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

Documentation update 3.6.0 (#5257)

Browse Source 
* documentation update 3.6.0

* documentation update 3.6.0

* update missing doc
This commit is contained in:
Eugenio Romano
2019-11-18 12:34:28 +00:00
committed by GitHub
parent 7ca2f5d1e9
commit a6ad7a5ad0
113 changed files with 421 additions and 374 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -279,7 +279,7 @@ could use this, say, to provide two alternative ways of entering the same inform
up default values that can be edited.
You can implement this in ADF using the `formFieldValueChanged` event of the
[Form service](../../core/services/form.service.md). For example, if you had a form with a dropdown widget (id: `type`)
[Form service](../../core/services/form.service.md). For example, if you had a form with a [dropdown widget](../../../lib/testing/src/lib/core/pages/form/widgets/dropdownWidget.ts) (id: `type`)
and a multiline text (id:`description`), you could synchronize their values as follows:
```ts
@@ -296,7 +296,7 @@ formService.formFieldValueChanged.subscribe((e: FormFieldEvent) => {
```
The code shown above subscribes to the `formFieldValueChanged` event to check whether an event
is emitted for the `type` widget. Then it finds the `description` widget and assigns some text
is emitted for the `type` [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts). Then it finds the `description` [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) and assigns some text
to its `value` property.
The result should look like the following:
@@ -349,7 +349,7 @@ In the CSS, you can target any outcome ID and change the style as in this exampl
APS allows you to configure where to store files and folders in your on-site Alfresco repositories.
If you have your repositories configured like this, you can use the attach file/folder
form widget to get a file from those repositories and attach it to the [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts).
form [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to get a file from those repositories and attach it to the [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts).
**Note:** your repositories could be configured to be on different servers from the one
where your front-end is deployed. Make sure you are using the right Proxy or configuration,

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

@@ -58,7 +58,7 @@ when the process list is empty:
| presetColumn | `string` | | Custom preset column schema in JSON format. |
| processDefinitionId | `string` | | The Definition Id of the process. |
| processInstanceId | `number \| string` | | The id of the process instance. |
| resolverFn | `Function` | | Resolver function is used to show dynamic complex column objects see the [docs](../../core/interfaces/datatable-adapter.interface.md) to learn how to configure a resolverFn. |
| resolverFn | `Function` | null | Resolver function is used to show dynamic complex column objects see the docs to learn how to configure a resolverFn. |
| selectFirstRow | `boolean` | true | Toggles default selection of the first row |
| 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. |
| size | `number` | | The number of processes to fetch in each page. |

6
docs/process-services/services/tasklist.service.md
View File

@@ -107,10 +107,10 @@ Manages Task Instances.
Un-claims a task for the current user.
- _taskId:_ `string` - ID of the task to unclaim
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Null response notifying when the operation is complete
- **updateTask**(taskId: `any`, updated: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`<br/>
- **updateTask**(taskId: `string`, updated: [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`<br/>
Updates the details (name, description, due date) for a task.
- _taskId:_ `any` - ID of the task to update
- _updated:_ `any` - Data to update the task (as a [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md) instance).
- _taskId:_ `string` - ID of the task to update
- _updated:_ [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md) - Data to update the task (as a [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md) instance).
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Updated task details
## Details