Variable TermsApiConst

Type Declaration

• addWithTranslation: function

  • addWithTranslation(
        text: string,
        langId: number,
        translation: string,
    ): Promise<ApiResponse<TermTranslationResponse>>

    Add a new term with translation.

    Parameters

    • text: string

      Term text

    • langId: number

      Language ID

    • translation: string

      Translation

    Returns Promise<ApiResponse<TermTranslationResponse>>

    Promise with new term data

• createFull: function

  • createFull(data: TermCreateFullRequest): Promise<ApiResponse<TermFullResponse>>

    Create a new term with full data.

    Parameters

    • data: TermCreateFullRequest

      Term creation data (textId, position, translation, romanization, sentence, status, tags)

    Returns Promise<ApiResponse<TermFullResponse>>

    Promise with created term data

• createMultiWord: function

  • createMultiWord(
        data: MultiWordInput,
    ): Promise<ApiResponse<TermQuickCreateResponse>>

    Create a new multi-word expression.

    Parameters

    • data: MultiWordInput

      Multi-word data

    Returns Promise<ApiResponse<TermQuickCreateResponse>>

    Promise with new term data

• createQuick: function

  • createQuick(
        textId: number,
        position: number,
        status: 98 | 99,
    ): Promise<ApiResponse<TermQuickCreateResponse>>

    Create a term quickly with wellknown (99) or ignored (98) status. Used for marking unknown words without opening the edit form.

    Parameters

    • textId: number

      Text ID containing the word

    • position: number

      Word position in text

    • status: 98 | 99

      Status to set (98 for ignored, 99 for well-known)

    Returns Promise<ApiResponse<TermQuickCreateResponse>>

    Promise with new term data

• delete: function

  • delete(termId: number): Promise<ApiResponse<TermDeleteResponse>>

    Delete a term.

    Parameters

    • termId: number

      Term ID to delete

    Returns Promise<ApiResponse<TermDeleteResponse>>

    Promise with deletion result

• get: function

  • get(termId: number): Promise<ApiResponse<Term>>

    Get term by ID.

    Parameters

    • termId: number

      Term ID

    Returns Promise<ApiResponse<Term>>

    Promise with term data or error

• getDetails: function

  • getDetails(termId: number, ann?: string): Promise<ApiResponse<TermDetails>>

    Get detailed term information including sentence and tags.

    Parameters

    • termId: number

      Term ID

    • Optionalann: string

      Optional annotation to highlight in translation

    Returns Promise<ApiResponse<TermDetails>>

    Promise with term details or error

• getForEdit: function

  • getForEdit(
        textId: number,
        position: number,
        wordId?: number,
    ): Promise<ApiResponse<TermForEditResponse>>

    Get term data for editing in modal.

    Returns term data, language settings, all tags for autocomplete, and similar terms.

    Parameters

    • textId: number

      Text ID

    • position: number

      Word position in text

    • OptionalwordId: number

      Word ID (optional, for existing terms)

    Returns Promise<ApiResponse<TermForEditResponse>>

    Promise with term edit data

• getImported: function

  • getImported(): Promise<ApiResponse<Term[]>>

    Get imported terms (terms that were bulk imported).

    Returns Promise<ApiResponse<Term[]>>

    Promise with array of imported terms

• getMultiWord: function

  • getMultiWord(
        textId: number,
        position: number,
        text?: string,
        wordId?: number,
    ): Promise<ApiResponse<MultiWordData>>

    Get multi-word expression data for editing.

    Parameters

    • textId: number

      Text ID

    • position: number

      Position in text

    • Optionaltext: string

      Multi-word text (for new expressions)

    • OptionalwordId: number

      Word ID (for existing expressions)

    Returns Promise<ApiResponse<MultiWordData>>

    Promise with multi-word data or error

• getSentences: function

  • getSentences(
        termId: number,
        langId: number,
    ): Promise<ApiResponse<SentenceWithTerm[]>>

    Get sentences containing a term.

    Parameters

    • termId: number

      Term ID

    • langId: number

      Language ID

    Returns Promise<ApiResponse<SentenceWithTerm[]>>

    Promise with array of sentences

• getSimilar: function

  • getSimilar(
        termText: string,
        langId: number,
    ): Promise<ApiResponse<SimilarTerm[]>>

    Get similar terms for a given term.

    Parameters

    • termText: string

      Term text to find similar terms for

    • langId: number

      Language ID

    Returns Promise<ApiResponse<SimilarTerm[]>>

    Promise with array of similar terms

• incrementStatus: function

  • incrementStatus(
        termId: number,
        direction: "up" | "down",
    ): Promise<ApiResponse<TermStatusResponse>>

    Increment or decrement term status.

    Parameters

    • termId: number

      Term ID

    • direction: "up" | "down"

      'up' to increment, 'down' to decrement

    Returns Promise<ApiResponse<TermStatusResponse>>

    Promise with operation result including HTML controls

• setStatus: function

  • setStatus(
        termId: number,
        status: number,
    ): Promise<ApiResponse<TermStatusResponse>>

    Set term status to a specific value.

    Parameters

    • termId: number

      Term ID

    • status: number

      New status (1-5, 98, 99)

    Returns Promise<ApiResponse<TermStatusResponse>>

    Promise with operation result

• updateFull: function

  • updateFull(
        termId: number,
        data: TermUpdateFullRequest,
    ): Promise<ApiResponse<TermFullResponse>>

    Update an existing term with full data.

    Parameters

    • termId: number

      Term ID

    • data: TermUpdateFullRequest

      Term update data (translation, romanization, sentence, status, tags)

    Returns Promise<ApiResponse<TermFullResponse>>

    Promise with updated term data

• updateMultiWord: function

  • updateMultiWord(
        termId: number,
        data: Partial<MultiWordInput>,
    ): Promise<ApiResponse<MultiWordUpdateResponse>>

    Update an existing multi-word expression.

    Parameters

    • termId: number

      Term ID

    • data: Partial<MultiWordInput>

      Multi-word data (translation, romanization, sentence, status)

    Returns Promise<ApiResponse<MultiWordUpdateResponse>>

    Promise with update result

• updateTranslation: function

  • updateTranslation(
        termId: number,
        translation: string,
    ): Promise<ApiResponse<TermTranslationResponse>>

    Update term translation (adds to existing translations).

    Parameters

    • termId: number

      Term ID

    • translation: string

      New translation to add

    Returns Promise<ApiResponse<TermTranslationResponse>>

    Promise with update result