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-2764] Applied new type linker features to proc services docs (#3449)

Browse Source
This commit is contained in:
Andy Stark
2018-06-07 14:37:47 +01:00
committed by Eugenio Romano
parent e988691d0a
commit d9d37e1964
29 changed files with 172 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -43,7 +43,7 @@ If we intend to show a custom template if there are no apps present
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| appClick | [`EventEmitter<AppDefinitionRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) | Emitted when an app entry is clicked. | | appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` | Emitted when an app entry is clicked. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | `EventEmitter<any>` | Emitted when an error occurs. |
## Details ## Details

4
docs/process-services/checklist.component.md
View File

@@ -31,6 +31,6 @@ Shows the checklist task functionality.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| checklistTaskCreated | [`EventEmitter<TaskDetailsModel>`](../process-services/task-details.model.md) | Emitted when a new checklist task is created. | | checklistTaskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` | Emitted when a new checklist task is created. |
| checklistTaskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. | | checklistTaskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a checklitst task is deleted. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | `EventEmitter<any>` | Emitted when an error occurs. |

4
docs/process-services/create-process-attachment.component.md
View File

@@ -31,5 +31,5 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. |
| success | `EventEmitter<any>` | Emitted when an attachment is successfully created or uploaded from within the component. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an attachment is successfully created or uploaded from within the component. |

4
docs/process-services/create-task-attachment.component.md
View File

@@ -31,5 +31,5 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. |
| success | `EventEmitter<any>` | Emitted when an attachment is created or uploaded successfully from within the component. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an attachment is created or uploaded successfully from within the component. |

6
docs/process-services/people-list.component.md
View File

@@ -79,11 +79,11 @@ Note that the [people list component](../process-services/people-list.component.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -- | -- | -- | -- | | -- | -- | -- | -- |
| actions | `boolean` | false | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. | | actions | `boolean` | false | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. |
| users | [`UserProcessModel[]`](../core/user-process.model.md) | | The array of user data used to populate the people list. | | users | [`UserProcessModel`](../core/user-process.model.md)`[]` | | The array of user data used to populate the people list. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| clickAction | [`EventEmitter<UserEventModel>`](../../lib/process-services/task-list/models/user-event.model.ts) | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. | | clickAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserEventModel`](../../lib/process-services/task-list/models/user-event.model.ts)`>` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. |
| clickRow | [`EventEmitter<UserProcessModel>`](../core/user-process.model.md) | Emitted when the user clicks a row in the people list. | | clickRow | `EventEmitter<UserProcessModel>` | Emitted when the user clicks a row in the people list. |

8
docs/process-services/people-search.component.md
View File

@@ -19,15 +19,15 @@ Searches users/people.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -- | -- | -- | -- | | -- | -- | -- | -- |
| results | [`Observable<UserProcessModel[]>`](../core/user-process.model.md) | | Parameters for displaying the list. | | results | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>` | | Parameters for displaying the list. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| closeSearch | `EventEmitter<Object>` | Emitted when the "close" button is clicked. | | closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the "close" button is clicked. |
| searchPeople | `EventEmitter<any>` | Emitted when a search is performed with a new keyword. | | searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a search is performed with a new keyword. |
| success | [`EventEmitter<UserProcessModel>`](../core/user-process.model.md) | Emitted when a user is selected and the action button is clicked. | | success | `EventEmitter<UserProcessModel>` | Emitted when a user is selected and the action button is clicked. |
## Details ## Details

2
docs/process-services/people.component.md
View File

@@ -41,7 +41,7 @@ Displays users involved with a specified task
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -- | -- | -- | -- | | -- | -- | -- | -- |
| people | [`UserProcessModel[]`](../core/user-process.model.md) | \[] | The array of User objects to display. | | people | [`UserProcessModel`](../core/user-process.model.md)`[]` | \[] | The array of User objects to display. |
| readOnly | `boolean` | false | Should the data be read-only? | | readOnly | `boolean` | false | Should the data be read-only? |
| taskId | `string` | "" | The numeric ID of the task. | | taskId | `string` | "" | The numeric ID of the task. |

6
docs/process-services/process-attachment-list.component.md
View File

@@ -19,7 +19,7 @@ Displays attached documents on a specified process instance
</adf-process-attachment-list> </adf-process-attachment-list>
``` ```
Make sure to override the [UploadService](../core/upload.service.md) with the [ProcessUploadService](../../lib/process-services/task-list/services/process-upload.service.ts) Make sure to override the [`UploadService`](../core/upload.service.md) with the [`ProcessUploadService`](../../lib/process-services/task-list/services/process-upload.service.ts)
```ts ```ts
import { UploadService } from '@alfresco/adf-core'; import { UploadService } from '@alfresco/adf-core';
@@ -49,8 +49,8 @@ export class MyCustomProcessAttachmentComponent {
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| attachmentClick | `EventEmitter<Object>` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a Blob representing the object that was clicked. | | attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. |
| error | `EventEmitter<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). |
| success | `EventEmitter<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | | success | `EventEmitter<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
## Details ## Details

