mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4249] Updates for doc review (#4454)
* [ADF-4249] Updates for doc review * [ADF-4249] Clarified text slightly
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
34b5c5a1b3
commit
7fe066b068
@@ -1,26 +0,0 @@
|
||||
---
|
||||
Title: Complete Cloud Task
|
||||
Added: v3.1.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-02-28
|
||||
---
|
||||
|
||||
# [Complete task directive](../../lib/process-services-cloud/src/lib/task/task-header/directives/complete-task.directive.ts "Defined in complete-task.directive.ts")
|
||||
|
||||
Complete a task
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<button adf-cloud-complete-task [appName]="appName" [taskId]="taskId" (success)="onTaskCompleted()">Complete</button>
|
||||
```
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| taskId | `string` | empty |(Required) The id of the task. |
|
||||
| appName | `string` | empty | (Required) The name of the application. |
|
||||
| success | `EventEmitter<any>` | empty | Emitted when the task is completed. |
|
||||
| error | `EventEmitter<any>` | empty | Emitted when the task cannot be completed. |
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
Title: Complete Task Directive
|
||||
Added: v3.1.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-03-19
|
||||
---
|
||||
|
||||
# [Complete task directive](../../../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts "Defined in complete-task.directive.ts")
|
||||
|
||||
Completes a task.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<button adf-cloud-complete-task [appName]="appName" [taskId]="taskId" (success)="onTaskCompleted()">Complete</button>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appName | `string` | | (Required) The name of the application. |
|
||||
| taskId | `string` | | (Required) The id of the task. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task cannot be completed. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is completed. |
|
||||
@@ -2,37 +2,37 @@
|
||||
Title: Task Cloud Service
|
||||
Added: v3.1.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-02-28
|
||||
Last reviewed: 2019-03-19
|
||||
---
|
||||
|
||||
# [Task Cloud Service](../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts "Defined in task-cloud.service.ts")
|
||||
# [Task Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts "Defined in task-cloud.service.ts")
|
||||
|
||||
Manage task cloud.
|
||||
Manages task cloud.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **completeTask**(appName: `string`, taskId: `string`)<br/>
|
||||
Complete a task
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _taskId:_ `string` - ID of the task to complete
|
||||
|
||||
- **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts))<br/>
|
||||
- **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
|
||||
Validate if a task can be completed.
|
||||
- _taskDetails:_ [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts) - Task details object
|
||||
|
||||
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
|
||||
- **Returns** `boolean` - Boolean value if the task can be completed
|
||||
- **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/>
|
||||
- **completeTask**(appName: `string`, taskId: `string`): `any`<br/>
|
||||
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`](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
|
||||
- **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
|
||||
@@ -48,10 +48,10 @@ Manage task cloud.
|
||||
## Details
|
||||
|
||||
The methods work in much the same way as the equivalent methods in the
|
||||
[Tasklist service](../process-services/tasklist.service.md)
|
||||
[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/tasklist.service.md) page for usage examples.
|
||||
[Tasklist service](../../process-services/services/tasklist.service.md) page for usage examples.
|
||||
|
||||
## See also
|
||||
|
||||
- [Tasklist service](../process-services/tasklist.service.md)
|
||||
- [Tasklist service](../../process-services/services/tasklist.service.md)
|
||||
Reference in New Issue
Block a user