Variable ReviewApiConst

Type Declaration

• getNextWord: function

  • getNextWord(params: NextWordParams): Promise<ApiResponse<WordTestData>>

    Get the next word to review.

    Parameters

    • params: NextWordParams

      Review parameters

    Returns Promise<ApiResponse<WordTestData>>

    Promise with word review data

• getReviewConfig: function

  • getReviewConfig(
        params: { lang?: number; selection?: number; text?: number },
    ): Promise<ApiResponse<ReviewConfigResponse>>

    Get review configuration.

    Parameters

    • params: { lang?: number; selection?: number; text?: number }

      Review parameters (lang, text, or selection)

    Returns Promise<ApiResponse<ReviewConfigResponse>>

    Promise with review configuration

• getTableWords: function

  • getTableWords(
        reviewKey: string,
        selection: string,
    ): Promise<ApiResponse<TableWordsResponse>>

    Get all words for table review mode.

    Parameters

    • reviewKey: string

      Review session key

    • selection: string

      Word selection criteria

    Returns Promise<ApiResponse<TableWordsResponse>>

    Promise with table words

• getTomorrowCount: function

  • getTomorrowCount(
        reviewKey: string,
        selection: string,
    ): Promise<ApiResponse<TomorrowCountResponse>>

    Get count of words due for review tomorrow.

    Parameters

    • reviewKey: string

      Review session key

    • selection: string

      Word selection criteria

    Returns Promise<ApiResponse<TomorrowCountResponse>>

    Promise with count

• updateStatus: function

  • updateStatus(
        termId: number,
        status?: number,
        change?: number,
    ): Promise<ApiResponse<ReviewStatusResponse>>

    Update word status during review.

    Parameters

    • termId: number
    • Optionalstatus: number

      New status (1-5, 98, 99) or undefined for increment

    • Optionalchange: number

      Status change amount (+1 or -1)

    Returns Promise<ApiResponse<ReviewStatusResponse>>

    Promise with update result