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 (#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
committed by
Eugenio Romano
Eugenio Romano
parent
04c6436ed2
commit
cec08f50d7
@@ -1,26 +0,0 @@
|
||||
---
|
||||
Title: Claim Task Directive
|
||||
Added: v3.1.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-03-05
|
||||
---
|
||||
|
||||
# [Claim task directive](../../lib/process-services-cloud/src/lib/task/directives/claim-task.directive.ts "Defined in claim-task.directive.ts")
|
||||
|
||||
Claim a task
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<button adf-claim-task [appName]="appName" [taskId]="taskId" (success)="onTaskClaimed()">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. |
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Process Instance List Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-03-20
|
||||
Last reviewed: 2019-03-25
|
||||
---
|
||||
|
||||
# [Process Instance List Cloud component](../../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts "Defined in process-list-cloud.component.ts")
|
||||
@@ -51,13 +51,14 @@ when the process list is empty:
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appName | `string` | "" | The name of the application. |
|
||||
| businessKey | `string` | "" | Filter the tasks to display only the ones with this businessKey value. |
|
||||
| businessKey | `string` | "" | Filter the processes to display only the ones with this businessKey value. |
|
||||
| id | `string` | "" | Filter the processes to display only the ones with this ID. |
|
||||
| initiator | `string` | "" | Name of the initiator of the process. |
|
||||
| lastModifiedFrom | `string` | "" | Filter the processes. Display only process with lastModifiedTo equal to the supplied date. |
|
||||
| lastModifiedTo | `string` | "" | Filter the processes. Display only process with lastModifiedTo equal to the supplied date. |
|
||||
| multiselect | `boolean` | false | Toggles multiple row selection and renders checkboxes at the beginning of each row |
|
||||
| name | `string` | "" | Filter the processes to display only the ones with this name. |
|
||||
| presetColumn | `string` | | Custom preset column schema in JSON format. |
|
||||
| processDefinitionId | `string` | "" | Filter the processes to display only the ones with this process definition ID. |
|
||||
| processDefinitionKey | `string` | "" | Filter the processes to display only the ones with this process definition key. |
|
||||
| selectionMode | `string` | "single" | Row selection mode. Can be "none", "single" or "multiple". For multiple mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Task List Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-03-20
|
||||
Last reviewed: 2019-03-25
|
||||
---
|
||||
|
||||
# [Task List Cloud component](../../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts "Defined in task-list-cloud.component.ts")
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
Title: Claim Task Directive
|
||||
Added: v3.1.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-03-25
|
||||
---
|
||||
|
||||
# [Claim task directive](../../../lib/process-services-cloud/src/lib/task/directives/claim-task.directive.ts "Defined in claim-task.directive.ts")
|
||||
|
||||
Claims a task
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<button adf-claim-task [appName]="appName" [taskId]="taskId" (success)="onTaskClaimed()">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. |
|
||||
@@ -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. |
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Process List Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-02-06
|
||||
Last reviewed: 2019-03-25
|
||||
---
|
||||
|
||||
# [Process List Cloud Service](../../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts "Defined in process-list-cloud.service.ts")
|
||||
@@ -26,7 +26,7 @@ must at minimum have the `appName` property correctly set.
|
||||
|
||||
## Activiti 7
|
||||
|
||||
If you are generating a project for activiti7 you need to add in the **app.config.json** the list of the apps that you desire to use.
|
||||
If you are generating a project for Activiti 7, you must add the list of apps you want to use in **app.config.json** .
|
||||
|
||||
For example :
|
||||
|
||||
@@ -34,4 +34,6 @@ For example :
|
||||
"alfresco-deployed-apps" : [{"name": "simple-app"}]
|
||||
```
|
||||
|
||||
For more information about the app list component refer to the [documentation](https://github.com/Alfresco/alfresco-ng2-components/blob/development/docs/process-services-cloud/app-list-cloud.component.md)
|
||||
## See also
|
||||
|
||||
- [App list cloud component](../components/app-list-cloud.component.md)
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
---
|
||||
Title: Unclaim Task Directive
|
||||
Added: v3.1.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-03-05
|
||||
---
|
||||
|
||||
# [Unclaim task directive](../../lib/process-services-cloud/src/lib/task/directives/unclaim-task.directive.ts "Defined in unclaim-task.directive.ts")
|
||||
|
||||
Unclaim 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 |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| 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. |
|
||||
Reference in New Issue
Block a user