task-cloud.service.md

Title	Added	Status	Last reviewed
Task Cloud Service	v3.1.0	Experimental	2019-03-29

Task Cloud Service

Manages task cloud.

Class members

Methods

• assign(appName: string, taskId: string, assignee: string): Observable<TaskDetailsCloudModel>
  Updates the task assignee.

  • appName: string - Name of the app
  • taskId: string - ID of the task to update assignee
  • assignee: string - assignee to update current user task assignee
  • Returns Observable<TaskDetailsCloudModel> - Updated task details with new assignee

• canClaimTask(taskDetails: TaskDetailsCloudModel): boolean
  Validate if a task can be claimed.

  • taskDetails: TaskDetailsCloudModel - task details object
  • Returns boolean - Boolean value if the task can be completed

• canCompleteTask(taskDetails: TaskDetailsCloudModel): boolean
  Validate if a task can be completed.

  • taskDetails: TaskDetailsCloudModel - task details object
  • Returns boolean - Boolean value if the task can be completed

• canUnclaimTask(taskDetails: TaskDetailsCloudModel): boolean
  Validate if a task can be unclaimed.

  • taskDetails: TaskDetailsCloudModel - task details object
  • Returns boolean - Boolean value if the task can be completed

• claimTask(appName: string, taskId: string, assignee: string): Observable<TaskDetailsCloudModel>
  Claims a task for an assignee.

  • appName: string - Name of the app
  • taskId: string - ID of the task to claim
  • assignee: string - User to assign the task to
  • Returns Observable<TaskDetailsCloudModel> - Details of the claimed task

• completeTask(appName: string, taskId: string): Observable<TaskDetailsCloudModel>
  Complete a task.

  • appName: string - Name of the app
  • taskId: string - ID of the task to complete
  • Returns Observable<TaskDetailsCloudModel> - Details of the task that was completed

• createNewTask(startTaskRequest: StartTaskCloudRequestModel, appName: string): Observable<TaskDetailsCloudModel>
  Creates a new standalone task.

  • startTaskRequest: StartTaskCloudRequestModel -
  • appName: string -
  • Returns Observable<TaskDetailsCloudModel> - Details of the newly created task

• getBasePath(appName: string): string
  

  • appName: string -
  • Returns string -

• getCandidateGroups(appName: string, taskId: string): Observable<string[]>
  Gets candidate groups of the task.

  • appName: string - Name of the app
  • taskId: string - ID of the task
  • Returns Observable<string[]> - Candidate groups

• getCandidateUsers(appName: string, taskId: string): Observable<string[]>
  Gets candidate users of the task.

  • appName: string - Name of the app
  • taskId: string - ID of the task
  • Returns Observable<string[]> - Candidate users

• getPriorityLabel(priority: number): string
  

  • priority: number -
  • Returns string -

• getProcessDefinitions(appName: string): Observable<ProcessDefinitionCloud[]>
  Gets the process definitions associated with an app.

  • appName: string - Name of the target app
  • Returns Observable<ProcessDefinitionCloud[]> - Array of process definitions

• getTaskById(appName: string, taskId: string): Observable<TaskDetailsCloudModel>
  Gets details of a task.

  • appName: string - Name of the app
  • taskId: string - ID of the task whose details you want
  • Returns Observable<TaskDetailsCloudModel> - Task details

• isAssigneePropertyClickable(taskDetails: TaskDetailsCloudModel, candidateUsers: CardViewArrayItem[], candidateGroups: CardViewArrayItem[]): boolean
  

  • taskDetails: TaskDetailsCloudModel -
  • candidateUsers: CardViewArrayItem[] -
  • candidateGroups: CardViewArrayItem[] -
  • Returns boolean -

• isTaskEditable(taskDetails: TaskDetailsCloudModel): boolean
  Validate if a task is editable.

  • taskDetails: TaskDetailsCloudModel - task details object
  • Returns boolean - Boolean value if the task is editable

• unclaimTask(appName: string, taskId: string): Observable<TaskDetailsCloudModel>
  Un-claims a task.

  • appName: string - Name of the app
  • taskId: string - ID of the task to unclaim
  • Returns Observable<TaskDetailsCloudModel> - Details of the task that was unclaimed

• updateTask(appName: string, taskId: string, payload: any): Observable<TaskDetailsCloudModel>
  Updates the details (name, description, due date) for a task.

  • appName: string - Name of the app
  • taskId: string - ID of the task to update
  • payload: any - Data to update the task
  • Returns Observable<TaskDetailsCloudModel> - Updated task details

Details

The methods work in much the same way as the equivalent methods in the Tasklist service but they use the cloud variants of the classes for return values. See the Tasklist service page for usage examples.

See also

• Tasklist service