From 7b3f400c48dde534957ae903fc8dee45333edc5d Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Wed, 14 Nov 2018 14:23:14 +0000 Subject: [PATCH] [ADF-3745] Updates for doc review (#3965) --- docs/README.md | 5 ++- docs/content-services/README.md | 1 + .../add-permission-dialog.component.md | 10 +++-- ...ive.md => content-node-share.directive.md} | 0 .../document-actions.service.md | 2 +- .../folder-actions.service.md | 2 +- docs/content-services/tag.service.md | 12 +++--- docs/core/README.md | 2 +- docs/core/auth-guard-bpm.service.md | 2 +- docs/core/auth-guard-ecm.service.md | 2 +- docs/core/auth-guard.service.md | 2 +- docs/core/content.service.md | 8 ++-- docs/core/cookie.service.md | 4 +- docs/core/highlight-transform.service.md | 1 + docs/core/infinite-pagination.component.md | 2 +- docs/core/login.component.md | 6 +-- docs/core/node-favorite.directive.md | 6 +-- docs/core/node-restore.directive.md | 2 +- docs/core/nodes-api.service.md | 22 +++++------ docs/core/sites.service.md | 6 +-- docs/core/thumbnail.service.md | 4 +- docs/core/upload.service.md | 12 ++++-- docs/core/viewer.component.md | 2 +- .../process-filter.service.md | 6 +-- .../start-process.component.md | 38 +++++++++---------- docs/process-services/start-task.component.md | 3 +- .../task-details.component.md | 2 +- .../process-services/task-header.component.md | 2 +- .../directives/node-favorite.directive.ts | 2 +- .../components/start-process.component.ts | 4 +- tools/doc/doctool.config.json | 8 +++- 31 files changed, 95 insertions(+), 85 deletions(-) rename docs/content-services/{node-share.directive.md => content-node-share.directive.md} (100%) diff --git a/docs/README.md b/docs/README.md index 8efdb4ba50..adda78ba27 100644 --- a/docs/README.md +++ b/docs/README.md @@ -83,7 +83,7 @@ for more information about installing and using the source code. | [Sidenav layout component](core/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) | | [Login dialog panel component](core/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/login/components/login-dialog-panel.component.ts) | | [Login dialog component](core/login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../lib/core/login/components/login-dialog.component.ts) | -| [Login component](core/login.component.md) | Authenticates to Alfresco Content Services and or Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | +| [Login component](core/login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | | [Infinite pagination component](core/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | | [Pagination component](core/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | | [Host settings component](core/host-settings.component.md) ![Internal](docassets/images/InternalIcon.png) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | @@ -249,6 +249,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 download directive](content-services/node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../lib/content-services/directives/node-download.directive.ts) | | [Node lock directive](content-services/node-lock.directive.md) | Locks 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) | @@ -319,7 +320,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 we 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 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) | diff --git a/docs/content-services/README.md b/docs/content-services/README.md index 98c7846e5a..9d526cd8d1 100644 --- a/docs/content-services/README.md +++ b/docs/content-services/README.md @@ -53,6 +53,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 download directive](node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../../lib/content-services/directives/node-download.directive.ts) | | [Node lock directive](node-lock.directive.md) | Locks 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) | diff --git a/docs/content-services/add-permission-dialog.component.md b/docs/content-services/add-permission-dialog.component.md index 9dde52e0f9..38db42bda3 100644 --- a/docs/content-services/add-permission-dialog.component.md +++ b/docs/content-services/add-permission-dialog.component.md @@ -1,7 +1,7 @@ --- Added: v2.4.0 Status: Active -Last reviewed: 2018-05-03 +Last reviewed: 2018-11-13 --- # Add Permission Dialog Component @@ -30,9 +30,11 @@ import { NodePermissionDialogService } from '@alfresco/adf-content-services'; This component extends the [Add permission panel component](../content-services/add-permission-panel.component.md) to apply the chosen selection of permissions when they are accepted. -You can open the dialog with the [Node Permission Dialog Service](../content-services/node-permission-dialog.service.md). This returns Observables that -you can subscribe to for get the details of the node after the update. -Use the `updateNodePermissionByDialog` from the service to update node permissions, as shown in +You can open the dialog with the `openAddPermissionDialog` method from the +[Node Permission Dialog Service](../content-services/node-permission-dialog.service.md). +This returns an [`Observable`](http://reactivex.io/documentation/observable.html) +that you can subscribe to so you can get the details of the node after the update. +Use the `updateNodePermissionByDialog` nethod from the service to update node permissions, as shown in the following example: ```ts diff --git a/docs/content-services/node-share.directive.md b/docs/content-services/content-node-share.directive.md similarity index 100% rename from docs/content-services/node-share.directive.md rename to docs/content-services/content-node-share.directive.md diff --git a/docs/content-services/document-actions.service.md b/docs/content-services/document-actions.service.md index b98b64d9fe..615ab1da56 100644 --- a/docs/content-services/document-actions.service.md +++ b/docs/content-services/document-actions.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-29 +Last reviewed: 2018-11-13 --- # Document Actions service diff --git a/docs/content-services/folder-actions.service.md b/docs/content-services/folder-actions.service.md index 57a6904e4d..2e89fbfc9d 100644 --- a/docs/content-services/folder-actions.service.md +++ b/docs/content-services/folder-actions.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-05 +Last reviewed: 2018-11-13 --- # Folder Actions service diff --git a/docs/content-services/tag.service.md b/docs/content-services/tag.service.md index 2e090c9254..d1f55bd0d7 100644 --- a/docs/content-services/tag.service.md +++ b/docs/content-services/tag.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-05 +Last reviewed: 2018-11-13 --- # Tag service @@ -16,15 +16,15 @@ Manages tags in Content Services. Adds a tag to a node. - _nodeId:_ `string` - ID of the target node - _tagName:_ `string` - Name of the tag to add - - **Returns** `any` - TagEntry object (defined in JSAPI) with details of the new tag -- **getAllTheTags**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** `any` - [TagEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md) object (defined in JS-API) with details of the new tag +- **getAllTheTags**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`
Gets a list of all the tags already defined in the repository. - - _opts:_ `any` - (Optional) Options supported by JSAPI - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - TagPaging object (defined in JSAPI) containing the tags + - _opts:_ `any` - (Optional) Options supported by JS-API + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags - **getTagsByNodeId**(nodeId: `string`): `any`
Gets a list of tags added to a node. - _nodeId:_ `string` - ID of the target node - - **Returns** `any` - TagPaging object (defined in JSAPI) containing the tags + - **Returns** `any` - [TagPaging](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md) object (defined in JS-API) containing the tags - **removeTag**(nodeId: `string`, tag: `string`): `any`
Removes a tag from a node. - _nodeId:_ `string` - ID of the target node diff --git a/docs/core/README.md b/docs/core/README.md index 2e49e8882a..f3fdb0314d 100644 --- a/docs/core/README.md +++ b/docs/core/README.md @@ -34,7 +34,7 @@ for more information about installing and using the source code. | [Sidenav layout component](sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) | | [Login dialog panel component](login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../../lib/core/login/components/login-dialog-panel.component.ts) | | [Login dialog component](login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../../lib/core/login/components/login-dialog.component.ts) | -| [Login component](login.component.md) | Authenticates to Alfresco Content Services and or Alfresco Process Services. | [Source](../../lib/core/login/components/login.component.ts) | +| [Login component](login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../../lib/core/login/components/login.component.ts) | | [Infinite pagination component](infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../../lib/core/pagination/infinite-pagination.component.ts) | | [Pagination component](pagination.component.md) | Adds pagination to the component it is used with. | [Source](../../lib/core/pagination/pagination.component.ts) | | [Host settings component](host-settings.component.md) ![Internal](../docassets/images/InternalIcon.png) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../../lib/core/settings/host-settings.component.ts) | diff --git a/docs/core/auth-guard-bpm.service.md b/docs/core/auth-guard-bpm.service.md index 9e6df37346..431c8ff696 100644 --- a/docs/core/auth-guard-bpm.service.md +++ b/docs/core/auth-guard-bpm.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-08 +Last reviewed: 2018-11-13 --- # Auth Guard Bpm service diff --git a/docs/core/auth-guard-ecm.service.md b/docs/core/auth-guard-ecm.service.md index ca8be2ccdc..56f183e13d 100644 --- a/docs/core/auth-guard-ecm.service.md +++ b/docs/core/auth-guard-ecm.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-08 +Last reviewed: 2018-11-13 --- # Auth Guard Ecm service diff --git a/docs/core/auth-guard.service.md b/docs/core/auth-guard.service.md index 48df6f3be3..ab3088f627 100644 --- a/docs/core/auth-guard.service.md +++ b/docs/core/auth-guard.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-05-08 +Last reviewed: 2018-11-13 --- # Auth Guard service diff --git a/docs/core/content.service.md b/docs/core/content.service.md index 8a061a0d21..c8e7fec60d 100644 --- a/docs/core/content.service.md +++ b/docs/core/content.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-13 +Last reviewed: 2018-11-13 --- # Content service @@ -12,12 +12,12 @@ Accesses app-generated data objects via URLs and file downloads. ### Methods -- **createFolder**(relativePath: `string`, name: `string`, parentId?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **createFolder**(relativePath: `string`, name: `string`, parentId?: `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)`>`
Creates a folder. - _relativePath:_ `string` - Location to create the folder - _name:_ `string` - Folder name - _parentId:_ `string` - (Optional) Node ID of parent folder - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Information about the new folder + - **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)`>` - Information about the new folder - **createTrustedUrl**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)): `string`
Creates a trusted object URL from the [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob). WARNING: calling this method with untrusted user data exposes your application to XSS security risks! - _blob:_ [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) - Data to wrap into object URL @@ -49,7 +49,7 @@ Accesses app-generated data objects via URLs and file downloads. - **getNode**(nodeId: `string`, opts?: `any`): [`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)`>`
Gets a Node via its node ID. - _nodeId:_ `string` - ID of the target node - - _opts:_ `any` - (Optional) Options supported by JSAPI + - _opts:_ `any` - (Optional) Options supported by JS-API - **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)`>` - Details of the folder - **getNodeContent**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets content for the given node. diff --git a/docs/core/cookie.service.md b/docs/core/cookie.service.md index 2ad9511047..f6e8d50297 100644 --- a/docs/core/cookie.service.md +++ b/docs/core/cookie.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-29 +Last reviewed: 2018-11-13 --- # Cookie service @@ -13,7 +13,7 @@ Stores key-value data items as browser cookies. ### Methods - **clear**()
- + Placeholder for testing purposes - do not use. - **getItem**(key: `string`): `string|null`
Retrieves a cookie by its key. - _key:_ `string` - Key to identify the cookie diff --git a/docs/core/highlight-transform.service.md b/docs/core/highlight-transform.service.md index c14f7d33ea..88e58330e3 100644 --- a/docs/core/highlight-transform.service.md +++ b/docs/core/highlight-transform.service.md @@ -1,6 +1,7 @@ --- Added: v2.0.0 Status: Active +Last reviewed: 2018-11-13 --- # Highlight Transform service diff --git a/docs/core/infinite-pagination.component.md b/docs/core/infinite-pagination.component.md index d769469ee1..711072df23 100644 --- a/docs/core/infinite-pagination.component.md +++ b/docs/core/infinite-pagination.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-06 +Last reviewed: 2018-11-13 --- # Infinite Pagination component diff --git a/docs/core/login.component.md b/docs/core/login.component.md index dc482b5883..ffc84bffdf 100644 --- a/docs/core/login.component.md +++ b/docs/core/login.component.md @@ -1,12 +1,12 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-09-13 +Last reviewed: 2018-11-13 --- # Login component -Authenticates to Alfresco Content Services and or Alfresco Process Services. +Authenticates to Alfresco Content Services and Alfresco Process Services. ![Login component](../docassets/images/login-extra-content.png) @@ -291,7 +291,7 @@ enabled the setting in `app.config.json`) then the [login component](../core/log ![Login component](../docassets/images/sso-login.png) -Note that if the `silentLogin property` in the `oauth2` configuration is set to true +Note that if the `silentLogin` property in the `oauth2` configuration is set to true then the login page will not be shown. Instead, the application will redirect automatically to the authorization server when the user is not logged-in diff --git a/docs/core/node-favorite.directive.md b/docs/core/node-favorite.directive.md index ffe1d579d1..8501eadce0 100644 --- a/docs/core/node-favorite.directive.md +++ b/docs/core/node-favorite.directive.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-13 --- # Node Favorite directive @@ -48,7 +48,7 @@ export class MyComponent { | Name | Type | Description | | ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting has fail. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting fails. | | toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting is complete. | ## Details @@ -75,7 +75,7 @@ which also lets you add extra styling to the element: The directive behaves as follows: - If there are no favorite nodes in the selection, then all are marked as favorites -- If there are one or more favorite node in the selection, then only those that are not +- If there are one or more favorite nodes in the selection, then only those that are not favorites are marked - If all nodes in the selection are favorites, then they all have their favorite status removed diff --git a/docs/core/node-restore.directive.md b/docs/core/node-restore.directive.md index 1750fb170e..ae7f702ba5 100644 --- a/docs/core/node-restore.directive.md +++ b/docs/core/node-restore.directive.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-10 +Last reviewed: 2018-11-13 --- # Node Restore directive diff --git a/docs/core/nodes-api.service.md b/docs/core/nodes-api.service.md index 386761f584..120a9175c4 100644 --- a/docs/core/nodes-api.service.md +++ b/docs/core/nodes-api.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-06 +Last reviewed: 2018-11-13 --- # Nodes Api service @@ -27,33 +27,29 @@ Accesses and manipulates ACS document nodes using their node IDs. 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 JSAPI + - _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)`>`
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 JSAPI + - _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 -- **deleteNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **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 JSAPI - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty result that notifies when the deletion is complete + - _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)`>`
Gets the stored information about a node. - _nodeId:_ `string` - ID of the target node - - _options:_ `any` - Optional parameters supported by JSAPI + - _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 - **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 JSAPI + - _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 -- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Reports an error. - - _error:_ `any` - Object representing the error - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Error information - **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
Restores a node previously moved to the trashcan. - _nodeId:_ `string` - ID of the node to restore @@ -62,7 +58,7 @@ Accesses and manipulates ACS document nodes using their node IDs. 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 JSAPI + - _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 ## Details diff --git a/docs/core/sites.service.md b/docs/core/sites.service.md index 5c3685aa77..0d3f090e07 100644 --- a/docs/core/sites.service.md +++ b/docs/core/sites.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-21 +Last reviewed: 2018-11-13 --- # Sites service @@ -23,7 +23,7 @@ Accesses and manipulates sites from a Content Services repository. - **getSite**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`
Gets the details for a site. - _siteId:_ `string` - ID of the target site - - _opts:_ `any` - (Optional) Options supported by JSAPI + - _opts:_ `any` - (Optional) Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` - Information about the site - **getSiteContent**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`
Gets a site's content. @@ -35,7 +35,7 @@ Accesses and manipulates sites from a Content Services repository. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` - Site members - **getSites**(opts: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>`
Gets a list of all sites in the repository. - - _opts:_ `any` - Options supported by JSAPI + - _opts:_ `any` - Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>` - List of sites ## Details diff --git a/docs/core/thumbnail.service.md b/docs/core/thumbnail.service.md index 2a03aa27ef..913037006f 100644 --- a/docs/core/thumbnail.service.md +++ b/docs/core/thumbnail.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-21 +Last reviewed: 2018-11-13 --- # Thumbnail service @@ -49,7 +49,7 @@ and icons is shown in the table below: ### Mat-icon -All the ADF icons for MIME types are now registered into the MatIconRegistry, so you can use all +All the ADF icons for MIME types are now registered into the [`MatIconRegistry`](https://material.angular.io/components/icon/api), so you can use all the icons via the <mat-icon> tag: ```javascript diff --git a/docs/core/upload.service.md b/docs/core/upload.service.md index 24edcd7627..64e65a671d 100644 --- a/docs/core/upload.service.md +++ b/docs/core/upload.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-05 +Last reviewed: 2018-11-12 --- # Upload Service @@ -61,9 +61,13 @@ The configuration of this service is saved in the `app.config.json` file The example below shows how to filter out the : '.git', '.DS_Store' and 'desktop.ini' files. Each element of the ignore list is a glob pattern string, so you could exclude all the `.txt` files, for example, by adding a `*.txt` pattern to the list. -There is also the possibility to add some more option to how perform the check via the `match-options` parameter. -For example in this case we have added the ignore case so `*.TXT` will match all the txt files ignoring the case for the extension. -For more information about the options available please check [minimatch](https://www.npmjs.com/package/minimatch#options) documentation. +You can also specify some more options about how to perform the check via the `match-options` parameter. + +In the example below, we have added the `nocase` option (ie, ignore case when performing the +glob match), so `*.TXT` will also match `.txt`, etc. +For more information about the options available please check the documentation for the +[minimatch](https://www.npmjs.com/package/minimatch#options) +node module. **app.config.json** diff --git a/docs/core/viewer.component.md b/docs/core/viewer.component.md index 9b1688a5b1..3ba6ea258d 100644 --- a/docs/core/viewer.component.md +++ b/docs/core/viewer.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-09-14 +Last reviewed: 2018-11-13 --- # Viewer component diff --git a/docs/process-services/process-filter.service.md b/docs/process-services/process-filter.service.md index c7946926f5..e0680f1e88 100644 --- a/docs/process-services/process-filter.service.md +++ b/docs/process-services/process-filter.service.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-21 +Last reviewed: 2018-11-13 --- # Process Filter Service @@ -16,10 +16,10 @@ Manage Process Filters, which are pre-configured Process Instance queries. Adds a filter. - _filter:_ [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - The filter to add - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>` - The filter just added -- **callApiProcessFilters**(appId?: `number`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
+- **callApiProcessFilters**(appId?: `number`): `any`
Calls `getUserProcessInstanceFilters` from the Alfresco JS API. - _appId:_ `number` - (Optional) ID of the target app - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - List of filter details + - **Returns** `any` - List of filter details - **createDefaultFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`
Creates and returns the default filters for an app. - _appId:_ `number` - ID of the target app diff --git a/docs/process-services/start-process.component.md b/docs/process-services/start-process.component.md index c85526587e..37a01e3b28 100644 --- a/docs/process-services/start-process.component.md +++ b/docs/process-services/start-process.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-13 +Last reviewed: 2018-11-13 --- # Start Process component @@ -35,23 +35,23 @@ Starts a process. ### Properties -| Name | Type | Description | -| ---- | ---- | ----------- | -| appId | `number` | (optional): Limit the list of processes which can be started to those contained in the specified app | -| name | `string` | (optional) name to assign to the current process | -| processDefinitionName | `string` | (optional) definition name of the process to start | -| processFilterSelector | `boolean` | (optional) Enables automatic selection of process when typing dowm in process field, true by default | -| variables | [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md) | -| values | [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) | Parameter to pass form field values in the start form if is associated | -| showSelectProcessDropdown | `boolean` | hide or show the process selection drodown, true by default | +| Name | Type | Default value | Description | +| ---- | ---- | ------------- | ----------- | +| appId | `number` | | (optional) Limit the list of processes that can be started to those contained in the specified app. | +| name | `string` | "" | (optional) Name to assign to the current process. | +| processDefinitionName | `string` | | (optional) Definition name of the process to start. | +| 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. | +| 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 | Name | Type | Description | | ---- | ---- | ----------- | -| start | [`EventEmitter`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the process starts | -| cancel | [`EventEmitter`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the process is canceled | -| error | [`EventEmitter`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the start process operation fails | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` | Emitted when the process is canceled. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` | Emitted when an error occurs. | +| start | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` | Emitted when the process starts. | ## Details @@ -112,13 +112,13 @@ to _alfresco-1002_ as follows: ```json { - application: { - name: 'Alfresco ADF Application' + "application": { + "name": "Alfresco ADF Application" }, - ecmHost: 'http://{hostname}{:port}/ecm', - bpmHost: 'http://{hostname}{:port}/bpm', - logLevel: 'silent', - alfrescoRepositoryName : 'alfresco-1002' + "ecmHost": "http://{hostname}{:port}/ecm", + "bpmHost": "http://{hostname}{:port}/bpm", + "logLevel": "silent", + "alfrescoRepositoryName": "alfresco-1002" } ``` diff --git a/docs/process-services/start-task.component.md b/docs/process-services/start-task.component.md index f37b154000..2fc507adce 100644 --- a/docs/process-services/start-task.component.md +++ b/docs/process-services/start-task.component.md @@ -1,11 +1,12 @@ --- Added: v2.0.0 Status: Active +Last reviewed: 2018-11-13 --- # Start Task Component -Creates/Starts new task for the specified app +Creates/Starts a new task for the specified app ![adf-start-task](../docassets/images/adf-start-task.png) diff --git a/docs/process-services/task-details.component.md b/docs/process-services/task-details.component.md index e01f4b6fbd..89e0f7c2d7 100644 --- a/docs/process-services/task-details.component.md +++ b/docs/process-services/task-details.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-04-16 +Last reviewed: 2018-11-13 --- # Task Details component diff --git a/docs/process-services/task-header.component.md b/docs/process-services/task-header.component.md index 9659ecf72f..fe49337fd8 100644 --- a/docs/process-services/task-header.component.md +++ b/docs/process-services/task-header.component.md @@ -1,7 +1,7 @@ --- Added: v2.0.0 Status: Active -Last reviewed: 2018-03-21 +Last reviewed: 2018-11-13 --- # Task Header component diff --git a/lib/core/directives/node-favorite.directive.ts b/lib/core/directives/node-favorite.directive.ts index 7e50d1f207..97f7330296 100644 --- a/lib/core/directives/node-favorite.directive.ts +++ b/lib/core/directives/node-favorite.directive.ts @@ -37,7 +37,7 @@ export class NodeFavoriteDirective implements OnChanges { /** Emitted when the favorite setting is complete. */ @Output() toggle: EventEmitter = new EventEmitter(); - /** Emitted when the favorite setting has fail. */ + /** Emitted when the favorite setting fails. */ @Output() error: EventEmitter = new EventEmitter(); @HostListener('click') diff --git a/lib/process-services/process-list/components/start-process.component.ts b/lib/process-services/process-list/components/start-process.component.ts index 2a790cb18e..2ecc16d325 100644 --- a/lib/process-services/process-list/components/start-process.component.ts +++ b/lib/process-services/process-list/components/start-process.component.ts @@ -51,13 +51,13 @@ export class StartProcessInstanceComponent implements OnChanges, OnInit { @Input() processDefinitionName: string; - /** Variables in input to the process + /** 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). */ @Input() variables: ProcessInstanceVariable[]; - /** Parameter to pass form field values in the start form if it is associated. */ + /** Parameter to pass form field values in the start form if one is associated. */ @Input() values: FormValues; diff --git a/tools/doc/doctool.config.json b/tools/doc/doctool.config.json index f16d295859..19a17005ee 100644 --- a/tools/doc/doctool.config.json +++ b/tools/doc/doctool.config.json @@ -31,6 +31,7 @@ "Blob": "https://developer.mozilla.org/en-US/docs/Web/API/Blob", "Promise": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises", "EventEmitter": "https://angular.io/api/core/EventEmitter", + "MatIconRegistry": "https://material.angular.io/components/icon/api", "MatSnackBarRef": "https://material.angular.io/components/snack-bar/overview", "TemplateRef": "https://angular.io/api/core/TemplateRef", "Observable": "http://reactivex.io/documentation/observable.html", @@ -42,7 +43,9 @@ "NodeEntry": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md", "RelatedContentRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md", "SiteEntry": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md", - "SitePaging": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md" + "SitePaging": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md", + "TagEntry": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md", + "TagPaging": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md" }, "typeNameExceptions": { "datatable.component": "DataTableComponent", @@ -53,7 +56,8 @@ "process-list.component": "ProcessInstanceListComponent", "inherited-button.directive": "InheritPermissionDirective", "node-share.directive": "NodeSharedDirective", - "sites-dropdown.component": "DropdownSitesComponent" + "sites-dropdown.component": "DropdownSitesComponent", + "start-process.component": "StartProcessInstanceComponent" }, "undocStoplist": [ "model",