Variable LocalDictionariesApiConst

Type Declaration

• list: function

  • list(languageId: number): Promise<ApiResponse<LocalDictionaryListResponse>>

    List the dictionaries configured for a language.

    Parameters

    • languageId: number

      Language whose dictionaries to list

    Returns Promise<ApiResponse<LocalDictionaryListResponse>>

    Promise with the dictionaries and the language's lookup mode

• remove: function

  • remove(dictId: number): Promise<ApiResponse<LocalDictionaryMutationResponse>>

    Delete a dictionary and its entries.

    Parameters

    • dictId: number

      Dictionary to remove

    Returns Promise<ApiResponse<LocalDictionaryMutationResponse>>

    Promise with the outcome

• setEnabled: function

  • setEnabled(
        dictId: number,
        enabled: boolean,
    ): Promise<ApiResponse<LocalDictionaryMutationResponse>>

    Enable or disable a dictionary.

    Parameters

    • dictId: number

      Dictionary to update

    • enabled: boolean

      Desired state

    Returns Promise<ApiResponse<LocalDictionaryMutationResponse>>

    Promise with the outcome