mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3745] Updates for doc review (#3965)
This commit is contained in:
committed by
Eugenio Romano
parent
867ca8c39d
commit
7b3f400c48
@@ -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) |
|
| [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 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 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) |
|
| [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) |
|
| [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)  | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) |
|
| [Host settings component](core/host-settings.component.md)  | 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 |
|
| 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 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) |
|
| [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) |
|
| [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) |
|
| [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) |
|
| [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) |
|
| [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 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 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) |
|
| [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) |
|
||||||
|
@@ -53,6 +53,7 @@ for more information about installing and using the source code.
|
|||||||
|
|
||||||
| Name | Description | Source link |
|
| 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 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) |
|
| [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) |
|
| [Folder create directive](folder-create.directive.md) | Creates folders. | [Source](../../lib/content-services/folder-directive/folder-create.directive.ts) |
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.4.0
|
Added: v2.4.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-05-03
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Add Permission Dialog Component
|
# 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)
|
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.
|
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 open the dialog with the `openAddPermissionDialog` method from the
|
||||||
you can subscribe to for get the details of the node after the update.
|
[Node Permission Dialog Service](../content-services/node-permission-dialog.service.md).
|
||||||
Use the `updateNodePermissionByDialog` from the service to update node permissions, as shown in
|
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:
|
the following example:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-03-29
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Document Actions service
|
# Document Actions service
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-04-05
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Folder Actions service
|
# Folder Actions service
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-04-05
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Tag service
|
# Tag service
|
||||||
@@ -16,15 +16,15 @@ Manages tags in Content Services.
|
|||||||
Adds a tag to a node.
|
Adds a tag to a node.
|
||||||
- _nodeId:_ `string` - ID of the target node
|
- _nodeId:_ `string` - ID of the target node
|
||||||
- _tagName:_ `string` - Name of the tag to add
|
- _tagName:_ `string` - Name of the tag to add
|
||||||
- **Returns** `any` - TagEntry object (defined in JSAPI) with details of the new tag
|
- **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>`<br/>
|
- **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)`>`<br/>
|
||||||
Gets a list of all the tags already defined in the repository.
|
Gets a list of all the tags already defined in the repository.
|
||||||
- _opts:_ `any` - (Optional) Options supported by JSAPI
|
- _opts:_ `any` - (Optional) Options supported by JS-API
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<TagPaging>` - TagPaging object (defined in JSAPI) containing the tags
|
- **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`<br/>
|
- **getTagsByNodeId**(nodeId: `string`): `any`<br/>
|
||||||
Gets a list of tags added to a node.
|
Gets a list of tags added to a node.
|
||||||
- _nodeId:_ `string` - ID of the target 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`<br/>
|
- **removeTag**(nodeId: `string`, tag: `string`): `any`<br/>
|
||||||
Removes a tag from a node.
|
Removes a tag from a node.
|
||||||
- _nodeId:_ `string` - ID of the target node
|
- _nodeId:_ `string` - ID of the target node
|
||||||
|
@@ -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) |
|
| [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 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 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) |
|
| [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) |
|
| [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)  | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../../lib/core/settings/host-settings.component.ts) |
|
| [Host settings component](host-settings.component.md)  | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../../lib/core/settings/host-settings.component.ts) |
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-05-08
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Auth Guard Bpm service
|
# Auth Guard Bpm service
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-05-08
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Auth Guard Ecm service
|
# Auth Guard Ecm service
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-05-08
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Auth Guard service
|
# Auth Guard service
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-04-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Content service
|
# Content service
|
||||||
@@ -12,12 +12,12 @@ Accesses app-generated data objects via URLs and file downloads.
|
|||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
|
|
||||||
- **createFolder**(relativePath: `string`, name: `string`, parentId?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<FolderCreatedEvent>`<br/>
|
- **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)`>`<br/>
|
||||||
Creates a folder.
|
Creates a folder.
|
||||||
- _relativePath:_ `string` - Location to create the folder
|
- _relativePath:_ `string` - Location to create the folder
|
||||||
- _name:_ `string` - Folder name
|
- _name:_ `string` - Folder name
|
||||||
- _parentId:_ `string` - (Optional) Node ID of parent folder
|
- _parentId:_ `string` - (Optional) Node ID of parent folder
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<FolderCreatedEvent>` - 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`<br/>
|
- **createTrustedUrl**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)): `string`<br/>
|
||||||
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!
|
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
|
- _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)`>`<br/>
|
- **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)`>`<br/>
|
||||||
Gets a Node via its node ID.
|
Gets a Node via its node ID.
|
||||||
- _nodeId:_ `string` - ID of the target node
|
- _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
|
- **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)`<any>`<br/>
|
- **getNodeContent**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||||
Gets content for the given node.
|
Gets content for the given node.
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-03-29
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Cookie service
|
# Cookie service
|
||||||
@@ -13,7 +13,7 @@ Stores key-value data items as browser cookies.
|
|||||||
### Methods
|
### Methods
|
||||||
|
|
||||||
- **clear**()<br/>
|
- **clear**()<br/>
|
||||||
|
Placeholder for testing purposes - do not use.
|
||||||
- **getItem**(key: `string`): `string|null`<br/>
|
- **getItem**(key: `string`): `string|null`<br/>
|
||||||
Retrieves a cookie by its key.
|
Retrieves a cookie by its key.
|
||||||
- _key:_ `string` - Key to identify the cookie
|
- _key:_ `string` - Key to identify the cookie
|
||||||
|
@@ -1,6 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Highlight Transform service
|
# Highlight Transform service
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-04-06
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Infinite Pagination component
|
# Infinite Pagination component
|
||||||
|
@@ -1,12 +1,12 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-09-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Login component
|
# Login component
|
||||||
|
|
||||||
Authenticates to Alfresco Content Services and or Alfresco Process Services.
|
Authenticates to Alfresco Content Services and Alfresco Process Services.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -291,7 +291,7 @@ enabled the setting in `app.config.json`) then the [login component](../core/log
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
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
|
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
|
automatically to the authorization server when the user is not logged-in
|
||||||
|
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-04-10
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Node Favorite directive
|
# Node Favorite directive
|
||||||
@@ -48,7 +48,7 @@ export class MyComponent {
|
|||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| ---- | ---- | ----------- |
|
| ---- | ---- | ----------- |
|
||||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting has fail. |
|
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting fails. |
|
||||||
| toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting is complete. |
|
| toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting is complete. |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
@@ -75,7 +75,7 @@ which also lets you add extra styling to the element:
|
|||||||
The directive behaves as follows:
|
The directive behaves as follows:
|
||||||
|
|
||||||
- If there are no favorite nodes in the selection, then all are marked as favorites
|
- 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
|
favorites are marked
|
||||||
- If all nodes in the selection are favorites, then they all have their favorite status removed
|
- If all nodes in the selection are favorites, then they all have their favorite status removed
|
||||||
|
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-04-10
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Node Restore directive
|
# Node Restore directive
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-04-06
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Nodes Api service
|
# 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.
|
Creates a new folder node inside a parent folder.
|
||||||
- _parentNodeId:_ `string` - ID of the parent folder node
|
- _parentNodeId:_ `string` - ID of the parent folder node
|
||||||
- _nodeBody:_ `any` - Data for the new folder
|
- _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
|
- **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)`>`<br/>
|
- **createNode**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
|
||||||
Creates a new document node inside a folder.
|
Creates a new document node inside a folder.
|
||||||
- _parentNodeId:_ `string` - ID of the parent folder node
|
- _parentNodeId:_ `string` - ID of the parent folder node
|
||||||
- _nodeBody:_ `any` - Data for the new 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
|
- **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)`<void>`<br/>
|
- **deleteNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||||
Moves a node to the trashcan.
|
Moves a node to the trashcan.
|
||||||
- _nodeId:_ `string` - ID of the target 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)`<void>` - Empty result that notifies when the deletion is complete
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
|
- **getNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
|
||||||
Gets the stored information about a node.
|
Gets the stored information about a node.
|
||||||
- _nodeId:_ `string` - ID of the target 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
|
- **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)`>`<br/>
|
- **getNodeChildren**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
|
||||||
Gets the items contained in a folder node.
|
Gets the items contained in a folder node.
|
||||||
- _nodeId:_ `string` - ID of the target 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
|
- **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)`<any>`<br/>
|
|
||||||
Reports an error.
|
|
||||||
- _error:_ `any` - Object representing the error
|
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Error information
|
|
||||||
- **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
|
- **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
|
||||||
Restores a node previously moved to the trashcan.
|
Restores a node previously moved to the trashcan.
|
||||||
- _nodeId:_ `string` - ID of the node to restore
|
- _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.
|
Updates the information about a node.
|
||||||
- _nodeId:_ `string` - ID of the target node
|
- _nodeId:_ `string` - ID of the target node
|
||||||
- _nodeBody:_ `any` - New data for the 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
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Updated node information
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-03-21
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Sites service
|
# 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)`>`<br/>
|
- **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)`>`<br/>
|
||||||
Gets the details for a site.
|
Gets the details for a site.
|
||||||
- _siteId:_ `string` - ID of the target 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
|
- **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)`>`<br/>
|
- **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)`>`<br/>
|
||||||
Gets a site's content.
|
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
|
- **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)`>`<br/>
|
- **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)`>`<br/>
|
||||||
Gets a list of all sites in the repository.
|
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
|
- **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
|
## Details
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-03-21
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Thumbnail service
|
# Thumbnail service
|
||||||
@@ -49,7 +49,7 @@ and icons is shown in the table below:
|
|||||||
|
|
||||||
### Mat-icon
|
### 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:
|
the icons via the <mat-icon> tag:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-04-05
|
Last reviewed: 2018-11-12
|
||||||
---
|
---
|
||||||
|
|
||||||
# Upload Service
|
# 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.
|
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`
|
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.
|
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.
|
You can also specify some more options about how to 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.
|
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**
|
**app.config.json**
|
||||||
|
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-09-14
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Viewer component
|
# Viewer component
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-03-21
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Process Filter Service
|
# Process Filter Service
|
||||||
@@ -16,10 +16,10 @@ Manage Process Filters, which are pre-configured Process Instance queries.
|
|||||||
Adds a filter.
|
Adds a filter.
|
||||||
- _filter:_ [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - The filter to add
|
- _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
|
- **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)`<any>`<br/>
|
- **callApiProcessFilters**(appId?: `number`): `any`<br/>
|
||||||
Calls `getUserProcessInstanceFilters` from the Alfresco JS API.
|
Calls `getUserProcessInstanceFilters` from the Alfresco JS API.
|
||||||
- _appId:_ `number` - (Optional) ID of the target app
|
- _appId:_ `number` - (Optional) ID of the target app
|
||||||
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>` - 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)`[]>`<br/>
|
- **createDefaultFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`<br/>
|
||||||
Creates and returns the default filters for an app.
|
Creates and returns the default filters for an app.
|
||||||
- _appId:_ `number` - ID of the target app
|
- _appId:_ `number` - ID of the target app
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-03-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Start Process component
|
# Start Process component
|
||||||
@@ -35,23 +35,23 @@ Starts a process.
|
|||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Default value | Description |
|
||||||
| ---- | ---- | ----------- |
|
| ---- | ---- | ------------- | ----------- |
|
||||||
| appId | `number` | (optional): Limit the list of processes which can be started to those contained in the specified app |
|
| 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 |
|
| name | `string` | "" | (optional) Name to assign to the current process. |
|
||||||
| processDefinitionName | `string` | (optional) definition name of the process to start |
|
| 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 |
|
| processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. |
|
||||||
| 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) |
|
| showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. |
|
||||||
| values | [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) | Parameter to pass form field values in the start form if is associated |
|
| values | `FormValues` | | Parameter to pass form field values in the start form if one is associated. |
|
||||||
| showSelectProcessDropdown | `boolean` | hide or show the process selection drodown, true by default |
|
| 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
|
### Events
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| ---- | ---- | ----------- |
|
| ---- | ---- | ----------- |
|
||||||
| start | [`EventEmitter<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the process starts |
|
| 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. |
|
||||||
| cancel | [`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. |
|
||||||
| error | [`EventEmitter<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the start process operation fails |
|
| 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
|
## Details
|
||||||
|
|
||||||
@@ -112,13 +112,13 @@ to _alfresco-1002_ as follows:
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
application: {
|
"application": {
|
||||||
name: 'Alfresco ADF Application'
|
"name": "Alfresco ADF Application"
|
||||||
},
|
},
|
||||||
ecmHost: 'http://{hostname}{:port}/ecm',
|
"ecmHost": "http://{hostname}{:port}/ecm",
|
||||||
bpmHost: 'http://{hostname}{:port}/bpm',
|
"bpmHost": "http://{hostname}{:port}/bpm",
|
||||||
logLevel: 'silent',
|
"logLevel": "silent",
|
||||||
alfrescoRepositoryName : 'alfresco-1002'
|
"alfrescoRepositoryName": "alfresco-1002"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@@ -1,11 +1,12 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Start Task Component
|
# Start Task Component
|
||||||
|
|
||||||
Creates/Starts new task for the specified app
|
Creates/Starts a new task for the specified app
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-04-16
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Task Details component
|
# Task Details component
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-03-21
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Task Header component
|
# Task Header component
|
||||||
|
@@ -37,7 +37,7 @@ export class NodeFavoriteDirective implements OnChanges {
|
|||||||
/** Emitted when the favorite setting is complete. */
|
/** Emitted when the favorite setting is complete. */
|
||||||
@Output() toggle: EventEmitter<any> = new EventEmitter();
|
@Output() toggle: EventEmitter<any> = new EventEmitter();
|
||||||
|
|
||||||
/** Emitted when the favorite setting has fail. */
|
/** Emitted when the favorite setting fails. */
|
||||||
@Output() error: EventEmitter<any> = new EventEmitter();
|
@Output() error: EventEmitter<any> = new EventEmitter();
|
||||||
|
|
||||||
@HostListener('click')
|
@HostListener('click')
|
||||||
|
@@ -51,13 +51,13 @@ export class StartProcessInstanceComponent implements OnChanges, OnInit {
|
|||||||
@Input()
|
@Input()
|
||||||
processDefinitionName: string;
|
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).
|
* [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md).
|
||||||
*/
|
*/
|
||||||
@Input()
|
@Input()
|
||||||
variables: ProcessInstanceVariable[];
|
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()
|
@Input()
|
||||||
values: FormValues;
|
values: FormValues;
|
||||||
|
|
||||||
|
@@ -31,6 +31,7 @@
|
|||||||
"Blob": "https://developer.mozilla.org/en-US/docs/Web/API/Blob",
|
"Blob": "https://developer.mozilla.org/en-US/docs/Web/API/Blob",
|
||||||
"Promise": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises",
|
"Promise": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises",
|
||||||
"EventEmitter": "https://angular.io/api/core/EventEmitter",
|
"EventEmitter": "https://angular.io/api/core/EventEmitter",
|
||||||
|
"MatIconRegistry": "https://material.angular.io/components/icon/api",
|
||||||
"MatSnackBarRef": "https://material.angular.io/components/snack-bar/overview",
|
"MatSnackBarRef": "https://material.angular.io/components/snack-bar/overview",
|
||||||
"TemplateRef": "https://angular.io/api/core/TemplateRef",
|
"TemplateRef": "https://angular.io/api/core/TemplateRef",
|
||||||
"Observable": "http://reactivex.io/documentation/observable.html",
|
"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",
|
"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",
|
"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",
|
"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": {
|
"typeNameExceptions": {
|
||||||
"datatable.component": "DataTableComponent",
|
"datatable.component": "DataTableComponent",
|
||||||
@@ -53,7 +56,8 @@
|
|||||||
"process-list.component": "ProcessInstanceListComponent",
|
"process-list.component": "ProcessInstanceListComponent",
|
||||||
"inherited-button.directive": "InheritPermissionDirective",
|
"inherited-button.directive": "InheritPermissionDirective",
|
||||||
"node-share.directive": "NodeSharedDirective",
|
"node-share.directive": "NodeSharedDirective",
|
||||||
"sites-dropdown.component": "DropdownSitesComponent"
|
"sites-dropdown.component": "DropdownSitesComponent",
|
||||||
|
"start-process.component": "StartProcessInstanceComponent"
|
||||||
},
|
},
|
||||||
"undocStoplist": [
|
"undocStoplist": [
|
||||||
"model",
|
"model",
|
||||||
|
Reference in New Issue
Block a user