4
docs/process-services/process-audit.directive.md
View File

@@ -37,5 +37,5 @@ Fetches the Process Audit information the PDF or JSON format.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| clicked | `EventEmitter<any>` | Emitted when the decorated element is clicked. | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the decorated element is clicked. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |

2
docs/process-services/process-comments.component.md
View File

@@ -28,4 +28,4 @@ Displays comments associated with a particular process instance and allows the u
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |

20
docs/process-services/process-filter.service.md
View File

@@ -12,32 +12,32 @@ Manage Process Filters, which are pre-configured Process Instance queries.
### Methods ### Methods
- **addProcessFilter**(filter: [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) = `null`): [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/> - **addProcessFilter**(filter: [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`<br/>
Adds a filter. Adds a filter.
- _filter:_ [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - The filter to add - _filter:_ [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - The filter to add
- **Returns** [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts) - The filter just added - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>` - The filter just added
- **callApiProcessFilters**(appId?: `number` = `null`): `Promise<any>`<br/> - **callApiProcessFilters**(appId?: `number` = `null`): `Promise<any>`<br/>
Calls `getUserProcessInstanceFilters` from the Alfresco JS API. Calls `getUserProcessInstanceFilters` from the Alfresco JS API.
- _appId:_ `number` - (Optional) ID of the target app - _appId:_ `number` - (Optional) ID of the target app
- **Returns** `Promise<any>` - List of filter details - **Returns** `Promise<any>` - List of filter details
- **createDefaultFilters**(appId: `number` = `null`): [`Observable<FilterProcessRepresentationModel[]>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/> - **createDefaultFilters**(appId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`<br/>
Creates and returns the default filters for an app. Creates and returns the default filters for an app.
- _appId:_ `number` - ID of the target app - _appId:_ `number` - ID of the target app
- **Returns** [`Observable<FilterProcessRepresentationModel[]>`](../../lib/process-services/process-list/models/filter-process.model.ts) - Default filters just created - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>` - Default filters just created
- **getProcessFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/> - **getProcessFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`<br/>
Retrieves the process filter by ID. Retrieves the process filter by ID.
- _filterId:_ `number` - ID of the filter - _filterId:_ `number` - ID of the filter
- _appId:_ `number` - (Optional) ID of the target app - _appId:_ `number` - (Optional) ID of the target app
- **Returns** [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts) - Details of the filter - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>` - Details of the filter
- **getProcessFilterByName**(filterName: `string` = `null`, appId?: `number` = `null`): [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/> - **getProcessFilterByName**(filterName: `string` = `null`, appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`<br/>
Retrieves the process filter by name. Retrieves the process filter by name.
- _filterName:_ `string` - Name of the filter - _filterName:_ `string` - Name of the filter
- _appId:_ `number` - (Optional) ID of the target app - _appId:_ `number` - (Optional) ID of the target app
- **Returns** [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts) - Details of the filter - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>` - Details of the filter
- **getProcessFilters**(appId: `number` = `null`): [`Observable<FilterProcessRepresentationModel[]>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/> - **getProcessFilters**(appId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`<br/>
Gets all filters defined for a Process App. Gets all filters defined for a Process App.
- _appId:_ `number` - ID of the target app - _appId:_ `number` - ID of the target app
- **Returns** [`Observable<FilterProcessRepresentationModel[]>`](../../lib/process-services/process-list/models/filter-process.model.ts) - Array of filter details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>` - Array of filter details
- **getRunningFilterInstance**(appId: `number` = `null`): [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/> - **getRunningFilterInstance**(appId: `number` = `null`): [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/>
Creates and returns a filter that matches "running" process instances. Creates and returns a filter that matches "running" process instances.
- _appId:_ `number` - ID of the target app - _appId:_ `number` - ID of the target app

4
docs/process-services/process-filters.component.md
View File

@@ -47,8 +47,8 @@ Collection of criteria used to filter process instances, which may be customized
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| filterClick | `EventEmitter<ProcessInstanceFilterRepresentation>` | Emitted when the user selects a filter from the list. | | filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`>` | Emitted when the user selects a filter from the list. |
| success | `EventEmitter<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. | | success | `EventEmitter<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. |
## Details ## Details

8
docs/process-services/process-instance-details.component.md
View File

@@ -29,7 +29,7 @@ Displays detailed information on a specified process instance
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| processCancelled | `EventEmitter<any>` | Emitted when the current process is cancelled by the user from within the component. | | processCancelled | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the current process is cancelled by the user from within the component. |
| showProcessDiagram | `EventEmitter<any>` | Emitted when the "show diagram" button is clicked. | | showProcessDiagram | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "show diagram" button is clicked. |
| taskClick | [`EventEmitter<TaskDetailsEvent>`](../../lib/process-services/task-list/models/task-details.event.ts) | Emitted when a task is clicked. | | taskClick | `EventEmitter<TaskDetailsEvent>` | Emitted when a task is clicked. |

4
docs/process-services/process-instance-tasks.component.md
View File

@@ -29,5 +29,5 @@ Lists both the active and completed tasks associated with a particular process i
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| taskClick | [`EventEmitter<TaskDetailsEvent>`](../../lib/process-services/task-list/models/task-details.event.ts) | Emitted when a task is clicked. | | taskClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsEvent`](../../lib/process-services/task-list/models/task-details.event.ts)`>` | Emitted when a task is clicked. |

23
docs/process-services/process-list.component.md
View File

@@ -8,6 +8,23 @@ Last reviewed: 2018-05-24
Renders a list containing all the process instances matched by the parameters specified. Renders a list containing all the process instances matched by the parameters specified.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Setting Sorting Order for the list](#setting-sorting-order-for-the-list)
- [Pagination strategy](#pagination-strategy)
- [Show custom template when processList is empty](#show-custom-template-when-processlist-is-empty)
- [See also](#see-also)
## Basic Usage ## Basic Usage
**app.component.html** **app.component.html**
@@ -42,9 +59,9 @@ Renders a list containing all the process instances matched by the parameters sp
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs while loading the list of process instances from the server. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while loading the list of process instances from the server. |
| rowClick | `EventEmitter<string>` | Emitted when a row in the process list is clicked. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a row in the process list is clicked. |
| success | [`EventEmitter<ProcessListModel>`](../../lib/process-services/process-list/models/process-list.model.ts) | Emitted when the list of process instances has been loaded successfully from the server. | | success | `EventEmitter<ProcessListModel>` | Emitted when the list of process instances has been loaded successfully from the server. |
## Details ## Details

48
docs/process-services/process.service.md
View File

@@ -12,58 +12,58 @@ Manages Process Instances, Process Variables, and Process Audit Log.
### Methods ### Methods
- **cancelProcess**(processInstanceId: `string` = `null`): `Observable<void>`<br/> - **cancelProcess**(processInstanceId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
Cancels a process instance. Cancels a process instance.
- _processInstanceId:_ `string` - ID of process to cancel - _processInstanceId:_ `string` - ID of process to cancel
- **Returns** `Observable<void>` - Null response notifying when the operation is complete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - Null response notifying when the operation is complete
- **createOrUpdateProcessInstanceVariables**(processInstanceId: `string` = `null`, variables: [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) = `null`): [`Observable<ProcessInstanceVariable[]>`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)<br/> - **createOrUpdateProcessInstanceVariables**(processInstanceId: `string` = `null`, variables: [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`<br/>
Creates or updates variables for a process instance. Creates or updates variables for a process instance.
- _processInstanceId:_ `string` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
- _variables:_ [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - Variables to update - _variables:_ [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` - Variables to update
- **Returns** [`Observable<ProcessInstanceVariable[]>`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - Array of instance variable info - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info
- **deleteProcessInstanceVariable**(processInstanceId: `string` = `null`, variableName: `string` = `null`): `Observable<void>`<br/> - **deleteProcessInstanceVariable**(processInstanceId: `string` = `null`, variableName: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
Deletes a variable for a process instance. Deletes a variable for a process instance.
- _processInstanceId:_ `string` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
- _variableName:_ `string` - Name of the variable to delete - _variableName:_ `string` - Name of the variable to delete
- **Returns** `Observable<void>` - Null response notifying when the operation is complete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - Null response notifying when the operation is complete
- **fetchProcessAuditJsonById**(processId: `string` = `null`): `Observable<any>`<br/> - **fetchProcessAuditJsonById**(processId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Fetches the Process Audit information in a JSON format. Fetches the Process Audit information in a JSON format.
- _processId:_ `string` - ID of the target process - _processId:_ `string` - ID of the target process
- **Returns** `Observable<any>` - JSON data - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - JSON data
- **fetchProcessAuditPdfById**(processId: `string` = `null`): `Observable<Blob>`<br/> - **fetchProcessAuditPdfById**(processId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`<br/>
Fetches the Process Audit information as a PDF. Fetches the Process Audit information as a PDF.
- _processId:_ `string` - ID of the target process - _processId:_ `string` - ID of the target process
- **Returns** `Observable<Blob>` - Binary PDF data - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data
- **getProcess**(processInstanceId: `string` = `null`): [`Observable<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts)<br/> - **getProcess**(processInstanceId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`<br/>
Gets Process Instance metadata. Gets Process Instance metadata.
- _processInstanceId:_ `string` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
- **Returns** [`Observable<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) - Metadata for the instance - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` - Metadata for the instance
- **getProcessDefinitions**(appId?: `number` = `null`): [`Observable<ProcessDefinitionRepresentation[]>`](../../lib/process-services/process-list/models/process-definition.model.ts)<br/> - **getProcessDefinitions**(appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>`<br/>
Gets process definitions associated with an app. Gets process definitions associated with an app.
- _appId:_ `number` - (Optional) ID of a target app - _appId:_ `number` - (Optional) ID of a target app
- **Returns** [`Observable<ProcessDefinitionRepresentation[]>`](../../lib/process-services/process-list/models/process-definition.model.ts) - Array of process definitions - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>` - Array of process definitions
- **getProcessInstanceVariables**(processInstanceId: `string` = `null`): [`Observable<ProcessInstanceVariable[]>`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)<br/> - **getProcessInstanceVariables**(processInstanceId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`<br/>
Gets the variables for a process instance. Gets the variables for a process instance.
- _processInstanceId:_ `string` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
- **Returns** [`Observable<ProcessInstanceVariable[]>`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - Array of instance variable info - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info
- **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) = `null`, processDefinitionKey?: `string` = `null`): [`Observable<ProcessListModel>`](../../lib/process-services/process-list/models/process-list.model.ts)<br/> - **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) = `null`, processDefinitionKey?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>`<br/>
Gets process instances for a filter and optionally a process definition. Gets process instances for a filter and optionally a process definition.
- _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - Filter for instances - _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - Filter for instances
- _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition - _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition
- **Returns** [`Observable<ProcessListModel>`](../../lib/process-services/process-list/models/process-list.model.ts) - List of process instances - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>` - List of process instances
- **getProcessTasks**(processInstanceId: `string` = `null`, state?: `string` = `null`): [`Observable<TaskDetailsModel[]>`](../process-services/task-details.model.md)<br/> - **getProcessTasks**(processInstanceId: `string` = `null`, state?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>`<br/>
Gets task instances for a process instance. Gets task instances for a process instance.
- _processInstanceId:_ `string` - ID of the process instance - _processInstanceId:_ `string` - ID of the process instance
- _state:_ `string` - (Optional) Task state filter (can be "active" or "completed") - _state:_ `string` - (Optional) Task state filter (can be "active" or "completed")
- **Returns** [`Observable<TaskDetailsModel[]>`](../process-services/task-details.model.md) - Array of task instance details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>` - Array of task instance details
- **startProcess**(processDefinitionId: `string` = `null`, name: `string` = `null`, outcome?: `string` = `null`, startFormValues?: [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) = `null`, variables?: [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) = `null`): [`Observable<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts)<br/> - **startProcess**(processDefinitionId: `string` = `null`, name: `string` = `null`, outcome?: `string` = `null`, startFormValues?: [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) = `null`, variables?: [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`<br/>
Starts a process based on a process definition, name, form values or variables. Starts a process based on a process definition, name, form values or variables.
- _processDefinitionId:_ `string` - Process definition ID - _processDefinitionId:_ `string` - Process definition ID
- _name:_ `string` - Process name - _name:_ `string` - Process name
- _outcome:_ `string` - (Optional) Process outcome - _outcome:_ `string` - (Optional) Process outcome
- _startFormValues:_ [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form - _startFormValues:_ [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form
- _variables:_ [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - (Optional) Array of process instance variables - _variables:_ [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` - (Optional) Array of process instance variables
- **Returns** [`Observable<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) - Details of the process instance just started - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` - Details of the process instance just started
## Details ## Details

2
docs/process-services/start-process.component.md
View File

@@ -162,7 +162,7 @@ const values: FormValues = {
``` ```
Note that in the object above, the key `file` is the name of the attach file field in the start form of the process. The value of the `file` property must be a Note that in the object above, the key `file` is the name of the attach file field in the start form of the process. The value of the `file` property must be a
[MinimalNodeEntryEntity](../content-services/document-library.model.md): [`MinimalNodeEntryEntity`](../content-services/document-library.model.md):
```html ```html
<adf-start-process <adf-start-process

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

@@ -29,6 +29,6 @@ Creates/Starts new task for the specified app
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| cancel | `EventEmitter<void>` | Emitted when the cancel button is clicked by the user. | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the cancel button is clicked by the user. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | `EventEmitter<any>` | Emitted when the task is successfully created. | | success | `EventEmitter<any>` | Emitted when the task is successfully created. |

4
docs/process-services/task-attachment-list.component.md
View File

@@ -32,8 +32,8 @@ Displays attached documents on a specified task.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| attachmentClick | `EventEmitter<Object>` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a Blob representing the clicked object. | | attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. |
| error | `EventEmitter<any>` | Emitted when an error occurs while fetching the attachments. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while fetching the attachments. |
| success | `EventEmitter<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | | success | `EventEmitter<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
## Details ## Details

4
docs/process-services/task-audit.directive.md
View File

@@ -36,5 +36,5 @@ Fetches the Task Audit information in PDF or JSON format.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| clicked | `EventEmitter<any>` | Emitted when the decorated element is clicked. | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the decorated element is clicked. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |

20
docs/process-services/task-details.component.md
View File

@@ -23,7 +23,7 @@ Shows the details of the task ID passed in as input.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -- | -- | -- | -- | | -- | -- | -- | -- |
| debugMode | `boolean` | false | Toggles debug mode. | | debugMode | `boolean` | false | Toggles debug mode. |
| fieldValidators | [`FormFieldValidator[]`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | \[] | Field validators for use with the form. | | fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. |
| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | | readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. |
| showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. | | showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. |
| showComments | `boolean` | true | Toggles `Comments` feature for the Header component. | | showComments | `boolean` | true | Toggles `Comments` feature for the Header component. |
@@ -41,15 +41,15 @@ Shows the details of the task ID passed in as input.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| assignTask | `EventEmitter<void>` | Emitted when a task is assigned. | | assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when a task is assigned. |
| claimedTask | `EventEmitter<string>` | Emitted when a task is claimed. | | claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task is claimed. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| executeOutcome | [`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()`. | | 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<FormModel>`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is submitted with the `Complete` outcome. | | formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter<ContentLinkModel>`](../../lib/core/form/components/widgets/core/content-link.model.ts) | Emitted when the form field content is clicked. | | formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. |
| formLoaded | [`EventEmitter<FormModel>`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is loaded or reloaded. | | formLoaded | `EventEmitter<FormModel>` | Emitted when the form is loaded or reloaded. |
| formSaved | [`EventEmitter<FormModel>`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is submitted with the `Save` or custom outcomes. | | formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| taskCreated | [`EventEmitter<TaskDetailsModel>`](../process-services/task-details.model.md) | Emitted when a checklist task is created. | | taskCreated | `EventEmitter<TaskDetailsModel>` | Emitted when a checklist task is created. |
| taskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. | | taskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
| unClaimedTask | `EventEmitter<string>` | Emitted when a task is unclaimed. | | unClaimedTask | `EventEmitter<string>` | Emitted when a task is unclaimed. |

20
docs/process-services/task-filter.service.md
View File

@@ -11,18 +11,18 @@ Manage Task Filters, which are pre-configured Task Instance queries.
### Methods ### Methods
- **addFilter**(filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/> - **addFilter**(filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`<br/>
Adds a new task filter Adds a new task filter
- _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The new filter to add - _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The new filter to add
- **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - Details of task filter just added - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` - Details of task filter just added
- **callApiTaskFilters**(appId?: `number` = `null`): `Promise<any>`<br/> - **callApiTaskFilters**(appId?: `number` = `null`): `Promise<any>`<br/>
Calls `getUserTaskFilters` from the Alfresco JS API. Calls `getUserTaskFilters` from the Alfresco JS API.
- _appId:_ `number` - (Optional) ID of the target app - _appId:_ `number` - (Optional) ID of the target app
- **Returns** `Promise<any>` - List of task filters - **Returns** `Promise<any>` - List of task filters
- **createDefaultFilters**(appId: `number` = `null`): [`Observable<FilterRepresentationModel[]>`](../../lib/process-services/task-list/models/filter.model.ts)<br/> - **createDefaultFilters**(appId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>`<br/>
Creates and returns the default filters for a process app. Creates and returns the default filters for a process app.
- _appId:_ `number` - ID of the target app - _appId:_ `number` - ID of the target app
- **Returns** [`Observable<FilterRepresentationModel[]>`](../../lib/process-services/task-list/models/filter.model.ts) - Array of default filters just created - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>` - Array of default filters just created
- **getCompletedTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)<br/> - **getCompletedTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Creates and returns a filter for "Completed" task instances. Creates and returns a filter for "Completed" task instances.
- _appId:_ `number` - ID of the target app - _appId:_ `number` - ID of the target app
@@ -39,20 +39,20 @@ Manage Task Filters, which are pre-configured Task Instance queries.
Creates and returns a filter for "Queued Tasks" task instances. Creates and returns a filter for "Queued Tasks" task instances.
- _appId:_ `number` - ID of the target app - _appId:_ `number` - ID of the target app
- **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter - **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter
- **getTaskFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/> - **getTaskFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`<br/>
Gets a task filter by ID. Gets a task filter by ID.
- _filterId:_ `number` - ID of the filter - _filterId:_ `number` - ID of the filter
- _appId:_ `number` - (Optional) ID of the app for the filter - _appId:_ `number` - (Optional) ID of the app for the filter
- **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - Details of task filter - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` - Details of task filter
- **getTaskFilterByName**(taskName: `string` = `null`, appId?: `number` = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/> - **getTaskFilterByName**(taskName: `string` = `null`, appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`<br/>
Gets a task filter by name. Gets a task filter by name.
- _taskName:_ `string` - Name of the filter - _taskName:_ `string` - Name of the filter
- _appId:_ `number` - (Optional) ID of the app for the filter - _appId:_ `number` - (Optional) ID of the app for the filter
- **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - Details of task filter - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` - Details of task filter
- **getTaskListFilters**(appId?: `number` = `null`): [`Observable<FilterRepresentationModel[]>`](../../lib/process-services/task-list/models/filter.model.ts)<br/> - **getTaskListFilters**(appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>`<br/>
Gets all task filters for a process app. Gets all task filters for a process app.
- _appId:_ `number` - (Optional) Optional ID for a specific app - _appId:_ `number` - (Optional) Optional ID for a specific app
- **Returns** [`Observable<FilterRepresentationModel[]>`](../../lib/process-services/task-list/models/filter.model.ts) - Array of task filter details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>` - Array of task filter details
## Details ## Details

4
docs/process-services/task-filters.component.md
View File

@@ -45,8 +45,8 @@ Shows all available filters.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs during loading. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during loading. |
| filterClick | [`EventEmitter<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) | Emitted when a filter in the list is clicked. | | filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` | Emitted when a filter in the list is clicked. |
| success | `EventEmitter<any>` | Emitted when the list is loaded. | | success | `EventEmitter<any>` | Emitted when the list is loaded. |
## Details ## Details

4
docs/process-services/task-header.component.md
View File

@@ -31,8 +31,8 @@ Shows all the information related to a task.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| claim | `EventEmitter<any>` | Emitted when the task is claimed. | | claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is claimed. |
| unclaim | `EventEmitter<any>` | Emitted when the task is unclaimed (ie, requeued). | | unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is unclaimed (ie, requeued). |
## Details ## Details

15
docs/process-services/task-list.component.md
View File

@@ -20,9 +20,11 @@ Renders a list containing all the tasks matched by the parameters specified.
- [Details](#details) - [Details](#details)
- [Setting the column schema](#setting-the-column-schema) - [Setting the column schema](#setting-the-column-schema)
- [Setting Sorting Order for the list](#setting-sorting-order-for-the-list)
- [Pagination strategy](#pagination-strategy) - [Pagination strategy](#pagination-strategy)
- [DataTableAdapter example](#datatableadapter-example) - [DataTableAdapter example](#datatableadapter-example)
- [DataColumn Features](#datacolumn-features) - [DataColumn Features](#datacolumn-features)
- [Show custom template when tasklist is empty](#show-custom-template-when-tasklist-is-empty)
- [See also](#see-also) - [See also](#see-also)
@@ -44,14 +46,14 @@ Renders a list containing all the tasks matched by the parameters specified.
| -- | -- | -- | -- | | -- | -- | -- | -- |
| appId | `number` | | The id of the app. | | appId | `number` | | The id of the app. |
| assignment | `string` | | The assignment of the process. Possible values are: "assignee" (the current user is the assignee), candidate (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value(the current user is involved). | | assignment | `string` | | The assignment of the process. Possible values are: "assignee" (the current user is the assignee), candidate (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value(the current user is involved). |
| data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | | Data source object that represents the number and the type of the columns that you want to show. **Deprecated:** in 2.4.0 | | data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | | **Deprecated:** 2.4.0 |
| landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. | | landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. |
| multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | | multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row |
| name | `string` | | Name of the tasklist. | | name | `string` | | Name of the tasklist. |
| page | `number` | 0 | The page number of the tasks to fetch. | | page | `number` | 0 | The page number of the tasks to fetch. |
| presetColumn | `string` | | Custom preset column schema in JSON format. |
| processDefinitionKey | `string` | | **Deprecated:** 2.4.0 | | processDefinitionKey | `string` | | **Deprecated:** 2.4.0 |
| processInstanceId | `string` | | The Instance Id of the process. | | processInstanceId | `string` | | The Instance Id of the process. |
| selectFirstRow | `boolean` | true | |
| 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. | | 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` | [`PaginationComponent`](../core/pagination.component.md).DEFAULT_PAGINATION.maxItems | The number of tasks to fetch. Default value: 25. | | size | `number` | [`PaginationComponent`](../core/pagination.component.md).DEFAULT_PAGINATION.maxItems | The number of tasks to fetch. Default value: 25. |
| sort | `string` | | Define the sort order of the tasks. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | | sort | `string` | | Define the sort order of the tasks. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` |
@@ -61,9 +63,9 @@ Renders a list containing all the tasks matched by the parameters specified.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| rowClick | `EventEmitter<string>` | Emitted when a task in the list is clicked | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task in the list is clicked |
| rowsSelected | `EventEmitter<any[]>` | Emitted when rows are selected/unselected | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | Emitted when rows are selected/unselected |
| success | `EventEmitter<any>` | Emitted when the task list is loaded | | success | `EventEmitter<any>` | Emitted when the task list is loaded |
## Details ## Details
@@ -193,7 +195,7 @@ The Tasklist also supports pagination as shown in the example below:
### DataTableAdapter example ### DataTableAdapter example
See the [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) page for full details of the interface and its standard See the [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) page for full details of the interface and its standard
implementation, [ObjectDataTableAdapter](../../lib/core/datatable/data/object-datatable-adapter.ts). Below is an example of how you can set up the adapter for a implementation, [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts). Below is an example of how you can set up the adapter for a
typical tasklist. typical tasklist.
```json ```json
@@ -220,6 +222,7 @@ You can add your own template or message as shown in the example below:
</adf-empty-custom-content> </adf-empty-custom-content>
<adf-tasklist> <adf-tasklist>
``` ```
## See also ## See also
- [Data column component](../core/data-column.component.md) - [Data column component](../core/data-column.component.md)

4
docs/process-services/task-standalone.component.md
View File

@@ -30,5 +30,5 @@ This component can be used when there is no form attached to a task.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| cancel | `EventEmitter<void>` | Emitted when the "Cancel" button is clicked. | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the "Cancel" button is clicked. |
| complete | `EventEmitter<void>` | Emitted when the form associated with the task is completed. | | complete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the form associated with the task is completed. |

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

@@ -12,101 +12,101 @@ Manages Task Instances.
### Methods ### Methods
- **addTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/> - **addTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/>
Adds a subtask (ie, a checklist task) to a parent task. Adds a subtask (ie, a checklist task) to a parent task.
- _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - The task to add - _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - The task to add
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - The subtask that was added - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - The subtask that was added
- **assignTask**(taskId: `string` = `null`, requestNode: `any` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/> - **assignTask**(taskId: `string` = `null`, requestNode: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/>
Assigns a task to a user or group. Assigns a task to a user or group.
- _taskId:_ `string` - The task to assign - _taskId:_ `string` - The task to assign
- _requestNode:_ `any` - User or group to assign the task to - _requestNode:_ `any` - User or group to assign the task to
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Details of the assigned task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Details of the assigned task
- **assignTaskByUserId**(taskId: `string` = `null`, userId: `number` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/> - **assignTaskByUserId**(taskId: `string` = `null`, userId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/>
Assigns a task to a user. Assigns a task to a user.
- _taskId:_ `string` - ID of the task to assign - _taskId:_ `string` - ID of the task to assign
- _userId:_ `number` - ID of the user to assign the task to - _userId:_ `number` - ID of the user to assign the task to
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Details of the assigned task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Details of the assigned task
- **attachFormToATask**(taskId: `string` = `null`, formId: `number` = `null`): `Observable<any>`<br/> - **attachFormToATask**(taskId: `string` = `null`, formId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Attaches a form to a task. Attaches a form to a task.
- _taskId:_ `string` - ID of the target task - _taskId:_ `string` - ID of the target task
- _formId:_ `number` - ID of the form to add - _formId:_ `number` - ID of the form to add
- **Returns** `Observable<any>` - Null response notifying when the operation is complete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null response notifying when the operation is complete
- **claimTask**(taskId: `string` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/> - **claimTask**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/>
Claims a task for the current user. Claims a task for the current user.
- _taskId:_ `string` - ID of the task to claim - _taskId:_ `string` - ID of the task to claim
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Details of the claimed task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Details of the claimed task
- **completeTask**(taskId: `string` = `null`): `Observable<any>`<br/> - **completeTask**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gives completed status to a task. Gives completed status to a task.
- _taskId:_ `string` - ID of the target task - _taskId:_ `string` - ID of the target task
- **Returns** `Observable<any>` - Null response notifying when the operation is complete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null response notifying when the operation is complete
- **createNewTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/> - **createNewTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/>
Creates a new standalone task. Creates a new standalone task.
- _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - Details of the new task - _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - Details of the new task
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Details of the newly created task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Details of the newly created task
- **deleteTask**(taskId: `string` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/> - **deleteTask**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/>
Deletes a subtask (ie, a checklist task) from a parent task. Deletes a subtask (ie, a checklist task) from a parent task.
- _taskId:_ `string` - The task to delete - _taskId:_ `string` - The task to delete
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Null response notifying when the operation is complete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Null response notifying when the operation is complete
- **fetchTaskAuditJsonById**(taskId: `string` = `null`): `Observable<any>`<br/> - **fetchTaskAuditJsonById**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Fetch the Task Audit information in JSON format Fetch the Task Audit information in JSON format
- _taskId:_ `string` - ID of the target task - _taskId:_ `string` - ID of the target task
- **Returns** `Observable<any>` - JSON data - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - JSON data
- **fetchTaskAuditPdfById**(taskId: `string` = `null`): `Observable<Blob>`<br/> - **fetchTaskAuditPdfById**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`<br/>
Fetches the Task Audit information in PDF format. Fetches the Task Audit information in PDF format.
- _taskId:_ `string` - ID of the target task - _taskId:_ `string` - ID of the target task
- **Returns** `Observable<Blob>` - Binary PDF data - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data
- **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`, state?: `string` = `null`): [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts)<br/> - **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`, state?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`<br/>
Gets all tasks matching a query and state value. Gets all tasks matching a query and state value.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks. - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks.
- _state:_ `string` - (Optional) Task state. Can be "open" or "completed". - _state:_ `string` - (Optional) Task state. Can be "open" or "completed".
- **Returns** [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts) - List of tasks - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>` - List of tasks
- **findAllTasksWithoutState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts)<br/> - **findAllTasksWithoutState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`<br/>
Gets all tasks matching the supplied query but ignoring the task state. Gets all tasks matching the supplied query but ignoring the task state.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks
- **Returns** [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts) - List of tasks - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>` - List of tasks
- **findTasksByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`, state?: `string` = `null`): [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts)<br/> - **findTasksByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`, state?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`<br/>
Gets tasks matching a query and state value. Gets tasks matching a query and state value.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks
- _state:_ `string` - (Optional) Task state. Can be "open" or "completed". - _state:_ `string` - (Optional) Task state. Can be "open" or "completed".
- **Returns** [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts) - List of tasks - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>` - List of tasks
- **getFilterForTaskById**(taskId: `string` = `null`, filterList: [`FilterRepresentationModel[]`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/> - **getFilterForTaskById**(taskId: `string` = `null`, filterList: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`<br/>
Gets all the filters in the list that belong to a task. Gets all the filters in the list that belong to a task.
- _taskId:_ `string` - ID of the target task - _taskId:_ `string` - ID of the target task
- _filterList:_ [`FilterRepresentationModel[]`](../../lib/process-services/task-list/models/filter.model.ts) - List of filters to search through - _filterList:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]` - List of filters to search through
- **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - Filters belonging to the task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` - Filters belonging to the task
- **getFormList**(): [`Observable<Form[]>`](../../lib/process-services/task-list/models/form.model.ts)<br/> - **getFormList**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Form`](../../lib/process-services/task-list/models/form.model.ts)`[]>`<br/>
Gets all available reusable forms. Gets all available reusable forms.
- **Returns** [`Observable<Form[]>`](../../lib/process-services/task-list/models/form.model.ts) - Array of form details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Form`](../../lib/process-services/task-list/models/form.model.ts)`[]>` - Array of form details
- **getTaskChecklist**(id: `string` = `null`): [`Observable<TaskDetailsModel[]>`](../process-services/task-details.model.md)<br/> - **getTaskChecklist**(id: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>`<br/>
Gets the checklist for a task. Gets the checklist for a task.
- _id:_ `string` - ID of the target task - _id:_ `string` - ID of the target task
- **Returns** [`Observable<TaskDetailsModel[]>`](../process-services/task-details.model.md) - Array of checklist task details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>` - Array of checklist task details
- **getTaskDetails**(taskId: `string` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/> - **getTaskDetails**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/>
Gets details for a task. Gets details for a task.
- _taskId:_ `string` - ID of the target task. - _taskId:_ `string` - ID of the target task.
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Task details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Task details
- **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts)<br/> - **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`<br/>
Gets all the tasks matching the supplied query. Gets all the tasks matching the supplied query.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks
- **Returns** [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts) - List of tasks - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>` - List of tasks
- **getTotalTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): `Observable<any>`<br/> - **getTotalTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets the total number of the tasks found by a query. Gets the total number of the tasks found by a query.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks
- **Returns** `Observable<any>` - Number of tasks - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Number of tasks
- **isTaskRelatedToFilter**(taskId: `string` = `null`, filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/> - **isTaskRelatedToFilter**(taskId: `string` = `null`, filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`<br/>
Checks if a taskId is filtered with the given filter. Checks if a taskId is filtered with the given filter.
- _taskId:_ `string` - ID of the target task - _taskId:_ `string` - ID of the target task
- _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The filter you want to check - _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The filter you want to check
- **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - The filter if it is related or null otherwise - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` - The filter if it is related or null otherwise
- **unclaimTask**(taskId: `string` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/> - **unclaimTask**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/>
Unclaims a task for the current user. Unclaims a task for the current user.
- _taskId:_ `string` - ID of the task to unclaim - _taskId:_ `string` - ID of the task to unclaim
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Null response notifying when the operation is complete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Null response notifying when the operation is complete
- **updateTask**(taskId: `any` = `null`, updated: `any` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/> - **updateTask**(taskId: `any` = `null`, updated: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/>
Updates the details (name, description, due date) for a task. Updates the details (name, description, due date) for a task.
- _taskId:_ `any` - ID of the task to update - _taskId:_ `any` - ID of the task to update
- _updated:_ `any` - Data to update the task (as a `TaskUpdateRepresentation` instance). - _updated:_ `any` - Data to update the task (as a `TaskUpdateRepresentation` instance).
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Updated task details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Updated task details
## Details ## Details

1
tools/doc/tools/typeLinker.js
View File

@@ -24,6 +24,7 @@ var externalTypes = {
'MinimalNodeEntity': '../content-services/document-library.model.md', 'MinimalNodeEntity': '../content-services/document-library.model.md',
'MinimalNodeEntryEntity': '../content-services/document-library.model.md', 'MinimalNodeEntryEntity': '../content-services/document-library.model.md',
'NodeEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md', 'NodeEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md',
'ProcessInstanceFilterRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md',
'RelatedContentRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md', 'RelatedContentRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md',
'SiteEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md', 'SiteEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md',
'SitePaging': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md' 'SitePaging': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md'

1
tools/doc/tools/typeLinker.ts
View File

@@ -45,6 +45,7 @@ const externalTypes = {
'MinimalNodeEntity': '../content-services/document-library.model.md', 'MinimalNodeEntity': '../content-services/document-library.model.md',
'MinimalNodeEntryEntity': '../content-services/document-library.model.md', 'MinimalNodeEntryEntity': '../content-services/document-library.model.md',
'NodeEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md', 'NodeEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md',
'ProcessInstanceFilterRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md',
'RelatedContentRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md', 'RelatedContentRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md',
'SiteEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md', 'SiteEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md',
'SitePaging': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md' 'SitePaging': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md'