diff --git a/docs/content-services/node-permission.service.md b/docs/content-services/node-permission.service.md index f734b670f8..5dbe461fa7 100644 --- a/docs/content-services/node-permission.service.md +++ b/docs/content-services/node-permission.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-08 +Last reviewed: 2018-09-14 --- # Node Permission service @@ -22,26 +22,23 @@ Manages role permissions for content nodes. - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - The target node - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - 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)`>`
- - - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - - - _permissionToRemove:_ `PermissionElement` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - - + Removes a permission setting from a node. + - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - ID of the target node + - _permissionToRemove:_ `PermissionElement` - Permission setting to remove + - **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)`>`
- - - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - - - _nodes:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - - - _nodeRole:_ `string[]` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - - + Updates the locally set permissions for a node. + - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - ID of the target node + - _nodes:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - Permission settings + - _nodeRole:_ `string[]` - Permission role + - **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)`>`
- - - _nodeId:_ `string` - - - _permissionList:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - - + Update permissions for a node. + - _nodeId:_ `string` - ID of the target node + - _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)`>` - 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)`>`
- Updates the permission for a node. + Updates the permission role for a node. - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Target node - _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 diff --git a/docs/content-services/search-chip-list.component.md b/docs/content-services/search-chip-list.component.md index 19677547bd..811814a157 100644 --- a/docs/content-services/search-chip-list.component.md +++ b/docs/content-services/search-chip-list.component.md @@ -1,15 +1,26 @@ --- Added: v2.3.0 Status: Active +Last reviewed: 2018-09-14 --- # Search Chip List Component Displays search criteria as a set of "chips". +![Selected Facets](../docassets/images/selected-facets.png) + +## Basic usage + ```html ``` -![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. | diff --git a/docs/core/sidebar-action-menu.component.md b/docs/core/sidebar-action-menu.component.md index 4d52a90c8c..9a448a4352 100644 --- a/docs/core/sidebar-action-menu.component.md +++ b/docs/core/sidebar-action-menu.component.md @@ -1,6 +1,7 @@ --- Added: v2.1.0 Status: Active +Last reviewed: 2018-09-14 --- # Sidebar action menu component @@ -44,7 +45,7 @@ the following names: | ---- | ---- | ------------- | ----------- | | expanded | `boolean` | | Toggle the sidebar action menu on expand. | | 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 diff --git a/docs/core/sidenav-layout.component.md b/docs/core/sidenav-layout.component.md index a3475a22c1..bbcb960ca5 100644 --- a/docs/core/sidenav-layout.component.md +++ b/docs/core/sidenav-layout.component.md @@ -1,7 +1,7 @@ --- Added: v2.3.0 Status: Active -Last reviewed: 2018-06-08 +Last reviewed: 2018-09-14 --- # Sidenav Layout component @@ -69,17 +69,17 @@ sub-components (note the use of `` in the sub-components' body sect | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? | -| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region | -| sidenavMax | `number` | | Maximum size of the navigation region | -| sidenavMin | `number` | | Minimum size of the navigation region | -| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration | -| position | `string` | 'start' | The side that the drawer is attached to 'start' or 'end' page | +| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. | +| position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. | +| sidenavMax | `number` | | Maximum size of the navigation region. | +| sidenavMin | `number` | | Minimum size of the navigation region. | +| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes | +| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. | ## Details diff --git a/docs/core/user-preferences.service.md b/docs/core/user-preferences.service.md index 562d9ffa59..10149e3ae3 100644 --- a/docs/core/user-preferences.service.md +++ b/docs/core/user-preferences.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-16 +Last reviewed: 2018-09-14 --- # User Preferences Service @@ -33,7 +33,7 @@ Stores preferences for components. - **hasItem**(property: `string`): `boolean`
Check if an item is present in the storage - _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)``
Sets up a callback to notify when a property has changed. - _property:_ `string` - The property to watch diff --git a/docs/core/viewer.component.md b/docs/core/viewer.component.md index a78858a7d6..282c0f814a 100644 --- a/docs/core/viewer.component.md +++ b/docs/core/viewer.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-07 +Last reviewed: 2018-09-14 --- # 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)`>` | Emitted when user clicks the 'Download' button. | | extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the filename extension changes. | | goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Back' button. | +| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the shared link used is not valid. | | navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Before' ("<") button. | | navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Next' (">") button. | | print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Print' button. | | share | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Share' button. | | showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the viewer is shown or hidden. | -| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the shared link used is not valid. | ## Keyboard shortcuts @@ -179,7 +179,7 @@ You can provide custom file parameters, for example a value for the `mimeType` o ### 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 - application/pdf @@ -265,7 +265,7 @@ The [Viewer component](../core/viewer.component.md) now should be able to displa ### 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` to handle 3D data files: diff --git a/docs/process-services/attach-form.component.md b/docs/process-services/attach-form.component.md index 5ab0e1853c..86a64e499f 100644 --- a/docs/process-services/attach-form.component.md +++ b/docs/process-services/attach-form.component.md @@ -1,6 +1,7 @@ --- Added: v2.0.0 Status: Active +Last reviewed: 2018-09-14 --- # 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 | | ---- | ---- | ------------- | ----------- | -| formKey | `any` | | | +| formKey | `any` | | Identifier of the form to attach. | | taskId | `any` | | Id of the task. | ### 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 | | ---- | ---- | ----------- | | cancelAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form is attached successfully. | diff --git a/docs/process-services/process-filters.component.md b/docs/process-services/process-filters.component.md index 3fd42878bd..0a2f11563f 100644 --- a/docs/process-services/process-filters.component.md +++ b/docs/process-services/process-filters.component.md @@ -1,6 +1,7 @@ --- Added: v2.0.0 Status: Active +Last reviewed: 2018-09-14 --- # Process Filters Component @@ -43,9 +44,9 @@ Collection of criteria used to filter process instances, which may be customized | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects a filter from the list. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list of filters has been successfully loaded from the server. | +| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects a filter from the list. | | filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a process filter is selected. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list of filters has been successfully loaded from the server. | ## Details diff --git a/docs/process-services/tasklist.service.md b/docs/process-services/tasklist.service.md index e07046d5ab..10d3494dcb 100644 --- a/docs/process-services/tasklist.service.md +++ b/docs/process-services/tasklist.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-22 +Last reviewed: 2018-09-14 --- # Tasklist Service @@ -35,10 +35,10 @@ Manages Task Instances. Claims a task for the current user. - _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 -- **completeTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **completeTask**(taskId: `string`): `any`
Gives completed status to a task. - _taskId:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - 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)`>`
Creates a new standalone 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. - _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 -- **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **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)`>`
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`](http://reactivex.io/documentation/observable.html)`` - List of tasks -- **findAllTasksWithoutState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **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`](../../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`](http://reactivex.io/documentation/observable.html)`` - List of tasks -- **findTasksByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **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`](../../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`](http://reactivex.io/documentation/observable.html)`` - 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)`>`
Gets all the filters in the list that belong to a task. - _taskId:_ `string` - ID of the target task @@ -89,18 +89,18 @@ Manages Task Instances. Gets details for a 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 -- **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **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)`>`
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`](http://reactivex.io/documentation/observable.html)`` - 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)``
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`](http://reactivex.io/documentation/observable.html)`` - 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)`>`
+- **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)`>`
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 + - _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 - **unclaimTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Unclaims a task for the current user. diff --git a/lib/content-services/permission-manager/services/node-permission.service.ts b/lib/content-services/permission-manager/services/node-permission.service.ts index 2a43b819c3..943db0be9f 100644 --- a/lib/content-services/permission-manager/services/node-permission.service.ts +++ b/lib/content-services/permission-manager/services/node-permission.service.ts @@ -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 updatedPermissionRole Permission role to update or add * @returns Node with updated permission @@ -68,6 +68,12 @@ export class NodePermissionService { 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 { return this.nodeService.getNode(nodeId).pipe( 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 { let permissionBody = { permissions: { locallySet: []} }; 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 { let permissionBody = { permissions: { locallySet: [] } }; const index = node.permissions.locallySet.map((permission) => permission.authorityId).indexOf(permissionToRemove.authorityId); diff --git a/lib/content-services/search/components/search-chip-list/search-chip-list.component.ts b/lib/content-services/search/components/search-chip-list/search-chip-list.component.ts index 9459dadc74..8e3f0901cb 100644 --- a/lib/content-services/search/components/search-chip-list/search-chip-list.component.ts +++ b/lib/content-services/search/components/search-chip-list/search-chip-list.component.ts @@ -26,6 +26,7 @@ import { SearchFilterComponent } from '../../components/search-filter/search-fil }) export class SearchChipListComponent { + /** Search filter to supply the data for the chips. */ @Input() searchFilter: SearchFilterComponent; } diff --git a/lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts b/lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts index 7ff13b8326..3845ecfba1 100644 --- a/lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts +++ b/lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts @@ -36,6 +36,7 @@ export class SidebarActionMenuComponent { @Input() expanded: boolean; + /** Width in pixels for sidebar action menu options. */ @Input() width: number = 272; diff --git a/lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts b/lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts index ce24bde0fa..f777c184ae 100644 --- a/lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts +++ b/lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts @@ -31,15 +31,25 @@ export class SidenavLayoutComponent implements OnInit, AfterViewInit, OnDestroy 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'; + /** Minimum size of the navigation region. */ @Input() sidenavMin: number; + + /** Maximum size of the navigation region. */ @Input() sidenavMax: number; + + /** Screen size at which display switches from small screen to large screen configuration. */ @Input() stepOver: number; + + /** Toggles showing/hiding the navigation region. */ @Input() hideSidenav = false; + + /** Should the navigation region be expanded initially? */ @Input() expandedSidenav = true; + /** Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. */ @Output() expanded = new EventEmitter(); @ContentChild(SidenavLayoutHeaderDirective) headerDirective: SidenavLayoutHeaderDirective; diff --git a/lib/core/services/user-preferences.service.ts b/lib/core/services/user-preferences.service.ts index bcb9881cfa..d371e8d823 100644 --- a/lib/core/services/user-preferences.service.ts +++ b/lib/core/services/user-preferences.service.ts @@ -112,6 +112,7 @@ export class UserPreferencesService { /** * Check if an item is present in the storage * @param property Name of the property + * @returns True if the item is present, false otherwise */ hasItem(property: string) { if (!property) { diff --git a/lib/core/viewer/components/viewer.component.ts b/lib/core/viewer/components/viewer.component.ts index f67685e8b3..0e1d6531a0 100644 --- a/lib/core/viewer/components/viewer.component.ts +++ b/lib/core/viewer/components/viewer.component.ts @@ -210,6 +210,7 @@ export class ViewerComponent implements OnChanges, OnInit, OnDestroy { @Output() navigateNext = new EventEmitter(); + /** Emitted when the shared link used is not valid. */ @Output() invalidSharedLink = new EventEmitter(); diff --git a/lib/process-services/process-list/components/process-filters.component.ts b/lib/process-services/process-list/components/process-filters.component.ts index 1261cac351..76f9da5d61 100644 --- a/lib/process-services/process-list/components/process-filters.component.ts +++ b/lib/process-services/process-list/components/process-filters.component.ts @@ -59,6 +59,7 @@ export class ProcessFiltersComponent implements OnChanges { @Input() showIcon: boolean = true; + /** Emitted when a process filter is selected. */ @Output() filterSelected: EventEmitter = new EventEmitter(); diff --git a/lib/process-services/task-list/components/attach-form.component.ts b/lib/process-services/task-list/components/attach-form.component.ts index bf2acc9062..bd9ac0e36d 100644 --- a/lib/process-services/task-list/components/attach-form.component.ts +++ b/lib/process-services/task-list/components/attach-form.component.ts @@ -32,18 +32,23 @@ export class AttachFormComponent implements OnInit, OnChanges { private logService: LogService, private formService: FormService) { } + /** Id of the task. */ @Input() taskId; + /** Identifier of the form to attach. */ @Input() formKey; + /** Emitted when the "Cancel" button is clicked. */ @Output() cancelAttachForm: EventEmitter = new EventEmitter(); + /** Emitted when the form is attached successfully. */ @Output() success: EventEmitter = new EventEmitter(); + /** Emitted when an error occurs. */ @Output() error: EventEmitter = new EventEmitter(); diff --git a/lib/process-services/task-list/services/tasklist.service.ts b/lib/process-services/task-list/services/tasklist.service.ts index 25e8f3c220..cc61a977a6 100644 --- a/lib/process-services/task-list/services/tasklist.service.ts +++ b/lib/process-services/task-list/services/tasklist.service.ts @@ -63,7 +63,7 @@ export class TaskListService { /** * Checks if a taskId is filtered with the given filter. * @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 */ isTaskRelatedToFilter(taskId: string, filterModel: FilterRepresentationModel): Observable {