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

* [ADF-4249] Doc review updates

* [ADF-4249] Updated doc index pages

* [ADF-4249] Minor corrections to un/claim task docs
This commit is contained in:
Andy Stark
2019-03-26 10:18:44 +00:00
committed by Eugenio Romano
parent 04c6436ed2
commit cec08f50d7
11 changed files with 83 additions and 63 deletions

View File

@@ -0,0 +1,32 @@
---
Title: Unclaim Task Directive
Added: v3.1.0
Status: Experimental
Last reviewed: 2019-03-25
---
# [Unclaim task directive](../../../lib/process-services-cloud/src/lib/task/directives/unclaim-task.directive.ts "Defined in unclaim-task.directive.ts")
Unclaims a task
## Basic Usage
```html
<button adf-unclaim-task [appName]="appName" [taskId]="taskId" (success)="onTaskUnclaimed()">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. |