Variable TextsApiConst

Type Declaration

• bulkAction: function

  • bulkAction(
        action: "delete" | "archive",
        ids: number[],
    ): Promise<ApiResponse<{ count: number }>>

    Archive or delete multiple texts in one call.

    The JSON path for the destructive bulk actions, so they work against a configurable API base URL instead of a same-origin form POST. The server scopes the action to the current user's texts.

    Parameters

    • action: "delete" | "archive"

      'archive' or 'delete'

    • ids: number[]

      Text IDs to act on

    Returns Promise<ApiResponse<{ count: number }>>

    Promise with the number of texts affected

• create: function

  • create(data: TextCreateRequest): Promise<ApiResponse<TextSaveResponse>>

    Create a new text.

    Parameters

    • data: TextCreateRequest

      Text creation data

    Returns Promise<ApiResponse<TextSaveResponse>>

    Promise with new text ID or error

• getAnnotation: function

  • getAnnotation(textId: number): Promise<ApiResponse<AnnotationResponse>>

    Get annotation data for improved/annotated text view.

    Parameters

    • textId: number

      Text ID

    Returns Promise<ApiResponse<AnnotationResponse>>

    Promise with annotation items and config

• getAudio: function

  • getAudio(textId: number): Promise<ApiResponse<AudioInfo>>

    Get the audio metadata + player settings for the reader's media player.

    Parameters

    • textId: number

      Text ID

    Returns Promise<ApiResponse<AudioInfo>>

    Promise with audio uri, saved position, and player settings

• getBookContext: function

  • getBookContext(textId: number): Promise<ApiResponse<BookContextResponse>>

    Get the book/chapter context for the reader's chapter navigation.

    Parameters

    • textId: number

      Text ID

    Returns Promise<ApiResponse<BookContextResponse>>

    Promise with { book }; book is null for a standalone text

• getPrintItems: function

  • getPrintItems(textId: number): Promise<ApiResponse<PrintItemsResponse>>

    Get print items for a text (for client-side print rendering).

    Parameters

    • textId: number

      Text ID

    Returns Promise<ApiResponse<PrintItemsResponse>>

    Promise with print items and config

• getStatistics: function

  • getStatistics(textIds: string | number[]): Promise<ApiResponse<TextStatistics>>

    Get word count statistics for one or more texts.

    Parameters

    • textIds: string | number[]

      Array of text IDs or comma-separated string

    Returns Promise<ApiResponse<TextStatistics>>

    Promise with text statistics

• getWords: function

  • getWords(textId: number): Promise<ApiResponse<TextWordsResponse>>

    Get all words for a text (for client-side rendering).

    Parameters

    • textId: number

      Text ID

    Returns Promise<ApiResponse<TextWordsResponse>>

    Promise with words array and config

• markAllIgnored: function

  • markAllIgnored(textId: number): Promise<ApiResponse<MarkAllResponse>>

    Mark all unknown words in a text as ignored.

    Parameters

    • textId: number

      Text ID

    Returns Promise<ApiResponse<MarkAllResponse>>

    Promise with count and words data

• markAllWellKnown: function

  • markAllWellKnown(textId: number): Promise<ApiResponse<MarkAllResponse>>

    Mark all unknown words in a text as well-known.

    Parameters

    • textId: number

      Text ID

    Returns Promise<ApiResponse<MarkAllResponse>>

    Promise with count and words data

• setDisplayMode: function

  • setDisplayMode(
        textId: number,
        mode: Partial<TextDisplayMode>,
    ): Promise<ApiResponse<DisplayModeResponse>>

    Update display mode for text reading.

    Parameters

    • textId: number

      Text ID

    • mode: Partial<TextDisplayMode>

      Display mode settings

    Returns Promise<ApiResponse<DisplayModeResponse>>

    Promise with update result

• update: function

  • update(
        textId: number,
        data: TextCreateRequest,
    ): Promise<ApiResponse<TextSaveResponse>>

    Update an existing text and reparse it.

    Same payload as create. Reparsing discards the text's sentences and word occurrences and builds them again, so reading progress in the text is lost — which is what the form POST did too.

    Parameters

    • textId: number

      Text ID to update

    • data: TextCreateRequest

      Text fields

    Returns Promise<ApiResponse<TextSaveResponse>>

    Promise with the saved text ID or error