Class BackgroundTasksApi

BackgroundTasksApi - object-oriented interface

Hierarchy

BaseAPI
- BackgroundTasksApi

Index

Constructors

Properties

axios basePath configuration

Methods

getTask getTasks

Constructors

constructor

new BackgroundTasksApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): BackgroundTasksApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns BackgroundTasksApi
Inherited from BaseAPI.constructor
- Defined in base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getTask

getTask(
requestParameters: BackgroundTasksApiGetTaskRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<TrackableTaskSchema, any, {}>>
Return a specific background task
Parameters
- requestParameters: BackgroundTasksApiGetTaskRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TrackableTaskSchema, any, {}>>

Throws
- Defined in api.ts:3059

getTasks

getTasks(
requestParameters?: BackgroundTasksApiGetTasksRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PageTrackableTaskSchema, any, {}>>
Return a list of all non-expired background tasks
Parameters
- requestParameters: BackgroundTasksApiGetTasksRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageTrackableTaskSchema, any, {}>>

Throws
- Defined in api.ts:3070