[ADF-3551] Doc review updates (#3793)

* [ADF-3551] Updated docs and JSDocs

* [ADF-3551] Updated docs and JSDocs

* [ADF-3551] Updated docs and JSDocs
This commit is contained in:
Andy Stark
2018-09-14 14:41:25 +01:00
committed by Eugenio Romano
parent a67263462c
commit 58d765a355
18 changed files with 104 additions and 54 deletions

View File

@@ -1,7 +1,7 @@
--- ---
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-05-08 Last reviewed: 2018-09-14
--- ---
# Node Permission service # Node Permission service
@@ -22,26 +22,23 @@ Manages role permissions for content nodes.
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - The target node - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - The target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Array of strings representing the roles - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Array of strings representing the roles
- **removePermission**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), permissionToRemove: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/> - **removePermission**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), permissionToRemove: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
Removes a permission setting from a node.
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - ID of the target node
- _permissionToRemove:_ `PermissionElement` - - _permissionToRemove:_ `PermissionElement` - Permission setting to remove
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with modified permissions
- **updateLocallySetPermissions**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), nodes: [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/> - **updateLocallySetPermissions**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), nodes: [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
Updates the locally set permissions for a node.
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - ID of the target node
- _nodes:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - - _nodes:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - Permission settings
- _nodeRole:_ `string[]` - - _nodeRole:_ `string[]` - Permission role
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permissions
- **updateNodePermissions**(nodeId: `string`, permissionList: [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/> - **updateNodePermissions**(nodeId: `string`, permissionList: [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
Update permissions for a node.
- _nodeId:_ `string` - - _nodeId:_ `string` - ID of the target node
- _permissionList:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - - _permissionList:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - New permission settings
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permissions
- **updatePermissionRole**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), updatedPermissionRole: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/> - **updatePermissionRole**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), updatedPermissionRole: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
Updates the permission for a node. Updates the permission role for a node.
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Target node - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Target node
- _updatedPermissionRole:_ `PermissionElement` - Permission role to update or add - _updatedPermissionRole:_ `PermissionElement` - Permission role to update or add
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permission - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permission

View File

@@ -1,15 +1,26 @@
--- ---
Added: v2.3.0 Added: v2.3.0
Status: Active Status: Active
Last reviewed: 2018-09-14
--- ---
# Search Chip List Component # Search Chip List Component
Displays search criteria as a set of "chips". Displays search criteria as a set of "chips".
![Selected Facets](../docassets/images/selected-facets.png)
## Basic usage
```html ```html
<adf-search-chip-list [searchFilter]="searchFilter"></adf-search-chip-list> <adf-search-chip-list [searchFilter]="searchFilter"></adf-search-chip-list>
<adf-search-filter #searchFilter></adf-search-filter> <adf-search-filter #searchFilter></adf-search-filter>
``` ```
![Selected Facets](../docassets/images/selected-facets.png) ## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| searchFilter | [`SearchFilterComponent`](../content-services/search-filter.component.md) | | Search filter to supply the data for the chips. |

View File

@@ -1,6 +1,7 @@
--- ---
Added: v2.1.0 Added: v2.1.0
Status: Active Status: Active
Last reviewed: 2018-09-14
--- ---
# Sidebar action menu component # Sidebar action menu component
@@ -44,7 +45,7 @@ the following names:
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| expanded | `boolean` | | Toggle the sidebar action menu on expand. | | expanded | `boolean` | | Toggle the sidebar action menu on expand. |
| title | `string` | | The title of the sidebar action. | | title | `string` | | The title of the sidebar action. |
| width | `number` | 272 | Width in pixels for sidebar action menu options | | width | `number` | 272 | Width in pixels for sidebar action menu options. |
## Details ## Details

View File

@@ -1,7 +1,7 @@
--- ---
Added: v2.3.0 Added: v2.3.0
Status: Active Status: Active
Last reviewed: 2018-06-08 Last reviewed: 2018-09-14
--- ---
# Sidenav Layout component # Sidenav Layout component
@@ -69,17 +69,17 @@ sub-components (note the use of `<ng-template>` in the sub-components' body sect
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? | | expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? |
| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region | | hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. |
| sidenavMax | `number` | | Maximum size of the navigation region | | position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. |
| sidenavMin | `number` | | Minimum size of the navigation region | | sidenavMax | `number` | | Maximum size of the navigation region. |
| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration | | sidenavMin | `number` | | Minimum size of the navigation region. |
| position | `string` | 'start' | The side that the drawer is attached to 'start' or 'end' page | | stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes | | expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. |
## Details ## Details

View File

@@ -1,7 +1,7 @@
--- ---
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-04-16 Last reviewed: 2018-09-14
--- ---
# User Preferences Service # User Preferences Service
@@ -33,7 +33,7 @@ Stores preferences for components.
- **hasItem**(property: `string`): `boolean`<br/> - **hasItem**(property: `string`): `boolean`<br/>
Check if an item is present in the storage Check if an item is present in the storage
- _property:_ `string` - Name of the property - _property:_ `string` - Name of the property
- **Returns** `boolean` - - **Returns** `boolean` - True if the item is present, false otherwise
- **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> - **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Sets up a callback to notify when a property has changed. Sets up a callback to notify when a property has changed.
- _property:_ `string` - The property to watch - _property:_ `string` - The property to watch

View File

@@ -1,7 +1,7 @@
--- ---
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-03-07 Last reviewed: 2018-09-14
--- ---
# Viewer component # Viewer component
@@ -109,12 +109,12 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
| download | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Download' button. | | download | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Download' button. |
| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the filename extension changes. | | extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the filename extension changes. |
| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Back' button. | | goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Back' button. |
| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the shared link used is not valid. |
| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when user clicks 'Navigate Before' ("&lt;") button. | | navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when user clicks 'Navigate Before' ("&lt;") button. |
| navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when user clicks 'Navigate Next' (">") button. | | navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when user clicks 'Navigate Next' (">") button. |
| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Print' button. | | print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Print' button. |
| share | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Share' button. | | share | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Share' button. |
| showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the viewer is shown or hidden. | | showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the viewer is shown or hidden. |
| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the shared link used is not valid. |
## Keyboard shortcuts ## Keyboard shortcuts
@@ -179,7 +179,7 @@ You can provide custom file parameters, for example a value for the `mimeType` o
### Supported file formats ### Supported file formats
The [Viewer component](../core/viewer.component.md) consists of separate Views that handle particular types of type families based on either a file extension or a mime type: The [Viewer component](../core/viewer.component.md) consists of separate Views that handle particular types or type families based on either a file extension or a mime type:
- PDF View - PDF View
- application/pdf - application/pdf
@@ -265,7 +265,7 @@ The [Viewer component](../core/viewer.component.md) now should be able to displa
### Extending the Viewer ### Extending the Viewer
You can define your own custom handle to handle other file formats that are not yet supported by You can define your own custom handler to handle other file formats that are not yet supported by
the [Viewer component](../core/viewer.component.md). Below is an example that shows how to use the `adf-viewer-extension` the [Viewer component](../core/viewer.component.md). Below is an example that shows how to use the `adf-viewer-extension`
to handle 3D data files: to handle 3D data files:

View File

@@ -1,6 +1,7 @@
--- ---
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-09-14
--- ---
# Attach Form component # Attach Form component
@@ -21,7 +22,7 @@ This component can be used when there is no form attached to a task and we want
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| formKey | `any` | | | | formKey | `any` | | Identifier of the form to attach. |
| taskId | `any` | | Id of the task. | | taskId | `any` | | Id of the task. |
### Events ### Events
@@ -29,5 +30,5 @@ This component can be used when there is no form attached to a task and we want
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| cancelAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the "Cancel" button is clicked. | | cancelAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the "Cancel" button is clicked. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the form is attached successfully. |

View File

@@ -1,6 +1,7 @@
--- ---
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-09-14
--- ---
# Process Filters Component # Process Filters Component
@@ -43,9 +44,9 @@ Collection of criteria used to filter process instances, which may be customized
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<ProcessInstanceFilterRepresentation>` | Emitted when the user selects a filter from the list. | | filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<UserProcessInstanceFilterRepresentation>` | Emitted when the user selects a filter from the list. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. |
| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<ProcessInstanceFilterRepresentation>` | Emitted when a process filter is selected. | | filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<ProcessInstanceFilterRepresentation>` | Emitted when a process filter is selected. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. |
## Details ## Details

View File

@@ -1,7 +1,7 @@
--- ---
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-03-22 Last reviewed: 2018-09-14
--- ---
# Tasklist Service # Tasklist Service
@@ -35,10 +35,10 @@ Manages Task Instances.
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`](http://reactivex.io/documentation/observable.html)`<`[`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`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> - **completeTask**(taskId: `string`): `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`](http://reactivex.io/documentation/observable.html)`<any>` - Null response notifying when the operation is complete - **Returns** `any` - Null response notifying when the operation is complete
- **createNewTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/> - **createNewTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md)): [`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
@@ -59,20 +59,20 @@ Manages Task Instances.
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`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/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), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<TaskListModel>`<br/> - **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts), state?: `string`): [`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`](http://reactivex.io/documentation/observable.html)`<TaskListModel>` - 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)): [`Observable`](http://reactivex.io/documentation/observable.html)`<TaskListModel>`<br/> - **findAllTasksWithoutState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`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`](http://reactivex.io/documentation/observable.html)`<TaskListModel>` - 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), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<TaskListModel>`<br/> - **findTasksByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts), state?: `string`): [`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`](http://reactivex.io/documentation/observable.html)`<TaskListModel>` - 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`, filterList: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`<br/> - **getFilterForTaskById**(taskId: `string`, filterList: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]`): [`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
@@ -89,18 +89,18 @@ Manages Task Instances.
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`](http://reactivex.io/documentation/observable.html)`<`[`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)): [`Observable`](http://reactivex.io/documentation/observable.html)`<TaskListModel>`<br/> - **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`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`](http://reactivex.io/documentation/observable.html)`<TaskListModel>` - 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)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> - **getTotalTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`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`](http://reactivex.io/documentation/observable.html)`<any>` - Number of tasks - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Number of tasks
- **isTaskRelatedToFilter**(taskId: `string`, filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`<br/> - **isTaskRelatedToFilter**(taskId: `string`, filterModel: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`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 - _filterModel:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The filter you want to check
- **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 - **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`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`<br/> - **unclaimTask**(taskId: `string`): [`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.

View File

@@ -51,7 +51,7 @@ export class NodePermissionService {
} }
/** /**
* Updates the permission for a node. * Updates the permission role for a node.
* @param node Target node * @param node Target node
* @param updatedPermissionRole Permission role to update or add * @param updatedPermissionRole Permission role to update or add
* @returns Node with updated permission * @returns Node with updated permission
@@ -68,6 +68,12 @@ export class NodePermissionService {
return this.nodeService.updateNode(node.id, permissionBody); return this.nodeService.updateNode(node.id, permissionBody);
} }
/**
* Update permissions for a node.
* @param nodeId ID of the target node
* @param permissionList New permission settings
* @returns Node with updated permissions
*/
updateNodePermissions(nodeId: string, permissionList: MinimalNodeEntity[]): Observable<MinimalNodeEntryEntity> { updateNodePermissions(nodeId: string, permissionList: MinimalNodeEntity[]): Observable<MinimalNodeEntryEntity> {
return this.nodeService.getNode(nodeId).pipe( return this.nodeService.getNode(nodeId).pipe(
switchMap(node => { switchMap(node => {
@@ -79,6 +85,13 @@ export class NodePermissionService {
); );
} }
/**
* Updates the locally set permissions for a node.
* @param node ID of the target node
* @param nodes Permission settings
* @param nodeRole Permission role
* @returns Node with updated permissions
*/
updateLocallySetPermissions(node: MinimalNodeEntryEntity, nodes: MinimalNodeEntity[], nodeRole: string[]): Observable<MinimalNodeEntryEntity> { updateLocallySetPermissions(node: MinimalNodeEntryEntity, nodes: MinimalNodeEntity[], nodeRole: string[]): Observable<MinimalNodeEntryEntity> {
let permissionBody = { permissions: { locallySet: []} }; let permissionBody = { permissions: { locallySet: []} };
const permissionList = this.transformNodeToPermissionElement(nodes, nodeRole[0]); const permissionList = this.transformNodeToPermissionElement(nodes, nodeRole[0]);
@@ -124,6 +137,12 @@ export class NodePermissionService {
}); });
} }
/**
* Removes a permission setting from a node.
* @param node ID of the target node
* @param permissionToRemove Permission setting to remove
* @returns Node with modified permissions
*/
removePermission(node: MinimalNodeEntryEntity, permissionToRemove: PermissionElement): Observable<MinimalNodeEntryEntity> { removePermission(node: MinimalNodeEntryEntity, permissionToRemove: PermissionElement): Observable<MinimalNodeEntryEntity> {
let permissionBody = { permissions: { locallySet: [] } }; let permissionBody = { permissions: { locallySet: [] } };
const index = node.permissions.locallySet.map((permission) => permission.authorityId).indexOf(permissionToRemove.authorityId); const index = node.permissions.locallySet.map((permission) => permission.authorityId).indexOf(permissionToRemove.authorityId);

View File

@@ -26,6 +26,7 @@ import { SearchFilterComponent } from '../../components/search-filter/search-fil
}) })
export class SearchChipListComponent { export class SearchChipListComponent {
/** Search filter to supply the data for the chips. */
@Input() @Input()
searchFilter: SearchFilterComponent; searchFilter: SearchFilterComponent;
} }

View File

@@ -36,6 +36,7 @@ export class SidebarActionMenuComponent {
@Input() @Input()
expanded: boolean; expanded: boolean;
/** Width in pixels for sidebar action menu options. */
@Input() @Input()
width: number = 272; width: number = 272;

View File

@@ -31,15 +31,25 @@ export class SidenavLayoutComponent implements OnInit, AfterViewInit, OnDestroy
static STEP_OVER = 600; static STEP_OVER = 600;
/** The side that the drawer is attached to 'start' | 'end' page */ /** The side that the drawer is attached to. Possible values are 'start' and 'end'. */
@Input() position = 'start'; @Input() position = 'start';
/** Minimum size of the navigation region. */
@Input() sidenavMin: number; @Input() sidenavMin: number;
/** Maximum size of the navigation region. */
@Input() sidenavMax: number; @Input() sidenavMax: number;
/** Screen size at which display switches from small screen to large screen configuration. */
@Input() stepOver: number; @Input() stepOver: number;
/** Toggles showing/hiding the navigation region. */
@Input() hideSidenav = false; @Input() hideSidenav = false;
/** Should the navigation region be expanded initially? */
@Input() expandedSidenav = true; @Input() expandedSidenav = true;
/** Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. */
@Output() expanded = new EventEmitter<boolean>(); @Output() expanded = new EventEmitter<boolean>();
@ContentChild(SidenavLayoutHeaderDirective) headerDirective: SidenavLayoutHeaderDirective; @ContentChild(SidenavLayoutHeaderDirective) headerDirective: SidenavLayoutHeaderDirective;

View File

@@ -112,6 +112,7 @@ export class UserPreferencesService {
/** /**
* Check if an item is present in the storage * Check if an item is present in the storage
* @param property Name of the property * @param property Name of the property
* @returns True if the item is present, false otherwise
*/ */
hasItem(property: string) { hasItem(property: string) {
if (!property) { if (!property) {

View File

@@ -210,6 +210,7 @@ export class ViewerComponent implements OnChanges, OnInit, OnDestroy {
@Output() @Output()
navigateNext = new EventEmitter(); navigateNext = new EventEmitter();
/** Emitted when the shared link used is not valid. */
@Output() @Output()
invalidSharedLink = new EventEmitter(); invalidSharedLink = new EventEmitter();

View File

@@ -59,6 +59,7 @@ export class ProcessFiltersComponent implements OnChanges {
@Input() @Input()
showIcon: boolean = true; showIcon: boolean = true;
/** Emitted when a process filter is selected. */
@Output() @Output()
filterSelected: EventEmitter<ProcessInstanceFilterRepresentation> = new EventEmitter<ProcessInstanceFilterRepresentation>(); filterSelected: EventEmitter<ProcessInstanceFilterRepresentation> = new EventEmitter<ProcessInstanceFilterRepresentation>();

View File

@@ -32,18 +32,23 @@ export class AttachFormComponent implements OnInit, OnChanges {
private logService: LogService, private logService: LogService,
private formService: FormService) { } private formService: FormService) { }
/** Id of the task. */
@Input() @Input()
taskId; taskId;
/** Identifier of the form to attach. */
@Input() @Input()
formKey; formKey;
/** Emitted when the "Cancel" button is clicked. */
@Output() @Output()
cancelAttachForm: EventEmitter<void> = new EventEmitter<void>(); cancelAttachForm: EventEmitter<void> = new EventEmitter<void>();
/** Emitted when the form is attached successfully. */
@Output() @Output()
success: EventEmitter<void> = new EventEmitter<void>(); success: EventEmitter<void> = new EventEmitter<void>();
/** Emitted when an error occurs. */
@Output() @Output()
error: EventEmitter<any> = new EventEmitter<any>(); error: EventEmitter<any> = new EventEmitter<any>();

View File

@@ -63,7 +63,7 @@ export class TaskListService {
/** /**
* Checks if a taskId is filtered with the given filter. * Checks if a taskId is filtered with the given filter.
* @param taskId ID of the target task * @param taskId ID of the target task
* @param filter The filter you want to check * @param filterModel The filter you want to check
* @returns The filter if it is related or null otherwise * @returns The filter if it is related or null otherwise
*/ */
isTaskRelatedToFilter(taskId: string, filterModel: FilterRepresentationModel): Observable<FilterRepresentationModel> { isTaskRelatedToFilter(taskId: string, filterModel: FilterRepresentationModel): Observable<FilterRepresentationModel> {