inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release Note for 4.2 - Initial draft. (#6390)

Browse Source 
* Release Note for 4.2 - Initial draft.

* update dep

* documentation

* fix

* remove script

* lint

Co-authored-by: Eugenio Romano <eugenio.romano@alfresco.com>
Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
This commit is contained in:
Francesco Corti
2020-12-07 22:03:41 +01:00
committed by GitHub
parent 27167b3420
commit 5a4cc4edda
214 changed files with 5178 additions and 4950 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/content-services/components/add-permission-panel.component.md
View File

@@ -25,8 +25,8 @@ Searches for people or groups to add to the current node permissions.
### Events
| Name | Type | Description |
| ------ | ----------------------------------------------------------------- | ------------------------------------------------ |
| Name | Type | Description |
| --- | --- | --- |
| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission list item is selected. |
## Details
@@ -41,5 +41,5 @@ permissions to the node once the selection has been made.
## See also
- [Add permission dialog component](add-permission-dialog.component.md)
- [Add permission component](add-permission.component.md)
* [Add permission dialog component](add-permission-dialog.component.md)
* [Add permission component](add-permission.component.md)

18
docs/content-services/components/add-permission.component.md
View File

@@ -25,16 +25,16 @@ Searches for people or groups to add to the current node permissions.
### Properties
| Name | Type | Default value | Description |
| ------ | -------- | ------------- | ---------------------- |
| nodeId | `string` | | ID of the target node. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodeId | `string` | | ID of the target node. |
### Events
| Name | Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the update. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated successfully. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the update. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated successfully. |
## Details
@@ -44,5 +44,5 @@ use the [Add permission dialog component](add-permission-dialog.component.md) to
## See also
- [Add permission panel component](add-permission-panel.component.md)
- [Add permission dialog component](add-permission-dialog.component.md)
* [Add permission panel component](add-permission-panel.component.md)
* [Add permission dialog component](add-permission-dialog.component.md)

26
docs/content-services/components/breadcrumb.component.md
View File

@@ -23,19 +23,19 @@ Indicates the current position within a navigation hierarchy.
### Properties
| Name | Type | Default value | Description |
| ---------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. |
| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. |
| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. |
| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. |
| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. |
| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. |
| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
### Events
| Name | Type | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| 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
@@ -52,7 +52,7 @@ uses to find the "crumbs" for the list. You can use this, for example, to remove
the list by altering the node's `path.elements` property.
Below is an example of how you might do this with the
[Content Node Selector component](content-node-selector.component.md). In this case, you pass the
[Content Node Selector component](content-node-selector.component.md). In this case, you pass the
transform function via the `breadcrumbTransform` property of [`ContentNodeSelectorComponentData`](../../../lib/content-services/src/lib/content-node-selector/content-node-selector.component-data.interface.ts) during
initialization:
@@ -96,5 +96,5 @@ Below, the breadcrumb is shown before and after the transform function is applie
## See also
- [Document list component](document-list.component.md)
- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md)
* [Document list component](document-list.component.md)
* [Dropdown breadcrumb component](dropdown-breadcrumb.component.md)

92
docs/content-services/components/content-action.component.md
View File

