Class InlineTasks

Deprecated

Will be removed in next major version.

Index

Constructors

Methods

getTaskById searchTasks updateTaskById

Constructors

constructor

new InlineTasks(client: Client): InlineTasks
Parameters
- client: Client
Returns InlineTasks
- Defined in src/api/inlineTasks.ts:9

Methods

getTaskById

getTaskById<T = Task>(
parameters: GetTaskById,
callback: Callback<T>,
): Promise<void>
Returns inline task based on the global ID.

Permissions required: Permission to view the content associated with the task.
Type Parameters
- T = Task
Parameters
- parameters: GetTaskById
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in next major version.
- Defined in src/api/inlineTasks.ts:68
getTaskById<T = Task>(parameters: GetTaskById, callback?: undefined): Promise<T>
Returns inline task based on the global ID.

Permissions required: Permission to view the content associated with the task.
Type Parameters
- T = Task
Parameters
- parameters: GetTaskById
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
Will be removed in next major version.
- Defined in src/api/inlineTasks.ts:77

searchTasks

searchTasks<T = TaskPageResponse>(
parameters: undefined | SearchTasks,
callback: Callback<T>,
): Promise<void>
Returns inline tasks based on the search query.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.
Type Parameters
- T = TaskPageResponse
Parameters
- parameters: undefined | SearchTasks
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in next major version.
- Defined in src/api/inlineTasks.ts:19
searchTasks<T = TaskPageResponse>(
parameters?: SearchTasks,
callback?: undefined,
): Promise<T>
Returns inline tasks based on the search query.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.
Type Parameters
- T = TaskPageResponse
Parameters
- Optionalparameters: SearchTasks
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
Will be removed in next major version.
- Defined in src/api/inlineTasks.ts:31

updateTaskById

updateTaskById<T = Task>(
parameters: UpdateTaskById,
callback: Callback<T>,
): Promise<void>
Updates an inline tasks status given its global ID

Permissions required: Permission to update the content associated with the task.
Type Parameters
- T = Task
Parameters
- parameters: UpdateTaskById
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in next major version.
- Defined in src/api/inlineTasks.ts:95
updateTaskById<T = Task>(
parameters: UpdateTaskById,
callback?: undefined,
): Promise<T>
Updates an inline tasks status given its global ID

Permissions required: Permission to update the content associated with the task.
Type Parameters
- T = Task
Parameters
- parameters: UpdateTaskById
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
Will be removed in next major version.
- Defined in src/api/inlineTasks.ts:104