diff --git a/docs/README.md b/docs/README.md index a16605e67b..5ff4e006d3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -311,6 +311,7 @@ for more information about installing and using the source code. | [Folder Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/src/lib/folder-directive/folder-create.directive.ts) | | [Folder Edit directive](content-services/directives/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/src/lib/folder-directive/folder-edit.directive.ts) | | [Inherit Permission directive](content-services/directives/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/inherited-button.directive.ts) | +| [Node Counter directive](content-services/directives/node-counter.directive.md) | Appends a counter to an element. | [Source](../lib/content-services/src/lib/directives/node-counter.directive.ts) | | [Node Lock directive](content-services/directives/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/src/lib/directives/node-lock.directive.ts) | | [Toggle Icon directive](content-services/directives/toggle-icon.directive.md) | Toggle icon on mouse or keyboard event for a selectable element. | [Source](../lib/content-services/src/lib/upload/directives/toggle-icon.directive.ts) | diff --git a/docs/content-services/components/breadcrumb.component.md b/docs/content-services/components/breadcrumb.component.md index dc26e2e3e6..7da0417bd4 100644 --- a/docs/content-services/components/breadcrumb.component.md +++ b/docs/content-services/components/breadcrumb.component.md @@ -37,7 +37,7 @@ Indicates the current position within a navigation hierarchy. | Name | Type | Description | | ---- | ---- | ----------- | -| navigate | `any` | Emitted when the user clicks on a breadcrumb. | +| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/components/content-action.component.md b/docs/content-services/components/content-action.component.md index be90cf2a67..b9b5d84e95 100644 --- a/docs/content-services/components/content-action.component.md +++ b/docs/content-services/components/content-action.component.md @@ -97,10 +97,10 @@ export class MyView { | Name | Type | Description | | ---- | ---- | ----------- | -| error | `any` | Emitted when an error occurs during the action. Applies to copy and move actions. | -| execute | `any` | Emitted when the user selects the action from the menu. | -| permissionEvent | `any` | Emitted when a permission error occurs | -| success | `any` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the action. Applies to copy and move actions. | +| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects the action from the menu. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission error occurs | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | ## Details diff --git a/docs/content-services/components/content-type-dialog.component.md b/docs/content-services/components/content-type-dialog.component.md index 050c64508f..a77cd6e5e5 100644 --- a/docs/content-services/components/content-type-dialog.component.md +++ b/docs/content-services/components/content-type-dialog.component.md @@ -43,7 +43,7 @@ The properties are described in the table below: | nodeType | `string` | "" | current prefixed name of the content type selected | If you don't want to manage the dialog yourself then it is easier to use the -methods of the Content Type [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) Service, which create +methods of the Content Type [`Property`](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) Service, which create the dialog for you. ### Usage example diff --git a/docs/content-services/components/dropdown-breadcrumb.component.md b/docs/content-services/components/dropdown-breadcrumb.component.md index 7b60579362..da575df666 100644 --- a/docs/content-services/components/dropdown-breadcrumb.component.md +++ b/docs/content-services/components/dropdown-breadcrumb.component.md @@ -38,7 +38,7 @@ Indicates the current position within a navigation hierarchy using a dropdown me | Name | Type | Description | | ---- | ---- | ----------- | -| navigate | `any` | Emitted when the user clicks on a breadcrumb. | +| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/components/like.component.md b/docs/content-services/components/like.component.md index 6ce30eb8ce..e38c9e14e1 100644 --- a/docs/content-services/components/like.component.md +++ b/docs/content-services/components/like.component.md @@ -29,7 +29,7 @@ Allows a user to add "likes" to an item. | Name | Type | Description | | ---- | ---- | ----------- | -| changeVote | `any` | Emitted when the "vote" gets changed. | +| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also diff --git a/docs/content-services/components/permission-list.component.md b/docs/content-services/components/permission-list.component.md index ca7c48db39..35e0839ec6 100644 --- a/docs/content-services/components/permission-list.component.md +++ b/docs/content-services/components/permission-list.component.md @@ -17,14 +17,13 @@ Shows node permissions as a table. ``` - ## Class members ### Properties | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| nodeId | `string` | "" | ID of the node whose permissions you want to show. | +| nodeId | `string` | | ID of the node whose permissions you want to show. | ### Events diff --git a/docs/content-services/components/rating.component.md b/docs/content-services/components/rating.component.md index 19a7e0ccb9..2481a126e7 100644 --- a/docs/content-services/components/rating.component.md +++ b/docs/content-services/components/rating.component.md @@ -40,7 +40,7 @@ If the average is decimal number it will be rounded. | Name | Type | Description | | ---- | ---- | ----------- | -| changeVote | `any` | Emitted when the "vote" gets changed. | +| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also diff --git a/docs/content-services/components/tag-actions.component.md b/docs/content-services/components/tag-actions.component.md index 4425f234a5..78dbc778e3 100644 --- a/docs/content-services/components/tag-actions.component.md +++ b/docs/content-services/components/tag-actions.component.md @@ -32,5 +32,5 @@ Shows available actions for tags. | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| result | `any` | Emitted when an action is chosen. | +| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an action is chosen. | | successAdd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is added successfully. | diff --git a/docs/content-services/components/tag-list.component.md b/docs/content-services/components/tag-list.component.md index 54e7b04841..3e4fe204e3 100644 --- a/docs/content-services/components/tag-list.component.md +++ b/docs/content-services/components/tag-list.component.md @@ -17,7 +17,7 @@ Shows tags for an item. | Name | Type | Description | | ---- | ---- | ----------- | -| result | `any` | Emitted when a tag is selected. | +| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | ## See Also diff --git a/docs/content-services/components/tag-node-list.component.md b/docs/content-services/components/tag-node-list.component.md index f9562caa5e..b5aafc72ef 100644 --- a/docs/content-services/components/tag-node-list.component.md +++ b/docs/content-services/components/tag-node-list.component.md @@ -32,4 +32,4 @@ Shows tags for a node. | Name | Type | Description | | ---- | ---- | ----------- | -| results | `any` | Emitted when a tag is selected. | +| results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | diff --git a/docs/content-services/components/upload-button.component.md b/docs/content-services/components/upload-button.component.md index 53d5e07388..60bd4864d6 100644 --- a/docs/content-services/components/upload-button.component.md +++ b/docs/content-services/components/upload-button.component.md @@ -47,11 +47,11 @@ Activates a file upload. | Name | Type | Description | | ---- | ---- | ----------- | -| beginUpload | `any` | Emitted when the upload begins. | -| error | `any` | Emitted when an error occurs. | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | -| success | `any` | Emitted when the file is uploaded successfully. | -| updateFileVersion | `any` | Emitted when dropping a file over another file to update the version. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | +| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | ## Details diff --git a/docs/content-services/components/upload-drag-area.component.md b/docs/content-services/components/upload-drag-area.component.md index 8f29591352..c6455bd72b 100644 --- a/docs/content-services/components/upload-drag-area.component.md +++ b/docs/content-services/components/upload-drag-area.component.md @@ -74,10 +74,10 @@ as the drag/drop target: | Name | Type | Description | | ---- | ---- | ----------- | -| beginUpload | `any` | Emitted when the upload begins. | -| error | `any` | Emitted when an error occurs. | -| success | `any` | Emitted when the file is uploaded successfully. | -| updateFileVersion | `any` | Emitted when dropping a file over another file to update the version. | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | +| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | ## Details diff --git a/docs/content-services/components/upload-version-button.component.md b/docs/content-services/components/upload-version-button.component.md index 5cc2127bd2..ac48bcdfb5 100644 --- a/docs/content-services/components/upload-version-button.component.md +++ b/docs/content-services/components/upload-version-button.component.md @@ -50,11 +50,11 @@ to enrich the features and decrease the restrictions currently applied to node v | Name | Type | Description | | ---- | ---- | ----------- | -| beginUpload | `any` | Emitted when the upload begins. | -| error | `any` | Emitted when an error occurs. | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | -| success | `any` | Emitted when the file is uploaded successfully. | -| updateFileVersion | `any` | Emitted when dropping a file over another file to update the version. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | +| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | ## Details diff --git a/docs/content-services/components/version-upload.component.md b/docs/content-services/components/version-upload.component.md index 48f50081c0..307473b8ae 100644 --- a/docs/content-services/components/version-upload.component.md +++ b/docs/content-services/components/version-upload.component.md @@ -30,11 +30,11 @@ Displays the new version's minor/major changes and the optional comment of a nod | Name | Type | Description | | ---- | ---- | ----------- | -| cancel | `any` | Emitted when an cancelling during upload. | -| commentChanged | `any` | Emitted when the comment is changed. | -| error | `any` | Emitted when an error occurs. | -| success | `any` | Emitted when the file is uploaded successfully. | -| versionChanged | `any` | Emitted when the version is changed. | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an cancelling during upload. | +| commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the comment is changed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | +| versionChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the version is changed. | ## Details diff --git a/docs/content-services/components/webscript.component.md b/docs/content-services/components/webscript.component.md index eae8175dd1..b01c7e57d6 100644 --- a/docs/content-services/components/webscript.component.md +++ b/docs/content-services/components/webscript.component.md @@ -75,7 +75,7 @@ export class AppComponent { | Name | Type | Description | | ---- | ---- | ----------- | -| success | `any` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. | ## Details diff --git a/docs/content-services/directives/file-draggable.directive.md b/docs/content-services/directives/file-draggable.directive.md index 458adbdf9a..32bc85af3f 100644 --- a/docs/content-services/directives/file-draggable.directive.md +++ b/docs/content-services/directives/file-draggable.directive.md @@ -46,8 +46,8 @@ Some sample CSS to show the drag and drop area: | Name | Type | Description | | ---- | ---- | ----------- | -| filesDropped | `any` | Emitted when one or more files are dragged and dropped onto the draggable element. | -| folderEntityDropped | `any` | Emitted when a directory is dragged and dropped onto the draggable element. | +| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when one or more files are dragged and dropped onto the draggable element. | +| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a directory is dragged and dropped onto the draggable element. | ## Details diff --git a/docs/content-services/services/audit.service.md b/docs/content-services/services/audit.service.md index 8995f2dc3e..cf968ab935 100644 --- a/docs/content-services/services/audit.service.md +++ b/docs/content-services/services/audit.service.md @@ -26,31 +26,31 @@ Manages Audit apps and entries. - **getAuditApp**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>`
Get audit application info. - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional) (Optional) Options. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>` - - **getAuditApps**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>`
List audit applications. - - _opts:_ `any` - (Optional) (Optional) Options. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>` - - **getAuditEntries**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`
List audit entries for an audit application. - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional) (Optional) Options. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - - **getAuditEntriesForNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`
List audit entries for a node. - _nodeId:_ `string` - The identifier of a node. - - _opts:_ `any` - (Optional) (Optional) Options. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - - **getAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>`
Get audit entry. - _auditApplicationId:_ `string` - The identifier of an audit application. - _auditEntryId:_ `string` - The identifier of an audit entry. - - _opts:_ `any` - (Optional) (Optional) Options. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>` - - **updateAuditApp**(auditApplicationId: `string`, auditAppBodyUpdate: `boolean`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|__type>`
Update audit application info. - _auditApplicationId:_ `string` - The identifier of an audit application. - _auditAppBodyUpdate:_ `boolean` - The audit application to update. - - _opts:_ `any` - (Optional) (Optional) Options. + - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|__type>` - diff --git a/docs/content-services/services/document-list.service.md b/docs/content-services/services/document-list.service.md index 00dd669257..eabee1fd88 100644 --- a/docs/content-services/services/document-list.service.md +++ b/docs/content-services/services/document-list.service.md @@ -13,11 +13,11 @@ Implements node operations used by the [Document List component](../components/d ### Methods -- **copyNode**(nodeId: `string`, targetParentId: `string`): `any`
+- **copyNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Copy a node to destination node - _nodeId:_ `string` - The id of the node to be copied - _targetParentId:_ `string` - The id of the folder where the node will be copied - - **Returns** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the copied node + - **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)`>` - NodeEntry for the copied node - **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a node. - _nodeId:_ `string` - ID of the node to delete @@ -51,11 +51,11 @@ Implements node operations used by the [Document List component](../components/d - _where:_ `string` - (Optional) Optionally filter the list - _orderBy:_ `string[]` - (Optional) order by node property - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>` - Details of the folder -- **moveNode**(nodeId: `string`, targetParentId: `string`): `any`
+- **moveNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Moves a node to destination node. - _nodeId:_ `string` - The id of the node to be moved - _targetParentId:_ `string` - The id of the folder where the node will be moved - - **Returns** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the moved node + - **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)`>` - NodeEntry for the moved node ## Details diff --git a/docs/content-services/services/node-permission-dialog.service.md b/docs/content-services/services/node-permission-dialog.service.md index 728af29589..ee23388347 100644 --- a/docs/content-services/services/node-permission-dialog.service.md +++ b/docs/content-services/services/node-permission-dialog.service.md @@ -15,11 +15,12 @@ Displays dialogs to let the user set node permissions. - **close**()
Closes the currently-open dialog. -- **openAddPermissionDialog**(node: `Node`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>`
+- **openAddPermissionDialog**(node: `Node`, roles: [`RoleModel`](../../../lib/content-services/src/lib/permission-manager/models/role.model.ts)`[]`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]>`
Opens a dialog to add permissions to a node. - - _node:_ `Node` - ID of the target node + - _node:_ `Node` - target node + - _roles:_ [`RoleModel`](../../../lib/content-services/src/lib/permission-manager/models/role.model.ts)`[]` - settable roles for the node - _title:_ `string` - (Optional) Dialog title - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` - Node with updated permissions + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]>` - Node with updated permissions - **updateNodePermissionByDialog**(nodeId?: `string`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Opens a dialog to update permissions for a node. - _nodeId:_ `string` - (Optional) ID of the target node diff --git a/docs/content-services/services/node-permission.service.md b/docs/content-services/services/node-permission.service.md index 5d0a9c4703..f42fb392f5 100644 --- a/docs/content-services/services/node-permission.service.md +++ b/docs/content-services/services/node-permission.service.md @@ -18,31 +18,64 @@ Manages role permissions for content nodes. - _groupName:_ `string` - Name of group to look for members - _opts:_ `any` - (Optional) Extra options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>` - List of members +- **getInheritedPermission**(node: `Node`): [`PermissionDisplayModel`](../../../lib/content-services/src/lib/permission-manager/models/permission.model.ts)`[]`
+ + - _node:_ `Node` - + - **Returns** [`PermissionDisplayModel`](../../../lib/content-services/src/lib/permission-manager/models/permission.model.ts)`[]` - + +- **getLocalPermissions**(node: `Node`): [`PermissionDisplayModel`](../../../lib/content-services/src/lib/permission-manager/models/permission.model.ts)`[]`
+ + - _node:_ `Node` - + - **Returns** [`PermissionDisplayModel`](../../../lib/content-services/src/lib/permission-manager/models/permission.model.ts)`[]` - + +- **getNodePermissions**(node: `Node`): [`PermissionDisplayModel`](../../../lib/content-services/src/lib/permission-manager/models/permission.model.ts)`[]`
+ + - _node:_ `Node` - + - **Returns** [`PermissionDisplayModel`](../../../lib/content-services/src/lib/permission-manager/models/permission.model.ts)`[]` - + - **getNodeRoles**(node: `Node`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets a list of roles for the current node. - _node:_ `Node` - The target node - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Array of strings representing the roles +- **getNodeWithRoles**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Gets all node detail for nodeId along with settable permissions. + - _nodeId:_ `string` - Id of the node + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - node and it's associated roles { node: Node; roles: RoleModel\[] } - **removePermission**(node: `Node`, permissionToRemove: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Removes a permission setting from a node. - _node:_ `Node` - ID of the target node - _permissionToRemove:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission setting to remove - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Node with modified permissions -- **updateLocallySetPermissions**(node: `Node`, nodes: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **removePermissions**(node: `Node`, permissions: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Removes permissions setting from a node. + - _node:_ `Node` - target node with permission + - _permissions:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]` - Permissions to remove + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Node with modified permissions +- **transformNodeToUserPerson**(node: `Node`): `Function`
+ + - _node:_ `Node` - + - **Returns** `Function` - + +- **updateLocallySetPermissions**(node: `Node`, permissions: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Updates the locally set permissions for a node. - _node:_ `Node` - ID of the target node - - _nodes:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - Permission settings - - _nodeRole:_ `string[]` - Permission role + - _permissions:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]` - Permission settings - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Node with updated permissions -- **updateNodePermissions**(nodeId: `string`, permissionList: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **updateNodePermissions**(nodeId: `string`, permissionList: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Update permissions for a node. - _nodeId:_ `string` - ID of the target node - - _permissionList:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - New permission settings + - _permissionList:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]` - New permission settings - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Node with updated permissions - **updatePermissionRole**(node: `Node`, updatedPermissionRole: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Updates the permission role for a node. - _node:_ `Node` - Target node - _updatedPermissionRole:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission role to update or add - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Node with updated permission +- **updatePermissions**(node: `Node`, permissions: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ updates permissions setting from a node. + - _node:_ `Node` - target node with permission + - _permissions:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`[]` - Permissions to update + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Node with modified permissions ## Details diff --git a/docs/content-services/services/search-query-builder.service.md b/docs/content-services/services/search-query-builder.service.md index 99fcbbeaad..081614af1e 100644 --- a/docs/content-services/services/search-query-builder.service.md +++ b/docs/content-services/services/search-query-builder.service.md @@ -25,7 +25,7 @@ Stores information from all the custom search and faceted search widgets, compil - **Returns** `QueryBody` - The finished query - **execute**(queryBody?: `QueryBody`)
Builds and executes the current query. - - _queryBody:_ `QueryBody` - (Optional) (Optional) + - _queryBody:_ `QueryBody` - (Optional) (Optional) (Optional) - **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)
Gets a facet field by label. - _label:_ `string` - Label of the facet field @@ -84,7 +84,7 @@ Stores information from all the custom search and faceted search widgets, compil - **update**(queryBody?: `QueryBody`)
Builds the current query and triggers the `updated` event. - - _queryBody:_ `QueryBody` - (Optional) (Optional) + - _queryBody:_ `QueryBody` - (Optional) (Optional) (Optional) ## Details diff --git a/docs/core/components/data-column.component.md b/docs/core/components/data-column.component.md index 7168846807..785ecb7c61 100644 --- a/docs/core/components/data-column.component.md +++ b/docs/core/components/data-column.component.md @@ -201,7 +201,6 @@ In the example below we will show capitalised custom name for a column: - In the Example below we will integrate the [adf-tag-node-list](../../content-services/components/tag-node-list.component.md) component within the document list. diff --git a/docs/core/components/datatable.component.md b/docs/core/components/datatable.component.md index 65faba250f..94a0085e5a 100644 --- a/docs/core/components/datatable.component.md +++ b/docs/core/components/datatable.component.md @@ -369,11 +369,11 @@ Learm more about styling your datatable: [Customizing the component's styles](#c | Name | Type | Description | | ---- | ---- | ----------- | -| executeRowAction | `any` | Emitted when the user executes a row action. | -| rowClick | `any` | Emitted when the user clicks a row. | -| rowDblClick | `any` | Emitted when the user double-clicks a row. | -| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | +| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | ## Details diff --git a/docs/core/components/header.component.md b/docs/core/components/header.component.md index d27507cccc..68ed2eca27 100644 --- a/docs/core/components/header.component.md +++ b/docs/core/components/header.component.md @@ -51,7 +51,7 @@ body of the element: | Name | Type | Description | | ---- | ---- | ----------- | -| clicked | `any` | Emitted when the sidenav button is clicked. | +| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the sidenav button is clicked. | ## Details diff --git a/docs/core/components/host-settings.component.md b/docs/core/components/host-settings.component.md index ad24c9a005..33618246b5 100644 --- a/docs/core/components/host-settings.component.md +++ b/docs/core/components/host-settings.component.md @@ -40,6 +40,6 @@ Validates the URLs for ACS and APS and saves them in the user's local storage | Name | Type | Description | | ---- | ---- | ----------- | -| cancel | `any` | Emitted when the user cancels the changes. | -| error | `any` | Emitted when the URL is invalid. | -| success | `any` | Emitted when the changes are successfully applied. | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user cancels the changes. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the URL is invalid. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the changes are successfully applied. | diff --git a/docs/core/components/login-dialog-panel.component.md b/docs/core/components/login-dialog-panel.component.md index 6f5939c85f..560f6250d9 100644 --- a/docs/core/components/login-dialog-panel.component.md +++ b/docs/core/components/login-dialog-panel.component.md @@ -15,7 +15,7 @@ Shows and manages a login dialog. | Name | Type | Description | | ---- | ---- | ----------- | -| success | `any` | Emitted when the login succeeds. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. | ## Details diff --git a/docs/core/components/login.component.md b/docs/core/components/login.component.md index 13697224b7..66ddc9dec6 100644 --- a/docs/core/components/login.component.md +++ b/docs/core/components/login.component.md @@ -92,9 +92,9 @@ with custom input fields handled by your application or parent component: | Name | Type | Description | | ---- | ---- | ----------- | -| error | `any` | Emitted when the login fails. | -| executeSubmit | `any` | Emitted when the login form is submitted. | -| success | `any` | Emitted when the login is successful. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. | +| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. | ## Details diff --git a/docs/core/components/pagination.component.md b/docs/core/components/pagination.component.md index 530af8fe71..a2d0b2c595 100644 --- a/docs/core/components/pagination.component.md +++ b/docs/core/components/pagination.component.md @@ -50,11 +50,11 @@ Adds pagination to the component it is used with. | Name | Type | Description | | ---- | ---- | ----------- | -| change | `any` | Emitted when pagination changes in any way. | -| changePageNumber | `any` | Emitted when the page number changes. | -| changePageSize | `any` | Emitted when the page size changes. | -| nextPage | `any` | Emitted when the next page is requested. | -| prevPage | `any` | Emitted when the previous page is requested. | +| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. | +| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. | +| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page size changes. | +| nextPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the next page is requested. | +| prevPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the previous page is requested. | ## Details diff --git a/docs/core/components/sidenav-layout.component.md b/docs/core/components/sidenav-layout.component.md index a49ce05352..84ffee0e02 100644 --- a/docs/core/components/sidenav-layout.component.md +++ b/docs/core/components/sidenav-layout.component.md @@ -80,7 +80,7 @@ sub-components (note the use of `` in the sub-components' body sect | Name | Type | Description | | ---- | ---- | ----------- | -| expanded | `any` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. | +| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. | ## Details diff --git a/docs/core/components/sorting-picker.component.md b/docs/core/components/sorting-picker.component.md index 76174f53bf..8c1a20d787 100644 --- a/docs/core/components/sorting-picker.component.md +++ b/docs/core/components/sorting-picker.component.md @@ -36,8 +36,8 @@ Selects from a set of predefined sorting definitions and directions. | Name | Type | Description | | ---- | ---- | ----------- | -| sortingChange | `any` | Raised each time direction gets changed. | -| valueChange | `any` | Raised each time sorting key gets changed. | +| sortingChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time direction gets changed. | +| valueChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time sorting key gets changed. | ## Details diff --git a/docs/core/components/viewer.component.md b/docs/core/components/viewer.component.md index abc75cf8cf..6a24efd499 100644 --- a/docs/core/components/viewer.component.md +++ b/docs/core/components/viewer.component.md @@ -109,13 +109,13 @@ See the [Custom layout](#custom-layout) section for full details of all availabl | Name | Type | Description | | ---- | ---- | ----------- | -| extensionChange | `any` | Emitted when the filename extension changes. | -| goBack | `any` | Emitted when user clicks the 'Back' button. | -| invalidSharedLink | `any` | Emitted when the shared link used is not valid. | -| navigateBefore | `any` | Emitted when user clicks 'Navigate Before' ("<") button. | -| navigateNext | `any` | Emitted when user clicks 'Navigate Next' (">") button. | -| print | `any` | Emitted when user clicks the 'Print' button. | -| showViewerChange | `any` | Emitted when the viewer is shown or hidden. | +| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the filename extension changes. | +| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Back' button. | +| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the shared link used is not valid. | +| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Before' ("<") button. | +| navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Next' (">") button. | +| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Print' button. | +| showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the viewer is shown or hidden. | ## Keyboard shortcuts diff --git a/docs/core/directives/infinite-select-scroll.directive.md b/docs/core/directives/infinite-select-scroll.directive.md index 52c6affb7e..295d9f40d3 100644 --- a/docs/core/directives/infinite-select-scroll.directive.md +++ b/docs/core/directives/infinite-select-scroll.directive.md @@ -27,4 +27,4 @@ Load more options to select component if API returns more items | Name | Type | Description | | ---- | ---- | ----------- | -| scrollEnd | `any` | Emitted when scroll reaches the last item. | +| scrollEnd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when scroll reaches the last item. | diff --git a/docs/core/services/authentication.service.md b/docs/core/services/authentication.service.md index 7be672feb8..33c0b44076 100644 --- a/docs/core/services/authentication.service.md +++ b/docs/core/services/authentication.service.md @@ -87,9 +87,9 @@ Provides authentication to ACS and APS. - _password:_ `string` - Password for the login - _rememberMe:_ `boolean` - Stores the user's login details if true - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket -- **logout**(): `any`
+- **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Logs the user out. - - **Returns** `any` - Response event called when logout is complete + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Response event called when logout is complete - **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))
Sets the URL to redirect to after login. - _url:_ [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to diff --git a/docs/core/services/ecm-user.service.md b/docs/core/services/ecm-user.service.md index 4a023adadc..d579ab010d 100644 --- a/docs/core/services/ecm-user.service.md +++ b/docs/core/services/ecm-user.service.md @@ -13,9 +13,9 @@ Gets information about a Content Services user. ### Methods -- **getCurrentUserInfo**(): `any`
+- **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
Gets information about the user who is currently logged-in. - - **Returns** `any` - User information as for getUserInfo + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - User information as for getUserInfo - **getUserInfo**(userName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
Gets information about a user identified by their username. - _userName:_ `string` - Target username diff --git a/docs/core/services/form.service.md b/docs/core/services/form.service.md index 4d95076b3e..383da1c7a7 100644 --- a/docs/core/services/form.service.md +++ b/docs/core/services/form.service.md @@ -73,7 +73,7 @@ class MyComponent { Saves a form. - `formId` - ID of the form to save - - `formModel` - [Model](../../../lib/cli/node_modules/@alfresco/js-api/src/api/model-rest-api/model/model.ts) data for the form + - `formModel` - [`Model`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/model-rest-api/model/model.ts) data for the form - `searchFrom(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Search for a form by name. diff --git a/docs/core/services/notification.service.md b/docs/core/services/notification.service.md index 637ff52a08..c15438754a 100644 --- a/docs/core/services/notification.service.md +++ b/docs/core/services/notification.service.md @@ -15,9 +15,8 @@ Shows a notification message with optional feedback. ### Methods -- **dismissSnackMessageAction**(): `any`
+- **dismissSnackMessageAction**()
dismiss the notification snackbar - - **Returns** `any` - - **openSnackMessage**(message: `string`, config?: `number|MatSnackBarConfig`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Opens a SnackBar notification to show a message. - _message:_ `string` - The message (or resource key) to show. diff --git a/docs/core/services/people-content.service.md b/docs/core/services/people-content.service.md index af98042aa7..dcff36a8f1 100644 --- a/docs/core/services/people-content.service.md +++ b/docs/core/services/people-content.service.md @@ -13,20 +13,26 @@ Gets information about a Content Services user. ### Methods +- **createPerson**(newPerson: [`PersonBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/model/personBodyCreate.ts), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
+ Creates new person. + - _newPerson:_ [`PersonBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/model/personBodyCreate.ts) - Object containing the new person details. + - _opts:_ `any` - (Optional) Optional parameters + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - Created new person - **getCurrentPerson**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets information about the user who is currently logged in. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - User information - **getPerson**(personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Gets information about a user identified by their ID. + Gets information about a user identified by their username. - _personId:_ `string` - ID of the target user - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - User information -- **listPeople**(options: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`[]>`
Gets information on a list of users - - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`[]>` -- **createPerson**(newPerson: [`PersonBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PersonBodyCreate.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
- Creates new person. - - _newPerson:_ `<`[`PersonBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PersonBodyCreate.md)`>` - Object containing the new person details - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - Created new person. +- **isContentAdmin**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
+ + - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - + +- **listPeople**(options?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`[]>`
+ Gets a list of people. + - _options:_ `any` - (Optional) Optional parameters supported by JS-API + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`[]>` - Array of people ## Details diff --git a/docs/core/services/process-content.service.md b/docs/core/services/process-content.service.md index 361c833e68..7a03b23271 100644 --- a/docs/core/services/process-content.service.md +++ b/docs/core/services/process-content.service.md @@ -18,12 +18,12 @@ Manipulates content related to a Process Instance or Task Instance in APS. - _content:_ `any` - File to associate - _opts:_ `any` - (Optional) Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of created content -- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): `any`
+- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Associates an uploaded file with a task instance. - _taskId:_ `string` - ID of the target task - _file:_ `any` - File to associate - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** `any` - Details of created content + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of created content - **createTemporaryRawRelatedContent**(file: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`
Create temporary related content from an uploaded file. - _file:_ `any` - File to use for content diff --git a/docs/core/services/renditions.service.md b/docs/core/services/renditions.service.md index 9fde5ac7dd..f3f4220c86 100644 --- a/docs/core/services/renditions.service.md +++ b/docs/core/services/renditions.service.md @@ -13,13 +13,13 @@ Manages prearranged conversions of content to different formats. ### Methods -- **convert**(nodeId: `string`, encoding: `string`, pollingInterval: `number` = `1000`, retries: `number` = `5`): `any`
+- **convert**(nodeId: `string`, encoding: `string`, pollingInterval: `number` = `1000`, retries: `number` = `5`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>`
Repeatedly attempts to create a rendition, through to success or failure. - _nodeId:_ `string` - ID of the target node - _encoding:_ `string` - Name of the rendition encoding - _pollingInterval:_ `number` - Time interval (in milliseconds) between checks for completion - _retries:_ `number` - Number of attempts to make before declaring failure - - **Returns** `any` - True if the rendition was created, false otherwise + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - True if the rendition was created, false otherwise - **createRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<__type>`
Creates a rendition for a node. - _nodeId:_ `string` - ID of the target node diff --git a/docs/core/widgets/content.widget.md b/docs/core/widgets/content.widget.md index bece9550c9..30ad07c64d 100644 --- a/docs/core/widgets/content.widget.md +++ b/docs/core/widgets/content.widget.md @@ -29,7 +29,7 @@ Shows the content preview. | Name | Type | Description | | ---- | ---- | ----------- | -| contentClick | `any` | Emitted when the content is clicked. | +| contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content is clicked. | | contentLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content has loaded. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | thumbnailLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the thumbnail has loaded. | diff --git a/docs/extensions/services/extension.service.md b/docs/extensions/services/extension.service.md index a97ba3a96f..c8c5836a8b 100644 --- a/docs/extensions/services/extension.service.md +++ b/docs/extensions/services/extension.service.md @@ -26,10 +26,10 @@ Manages and runs basic extension functionality. Retrieves one or more auth guards using an array of ID values. - _ids:_ `string[]` - Array of ID value to look for - **Returns** `Array>` - Array of auth guards or empty array if none were found -- **getComponentById**(id: `string`): `any`
+- **getComponentById**(id: `string`): `Type<>`
Retrieves a registered [extension component](../../../lib/extensions/src/lib/services/component-register.service.ts) using its ID value. - _id:_ `string` - The ID value to look for - - **Returns** `any` - The component or null if not found + - **Returns** `Type<>` - The component or null if not found - **getElements**(key: `string`, fallback: `Array<>` = `[]`): `Array<>`
- _key:_ `string` - diff --git a/docs/insights/components/analytics-generator.component.md b/docs/insights/components/analytics-generator.component.md index 05c676fe6f..45ccbcfb63 100644 --- a/docs/insights/components/analytics-generator.component.md +++ b/docs/insights/components/analytics-generator.component.md @@ -30,5 +30,5 @@ Generates and shows charts | Name | Type | Description | | ---- | ---- | ----------- | -| error | `any` | error. | -| success | `any` | success. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/insights/components/analytics-report-list.component.md b/docs/insights/components/analytics-report-list.component.md index aab11bd577..98e96f47cb 100644 --- a/docs/insights/components/analytics-report-list.component.md +++ b/docs/insights/components/analytics-report-list.component.md @@ -30,6 +30,6 @@ Shows a list of all available reports | Name | Type | Description | | ---- | ---- | ----------- | -| error | `any` | error. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | | reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../../lib/insights/src/lib/diagram/models/report/report-parameters.model.ts)`>` | report Click. | -| success | `any` | success. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/insights/components/analytics.component.md b/docs/insights/components/analytics.component.md index 2482cab47e..c26bc6b67b 100644 --- a/docs/insights/components/analytics.component.md +++ b/docs/insights/components/analytics.component.md @@ -33,6 +33,6 @@ Shows the charts related to the reportId passed as input | Name | Type | Description | | ---- | ---- | ----------- | -| editReport | `any` | emitted when editReport. | -| reportDeleted | `any` | emitted when reportDeleted. | -| reportSaved | `any` | emitted when reportSaved. | +| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when editReport. | +| reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when reportDeleted. | +| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when reportSaved. | diff --git a/docs/insights/components/diagram.component.md b/docs/insights/components/diagram.component.md index 49e34f67e3..3d16e8917b 100644 --- a/docs/insights/components/diagram.component.md +++ b/docs/insights/components/diagram.component.md @@ -44,5 +44,5 @@ The below component shows the diagram of a running process instance with the act | Name | Type | Description | | ---- | ---- | ----------- | -| error | `any` | error. | -| success | `any` | success. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/process-services-cloud/components/app-list-cloud.component.md b/docs/process-services-cloud/components/app-list-cloud.component.md index 692c1d8ecb..490ae0f84d 100644 --- a/docs/process-services-cloud/components/app-list-cloud.component.md +++ b/docs/process-services-cloud/components/app-list-cloud.component.md @@ -53,4 +53,4 @@ For example : | Name | Type | Description | | ---- | ---- | ----------- | -| appClick | `any` | Emitted when an app entry is clicked. | +| appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`>` | Emitted when an app entry is clicked. | diff --git a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md index f67ecaa8b9..496cbbae5a 100644 --- a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md @@ -58,8 +58,8 @@ Shows/edits process filter details. | Name | Type | Description | | ---- | ---- | ----------- | -| action | `any` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. | -| filterChange | `any` | Emitted when a process instance filter property changes. | +| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterAction`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. | +| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a process instance filter property changes. | ## Details diff --git a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md index 2729de779a..e60efad64b 100644 --- a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md @@ -57,8 +57,8 @@ Edits task filter details. | Name | Type | Description | | ---- | ---- | ----------- | -| action | `any` | Emitted when a filter action occurs (i.e Save, Save As, Delete). | -| filterChange | `any` | Emitted when a task filter property changes. | +| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterAction`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). | +| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when a task filter property changes. | ## Details diff --git a/docs/process-services-cloud/components/form-cloud.component.md b/docs/process-services-cloud/components/form-cloud.component.md index 1f8a5d42fc..a0439f8788 100644 --- a/docs/process-services-cloud/components/form-cloud.component.md +++ b/docs/process-services-cloud/components/form-cloud.component.md @@ -102,12 +102,12 @@ The template defined inside `empty-form` will be shown when no form definition i | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | | executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | `any` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | `any` | Emitted when form content is clicked. | -| formDataRefreshed | `any` | Emitted when form values are refreshed due to a data property change. | +| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | +| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | | formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | -| formLoaded | `any` | Emitted when the form is loaded or reloaded. | -| formSaved | `any` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | ## Details diff --git a/docs/process-services-cloud/components/group-cloud.component.md b/docs/process-services-cloud/components/group-cloud.component.md index c79cd38bc9..d0e468eb36 100644 --- a/docs/process-services-cloud/components/group-cloud.component.md +++ b/docs/process-services-cloud/components/group-cloud.component.md @@ -51,10 +51,10 @@ Searches Groups. | Name | Type | Description | | ---- | ---- | ----------- | -| changedGroups | `any` | Emitted when a group selection change. | -| removeGroup | `any` | Emitted when a group is removed. | -| selectGroup | `any` | Emitted when a group is selected. | -| warning | `any` | Emitted when an warning occurs. | +| changedGroups | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` | Emitted when a group selection change. | +| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is removed. | +| selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is selected. | +| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | ## Details diff --git a/docs/process-services-cloud/components/people-cloud.component.md b/docs/process-services-cloud/components/people-cloud.component.md index 8a195737a6..d069e737cd 100644 --- a/docs/process-services-cloud/components/people-cloud.component.md +++ b/docs/process-services-cloud/components/people-cloud.component.md @@ -31,7 +31,7 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu | preSelectUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | | readOnly | `boolean` | false | Show the info in readonly mode | | roles | `string[]` | | Role names of the users to be listed. | -| searchUserCtrl | `any` | | FormControl to search the user | +| searchUserCtrl | `FormControl` | | FormControl to search the user | | title | `string` | | Placeholder translation key | | userChipsCtrl | `FormControl` | | FormControl to list of users | | validate | `boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | @@ -40,10 +40,10 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu | Name | Type | Description | | ---- | ---- | ----------- | -| changedUsers | `any` | Emitted when a user selection change. | -| removeUser | `any` | Emitted when a selected user is removed in multi selection mode. | -| selectUser | `any` | Emitted when a user is selected. | -| warning | `any` | Emitted when an warning occurs. | +| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. | +| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. | +| selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a user is selected. | +| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | ## Details diff --git a/docs/process-services-cloud/components/process-filters-cloud.component.md b/docs/process-services-cloud/components/process-filters-cloud.component.md index fe88bc5e76..8561e38ca0 100644 --- a/docs/process-services-cloud/components/process-filters-cloud.component.md +++ b/docs/process-services-cloud/components/process-filters-cloud.component.md @@ -32,10 +32,10 @@ Lists all available process filters and allows to select a filter. | Name | Type | Description | | ---- | ---- | ----------- | -| error | `any` | Emitted when any error occurs while loading the filters | -| filterClicked | `any` | Emitted when a filter is being clicked from the UI. | -| filterSelected | `any` | Emitted when a filter is being selected based on the filterParam input. | -| success | `any` | Emitted when filters are loaded successfully | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs while loading the filters | +| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is being clicked from the UI. | +| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is being selected based on the filterParam input. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when filters are loaded successfully | ## See also diff --git a/docs/process-services-cloud/components/process-list-cloud.component.md b/docs/process-services-cloud/components/process-list-cloud.component.md index f019392bcd..ba54d61ba6 100644 --- a/docs/process-services-cloud/components/process-list-cloud.component.md +++ b/docs/process-services-cloud/components/process-list-cloud.component.md @@ -75,17 +75,19 @@ when the process list is empty: | startTo | `string` | "" | Filter the processes. Display only process with startedDate less than the supplied date. | | status | `string` | "" | Filter the processes to display only the ones with this status. | | stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| suspendedFrom | `string` | "" | Filter the processes. Display only process with suspendedFrom equal to the supplied date. | +| suspendedTo | `string` | "" | Filter the processes. Display only process with suspendedTo equal to the supplied date. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | -| executeRowAction | `any` | Emitted when the user executes a row action. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected. | -| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details diff --git a/docs/process-services-cloud/components/start-process-cloud.component.md b/docs/process-services-cloud/components/start-process-cloud.component.md index 82bd720b20..c709b33eb1 100644 --- a/docs/process-services-cloud/components/start-process-cloud.component.md +++ b/docs/process-services-cloud/components/start-process-cloud.component.md @@ -48,11 +48,11 @@ Starts a process. | Name | Type | Description | | ---- | ---- | ----------- | -| cancel | `any` | Emitted when the starting process is cancelled | -| error | `any` | Emitted when an error occurs. | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the starting process is cancelled | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. | | formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | | processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`>` | Emitted when process definition selection changes. | -| success | `any` | Emitted when the process is successfully started. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the process is successfully started. | ## Details diff --git a/docs/process-services-cloud/components/task-filters-cloud.component.md b/docs/process-services-cloud/components/task-filters-cloud.component.md index 440c90d448..6af9f567cc 100644 --- a/docs/process-services-cloud/components/task-filters-cloud.component.md +++ b/docs/process-services-cloud/components/task-filters-cloud.component.md @@ -42,9 +42,9 @@ Shows all available filters. | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | -| filterClicked | `any` | Emitted when a filter is being clicked from the UI. | +| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter is being clicked from the UI. | | filterCounterUpdated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskCloudEngineEvent`](../../../lib/process-services-cloud/src/lib/models/engine-event-cloud.model.ts)`[]>` | Emitted when filter counters are updated. | -| filterSelected | `any` | Emitted when a filter is being selected based on the filterParam input. | +| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter is being selected based on the filterParam input. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | ## Details @@ -71,7 +71,7 @@ as the value of `filterParam` as shown in the table below: ### Showing Filter Counters -By default, filter counters are hidden. If you want to display filter counters you will need to add the `showCounter` property set to `true` in your [TaskFilterCloudModel](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts). +By default, filter counters are hidden. If you want to display filter counters you will need to add the `showCounter` property set to `true` in your [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts). ![](../../docassets/images/task-filter-counter.png) diff --git a/docs/process-services-cloud/components/task-form-cloud.component.md b/docs/process-services-cloud/components/task-form-cloud.component.md index ee359bff56..34ef3a5535 100644 --- a/docs/process-services-cloud/components/task-form-cloud.component.md +++ b/docs/process-services-cloud/components/task-form-cloud.component.md @@ -48,14 +48,14 @@ Save and Complete buttons get disabled when at least one of the form's inputs ar | Name | Type | Description | | ---- | ---- | ----------- | -| cancelClick | `any` | Emitted when the cancel button is clicked. | -| error | `any` | Emitted when any error occurs. | -| formCompleted | `any` | Emitted when the form is submitted with the `Complete` outcome. | +| cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | | formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | -| formSaved | `any` | Emitted when the form is saved. | -| taskClaimed | `any` | Emitted when the task is claimed. | -| taskCompleted | `any` | Emitted when the task is completed. | -| taskUnclaimed | `any` | Emitted when the task is unclaimed. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is saved. | +| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| taskCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | +| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed. | ## See also diff --git a/docs/process-services-cloud/components/task-list-cloud.component.md b/docs/process-services-cloud/components/task-list-cloud.component.md index f6ddd3cfec..3f95f7c8ee 100644 --- a/docs/process-services-cloud/components/task-list-cloud.component.md +++ b/docs/process-services-cloud/components/task-list-cloud.component.md @@ -90,11 +90,11 @@ when the task list is empty: | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeRowAction | `any` | Emitted when the user executes a row action. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | -| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | ## Details diff --git a/docs/process-services-cloud/services/process-filter-cloud.service.md b/docs/process-services-cloud/services/process-filter-cloud.service.md index f30a0ee44f..43e79b8198 100644 --- a/docs/process-services-cloud/services/process-filter-cloud.service.md +++ b/docs/process-services-cloud/services/process-filter-cloud.service.md @@ -47,8 +47,8 @@ Manage Process Filters, which are pre-configured Process Instance queries. - _value:_ `Object` - - _filterProperties:_ `string[]` - - - _appName:_ `string` - (Optional) - - _id:_ `string` - (Optional) + - _appName:_ `string` - (Optional) (Optional) + - _id:_ `string` - (Optional) (Optional) - **Returns** `Object` - ## Inject Preference service diff --git a/docs/process-services/components/people-list.component.md b/docs/process-services/components/people-list.component.md index 8d94a8c1de..f0ad4ef0ba 100644 --- a/docs/process-services/components/people-list.component.md +++ b/docs/process-services/components/people-list.component.md @@ -85,5 +85,5 @@ You can use column templates with the [people list component](people-list.compon | Name | Type | Description | | ---- | ---- | ----------- | -| clickAction | `any` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. | -| clickRow | `any` | Emitted when the user clicks a row in the people list. | +| clickAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserEventModel`](../../../lib/process-services/src/lib/task-list/models/user-event.model.ts)`>` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. | +| clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when the user clicks a row in the people list. | diff --git a/docs/process-services/components/people-search.component.md b/docs/process-services/components/people-search.component.md index ddd5267f86..f55fcaaa68 100644 --- a/docs/process-services/components/people-search.component.md +++ b/docs/process-services/components/people-search.component.md @@ -39,9 +39,9 @@ special sub-components in the body of the `` element: | Name | Type | Description | | ---- | ---- | ----------- | -| closeSearch | `any` | Emitted when the "close" button is clicked. | -| searchPeople | `any` | Emitted when a search is performed with a new keyword. | -| success | `any` | Emitted when a user is selected and the action button is clicked. | +| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "close" button is clicked. | +| searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a search is performed with a new keyword. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when a user is selected and the action button is clicked. | ## Details diff --git a/docs/process-services/components/process-attachment-list.component.md b/docs/process-services/components/process-attachment-list.component.md index a6ff1a88d3..41a0da993f 100644 --- a/docs/process-services/components/process-attachment-list.component.md +++ b/docs/process-services/components/process-attachment-list.component.md @@ -67,9 +67,9 @@ A default template will be used if you don't supply a custom one to override it: | Name | Type | Description | | ---- | ---- | ----------- | -| attachmentClick | `any` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. | -| error | `any` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | -| success | `any` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/components/process-instance-details.component.md b/docs/process-services/components/process-instance-details.component.md index aa6d0f59d6..bd96498023 100644 --- a/docs/process-services/components/process-instance-details.component.md +++ b/docs/process-services/components/process-instance-details.component.md @@ -31,7 +31,7 @@ Displays detailed information about a specified process instance | Name | Type | Description | | ---- | ---- | ----------- | -| error | `any` | Emitted when an error occurs. | -| processCancelled | `any` | Emitted when the current process is cancelled by the user from within the component. | -| showProcessDiagram | `any` | Emitted when the "show diagram" button is clicked. | -| taskClick | `any` | Emitted when a task is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| processCancelled | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the current process is cancelled by the user from within the component. | +| showProcessDiagram | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "show diagram" button is clicked. | +| taskClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsEvent`](../../../lib/process-services/src/lib/task-list/models/task-details.event.ts)`>` | Emitted when a task is clicked. | diff --git a/docs/process-services/components/process-list.component.md b/docs/process-services/components/process-list.component.md index a14a4aacb4..8a2d12fa9b 100644 --- a/docs/process-services/components/process-list.component.md +++ b/docs/process-services/components/process-list.component.md @@ -71,10 +71,10 @@ when the process list is empty: | Name | Type | Description | | ---- | ---- | ----------- | -| error | `any` | Emitted when an error occurs while loading the list of process instances from the server. | -| rowClick | `any` | Emitted when a row in the process list is clicked. | -| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. | -| success | `any` | Emitted when the list of process instances has been loaded successfully from the server. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details diff --git a/docs/process-services/components/task-attachment-list.component.md b/docs/process-services/components/task-attachment-list.component.md index 2871242a26..ca05b42ebb 100644 --- a/docs/process-services/components/task-attachment-list.component.md +++ b/docs/process-services/components/task-attachment-list.component.md @@ -61,9 +61,9 @@ A default "no content" template is displayed if you don't supply one to override | Name | Type | Description | | ---- | ---- | ----------- | -| attachmentClick | `any` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. | -| error | `any` | Emitted when an error occurs while fetching the attachments. | -| success | `any` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while fetching the attachments. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/components/task-form.component.md b/docs/process-services/components/task-form.component.md index eaa5d1b2a2..d31d210580 100644 --- a/docs/process-services/components/task-form.component.md +++ b/docs/process-services/components/task-form.component.md @@ -37,18 +37,18 @@ Shows a [`form`](../../../lib/process-services/src/lib/task-list/models/form.mod | Name | Type | Description | | ---- | ---- | ----------- | -| cancel | `any` | Emitted when the "Cancel" button is clicked. | -| completed | `any` | Emitted when the form associated with the task is completed. | -| error | `any` | Emitted when an error occurs. | -| executeOutcome | `any` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | `any` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | `any` | Emitted when the form field content is clicked. | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | +| completed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | | formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | -| formLoaded | `any` | Emitted when the form is loaded or reloaded. | -| formSaved | `any` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | | showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | -| taskClaimed | `any` | Emitted when the task is claimed. | -| taskUnclaimed | `any` | Emitted when the task is unclaimed (ie, requeued).. | +| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued).. | ## See also diff --git a/docs/process-services/components/task-list.component.md b/docs/process-services/components/task-list.component.md index 041468ebb5..7d065d1b62 100644 --- a/docs/process-services/components/task-list.component.md +++ b/docs/process-services/components/task-list.component.md @@ -80,11 +80,11 @@ when the task list is empty: | Name | Type | Description | | ---- | ---- | ----------- | -| error | `any` | Emitted when an error occurs. | -| rowClick | `any` | Emitted when a task in the list is clicked | -| rowsSelected | `any` | Emitted when rows are selected/unselected | -| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. | -| success | `any` | Emitted when the task list is loaded | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | +| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | ## Details diff --git a/docs/process-services/services/tasklist.service.md b/docs/process-services/services/tasklist.service.md index c95788cc77..86214e5e78 100644 --- a/docs/process-services/services/tasklist.service.md +++ b/docs/process-services/services/tasklist.service.md @@ -36,10 +36,10 @@ Manages Task Instances. Claims a task for the current user. - _taskId:_ `string` - ID of the task to claim - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the claimed task -- **completeTask**(taskId: `string`): `any`
+- **completeTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gives completed status to a task. - _taskId:_ `string` - ID of the target task - - **Returns** `any` - Null response notifying when the operation is complete + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete - **createNewTask**(task: [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Creates a new standalone task. - _task:_ [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) - Details of the new task