inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-26 17:24:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/process-services-cloud/services/task-cloud.service.md
Silviu Popa 31658c0974 [ADF-4127] ProcessServicesCloud - add claim/unclaim directive (#4464) 
* [ADF-4127] ProessServicesCloud - claim task directive

* [ADF-4127] - fix doc

* [ADF-4127] - revert docs changes

* [ADF-4127] - revert doc changes

* [ADF-4127] - fix doc and reset sourceLinker.js

* [ADF-4127] - refractor task-cloud.service. add validation for claim/unclaim and fix unit tests

* [ADF-4127] - fix docs files

* [ADF-4127[ - add aditional complete task validation

* [ADF-4127] - PR changes

* [ADF-4127] - complete docs file

* [ADF-4127] - more PR changes

* [ADF-4127] - change Unclaim task name and wait for task to be claimed and unclaimed before emit the success event

* [ADF-4127] - fix unit tests
2019-03-25 12:24:26 +00:00

4.3 KiB
Raw Blame History

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
  • completeTask(appName: string, taskId: string)
    Complete a task
    • appName: string - Name of the app
    • taskId: string - ID of the task to complete
    • Returns TaskDetailsCloudModel - Details of the task that was completed
  • canClaimTask(taskDetails: TaskDetailsCloudModel)
    Validate if a task can be claimed.
    • taskDetails: TaskDetailsCloudModel - Task details object
    • Returns boolean - Boolean value if the task can be claimed
  • canUnclaimTask(taskDetails: TaskDetailsCloudModel)
    Validate if a task can be unclaimed.
    • taskDetails: TaskDetailsCloudModel - Task details object
    • Returns boolean - Boolean value if the task can be unclaimed
  • 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 TaskDetailsCloudModel - Details of the claimed 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 TaskDetailsCloudModel - Details of the task that was unclaimed
  • getTaskById(appName: string, taskId: string): Observable<TaskDetailsCloudModel>
    Gets details of a task.
  • 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 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