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-3.2.0] review link doc (#4689)

Browse Source 
* review link doc
This commit is contained in:
Eugenio Romano
2019-05-03 14:30:35 +01:00
committed by GitHub
parent f40eb2560b
commit 42d02146fd
69 changed files with 736 additions and 579 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/process-services-cloud/components/app-list-cloud.component.md
View File

@@ -41,7 +41,6 @@ For example :
"alfresco-deployed-apps" : [{"name": "simple-app"}]
```
## Class members
### Properties

2
docs/process-services-cloud/components/form-cloud.component.md
View File

@@ -12,6 +12,7 @@ Shows a [`form`](../../../lib/process-services-cloud/src/lib/form/models/form-cl
## Contents
- [Basic Usage](#basic-usage)
- [Custom form outcomes template](#custom-form-outcomes-template)
- [Empty form template](#empty-form-template)
- [Class members](#class-members)
- [Properties](#properties)
@@ -98,6 +99,7 @@ The template defined inside `empty-form` will be shown when no form definition i
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | |
| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts)`>` | Emitted when form values are refreshed due to a data property change. |
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormCloud`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts)`>` | Emitted when the form is loaded or reloaded. |

7
docs/process-services-cloud/components/form-definition-selector-cloud.component.md
View File

@@ -1,5 +1,4 @@
# [Form Definition Selector Cloud](../../../lib/process-services-cloud/src/lib/form-definition-selector/components/form-definition-selector-cloud.component.ts "Defined in form-definition-selector-cloud.component.ts")
# [Form Definition Selector Cloud](../../../lib/process-services-cloud/src/lib/form/components/form-definition-selector-cloud.component.ts "Defined in form-definition-selector-cloud.component.ts")
Allows one form to be selected.
@@ -18,10 +17,10 @@ Allows one form to be selected.
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | | (**required**) Name of the application. If specified, this shows the users who have access to the app.
| appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| selectForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`string`](../../../lib/core/userinfo/models/identity-user.model.ts)`>` | Emitted when a form is selected. |
| selectForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a form is selected. |

4
docs/process-services-cloud/components/people-cloud.component.md
View File

@@ -28,8 +28,8 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu
| mode | `string` | | User selection mode (single/multiple). |
| preSelectUsers | [`IdentityUserModel`](../../../lib/core/userinfo/models/identity-user.model.ts)`[]` | | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username |
| roles | `string[]` | | Role names of the users to be listed. |
| validate | `Boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. |
| title | `string` | | Translation key for the input placeholder |
| title | `string` | | Placeholder translation key |
| validate | `Boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. |
### Events

3
docs/process-services-cloud/components/process-list-cloud.component.md
View File

@@ -50,7 +50,7 @@ when the process list is empty:
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | The name of the application. |
| appName | `string` | | The name of the application. |
| 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. |
@@ -190,7 +190,6 @@ The configuration related to the pagination can be changed from the `app.config.
"size": 20,
"supportedPageSizes": [ 5, 10, 15, 20 ]
},
```
## See also

7
docs/process-services-cloud/services/form-cloud.service.md
View File

@@ -40,6 +40,11 @@ class MyComponent {
- _nodeId:_ `any` -
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
- **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getForm**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets a form definition.
- _appName:_ `string` - Name of the app
@@ -82,4 +87,4 @@ class MyComponent {
## See also
- [Form cloud component](../components/form-cloud.component.md)
- [Form cloud component](../components/form-cloud.component.md)

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

@@ -13,6 +13,11 @@ Manages cloud process instances.
### Methods
- **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getProcessInstanceById**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`<br/>
Gets details of a process instance.
- _appName:_ `string` - Name of the app

7
docs/process-services-cloud/services/process-list-cloud.service.md
View File

@@ -13,6 +13,11 @@ Searches processes.
### Methods
- **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Finds a process using an object with optional query properties.
- _requestNode:_ [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object
@@ -36,4 +41,4 @@ For example :
## See also
- [App list cloud component](../components/app-list-cloud.component.md)
- [App list cloud component](../components/app-list-cloud.component.md)

5
docs/process-services-cloud/services/start-process-cloud.service.md
View File

@@ -13,6 +13,11 @@ Gets process definitions and starts processes.
### Methods
- **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>`<br/>
Gets the process definitions associated with an app.
- _appName:_ `string` - Name of the target app

4
docs/process-services-cloud/services/start-task-cloud.service.md
View File

@@ -17,6 +17,10 @@ Starts standalone tasks.
Creates a new standalone task.
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task to create
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task
- **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` -
- **Returns** `string` -
## Details

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

@@ -36,6 +36,11 @@ Manages task cloud.
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task to complete
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task that was completed
- **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **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

5
docs/process-services-cloud/services/task-list-cloud.service.md
View File

@@ -13,6 +13,11 @@ Searches tasks.
### Methods
- **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Finds a task using an object with optional query properties.
- _requestNode:_ [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object