From d9d37e1964f5a835509bb02e4a9e0a613d23d784 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Thu, 7 Jun 2018 14:37:47 +0100 Subject: [PATCH] [ADF-2764] Applied new type linker features to proc services docs (#3449) --- docs/process-services/apps-list.component.md | 2 +- docs/process-services/checklist.component.md | 4 +- .../create-process-attachment.component.md | 4 +- .../create-task-attachment.component.md | 4 +- .../process-services/people-list.component.md | 6 +- .../people-search.component.md | 8 +- docs/process-services/people.component.md | 2 +- .../process-attachment-list.component.md | 6 +- .../process-audit.directive.md | 4 +- .../process-comments.component.md | 2 +- .../process-filter.service.md | 20 ++--- .../process-filters.component.md | 4 +- .../process-instance-details.component.md | 8 +- .../process-instance-tasks.component.md | 4 +- .../process-list.component.md | 23 ++++- docs/process-services/process.service.md | 48 +++++----- .../start-process.component.md | 2 +- docs/process-services/start-task.component.md | 4 +- .../task-attachment-list.component.md | 4 +- docs/process-services/task-audit.directive.md | 4 +- .../task-details.component.md | 20 ++--- docs/process-services/task-filter.service.md | 20 ++--- .../task-filters.component.md | 4 +- .../process-services/task-header.component.md | 4 +- docs/process-services/task-list.component.md | 15 ++-- .../task-standalone.component.md | 4 +- docs/process-services/tasklist.service.md | 90 +++++++++---------- tools/doc/tools/typeLinker.js | 1 + tools/doc/tools/typeLinker.ts | 1 + 29 files changed, 172 insertions(+), 150 deletions(-) diff --git a/docs/process-services/apps-list.component.md b/docs/process-services/apps-list.component.md index 3c59700e44..bf452a7f17 100644 --- a/docs/process-services/apps-list.component.md +++ b/docs/process-services/apps-list.component.md @@ -43,7 +43,7 @@ If we intend to show a custom template if there are no apps present | Name | Type | Description | | -- | -- | -- | -| appClick | [`EventEmitter`](../../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` | Emitted when an error occurs. | ## Details diff --git a/docs/process-services/checklist.component.md b/docs/process-services/checklist.component.md index a91fd58517..db4a2a9bf0 100644 --- a/docs/process-services/checklist.component.md +++ b/docs/process-services/checklist.component.md @@ -31,6 +31,6 @@ Shows the checklist task functionality. | Name | Type | Description | | -- | -- | -- | -| checklistTaskCreated | [`EventEmitter`](../process-services/task-details.model.md) | Emitted when a new checklist task is created. | -| checklistTaskDeleted | `EventEmitter` | Emitted when a checklist task is deleted. | +| 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`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklitst task is deleted. | | error | `EventEmitter` | Emitted when an error occurs. | diff --git a/docs/process-services/create-process-attachment.component.md b/docs/process-services/create-process-attachment.component.md index bff3807850..0989091b9b 100644 --- a/docs/process-services/create-process-attachment.component.md +++ b/docs/process-services/create-process-attachment.component.md @@ -31,5 +31,5 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | -| success | `EventEmitter` | Emitted when an attachment is successfully created or uploaded from within the component. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is successfully created or uploaded from within the component. | diff --git a/docs/process-services/create-task-attachment.component.md b/docs/process-services/create-task-attachment.component.md index ca2315e111..f849d6887a 100644 --- a/docs/process-services/create-task-attachment.component.md +++ b/docs/process-services/create-task-attachment.component.md @@ -31,5 +31,5 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | -| success | `EventEmitter` | Emitted when an attachment is created or uploaded successfully from within the component. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is created or uploaded successfully from within the component. | diff --git a/docs/process-services/people-list.component.md b/docs/process-services/people-list.component.md index 150b78997a..6f22a54e56 100644 --- a/docs/process-services/people-list.component.md +++ b/docs/process-services/people-list.component.md @@ -79,11 +79,11 @@ Note that the [people list component](../process-services/people-list.component. | Name | Type | Default value | Description | | -- | -- | -- | -- | | 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 | Name | Type | Description | | -- | -- | -- | -| clickAction | [`EventEmitter`](../../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`](../core/user-process.model.md) | Emitted when the user clicks a row in the people list. | +| 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` | Emitted when the user clicks a row in the people list. | diff --git a/docs/process-services/people-search.component.md b/docs/process-services/people-search.component.md index 58945b7318..bced56f42d 100644 --- a/docs/process-services/people-search.component.md +++ b/docs/process-services/people-search.component.md @@ -19,15 +19,15 @@ Searches users/people. | Name | Type | Default value | Description | | -- | -- | -- | -- | -| results | [`Observable`](../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 | Name | Type | Description | | -- | -- | -- | -| closeSearch | `EventEmitter` | Emitted when the "close" button is clicked. | -| searchPeople | `EventEmitter` | Emitted when a search is performed with a new keyword. | -| success | [`EventEmitter`](../core/user-process.model.md) | Emitted when a user is selected and the action button is clicked. | +| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "close" button is clicked. | +| searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a search is performed with a new keyword. | +| success | `EventEmitter` | Emitted when a user is selected and the action button is clicked. | ## Details diff --git a/docs/process-services/people.component.md b/docs/process-services/people.component.md index 28e79e6005..957acd0826 100644 --- a/docs/process-services/people.component.md +++ b/docs/process-services/people.component.md @@ -41,7 +41,7 @@ Displays users involved with a specified task | 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? | | taskId | `string` | "" | The numeric ID of the task. | diff --git a/docs/process-services/process-attachment-list.component.md b/docs/process-services/process-attachment-list.component.md index d3b090d777..de7b6d4c9b 100644 --- a/docs/process-services/process-attachment-list.component.md +++ b/docs/process-services/process-attachment-list.component.md @@ -19,7 +19,7 @@ Displays attached documents on a specified process instance ``` -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 import { UploadService } from '@alfresco/adf-core'; @@ -49,8 +49,8 @@ export class MyCustomProcessAttachmentComponent { | Name | Type | Description | | -- | -- | -- | -| attachmentClick | `EventEmitter` | 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. | -| error | `EventEmitter` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | +| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | 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`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | | success | `EventEmitter` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/process-audit.directive.md b/docs/process-services/process-audit.directive.md index 79878b7678..51ede51907 100644 --- a/docs/process-services/process-audit.directive.md +++ b/docs/process-services/process-audit.directive.md @@ -37,5 +37,5 @@ Fetches the Process Audit information the PDF or JSON format. | Name | Type | Description | | -- | -- | -- | -| clicked | `EventEmitter` | Emitted when the decorated element is clicked. | -| error | `EventEmitter` | Emitted when an error occurs. | +| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the decorated element is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/process-comments.component.md b/docs/process-services/process-comments.component.md index 91282fad53..231b763a0b 100644 --- a/docs/process-services/process-comments.component.md +++ b/docs/process-services/process-comments.component.md @@ -28,4 +28,4 @@ Displays comments associated with a particular process instance and allows the u | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/process-filter.service.md b/docs/process-services/process-filter.service.md index 77b91bb32a..ab52e3f6fb 100644 --- a/docs/process-services/process-filter.service.md +++ b/docs/process-services/process-filter.service.md @@ -12,32 +12,32 @@ Manage Process Filters, which are pre-configured Process Instance queries. ### Methods -- **addProcessFilter**(filter: [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) = `null`): [`Observable`](../../lib/process-services/process-list/models/filter-process.model.ts)
+- **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)`>`
Adds a filter. - _filter:_ [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - The filter to add - - **Returns** [`Observable`](../../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`
Calls `getUserProcessInstanceFilters` from the Alfresco JS API. - _appId:_ `number` - (Optional) ID of the target app - **Returns** `Promise` - List of filter details -- **createDefaultFilters**(appId: `number` = `null`): [`Observable`](../../lib/process-services/process-list/models/filter-process.model.ts)
+- **createDefaultFilters**(appId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`
Creates and returns the default filters for an app. - _appId:_ `number` - ID of the target app - - **Returns** [`Observable`](../../lib/process-services/process-list/models/filter-process.model.ts) - Default filters just created -- **getProcessFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable`](../../lib/process-services/process-list/models/filter-process.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`
Retrieves the process filter by ID. - _filterId:_ `number` - ID of the filter - _appId:_ `number` - (Optional) ID of the target app - - **Returns** [`Observable`](../../lib/process-services/process-list/models/filter-process.model.ts) - Details of the filter -- **getProcessFilterByName**(filterName: `string` = `null`, appId?: `number` = `null`): [`Observable`](../../lib/process-services/process-list/models/filter-process.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`
Retrieves the process filter by name. - _filterName:_ `string` - Name of the filter - _appId:_ `number` - (Optional) ID of the target app - - **Returns** [`Observable`](../../lib/process-services/process-list/models/filter-process.model.ts) - Details of the filter -- **getProcessFilters**(appId: `number` = `null`): [`Observable`](../../lib/process-services/process-list/models/filter-process.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`
Gets all filters defined for a Process App. - _appId:_ `number` - ID of the target app - - **Returns** [`Observable`](../../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)
Creates and returns a filter that matches "running" process instances. - _appId:_ `number` - ID of the target app diff --git a/docs/process-services/process-filters.component.md b/docs/process-services/process-filters.component.md index 4f26f14182..14b2b83a14 100644 --- a/docs/process-services/process-filters.component.md +++ b/docs/process-services/process-filters.component.md @@ -47,8 +47,8 @@ Collection of criteria used to filter process instances, which may be customized | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs. | -| filterClick | `EventEmitter` | Emitted when the user selects a filter from the list. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| 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` | Emitted when the list of filters has been successfully loaded from the server. | ## Details diff --git a/docs/process-services/process-instance-details.component.md b/docs/process-services/process-instance-details.component.md index f67bf60a65..3eb0c160f4 100644 --- a/docs/process-services/process-instance-details.component.md +++ b/docs/process-services/process-instance-details.component.md @@ -29,7 +29,7 @@ Displays detailed information on a specified process instance | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs. | -| processCancelled | `EventEmitter` | Emitted when the current process is cancelled by the user from within the component. | -| showProcessDiagram | `EventEmitter` | Emitted when the "show diagram" button is clicked. | -| taskClick | [`EventEmitter`](../../lib/process-services/task-list/models/task-details.event.ts) | Emitted when a task is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| processCancelled | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the current process is cancelled by the user from within the component. | +| showProcessDiagram | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "show diagram" button is clicked. | +| taskClick | `EventEmitter` | Emitted when a task is clicked. | diff --git a/docs/process-services/process-instance-tasks.component.md b/docs/process-services/process-instance-tasks.component.md index 81cddc0b2e..9f9e49c208 100644 --- a/docs/process-services/process-instance-tasks.component.md +++ b/docs/process-services/process-instance-tasks.component.md @@ -29,5 +29,5 @@ Lists both the active and completed tasks associated with a particular process i | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs. | -| taskClick | [`EventEmitter`](../../lib/process-services/task-list/models/task-details.event.ts) | Emitted when a task is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| 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. | diff --git a/docs/process-services/process-list.component.md b/docs/process-services/process-list.component.md index 1df9f32e0a..a7b42b8a60 100644 --- a/docs/process-services/process-list.component.md +++ b/docs/process-services/process-list.component.md @@ -8,6 +8,23 @@ Last reviewed: 2018-05-24 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 **app.component.html** @@ -42,9 +59,9 @@ Renders a list containing all the process instances matched by the parameters sp | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs while loading the list of process instances from the server. | -| rowClick | `EventEmitter` | Emitted when a row in the process list is clicked. | -| success | [`EventEmitter`](../../lib/process-services/process-list/models/process-list.model.ts) | Emitted when the list of process instances has been loaded successfully from the server. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | +| success | `EventEmitter` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details diff --git a/docs/process-services/process.service.md b/docs/process-services/process.service.md index 33e1b7f1e5..dd65a3439d 100644 --- a/docs/process-services/process.service.md +++ b/docs/process-services/process.service.md @@ -12,58 +12,58 @@ Manages Process Instances, Process Variables, and Process Audit Log. ### Methods -- **cancelProcess**(processInstanceId: `string` = `null`): `Observable`
+- **cancelProcess**(processInstanceId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Cancels a process instance. - _processInstanceId:_ `string` - ID of process to cancel - - **Returns** `Observable` - 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`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - 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`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
Creates or updates variables for a process instance. - _processInstanceId:_ `string` - ID of the target process - - _variables:_ [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - Variables to update - - **Returns** [`Observable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - Array of instance variable info -- **deleteProcessInstanceVariable**(processInstanceId: `string` = `null`, variableName: `string` = `null`): `Observable`
+ - _variables:_ [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` - Variables to update + - **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`](http://reactivex.io/documentation/observable.html)``
Deletes a variable for a process instance. - _processInstanceId:_ `string` - ID of the target process - _variableName:_ `string` - Name of the variable to delete - - **Returns** `Observable` - Null response notifying when the operation is complete -- **fetchProcessAuditJsonById**(processId: `string` = `null`): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +- **fetchProcessAuditJsonById**(processId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Fetches the Process Audit information in a JSON format. - _processId:_ `string` - ID of the target process - - **Returns** `Observable` - JSON data -- **fetchProcessAuditPdfById**(processId: `string` = `null`): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - JSON data +- **fetchProcessAuditPdfById**(processId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Fetches the Process Audit information as a PDF. - _processId:_ `string` - ID of the target process - - **Returns** `Observable` - Binary PDF data -- **getProcess**(processInstanceId: `string` = `null`): [`Observable`](../../lib/process-services/process-list/models/process-instance.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`
Gets Process Instance metadata. - _processInstanceId:_ `string` - ID of the target process - - **Returns** [`Observable`](../../lib/process-services/process-list/models/process-instance.model.ts) - Metadata for the instance -- **getProcessDefinitions**(appId?: `number` = `null`): [`Observable`](../../lib/process-services/process-list/models/process-definition.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>`
Gets process definitions associated with an app. - _appId:_ `number` - (Optional) ID of a target app - - **Returns** [`Observable`](../../lib/process-services/process-list/models/process-definition.model.ts) - Array of process definitions -- **getProcessInstanceVariables**(processInstanceId: `string` = `null`): [`Observable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
Gets the variables for a process instance. - _processInstanceId:_ `string` - ID of the target process - - **Returns** [`Observable`](../../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`](../../lib/process-services/process-list/models/process-list.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>`
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 - _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition - - **Returns** [`Observable`](../../lib/process-services/process-list/models/process-list.model.ts) - List of process instances -- **getProcessTasks**(processInstanceId: `string` = `null`, state?: `string` = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>`
Gets task instances for a process instance. - _processInstanceId:_ `string` - ID of the process instance - _state:_ `string` - (Optional) Task state filter (can be "active" or "completed") - - **Returns** [`Observable`](../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`](../../lib/process-services/process-list/models/process-instance.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`
Starts a process based on a process definition, name, form values or variables. - _processDefinitionId:_ `string` - Process definition ID - _name:_ `string` - Process name - _outcome:_ `string` - (Optional) Process outcome - _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 - - **Returns** [`Observable`](../../lib/process-services/process-list/models/process-instance.model.ts) - Details of the process instance just started + - _variables:_ [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` - (Optional) Array of process instance variables + - **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 diff --git a/docs/process-services/start-process.component.md b/docs/process-services/start-process.component.md index 913d60a3d6..b6a9e37643 100644 --- a/docs/process-services/start-process.component.md +++ b/docs/process-services/start-process.component.md @@ -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 -[MinimalNodeEntryEntity](../content-services/document-library.model.md): +[`MinimalNodeEntryEntity`](../content-services/document-library.model.md): ```html ` | Emitted when the cancel button is clicked by the user. | -| error | `EventEmitter` | Emitted when an error occurs. | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | success | `EventEmitter` | Emitted when the task is successfully created. | diff --git a/docs/process-services/task-attachment-list.component.md b/docs/process-services/task-attachment-list.component.md index d6d6a92ec0..b1821017df 100644 --- a/docs/process-services/task-attachment-list.component.md +++ b/docs/process-services/task-attachment-list.component.md @@ -32,8 +32,8 @@ Displays attached documents on a specified task. | Name | Type | Description | | -- | -- | -- | -| attachmentClick | `EventEmitter` | 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. | -| error | `EventEmitter` | Emitted when an error occurs while fetching the attachments. | +| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | 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`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while fetching the attachments. | | success | `EventEmitter` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/task-audit.directive.md b/docs/process-services/task-audit.directive.md index d7e2bcc7a7..e97d549cae 100644 --- a/docs/process-services/task-audit.directive.md +++ b/docs/process-services/task-audit.directive.md @@ -36,5 +36,5 @@ Fetches the Task Audit information in PDF or JSON format. | Name | Type | Description | | -- | -- | -- | -| clicked | `EventEmitter` | Emitted when the decorated element is clicked. | -| error | `EventEmitter` | Emitted when an error occurs. | +| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the decorated element is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/task-details.component.md b/docs/process-services/task-details.component.md index 4e2ae1f9c2..72fd58c8a3 100644 --- a/docs/process-services/task-details.component.md +++ b/docs/process-services/task-details.component.md @@ -23,7 +23,7 @@ Shows the details of the task ID passed in as input. | Name | Type | Default value | Description | | -- | -- | -- | -- | | 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. | | showChecklist | `boolean` | true | Toggles `Checklist` 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 | | -- | -- | -- | -| assignTask | `EventEmitter` | Emitted when a task is assigned. | -| claimedTask | `EventEmitter` | Emitted when a task is claimed. | -| error | `EventEmitter` | Emitted when an error occurs. | -| executeOutcome | [`EventEmitter`](../../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`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](../../lib/core/form/components/widgets/core/content-link.model.ts) | Emitted when the form field content is clicked. | -| formLoaded | [`EventEmitter`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is loaded or reloaded. | -| formSaved | [`EventEmitter`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is submitted with the `Save` or custom outcomes. | -| taskCreated | [`EventEmitter`](../process-services/task-details.model.md) | Emitted when a checklist task is created. | +| assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is assigned. | +| claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is claimed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an 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)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| 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` | Emitted when the form is loaded or reloaded. | +| formSaved | `EventEmitter` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| taskCreated | `EventEmitter` | Emitted when a checklist task is created. | | taskDeleted | `EventEmitter` | Emitted when a checklist task is deleted. | | unClaimedTask | `EventEmitter` | Emitted when a task is unclaimed. | diff --git a/docs/process-services/task-filter.service.md b/docs/process-services/task-filter.service.md index 526be8b118..18d8914f69 100644 --- a/docs/process-services/task-filter.service.md +++ b/docs/process-services/task-filter.service.md @@ -11,18 +11,18 @@ Manage Task Filters, which are pre-configured Task Instance queries. ### Methods -- **addFilter**(filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](../../lib/process-services/task-list/models/filter.model.ts)
+- **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)`>`
Adds a new task filter - _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The new filter to add - - **Returns** [`Observable`](../../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`
Calls `getUserTaskFilters` from the Alfresco JS API. - _appId:_ `number` - (Optional) ID of the target app - **Returns** `Promise` - List of task filters -- **createDefaultFilters**(appId: `number` = `null`): [`Observable`](../../lib/process-services/task-list/models/filter.model.ts)
+- **createDefaultFilters**(appId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>`
Creates and returns the default filters for a process app. - _appId:_ `number` - ID of the target app - - **Returns** [`Observable`](../../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)
Creates and returns a filter for "Completed" task instances. - _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. - _appId:_ `number` - ID of the target app - **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter -- **getTaskFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable`](../../lib/process-services/task-list/models/filter.model.ts)
+- **getTaskFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
Gets a task filter by ID. - _filterId:_ `number` - ID of the filter - _appId:_ `number` - (Optional) ID of the app for the filter - - **Returns** [`Observable`](../../lib/process-services/task-list/models/filter.model.ts) - Details of task filter -- **getTaskFilterByName**(taskName: `string` = `null`, appId?: `number` = `null`): [`Observable`](../../lib/process-services/task-list/models/filter.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
Gets a task filter by name. - _taskName:_ `string` - Name of the filter - _appId:_ `number` - (Optional) ID of the app for the filter - - **Returns** [`Observable`](../../lib/process-services/task-list/models/filter.model.ts) - Details of task filter -- **getTaskListFilters**(appId?: `number` = `null`): [`Observable`](../../lib/process-services/task-list/models/filter.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>`
Gets all task filters for a process app. - _appId:_ `number` - (Optional) Optional ID for a specific app - - **Returns** [`Observable`](../../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 diff --git a/docs/process-services/task-filters.component.md b/docs/process-services/task-filters.component.md index 33abe69996..731e289c9f 100644 --- a/docs/process-services/task-filters.component.md +++ b/docs/process-services/task-filters.component.md @@ -45,8 +45,8 @@ Shows all available filters. | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs during loading. | -| filterClick | [`EventEmitter`](../../lib/process-services/task-list/models/filter.model.ts) | Emitted when a filter in the list is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | +| 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` | Emitted when the list is loaded. | ## Details diff --git a/docs/process-services/task-header.component.md b/docs/process-services/task-header.component.md index fd6f56cfa5..4fb2d6e1fd 100644 --- a/docs/process-services/task-header.component.md +++ b/docs/process-services/task-header.component.md @@ -31,8 +31,8 @@ Shows all the information related to a task. | Name | Type | Description | | -- | -- | -- | -| claim | `EventEmitter` | Emitted when the task is claimed. | -| unclaim | `EventEmitter` | Emitted when the task is unclaimed (ie, requeued). | +| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued). | ## Details diff --git a/docs/process-services/task-list.component.md b/docs/process-services/task-list.component.md index b1b88ec7b4..f8e879cb2d 100644 --- a/docs/process-services/task-list.component.md +++ b/docs/process-services/task-list.component.md @@ -20,9 +20,11 @@ Renders a list containing all the tasks matched by the parameters specified. - [Details](#details) - [Setting the column schema](#setting-the-column-schema) + - [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) - [Pagination strategy](#pagination-strategy) - [DataTableAdapter example](#datatableadapter-example) - [DataColumn Features](#datacolumn-features) + - [Show custom template when tasklist is empty](#show-custom-template-when-tasklist-is-empty) - [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. | | 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. | | multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | | name | `string` | | Name of the tasklist. | | 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 | | 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. | | 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` | @@ -61,9 +63,9 @@ Renders a list containing all the tasks matched by the parameters specified. | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs. | -| rowClick | `EventEmitter` | Emitted when a task in the list is clicked | -| rowsSelected | `EventEmitter` | Emitted when rows are selected/unselected | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | +| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | | success | `EventEmitter` | Emitted when the task list is loaded | ## Details @@ -193,7 +195,7 @@ The Tasklist also supports pagination as shown in the example below: ### DataTableAdapter example 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. ```json @@ -220,6 +222,7 @@ You can add your own template or message as shown in the example below: ``` + ## See also - [Data column component](../core/data-column.component.md) diff --git a/docs/process-services/task-standalone.component.md b/docs/process-services/task-standalone.component.md index 2c62742a42..b471db701e 100644 --- a/docs/process-services/task-standalone.component.md +++ b/docs/process-services/task-standalone.component.md @@ -30,5 +30,5 @@ This component can be used when there is no form attached to a task. | Name | Type | Description | | -- | -- | -- | -| cancel | `EventEmitter` | Emitted when the "Cancel" button is clicked. | -| complete | `EventEmitter` | Emitted when the form associated with the task is completed. | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | +| complete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | diff --git a/docs/process-services/tasklist.service.md b/docs/process-services/tasklist.service.md index 416c4be988..7bfb6eac2d 100644 --- a/docs/process-services/tasklist.service.md +++ b/docs/process-services/tasklist.service.md @@ -12,101 +12,101 @@ Manages Task Instances. ### Methods -- **addTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable`](../process-services/task-details.model.md)
+- **addTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Adds a subtask (ie, a checklist task) to a parent task. - _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - The task to add - - **Returns** [`Observable`](../process-services/task-details.model.md) - The subtask that was added -- **assignTask**(taskId: `string` = `null`, requestNode: `any` = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Assigns a task to a user or group. - _taskId:_ `string` - The task to assign - _requestNode:_ `any` - User or group to assign the task to - - **Returns** [`Observable`](../process-services/task-details.model.md) - Details of the assigned task -- **assignTaskByUserId**(taskId: `string` = `null`, userId: `number` = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Assigns a task to a user. - _taskId:_ `string` - ID of the task to assign - _userId:_ `number` - ID of the user to assign the task to - - **Returns** [`Observable`](../process-services/task-details.model.md) - Details of the assigned task -- **attachFormToATask**(taskId: `string` = `null`, formId: `number` = `null`): `Observable`
+ - **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`](http://reactivex.io/documentation/observable.html)``
Attaches a form to a task. - _taskId:_ `string` - ID of the target task - _formId:_ `number` - ID of the form to add - - **Returns** `Observable` - Null response notifying when the operation is complete -- **claimTask**(taskId: `string` = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +- **claimTask**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Claims a task for the current user. - _taskId:_ `string` - ID of the task to claim - - **Returns** [`Observable`](../process-services/task-details.model.md) - Details of the claimed task -- **completeTask**(taskId: `string` = `null`): `Observable`
+ - **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`](http://reactivex.io/documentation/observable.html)``
Gives completed status to a task. - _taskId:_ `string` - ID of the target task - - **Returns** `Observable` - Null response notifying when the operation is complete -- **createNewTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +- **createNewTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Creates a new standalone task. - _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - Details of the new task - - **Returns** [`Observable`](../process-services/task-details.model.md) - Details of the newly created task -- **deleteTask**(taskId: `string` = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Deletes a subtask (ie, a checklist task) from a parent task. - _taskId:_ `string` - The task to delete - - **Returns** [`Observable`](../process-services/task-details.model.md) - Null response notifying when the operation is complete -- **fetchTaskAuditJsonById**(taskId: `string` = `null`): `Observable`
+ - **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`](http://reactivex.io/documentation/observable.html)``
Fetch the Task Audit information in JSON format - _taskId:_ `string` - ID of the target task - - **Returns** `Observable` - JSON data -- **fetchTaskAuditPdfById**(taskId: `string` = `null`): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - JSON data +- **fetchTaskAuditPdfById**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Fetches the Task Audit information in PDF format. - _taskId:_ `string` - ID of the target task - - **Returns** `Observable` - Binary PDF data -- **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`, state?: `string` = `null`): [`Observable`](../../lib/process-services/task-list/models/task-list.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`
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. - _state:_ `string` - (Optional) Task state. Can be "open" or "completed". - - **Returns** [`Observable`](../../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`](../../lib/process-services/task-list/models/task-list.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`
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 - - **Returns** [`Observable`](../../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`](../../lib/process-services/task-list/models/task-list.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`
Gets tasks matching a query and state value. - _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". - - **Returns** [`Observable`](../../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`](../../lib/process-services/task-list/models/filter.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
Gets all the filters in the list that belong to a 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 - - **Returns** [`Observable`](../../lib/process-services/task-list/models/filter.model.ts) - Filters belonging to the task -- **getFormList**(): [`Observable`](../../lib/process-services/task-list/models/form.model.ts)
+ - _filterList:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]` - List of filters to search through + - **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`](http://reactivex.io/documentation/observable.html)`<`[`Form`](../../lib/process-services/task-list/models/form.model.ts)`[]>`
Gets all available reusable forms. - - **Returns** [`Observable`](../../lib/process-services/task-list/models/form.model.ts) - Array of form details -- **getTaskChecklist**(id: `string` = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>`
Gets the checklist for a task. - _id:_ `string` - ID of the target task - - **Returns** [`Observable`](../process-services/task-details.model.md) - Array of checklist task details -- **getTaskDetails**(taskId: `string` = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Gets details for a task. - _taskId:_ `string` - ID of the target task. - - **Returns** [`Observable`](../process-services/task-details.model.md) - Task details -- **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](../../lib/process-services/task-list/models/task-list.model.ts)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`
Gets all the tasks matching the supplied query. - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks - - **Returns** [`Observable`](../../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`
+ - **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`](http://reactivex.io/documentation/observable.html)``
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 - - **Returns** `Observable` - Number of tasks -- **isTaskRelatedToFilter**(taskId: `string` = `null`, filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](../../lib/process-services/task-list/models/filter.model.ts)
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Number of tasks +- **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)`>`
Checks if a taskId is filtered with the given filter. - _taskId:_ `string` - ID of the target task - _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The filter you want to check - - **Returns** [`Observable`](../../lib/process-services/task-list/models/filter.model.ts) - The filter if it is related or null otherwise -- **unclaimTask**(taskId: `string` = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Unclaims a task for the current user. - _taskId:_ `string` - ID of the task to unclaim - - **Returns** [`Observable`](../process-services/task-details.model.md) - Null response notifying when the operation is complete -- **updateTask**(taskId: `any` = `null`, updated: `any` = `null`): [`Observable`](../process-services/task-details.model.md)
+ - **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`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
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` instance). - - **Returns** [`Observable`](../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 diff --git a/tools/doc/tools/typeLinker.js b/tools/doc/tools/typeLinker.js index 330955f1de..1a2d315c94 100644 --- a/tools/doc/tools/typeLinker.js +++ b/tools/doc/tools/typeLinker.js @@ -24,6 +24,7 @@ var externalTypes = { 'MinimalNodeEntity': '../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', + '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', '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' diff --git a/tools/doc/tools/typeLinker.ts b/tools/doc/tools/typeLinker.ts index 8a25e1d555..56d86c13ca 100644 --- a/tools/doc/tools/typeLinker.ts +++ b/tools/doc/tools/typeLinker.ts @@ -45,6 +45,7 @@ const externalTypes = { 'MinimalNodeEntity': '../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', + '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', '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'