Function BackgroundTasksApiFp

Returns {
    getTask(
        taskId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TrackableTaskSchema>,
    >;
    getTasks(
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageTrackableTaskSchema>,
    >;
}

• getTask: function

  • getTask(
        taskId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TrackableTaskSchema>,
    >

    Return a specific background task

    Parameters

    • taskId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TrackableTaskSchema>,
    >

    Throws

• getTasks: function

  • getTasks(
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageTrackableTaskSchema>,
    >

    Return a list of all non-expired background tasks

    Parameters

    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageTrackableTaskSchema>,
    >

    Throws