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:
committed by
Eugenio Romano
parent
34b5c5a1b3
commit
7fe066b068
@@ -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. |
|
Reference in New Issue
Block a user