Variable TextsApiConst

Type Declaration

• create: function

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

    Create a new text.

    Parameters

    • data: TextCreateRequest

      Text creation data

    Returns Promise<ApiResponse<TextCreateResponse>>

    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

• 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