Class Tasks

Index

Constructors

Methods

cancelTask getTask

Constructors

constructor

new Tasks(client: Client): Version3.Tasks
Parameters
- client: Client
Returns Version3.Tasks
- Defined in src/version3/tasks.ts:8

Methods

cancelTask

cancelTask<T = unknown>(
parameters: string | Version3Parameters.CancelTask,
callback: Callback<T>,
): Promise<void>
Cancels a task.

Permissions required: either of:
- Administer Jira global permission.
- Creator of the task.
Type Parameters
- T = unknown
Parameters
- parameters: string | Version3Parameters.CancelTask
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/tasks.ts:74
cancelTask<T = unknown>(
parameters: string | Version3Parameters.CancelTask,
callback?: undefined,
): Promise<T>
Cancels a task.

Permissions required: either of:
- Administer Jira global permission.
- Creator of the task.
Type Parameters
- T = unknown
Parameters
- parameters: string | Version3Parameters.CancelTask
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/tasks.ts:84

getTask

getTask<T = Version3Models.TaskProgressObject>(
parameters: string | Version3Parameters.GetTask,
callback: Callback<T>,
): Promise<void>
Returns the status of a long-running asynchronous task.

When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice.

Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.
- read:jira-work
Permissions required: either of:
- Administer Jira global permission.
- Creator of the task.
Type Parameters
- T = Version3Models.TaskProgressObject
Parameters
- parameters: string | Version3Parameters.GetTask
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/tasks.ts:28
getTask<T = Version3Models.TaskProgressObject>(
parameters: string | Version3Parameters.GetTask,
callback?: undefined,
): Promise<T>
Returns the status of a long-running asynchronous task.

When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice.

Deprecation notice: The required OAuth 2.0 scopes will be updated on June 15, 2024.
- read:jira-work
Permissions required: either of:
- Administer Jira global permission.
- Creator of the task.
Type Parameters
- T = Version3Models.TaskProgressObject
Parameters
- parameters: string | Version3Parameters.GetTask
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/tasks.ts:50