inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-4249] Updates for doc review (#4470)

Browse Source 
* [ADF-4249] Updated review checker tool to work with new doc subfolders

* [ADF-4249] Updates for doc review
This commit is contained in:
Andy Stark
2019-03-20 18:12:22 +00:00
committed by Eugenio Romano
parent 10e91bed2a
commit e5c7ffb314
30 changed files with 158 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/process-services-cloud/services/task-header-cloud.service.md
View File

@@ -1,48 +0,0 @@
---
Title: Task Header Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-18
---
# [Task Header Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts "Defined in task-header-cloud.service.ts")
Manages cloud tasks.
## Class members
### Methods
- **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): `any`<br/>
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
- **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
Gets details of a task.
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task whose details you want
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details
- **unclaimTask**(appName: `string`, taskId: `string`): `any`<br/>
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`<br/>
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](../../process-services/services/tasklist.service.md)
but they use the cloud variants of the classes for return values. See the
[Tasklist service](../../process-services/services/tasklist.service.md) page for usage examples.
## See also
- [Tasklist service](../../process-services/services/tasklist.service.md)