Skip to content

TaskMethods

Methods

assign()

assign(options: TaskAssignOptions): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>

Assigns this task to a user or users

Parameters

Parameter Type Description
options TaskAssignOptions Assignment options (requires at least one of: userId, userNameOrEmail)

Returns

Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>

Promise resolving to task assignment results


complete()

complete(options: TaskCompleteOptions): Promise<OperationResponse<TaskCompletionOptions>>

Completes this task with optional data and action

Parameters

Parameter Type Description
options TaskCompleteOptions Completion options

Returns

Promise<OperationResponse<TaskCompletionOptions>>

Promise resolving to completion result


reassign()

reassign(options: TaskAssignOptions): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>

Reassigns this task to a new user

Parameters

Parameter Type Description
options TaskAssignOptions Assignment options (requires at least one of: userId, userNameOrEmail)

Returns

Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>

Promise resolving to task assignment results


unassign()

unassign(): Promise<OperationResponse<TaskAssignmentResponse[] | { taskId: number; }[]>>

Unassigns this task (removes current assignee)

Returns

Promise<OperationResponse<TaskAssignmentResponse[] | { taskId: number; }[]>>

Promise resolving to task assignment results