diff --git a/docs/README.md b/docs/README.md index 9a808dd79a..754a3f2ba2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -173,7 +173,7 @@ for more information about installing and using the source code. | [Page title service](core/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | | [People content service](core/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | | [People process service](core/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) | -| [Renditions service](core/renditions.service.md) ![Deprecated](docassets/images/DeprecatedIcon.png) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) | +| [Renditions service](core/renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) | | [Search configuration service](core/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | | [Search service](core/search.service.md) | Accesses the Content Services Search API. | [Source](../lib/core/services/search.service.ts) | | [Shared links api service](core/shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../lib/core/services/shared-links-api.service.ts) | @@ -200,7 +200,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Data Table Adapter interface](core/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | -| [Form Field Validator interface](core/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | +| [Form Field Validator interface](core/form-field-validator.interface.md) | Defines how the input fields of [`Form`](../../lib/process-services/task-list/models/form.model.ts) and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | | [Search Configuration interface](core/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | [(Back to Contents)](#contents) @@ -267,7 +267,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Content node share directive](content-services/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/content-node-share/content-node-share.directive.ts) | -| [Node lock directive](content-services/node-lock.directive.md) | Locks a node. | [Source](../lib/content-services/directives/node-lock.directive.ts) | +| [Node lock directive](content-services/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/directives/node-lock.directive.ts) | | [Folder create directive](content-services/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) | | [Folder edit directive](content-services/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) | | [Inherited button directive](content-services/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/permission-manager/components/inherited-button.directive.ts) | @@ -277,9 +277,14 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Document library model](content-services/document-library.model.md) | Defines classes for use with the Content Services node API. | [Source](../lib/content-services/document-list/models/document-library.model.ts) | | [Permissions style model](content-services/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/document-list/models/permissions-style.model.ts) | +## Pipes + +| Name | Description | Source link | +| ---- | ----------- | ----------- | +| _File upload error pipe_ | _Not currently documented_ | [Source](../lib/content-services/upload/pipes/file-upload-error.pipe.ts) | + ## Services | Name | Description | Source link | @@ -302,7 +307,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Search Widget interface](content-services/search-widget.interface.md) | Specifies required properties for Search filter component widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) | +| [Search Widget interface](content-services/search-widget.interface.md) | Specifies required properties for [Search filter component](../content-services/search-filter.component.md) widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) | [(Back to Contents)](#contents) @@ -320,10 +325,10 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Apps list component](process-services/apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/app-list/apps-list.component.ts) | -| [Create process attachment component](process-services/create-process-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance | [Source](../lib/process-services/attachment/create-process-attachment.component.ts) | -| [Create task attachment component](process-services/create-task-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified task | [Source](../lib/process-services/attachment/create-task-attachment.component.ts) | -| [Process attachment list component](process-services/process-attachment-list.component.md) | Displays attached documents on a specified process instance | [Source](../lib/process-services/attachment/process-attachment-list.component.ts) | -| [Task attachment list component](process-services/task-attachment-list.component.md) | Displays attached documents on a specified task. | [Source](../lib/process-services/attachment/task-attachment-list.component.ts) | +| [Create process attachment component](process-services/create-process-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified process instance. | [Source](../lib/process-services/attachment/create-process-attachment.component.ts) | +| [Create task attachment component](process-services/create-task-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified task. | [Source](../lib/process-services/attachment/create-task-attachment.component.ts) | +| [Process attachment list component](process-services/process-attachment-list.component.md) | Displays documents attached to a specified process instance. | [Source](../lib/process-services/attachment/process-attachment-list.component.ts) | +| [Task attachment list component](process-services/task-attachment-list.component.md) | Displays documents attached to a specified task. | [Source](../lib/process-services/attachment/task-attachment-list.component.ts) | | [People component](process-services/people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/people/components/people/people.component.ts) | | [People list component](process-services/people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/people/components/people-list/people-list.component.ts) | | [People search component](process-services/people-search.component.md) | Searches users/people. | [Source](../lib/process-services/people/components/people-search/people-search.component.ts) | @@ -336,7 +341,7 @@ for more information about installing and using the source code. | [Start process component](process-services/start-process.component.md) | Starts a process. | [Source](../lib/process-services/process-list/components/start-process.component.ts) | | [Attach form component](process-services/attach-form.component.md) | This component can be used when there is no form attached to a task and you want to add one. | [Source](../lib/process-services/task-list/components/attach-form.component.ts) | | [Checklist component](process-services/checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/task-list/components/checklist.component.ts) | -| [Start task component](process-services/start-task.component.md) | Creates/Starts a new task for the specified app | [Source](../lib/process-services/task-list/components/start-task.component.ts) | +| [Start task component](process-services/start-task.component.md) | Creates/Starts a new task for the specified app. | [Source](../lib/process-services/task-list/components/start-task.component.ts) | | [Task details component](process-services/task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../lib/process-services/task-list/components/task-details.component.ts) | | [Task filters component](process-services/task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/task-list/components/task-filters.component.ts) | | [Task header component](process-services/task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/task-list/components/task-header.component.ts) | @@ -347,7 +352,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Process audit directive](process-services/process-audit.directive.md) | Fetches the Process Audit information the PDF or JSON format. | [Source](../lib/process-services/process-list/components/process-audit.directive.ts) | +| [Process audit directive](process-services/process-audit.directive.md) | Fetches the Process Audit information in PDF or JSON format. | [Source](../lib/process-services/process-list/components/process-audit.directive.ts) | | [Task audit directive](process-services/task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../lib/process-services/task-list/components/task-audit.directive.ts) | ## Services @@ -377,16 +382,24 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [App list cloud component](process-services-cloud/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) | +| [Group cloud component](process-services-cloud/group-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) | | [Edit process filter cloud component](process-services-cloud/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows Process Filter Details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) | | [Process filters cloud component](process-services-cloud/process-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) | | [Process list cloud component](process-services-cloud/process-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) | | [Start process cloud component](process-services-cloud/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | +| [People cloud component](process-services-cloud/people-cloud.component.md) | An autosuggest input control that allows single or multiple users to be selected based on the input parameters. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) | | [Start task cloud component](process-services-cloud/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | | [Edit task filter cloud component](process-services-cloud/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits Task Filter Details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) | | [Task filters cloud component](process-services-cloud/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | +| [Task header cloud component](process-services-cloud/task-header-cloud.component.md) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | | [Task list cloud component](process-services-cloud/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | | _App details cloud component_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.ts) | -| _People cloud component_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) | + +## Pipes + +| Name | Description | Source link | +| ---- | ----------- | ----------- | +| _Group initial pipe_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | ## Services @@ -397,6 +410,9 @@ for more information about installing and using the source code. | [Start task cloud service](process-services-cloud/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) | | [Task filter cloud service](process-services-cloud/task-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) | | _Apps process cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | +| _Group cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | +| _Process list cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | +| _Task header cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) | | _Task list cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | @@ -418,7 +434,6 @@ for more information about installing and using the source code. | ---- | ----------- | ----------- | | [Dynamic component](extensions/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | | [Dynamic tab component](extensions/dynamic-tab.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extensions with tabs. | [Source](../lib/extensions/src/lib/components/dynamic-tab/dynamic-tab.component.ts) | -| _Dynamic column component_ | _Not currently documented_ | [Source](../lib/extensions/src/lib/components/dynamic-column/dynamic-column.component.ts) | ## Services diff --git a/docs/content-services/README.md b/docs/content-services/README.md index f1b6e9e7c7..c298c25d7e 100644 --- a/docs/content-services/README.md +++ b/docs/content-services/README.md @@ -65,7 +65,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Content node share directive](content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../../lib/content-services/content-node-share/content-node-share.directive.ts) | -| [Node lock directive](node-lock.directive.md) | Locks a node. | [Source](../../lib/content-services/directives/node-lock.directive.ts) | +| [Node lock directive](node-lock.directive.md) | Locks or unlocks a node. | [Source](../../lib/content-services/directives/node-lock.directive.ts) | | [Folder create directive](folder-create.directive.md) | Creates folders. | [Source](../../lib/content-services/folder-directive/folder-create.directive.ts) | | [Folder edit directive](folder-edit.directive.md) | Allows folders to be edited. | [Source](../../lib/content-services/folder-directive/folder-edit.directive.ts) | | [Inherited button directive](inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../../lib/content-services/permission-manager/components/inherited-button.directive.ts) | @@ -75,9 +75,14 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Document library model](document-library.model.md) | Defines classes for use with the Content Services node API. | [Source](../../lib/content-services/document-list/models/document-library.model.ts) | | [Permissions style model](permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../../lib/content-services/document-list/models/permissions-style.model.ts) | +## Pipes + +| Name | Description | Source link | +| ---- | ----------- | ----------- | +| _File upload error pipe_ | _Not currently documented_ | [Source](../../lib/content-services/upload/pipes/file-upload-error.pipe.ts) | + ## Services | Name | Description | Source link | diff --git a/docs/content-services/add-permission.component.md b/docs/content-services/add-permission.component.md index 6f38834302..5fa988ceb2 100644 --- a/docs/content-services/add-permission.component.md +++ b/docs/content-services/add-permission.component.md @@ -2,7 +2,7 @@ Title: Add Permission Component Added: v2.4.0 Status: Active -Last reviewed: 2018-11-19 +Last reviewed: 2019-01-16 --- # [Add Permission Component](../../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts "Defined in add-permission.component.ts") @@ -34,7 +34,7 @@ Searches for people or groups to add to the current node permissions. | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the update. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when the node is updated successfully. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated successfully. | ## Details diff --git a/docs/content-services/breadcrumb.component.md b/docs/content-services/breadcrumb.component.md index 89f89644c8..961ba99d5a 100644 --- a/docs/content-services/breadcrumb.component.md +++ b/docs/content-services/breadcrumb.component.md @@ -2,7 +2,7 @@ Title: Breadcrumb Component Added: v2.0.0 Status: Active -Last reviewed: 2018-06-08 +Last reviewed: 2019-01-16 --- # [Breadcrumb Component](../../lib/content-services/breadcrumb/breadcrumb.component.ts "Defined in breadcrumb.component.ts") @@ -26,7 +26,7 @@ Indicates the current position within a navigation hierarchy. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| folderNode | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | null | Active node, builds UI based on folderNode.path.elements collection. | +| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | | maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | | root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | | rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | @@ -37,7 +37,7 @@ Indicates the current position within a navigation hierarchy. | Name | Type | Description | | ---- | ---- | ----------- | -| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElementEntity`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the user clicks on a breadcrumb. | +| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks on a breadcrumb. | ## Details @@ -48,7 +48,7 @@ removed and kept in a menu as with the ### Using the transform function -The function supplied in the `transform` property lets you modify the Node object that the component +The function supplied in the `transform` property lets you modify the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) object that the component uses to find the "crumbs" for the list. You can use this, for example, to remove unwanted items from the list by altering the node's `path.elements` property. @@ -75,7 +75,7 @@ initialization: A transform function to remove the "Sites" folder from the path would look something like this: ```ts - private changeBreadcrumbPath(node: MinimalNodeEntryEntity) { + private changeBreadcrumbPath(node: Node) { if (node && node.path && node.path.elements) { const elements = node.path.elements; diff --git a/docs/content-services/content-action.component.md b/docs/content-services/content-action.component.md index af1bd3abb4..00e3b3741d 100644 --- a/docs/content-services/content-action.component.md +++ b/docs/content-services/content-action.component.md @@ -2,7 +2,7 @@ Title: Content Action component Added: v2.0.0 Status: Active -Last reviewed: 2018-11-20 +Last reviewed: 2019-01-17 --- # [Content Action component](../../lib/content-services/document-list/components/content-action/content-action.component.ts "Defined in content-action.component.ts") @@ -122,8 +122,7 @@ will trigger the same action.) You can also add your own handler by implementing Note that you can use _both_ a built-in handler and your own `execute` function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](../../lib/content-services/document-list/models/document-library.model.ts) as its -parameter (see the [Document Library model](document-library.model.md) page for more -information) which contains full details of the item that the action is operating on. For +parameter. For example, with `handler="delete"` you could use `execute` to show a message with the name, type, and other details of the item just deleted: @@ -354,7 +353,7 @@ your component class: ```ts export class MyComponent { - canDownloadNode = (node: MinimalNodeEntity): boolean => { + canDownloadNode = (node: Node): boolean => { if (node && node.entry && node.entry.name === 'For Sale.docx') { return true; } @@ -410,7 +409,7 @@ The code above relies on the `isCustomActionDisabled` property of a `Function` t ```ts export class MyComponent { - isCustomActionDisabled = (node: MinimalNodeEntity): boolean => { + isCustomActionDisabled = (node: Node): boolean => { if (node && node.entry && node.entry.name === 'custom') { return false; } diff --git a/docs/content-services/content-metadata-card.component.md b/docs/content-services/content-metadata-card.component.md index c586bdf519..09bfb2cb93 100644 --- a/docs/content-services/content-metadata-card.component.md +++ b/docs/content-services/content-metadata-card.component.md @@ -2,7 +2,7 @@ Title: Content Metadata Card component Added: v2.1.0 Status: Active -Last reviewed: 2018-08-07 +Last reviewed: 2019-01-16 --- # [Content Metadata Card component](../../lib/content-services/content-metadata/components/content-metadata-card/content-metadata-card.component.ts "Defined in content-metadata-card.component.ts") @@ -30,9 +30,10 @@ Displays and edits metadata related to a node. | ---- | ---- | ------------- | ----------- | | displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. | | multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. | -| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | (required) The node entity to fetch metadata about | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | (required) The node entity to fetch metadata about | | preset | `string` | | (required) Name of the metadata preset, which defines aspects and their properties. | | readOnly | `boolean` | false | (optional) This flag sets the metadata in read only mode preventing changes. | +| displayDefaultProperties | `boolean` | | (optional) This flag displays/hides the metadata properties. | ## Details diff --git a/docs/content-services/content-metadata.component.md b/docs/content-services/content-metadata.component.md index 45c998f932..c5134b652a 100644 --- a/docs/content-services/content-metadata.component.md +++ b/docs/content-services/content-metadata.component.md @@ -2,7 +2,7 @@ Title: Content Metadata Card component Added: v2.1.0 Status: Active -Last reviewed: 2018-08-07 +Last reviewed: 2019-01-16 --- # [Content Metadata Card component](../../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts "Defined in content-metadata.component.ts") @@ -28,12 +28,12 @@ Displays and edits metadata related to a node. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | +| displayDefaultProperties | `boolean` | true | Toggles whether the metadata properties should be shown | | displayEmpty | `boolean` | false | Toggles whether to display empty values in the card view | -| displayDefaultProperties | `boolean` | true | Toggles whether to display metadata fields values in the card view | | editable | `boolean` | false | Toggles whether the edit button should be shown | | expanded | `boolean` | false | Toggles between expanded (ie, full information) and collapsed (ie, reduced information) in the display | | multi | `boolean` | false | The multi parameter of the underlying material expansion panel, set to true to allow multi accordion to be expanded at the same time | -| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | (required) The node entity to fetch metadata about | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | (required) The node entity to fetch metadata about | | preset | `string` | | Name of the metadata preset, which defines aspects and their properties | ## Details diff --git a/docs/content-services/content-node-dialog.service.md b/docs/content-services/content-node-dialog.service.md index 8d16d26dcf..adb9d1d1c1 100644 --- a/docs/content-services/content-node-dialog.service.md +++ b/docs/content-services/content-node-dialog.service.md @@ -20,40 +20,41 @@ Displays and manages dialogs for selecting content to open, copy or upload. - _action:_ `string` - Name of the action to display in the dialog title - _name:_ `string` - Name of the item on which the action is being performed - **Returns** `string` - Translated version of the title -- **openCopyMoveDialog**(action: `string`, contentEntry: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), permission?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
+- **openCopyMoveDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a dialog to copy or move an item to a new location. - _action:_ `string` - Name of the action (eg, "Copy" or "Move") to show in the title - - _contentEntry:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Item to be copied or moved + - _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - Item to be copied or moved - _permission:_ `string` - (Optional) Permission for the operation - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about files that were copied/moved -- **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
+ - _excludeSiteContent:_ `string[]` - (Optional) The site content that should be filtered out + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>` - Information about files that were copied/moved +- **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a file browser at a chosen folder location. - _folderNodeId:_ `string` - ID of the folder to use - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the selected file(s) -- **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) +- **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a file browser at a chosen site location. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the selected file(s) -- **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) +- **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a folder browser at a chosen folder location. - _folderNodeId:_ `string` - ID of the folder to use - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the selected folder(s) -- **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s) +- **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a folder browser at a chosen site location. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the selected folder(s) -- **openLockNodeDialog**(contentEntry: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md)): [`Subject`](http://reactivex.io/documentation/subject.html)``
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s) +- **openLockNodeDialog**(contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)): [`Subject`](http://reactivex.io/documentation/subject.html)``
Opens a lock node dialog. - - _contentEntry:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Node to lock + - _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to lock - **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`` - Error/status message (if any) -- **openUploadFileDialog**(action: `string`, contentEntry: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
+- **openUploadFileDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a dialog to choose a file to upload. - _action:_ `string` - Name of the action to show in the title - - _contentEntry:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Item to upload - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the chosen file(s) -- **openUploadFolderDialog**(action: `string`, contentEntry: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
+ - _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - Item to upload + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen file(s) +- **openUploadFolderDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a dialog to choose folders to upload. - _action:_ `string` - Name of the action to show in the title - - _contentEntry:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Item to upload - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the chosen folder(s) + - _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - Item to upload + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen folder(s) ## Details @@ -70,7 +71,7 @@ constructor(private contentDialogService: ContentNodeDialogService){} yourFunctionOnCopyOrMove(){ this.contentDialogService .openCopyMoveDialog(actionName, targetNode, neededPermissionForAction) - .subscribe((selections: MinimalNodeEntryEntity[]) => { + .subscribe((selections: MinimalNode[]) => { // place your action here on operation success! }); } @@ -78,7 +79,7 @@ yourFunctionOnCopyOrMove(){ The `openXXXByFolderId` methods let you set the initial folder location of the browser using a folder ID string. This can be obtained from the `id` property of a -[`MinimalNodeEntryEntity`](../content-services/document-library.model.md) object (returned from a previous +[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) object (returned from a previous dialog operation, say) or be set to one of the well-known names "-my-" , "-shared-" or "-root-". diff --git a/docs/content-services/content-node-selector-panel.component.md b/docs/content-services/content-node-selector-panel.component.md index 297092450b..166f326b5b 100644 --- a/docs/content-services/content-node-selector-panel.component.md +++ b/docs/content-services/content-node-selector-panel.component.md @@ -2,12 +2,12 @@ Title: Content Node Selector Panel component Added: v2.1.0 Status: Active -Last reviewed: 2018-11-19 +Last reviewed: 2019-01-16 --- # [Content Node Selector Panel component](../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts "Defined in content-node-selector-panel.component.ts") -Opens a Content Node Selector in its own dialog window. +Opens a Content [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) Selector in its own dialog window. ![Content Node Selector screenshot](../docassets/images/ContentNodeSelector.png) @@ -31,20 +31,20 @@ Opens a Content Node Selector in its own dialog window. | 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. | -| currentFolderId | `string` | null | Node ID of the folder currently listed. | +| 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 same as siteList. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | +| excludeSiteContent | `string[]` | \[] | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | | imageResolver | `ImageResolver` | null | Custom image resolver function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | | isSelectionValid | `ValidationFunction` | 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. | | rowFilter | `RowFilter` | null | Custom row filter function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | -| excludeSiteContent | string[] | [] | Custom list of site content componentIds that is used to filter out their corresponding items from the displayed nodes. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` | Emitted when the user has chosen an item. | +| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`[]>` | Emitted when the user has chosen an item. | ## Details @@ -57,7 +57,7 @@ finer control over the behavior of the dialog. ### Using the breadcrumbTransform function -The `breadcrumbTransform` property lets you modify the Node object that is used to generate the +The `breadcrumbTransform` property lets you modify the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) object that is used to generate the list of breadcrumbs. You can use this, for example, to remove path elements that are not relevant to the use case. See the [Breadcrumb component](breadcrumb.component.md) page for an example of how to use this function. diff --git a/docs/content-services/content-node-selector.component.md b/docs/content-services/content-node-selector.component.md index 4ecb7b6086..5f613c884e 100644 --- a/docs/content-services/content-node-selector.component.md +++ b/docs/content-services/content-node-selector.component.md @@ -22,7 +22,7 @@ more information). ### Showing the dialog -Unlike most components, the Content Node Selector is typically shown in a dialog box +Unlike most components, the Content [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) Selector is typically shown in a dialog box rather than the main page and you are responsible for opening the dialog yourself. You can use the [Angular Material Dialog](https://material.angular.io/components/dialog/overview) for this, as shown in the usage example. ADF provides the [`ContentNodeSelectorComponentData`](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) interface @@ -30,17 +30,18 @@ to work with the Dialog's [data option](https://material.angular.io/components/dialog/overview#sharing-data-with-the-dialog-component-): ```ts -interface ContentNodeSelectorComponentData { +export interface ContentNodeSelectorComponentData { title: string; actionName?: string; currentFolderId: string; dropdownHideMyFiles?: boolean; dropdownSiteList?: SitePaging; - rowFilter?: RowFilter; - imageResolver?: ImageResolver; - isSelectionValid?: (entry: MinimalNodeEntryEntity) => boolean; + rowFilter?: any; + imageResolver?: any; + isSelectionValid?: (entry: Node) => boolean; breadcrumbTransform?: (node) => any; - select: EventEmitter; + excludeSiteContent?: string[]; + select: Subject; } ``` @@ -50,7 +51,7 @@ The properties are described in the table below: | ---- | ---- | ------------- | ----------- | | title | `string` | "" | Dialog title | | actionName | `string` | "" | Text to appear on the dialog's main action button ("Move", "Copy", etc) | -| currentFolderId | `string` | `null` | Node ID of the folder currently listed. | +| 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 same as siteList. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | | rowFilter | [`RowFilter`](../../lib/content-services/document-list/data/row-filter.model.ts) | `null` | Custom row filter function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | @@ -58,7 +59,7 @@ The properties are described in the table below: | pageSize | `number` | | Number of items shown per page in the list. | | isSelectionValid | [`ValidationFunction`](../../lib/content-services/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. | | breadcrumbTransform | `(node: any) => any` | | 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. | -| select | [`EventEmitter`](../content-services/document-library.model.md) | | Event emitted with the current node selection when the dialog closes | +| select | [`Subject`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | Event emitted with the current node selection when the dialog closes | If you don't want to manage the dialog yourself then it is easier to use the [Content Node Selector Panel component](content-node-selector-panel.component.md), or the @@ -80,7 +81,7 @@ openSelectorDialog() { title: "Choose an item", actionName: "Choose", currentFolderId: someFolderId, - select: new Subject() + select: new Subject() }; this.dialog.open( @@ -91,7 +92,7 @@ openSelectorDialog() { } ); - data.select.subscribe((selections: MinimalNodeEntryEntity[]) => { + data.select.subscribe((selections: Node[]) => { // Use or store selection... }, (error)=>{ @@ -109,7 +110,7 @@ When the dialog action is selected by clicking, the `data.select` stream will be ### RowFilter and ImageResolver -The Content Node Selector uses a [Document List](document-list.component.md) to display the +The Content [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) Selector uses a [Document List](document-list.component.md) to display the items that the user can choose. As with the standard Document List, you can supply a custom **row filter** function (to hide items that can't be chosen) and a custom **image resolver** function (to select an image to show in a particular list cell). For example, you could use @@ -120,7 +121,7 @@ section of the Document List page to learn how these functions are implemented. ### Using the breadcrumbTransform function The `breadcrumbTransform` property of [`ContentNodeSelectorComponentData`](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) lets you modify -the Node object that is used to generate the +the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) object that is used to generate the list of breadcrumbs. You can use this, for example, to remove path elements that are not relevant to the use case. See the [Breadcrumb component](breadcrumb.component.md) page for an example of how to use this function. diff --git a/docs/content-services/document-library.model.md b/docs/content-services/document-library.model.md deleted file mode 100644 index 8d5807e0b9..0000000000 --- a/docs/content-services/document-library.model.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -Title: Document Library model -Added: v2.0.0 -Status: Active ---- - -# [Document Library model](../../lib/content-services/document-list/models/document-library.model.ts "Defined in document-library.model.ts") - -Defines classes for use with the Content Services node API. - -## Details - -ADF provides several services that give higher-level access to -underlying [Alfresco JS Api](../core/alfresco-api.service.md) functionality. -The classes defined below are used in some of these services to access -the Content Services nodes API. You can use these services to access -the nodes (ie, documents and folders) of a repository using their -associated ID strings. See [Nodes Api service](../core/nodes-api.service.md) -for more detail about the usage of these classes. - -## Node information - -These classes contain basic information about nodes (see -[Item information](#item-information) below for more detail -about some of the properties). For example, this is used by the -[Document List component](document-list.component.md) to supply -a [data context](document-list.component.md#underlying-node-object) -for each row of the list. The [Nodes Api service](../core/nodes-api.service.md) -has methods for getting the full information for a node ID string. - -```ts -class NodeMinimalEntry implements MinimalNodeEntity { - entry: NodeMinimal; -} - -class NodeMinimal implements MinimalNodeEntryEntity { - id: string; - parentId: string; - name: string; - nodeType: string; - isFolder: boolean; - isFile: boolean; - modifiedAt: Date; - modifiedByUser: UserInfo; - createdAt: Date; - createdByUser: UserInfo; - content: ContentInfo; - path: PathInfoEntity; - properties: NodeProperties = {}; -} - -interface NodeProperties { - [key: string]: any; -} -``` - -## Paging - -These classes are used to handle a list of nodes, such as the -contents of a folder node. For example, the `node` property of -the [Document List component](document-list.component.md) contains -the node whose contents are currently shown in the document list. - -```ts -class NodePaging { - list: NodePagingList; -} - -class NodePagingList { - pagination: Pagination; - entries: NodeMinimalEntry[]; -} - -class Pagination { - count: number; - hasMoreItems: boolean; - totalItems: number; - skipCount: number; - maxItems: number; -} -``` - -## Item information - -These classes hold information about specific items related to -a node. - -```ts -class UserInfo { - displayName: string; - id: string; -} - -class ContentInfo { - mimeType: string; - mimeTypeName: string; - sizeInBytes: number; - encoding: string; -} - -class PathInfoEntity { - elements: PathElementEntity[]; - isComplete: boolean; - name: string; -} - -class PathElementEntity { - id: string; - name: string; -} -``` - - - - - -## See also - -- [Document list component](document-list.component.md) -- [Nodes api service](../core/nodes-api.service.md) - diff --git a/docs/content-services/document-list.component.md b/docs/content-services/document-list.component.md index 3e79663237..9913301a88 100644 --- a/docs/content-services/document-list.component.md +++ b/docs/content-services/document-list.component.md @@ -121,7 +121,7 @@ have at least the following properties as part of the `Event.detail` property va ```ts { sender: DocumentListComponent, - node: MinimalNodeEntity + node: NodeEntry } ``` @@ -202,7 +202,7 @@ You can use any of the following options to set the folder that the Document Lis #### Node ID -The unique identifier of the Node. Gets automatically updated when you perform navigation to other folders. +The unique identifier of the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md). Gets automatically updated when you perform navigation to other folders. #### Repository aliases @@ -475,7 +475,7 @@ documentation for a full explanation of the component lifecycle. ### Underlying node object The [Document List component](../content-services/document-list.component.md) assigns an instance of -[MinimalNode](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/MinimalNode.md) +[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) (defined in the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api)) as the data context for each row. You can make use of the properties of this object when defining custom columns: @@ -870,7 +870,6 @@ This will give the following output: - [Infinite pagination component](../core/infinite-pagination.component.md) - [Sites dropdown component](sites-dropdown.component.md) - [Metadata indicators](../user-guide/metadata-indicators.md) -- [Document library model](document-library.model.md) - [Nodes api service](../core/nodes-api.service.md) - [Breadcrumb component](breadcrumb.component.md) - [Content action component](content-action.component.md) diff --git a/docs/content-services/document-list.service.md b/docs/content-services/document-list.service.md index 5dd86817f6..d3ef525ec1 100644 --- a/docs/content-services/document-list.service.md +++ b/docs/content-services/document-list.service.md @@ -27,7 +27,7 @@ Implements node operations used by the [Document List component](../content-serv - **Returns** `string` - Path to the icon file - **getDocumentThumbnailUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `string`
Get thumbnail URL for the given document node. - - _node:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Node to get URL for. + - _node:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to get URL for. - **Returns** `string` - Thumbnail URL string - **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets the folder node with the specified relative name path below the root node. @@ -62,9 +62,6 @@ see the [Nodes API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#getNodeChildren) for further details of the types, options and the underlying REST architecture. -Also, the [Document Library model](document-library.model.md) in the ADF docs has -more information about related classes. - ### Moving, copying and deleting nodes Both `moveNode` and `copyNode` create a copy of the existing node under a new diff --git a/docs/content-services/dropdown-breadcrumb.component.md b/docs/content-services/dropdown-breadcrumb.component.md index ca7252b244..cba91f1c6e 100644 --- a/docs/content-services/dropdown-breadcrumb.component.md +++ b/docs/content-services/dropdown-breadcrumb.component.md @@ -2,7 +2,7 @@ Title: Dropdown Breadcrumb Component Added: v2.0.0 Status: Active -Last reviewed: 2018-06-08 +Last reviewed: 2019-01-16 --- # [Dropdown Breadcrumb Component](../../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts "Defined in dropdown-breadcrumb.component.ts") @@ -26,7 +26,7 @@ Indicates the current position within a navigation hierarchy using a dropdown me | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| folderNode | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | null | Active node, builds UI based on folderNode.path.elements collection. | +| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | | maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | | root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | | rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | @@ -37,7 +37,7 @@ Indicates the current position within a navigation hierarchy using a dropdown me | Name | Type | Description | | ---- | ---- | ----------- | -| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElementEntity`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the user clicks on a breadcrumb. | +| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/folder-create.directive.md b/docs/content-services/folder-create.directive.md index c6dcd37c99..8d9c057ef4 100644 --- a/docs/content-services/folder-create.directive.md +++ b/docs/content-services/folder-create.directive.md @@ -2,7 +2,7 @@ Title: Folder Create directive Added: v2.0.0 Status: Active -Last reviewed: 2018-11-20 +Last reviewed: 2019-01-16 --- # [Folder Create directive](../../lib/content-services/folder-directive/folder-create.directive.ts "Defined in folder-create.directive.ts") @@ -41,7 +41,7 @@ Creates folders. | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when the folder is created successfully. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. | ## Details diff --git a/docs/content-services/folder-edit.directive.md b/docs/content-services/folder-edit.directive.md index 3824e34e9d..ed999a6723 100644 --- a/docs/content-services/folder-edit.directive.md +++ b/docs/content-services/folder-edit.directive.md @@ -2,7 +2,7 @@ Title: Folder Edit directive Added: v2.0.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2019-01-16 --- # [Folder Edit directive](../../lib/content-services/folder-directive/folder-edit.directive.ts "Defined in folder-edit.directive.ts") @@ -32,7 +32,7 @@ Allows folders to be edited. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| folder | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | Folder node to edit. | +| folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. | | title | `string` | null | Title of folder edit dialog. | ### Events @@ -40,7 +40,7 @@ Allows folders to be edited. | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when the folder has been edited successfully. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. | ## Details diff --git a/docs/content-services/inherited-button.directive.md b/docs/content-services/inherited-button.directive.md index 52b51fec0d..26c4ec5fd4 100644 --- a/docs/content-services/inherited-button.directive.md +++ b/docs/content-services/inherited-button.directive.md @@ -2,7 +2,7 @@ Title: Inherit Permission directive Added: v2.3.0 Status: Active -Last reviewed: 2018-11-20 +Last reviewed: 2019-01-16 --- # [Inherit Permission directive](../../lib/content-services/permission-manager/components/inherited-button.directive.ts "Defined in inherited-button.directive.ts") @@ -31,7 +31,7 @@ Update the current node by adding/removing the inherited permissions. | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when the node is updated. | +| updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated. | ## Details diff --git a/docs/content-services/node-lock.directive.md b/docs/content-services/node-lock.directive.md index 187a73e2a0..44a3a68a4d 100644 --- a/docs/content-services/node-lock.directive.md +++ b/docs/content-services/node-lock.directive.md @@ -2,12 +2,12 @@ Title: Node Lock directive Added: v2.2.0 Status: Active -Last reviewed: 2018-11-20 +Last reviewed: 2019-01-17 --- # [Node Lock directive](../../lib/content-services/directives/node-lock.directive.ts "Defined in node-lock.directive.ts") -Locks a node. +Locks or unlocks a node. ## Basic Usage @@ -23,7 +23,7 @@ Locks a node. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | Node to lock/unlock. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to lock/unlock. | ## Details diff --git a/docs/content-services/node-permission-dialog.service.md b/docs/content-services/node-permission-dialog.service.md index c0493c3536..199cc0e87e 100644 --- a/docs/content-services/node-permission-dialog.service.md +++ b/docs/content-services/node-permission-dialog.service.md @@ -2,7 +2,7 @@ Title: Node permission dialog service Added: v2.4.0 Status: Active -Last reviewed: 2018-09-13 +Last reviewed: 2019-01-16 --- # [Node permission dialog service](../../lib/content-services/permission-manager/services/node-permission-dialog.service.ts "Defined in node-permission-dialog.service.ts") @@ -15,16 +15,16 @@ Displays dialogs to let the user set node permissions. - **close**()
Closes the currently-open dialog. -- **openAddPermissionDialog**(node: `Node`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntity`](../content-services/document-library.model.md)`[]>`
+- **openAddPermissionDialog**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), title?: `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)`[]>`
Opens a dialog to add permissions to a node. - - _node:_ `Node` - ID of the target node + - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - ID of the target node - _title:_ `string` - (Optional) Dialog title - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntity`](../content-services/document-library.model.md)`[]>` - Node with updated permissions -- **updateNodePermissionByDialog**(nodeId?: `string`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
+ - **Returns** [`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)`[]>` - Node with updated permissions +- **updateNodePermissionByDialog**(nodeId?: `string`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>`
Opens a dialog to update permissions for a node. - _nodeId:_ `string` - (Optional) ID of the target node - _title:_ `string` - (Optional) Dialog title - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permissions + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions ## Details diff --git a/docs/content-services/node-permission.service.md b/docs/content-services/node-permission.service.md index b2f1ba23b1..0ae6ee4888 100644 --- a/docs/content-services/node-permission.service.md +++ b/docs/content-services/node-permission.service.md @@ -2,7 +2,7 @@ Title: Node Permission service Added: v2.0.0 Status: Active -Last reviewed: 2018-11-14 +Last reviewed: 2019-01-16 --- # [Node Permission service](../../lib/content-services/permission-manager/services/node-permission.service.ts "Defined in node-permission.service.ts") @@ -13,36 +13,36 @@ Manages role permissions for content nodes. ### Methods -- **getGroupMemberByGroupName**(groupName: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getGroupMemberByGroupName**(groupName: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/GroupMemberPaging.md)`>`
Gets all members related to a group name. - _groupName:_ `string` - Name of group to look for members - _opts:_ `any` - (Optional) Extra options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of members -- **getNodeRoles**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/GroupMemberPaging.md)`>` - List of members +- **getNodeRoles**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets a list of roles for the current node. - - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - The target node + - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.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)`>`
+- **removePermission**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), permissionToRemove: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>`
Removes a permission setting from a node. - - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - ID of the target node + - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.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)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` - Node with modified permissions +- **updateLocallySetPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), nodes: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.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 + - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - ID of the target node + - _nodes:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.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)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions +- **updateNodePermissions**(nodeId: `string`, permissionList: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.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)`>`
+ - _permissionList:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - New permission settings + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions +- **updatePermissionRole**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), updatedPermissionRole: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>`
Updates the permission role for a node. - - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Target node + - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.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 + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permission ## Details diff --git a/docs/content-services/upload-version-button.component.md b/docs/content-services/upload-version-button.component.md index 805be23346..e589cd11d6 100644 --- a/docs/content-services/upload-version-button.component.md +++ b/docs/content-services/upload-version-button.component.md @@ -37,7 +37,7 @@ to enrich the features and decrease the restrictions currently applied to node v | majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | | maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | | multipleFiles | `boolean` | false | Allows/disallows multiple files | -| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | (**Required**) The node to be versioned. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | (**Required**) The node to be versioned. | | nodeType | `string` | "cm:content" | Custom node type for uploaded file | | rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | | staticTitle | `string` | | Defines the text of the upload button. | @@ -49,8 +49,7 @@ 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/upload/components/upload-files.event.ts)`>` | | -| createFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a folder is created. | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | | 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/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. | diff --git a/docs/content-services/version-manager.component.md b/docs/content-services/version-manager.component.md index 60de626394..d4ea21f6d4 100644 --- a/docs/content-services/version-manager.component.md +++ b/docs/content-services/version-manager.component.md @@ -2,7 +2,7 @@ Title: Version Manager Component Added: v2.0.0 Status: Experimental -Last reviewed: 2018-04-13 +Last reviewed: 2019-01-16 --- # [Version Manager Component](../../lib/content-services/version-manager/version-manager.component.ts "Defined in version-manager.component.ts") @@ -17,7 +17,7 @@ Displays the version history of a node with the ability to upload a new version. ```html @@ -30,15 +30,15 @@ Displays the version history of a node with the ability to upload a new version. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | -| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | Target node to manage version history. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | Target node to manage version history. | | showComments | `boolean` | true | Toggles showing/hiding of comments. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when an error occurs during upload. | -| uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when a file is uploaded successfully. | +| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when an error occurs during upload. | +| uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a file is uploaded successfully. | ## Details diff --git a/docs/core/README.md b/docs/core/README.md index e99c5ae16d..5cd40bc383 100644 --- a/docs/core/README.md +++ b/docs/core/README.md @@ -29,7 +29,7 @@ for more information about installing and using the source code. | [Form component](form.component.md) | Shows a Form from APS | [Source](../../lib/core/form/components/form.component.ts) | | [Start form component](start-form.component.md) | Displays the Start Form for a process. | [Source](../../lib/core/form/components/start-form.component.ts) | | [Text mask component](text-mask.component.md) | Implements text field input masks. | [Source](../../lib/core/form/components/widgets/text/text-mask.component.ts) | -| [Icon component](icon.component.md) | Provides universal way of rendering registered and named icons. | [Source](../../lib/core/icon/icon.component.ts) | +| [Icon component](icon.component.md) | Provides a universal way of rendering registered and named icons. | [Source](../../lib/core/icon/icon.component.ts) | | [Info drawer layout component](info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../../lib/core/info-drawer/info-drawer-layout.component.ts) | | [Info drawer component](info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../../lib/core/info-drawer/info-drawer.component.ts) | | [Language menu component](language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../../lib/core/language-menu/language-menu.component.ts) | @@ -122,7 +122,7 @@ for more information about installing and using the source code. | [Page title service](page-title.service.md) | Sets the page title. | [Source](../../lib/core/services/page-title.service.ts) | | [People content service](people-content.service.md) | Gets information about a Content Services user. | [Source](../../lib/core/services/people-content.service.ts) | | [People process service](people-process.service.md) | Gets information about Process Services users. | [Source](../../lib/core/services/people-process.service.ts) | -| [Renditions service](renditions.service.md) ![Deprecated](../docassets/images/DeprecatedIcon.png) | Manages prearranged conversions of content to different formats. | [Source](../../lib/core/services/renditions.service.ts) | +| [Renditions service](renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../../lib/core/services/renditions.service.ts) | | [Search configuration service](search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../../lib/core/services/search-configuration.service.ts) | | [Search service](search.service.md) | Accesses the Content Services Search API. | [Source](../../lib/core/services/search.service.ts) | | [Shared links api service](shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../../lib/core/services/shared-links-api.service.ts) | diff --git a/docs/core/alfresco-api.service.md b/docs/core/alfresco-api.service.md index c367b571a7..056324dacf 100644 --- a/docs/core/alfresco-api.service.md +++ b/docs/core/alfresco-api.service.md @@ -2,7 +2,7 @@ Title: Alfresco Api Service Added: v2.0.0 Status: Active -Last reviewed: 2018-04-13 +Last reviewed: 2019-01-17 --- # [Alfresco Api Service](../../lib/core/services/alfresco-api.service.ts "Defined in alfresco-api.service.ts") @@ -47,7 +47,7 @@ export class MyComponent implements OnInit { | Name | Type | Description | | ---- | ---- | ----------- | -| nodeUpdated | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when a node updates. | +| nodeUpdated | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a node updates. | ## Details diff --git a/docs/core/deleted-nodes-api.service.md b/docs/core/deleted-nodes-api.service.md index 83dbd1dc77..7267044651 100644 --- a/docs/core/deleted-nodes-api.service.md +++ b/docs/core/deleted-nodes-api.service.md @@ -21,8 +21,7 @@ Gets a list of Content Services nodes currently in the trash. ## Details The `getDeletedNodes` method returns a [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) object that lists -the items in the trash (see [Document Library model](../content-services/document-library.model.md) for -more information about this class). The format of the `options` parameter is +the items in the trash. The format of the `options` parameter is described in the [getDeletedNodes](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#getDeletedNodes) page of the Alfresco JS API docs. diff --git a/docs/core/node-permission.directive.md b/docs/core/node-permission.directive.md index 91df62725d..c6f98f0d1e 100644 --- a/docs/core/node-permission.directive.md +++ b/docs/core/node-permission.directive.md @@ -42,13 +42,13 @@ Selectively disables an HTML element or Angular component. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| nodes | [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` | \[] | Nodes to check permission for. | -| permission | `string` | null | Node permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). | +| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. | +| permission | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). | ## Details The [Node Permission directive](../core/node-permission.directive.md) lets you disable an HTML element or Angular component -by taking a collection of [`MinimalNodeEntity`](../content-services/document-library.model.md) instances and checking their permissions. +by taking a collection of [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) instances and checking their permissions. The decorated element will be disabled if: diff --git a/docs/core/nodes-api.service.md b/docs/core/nodes-api.service.md index 2b7e758dd3..447feec378 100644 --- a/docs/core/nodes-api.service.md +++ b/docs/core/nodes-api.service.md @@ -2,7 +2,7 @@ Title: Nodes Api service Added: v2.0.0 Status: Active -Last reviewed: 2018-11-13 +Last reviewed: 2019-01-16 --- # [Nodes Api service](../../lib/core/services/nodes-api.service.ts "Defined in nodes-api.service.ts") @@ -24,43 +24,43 @@ Accesses and manipulates ACS document nodes using their node IDs. ### Methods -- **createFolder**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
+- **createFolder**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Creates a new folder node inside a parent folder. - _parentNodeId:_ `string` - ID of the parent folder node - _nodeBody:_ `any` - Data for the new folder - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Details of the new folder -- **createNode**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the new folder +- **createNode**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Creates a new document node inside a folder. - _parentNodeId:_ `string` - ID of the parent folder node - _nodeBody:_ `any` - Data for the new node - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Details of the new node + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the new node - **deleteNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Moves a node to the trashcan. - _nodeId:_ `string` - ID of the target node - _options:_ `any` - Optional parameters supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty result that notifies when the deletion is complete -- **getNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
+- **getNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Gets the stored information about a node. - _nodeId:_ `string` - ID of the target node - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node information + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Node information - **getNodeChildren**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets the items contained in a folder node. - _nodeId:_ `string` - ID of the target node - _options:_ `any` - Optional parameters supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of child items from the folder -- **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
+- **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Restores a node previously moved to the trashcan. - _nodeId:_ `string` - ID of the node to restore - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Details of the restored node -- **updateNode**(nodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the restored node +- **updateNode**(nodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Updates the information about a node. - _nodeId:_ `string` - ID of the target node - _nodeBody:_ `any` - New data for the node - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Updated node information + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Updated node information ## Details @@ -85,12 +85,10 @@ for more information. ### Getting node information -The `getNode` method gives access to the MinimalNode object that represents the +The `getNode` method gives access to the [MinimalNode](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) object that represents the details of a node: ```ts -interface MinimalNodeEntryEntity extends MinimalNode { -} interface MinimalNode extends Node {    id: string;    parentId: string; @@ -112,18 +110,18 @@ This provides useful information about the node, such as its name, creation and modification dates, etc. Also, the `id` and `parentId` properties contain the node ID strings for the current node and its enclosing folder. -Sometimes, a MinimalNode is provided directly, for example, the `folderNode` property +Sometimes, a [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) is provided directly, for example, the `folderNode` property of a [Document List component](../content-services/document-list.component.md) or the data context of a [Document List row](../content-services/document-list.component.md#underlying-node-object). In these cases, you might pass the `id` or `parentId` as a [route parameter](https://angular.io/guide/router) to a page describing the node in full detail. The component receiving the node ID can -use the [Nodes Api service](../core/nodes-api.service.md) to "decode" the ID string into a [`MinimalNodeEntryEntity`](../content-services/document-library.model.md): +use the [Nodes Api service](../core/nodes-api.service.md) to "decode" the ID string into a `MinimalNode`: ```ts import { ActivatedRoute, Router } from '@angular/router'; import { Component, OnInit } from '@angular/core'; import { NodesApiService } from '@alfresco/adf-core'; -import { MinimalNodeEntryEntity } from 'alfresco-js-api'; +import { MinimalNode } from '@alfresco/js-api'; ... export class RepositoryDetailsPageComponent implements OnInit { @@ -139,8 +137,8 @@ export class RepositoryDetailsPageComponent implements OnInit {  ngOnInit() {    this.nodeId = this.activatedRoute.snapshot.params['node-id']; -   this.nodeService.getNode(this.nodeId).subscribe((entry: MinimalNodeEntryEntity) => { -     const node: MinimalNodeEntryEntity = entry; +   this.nodeService.getNode(this.nodeId).subscribe((entry: MinimalNode) => { +     const node: MinimalNode = entry;      this.nodeName = node.name;      this.isFile = node.isFile; ... @@ -155,9 +153,7 @@ page in the Alfresco JS API docs for more information. ### Getting folder node contents The `getNodeChildren` method returns the contents of a folder -as a list of items. See the [Paging section](../content-services/document-library.model.md#paging) -of [Document Library model](../content-services/document-library.model.md) for -more information about the structure of the list. Also, the +as a list of items. The [getNodeChildren](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#getNodeChildren) page in the Alfresco JS API gives more information about the structure of the `options` parameter. @@ -191,7 +187,6 @@ pages in the Alfresco JS API for further details and options. Note that you can ## See also -- [Document library model](../content-services/document-library.model.md) - [Deleted nodes api service](deleted-nodes-api.service.md) - [Document list component](../content-services/document-list.component.md) - [Node service](node.service.md) diff --git a/docs/core/process-content.service.md b/docs/core/process-content.service.md index da66c9de6c..832b0f1bfc 100644 --- a/docs/core/process-content.service.md +++ b/docs/core/process-content.service.md @@ -380,7 +380,7 @@ The response format is the same as for the `getProcessRelatedContent` method, se ## Importing ```ts -import { RelatedContentRepresentation } from 'alfresco-js-api'; +import { RelatedContentRepresentation } from '@alfresco/js-api'; import { ProcessContentService } from '@alfresco/adf-core'; export class SomePageComponent implements OnInit { diff --git a/docs/core/search-configuration.interface.md b/docs/core/search-configuration.interface.md index c7d7478a14..400963ad01 100644 --- a/docs/core/search-configuration.interface.md +++ b/docs/core/search-configuration.interface.md @@ -36,7 +36,7 @@ described below. An example implementation is given below: ```ts - import { QueryBody } from 'alfresco-js-api'; + import { QueryBody } from '@alfresco/js-api'; import { SearchConfigurationInterface } from '@alfresco/adf-core'; export class TestSearchConfigurationService implements SearchConfigurationInterface { diff --git a/docs/process-services/README.md b/docs/process-services/README.md index 766314aae3..adfd898e0a 100644 --- a/docs/process-services/README.md +++ b/docs/process-services/README.md @@ -17,10 +17,10 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Apps list component](apps-list.component.md) | Shows all available apps. | [Source](../../lib/process-services/app-list/apps-list.component.ts) | -| [Create process attachment component](create-process-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance | [Source](../../lib/process-services/attachment/create-process-attachment.component.ts) | -| [Create task attachment component](create-task-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified task | [Source](../../lib/process-services/attachment/create-task-attachment.component.ts) | -| [Process attachment list component](process-attachment-list.component.md) | Displays attached documents on a specified process instance | [Source](../../lib/process-services/attachment/process-attachment-list.component.ts) | -| [Task attachment list component](task-attachment-list.component.md) | Displays attached documents on a specified task. | [Source](../../lib/process-services/attachment/task-attachment-list.component.ts) | +| [Create process attachment component](create-process-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified process instance. | [Source](../../lib/process-services/attachment/create-process-attachment.component.ts) | +| [Create task attachment component](create-task-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified task. | [Source](../../lib/process-services/attachment/create-task-attachment.component.ts) | +| [Process attachment list component](process-attachment-list.component.md) | Displays documents attached to a specified process instance. | [Source](../../lib/process-services/attachment/process-attachment-list.component.ts) | +| [Task attachment list component](task-attachment-list.component.md) | Displays documents attached to a specified task. | [Source](../../lib/process-services/attachment/task-attachment-list.component.ts) | | [People component](people.component.md) | Displays users involved with a specified task | [Source](../../lib/process-services/people/components/people/people.component.ts) | | [People list component](people-list.component.md) | Shows a list of users (people). | [Source](../../lib/process-services/people/components/people-list/people-list.component.ts) | | [People search component](people-search.component.md) | Searches users/people. | [Source](../../lib/process-services/people/components/people-search/people-search.component.ts) | @@ -33,7 +33,7 @@ for more information about installing and using the source code. | [Start process component](start-process.component.md) | Starts a process. | [Source](../../lib/process-services/process-list/components/start-process.component.ts) | | [Attach form component](attach-form.component.md) | This component can be used when there is no form attached to a task and you want to add one. | [Source](../../lib/process-services/task-list/components/attach-form.component.ts) | | [Checklist component](checklist.component.md) | Shows the checklist task functionality. | [Source](../../lib/process-services/task-list/components/checklist.component.ts) | -| [Start task component](start-task.component.md) | Creates/Starts a new task for the specified app | [Source](../../lib/process-services/task-list/components/start-task.component.ts) | +| [Start task component](start-task.component.md) | Creates/Starts a new task for the specified app. | [Source](../../lib/process-services/task-list/components/start-task.component.ts) | | [Task details component](task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../../lib/process-services/task-list/components/task-details.component.ts) | | [Task filters component](task-filters.component.md) | Shows all available filters. | [Source](../../lib/process-services/task-list/components/task-filters.component.ts) | | [Task header component](task-header.component.md) | Shows all the information related to a task. | [Source](../../lib/process-services/task-list/components/task-header.component.ts) | @@ -44,7 +44,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Process audit directive](process-audit.directive.md) | Fetches the Process Audit information the PDF or JSON format. | [Source](../../lib/process-services/process-list/components/process-audit.directive.ts) | +| [Process audit directive](process-audit.directive.md) | Fetches the Process Audit information in PDF or JSON format. | [Source](../../lib/process-services/process-list/components/process-audit.directive.ts) | | [Task audit directive](task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../../lib/process-services/task-list/components/task-audit.directive.ts) | ## Services diff --git a/docs/process-services/start-process.component.md b/docs/process-services/start-process.component.md index 160e786bd6..d497d70ac9 100644 --- a/docs/process-services/start-process.component.md +++ b/docs/process-services/start-process.component.md @@ -43,7 +43,7 @@ Starts a process. | processDefinitionName | `string` | | (optional) Definition name of the process to start. | | processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. | | showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. | -| values | `FormValues` | | Parameter to pass form field values in the start form if one is associated. | +| values | [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. | | variables | [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md). | ### Events @@ -126,7 +126,7 @@ to _alfresco-1002_ as follows: You then need to pass the node as the input `values` object with the other properties: ```ts -let node: MinimalNodeEntryEntity = null; +let node: MinimalNode = null; this.nodesApiService.getNode(NODE_ID).subscribe((minimalNode) => this.node = minimalNode); @@ -159,7 +159,7 @@ const values: FormValues = { ``` Note that in the object above, the key `file` is the name of the attach file field in the start form of the process. The value of the `file` property must be a -[`MinimalNodeEntryEntity`](../content-services/document-library.model.md): +[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md): ```html ` - Details of the assigned task -- **assignTaskByUserId**(taskId: `string`, userId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../lib/process-services/task-list/models/task-details.model.ts)`>`
+- **assignTaskByUserId**(taskId: `string`, userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../lib/process-services/task-list/models/task-details.model.ts)`>`
Assigns a task to a user. - _taskId:_ `string` - ID of the task to assign - - _userId:_ `number` - ID of the user to assign the task to + - _userId:_ `string` - ID of the user to assign the task to - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../lib/process-services/task-list/models/task-details.model.ts)`>` - Details of the assigned task - **attachFormToATask**(taskId: `string`, formId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Attaches a form to a task. @@ -226,7 +226,7 @@ limited the found set to five items. ```ts import { TaskListService, TaskDetailsModel, TaskQueryRequestRepresentationModel, TaskListModel, Form } from '@alfresco/adf-process-services'; -import { TaskUpdateRepresentation } from 'alfresco-js-api'; +import { TaskUpdateRepresentation } from '@alfresco/js-api'; export class SomePageComponent implements OnInit { diff --git a/docs/tutorials/working-with-nodes-api-service.md b/docs/tutorials/working-with-nodes-api-service.md index 082a2ee017..18e3d5e55b 100644 --- a/docs/tutorials/working-with-nodes-api-service.md +++ b/docs/tutorials/working-with-nodes-api-service.md @@ -5,15 +5,17 @@ Level: Intermediate # Working with the Nodes API Service -In this tutorial you will learn how to use the [`NodesApiService`](../core/nodes-api.service.md). We have developed some practical examples to show you how to interact with an instance of Alfresco Content Services without using the REST endpoints directly. With this approach the [`NodesApiService`](../core/nodes-api.service.md) is used as an abstraction layer, defined by one of the services in the ADF Core library. +In this tutorial you will learn how to use the [`NodesApiService`](../core/nodes-api.service.md). + +We have developed some practical examples to show you how to interact with an instance of Alfresco Content Services without using the REST endpoints directly. With this approach the [`NodesApiService`](../core/nodes-api.service.md) is used as an abstraction layer, defined by one of the services in the ADF Core library. ## Contents - [Preparing the development environment](#preparing-the-development-environment) - [Basic examples of usage](#basic-examples-of-usage) -- [About the ](#about-the-nodesapiservice) +- [About the NodesApiService](#about-the-nodesapiservice) - [Observables](#observables) - - [MinimalNodeEntryEntity](#minimalnodeentryentity) + - [MinimalNode](#minimalnode) - [NodePaging](#nodepaging) - [Retrieving info and metadata from a node](#retrieving-info-and-metadata-from-a-node) - [Retrieving the node's children](#retrieving-the-nodes-children) @@ -71,9 +73,7 @@ property that represents the [`NodesApiService`](../core/nodes-api.service.md) i ## About the NodesApiService -Before going further, let's introduce the [`NodesApiService`](../core/nodes-api.service.md) class. For further details about the -implementation, see the -[component catalog page](https://alfresco.github.io/adf-component-catalog/injectables/NodesApiService.html). +Before going further, let's introduce the [`NodesApiService`](../core/nodes-api.service.md) class. As you can see, the available methods are easy to understand and they should be all you need to manage the nodes of your content repository. @@ -94,10 +94,10 @@ this.nodesApi.getNode(nodeId).subscribe( ); ``` -### MinimalNodeEntryEntity +### MinimalNode -All the methods that manage content nodes return an [`Observable`](http://reactivex.io/documentation/observable.html) of the [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) -class. [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) is used to represent the node's content. See the +All the methods that manage content nodes return an [`Observable`](http://reactivex.io/documentation/observable.html) of the [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) +class. [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) is used to represent the node's content. See the [official documentation](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) for further details. diff --git a/tools/doc/doctool.config.json b/tools/doc/doctool.config.json index 0067f9caf0..904f0a427f 100644 --- a/tools/doc/doctool.config.json +++ b/tools/doc/doctool.config.json @@ -42,8 +42,11 @@ "DeletedNodesPaging": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md", "DownloadBodyCreate": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadBodyCreate.md", "DownloadEntry": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadEntry.md", + "GroupMemberPaging": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/GroupMemberPaging.md", + "MinimalNode": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md", "MinimalNodeEntity": "../content-services/document-library.model.md", "MinimalNodeEntryEntity": "../content-services/document-library.model.md", + "Node": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md", "NodeEntry": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md", "ProcessInstanceFilterRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md", "RelatedContentRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md",