Class LongRunningTask

Index

Constructors

Methods

getTask getTasks

Constructors

constructor

new LongRunningTask(client: Client): LongRunningTask
Parameters
- client: Client
Returns LongRunningTask
- Defined in src/api/longRunningTask.ts:8

Methods

getTask

getTask<T = LongTaskStatusWithLinks>(
parameters: GetTask,
callback: Callback<T>,
): Promise<void>
Returns information about an active long-running task (e.g. space export), such as how long it has been running and the percentage of the task that has completed.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = LongTaskStatusWithLinks
Parameters
- parameters: GetTask
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/longRunningTask.ts:52
getTask<T = LongTaskStatusWithLinks>(
parameters: GetTask,
callback?: undefined,
): Promise<T>
Returns information about an active long-running task (e.g. space export), such as how long it has been running and the percentage of the task that has completed.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = LongTaskStatusWithLinks
Parameters
- parameters: GetTask
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/longRunningTask.ts:63

getTasks

getTasks<T = LongTaskStatusArray>(
parameters: undefined | GetTasks,
callback: Callback<T>,
): Promise<void>
Returns information about all active long-running tasks (e.g. space export), such as how long each task has been running and the percentage of each task that has completed.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = LongTaskStatusArray
Parameters
- parameters: undefined | GetTasks
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/longRunningTask.ts:17
getTasks<T = LongTaskStatusArray>(
parameters?: GetTasks,
callback?: undefined,
): Promise<T>
Returns information about all active long-running tasks (e.g. space export), such as how long each task has been running and the percentage of each task that has completed.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = LongTaskStatusArray
Parameters
- Optionalparameters: GetTasks
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/longRunningTask.ts:28