@@ -13,17 +13,17 @@ Adds options to a Document List actions menu for a particular content type.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Examples](#examples)
- [Conditional visibility](#conditional-visibility)
- [Conditional disabled state](#conditional-disabled-state)
- [Customizing built-in actions](#customizing-built-in-actions)
- [Error, Permission and Success callbacks](#error-permission-and-success-callbacks)
- [See also](#see-also)
* [Basic Usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Examples](#examples)
* [Conditional visibility](#conditional-visibility)
* [Conditional disabled state](#conditional-disabled-state)
* [Customizing built-in actions](#customizing-built-in-actions)
* [Error, Permission and Success callbacks](#error-permission-and-success-callbacks)
* [See also](#see-also)
## Basic Usage
@@ -82,25 +82,25 @@ export class MyView {
### Properties
| Name | Type | Default value | Description |
| ----------------------- | --------------------- | ------------- | -------------------------------------------------------------------------------------- |
| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? |
| disabled | `boolean \| Function` | false | Is the menu item disabled? |
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). |
| permission | `string` | | The permission type. |
| target | `string` | | Type of item that the action applies to. Can be "document" or "folder" |
| title | `string` | "Action" | The title of the action as shown in the menu. |
| visible | `boolean \| Function` | true | Visibility state (see examples). |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? |
| disabled | `boolean \| Function` | false | Is the menu item disabled? |
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). |
| permission | `string` | | The permission type. |
| target | `string` | | Type of item that the action applies to. Can be "document" or "folder" |
| title | `string` | "Action" | The title of the action as shown in the menu. |
| visible | `boolean \| Function` | true | Visibility state (see examples). |
### Events
| Name | Type | Description |
| --------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user selects the action from the menu. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission error occurs |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user selects the action from the menu. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission error occurs |
| success | `EventEmitter<any>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
## Details
@@ -109,18 +109,18 @@ The document actions are rendered on a dropdown menu for each items of content.
A number of built-in actions are defined to handle common use cases:
- **Download** (document)
- **lock** (document)
- **Copy** (document, folder)
- **Move** (document, folder)
- **Delete** (document, folder)
* **Download** (document)
* **lock** (document)
* **Copy** (document, folder)
* **Move** (document, folder)
* **Delete** (document, folder)
You can use one of the built-in handlers by assigning its name to the `handler` property.
(The names are case-insensitive, so `handler="download"` and `handler="DOWNLOAD"`
will trigger the same action.) You can also add your own handler by implementing the
`execute` event.
Note that you can use _both_ a built-in handler and your own `execute`
Note that you can use *both* a built-in handler and your own `execute`
function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](../../../lib/content-services/src/lib/document-list/models/document-library.model.ts) as its
parameter. For
example, with `handler="delete"` you could use `execute` to show a message with the name,
@@ -212,7 +212,7 @@ If you specify both a system handler and your own custom handler with
`(execute)="myCustomActionAfterDelete($event)"`, your handler will run after the system handler
completes successfully. A system operation is considered successful if there are no permission
or network-related errors for the system request. You can avoid permission errors simply
by disabling an item for users who don't have permission to use it (set `disableWithNoPermission="true"`).
by disabling an item for users who don't have permission to use it (set `disableWithNoPermission="true"`).
```html
<adf-document-list ...>
@@ -322,8 +322,8 @@ allow the item being copied/moved to be the destination if it is itself a folder
The `<content-action>` component allows you to control visibility with the help of the `visible` property and supports the following scenarios:
- direct value of `boolean` type
- binding to a property of the `Function` type that evaluates condition and returns `boolean` value
* direct value of `boolean` type
* binding to a property of the `Function` type that evaluates condition and returns `boolean` value
#### Using direct boolean value
@@ -363,7 +363,7 @@ export class MyComponent {
```
The code above checks the node name and evaluates to `true` only if the corresponding
node is called "For Sale.docx".
node is called "For Sale.docx".
Note that if you want to preserve `this` context within the evaluator function then
you should declare it as a lambda function:
@@ -379,8 +379,8 @@ funcName = (parameters): boolean => {
As with the `visible` property, you can control the `disabled` state with the following options:
- direct value of `boolean` type
- binding to a property of the `Function` type that evaluates a condition and returns a `boolean` value
* direct value of `boolean` type
* binding to a property of the `Function` type that evaluates a condition and returns a `boolean` value
#### Using direct value of boolean type
@@ -418,7 +418,7 @@ export class MyComponent {
}
```
The code above checks the node name, and evaluates to `true` only if the corresponding node is called "custom".
The code above checks the node name, and evaluates to `true` only if the corresponding node is called "custom".
Note that if you want to preserve the `this` context within the evaluator function,
you should declare it as a lambda function:
@@ -442,14 +442,14 @@ for details and examples.
You can define error, permission and success callbacks in much the same way as for the delete permission handling.
- The error handler callback gets the error object that was raised
- The success callback's only parameter is the translatable success message string (which could be shown in a snackbar, for example)
- The `permissionEvent` callback is the same as described above for the delete action
* The error handler callback gets the error object that was raised
* The success callback's only parameter is the translatable success message string (which could be shown in a snackbar, for example)
* The `permissionEvent` callback is the same as described above for the delete action
![Copy/move document action](../../docassets/images/document-action-copymove.png)
## See also
- [Document list component](document-list.component.md)
- [Document actions service](../services/document-actions.service.md)
- [Folder actions service](../services/folder-actions.service.md)
* [Document list component](document-list.component.md)
* [Document actions service](../services/document-actions.service.md)
* [Folder actions service](../services/folder-actions.service.md)

56
docs/content-services/components/content-metadata-card.component.md
View File

@@ -13,19 +13,19 @@ Displays and edits metadata related to a node.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Details](#details)
- [Application config presets](#application-config-presets)
- [Layout oriented config](#layout-oriented-config)
- [Displaying all properties](#displaying-all-properties)
- [Making aspects and properties read only](#making-aspects-and-properties-read-only)
- [What happens when there is a whitelisted aspect in the config but the given node doesn't relate to that aspect](#what-happens-when-there-is-a-whitelisted-aspect-in-the-config-but-the-given-node-doesnt-relate-to-that-aspect)
- [Multi value card properties](#multi-value-card-properties)
- [Use chips for multi value properties](#use-chips-for-multi-value-properties)
- [Copy to Clipboard on click](#copy-to-clipboard-on-click)
- [Search select options (ACS 7+)](#search-select-options-acs-7)
* [Basic Usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Details](#details)
* [Application config presets](#application-config-presets)
* [Layout oriented config](#layout-oriented-config)
* [Displaying all properties](#displaying-all-properties)
* [Making aspects and properties read only](#making-aspects-and-properties-read-only)
* [What happens when there is a whitelisted aspect in the config but the given node doesn't relate to that aspect](#what-happens-when-there-is-a-whitelisted-aspect-in-the-config-but-the-given-node-doesnt-relate-to-that-aspect)
* [Multi value card properties](#multi-value-card-properties)
* [Use chips for multi value properties](#use-chips-for-multi-value-properties)
* [Copy to Clipboard on click](#copy-to-clipboard-on-click)
* [Search select options (ACS 7+)](#search-select-options-acs-7)
## Basic Usage
@@ -42,15 +42,15 @@ Displays and edits metadata related to a node.
### Properties
| Name | Type | Default value | Description |
| ------------------------ | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------- |
| displayAspect | `string` | null | (optional) This flag displays desired aspect when open for the first time fields. |
| displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. |
| multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (required) The node entity to fetch metadata about |
| preset | `string` | | (required) Name of the metadata preset, which defines aspects and their properties. |
| readOnly | `boolean` | false | (optional) This flag sets the metadata in read only mode preventing changes. |
| displayDefaultProperties | `boolean` | | (optional) This flag displays/hides the metadata properties. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| displayAspect | `string` | null | (optional) This flag displays desired aspect when open for the first time fields. |
| displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. |
| multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (required) The node entity to fetch metadata about |
| preset | `string` | | (required) Name of the metadata preset, which defines aspects and their properties. |
| readOnly | `boolean` | false | (optional) This flag sets the metadata in read only mode preventing changes. |
| displayDefaultProperties | `boolean` | | (optional) This flag displays/hides the metadata properties. |
## Details
@@ -65,7 +65,7 @@ properties.
You can define different presets for the metadata component or override the default presets in
the `app.config.json` file. If nothing else is set, the **default** preset is "\*",
which will use the "indifferent" config described below.
which will use the "indifferent" config described below.
You can define as many extra presets as you need for your components.
@@ -151,7 +151,7 @@ can be "cherry picked" and grouped into an accordion drawer, along with a transl
#### Basic elements
The following config will produce one accordion group named "TRANSLATABLE_TITLE_FOR_GROUP_1",
The following config will produce one accordion group named "TRANSLATABLE_TITLE_FOR_GROUP\_1",
with all the properties from `custom:aspect` followed by the two properties (`exif:pixelXDimension`
and `exif:pixelYDimension`) from the `exif:exif` aspect and then one property (`custom:myPropertyName`) from `custom:type`:
@@ -349,9 +349,9 @@ example below shows this with an aspect-oriented config:
### Making aspects and properties read only
Whenever you have properties that you want to protect from users editing their values you can add them to your configuration to make them read only. `readOnlyAspects` will make the whole aspect and its properties non editable.
Whenever you have properties that you want to protect from users editing their values you can add them to your configuration to make them read only. `readOnlyAspects` will make the whole aspect and its properties non editable.
If you want to disable the editing for specific properties you will need to add them to the `readOnlyProperties` property.
If you want to disable the editing for specific properties you will need to add them to the `readOnlyProperties` property.
```json
"content-metadata": {
@@ -392,13 +392,13 @@ To customize the separator used by this card you can set it in your `app.config.
### Use chips for multi value properties
If you want to display chips fo each value instead of a composed string you just need to enable it in the content-metadata config.
If you want to display chips fo each value instead of a composed string you just need to enable it in the content-metadata config.
![Chips for multi value properties](../../docassets/images/metadata-chips.png)
## Copy to Clipboard on click
For easier interaction with metadata properties you can enable the Copy to Clipboard feature from your configuration in the `app.config.json` file.
For easier interaction with metadata properties you can enable the Copy to Clipboard feature from your configuration in the `app.config.json` file.
Once you have enabled this feature you will be able to double click on your metadata properties and they will get copied to your clipboard for you to use.

55
docs/content-services/components/content-node-selector-panel.component.md
View File

@@ -28,37 +28,38 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
### Properties
| Name | Type | Default value | Description |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
| currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. |
| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). |
| imageResolver | [`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. |
| isSelectionValid | [`ValidationFunction`](../../../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
| pageSize | `number` | | Number of items shown per page in the list. |
| restrictRootToCurrentFolderId | `boolean` | false | If true will restrict the search and breadcrumbs to the currentFolderId |
| selectionMode | `"single" \| "multiple"` | "single" | Define the selection mode for document list. The allowed values are single or multiple |
| where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. |
| excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes |
| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. |
| showDropdownSiteList | `boolean` | | Toggle sites list dropdown rendering |
| showFilesInResult | `void` | | Shows the files and folders in the search result |
| showSearch | `boolean` | | Toggle search input rendering |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
| currentFolderId | `string` | null | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. |
| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). |
| imageResolver | [`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. |
| isSelectionValid | [`ValidationFunction`](../../../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
| pageSize | `number` | | Number of items shown per page in the list. |
| restrictRootToCurrentFolderId | `boolean` | false | If true will restrict the search and breadcrumbs to the currentFolderId |
| selectionMode | `"single" \| "multiple"` | "single" | Define the selection mode for document list. The allowed values are single or multiple |
| where | `string` | | Custom *where* filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. |
| excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes |
| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. |
| showDropdownSiteList | `boolean` | | Toggle sites list dropdown rendering |
| showFilesInResult | `void` | | Shows the files and folders in the search result |
| showSearch | `boolean` | | Toggle search input rendering |
### Events
| Name | Type | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| navigationChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the navigation changes. |
| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` | Emitted when the user has chosen an item. |
| showingSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when search is running. |
| siteChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the select site changes. |
| currentFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` | Emitted when current folder loaded. |
| Name | Type | Description |
| --- | --- | --- |
| currentFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when current folder loaded. |
| folderLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when folder loaded. |
| navigationChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the navigation changes. |
| select | `EventEmitter<Node[]>` | Emitted when the user has chosen an item. |
| showingSearch | `EventEmitter<boolean>` | Emitted when search is running. |
| siteChange | `EventEmitter<string>` | Emitted when the select site changes. |
## Details
This component opens a _content node selector_ in its own dialog window. This behaves a lot like the
This component opens a *content node selector* in its own dialog window. This behaves a lot like the
standard file open/save dialogs used by applications to choose files. Full details are given in the
[Content Node Selector component](content-node-selector.component.md) page (this is similar but does
not manage the dialog window for you). Also, the
@@ -74,5 +75,5 @@ example of how to use this function.
## See also
- [Content Node Selector component](content-node-selector.component.md)
- [Content Node Dialog service](../services/content-node-dialog.service.md)
* [Content Node Selector component](content-node-selector.component.md)
* [Content Node Dialog service](../services/content-node-dialog.service.md)

294
docs/content-services/components/document-list.component.md
View File

@@ -13,32 +13,32 @@ Displays the documents from a repository.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [DOM Events](#dom-events)
- [Conditional visibility](#conditional-visibility)
- [Card view](#card-view)
- [Pagination strategy](#pagination-strategy)
- [Data Sources](#data-sources)
- [Setting default folder](#setting-default-folder)
- [Calling DocumentList api directly](#calling-documentlist-api-directly)
- [Underlying node object](#underlying-node-object)
- [Custom columns](#custom-columns)
- [Column templates](#column-templates)
- [Date Column](#date-column)
- [Location Column](#location-column)
- [Actions](#actions)
- [Navigation mode](#navigation-mode)
- [Header filters](#header-filters)
- [Advanced usage and customization](#advanced-usage-and-customization)
- [Image Resolver and Row Filter functions](#image-resolver-and-row-filter-functions)
- [Custom 'empty folder' template](#custom-empty-folder-template)
- [Custom 'permission denied' template](#custom-permission-denied-template)
- [Custom 'loading' template](#custom-loading-template)
- [See also](#see-also)
* [Basic Usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [DOM Events](#dom-events)
* [Conditional visibility](#conditional-visibility)
* [Card view](#card-view)
* [Pagination strategy](#pagination-strategy)
* [Data Sources](#data-sources)
* [Setting default folder](#setting-default-folder)
* [Calling DocumentList api directly](#calling-documentlist-api-directly)
* [Underlying node object](#underlying-node-object)
* [Custom columns](#custom-columns)
* [Column templates](#column-templates)
* [Date Column](#date-column)
* [Location Column](#location-column)
* [Actions](#actions)
* [Navigation mode](#navigation-mode)
* [Header filters](#header-filters)
* [Advanced usage and customization](#advanced-usage-and-customization)
* [Image Resolver and Row Filter functions](#image-resolver-and-row-filter-functions)
* [Custom 'empty folder' template](#custom-empty-folder-template)
* [Custom 'permission denied' template](#custom-permission-denied-template)
* [Custom 'loading' template](#custom-loading-template)
* [See also](#see-also)
## Basic Usage
@@ -55,52 +55,52 @@ Displays the documents from a repository.
### Properties
| Name | Type | Default value | Description |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| additionalSorting | [`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | | Defines default sorting. The format is an array of strings `[key direction, otherKey otherDirection]` i.e. `['name desc', 'nodeType asc']` or `['name asc']`. Set this value if you want a base rule to be added to the sorting apart from the one driven by the header. |
| allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list or into another file to trigger updating it's version. When false, the dropped file will be added to the current folder (ie, the one containing all the items shown in the list). See the [Upload directive](../../core/directives/upload.directive.md) for further details about how the file drop is handled. |
| contentActions | `boolean` | false | Toggles content actions for each row |
| contentActionsPosition | `string` | "right" | Position of the content actions dropdown menu. Can be set to "left" or "right". |
| contextMenuActions | `boolean` | false | Toggles context menus for each row |
| currentFolderId | `string` | null | The ID of the folder node to display or a reserved string alias for special sources |
| display | `string` | DisplayMode.List | Change the display mode of the table. Can be "list" or "gallery". |
| emptyFolderImageUrl | `string` | | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' |
| filterValue | `any` | | Initial value for filter. |
| headerFilters | `boolean` | false | Toggles the header filters mode. |
| imageResolver | `any \| null` | null | Custom function to choose image file paths to show. See the [Image Resolver Model](image-resolver.model.md) page for more information. |
| includeFields | `string[]` | | Include additional information about the node in the server request. For example: association, isLink, isLocked and others. |
| loading | `boolean` | false | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. |
| locationFormat | `string` | "/" | The default route for all the location-based columns (if declared). |
| maxItems | `number` | | Default value is stored in the user preference settings. Use this only if you are not using pagination. |
| multiselect | `boolean` | false | Toggles multiselect mode |
| navigate | `boolean` | true | Toggles navigation to folder content or file preview |
| navigationMode | `string` | | [User](../../../lib/core/pipes/user-initial.pipe.ts) interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" |
| node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) | null | The Document list will show all the nodes contained in the [NodePaging](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) entity |
| permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) page for further details and examples. |
| preselectNodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to be pre-selected. All nodes in the array are pre-selected in multi selection mode, but only the first node is pre-selected in single selection mode. |
| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. |
| rowStyleClass | `string` | | The CSS class to apply to every row |
| selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| showHeader | `string` | ShowHeaderMode.Data | Toggles the header |
| sorting | `string[] \| `[`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
| sortingMode | `string` | "server" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. |
| stickyHeader | `boolean` | false | Toggles the sticky header mode. |
| thumbnails | `boolean` | false | Show document thumbnails rather than icons |
| where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. |
| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](row-filter.model.md) page for more information. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| additionalSorting | [`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | | Defines default sorting. The format is an array of strings `[key direction, otherKey otherDirection]` i.e. `['name desc', 'nodeType asc']` or `['name asc']`. Set this value if you want a base rule to be added to the sorting apart from the one driven by the header. |
| allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list or into another file to trigger updating it's version. When false, the dropped file will be added to the current folder (ie, the one containing all the items shown in the list). See the [Upload directive](../../core/directives/upload.directive.md) for further details about how the file drop is handled. |
| contentActions | `boolean` | false | Toggles content actions for each row |
| contentActionsPosition | `string` | "right" | Position of the content actions dropdown menu. Can be set to "left" or "right". |
| contextMenuActions | `boolean` | false | Toggles context menus for each row |
| currentFolderId | `string` | null | The ID of the folder node to display or a reserved string alias for special sources |
| display | `string` | DisplayMode.List | Change the display mode of the table. Can be "list" or "gallery". |
| emptyFolderImageUrl | `string` | | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' |
| filterValue | `any` | | Initial value for filter. |
| headerFilters | `boolean` | false | Toggles the header filters mode. |
| imageResolver | `any \| null` | null | Custom function to choose image file paths to show. See the [Image Resolver Model](image-resolver.model.md) page for more information. |
| includeFields | `string[]` | | Include additional information about the node in the server request. For example: association, isLink, isLocked and others. |
| loading | `boolean` | false | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. |
| locationFormat | `string` | "/" | The default route for all the location-based columns (if declared). |
| maxItems | `number` | | Default value is stored in the user preference settings. Use this only if you are not using pagination. |
| multiselect | `boolean` | false | Toggles multiselect mode |
| navigate | `boolean` | true | Toggles navigation to folder content or file preview |
| navigationMode | `string` | | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" |
| node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) | null | The Document list will show all the nodes contained in the [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) entity |
| permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) page for further details and examples. |
| preselectNodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to be pre-selected. All nodes in the array are pre-selected in multi selection mode, but only the first node is pre-selected in single selection mode. |
| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. |
| rowStyleClass | `string` | | The CSS class to apply to every row |
| selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| showHeader | `string` | ShowHeaderMode.Data | Toggles the header |
| sorting | ` string[] \| `[`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | \['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
| sortingMode | `string` | "server" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option *does not* request the server to sort the data before delivering it. |
| stickyHeader | `boolean` | false | Toggles the sticky header mode. |
| thumbnails | `boolean` | false | Show document thumbnails rather than icons |
| where | `string` | | Filters the Node list using the *where* condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. |
| rowFilter | `RowFilter` | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](row-filter.model.md) page for more information. |
### Events
| Name | Type | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the API fails to get the Document List data |
| filterSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterSearch`](../../../lib/content-services/src/lib/search/filter-search.interface.ts)`[]>` | Emitted when a filter value is selected |
| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes |
| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node |
| nodeDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node |
| nodeSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` | Emitted when the node selection change |
| preview | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the [Viewer component](../../core/components/viewer.component.md). |
| ready | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when the Document List has loaded all items and is ready for use |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the API fails to get the Document List data |
| filterSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterSearch`](../../../lib/content-services/src/lib/search/filter-search.interface.ts)`[]>` | Emitted when a filter value is selected |
| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes |
| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node |
| nodeDblClick | `EventEmitter<NodeEntityEvent>` | Emitted when the user double-clicks a list node |
| nodeSelected | `EventEmitter<NodeEntry[]>` | Emitted when the node selection change |
| preview | `EventEmitter<NodeEntityEvent>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the Viewer component. |
| ready | `EventEmitter<NodePaging>` | Emitted when the Document List has loaded all items and is ready for use |
## Details
@@ -108,14 +108,14 @@ The properties `currentFolderId` and `node` set the initial folder shown by
the Document List. They cannot be used together, so choose the one that suits your use case
best.
The Document list will automatically show special icons for : `Smart Folder`, `Link to a Folder` and `Folder with rules` as shown below :
The Document list will automatically show special icons for : `Smart Folder`, `Link to a Folder` and `Folder with rules` as shown below :
![Document List Folders](../../docassets/images/document-list-special-folder-icon.png)
### DOM Events
Below are the DOM events the DocumentList component emits.
All of them are _bubbling_, meaning you can handle them in any component up the parent hierarchy, even if the DocumentList is wrapped by one or more other components.
All of them are *bubbling*, meaning you can handle them in any component up the parent hierarchy, even if the DocumentList is wrapped by one or more other components.
| Name | Description |
| ------------- | ---------------------------------------- |
@@ -182,7 +182,7 @@ Set the `[display]` property to "gallery" to enable card view mode:
### Pagination strategy
The Document List by default supports 2 types of pagination: [Pagination component](../../core/components/pagination.component.md) and [Infinite pagination component](../../core/components/infinite-pagination.component.md)
The Document List by default supports 2 types of pagination: [Pagination component](../../core/components/pagination.component.md) and [Infinite pagination component](../../core/components/infinite-pagination.component.md)
#### Pagination component
@@ -217,20 +217,20 @@ The unique identifier of the [`Node`](https://github.com/Alfresco/alfresco-js-ap
You can use one of the well-known reserved aliases:
- `-root-`
- `-shared-`
- `-my-`
* `-root-`
* `-shared-`
* `-my-`
#### Document List aliases
The [Document List component](document-list.component.md) also provides support for the following reserved aliases:
- `-trashcan-`,
- `-sharedlinks-`
- `-sites-`
- `-mysites-`
- `-favorites-`
- `-recent-`
* `-trashcan-`,
* `-sharedlinks-`
* `-sites-`
* `-mysites-`
* `-favorites-`
* `-recent-`
Note that due to the nature of the data, these sources do not support navigation.
You may want to handle single and double clicks yourself to perform navigation to other sources.
@@ -245,11 +245,11 @@ You can set the default location format using the `locationFormat` property to a
The default column layout for non-reserved views is:
- Icon
- Name
- Size
- Modified (date)
- Modified by
* Icon
* Name
* Size
* Modified (date)
* Modified by
**Trashcan**
@@ -262,12 +262,12 @@ The default column layout for non-reserved views is:
Default layout:
- Icon
- Name
- Location
- Size
- Deleted
- Deleted by
* Icon
* Name
* Location
* Size
* Deleted
* Deleted by
**Shared Links**
@@ -280,13 +280,13 @@ Default layout:
Default layout:
- Icon
- Name
- Location
- Size
- Modified
- Modified by
- Shared by
* Icon
* Name
* Location
* Size
* Modified
* Modified by
* Shared by
**Sites**
@@ -298,9 +298,9 @@ Default layout:
Default layout:
- Icon
- Title
- Status
* Icon
* Title
* Status
**My Sites**
@@ -312,9 +312,9 @@ Default layout:
Default layout:
- Icon
- Title
- Status
* Icon
* Title
* Status
**Favorites**
@@ -327,12 +327,12 @@ Default layout:
Default layout:
- Icon
- Name
- Location
- Size
- Modified
- Modified by
* Icon
* Name
* Location
* Size
* Modified
* Modified by
**Recent Files**
@@ -345,13 +345,13 @@ Default layout:
Default layout:
- Icon
- Name
- Location
* Icon
* Name
* Location
### Setting default folder
You can set the current folder path by assigning a value to the `currentFolderId` property.
You can set the current folder path by assigning a value to the `currentFolderId` property.
It can be either one of the well-known locations (such as **-root-**, **-shared-** or **-my-**),
or a node ID (guid).
@@ -400,12 +400,12 @@ export class FilesComponent implements OnInit {
</adf-document-list>
```
The `console.log(node)` for the `getNodeInfo` callback is just for study and debug purposes.
The `console.log(node)` for the `getNodeInfo` callback is just for study and debug purposes.
It is useful for examining other information that you can access if necessary:
![documentLibrary](../../docassets/images/documentLibrary.png)
**Important note**: for this particular scenario you must also trigger `changeDetector.detectChanges()` as in the example above.
**Important note**: for this particular scenario you must also trigger `changeDetector.detectChanges()` as in the example above.
### Calling DocumentList api directly
@@ -428,9 +428,9 @@ export class MyAppComponent {
}
```
However there may be scenarios where you need direct access to the Document List APIs.
However there may be scenarios where you need direct access to the Document List APIs.
You can get a reference to the Document List instance using the Angular **Component Interaction** API.
See the [Parent calls a ViewChild](https://angular.io/docs/ts/latest/cookbook/component-communication.html#!#parent-to-view-child)
See the [Parent calls a ViewChild](https://angular.io/docs/ts/latest/cookbook/component-communication.html#!#parent-to-view-child)
section of the Angular docs for more information.
Below is an example of getting a reference:
@@ -473,7 +473,7 @@ Now you can access Document List properties or call methods directly:
console.log(documentList.currentFolderId);
```
**Important note**:
**Important note**:\
You must not access child components any earlier in the component lifecycle than
the `AfterViewInit` state. Any UI click (buttons, links, etc.) event handlers are fine but
an earlier event like `ngOnInit` is not.
@@ -483,7 +483,7 @@ documentation for a full explanation of the component lifecycle.
### Underlying node object
The [Document List component](document-list.component.md) assigns an instance of
The [Document List component](document-list.component.md) assigns an instance of
the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) class
(defined in the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api)) as the data context
for each row. You can make use of the properties of this object when defining custom columns:
@@ -589,7 +589,7 @@ For example:
```
All the components above also participate in [Extensibility](../../user-guide/app-extensions.md)
and can be used to compose DocumentList layouts from within the plugins.
and can be used to compose DocumentList layouts from within the plugins.
### Date Column
@@ -607,16 +607,16 @@ This column displays a clickable location link pointing to the parent path of th
**Important note**:
_For granular permissions, the Location Column may or may not render the link location_
*For granular permissions, the Location Column may or may not render the link location*
You would normally use this with custom navigation or when displaying content from sources like:
- Sites
- My Sites
- Shared Links
- Recent Files
- Favorites
- Trashcan
* Sites
* My Sites
* Shared Links
* Recent Files
* Favorites
* Trashcan
...or any other location where the user needs to be able to navigate to the node parent
folder easily.
@@ -656,7 +656,7 @@ you can also define your own actions. See the
[Content Action component](content-action.component.md)
for more information and examples.
You can also use the [Context Menu directive](../../core/directives/context-menu.directive.md) from the
You can also use the [Context Menu directive](../../core/directives/context-menu.directive.md) from the
ADF Core library to show the
actions you have defined in a context menu:
@@ -711,8 +711,8 @@ You can enable Header filters in your document list simply setting to true its `
The Document List has two properties that let you modify behavior with custom
functions:
- `imageResolver` - Specifies a function to choose image file paths for icons and thumbnails.
- `rowFilter` - Selects whether a row is shown or hidden according to its data content.
* `imageResolver` - Specifies a function to choose image file paths for icons and thumbnails.
* `rowFilter` - Selects whether a row is shown or hidden according to its data content.
See the [Image Resolver Model](../models/image-resolver.model.md)
and [Row Filter Model](../models/row-filter.model.md) pages for details of how to
@@ -782,18 +782,18 @@ This will give the following output:
## See also
- [Datatable component](../../core/components/datatable.component.md)
- [Data column component](../../core/components/data-column.component.md)
- [Pagination component](../../core/components/pagination.component.md)
- [Infinite pagination component](../../core/components/infinite-pagination.component.md)
- [Sites dropdown component](sites-dropdown.component.md)
- [Metadata indicators](../../user-guide/metadata-indicators.md)
- [Nodes api service](../../core/services/nodes-api.service.md)
- [Breadcrumb component](breadcrumb.component.md)
- [Content action component](content-action.component.md)
- [Content node selector component](content-node-selector.component.md)
- [Document list service](../services/document-list.service.md)
- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md)
- [Permissions style model](../models/permissions-style.model.md)
- [Version manager component](version-manager.component.md)
- [Viewer component](../../core/components/viewer.component.md)
* [Datatable component](../../core/components/datatable.component.md)
* [Data column component](../../core/components/data-column.component.md)
* [Pagination component](../../core/components/pagination.component.md)
* [Infinite pagination component](../../core/components/infinite-pagination.component.md)
* [Sites dropdown component](sites-dropdown.component.md)
* [Metadata indicators](../../user-guide/metadata-indicators.md)
* [Nodes api service](../../core/services/nodes-api.service.md)
* [Breadcrumb component](breadcrumb.component.md)
* [Content action component](content-action.component.md)
* [Content node selector component](content-node-selector.component.md)
* [Document list service](../services/document-list.service.md)
* [Dropdown breadcrumb component](dropdown-breadcrumb.component.md)
* [Permissions style model](../models/permissions-style.model.md)
* [Version manager component](version-manager.component.md)
* [Viewer component](../../core/components/viewer.component.md)

28
docs/content-services/components/dropdown-breadcrumb.component.md
View File

@@ -24,28 +24,28 @@ Indicates the current position within a navigation hierarchy using a dropdown me
### Properties
| Name | Type | Default value | Description |
| ---------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. |
| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. |
| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. |
| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. |
| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. |
| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. |
| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. |
| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
### Events
| Name | Type | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| 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
Although this component inherits the `maxItems` property from the [Breadcrumb component,](breadcrumb.component.md) the
"crumbs" are _always_ shown on a menu. By contrast, the [Breadcrumb component](breadcrumb.component.md) only falls back
to a menu when its maximum number of nodes is exceeded.
"crumbs" are *always* shown on a menu. By contrast, the [Breadcrumb component](breadcrumb.component.md) only falls back
to a menu when its maximum number of nodes is exceeded.
## See also
- [Document list component](document-list.component.md)
- [Breadcrumb component](breadcrumb.component.md)
* [Document list component](document-list.component.md)
* [Breadcrumb component](breadcrumb.component.md)

16
docs/content-services/components/file-uploading-dialog.component.md
View File

@@ -19,14 +19,14 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are
### Properties
| Name | Type | Default value | Description |
| -------- | -------- | ------------- | ------------------------------------------ |
| position | `string` | "right" | Dialog position. Can be 'left' or 'right'. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| position | `string` | "right" | Dialog position. Can be 'left' or 'right'. |
### Events
| Name | Type | Description |
| ----- | ----------------------------------------------------------------- | --------------------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file in the list has an error. |
## Details
@@ -37,6 +37,6 @@ This component should be used in combination with the
## See also
- [Upload button component](upload-button.component.md)
- [Upload drag area component](upload-drag-area.component.md)
- [File upload error pipe](../pipes/file-upload-error.pipe.md)
* [Upload button component](upload-button.component.md)
* [Upload drag area component](upload-drag-area.component.md)
* [File upload error pipe](../pipes/file-upload-error.pipe.md)

14
docs/content-services/components/like.component.md
View File

@@ -21,17 +21,17 @@ Allows a user to add "likes" to an item.
### Properties
| Name | Type | Default value | Description |
| ------ | -------- | ------------- | --------------------------------------- |
| nodeId | `string` | | Identifier of a node to apply likes to. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodeId | `string` | | Identifier of a node to apply likes to. |
### Events
| Name | Type | Description |
| ---------- | ----------------------------------------------------------------- | ------------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. |
## See also
- [Rating component](rating.component.md)
- [Rating service](../services/rating.service.md)
* [Rating component](rating.component.md)
* [Rating service](../services/rating.service.md)

16
docs/content-services/components/permission-list.component.md
View File

@@ -20,8 +20,8 @@ Shows node permissions as a table.
### [Transclusions](../../user-guide/transclusion.md)
When the list is empty, the contents will simply say "No permissions" by default,
but you can also supply your own content:
When the list is empty, the contents will simply say "No permissions" by default,
but you can also supply your own content:
```html
<adf-permission-list [nodeId]="nodeId">
@@ -35,15 +35,15 @@ but you can also supply your own content:
### Properties
| Name | Type | Default value | Description |
| ------ | -------- | ------------- | -------------------------------------------------- |
| nodeId | `string` | "" | ID of the node whose permissions you want to show. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodeId | `string` | "" | ID of the node whose permissions you want to show. |
### Events
| Name | Type | Description |
| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`>` | Emitted when the permission is updated. |
## Details

14
docs/content-services/components/rating.component.md
View File

@@ -32,17 +32,17 @@ If the average is decimal number it will be rounded.
### Properties
| Name | Type | Default value | Description |
| ------ | -------- | ------------- | ---------------------------------------------- |
| nodeId | `string` | | Identifier of the node to apply the rating to. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodeId | `string` | | Identifier of the node to apply the rating to. |
### Events
| Name | Type | Description |
| ---------- | ----------------------------------------------------------------- | ------------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. |
## See also
- [Like component](like.component.md)
- [Rating service](../services/rating.service.md)
* [Like component](like.component.md)
* [Rating service](../services/rating.service.md)

8
docs/content-services/components/search-chip-list.component.md
View File

@@ -22,7 +22,7 @@ Displays search criteria as a set of "chips".
### Properties
| Name | Type | Default value | Description |
| ------------ | --------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------- |
| clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. |
| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. |
| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. |

26
docs/content-services/components/search-control.component.md
View File

@@ -40,22 +40,22 @@ You can show your own custom template when no results are found for the search:
### Properties
| Name | Type | Default value | Description |
| -------------------- | --------- | ------------- | ------------------------------------------------------------------------------------------ |
| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. |
| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. |
| highlight | `boolean` | false | Toggles highlighting of the search term in the results. |
| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). |
| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. |
| liveSearchMaxResults | `number` | 5 | Maximum number of results to show in the live search. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. |
| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. |
| highlight | `boolean` | false | Toggles highlighting of the search term in the results. |
| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). |
| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. |
| liveSearchMaxResults | `number` | 5 | Maximum number of results to show in the live search. |
### Events
| Name | Type | Description |
| ------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file item from the list of "find-as-you-type" results is selected. |
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. |
| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |
| Name | Type | Description |
| --- | --- | --- |
| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file item from the list of "find-as-you-type" results is selected. |
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. |
| submit | `EventEmitter<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |
## Details

61
docs/content-services/components/search-filter.component.md
View File

@@ -11,17 +11,18 @@ Represents a main container component for custom search and faceted search setti
## Contents
- [Basic usage](#basic-usage)
- [Details](#details)
- [Configuration](#configuration)
- [Extra fields and filter queries](#extra-fields-and-filter-queries)
- [Sorting](#sorting)
- [Categories and widgets](#categories-and-widgets)
- [Facet Fields](#facet-fields)
- [Facet Queries](#facet-queries)
- [Facet Intervals](#facet-intervals)
- [Highlight](#highlight)
- [See also](#see-also)
* [Basic usage](#basic-usage)
* [Properties](#properties)
* [Details](#details)
* [Configuration](#configuration)
* [Extra fields and filter queries](#extra-fields-and-filter-queries)
* [Sorting](#sorting)
* [Categories and widgets](#categories-and-widgets)
* [Facet Fields](#facet-fields)
* [Facet Queries](#facet-queries)
* [Facet Intervals](#facet-intervals)
* [Highlight](#highlight)
* [See also](#see-also)
## Basic usage
@@ -44,9 +45,9 @@ to build and execute the query.
You may find it useful to check out the following resources for background information
before customizing the search UI:
- [Search API](https://docs.alfresco.com/5.2/concepts/search-api.html)
- [Alfresco Full Text Search Reference](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-intro.html)
- [ACS API Explorer](https://api-explorer.alfresco.com/api-explorer/#!/search/search)
* [Search API](https://docs.alfresco.com/5.2/concepts/search-api.html)
* [Alfresco Full Text Search Reference](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-intro.html)
* [ACS API Explorer](https://api-explorer.alfresco.com/api-explorer/#!/search/search)
### Configuration
@@ -166,14 +167,14 @@ settings:
}
```
Note that the entries of the `filterQueries` array are joined using the `AND` operator.
Note that the entries of the `filterQueries` array are joined using the `AND` operator.
### Sorting
The Sorting configuration section consists of two blocks:
- `options`: a list of items that users can select from
- `defaults`: predefined sorting to use by default
* `options`: a list of items that users can select from
* `defaults`: predefined sorting to use by default
```json
{
@@ -258,7 +259,7 @@ page for full details of how to do this.
Each type of [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) has its own settings.
For example Number editors may parse minimum and maximum values, while Text editors can support value formats or length constraints.
You can use `component.settings` to pass any information to a [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) using the
You can use `component.settings` to pass any information to a [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) using the
[`SearchWidgetSettings`](../../../lib/content-services/src/lib/search/search-widget-settings.interface.ts) interface:
```ts
@@ -287,9 +288,9 @@ export interface SearchWidgetSettings {
}
```
Every field declared within the `facetFields` group is presented by a separate collapsible category at runtime.
Every field declared within the `facetFields` group is presented by a separate collapsible category at runtime.
By default, users see only the top 5 entries.
By default, users see only the top 5 entries.
If there are more than 5 entries, a button to show more items is displayed to let the user move to
the next block of results.
@@ -488,13 +489,13 @@ then be added in each node entry response. An example partial response is shown
## See also
- [Search Query Builder service](../services/search-query-builder.service.md)
- [Search Chip List Component](search-chip-list.component.md)
- [Search Sorting Picker Component](search-sorting-picker.component.md)
- [Search Widget Interface](../interfaces/search-widget.interface.md)
- [Search check list component](search-check-list.component.md)
- [Search date range component](search-date-range.component.md)
- [Search number range component](search-number-range.component.md)
- [Search radio component](search-radio.component.md)
- [Search slider component](search-slider.component.md)
- [Search text component](search-text.component.md)
* [Search Query Builder service](../services/search-query-builder.service.md)
* [Search Chip List Component](search-chip-list.component.md)
* [Search Sorting Picker Component](search-sorting-picker.component.md)
* [Search Widget Interface](../interfaces/search-widget.interface.md)
* [Search check list component](search-check-list.component.md)
* [Search date range component](search-date-range.component.md)
* [Search number range component](search-number-range.component.md)
* [Search radio component](search-radio.component.md)
* [Search slider component](search-slider.component.md)
* [Search text component](search-text.component.md)

48
docs/content-services/components/search.component.md
View File

@@ -7,19 +7,19 @@ Last reviewed: 2019-01-16
# [Search component](../../../lib/content-services/src/lib/search/components/search.component.ts "Defined in search.component.ts")
Searches items for supplied search terms.
Searches items for supplied search terms.
## Contents
- [Basic usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Customise Search Results](#customise-search-results)
- [Attach an input field to the search](#attach-an-input-field-to-the-search)
- [Custom search configuration](#custom-search-configuration)
- [See Also](#see-also)
* [Basic usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Customise Search Results](#customise-search-results)
* [Attach an input field to the search](#attach-an-input-field-to-the-search)
* [Custom search configuration](#custom-search-configuration)
* [See Also](#see-also)
## Basic usage
@@ -34,19 +34,19 @@ Searches items for supplied search terms.
### Properties
| Name | Type | Default value | Description |
| ----------- | ------------------ | ------------- | --------------------------------------------------------------------------------------------------------------- |
| displayWith | `Function \| null` | null | Function that maps an option's value to its display value in the trigger. |
| maxResults | `number` | 20 | Maximum number of results to show in the search. |
| searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. |
| skipResults | `number` | 0 | Number of results to skip from the results pagination. |
| classList | `void` | | CSS class for display. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| displayWith | `Function \| null` | null | Function that maps an option's value to its display value in the trigger. |
| maxResults | `number` | 20 | Maximum number of results to show in the search. |
| searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. |
| skipResults | `number` | 0 | Number of results to skip from the results pagination. |
| classList | `void` | | CSS class for display. |
### Events
| Name | Type | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when search results have fully loaded. |
## Details
@@ -71,11 +71,11 @@ You can add a custom template to show the search results when once they are load
<!-- {% endraw %} -->
The results are provided via the [$implicit variable of angular2](https://angular.io/api/common/NgTemplateOutlet) and can be accessed via the sugar syntax 'let-yourChosenName'. The example above will give results like the following:
The results are provided via the [$implicit variable of angular2](https://angular.io/api/common/NgTemplateOutlet) and can be accessed via the sugar syntax 'let-yourChosenName'. The example above will give results like the following:
![adf-search-control](../../docassets/images/search-component-simple-template.png)
However, you can use a more complex template if necessary:
However, you can use a more complex template if necessary:
<!-- {% raw %} -->
@@ -160,5 +160,5 @@ customize your search.
## See Also
- [Search configuration interface](../../core/interfaces/search-configuration.interface.md)
- [Search configuration service](../../core/services/search-configuration.service.md)
* [Search configuration interface](../../core/interfaces/search-configuration.interface.md)
* [Search configuration service](../../core/services/search-configuration.service.md)

18
docs/content-services/components/sites-dropdown.component.md
View File

@@ -23,16 +23,16 @@ Displays a dropdown menu to show and interact with the sites of the current user
### Properties
| Name | Type | Default value | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| hideMyFiles | `boolean` | false | Hide the "My Files" option. |
| placeholder | `string` | | Text or a translation key to act as a placeholder. Default value is the key "DROPDOWN.PLACEHOLDER_LABEL". |
| relations | `string` | | Filter for the results of the sites query. Possible values are "members" and "containers". When "members" is used, the site list will be restricted to the sites that the user is a member of. |
| siteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. |
| value | `string` | null | Id of the selected site |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| hideMyFiles | `boolean` | false | Hide the "My Files" option. |
| placeholder | `string` | | Text or a translation key to act as a placeholder. Default value is the key "DROPDOWN.PLACEHOLDER_LABEL". |
| relations | `string` | | Filter for the results of the sites query. Possible values are "members" and "containers". When "members" is used, the site list will be restricted to the sites that the user is a member of. |
| siteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. |
| value | `string` | null | Id of the selected site |
### Events
| Name | Type | Description |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` | Emitted when the user selects a site. When the default option is selected, an empty model is emitted. |

16
docs/content-services/components/tag-actions.component.md
View File

@@ -23,14 +23,14 @@ Shows available actions for tags.
### Properties
| Name | Type | Default value | Description |
| ------ | -------- | ------------- | ------------------------- |
| nodeId | `string` | | The identifier of a node. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodeId | `string` | | The identifier of a node. |
### Events
| Name | Type | Description |
| ---------- | ----------------------------------------------------------------- | ----------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an action is chosen. |
| successAdd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is added successfully. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an action is chosen. |
| successAdd | `EventEmitter<any>` | Emitted when a tag is added successfully. |

6
docs/content-services/components/tag-list.component.md
View File

@@ -15,10 +15,10 @@ Shows tags for an item.
### Events
| Name | Type | Description |
| ------ | ----------------------------------------------------------------- | ------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. |
## See Also
- [Tag service](../services/tag.service.md)
* [Tag service](../services/tag.service.md)

12
docs/content-services/components/tag-node-list.component.md
View File

@@ -23,13 +23,13 @@ Shows tags for a node.
### Properties
| Name | Type | Default value | Description |
| ---------- | --------- | ------------- | ------------------------- |
| nodeId | `string` | | The identifier of a node. |
| showDelete | `boolean` | true | Show delete button |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodeId | `string` | | The identifier of a node. |
| showDelete | `boolean` | true | Show delete button |
### Events
| Name | Type | Description |
| ------- | ----------------------------------------------------------------- | ------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. |

12
docs/content-services/components/tree-view.component.md
View File

@@ -23,13 +23,13 @@ Shows the folder and subfolders of a node as a tree view.
### Properties
| Name | Type | Default value | Description |
| ------ | -------- | ------------- | ---------------------------------- |
| nodeId | `string` | | Identifier of the node to display. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodeId | `string` | | Identifier of the node to display. |
### Events
| Name | Type | Description |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an invalid node id is given. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an invalid node id is given. |
| nodeClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` | Emitted when a node in the tree view is clicked. |

50
docs/content-services/components/upload-button.component.md
View File

@@ -27,31 +27,31 @@ Activates a file upload.
### Properties
| Name | Type | Default value | Description |
| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' |
| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| multipleFiles | `boolean` | false | Allows/disallows multiple files |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| staticTitle | `string` | | Defines the text of the upload button. |
| tooltip | `string` | null | Custom tooltip text. |
| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). |
| versioning | `boolean` | false | Toggles versioning. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' |
| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| multipleFiles | `boolean` | false | Allows/disallows multiple files |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| staticTitle | `string` | | Defines the text of the upload button. |
| tooltip | `string` | null | Custom tooltip text. |
| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). |
| versioning | `boolean` | false | Toggles versioning. |
### Events
| Name | Type | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
| Name | Type | Description |
| --- | --- | --- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | `EventEmitter<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | `EventEmitter<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
## Details
@@ -59,7 +59,7 @@ Activates a file upload.
You can show a notification error when the user doesn't have the right permission to perform
the action. The component emits a `permissionEvent` when the user does not have delete permission.
You can subscribe to this event from your component and use the
You can subscribe to this event from your component and use the
[Notification service](../../core/services/notification.service.md) to show a message.
```html
@@ -85,5 +85,5 @@ export class MyComponent {
## See also
- [Upload Version Button component](upload-version-button.component.md)
- [File upload error pipe](../pipes/file-upload-error.pipe.md)
* [Upload Version Button component](upload-version-button.component.md)
* [File upload error pipe](../pipes/file-upload-error.pipe.md)

64
docs/content-services/components/upload-drag-area.component.md
View File

@@ -11,15 +11,15 @@ Adds a drag and drop area to upload files to ACS.
## Contents
- [Basic Usage](#basic-usage)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Intercepting uploads](#intercepting-uploads)
- [Example](#example)
- [See also](#see-also)
* [Basic Usage](#basic-usage)
* [Transclusions](#transclusions)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Intercepting uploads](#intercepting-uploads)
* [Example](#example)
* [See also](#see-also)
## Basic Usage
@@ -59,37 +59,37 @@ as the drag/drop target:
### Properties
| Name | Type | Default value | Description |
| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| versioning | `boolean` | false | Toggles versioning. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| versioning | `boolean` | false | Toggles versioning. |
### Events
| Name | Type | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
| Name | Type | Description |
| --- | --- | --- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | `EventEmitter<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | `EventEmitter<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
## Details
### Intercepting uploads
You can intercept the upload process using the `beginUpload` event.
You can intercept the upload process using the `beginUpload` event.
The event has a type of [`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts) and provides the following APIs:
- **files**: accesses the [`FileInfo`](../../../lib/core/utils/file-utils.ts) objects that are prepared for the upload
- **pauseUpload**: pauses the upload and performs additional tasks, like showing the confirmation dialog
- **resumeUpload**: resumes the upload process
* **files**: accesses the [`FileInfo`](../../../lib/core/utils/file-utils.ts) objects that are prepared for the upload
* **pauseUpload**: pauses the upload and performs additional tasks, like showing the confirmation dialog
* **resumeUpload**: resumes the upload process
### Example
@@ -139,6 +139,6 @@ This could be either a selection of 2 or more files, or a folder with multiple e
## See also
- [File uploading dialog component](file-uploading-dialog.component.md)
- [Upload button component](upload-button.component.md)
- [File upload error pipe](../pipes/file-upload-error.pipe.md)
* [File uploading dialog component](file-uploading-dialog.component.md)
* [Upload button component](upload-button.component.md)
* [File upload error pipe](../pipes/file-upload-error.pipe.md)

50
docs/content-services/components/upload-version-button.component.md
View File

@@ -29,40 +29,40 @@ to enrich the features and decrease the restrictions currently applied to node v
### Properties
| Name | Type | Default value | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' |
| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| multipleFiles | `boolean` | false | Allows/disallows multiple files |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (**Required**) The node to be versioned. |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| staticTitle | `string` | | Defines the text of the upload button. |
| tooltip | `string` | null | Custom tooltip text. |
| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). |
| versioning | `boolean` | false | Toggles versioning. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' |
| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| multipleFiles | `boolean` | false | Allows/disallows multiple files |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (**Required**) The node to be versioned. |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| staticTitle | `string` | | Defines the text of the upload button. |
| tooltip | `string` | null | Custom tooltip text. |
| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). |
| versioning | `boolean` | false | Toggles versioning. |
### Events
| Name | Type | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
| Name | Type | Description |
| --- | --- | --- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | `EventEmitter<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | `EventEmitter<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
## Details
This component extends the [Upload Button component](upload-button.component.md). The
properties and events are the same except for the `node` property that specifies the node
to be versioned (this is a _required_ input parameter). However, some properties don't make
to be versioned (this is a *required* input parameter). However, some properties don't make
sense when applied to the [Upload Version Button component](upload-version-button.component.md) so they are simply ignored.
## See also
- [Upload Button component](upload-button.component.md)
* [Upload Button component](upload-button.component.md)

8
docs/content-services/components/version-comparison.component.md
View File

@@ -24,7 +24,7 @@ Displays the side by side comparison between the current target node (type, name
### Properties
| Name | Type | Default value | Description |
| -------------- | -------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- |
| newFileVersion | `File` | | New file for updating current version. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| newFileVersion | `File` | | New file for updating current version. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node. |

26
docs/content-services/components/version-list.component.md
View File

@@ -19,21 +19,21 @@ Displays the version history of a node in a [Version Manager component](version-
### Properties
| Name | Type | Default value | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------- |
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| allowViewVersions | `boolean` | true | Enable/disable viewing a version of the current node. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. |
| showActions | `boolean` | true | Toggles showing/hiding of version actions |
| showComments | `boolean` | true | Toggles showing/hiding of comments |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| allowViewVersions | `boolean` | true | Enable/disable viewing a version of the current node. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. |
| showActions | `boolean` | true | Toggles showing/hiding of version actions |
| showComments | `boolean` | true | Toggles showing/hiding of comments |
### Events
| Name | Type | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- |
| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is deleted |
| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is restored |
| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when viewing a version |
| Name | Type | Description |
| --- | --- | --- |
| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is deleted |
| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is restored |
| viewVersion | `EventEmitter<string>` | Emitted when viewing a version |
## Details
@@ -48,4 +48,4 @@ If you want show readonly version list you set this component with showActions f
## See also
- [Version manager component](version-manager.component.md)
* [Version manager component](version-manager.component.md)

30
docs/content-services/components/version-manager.component.md
View File

@@ -27,22 +27,22 @@ Displays the version history of a node with the ability to upload a new version.
### Properties
| Name | Type | Default value | Description |
| --------------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| newFileVersion | `File` | | New file for updating current version. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node to manage version history. |
| showComments | `boolean` | true | Toggles showing/hiding of comments. |
| showVersionComparison | `boolean` | false | Toggles showing/hiding the [version comparison component](../../content-services/components/version-comparison.component.md). |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| newFileVersion | `File` | | New file for updating current version. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node to manage version history. |
| showComments | `boolean` | true | Toggles showing/hiding of comments. |
| showVersionComparison | `boolean` | false | Toggles showing/hiding the [version comparison component](../../content-services/components/version-comparison.component.md). |
### Events
| Name | Type | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- |
| uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when an cancelling during upload. |
| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when an error occurs during upload. |
| uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a file is uploaded successfully. |
| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when viewing a version. |
| Name | Type | Description |
| --- | --- | --- |
| uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when an cancelling during upload. |
| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when an error occurs during upload. |
| uploadSuccess | `EventEmitter<Node>` | Emitted when a file is uploaded successfully. |
| viewVersion | `EventEmitter<string>` | Emitted when viewing a version. |
## Details
@@ -56,5 +56,5 @@ Each version has a context menu on the right, with the following actions.
## See also
- [Version list component](version-list.component.md)
- [Document list component](document-list.component.md)
* [Version list component](version-list.component.md)
* [Document list component](document-list.component.md)

30
docs/content-services/components/version-upload.component.md
View File

@@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2020-11-06
---
# [Version Upload component](../../../lib/content-services/src/lib/version-manager/version-upload.component.ts "Defined in version-list.component.ts")
# [Version Upload component](../../../lib/content-services/src/lib/version-manager/version-upload.component.ts "Defined in version-upload.component.ts")
Displays the new version's minor/major changes and the optional comment of a node in a [Version Manager component](version-manager.component.md).
@@ -19,22 +19,22 @@ Displays the new version's minor/major changes and the optional comment of a nod
### Properties
| Name | Type | Default value | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------- |
| showUploadButton | `boolean` | true | Toggles showing/hiding the upload button. |
| showCancelButton | `boolean` | true | Toggles showing/hiding the cancel button. |
| newFileVersion | `File` | | Used to create a new version of the current node. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| newFileVersion | `File` | | New file for updating current version. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. |
| showCancelButton | `boolean` | true | Toggles showing/hiding of cancel button. |
| showUploadButton | `boolean` | true | Toggles showing/hiding upload button. |
### Events
| Name | Type | Description |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter) | Emitted when a new version is successfully uploaded |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter) | Emitted when a new version throws an error |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter) | Emitted when cancelling uploading a new version |
| versionChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the type of the new version is picked (minor/major) |
| commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the comment of the new version has changed. |
| Name | Type | Description |
| --- | --- | --- |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an cancelling during upload. |
| commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the comment is changed. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
| versionChanged | `EventEmitter<boolean>` | Emitted when the version is changed. |
## Details
@@ -43,4 +43,4 @@ load and displays the new node's version choice - minor/major & comment.
## See also
- [Version manager component](version-manager.component.md)
* [Version manager component](version-manager.component.md)

44
docs/content-services/components/webscript.component.md
View File

@@ -11,14 +11,14 @@ Provides access to Webscript features.
## Contents
- [Basic usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Webscript View HTML example](#webscript-view-html-example)
- [Webscript View DATATABLE example](#webscript-view-datatable-example)
- [Webscript View JSON example](#webscript-view-json-example)
* [Basic usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Webscript View HTML example](#webscript-view-html-example)
* [Webscript View DATATABLE example](#webscript-view-datatable-example)
* [Webscript View JSON example](#webscript-view-json-example)
## Basic usage
@@ -62,19 +62,19 @@ export class AppComponent {
### Properties
| Name | Type | Default value | Description |
| ----------- | --------- | ------------- | -------------------------------------------------------------------------------------------------------------- |
| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" |
| contextRoot | `string` | "alfresco" | Path where the application is deployed |
| scriptArgs | `any` | | Arguments to pass to the webscript. |
| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). |
| servicePath | `string` | "service" | Path that the webscript service is mapped to. |
| showData | `boolean` | true | Toggles whether to show or hide the data. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" |
| contextRoot | `string` | "alfresco" | Path where the application is deployed |
| scriptArgs | `any` | | Arguments to pass to the webscript. |
| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). |
| servicePath | `string` | "service" | Path that the webscript service is mapped to. |
| showData | `boolean` | true | Toggles whether to show or hide the data. |
### Events
| Name | Type | Description |
| ------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<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. |
## Details
@@ -96,7 +96,7 @@ This sample Web Scripts reside in your Alfresco Server. You can access the folde
</adf-webscript-get>
```
![Custom columns](../../docassets/images/HTML.png)
![Custom columns](../../docassets/images/HTML.png)
### Webscript View DATATABLE example
@@ -114,7 +114,7 @@ This sample demonstrates how to implement a [Webscript component](webscript.comp
</adf-webscript-get>
```
If you want to show the result from a webscript inside a
If you want to show the result from a webscript inside a
[datatable component](../../core/components/datatable.component.md)
you have to return the data structure below (subdivided into data and
schema) from the GET method of the webscript:
@@ -124,7 +124,7 @@ data: [],
schema: []
```
Here is an example:
Here is an example:
```ts
data: [
@@ -144,7 +144,7 @@ schema: [{
}]
```
Alternatively, you can send just the array data and the component will create a schema for you:
Alternatively, you can send just the array data and the component will create a schema for you:
```ts
data: [

10
docs/content-services/dialogs/library.dialog.md
View File

@@ -25,10 +25,10 @@ Creates a new Content Services document library/site.
### Events
| Name | Type | Description |
| ------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the new library is created successfully. The event parameter is a [SiteEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md) object with the details of the newly-created library. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the new library is created successfully. The event parameter is a SiteEntry object with the details of the newly-created library. |
## Details
@@ -39,4 +39,4 @@ section of the Content Services documentation for more information.
## See also
- [Sites dropdown component](../components/sites-dropdown.component.md)
* [Sites dropdown component](../components/sites-dropdown.component.md)

8
docs/content-services/directives/content-node-share.directive.md
View File

@@ -33,10 +33,10 @@ Creates and manages public shared links for files.
### Properties
| Name | Type | Default value | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------- |
| baseShareUrl | `string` | | Prefix to add to the generated link. |
| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to share. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| baseShareUrl | `string` | | Prefix to add to the generated link. |
| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to share. |
## Details

16
docs/content-services/directives/file-draggable.directive.md
View File

@@ -38,16 +38,16 @@ Some sample CSS to show the drag and drop area:
### Properties
| Name | Type | Default value | Description |
| ------- | --------- | ------------- | --------------------------------------------- |
| enabled | `boolean` | true | Enables/disables drag-and-drop functionality. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| enabled | `boolean` | true | Enables/disables drag-and-drop functionality. |
### Events
| Name | Type | Description |
| ------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<File[]>` | Emitted when one or more files are dragged and dropped onto the draggable element. |
| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a directory is dragged and dropped onto the draggable element. |
| Name | Type | Description |
| --- | --- | --- |
| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<File[]>` | Emitted when one or more files are dragged and dropped onto the draggable element. |
| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a directory is dragged and dropped onto the draggable element. |
## Details
@@ -75,4 +75,4 @@ export class SomeComponent implements OnInit {
## See also
- [Upload Drag Area component](../components/upload-drag-area.component.md)
* [Upload Drag Area component](../components/upload-drag-area.component.md)

20
docs/content-services/directives/folder-create.directive.md
View File

@@ -30,18 +30,18 @@ Creates folders.
### Properties
| Name | Type | Default value | Description |
| ------------ | -------- | ------------- | ------------------------------------------------------------------ |
| nodeType | `string` | "cm:folder" | Type of node to create. |
| parentNodeId | `string` | | Parent folder where the new folder will be located after creation. |
| title | `string` | null | Title of folder creation dialog. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodeType | `string` | "cm:folder" | Type of node to create. |
| parentNodeId | `string` | | Parent folder where the new folder will be located after creation. |
| title | `string` | null | Title of folder creation dialog. |
### Events
| Name | Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. |
## Details
@@ -52,4 +52,4 @@ then the dialog will emit a `success` event when it closes.
## See also
- [Folder Edit directive](folder-edit.directive.md)
* [Folder Edit directive](folder-edit.directive.md)

16
docs/content-services/directives/folder-edit.directive.md
View File

@@ -30,17 +30,17 @@ Allows folders to be edited.
### Properties
| Name | Type | Default value | Description |
| ------ | -------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------- |
| folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. |
| title | `string` | null | Title of folder edit dialog. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. |
| title | `string` | null | Title of folder edit dialog. |
### Events
| Name | Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. |
## Details

12
docs/content-services/directives/inherited-button.directive.md
View File

@@ -22,15 +22,15 @@ Update the current node by adding/removing the inherited permissions.
### Properties
| Name | Type | Default value | Description |
| ------ | -------- | ------------- | --------------------------------------------------- |
| nodeId | `string` | | ID of the node to add/remove inherited permissions. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodeId | `string` | | ID of the node to add/remove inherited permissions. |
### Events
| Name | Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated. |
## Details

6
docs/content-services/directives/node-lock.directive.md
View File

@@ -21,9 +21,9 @@ Locks or unlocks a node.
### Properties
| Name | Type | Default value | Description |
| ---- | -------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------- |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock/unlock. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock/unlock. |
## Details

32
docs/content-services/interfaces/search-widget.interface.md
View File

@@ -11,14 +11,14 @@ Specifies required properties for [Search filter component](../components/search
## Contents
- [Basic usage](#basic-usage)
- [Properties](#properties)
- [Details](#details)
- [Implementing a custom widget](#implementing-a-custom-widget)
- [Reading external settings](#reading-external-settings)
- [Updating the final query](#updating-the-final-query)
- [Registering a custom widget](#registering-a-custom-widget)
- [See also](#see-also)
* [Basic usage](#basic-usage)
* [Properties](#properties)
* [Details](#details)
* [Implementing a custom widget](#implementing-a-custom-widget)
* [Reading external settings](#reading-external-settings)
* [Updating the final query](#updating-the-final-query)
* [Registering a custom widget](#registering-a-custom-widget)
* [See also](#see-also)
## Basic usage
@@ -157,7 +157,7 @@ export class MyAppOrComponent {
}
```
When you have done this, you can declare your [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) in `app.config.json`
When you have done this, you can declare your [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) in `app.config.json`
and pass custom attributes, if your component supports them:
```json
@@ -184,10 +184,10 @@ and pass custom attributes, if your component supports them:
## See also
- [Search filter component](../components/search-filter.component.md)
- [Search check list component](../components/search-check-list.component.md)
- [Search date range component](../components/search-date-range.component.md)
- [Search number range component](../components/search-number-range.component.md)
- [Search radio component](../components/search-radio.component.md)
- [Search slider component](../components/search-slider.component.md)
- [Search text component](../components/search-text.component.md)
* [Search filter component](../components/search-filter.component.md)
* [Search check list component](../components/search-check-list.component.md)
* [Search date range component](../components/search-date-range.component.md)
* [Search number range component](../components/search-number-range.component.md)
* [Search radio component](../components/search-radio.component.md)
* [Search slider component](../components/search-slider.component.md)
* [Search text component](../components/search-text.component.md)

66
docs/content-services/services/audit.service.md
View File

@@ -13,44 +13,44 @@ Manages Audit apps and entries.
### Methods
- **deleteAuditEntries**(auditApplicationId: `string`, where: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
* **deleteAuditEntries**(auditApplicationId: `string`, where: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Permanently delete audit entries for an audit application.
- _auditApplicationId:_ `string` - The identifier of an audit application.
- _where:_ `string` - Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
- **deleteAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
* *auditApplicationId:* `string` - The identifier of an audit application.
* *where:* `string` - Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids.
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
* **deleteAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Permanently delete an audit entry.
- _auditApplicationId:_ `string` - The identifier of an audit application.
- _auditEntryId:_ `string` - The identifier of an audit entry.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
- **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)`>`<br/>
* *auditApplicationId:* `string` - The identifier of an audit application.
* *auditEntryId:* `string` - The identifier of an audit entry.
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
* **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)`>`<br/>
Get audit application info.
- _auditApplicationId:_ `string` - The identifier of an audit application.
- _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)`>`<br/>
* *auditApplicationId:* `string` - The identifier of an audit application.
* *opts:* `any` - (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)`>`<br/>
List audit applications.
- _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)`>`<br/>
* *opts:* `any` - (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)`>`<br/>
List audit entries for an audit application.
- _auditApplicationId:_ `string` - The identifier of an audit application.
- _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)`>`<br/>
* *auditApplicationId:* `string` - The identifier of an audit application.
* *opts:* `any` - (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)`>`<br/>
List audit entries for a node.
- _nodeId:_ `string` - The identifier of a node.
- _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)`>`<br/>
* *nodeId:* `string` - The identifier of a node.
* *opts:* `any` - (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)`>`<br/>
Get audit entry.
- _auditApplicationId:_ `string` - The identifier of an audit application.
- _auditEntryId:_ `string` - The identifier of an audit entry.
- _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)`|Function>`<br/>
* *auditApplicationId:* `string` - The identifier of an audit application.
* *auditEntryId:* `string` - The identifier of an audit entry.
* *opts:* `any` - (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)`|Function>`<br/>
Update audit application info.
- _auditApplicationId:_ `string` - The identifier of an audit application.
- _auditAppBodyUpdate:_ `boolean` - The audit application to update.
- _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)`|Function>` -
* *auditApplicationId:* `string` - The identifier of an audit application.
* *auditAppBodyUpdate:* `boolean` - The audit application to update.
* *opts:* `any` - (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)`|Function>` -

76
docs/content-services/services/content-node-dialog.service.md
View File

@@ -13,56 +13,56 @@ Displays and manages dialogs for selecting content to open, copy or upload.
### Methods
- **close**()<br/>
* **close**()<br/>
Closes the currently open dialog.
- **getTitleTranslation**(action: `string`, name: `string`): `string`<br/>
* **getTitleTranslation**(action: `string`, name: `string`): `string`<br/>
Gets the translation of the dialog title.
- _action:_ `string` - Name of the action to display in the dialog title
- _name:_ `string` - Name of the item on which the action is being performed
- **Returns** `string` - Translated version of the title
- **openCopyMoveDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
* *action:* `string` - Name of the action to display in the dialog title
* *name:* `string` - Name of the item on which the action is being performed
* **Returns** `string` - Translated version of the title
* **openCopyMoveDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a dialog to copy or move an item to a new location.
- _action:_ `string` - Name of the action (eg, "Copy" or "Move") to show in the title
- _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to be copied or moved
- _permission:_ `string` - (Optional) Permission for the operation
- _excludeSiteContent:_ `string[]` - (Optional) The site content that should be filtered out
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about files that were copied/moved
- **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
* *action:* `string` - Name of the action (eg, "Copy" or "Move") to show in the title
* *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to be copied or moved
* *permission:* `string` - (Optional) Permission for the operation
* *excludeSiteContent:* `string[]` - (Optional) The site content that should be filtered out
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about files that were copied/moved
* **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a file browser at a default myFile location. shows files and folders in the dialog search result.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
- **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
* **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a file browser at a chosen folder location. shows files and folders in the dialog search result.
- _folderNodeId:_ `string` - ID of the folder to use
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
- **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
* *folderNodeId:* `string` - ID of the folder to use
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
* **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a file browser at a chosen site location. shows files and folders in the dialog search result.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
- **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
* **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a folder browser at a chosen folder location.
- _folderNodeId:_ `string` - ID of the folder to use
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s)
- **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
* *folderNodeId:* `string` - ID of the folder to use
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s)
* **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a folder browser at a chosen site location.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s)
- **openLockNodeDialog**(contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Subject`](http://reactivex.io/documentation/subject.html)`<string>`<br/>
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s)
* **openLockNodeDialog**(contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Subject`](http://reactivex.io/documentation/subject.html)`<string>`<br/>
Opens a lock node dialog.
- _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock
- **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`<string>` - Error/status message (if any)
- **openUploadFileDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), showFilesInResult: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
* *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock
* **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`<string>` - Error/status message (if any)
* **openUploadFileDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), showFilesInResult: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a dialog to choose a file to upload.
- _action:_ `string` - Name of the action to show in the title
- _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload
- _showFilesInResult:_ `boolean` - Show files in dialog search result
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen file(s)
- **openUploadFolderDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
* *action:* `string` - Name of the action to show in the title
* *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload
* *showFilesInResult:* `boolean` - Show files in dialog search result
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen file(s)
* **openUploadFolderDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a dialog to choose folders to upload.
- _action:_ `string` - Name of the action to show in the title
- _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen folder(s)
* *action:* `string` - Name of the action to show in the title
* *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen folder(s)
## Details
The `openXXX` methods return an
The `openXXX` methods return an
[`Observable`](http://reactivex.io/documentation/observable.html) that you can subscribe
to in order to get the information from the result:
@@ -89,5 +89,5 @@ dialog operation, say) or be set to one of the well-known names "-my-" , "-share
## See Also
- [Content node selector panel component](../components/content-node-selector-panel.component.md)
- [Content node selector component](../components/content-node-selector.component.md)
* [Content node selector panel component](../components/content-node-selector-panel.component.md)
* [Content node selector component](../components/content-node-selector.component.md)

102
docs/content-services/services/custom-resources.service.md
View File

@@ -13,68 +13,68 @@ Manages Document List information that is specific to a user.
### Methods
- **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
* **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
Gets the contents of one of the well-known aliases in the form of node ID strings.
- _nodeId:_ `string` - ID of the target folder node
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - List of node IDs
- **getIdFromEntry**(node: `any`, nodeId: `string`): `string`<br/>
* *nodeId:* `string` - ID of the target folder node
* *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - List of node IDs
* **getIdFromEntry**(node: `any`, nodeId: `string`): `string`<br/>
Chooses the correct ID for a node entry.
- _node:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) object
- _nodeId:_ `string` - ID of the node object
- **Returns** `string` - ID value
- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
* *node:* `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) object
* *nodeId:* `string` - ID of the node object
* **Returns** `string` - ID value
* **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets files recently accessed by a user.
- _personId:_ `string` - ID of the user
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- _filters:_ `string[]` - (Optional) Specifies additional filters to apply (joined with **AND**)
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes for the recently used files
- **hasCorrespondingNodeIds**(nodeId: `string`): `boolean`<br/>
* *personId:* `string` - ID of the user
* *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
* *filters:* `string[]` - (Optional) Specifies additional filters to apply (joined with **AND**)
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes for the recently used files
* **hasCorrespondingNodeIds**(nodeId: `string`): `boolean`<br/>
Does the well-known alias have a corresponding node ID?
- _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check
- **Returns** `boolean` - True if the alias has a corresponding node ID, false otherwise
- **isCustomSource**(folderId: `string`): `boolean`<br/>
* *nodeId:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check
* **Returns** `boolean` - True if the alias has a corresponding node ID, false otherwise
* **isCustomSource**(folderId: `string`): `boolean`<br/>
Is the folder ID one of the well-known aliases?
- _folderId:_ `string` - Folder ID name to check
- **Returns** `boolean` - True if the ID is a well-known name, false otherwise
- **isSupportedSource**(folderId: `string`): `boolean`<br/>
* *folderId:* `string` - Folder ID name to check
* **Returns** `boolean` - True if the ID is a well-known name, false otherwise
* **isSupportedSource**(folderId: `string`): `boolean`<br/>
Is the folder ID a "-my", "-root-", or "-shared-" alias?
- _folderId:_ `string` - Folder ID name to check
- **Returns** `boolean` - True if the ID is one of the supported sources, false otherwise
- **loadFavorites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
* *folderId:* `string` - Folder ID name to check
* **Returns** `boolean` - True if the ID is one of the supported sources, false otherwise
* **loadFavorites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets favorite files for the current user.
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- _includeFields:_ `string[]` - List of data field names to include in the results
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorite files
- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): `any`<br/>
* *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
* *includeFields:* `string[]` - List of data field names to include in the results
* *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorite files
* **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): `any`<br/>
Gets a folder's contents.
- _nodeId:_ `string` - ID of the target folder node
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- _includeFields:_ `string[]` - List of data field names to include in the results
- _where:_ `string` - (Optional) Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information.
- **Returns** `any` - List of items contained in the folder
- **loadMemberSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`<br/>
* *nodeId:* `string` - ID of the target folder node
* *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
* *includeFields:* `string[]` - List of data field names to include in the results
* *where:* `string` - (Optional) Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the *where* condition of the REST API (for example, isFolder=true). See the REST API documentation for more information.
* **Returns** `any` - List of items contained in the folder
* **loadMemberSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`<br/>
Gets sites that the current user is a member of.
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - List of sites
- **loadSharedLinks**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>`<br/>
* *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
* *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - List of sites
* **loadSharedLinks**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>`<br/>
Gets shared links for the current user.
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- _includeFields:_ `string[]` - List of data field names to include in the results
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>` - List of shared links
- **loadSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
* *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
* *includeFields:* `string[]` - List of data field names to include in the results
* *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>` - List of shared links
* **loadSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets all sites in the repository.
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of sites
- **loadTrashcan**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`<br/>
* *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
* *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of sites
* **loadTrashcan**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`<br/>
Gets all items currently in the trash.
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- _includeFields:_ `string[]` - List of data field names to include in the results
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>` - List of deleted items
* *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
* *includeFields:* `string[]` - List of data field names to include in the results
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>` - List of deleted items
## Details
@@ -85,4 +85,4 @@ for further details of the returned data and the available fields.
## See also
- [Document List component](../components/document-list.component.md)
* [Document List component](../components/document-list.component.md)

24
docs/content-services/services/document-actions.service.md
View File

@@ -13,19 +13,19 @@ Implements the document menu actions for the [Document List component](../compon
### Methods
- **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/>
* **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/>
Checks if actions can be executed for an item.
- _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to receive an action
- **Returns** `boolean` - True if the action can be executed on this item, false otherwise
- **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)<br/>
* *nodeEntry:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to receive an action
* **Returns** `boolean` - True if the action can be executed on this item, false otherwise
* **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)<br/>
Gets the handler for an action.
- _key:_ `string` - Identifier of the action
- **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler for the action
- **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`<br/>
* *key:* `string` - Identifier of the action
* **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler for the action
* **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`<br/>
Sets a new handler for an action.
- _key:_ `string` - Identifier of the action
- _handler:_ [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - Handler for the action
- **Returns** `boolean` - False if the key was an empty/null string, true otherwise
* *key:* `string` - Identifier of the action
* *handler:* [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - Handler for the action
* **Returns** `boolean` - False if the key was an empty/null string, true otherwise
## Details
@@ -99,5 +99,5 @@ with a custom [application service](../../../lib/testing/src/lib/core/actions/AP
## See also
- [Content action component](../components/content-action.component.md)
- [Folder actions service](folder-actions.service.md)
* [Content action component](../components/content-action.component.md)
* [Folder actions service](folder-actions.service.md)

70
docs/content-services/services/document-list.service.md
View File

@@ -13,48 +13,48 @@ Implements node operations used by the [Document List component](../components/d
### Methods
- **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)`>`<br/>
* **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)`>`<br/>
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** [`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)`<any>`<br/>
* *nodeId:* `string` - The id of the node to be copied
* *targetParentId:* `string` - The id of the folder where the node will be copied
* **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)`<any>`<br/>
Deletes a node.
- _nodeId:_ `string` - ID of the node to delete
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the operation is complete
- **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
* *nodeId:* `string` - ID of the node to delete
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the operation is complete
* **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets the folder node with the specified relative name path below the root node.
- _folder:_ `string` - Path to folder.
- _opts:_ `any` - (Optional) Options.
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - Details of the folder
- **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
* *folder:* `string` - Path to folder.
* *opts:* `any` - (Optional) Options.
* *includeFields:* `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - Details of the folder
* **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
Gets a folder node via its node ID.
- _nodeId:_ `string` - ID of the folder node
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
- **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
* *nodeId:* `string` - ID of the folder node
* *includeFields:* `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
* **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
Gets a node via its node ID.
- _nodeId:_ `string` - ID of the target node
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
- **isCustomSourceService**(nodeId: `any`): `boolean`<br/>
* *nodeId:* `string` - ID of the target node
* *includeFields:* `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
* **isCustomSourceService**(nodeId: `any`): `boolean`<br/>
- _nodeId:_ `any` -
- **Returns** `boolean` -
- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`, orderBy?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`<br/>
* *nodeId:* `any` -
* **Returns** `boolean` -
* **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`, orderBy?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`<br/>
Load a folder by Node Id.
- _nodeId:_ `string` - ID of the folder node
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) -
- _includeFields:_ `string[]` - List of data field names to include in the results
- _where:_ `string` - (Optional) Optionally filter the list
- _orderBy:_ `string[]` - (Optional) 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`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
* *nodeId:* `string` - ID of the folder node
* *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) -
* *includeFields:* `string[]` - List of data field names to include in the results
* *where:* `string` - (Optional) Optionally filter the list
* *orderBy:* `string[]` - (Optional) 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`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
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** [`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
* *nodeId:* `string` - The id of the node to be moved
* *targetParentId:* `string` - The id of the folder where the node will be moved
* **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
@@ -94,4 +94,4 @@ values via their string equivalents.
## See also
- [Document list component](../components/document-list.component.md)
* [Document list component](../components/document-list.component.md)

24
docs/content-services/services/folder-actions.service.md
View File

@@ -13,19 +13,19 @@ Implements the folder menu actions for the [Document List component](../componen
### Methods
- **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/>
* **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/>
Checks if an action is available for a particular item.
- _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to check
- **Returns** `boolean` - True if the action is available, false otherwise
- **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)<br/>
* *nodeEntry:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to check
* **Returns** `boolean` - True if the action is available, false otherwise
* **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)<br/>
Gets the handler function for an action.
- _key:_ `string` - Identifier for the action
- **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler function
- **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`<br/>
* *key:* `string` - Identifier for the action
* **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler function
* **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`<br/>
Sets a new handler function for an action.
- _key:_ `string` - Identifier for the action
- _handler:_ [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The new handler function
- **Returns** `boolean` - True if the key was a valid action identifier, false otherwise
* *key:* `string` - Identifier for the action
* *handler:* [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The new handler function
* **Returns** `boolean` - True if the key was a valid action identifier, false otherwise
## Details
@@ -99,5 +99,5 @@ with a custom [application service](../../../lib/testing/src/lib/core/actions/AP
## See also
- [Document actions service](document-actions.service.md)
- [Content action component](../components/content-action.component.md)
* [Document actions service](document-actions.service.md)
* [Content action component](../components/content-action.component.md)

24
docs/content-services/services/node-permission-dialog.service.md
View File

@@ -13,25 +13,25 @@ Displays dialogs to let the user set node permissions.
### Methods
- **close**()<br/>
* **close**()<br/>
Closes the currently-open dialog.
- **openAddPermissionDialog**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>`<br/>
* **openAddPermissionDialog**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>`<br/>
Opens a dialog to add permissions to a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node
- _title:_ `string` - (Optional) Dialog title
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` - Node with updated permissions
- **updateNodePermissionByDialog**(nodeId?: `string`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
* *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node
* *title:* `string` - (Optional) Dialog title
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` - Node with updated permissions
* **updateNodePermissionByDialog**(nodeId?: `string`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
Opens a dialog to update permissions for a node.
- _nodeId:_ `string` - (Optional) ID of the target node
- _title:_ `string` - (Optional) Dialog title
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
* *nodeId:* `string` - (Optional) ID of the target node
* *title:* `string` - (Optional) Dialog title
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
## Details
This service sets up an [Add Permission Dialog component](../components/add-permission-dialog.component.md) to provide a user
interface for updating permissions.
interface for updating permissions.
## See also
- [Node Permission service](node-permission.service.md)
- [Add Permission Dialog component](../components/add-permission-dialog.component.md)
* [Node Permission service](node-permission.service.md)
* [Add Permission Dialog component](../components/add-permission-dialog.component.md)

50
docs/content-services/services/node-permission.service.md
View File

@@ -13,36 +13,36 @@ Manages role permissions for content nodes.
### Methods
- **getGroupMemberByGroupName**(groupName: `string`, opts?: `any`): [`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)`>`<br/>
* **getGroupMemberByGroupName**(groupName: `string`, opts?: `any`): [`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)`>`<br/>
Gets all members related to a group name.
- _groupName:_ `string` - Name of group to look for members
- _opts:_ `any` - (Optional) Extra options supported by JS-API
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>` - List of members
- **getNodeRoles**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
* *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
* **getNodeRoles**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
Gets a list of roles for the current node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - The target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Array of strings representing the roles
- **removePermission**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), 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)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
* *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - The target node
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Array of strings representing the roles
* **removePermission**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), 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)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
Removes a permission setting from a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - 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`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with modified permissions
- **updateLocallySetPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), nodes: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
* *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - 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`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with modified permissions
* **updateLocallySetPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), nodes: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
Updates the locally set permissions for a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node
- _nodes:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - Permission settings
- _nodeRole:_ `string[]` - Permission role
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
- **updateNodePermissions**(nodeId: `string`, permissionList: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
* *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node
* *nodes:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - Permission settings
* *nodeRole:* `string[]` - Permission role
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
* **updateNodePermissions**(nodeId: `string`, permissionList: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
- **updatePermissionRole**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), 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)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
* *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
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
* **updatePermissionRole**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), 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)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
Updates the permission role for a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - 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`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permission
* *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - 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`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permission
## Details
@@ -56,4 +56,4 @@ based on.
## See also
- [Permission list component](../components/permission-list.component.md)
* [Permission list component](../components/permission-list.component.md)

30
docs/content-services/services/rating.service.md
View File

@@ -13,22 +13,22 @@ Manages ratings for items in Content Services.
### Methods
- **deleteRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
* **deleteRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Removes the current user's rating for a node.
- _nodeId:_ `string` - Target node
- _ratingType:_ `any` - Type of rating to remove (can be "likes" or "fiveStar")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null response indicating that the operation is complete
- **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`<br/>
* *nodeId:* `string` - Target node
* *ratingType:* `any` - Type of rating to remove (can be "likes" or "fiveStar")
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null response indicating that the operation is complete
* **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`<br/>
Gets the current user's rating for a node.
- _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to get the rating from
- _ratingType:_ `any` - Type of rating (can be "likes" or "fiveStar")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - The rating value
- **postRating**(nodeId: `string`, ratingType: `string`, vote: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`<br/>
* *nodeId:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to get the rating from
* *ratingType:* `any` - Type of rating (can be "likes" or "fiveStar")
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - The rating value
* **postRating**(nodeId: `string`, ratingType: `string`, vote: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`<br/>
Adds the current user's rating for a node.
- _nodeId:_ `string` - Target node for the rating
- _ratingType:_ `string` - Type of rating (can be "likes" or "fiveStar")
- _vote:_ `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - Details about the rating, including the new value
* *nodeId:* `string` - Target node for the rating
* *ratingType:* `string` - Type of rating (can be "likes" or "fiveStar")
* *vote:* `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - Details about the rating, including the new value
## Details
@@ -44,5 +44,5 @@ REST API that this service is based on.
## See also
- [Like component](../components/like.component.md)
- [Rating component](../components/rating.component.md)
* [Like component](../components/like.component.md)
* [Rating component](../components/rating.component.md)

131
docs/content-services/services/search-query-builder.service.md
View File

@@ -13,66 +13,91 @@ Stores information from all the custom search and faceted search widgets, compil
### Methods
- **addFilterQuery**(query: `string`)<br/>
* **addFilterQuery**(query: `string`)<br/>
Adds a filter query to the current query.
- _query:_ `string` - Query string to add
- **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
* *query:* `string` - Query string to add
* **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
Adds a facet bucket to a field.
- _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field
- _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to add
- **buildQuery**(): `QueryBody`<br/>
* *field:* [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field
* *bucket:* [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to add
* **buildQuery**(): `QueryBody`<br/>
Builds the current query.
- **Returns** `QueryBody` - The finished query
- **execute**(queryBody?: `QueryBody`)<br/>
* **Returns** `QueryBody` - The finished query
* **execute**(queryBody?: `QueryBody`)<br/>
Builds and executes the current query.
- _queryBody:_ `QueryBody` - (Optional) (Optional)
- **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)<br/>
* *queryBody:* `QueryBody` - (Optional)
* **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)<br/>
Gets a facet field by label.
- _label:_ `string` - Label of the facet field
- **Returns** [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - Facet field data
- **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts)<br/>
* *label:* `string` - Label of the facet field
* **Returns** [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - Facet field data
* **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts)<br/>
Gets a facet query by label.
- _label:_ `string` - Label of the query
- **Returns** [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts) - Facet query data
- **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)<br/>
* *label:* `string` - Label of the query
* **Returns** [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts) - Facet query data
* **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)<br/>
Gets the primary sorting definition.
- **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts) - The primary sorting definition
- **getQueryGroup**(query: `any`): `any`<br/>
* **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts) - The primary sorting definition
* **getQueryGroup**(query: `any`): `any`<br/>
Gets the query group.
- _query:_ `any` - Target query
- **Returns** `any` - Query group
- **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]`<br/>
* *query:* `any` - Target query
* **Returns** `any` - Query group
* **getScope**(): [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts)<br/>
* **Returns** [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts) -
* **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]`<br/>
Gets all pre-configured sorting options that users can choose from.
- **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
- **getSupportedLabel**(configLabel: `string`): `string`<br/>
* **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
* **getSupportedLabel**(configLabel: `string`): `string`<br/>
Encloses a label name with double quotes if it contains whitespace characters.
- _configLabel:_ `string` - Original label text
- **Returns** `string` - Label, possibly with quotes if it contains spaces
- **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]`<br/>
* *configLabel:* `string` - Original label text
* **Returns** `string` - Label, possibly with quotes if it contains spaces
* **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]`<br/>
Gets the buckets currently added to a field
- _field:_ `string` - The target fields
- **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array
- **isFilterServiceActive**(): `boolean`<br/>
* *field:* `string` - The target fields
* **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array
- **Returns** `boolean` -
- **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)<br/>
* **isFilterServiceActive**(): `boolean`<br/>
- **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) -
- **removeFilterQuery**(query: `string`)<br/>
* **Returns** `boolean` -
* **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)<br/>
* **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) -
* **removeFilterQuery**(query: `string`)<br/>
Removes an existing filter query.
- _query:_ `string` - The query to remove
- **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
Removes an existing bucket from a field.
- _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field
- _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to remove
- **resetToDefaults**()<br/>
- **search**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`<br/>
* *query:* `string` - The query to remove
- _queryBody:_ `QueryBody` -
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` -
- **update**(queryBody?: `QueryBody`)<br/>
* **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
Removes an existing bucket from a field.
* *field:* [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field
* *bucket:* [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to remove
* **resetToDefaults**()<br/>
* **search**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`<br/>
* *queryBody:* `QueryBody` -
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` -
* **setScope**(scope: [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts))<br/>
* *scope:* [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts) -
* **update**(queryBody?: `QueryBody`)<br/>
Builds the current query and triggers the `updated` event.
- _queryBody:_ `QueryBody` - (Optional) (Optional)
* *queryBody:* `QueryBody` - (Optional)
## Details
@@ -84,13 +109,13 @@ You can reuse it with multiple component implementations.
You can use custom widgets to populate and edit the following parts of the resulting query:
- categories
- query fragments that form a query expression
- include fields
- scope settings
- filter queries
- facet fields
- range queries
* categories
* query fragments that form a query expression
* include fields
* scope settings
* filter queries
* facet fields
* range queries
```ts
constructor(queryBuilder: SearchQueryBuilderService) {
@@ -110,5 +135,5 @@ constructor(queryBuilder: SearchQueryBuilderService) {
## See also
- [Search filter component](../components/search-filter.component.md)
- [Search Widget interface](../interfaces/search-widget.interface.md)
* [Search filter component](../components/search-filter.component.md)
* [Search Widget interface](../interfaces/search-widget.interface.md)

30
docs/content-services/services/tag.service.md
View File

@@ -13,24 +13,24 @@ Manages tags in Content Services.
### Methods
- **addTag**(nodeId: `string`, tagName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`<br/>
* **addTag**(nodeId: `string`, tagName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`<br/>
Adds a tag to a node.
- _nodeId:_ `string` - ID of the target node
- _tagName:_ `string` - Name of the tag to add
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - TagEntry object (defined in JS-API) with details of the new tag
- **getAllTheTags**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/>
* *nodeId:* `string` - ID of the target node
* *tagName:* `string` - Name of the tag to add
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - TagEntry object (defined in JS-API) with details of the new tag
* **getAllTheTags**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/>
Gets a list of all the tags already defined in the repository.
- _opts:_ `any` - (Optional) Options supported by JS-API
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags
- **getTagsByNodeId**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/>
* *opts:* `any` - (Optional) Options supported by JS-API
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags
* **getTagsByNodeId**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/>
Gets a list of tags added to a node.
- _nodeId:_ `string` - ID of the target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags
- **removeTag**(nodeId: `string`, tag: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
* *nodeId:* `string` - ID of the target node
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags
* **removeTag**(nodeId: `string`, tag: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Removes a tag from a node.
- _nodeId:_ `string` - ID of the target node
- _tag:_ `string` - Name of the tag to remove
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null object when the operation completes
* *nodeId:* `string` - ID of the target node
* *tag:* `string` - Name of the tag to remove
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null object when the operation completes
## Details
@@ -53,4 +53,4 @@ based on.
## See also
- [Tag list component](../components/tag-list.component.md)
* [Tag list component](../components/tag-list.component.md)