Files
alfresco-ng2-components/docs/process-services-cloud/services/task-cloud.service.md
T
Andy Stark 7fe066b068 [ADF-4249] Updates for doc review (#4454)
* [ADF-4249] Updates for doc review

* [ADF-4249] Clarified text slightly
2019-03-19 15:35:59 +00:00

3.0 KiB

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

Task Cloud Service

Manages task cloud.

Class members

Methods

  • 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
  • claimTask(appName: string, taskId: string, assignee: string): any
    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 any - Details of the claimed task
  • completeTask(appName: string, taskId: string): any
    Complete a task.
    • appName: string - Name of the app
    • taskId: string - ID of the task to complete
    • Returns any - Details of the task that was completed
  • getTaskById(appName: string, taskId: string): Observable<TaskDetailsCloudModel>
    Gets details of a task.
  • unclaimTask(appName: string, taskId: string): any
    Un-claims a task.
    • appName: string - Name of the app
    • taskId: string - ID of the task to unclaim
    • Returns any - Details of the task that was unclaimed
  • updateTask(appName: string, taskId: string, updatePayload: any): any
    Updates the details (name, description, due date) for a task.
    • appName: string - Name of the app
    • taskId: string - ID of the task to update
    • updatePayload: any - Data to update the task
    • Returns any - 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