diff --git a/docs/content-services/components/content-action.component.md b/docs/content-services/components/content-action.component.md index 458e6ec4557..97a56c078d5 100644 --- a/docs/content-services/components/content-action.component.md +++ b/docs/content-services/components/content-action.component.md @@ -97,10 +97,10 @@ export class MyView { | Name | Type | Description | | ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when an error occurs during the action. Applies to copy and move actions. | -| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the user selects the action from the menu. | -| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when a permission error occurs | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the action. Applies to copy and move actions. | +| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects the action from the menu. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission error occurs | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | ## Details diff --git a/docs/content-services/components/content-node-selector-panel.component.md b/docs/content-services/components/content-node-selector-panel.component.md index 5f8edf18009..a0c0086a795 100644 --- a/docs/content-services/components/content-node-selector-panel.component.md +++ b/docs/content-services/components/content-node-selector-panel.component.md @@ -31,13 +31,13 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | -| restrictSearchToCurrentFolderId | `boolean` | false | If true will restrict the search to the currentFolderId. | | currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. | | dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | | dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). | | imageResolver | [`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. | | isSelectionValid | [`ValidationFunction`](../../../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | | pageSize | `number` | | Number of items shown per page in the list. | +| restrictSearchToCurrentFolderId | `boolean` | false | If true will restrict the search to the currentFolderId | | where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. | | excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | | rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. | diff --git a/docs/content-services/components/document-list.component.md b/docs/content-services/components/document-list.component.md index e8438818b9b..b20ef470271 100644 --- a/docs/content-services/components/document-list.component.md +++ b/docs/content-services/components/document-list.component.md @@ -69,7 +69,7 @@ Displays the documents from a repository. | maxItems | `number` | | Default value is stored in the user preference settings. Use this only if you are not using pagination. | | multiselect | `boolean` | false | Toggles multiselect mode | | navigate | `boolean` | true | Toggles navigation to folder content or file preview | -| navigationMode | `string` | | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | +| navigationMode | `string` | | [User](../../../lib/core/pipes/user-initial.pipe.ts) interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | | node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md) | null | The Document list will show all the nodes contained in the [NodePaging](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md) entity | | permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) page for further details and examples. | | rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. | @@ -77,7 +77,7 @@ Displays the documents from a repository. | selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | | showHeader | `string` | | Toggles the header | | sorting | `string[]` | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. | -| sortingMode | `string` | "client" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. | +| sortingMode | `string` | "server" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. | | stickyHeader | `boolean` | false | Toggles the sticky header mode. | | thumbnails | `boolean` | false | Show document thumbnails rather than icons | | where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. | diff --git a/docs/content-services/components/like.component.md b/docs/content-services/components/like.component.md index 615c17189b9..e38c9e14e1e 100644 --- a/docs/content-services/components/like.component.md +++ b/docs/content-services/components/like.component.md @@ -29,7 +29,7 @@ Allows a user to add "likes" to an item. | Name | Type | Description | | ---- | ---- | ----------- | -| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the "vote" gets changed. | +| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also diff --git a/docs/content-services/components/rating.component.md b/docs/content-services/components/rating.component.md index cdd24b212dc..2481a126e7d 100644 --- a/docs/content-services/components/rating.component.md +++ b/docs/content-services/components/rating.component.md @@ -40,7 +40,7 @@ If the average is decimal number it will be rounded. | Name | Type | Description | | ---- | ---- | ----------- | -| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the "vote" gets changed. | +| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also diff --git a/docs/content-services/components/search-header.component.md b/docs/content-services/components/search-header.component.md index 031263cd5b3..6c156ca7190 100644 --- a/docs/content-services/components/search-header.component.md +++ b/docs/content-services/components/search-header.component.md @@ -51,12 +51,14 @@ This component is designed to be used as transcluded inside the [document list c | currentFolderNodeId | `string` | | The id of the current folder of the document list. | | maxItems | `number` | | Maximum number of search results to show in a page. | | skipCount | `number` | | The offset of the start of the page within the results list. | +| value | `any` | | | ### Events | Name | Type | Description | | ---- | ---- | ----------- | | clear | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the last of all the filters is cleared. | +| selection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when a filter value is selected | | update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when the result of the filter is received from the API. | ## See also diff --git a/docs/content-services/components/tag-actions.component.md b/docs/content-services/components/tag-actions.component.md index 125e0c6c763..78dbc778e3c 100644 --- a/docs/content-services/components/tag-actions.component.md +++ b/docs/content-services/components/tag-actions.component.md @@ -32,5 +32,5 @@ Shows available actions for tags. | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when an action is chosen. | +| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an action is chosen. | | successAdd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is added successfully. | diff --git a/docs/content-services/components/tag-list.component.md b/docs/content-services/components/tag-list.component.md index 05185554f83..3e4fe204e35 100644 --- a/docs/content-services/components/tag-list.component.md +++ b/docs/content-services/components/tag-list.component.md @@ -17,7 +17,7 @@ Shows tags for an item. | Name | Type | Description | | ---- | ---- | ----------- | -| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when a tag is selected. | +| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | ## See Also diff --git a/docs/content-services/components/tag-node-list.component.md b/docs/content-services/components/tag-node-list.component.md index d3536a09126..b5aafc72ef5 100644 --- a/docs/content-services/components/tag-node-list.component.md +++ b/docs/content-services/components/tag-node-list.component.md @@ -32,4 +32,4 @@ Shows tags for a node. | Name | Type | Description | | ---- | ---- | ----------- | -| results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when a tag is selected. | +| results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | diff --git a/docs/content-services/components/upload-button.component.md b/docs/content-services/components/upload-button.component.md index b256a7e2937..c74ed624920 100644 --- a/docs/content-services/components/upload-button.component.md +++ b/docs/content-services/components/upload-button.component.md @@ -48,9 +48,9 @@ Activates a file upload. | Name | Type | Description | | ---- | ---- | ----------- | | beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the file is uploaded successfully. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | | updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | ## Details diff --git a/docs/content-services/components/upload-drag-area.component.md b/docs/content-services/components/upload-drag-area.component.md index 9a281736850..0ac2010f098 100644 --- a/docs/content-services/components/upload-drag-area.component.md +++ b/docs/content-services/components/upload-drag-area.component.md @@ -75,8 +75,8 @@ as the drag/drop target: | Name | Type | Description | | ---- | ---- | ----------- | | beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the file is uploaded successfully. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | | updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | ## Details diff --git a/docs/content-services/components/upload-version-button.component.md b/docs/content-services/components/upload-version-button.component.md index bed16fce3ae..8e27a1b94b6 100644 --- a/docs/content-services/components/upload-version-button.component.md +++ b/docs/content-services/components/upload-version-button.component.md @@ -51,9 +51,9 @@ to enrich the features and decrease the restrictions currently applied to node v | Name | Type | Description | | ---- | ---- | ----------- | | beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the file is uploaded successfully. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | | updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | ## Details diff --git a/docs/content-services/components/webscript.component.md b/docs/content-services/components/webscript.component.md index 472ba54cb60..78ae5356c3e 100644 --- a/docs/content-services/components/webscript.component.md +++ b/docs/content-services/components/webscript.component.md @@ -75,7 +75,7 @@ export class AppComponent { | Name | Type | Description | | ---- | ---- | ----------- | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. | ## Details diff --git a/docs/content-services/services/document-list.service.md b/docs/content-services/services/document-list.service.md index 60964f44640..d11cc5d1349 100644 --- a/docs/content-services/services/document-list.service.md +++ b/docs/content-services/services/document-list.service.md @@ -43,12 +43,13 @@ Implements node operations used by the [Document List component](../components/d - _nodeId:_ `any` - - **Returns** `boolean` - -- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`
+- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`, orderBy?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`
Load a folder by Node Id. - _nodeId:_ `string` - ID of the folder node - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - - _includeFields:_ `string[]` - List of data field names to include in the results - _where:_ `string` - (Optional) Optionally filter the list + - _orderBy:_ `string[]` - (Optional) - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>` - Details of the folder - **moveNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Moves a node to destination node. diff --git a/docs/core/components/data-column.component.md b/docs/core/components/data-column.component.md index d9a8a031e54..4d27f19ffd9 100644 --- a/docs/core/components/data-column.component.md +++ b/docs/core/components/data-column.component.md @@ -51,6 +51,7 @@ Defines column properties for DataTable, Tasklist, Document List and other compo | formatTooltip | `Function` | | Custom tooltip formatter function. | | key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. | | sortable | `boolean` | true | Toggles ability to sort by this column, for example by clicking the column header. | +| sortingKey | `string` | | When using server side sorting the column used by the api call where the sorting will be performed | | srTitle | `string` | | Title to be used for screen readers. | | title | `string` | "" | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. | | type | `string` | "text" | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize', 'location', and 'json'. | diff --git a/docs/core/components/datatable.component.md b/docs/core/components/datatable.component.md index cdf7dbe0dde..ff4442d3757 100644 --- a/docs/core/components/datatable.component.md +++ b/docs/core/components/datatable.component.md @@ -346,7 +346,7 @@ Learm more about styling your datatable: [Customizing the component's styles](#c | ---- | ---- | ------------- | ----------- | | actions | `boolean` | false | Toggles the data actions column. | | actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | -| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. | +| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet widget search for filtering. | | columns | `any[]` | \[] | The columns that the datatable will show. | | contextMenu | `boolean` | false | Toggles custom context menu for the component. | | data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source for the table | diff --git a/docs/core/components/form-field.component.md b/docs/core/components/form-field.component.md index 7f5d40704ce..bab9485563d 100644 --- a/docs/core/components/form-field.component.md +++ b/docs/core/components/form-field.component.md @@ -27,7 +27,7 @@ based on the field type or the metadata information. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. | +| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the [`FormFieldModel`](../../core/models/form-field.model.md) definitions. | ## Details diff --git a/docs/core/components/info-drawer-layout.component.md b/docs/core/components/info-drawer-layout.component.md index 80ade4024bf..147b26e06c8 100644 --- a/docs/core/components/info-drawer-layout.component.md +++ b/docs/core/components/info-drawer-layout.component.md @@ -37,6 +37,7 @@ with the following names: ``` + ## Class members ### Properties diff --git a/docs/core/components/info-drawer.component.md b/docs/core/components/info-drawer.component.md index 4c761b08cf3..7461420194c 100644 --- a/docs/core/components/info-drawer.component.md +++ b/docs/core/components/info-drawer.component.md @@ -50,8 +50,8 @@ have any content you like: | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | selectedIndex | `number` | 0 | The selected index tab. | -| title | `string \| null` | null | The title of the info drawer (string or translation key). | | showHeader | `boolean` | true | The visibility of the header. | +| title | `string \| null` | null | The title of the info drawer (string or translation key). | ### Events diff --git a/docs/core/components/pagination.component.md b/docs/core/components/pagination.component.md index 1b58c4727e0..034de550728 100644 --- a/docs/core/components/pagination.component.md +++ b/docs/core/components/pagination.component.md @@ -42,9 +42,9 @@ Adds pagination to the component it is used with. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. | | supportedPageSizes | `number[]` | | An array of page sizes. | | target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | +| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. | ### Events diff --git a/docs/core/components/start-form.component.md b/docs/core/components/start-form.component.md index 009a3817390..8b8c55c0cee 100644 --- a/docs/core/components/start-form.component.md +++ b/docs/core/components/start-form.component.md @@ -37,8 +37,8 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode | nameNode | `string` | | Name to assign to the new node where the metadata are stored. | | nodeId | `string` | | Content Services node ID for the form metadata. | | path | `string` | | Path of the folder where the metadata will be stored. | -| processDefinitionId | `string` | | Definition ID of the process to start, this parameter can not be use in combination with processId | -| processId | `string` | | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId | +| processDefinitionId | `string` | | [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId | +| processId | `string` | | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId | | readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | | readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? | | saveMetadata | `boolean` | false | Toggle saving of form metadata. | diff --git a/docs/core/components/viewer.component.md b/docs/core/components/viewer.component.md index 5dd0d63550b..99a7001bbc0 100644 --- a/docs/core/components/viewer.component.md +++ b/docs/core/components/viewer.component.md @@ -110,7 +110,7 @@ See the [Custom layout](#custom-layout) section for full details of all availabl | ---- | ---- | ----------- | | 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. | +| 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. | diff --git a/docs/core/directives/version-compatibility.directive.md b/docs/core/directives/version-compatibility.directive.md index 008778cea3b..91e9b7e6a4f 100644 --- a/docs/core/directives/version-compatibility.directive.md +++ b/docs/core/directives/version-compatibility.directive.md @@ -23,7 +23,7 @@ Enables/disables components based on ACS version in use. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| adf-acs-version | `string` | | Minimum version required for component to work correctly . | +| version | `void` | | Minimum version required for component to work correctly . | ## Details diff --git a/docs/core/services/form.service.md b/docs/core/services/form.service.md index ba93f4859e6..f0511997490 100644 --- a/docs/core/services/form.service.md +++ b/docs/core/services/form.service.md @@ -98,7 +98,7 @@ class MyComponent { Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) related to a taskId - `taskId` - Task Id - `getFormDefinitionById(formId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` - Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Definition + Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) - `formId` - [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Id - `getFormDefinitionByName(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Returns form definition with a given name. diff --git a/docs/core/services/sites.service.md b/docs/core/services/sites.service.md index a73bfabbd6a..62a61c2cae6 100644 --- a/docs/core/services/sites.service.md +++ b/docs/core/services/sites.service.md @@ -19,11 +19,11 @@ Accesses and manipulates sites from a Content Services repository. - _inviteeId:_ `string` - The invitee user name. - _opts:_ `any` - (Optional) Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`>` - Null response notifying when the operation is complete -- **createSiteGroupMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>`
+- **createSiteGroupMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Create a site membership for group - _siteId:_ `string` - The identifier of a site. - _siteMembershipBodyCreate:_ [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts) - The Group to add and its role - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - [`Observable`](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> - **createSiteMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMemberEntry.ts)`>`
Creates a site membership for person **personId** on site **siteId**. - _siteId:_ `string` - The identifier of a site @@ -57,11 +57,11 @@ Accesses and manipulates sites from a Content Services repository. Gets a site's content. - _siteId:_ `string` - ID of the target site - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>` - Site content -- **getSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>`
+- **getSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Get information about site membership of group - _siteId:_ `string` - The identifier of a site. - _groupId:_ `string` - The authorityId of a group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - [`Observable`](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> - **getSiteMembers**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>`
Gets a list of all a site's members. - _siteId:_ `string` - ID of the target site @@ -78,11 +78,11 @@ Accesses and manipulates sites from a Content Services repository. Gets a list of all sites in the repository. - _opts:_ `any` - Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>` - List of sites -- **listSiteGroups**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>`
+- **listSiteGroups**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
List group membership for site - _siteId:_ `string` - The identifier of a site. - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupPaging> + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - [`Observable`](http://reactivex.io/documentation/observable.html)<SiteGroupPaging> - **listSiteMemberships**(siteId: `string`, opts: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`
Gets a list of all a site's members. - _siteId:_ `string` - ID of the target site @@ -94,12 +94,12 @@ Accesses and manipulates sites from a Content Services repository. - _inviteeId:_ `string` - The invitee user name. - _opts:_ `any` - (Optional) Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`>` - Null response notifying when the operation is complete -- **updateSiteGroupMembership**(siteId: `string`, groupId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>`
+- **updateSiteGroupMembership**(siteId: `string`, groupId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Update site membership of group - _siteId:_ `string` - The identifier of a site. - _groupId:_ `string` - The authorityId of a group. - _siteMembershipBodyUpdate:_ [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts) - The group new role - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - [`Observable`](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> - **updateSiteMembership**(siteId: `string`, personId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMemberEntry.ts)`>`
Update a site membership - _siteId:_ `string` - The identifier of a site. diff --git a/docs/core/widgets/content.widget.md b/docs/core/widgets/content.widget.md index 142a6344501..30ad07c64d1 100644 --- a/docs/core/widgets/content.widget.md +++ b/docs/core/widgets/content.widget.md @@ -29,7 +29,7 @@ Shows the content preview. | Name | Type | Description | | ---- | ---- | ----------- | -| contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the content is clicked. | +| contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content is clicked. | | contentLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content has loaded. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | thumbnailLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the thumbnail has loaded. | diff --git a/docs/insights/components/analytics-generator.component.md b/docs/insights/components/analytics-generator.component.md index 561cccf7dc7..45ccbcfb63f 100644 --- a/docs/insights/components/analytics-generator.component.md +++ b/docs/insights/components/analytics-generator.component.md @@ -30,5 +30,5 @@ Generates and shows charts | Name | Type | Description | | ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | error. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | success. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/insights/components/analytics-report-list.component.md b/docs/insights/components/analytics-report-list.component.md index c4c49068fa6..98e96f47cbb 100644 --- a/docs/insights/components/analytics-report-list.component.md +++ b/docs/insights/components/analytics-report-list.component.md @@ -30,6 +30,6 @@ Shows a list of all available reports | Name | Type | Description | | ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | error. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | | reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../../lib/insights/src/lib/diagram/models/report/report-parameters.model.ts)`>` | report Click. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | success. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/insights/components/analytics.component.md b/docs/insights/components/analytics.component.md index 517e94b80b6..c26bc6b67b4 100644 --- a/docs/insights/components/analytics.component.md +++ b/docs/insights/components/analytics.component.md @@ -33,6 +33,6 @@ Shows the charts related to the reportId passed as input | Name | Type | Description | | ---- | ---- | ----------- | -| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | emitted when editReport. | -| reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | emitted when reportDeleted. | -| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | emitted when reportSaved. | +| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when editReport. | +| reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when reportDeleted. | +| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when reportSaved. | diff --git a/docs/insights/components/diagram.component.md b/docs/insights/components/diagram.component.md index d83a681d72e..3d16e8917b9 100644 --- a/docs/insights/components/diagram.component.md +++ b/docs/insights/components/diagram.component.md @@ -44,5 +44,5 @@ The below component shows the diagram of a running process instance with the act | Name | Type | Description | | ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | error. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | success. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md index 6a641433639..389bc3fee5b 100644 --- a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md @@ -82,14 +82,14 @@ given below: | ---- | ----------- | | **_appName_** | Name of the app | | **_status_** | Execution state of the task. | -| **_assignee_** | User the task is assigned to | +| **_assignee_** | [User](../../../lib/core/pipes/user-initial.pipe.ts) the task is assigned to | | **_taskName_** | Name of the task | | **_taskId_** | ID of the task | | **_parentTaskId_** | ID of the task's parent task | | **_priority_** | Task priority | | **_createdDate_** | Date the task was created | | **_standalone_** | Standalone status of the task | -| **_owner_** | User ID of the task's owner | +| **_owner_** | [User](../../../lib/core/pipes/user-initial.pipe.ts) ID of the task's owner | | **_processDefinitionId_** | Process definition ID | | **_processInstanceId_** | Process instance ID | | **_lastModified_** | Date the task was last modified. If lastModified defined the component will show the range **_lastModifiedFrom_**, **_lastModifiedTo_** | diff --git a/docs/process-services-cloud/components/group-cloud.component.md b/docs/process-services-cloud/components/group-cloud.component.md index d0e468eb366..f63211157ed 100644 --- a/docs/process-services-cloud/components/group-cloud.component.md +++ b/docs/process-services-cloud/components/group-cloud.component.md @@ -45,7 +45,7 @@ Searches Groups. | roles | `string[]` | \[] | Role names of the groups to be listed. | | searchGroupsControl | `FormControl` | | FormControl to search the group | | title | `string` | | Title of the field | -| validate | `Boolean` | false | This flag enables the validation on the preSelectGroups passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | +| validate | `Boolean` | false | This flag enables the validation on the preSelectGroups passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. | ### Events diff --git a/docs/process-services-cloud/components/people-cloud.component.md b/docs/process-services-cloud/components/people-cloud.component.md index 4186040cb7c..f6fd0c25ea3 100644 --- a/docs/process-services-cloud/components/people-cloud.component.md +++ b/docs/process-services-cloud/components/people-cloud.component.md @@ -25,14 +25,14 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. | -| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | User selection mode (single/multiple). | +| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | [User](../../../lib/core/pipes/user-initial.pipe.ts) selection mode (single/multiple). | | preSelectUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | | readOnly | `boolean` | false | Show the info in readonly mode | | roles | `string[]` | | Role names of the users to be listed. | | searchUserCtrl | `FormControl` | | FormControl to search the user | | title | `string` | | Placeholder translation key | | userChipsCtrl | `FormControl` | | FormControl to list of users | -| validate | `boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | +| validate | `boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. | ### Events diff --git a/docs/process-services-cloud/services/start-process-cloud.service.md b/docs/process-services-cloud/services/start-process-cloud.service.md index 6f32dea669f..7b3a8be7dc7 100644 --- a/docs/process-services-cloud/services/start-process-cloud.service.md +++ b/docs/process-services-cloud/services/start-process-cloud.service.md @@ -15,12 +15,12 @@ Gets process definitions and starts processes. - **createProcess**(appName: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Create a process based on a process definition, name, form values or variables. - - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + - _appName:_ `string` - name of the Application - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just created - **deleteProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Delete an existing process instance - - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + - _appName:_ `string` - name of the Application - _processInstanceId:_ `string` - process instance to update - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **getBasePath**(appName: `string`): `string`
@@ -40,12 +40,12 @@ Gets process definitions and starts processes. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started - **startProcess**(appName: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Starts a process based on a process definition, name, form values or variables. - - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + - _appName:_ `string` - name of the Application - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started - **updateProcess**(appName: `string`, processInstanceId: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Update an existing process instance - - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + - _appName:_ `string` - name of the Application - _processInstanceId:_ `string` - process instance to update - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started diff --git a/docs/process-services-cloud/services/task-cloud.service.md b/docs/process-services-cloud/services/task-cloud.service.md index a299611ab74..b875cdae2cd 100644 --- a/docs/process-services-cloud/services/task-cloud.service.md +++ b/docs/process-services-cloud/services/task-cloud.service.md @@ -29,7 +29,7 @@ Manages task cloud. Claims a task for an assignee. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the task to claim - - _assignee:_ `string` - User to assign the task to + - _assignee:_ `string` - [User](../../../lib/core/pipes/user-initial.pipe.ts) to assign the task to - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the claimed task - **completeTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Complete a task. diff --git a/docs/process-services/components/people-search.component.md b/docs/process-services/components/people-search.component.md index 70aa49d70d5..f55fcaaa686 100644 --- a/docs/process-services/components/people-search.component.md +++ b/docs/process-services/components/people-search.component.md @@ -39,7 +39,7 @@ special sub-components in the body of the `` element: | Name | Type | Description | | ---- | ---- | ----------- | -| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the "close" 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`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when a user is selected and the action button is clicked. | diff --git a/docs/process-services/components/people.component.md b/docs/process-services/components/people.component.md index dd61cfc886e..51957270099 100644 --- a/docs/process-services/components/people.component.md +++ b/docs/process-services/components/people.component.md @@ -39,7 +39,7 @@ Displays users involved with a specified task | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| people | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | \[] | The array of User objects to display. | +| people | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | \[] | The array of [User](../../../lib/core/pipes/user-initial.pipe.ts) 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/components/process-attachment-list.component.md b/docs/process-services/components/process-attachment-list.component.md index be0192907e0..41a0da993f1 100644 --- a/docs/process-services/components/process-attachment-list.component.md +++ b/docs/process-services/components/process-attachment-list.component.md @@ -67,9 +67,9 @@ A default template will be used if you don't supply a custom one to override it: | Name | Type | Description | | ---- | ---- | ----------- | -| 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. | +| 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`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/components/process-list.component.md b/docs/process-services/components/process-list.component.md index c4d73ee8d13..8a2d12fa9bb 100644 --- a/docs/process-services/components/process-list.component.md +++ b/docs/process-services/components/process-list.component.md @@ -56,7 +56,7 @@ when the process list is empty: | multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row | | page | `number` | 0 | The page number of the processes to fetch. | | presetColumn | `string` | | Custom preset column schema in JSON format. | -| processDefinitionId | `string` | | The Definition Id of the process. | +| processDefinitionId | `string` | | The [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | | processInstanceId | `number \| string` | | The id of the process instance. | | resolverFn | `Function` | null | Resolver function is used to show dynamic complex column objects see the docs to learn how to configure a resolverFn. | | selectFirstRow | `boolean` | true | Toggles default selection of the first row | diff --git a/docs/process-services/components/start-process.component.md b/docs/process-services/components/start-process.component.md index 842c132f904..3e0ad77c61c 100644 --- a/docs/process-services/components/start-process.component.md +++ b/docs/process-services/components/start-process.component.md @@ -42,7 +42,7 @@ Starts a process. | ---- | ---- | ------------- | ----------- | | appId | `number` | | (optional) Limit the list of processes that can be started to those contained in the specified app. | | name | `string` | "" | (optional) Name to assign to the current process. | -| processDefinitionName | `string` | | (optional) Definition name of the process to start. | +| processDefinitionName | `string` | | (optional) [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) name of the process to start. | | processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. | | showSelectApplicationDropdown | `boolean` | false | (optional) Hide or show application selection dropdown. | | showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. | diff --git a/docs/process-services/components/task-attachment-list.component.md b/docs/process-services/components/task-attachment-list.component.md index 3f013db8723..ca05b42ebbd 100644 --- a/docs/process-services/components/task-attachment-list.component.md +++ b/docs/process-services/components/task-attachment-list.component.md @@ -61,9 +61,9 @@ A default "no content" template is displayed if you don't supply one to override | Name | Type | Description | | ---- | ---- | ----------- | -| 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. | +| 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`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/components/task-list.component.md b/docs/process-services/components/task-list.component.md index a7ac8f3aa4d..7d065d1b62a 100644 --- a/docs/process-services/components/task-list.component.md +++ b/docs/process-services/components/task-list.component.md @@ -64,7 +64,7 @@ when the task list is empty: | 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. | -| processDefinitionId | `string` | | The Definition Id of the process. | +| processDefinitionId | `string` | | The [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | | processInstanceId | `string` | | The Instance Id of the process. | | selectFirstRow | `boolean` | true | Toggles default selection of the first row | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | diff --git a/docs/process-services/services/tasklist.service.md b/docs/process-services/services/tasklist.service.md index 269a2684d85..f5302a3b5e9 100644 --- a/docs/process-services/services/tasklist.service.md +++ b/docs/process-services/services/tasklist.service.md @@ -20,7 +20,7 @@ Manages Task Instances. - **assignTask**(taskId: `string`, requestNode: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Assigns a task to a user or group. - _taskId:_ `string` - The task to assign - - _requestNode:_ `any` - User or group to assign the task to + - _requestNode:_ `any` - [User](../../../lib/core/pipes/user-initial.pipe.ts) or group to assign the task to - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the assigned task - **assignTaskByUserId**(taskId: `string`, userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Assigns a task to a user. diff --git a/lib/content-services/src/lib/document-list/services/document-list.service.ts b/lib/content-services/src/lib/document-list/services/document-list.service.ts index 1ae46f69f81..9b332dd29db 100644 --- a/lib/content-services/src/lib/document-list/services/document-list.service.ts +++ b/lib/content-services/src/lib/document-list/services/document-list.service.ts @@ -182,13 +182,13 @@ export class DocumentListService implements DocumentListLoader { } } - private retrieveDocumentNode(nodeId: string, pagination: PaginationModel, includeFields: string[], where?: string, orderByValue?: string[]): Observable { + private retrieveDocumentNode(nodeId: string, pagination: PaginationModel, includeFields: string[], where?: string, orderBy?: string[]): Observable { return forkJoin( this.getFolderNode(nodeId, includeFields), this.getFolder(null, { maxItems: pagination.maxItems, skipCount: pagination.skipCount, - orderBy: orderByValue, + orderBy: orderBy, rootFolderId: nodeId, where: where }, includeFields)).pipe(