Function ScheduledTaskApiFp

Returns {
    getTask(
        taskId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo>,
    >;
    getTasks(
        isHidden?: boolean,
        isEnabled?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo[]>,
    >;
    startTask(
        taskId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    stopTask(
        taskId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updateTask(
        taskId: string,
        taskTriggerInfo: TaskTriggerInfo[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• getTask: function

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

    Parameters

    • taskId: string

      Task Id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getTasks: function

  • getTasks(
        isHidden?: boolean,
        isEnabled?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo[]>,
    >

    Parameters

    • OptionalisHidden: boolean

      Optional filter tasks that are hidden, or not.

    • OptionalisEnabled: boolean

      Optional filter tasks that are enabled, or not.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo[]>>

    Throws

• startTask: function

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

    Parameters

    • taskId: string

      Task Id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• stopTask: function

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

    Parameters

    • taskId: string

      Task Id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateTask: function

  • updateTask(
        taskId: string,
        taskTriggerInfo: TaskTriggerInfo[],
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • taskId: string

      Task Id.

    • taskTriggerInfo: TaskTriggerInfo[]

      Triggers.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws