inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-4152] Restructured Content Services docs (#4429)

Browse Source 
* [ADF-4152] Moved content services docs to subfolders

* [ADF-4152] Manual URL fixes for cont services docs

* [ADF-4152] Moved content services docs to subfolders

* [ADF-4152] Manual URL fixes for cont services docs

* [ADF-4152] Updated doc index pages for content services
This commit is contained in:
Andy Stark 2019-03-13 18:44:37 +00:00 committed by Eugenio Romano
parent bc5208b767
commit dfea5c2f04
72 changed files with 958 additions and 1055 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

146
docs/README.md
View File

@ -189,7 +189,7 @@ for more information about installing and using the source code.
| [Form Rendering service](core/services/form-rendering.service.md) | Maps a form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) |
| [Form service](core/services/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) |
| [Highlight Transform service](core/services/highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/services/highlight-transform.service.ts) |
| [Identity user service](core/services/identity-user.service.md) | Gets OAuth2 personal details and roles for users. | [Source](../lib/core/userinfo/services/identity-user.service.ts) |
| [Identity user service](core/services/identity-user.service.md) | Gets OAuth2 personal details and roles for users. | [Source](../lib/process-services-cloud/src/lib/services/identity-user.service.ts) |
| [JWT helper service](core/services/jwt-helper.service.md) | Decodes a JSON Web Token (JWT) to a JavaScript object. | [Source](../lib/core/services/jwt-helper.service.ts) |
| [Log Service](core/services/log.service.md) | Provides log functionality. | [Source](../lib/core/services/log.service.ts) |
| [Login Dialog service](core/services/login-dialog.service.md) | Manages login dialogs. | [Source](../lib/core/services/login-dialog.service.ts) |
@ -230,104 +230,104 @@ for more information about installing and using the source code.
<!--content-services start-->
## Components
### Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Breadcrumb component](content-services/breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) |
| [Dropdown breadcrumb component](content-services/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) |
| [Content metadata component](content-services/content-metadata.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts) |
| [Content metadata card component](content-services/content-metadata-card.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) |
| [Content node selector panel component](content-services/content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) |
| [Content node selector component](content-services/content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) |
| [Content action component](content-services/content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) |
| [Document list component](content-services/document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/document-list/components/document-list.component.ts) |
| [Add permission dialog component](content-services/add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission-dialog.component.ts) |
| [Add permission panel component](content-services/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts) |
| [Add permission component](content-services/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts) |
| [Permission list component](content-services/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/permission-manager/components/permission-list/permission-list.component.ts) |
| [Search check list component](content-services/search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-check-list/search-check-list.component.ts) |
| [Search chip list component](content-services/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts) |
| [Search control component](content-services/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.component.ts) |
| [Search date range component](content-services/search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-date-range/search-date-range.component.ts) |
| [Search filter component](content-services/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/search/components/search-filter/search-filter.component.ts) |
| [Search number range component](content-services/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-number-range/search-number-range.component.ts) |
| [Search radio component](content-services/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-radio/search-radio.component.ts) |
| [Search slider component](content-services/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-slider/search-slider.component.ts) |
| [Search sorting picker component](content-services/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts) |
| [Search text component](content-services/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-text/search-text.component.ts) |
| [Search component](content-services/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.component.ts) |
| [Sites dropdown component](content-services/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/site-dropdown/sites-dropdown.component.ts) |
| [Like component](content-services/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/social/like.component.ts) |
| [Rating component](content-services/rating.component.md) | Allows a user to add ratings to an item. | [Source](../lib/content-services/social/rating.component.ts) |
| [Tag actions component](content-services/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/tag/tag-actions.component.ts) |
| [Tag list component](content-services/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/tag/tag-list.component.ts) |
| [Tag node list component](content-services/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/tag/tag-node-list.component.ts) |
| [Tree view component](content-services/tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../lib/content-services/tree-view/components/tree-view.component.ts) |
| [File uploading dialog component](content-services/file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/upload/components/file-uploading-dialog.component.ts) |
| [Upload button component](content-services/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/upload/components/upload-button.component.ts) |
| [Upload drag area component](content-services/upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../lib/content-services/upload/components/upload-drag-area.component.ts) |
| [Upload version button component](content-services/upload-version-button.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../lib/content-services/upload/components/upload-version-button.component.ts) |
| [Version list component](content-services/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/version-manager/version-list.component.ts) |
| [Version manager component](content-services/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/version-manager/version-manager.component.ts) |
| [Webscript component](content-services/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/webscript/webscript.component.ts) |
| [Add Permission Dialog Component](content-services/components/add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission-dialog.component.ts) |
| [Add Permission Panel Component](content-services/components/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts) |
| [Add Permission Component](content-services/components/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts) |
| [Breadcrumb Component](content-services/components/breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) |
| [Content Action component](content-services/components/content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) |
| [Content Metadata Card component](content-services/components/content-metadata-card.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) |
| [Content Metadata Card component](content-services/components/content-metadata.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts) |
| [Content Node Selector Panel component](content-services/components/content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) |
| [Content Node Selector component](content-services/components/content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) |
| [Document List component](content-services/components/document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/document-list/components/document-list.component.ts) |
| [Dropdown Breadcrumb Component](content-services/components/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) |
| [File Uploading Dialog Component](content-services/components/file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/upload/components/file-uploading-dialog.component.ts) |
| [Like component](content-services/components/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/social/like.component.ts) |
| [Permission List Component](content-services/components/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/permission-manager/components/permission-list/permission-list.component.ts) |
| [Rating component](content-services/components/rating.component.md) | Allows a user to add ratings to an item. | [Source](../lib/content-services/social/rating.component.ts) |
| [Search check list component](content-services/components/search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-check-list/search-check-list.component.ts) |
| [Search Chip List Component](content-services/components/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts) |
| [Search control component](content-services/components/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.component.ts) |
| [Search date range component](content-services/components/search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-date-range/search-date-range.component.ts) |
| [Search Filter component](content-services/components/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/search/components/search-filter/search-filter.component.ts) |
| [Search number range component](content-services/components/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-number-range/search-number-range.component.ts) |
| [Search radio component](content-services/components/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-radio/search-radio.component.ts) |
| [Search slider component](content-services/components/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-slider/search-slider.component.ts) |
| [Search Sorting Picker Component](content-services/components/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts) |
| [Search text component](content-services/components/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-text/search-text.component.ts) |
| [Search component](content-services/components/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.component.ts) |
| [Sites Dropdown component](content-services/components/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/site-dropdown/sites-dropdown.component.ts) |
| [Tag Node Actions List component](content-services/components/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/tag/tag-actions.component.ts) |
| [Tag List component](content-services/components/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/tag/tag-list.component.ts) |
| [Tag Node List component](content-services/components/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/tag/tag-node-list.component.ts) |
| [Tree View component](content-services/components/tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../lib/content-services/tree-view/components/tree-view.component.ts) |
| [Upload Button Component](content-services/components/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/upload/components/upload-button.component.ts) |
| [Upload Drag Area Component](content-services/components/upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../lib/content-services/upload/components/upload-drag-area.component.ts) |
| [Upload Version Button Component (Workaround)](content-services/components/upload-version-button.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../lib/content-services/upload/components/upload-version-button.component.ts) |
| [Version List component](content-services/components/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/version-manager/version-list.component.ts) |
| [Version Manager Component](content-services/components/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/version-manager/version-manager.component.ts) |
| [Webscript component](content-services/components/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/webscript/webscript.component.ts) |
## Dialogs
### Directives
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Confirm dialog](content-services/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/dialogs/confirm.dialog.ts) |
| [Library dialog](content-services/library.dialog.md) | Creates a new Content Services document library/site. | [Source](../lib/content-services/dialogs/library/library.dialog.ts) |
| [Node Public File Share Directive](content-services/directives/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/content-node-share/content-node-share.directive.ts) |
| [File Draggable directive](content-services/directives/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a div. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) |
| [Folder Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) |
| [Folder Edit directive](content-services/directives/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) |
| [Inherit Permission directive](content-services/directives/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/permission-manager/components/inherited-button.directive.ts) |
| [Node Lock directive](content-services/directives/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/directives/node-lock.directive.ts) |
## Directives
### Dialogs
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Content node share directive](content-services/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/content-node-share/content-node-share.directive.ts) |
| [Node lock directive](content-services/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/directives/node-lock.directive.ts) |
| [Folder create directive](content-services/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) |
| [Folder edit directive](content-services/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) |
| [Inherited button directive](content-services/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/permission-manager/components/inherited-button.directive.ts) |
| [File draggable directive](content-services/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a `div`. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) |
| [Confirm dialog component](content-services/dialogs/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/dialogs/confirm.dialog.ts) |
| [Library dialog component](content-services/dialogs/library.dialog.md) | Creates a new Content Services document library/site. | [Source](../lib/content-services/dialogs/library/library.dialog.ts) |
## Models
### Interfaces
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Image resolver model](content-services/image-resolver.model.md) | Defines the Image Resolver function used by the Document List Component. | [Source](../lib/content-services/document-list/data/image-resolver.model.ts) |
| [Row filter model](content-services/row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../lib/content-services/document-list/data/row-filter.model.ts) |
| [Permissions style model](content-services/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/document-list/models/permissions-style.model.ts) |
| [Search widget interface](content-services/interfaces/search-widget.interface.md) | Specifies required properties for Search filter component widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) |
## Pipes
### Models
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [File upload error pipe](content-services/file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../lib/content-services/upload/pipes/file-upload-error.pipe.ts) |
| [Image Resolver Model](content-services/models/image-resolver.model.md) | Defines the Image Resolver function used by the Document List Component. | [Source](../lib/content-services/document-list/data/image-resolver.model.ts) |
| [Permission Style model](content-services/models/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/document-list/models/permissions-style.model.ts) |
| [Row Filter Model](content-services/models/row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../lib/content-services/document-list/data/row-filter.model.ts) |
## Services
### Pipes
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Content node dialog service](content-services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/content-node-selector/content-node-dialog.service.ts) |
| [Custom resources service](content-services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/document-list/services/custom-resources.service.ts) |
| [Document actions service](content-services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/document-actions.service.ts) |
| [Document list service](content-services/document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/document-list/services/document-list.service.ts) |
| [Folder actions service](content-services/folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) |
| [Node permission dialog service](content-services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/permission-manager/services/node-permission-dialog.service.ts) |
| [Node permission service](content-services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/permission-manager/services/node-permission.service.ts) |
| [Search filter service](content-services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/search/components/search-filter/search-filter.service.ts) |
| [Search query builder service](content-services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/search/search-query-builder.service.ts) |
| [Rating service](content-services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/social/services/rating.service.ts) |
| [Tag service](content-services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/tag/services/tag.service.ts) |
| [File upload error pipe](content-services/pipes/file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../lib/content-services/upload/pipes/file-upload-error.pipe.ts) |
### Services
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Content Node Dialog service](content-services/services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/content-node-selector/content-node-dialog.service.ts) |
| [Custom Resources service](content-services/services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/document-list/services/custom-resources.service.ts) |
| [Document Actions service](content-services/services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/document-actions.service.ts) |
| [Document List service](content-services/services/document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/document-list/services/document-list.service.ts) |
| [Folder Actions service](content-services/services/folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) |
| [Node permission dialog service](content-services/services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/permission-manager/services/node-permission-dialog.service.ts) |
| [Node Permission service](content-services/services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/permission-manager/services/node-permission.service.ts) |
| [Rating service](content-services/services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/social/services/rating.service.ts) |
| [Search filter service](content-services/services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/search/components/search-filter/search-filter.service.ts) |
| [Search Query Builder service](content-services/services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/search/search-query-builder.service.ts) |
| [Tag service](content-services/services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/tag/services/tag.service.ts) |
<!--content-services end-->
## Other classes and interfaces
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Search Widget interface](content-services/search-widget.interface.md) | Specifies required properties for Search filter component widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) |
[(Back to Contents)](#contents)
## Process Services API

111
docs/content-services/README.md
View File

@ -1,111 +0,0 @@
---
Title: Content Services API
Github only: true
---
# Content Services API
Contains components related to Content Services.
See the library's
[README file](../../lib/content-services/README.md)
for more information about installing and using the source code.
<!--content-services start-->
## Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Breadcrumb component](breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../../lib/content-services/breadcrumb/breadcrumb.component.ts) |
| [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) |
| [Content metadata component](content-metadata.component.md) | Displays and edits metadata related to a node. | [Source](../../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts) |
| [Content metadata card component](content-metadata-card.component.md) | Displays and edits metadata related to a node. | [Source](../../lib/content-services/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) |
| [Content node selector panel component](content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) |
| [Content node selector component](content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../../lib/content-services/content-node-selector/content-node-selector.component.ts) |
| [Content action component](content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../../lib/content-services/document-list/components/content-action/content-action.component.ts) |
| [Document list component](document-list.component.md) | Displays the documents from a repository. | [Source](../../lib/content-services/document-list/components/document-list.component.ts) |
| [Add permission dialog component](add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../../lib/content-services/permission-manager/components/add-permission/add-permission-dialog.component.ts) |
| [Add permission panel component](add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts) |
| [Add permission component](add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts) |
| [Permission list component](permission-list.component.md) | Shows node permissions as a table. | [Source](../../lib/content-services/permission-manager/components/permission-list/permission-list.component.ts) |
| [Search check list component](search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../../lib/content-services/search/components/search-check-list/search-check-list.component.ts) |
| [Search chip list component](search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts) |
| [Search control component](search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../../lib/content-services/search/components/search-control.component.ts) |
| [Search date range component](search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../../lib/content-services/search/components/search-date-range/search-date-range.component.ts) |
| [Search filter component](search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../../lib/content-services/search/components/search-filter/search-filter.component.ts) |
| [Search number range component](search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../../lib/content-services/search/components/search-number-range/search-number-range.component.ts) |
| [Search radio component](search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../../lib/content-services/search/components/search-radio/search-radio.component.ts) |
| [Search slider component](search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../../lib/content-services/search/components/search-slider/search-slider.component.ts) |
| [Search sorting picker component](search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts) |
| [Search text component](search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../../lib/content-services/search/components/search-text/search-text.component.ts) |
| [Search component](search.component.md) | Searches items for supplied search terms. | [Source](../../lib/content-services/search/components/search.component.ts) |
| [Sites dropdown component](sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../../lib/content-services/site-dropdown/sites-dropdown.component.ts) |
| [Like component](like.component.md) | Allows a user to add "likes" to an item. | [Source](../../lib/content-services/social/like.component.ts) |
| [Rating component](rating.component.md) | Allows a user to add ratings to an item. | [Source](../../lib/content-services/social/rating.component.ts) |
| [Tag actions component](tag-actions.component.md) | Shows available actions for tags. | [Source](../../lib/content-services/tag/tag-actions.component.ts) |
| [Tag list component](tag-list.component.md) | Shows tags for an item. | [Source](../../lib/content-services/tag/tag-list.component.ts) |
| [Tag node list component](tag-node-list.component.md) | Shows tags for a node. | [Source](../../lib/content-services/tag/tag-node-list.component.ts) |
| [Tree view component](tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../../lib/content-services/tree-view/components/tree-view.component.ts) |
| [File uploading dialog component](file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../../lib/content-services/upload/components/file-uploading-dialog.component.ts) |
| [Upload button component](upload-button.component.md) | Activates a file upload. | [Source](../../lib/content-services/upload/components/upload-button.component.ts) |
| [Upload drag area component](upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../../lib/content-services/upload/components/upload-drag-area.component.ts) |
| [Upload version button component](upload-version-button.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../../lib/content-services/upload/components/upload-version-button.component.ts) |
| [Version list component](version-list.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../../lib/content-services/version-manager/version-list.component.ts) |
| [Version manager component](version-manager.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../../lib/content-services/version-manager/version-manager.component.ts) |
| [Webscript component](webscript.component.md) | Provides access to Webscript features. | [Source](../../lib/content-services/webscript/webscript.component.ts) |
## Dialogs
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Confirm dialog](confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../../lib/content-services/dialogs/confirm.dialog.ts) |
| [Library dialog](library.dialog.md) | Creates a new Content Services document library/site. | [Source](../../lib/content-services/dialogs/library/library.dialog.ts) |
## Directives
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Content node share directive](content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../../lib/content-services/content-node-share/content-node-share.directive.ts) |
| [Node lock directive](node-lock.directive.md) | Locks or unlocks a node. | [Source](../../lib/content-services/directives/node-lock.directive.ts) |
| [Folder create directive](folder-create.directive.md) | Creates folders. | [Source](../../lib/content-services/folder-directive/folder-create.directive.ts) |
| [Folder edit directive](folder-edit.directive.md) | Allows folders to be edited. | [Source](../../lib/content-services/folder-directive/folder-edit.directive.ts) |
| [Inherited button directive](inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../../lib/content-services/permission-manager/components/inherited-button.directive.ts) |
| [File draggable directive](file-draggable.directive.md) | Provides drag-and-drop features for an element such as a `div`. | [Source](../../lib/content-services/upload/directives/file-draggable.directive.ts) |
## Models
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Image resolver model](image-resolver.model.md) | Defines the Image Resolver function used by the Document List Component. | [Source](../../lib/content-services/document-list/data/image-resolver.model.ts) |
| [Row filter model](row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../../lib/content-services/document-list/data/row-filter.model.ts) |
| [Permissions style model](permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../../lib/content-services/document-list/models/permissions-style.model.ts) |
## Pipes
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [File upload error pipe](file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../../lib/content-services/upload/pipes/file-upload-error.pipe.ts) |
## Services
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Content node dialog service](content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../../lib/content-services/content-node-selector/content-node-dialog.service.ts) |
| [Custom resources service](custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../../lib/content-services/document-list/services/custom-resources.service.ts) |
| [Document actions service](document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../../lib/content-services/document-list/services/document-actions.service.ts) |
| [Document list service](document-list.service.md) | Implements node operations used by the Document List component. | [Source](../../lib/content-services/document-list/services/document-list.service.ts) |
| [Folder actions service](folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../../lib/content-services/document-list/services/folder-actions.service.ts) |
| [Node permission dialog service](node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../../lib/content-services/permission-manager/services/node-permission-dialog.service.ts) |
| [Node permission service](node-permission.service.md) | Manages role permissions for content nodes. | [Source](../../lib/content-services/permission-manager/services/node-permission.service.ts) |
| [Search filter service](search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../../lib/content-services/search/components/search-filter/search-filter.service.ts) |
| [Search query builder service](search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../../lib/content-services/search/search-query-builder.service.ts) |
| [Rating service](rating.service.md) | Manages ratings for items in Content Services. | [Source](../../lib/content-services/social/services/rating.service.ts) |
| [Tag service](tag.service.md) | Manages tags in Content Services. | [Source](../../lib/content-services/tag/services/tag.service.ts) |
<!--content-services end-->
## Other classes and interfaces
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Search Widget interface](search-widget.interface.md) | Specifies required properties for [Search filter component](../content-services/search-filter.component.md) widgets. | [Source](../../lib/content-services/search/search-widget.interface.ts) |

10
docs/content-services/add-permission-dialog.component.md → docs/content-services/components/add-permission-dialog.component.md
View File

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Add Permission Dialog Component](../../lib/content-services/permission-manager/components/add-permission/add-permission-dialog.component.ts "Defined in add-permission-dialog.component.ts")
# [Add Permission Dialog Component](../../../lib/content-services/permission-manager/components/add-permission/add-permission-dialog.component.ts "Defined in add-permission-dialog.component.ts")
Displays a dialog to search for people or groups to add to the current node permissions.
![Add Permission Component](../docassets/images/add-permission-component.png)
![Add Permission Component](../../docassets/images/add-permission-component.png)
## Basic Usage
@ -29,10 +29,10 @@ import { NodePermissionDialogService } from '@alfresco/adf-content-services';
## Details
This component extends the [Add permission panel component](../content-services/add-permission-panel.component.md)
This component extends the [Add permission panel component](add-permission-panel.component.md)
to apply the chosen selection of permissions when they are accepted.
You can open the dialog with the `openAddPermissionDialog` method from the
[Node Permission Dialog Service](../content-services/node-permission-dialog.service.md).
[Node Permission Dialog Service](../services/node-permission-dialog.service.md).
This returns an [`Observable`](http://reactivex.io/documentation/observable.html)
that you can subscribe to so you can get the details of the node after the update.
Use the `updateNodePermissionByDialog` nethod from the service to update node permissions, as shown in
@ -54,5 +54,5 @@ import { NodePermissionDialogService } from '@alfresco/adf-content-services';
## See also
- [Node permission dialog service](node-permission-dialog.service.md)
- [Node permission dialog service](../services/node-permission-dialog.service.md)
- [Add permission panel component](add-permission-panel.component.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-14
---
# [Add Permission Panel Component](../../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts "Defined in add-permission-panel.component.ts")
# [Add Permission Panel Component](../../../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts "Defined in add-permission-panel.component.ts")
Searches for people or groups to add to the current node permissions.
![Add Permission Component](../docassets/images/add-permission-component.png)
![Add Permission Component](../../docassets/images/add-permission-component.png)
## Basic Usage
@ -35,11 +35,11 @@ This component uses a [Search component](search.component.md) to retrieve the
groups and people that could be added to the permission list of the current node.
The `select` event is emitted when a result is clicked from the list.
The [Add permission dialog component](../content-services/add-permission-dialog.component.md)
and [Add permission component](../content-services/add-permission.component.md) extend this behavior by applying the chosen
The [Add permission dialog component](add-permission-dialog.component.md)
and [Add permission component](add-permission.component.md) extend this behavior by applying the chosen
permissions to the node once the selection has been made.
## See also
- [Add permission dialog component](../content-services/add-permission-dialog.component.md)
- [Add permission component](../content-services/add-permission.component.md)
- [Add permission dialog component](add-permission-dialog.component.md)
- [Add permission component](add-permission.component.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Add Permission Component](../../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts "Defined in add-permission.component.ts")
# [Add Permission Component](../../../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts "Defined in add-permission.component.ts")
Searches for people or groups to add to the current node permissions.
![Add Permission Component](../docassets/images/add-permission-component.png)
![Add Permission Component](../../docassets/images/add-permission-component.png)
## Basic Usage
@ -38,11 +38,11 @@ Searches for people or groups to add to the current node permissions.
## Details
This component extends the [Add permission panel component](../content-services/add-permission-panel.component.md)
This component extends the [Add permission panel component](add-permission-panel.component.md)
to apply the chosen selection of permissions when they are accepted. You can also
use the [Add permission dialog component](../content-services/add-permission-dialog.component.md) to perform the same action using a dialog.
use the [Add permission dialog component](add-permission-dialog.component.md) to perform the same action using a dialog.
## See also
- [Add permission panel component](../content-services/add-permission-panel.component.md)
- [Add permission dialog component](../content-services/add-permission-dialog.component.md)
- [Add permission panel component](add-permission-panel.component.md)
- [Add permission dialog component](add-permission-dialog.component.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Breadcrumb Component](../../lib/content-services/breadcrumb/breadcrumb.component.ts "Defined in breadcrumb.component.ts")
# [Breadcrumb Component](../../../lib/content-services/breadcrumb/breadcrumb.component.ts "Defined in breadcrumb.component.ts")
Indicates the current position within a navigation hierarchy.
![Breadcrumb](../docassets/images/breadcrumb.png)
![Breadcrumb](../../docassets/images/breadcrumb.png)
## Basic Usage
@ -29,7 +29,7 @@ Indicates the current position within a navigation hierarchy.
| 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/document-list.component.md) | | (optional) [Document List component](../content-services/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. |
| 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
@ -43,7 +43,7 @@ Indicates the current position within a navigation hierarchy.
The `maxItems` property sets the maximum number of "crumbs" in the breadcrumb trail. If
the actual path contains more nodes than this then the earliest items in the path will be
removed and kept in a menu as with the
[Dropdown breadcrumb component](../content-services/dropdown-breadcrumb.component.md).
[Dropdown breadcrumb component](dropdown-breadcrumb.component.md).
### Using the transform function
@ -53,7 +53,7 @@ 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
transform function via the `breadcrumbTransform` property of [`ContentNodeSelectorComponentData`](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) during
transform function via the `breadcrumbTransform` property of [`ContentNodeSelectorComponentData`](../../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) during
initialization:
```ts
@ -92,7 +92,7 @@ A transform function to remove the "Sites" folder from the path would look somet
Below, the breadcrumb is shown before and after the transform function is applied:
![Content Node Selector breadcrumbTransform before/after screenshot](../docassets/images/breadcrumbTransform.png)
![Content Node Selector breadcrumbTransform before/after screenshot](../../docassets/images/breadcrumbTransform.png)
## See also

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-17
---
# [Content Action component](../../lib/content-services/document-list/components/content-action/content-action.component.ts "Defined in content-action.component.ts")
# [Content Action component](../../../lib/content-services/document-list/components/content-action/content-action.component.ts "Defined in content-action.component.ts")
Adds options to a Document List actions menu for a particular content type.
![Document Actions](../docassets/images/document-actions.png)
![Document Actions](../../docassets/images/document-actions.png)
## Contents
@ -121,7 +121,7 @@ will trigger the same action.) You can also add your own handler by implementing
`execute` event.
Note that you can use _both_ a built-in handler and your own `execute`
function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](../../lib/content-services/document-list/models/document-library.model.ts) as its
function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](../../../lib/content-services/document-list/models/document-library.model.ts) as its
parameter. For
example, with `handler="delete"` you could use `execute` to show a message with the name,
type, and other details of the item just deleted:
@ -155,7 +155,7 @@ type, and other details of the item just deleted:
}
```
![Custom delete message screenshot](../docassets/images/ContentActSnackMessage.png)
![Custom delete message screenshot](../../docassets/images/ContentActSnackMessage.png)
### Examples
@ -177,7 +177,7 @@ This action simply executes one of the built-in actions described above:
</adf-document-list>
```
![Download document action](../docassets/images/document-action-download.png)
![Download document action](../../docassets/images/document-action-download.png)
#### Custom handler
@ -241,13 +241,13 @@ export class MyComponent {
}
```
![Delete disable action button](../docassets/images/content-action-disable-delete-button.png)
![Delete disable action button](../../docassets/images/content-action-disable-delete-button.png)
#### Permission check
You can also implement the `permissionEvent` to handle permission errors
(to show the user a notification, for example). Subscribe to this event from your component
and use the [Notification service](../core/notification.service.md) to show a message.
and use the [Notification service](../../core/services/notification.service.md) to show a message.
```html
<adf-document-list [contentActions]="true"...>
@ -276,7 +276,7 @@ export class MyComponent {
}
```
![Delete show notification message](../docassets/images/content-action-notification-message.png)
![Delete show notification message](../../docassets/images/content-action-notification-message.png)
#### Copy and move
@ -284,7 +284,7 @@ These actions show the destination chooser dialog for copy and move actions. By
the destination chooser lists all the folders of the subject item's parent. However, it won't
allow the item being copied/moved to be the destination if it is itself a folder.
![Copy/move dialog](../docassets/images/document-action-copymovedialog.png)
![Copy/move dialog](../../docassets/images/document-action-copymovedialog.png)
```html
<adf-document-list [contentActions]="true"...>
@ -432,10 +432,10 @@ funcName = (parameters): boolean => {
### Customizing built-in actions
The built-in actions are defined in the [Document Actions service](document-actions.service.md) and
[Folder Actions service](folder-actions.service.md) but you can register new actions with these services
The built-in actions are defined in the [Document Actions service](../services/document-actions.service.md) and
[Folder Actions service](../services/folder-actions.service.md) but you can register new actions with these services
and override the default implementations. See the doc pages for
[Document Actions service](document-actions.service.md) and [Folder Actions service](folder-actions.service.md)
[Document Actions service](../services/document-actions.service.md) and [Folder Actions service](../services/folder-actions.service.md)
for details and examples.
### Error, Permission and Success callbacks
@ -446,10 +446,10 @@ You can define error, permission and success callbacks in much the same way as f
- 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)
![Copy/move document action](../../docassets/images/document-action-copymove.png)
## See also
- [Document list component](document-list.component.md)
- [Document actions service](document-actions.service.md)
- [Folder actions service](folder-actions.service.md)
- [Document actions service](../services/document-actions.service.md)
- [Folder actions service](../services/folder-actions.service.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Content Metadata Card component](../../lib/content-services/content-metadata/components/content-metadata-card/content-metadata-card.component.ts "Defined in content-metadata-card.component.ts")
# [Content Metadata Card component](../../../lib/content-services/content-metadata/components/content-metadata-card/content-metadata-card.component.ts "Defined in content-metadata-card.component.ts")
Displays and edits metadata related to a node.
![Content metadata screenshot](../docassets/images/ContentMetadata.png)
![Content metadata screenshot](../../docassets/images/ContentMetadata.png)
## Basic Usage
@ -38,7 +38,7 @@ Displays and edits metadata related to a node.
## Details
The component shows metadata related to a given node. It uses the
[Card View component](../core/card-view.component.md) to render the properties of metadata aspects.
[Card View component](../../core/components/card-view.component.md) to render the properties of metadata aspects.
The different aspects and their properties to be shown can be configured as application config
presets (see below). By default the component only shows the basic properties of the node.
The user can click on the pencil icon at the bottom of the component to edit the metadata

6
docs/content-services/content-metadata.component.md → docs/content-services/components/content-metadata.component.md
View File

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Content Metadata Card component](../../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts "Defined in content-metadata.component.ts")
# [Content Metadata Card component](../../../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts "Defined in content-metadata.component.ts")
Displays and edits metadata related to a node.
![Content metadata screenshot](../docassets/images/ContentMetadata.png)
![Content metadata screenshot](../../docassets/images/ContentMetadata.png)
## Basic Usage
@ -39,7 +39,7 @@ Displays and edits metadata related to a node.
## Details
The component shows metadata related to a given node. It uses the
[Card View component](../core/card-view.component.md) to render the properties of metadata aspects.
[Card View component](../../core/components/card-view.component.md) to render the properties of metadata aspects.
The different aspects and their properties to be shown can be configured as application config
presets (see below). By default the component only shows the basic properties of the node.
The user can click on the pencil icon at the bottom of the component to edit the metadata

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Content Node Selector Panel component](../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts "Defined in content-node-selector-panel.component.ts")
# [Content Node Selector Panel component](../../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts "Defined in content-node-selector-panel.component.ts")
Opens a [Content Node Selector](content-node-selector.component.md) in its own dialog window.
![Content Node Selector screenshot](../docassets/images/ContentNodeSelector.png)
![Content Node Selector screenshot](../../docassets/images/ContentNodeSelector.png)
## Basic Usage
@ -34,12 +34,12 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
| currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. |
| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). |
| imageResolver | `ImageResolver` | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. |
| imageResolver | `ImageResolver` | null | Custom image resolver function. See the [Image Resolver Model](../models/image-resolver.model.md) page for more information. |
| isSelectionValid | `ValidationFunction` | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
| pageSize | `number` | | Number of items shown per page in the list. |
| where | `string` | | Custom _where_ filter function. See the [Document List component](../content-services/document-list.component.md) for more information. |
| 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` | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. |
| rowFilter | `RowFilter` | | Custom row filter function. See the [Row Filter Model](../models/row-filter.model.md) page for more information. |
### Events
@ -53,7 +53,7 @@ This component opens a _content node selector_ in its own dialog window. This be
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
[Content Node Dialog service](content-node-dialog.service.md) has several methods that give you
[Content Node Dialog service](../services/content-node-dialog.service.md) has several methods that give you
finer control over the behavior of the dialog.
### Using the breadcrumbTransform function
@ -66,4 +66,4 @@ example of how to use this function.
## See also
- [Content Node Selector component](content-node-selector.component.md)
- [Content Node Dialog service](content-node-dialog.service.md)
- [Content Node Dialog service](../services/content-node-dialog.service.md)

26
docs/content-services/content-node-selector.component.md → docs/content-services/components/content-node-selector.component.md
View File

@ -5,15 +5,15 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Content Node Selector component](../../lib/content-services/content-node-selector/content-node-selector.component.ts "Defined in content-node-selector.component.ts")
# [Content Node Selector component](../../../lib/content-services/content-node-selector/content-node-selector.component.ts "Defined in content-node-selector.component.ts")
Allows a user to select items from a Content Services repository.
![Content Node Selector screenshot](../docassets/images/ContentNodeSelector.png)
![Content Node Selector screenshot](../../docassets/images/ContentNodeSelector.png)
## Details
The [Content Node Selector component](../content-services/content-node-selector.component.md) works a lot like the standard File Open/Save
The [Content Node Selector component](content-node-selector.component.md) works a lot like the standard File Open/Save
dialog used by desktop applications except that it chooses items from a Content Services
repository rather than the filesystem. For example, the
[Document List component](document-list.component.md) uses a selector to choose the targets
@ -25,7 +25,7 @@ more information).
Unlike most components, the [Content Node Selector Component](content-node-selector.component.md) is typically shown in a dialog box
rather than the main page and you are responsible for opening the dialog yourself. You can use the
[Angular Material Dialog](https://material.angular.io/components/dialog/overview) for this,
as shown in the usage example. ADF provides the [`ContentNodeSelectorComponentData`](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) interface
as shown in the usage example. ADF provides the [`ContentNodeSelectorComponentData`](../../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) interface
to work with the Dialog's
[data option](https://material.angular.io/components/dialog/overview#sharing-data-with-the-dialog-component-):
@ -55,17 +55,17 @@ The properties are described in the table below:
| currentFolderId | `string` | `null` | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. |
| dropdownHideMyFiles | `boolean` | `false` | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | `null` | Custom site for site dropdown same as siteList. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| rowFilter | [`RowFilter`](../../lib/content-services/document-list/data/row-filter.model.ts) | `null` | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. |
| where | `string` | `null` | Custom *where* filter function. See the [Document List component](document-list.component.md) for more information. |
| imageResolver | [`ImageResolver`](../../lib/content-services/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. |
| rowFilter | [`RowFilter`](../../../lib/content-services/document-list/data/row-filter.model.ts) | `null` | Custom row filter function. See the [Row Filter Model](../models/row-filter.model.md) page for more information. |
| where | `string` | `null` | Custom _where_ filter function. See the [Document List component](document-list.component.md) for more information. |
| imageResolver | [`ImageResolver`](../../../lib/content-services/document-list/data/image-resolver.model.ts) | `null` | Custom image resolver function. See the [Image Resolver Model](../models/image-resolver.model.md) page for more information. |
| pageSize | `number` | | Number of items shown per page in the list. |
| isSelectionValid | [`ValidationFunction`](../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) | `defaultValidation` | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
| isSelectionValid | [`ValidationFunction`](../../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) | `defaultValidation` | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
| breadcrumbTransform | `(node: any) => any` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
| select | [`Subject<Node>`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | Event emitted with the current node selection when the dialog closes |
If you don't want to manage the dialog yourself then it is easier to use the
[Content Node Selector Panel component](content-node-selector-panel.component.md), or the
methods of the [Content Node Dialog service](content-node-dialog.service.md), which create
methods of the [Content Node Dialog service](../services/content-node-dialog.service.md), which create
the dialog for you.
### Usage example
@ -107,7 +107,7 @@ openSelectorDialog() {
}
```
All the results will be streamed to the select [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present in the [`ContentNodeSelectorComponentData`](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) object passed to the dialog.
All the results will be streamed to the select [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present in the [`ContentNodeSelectorComponentData`](../../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) object passed to the dialog.
When the dialog action is selected by clicking, the `data.select` stream will be completed.
### RowFilter and ImageResolver
@ -118,12 +118,12 @@ items that the user can choose. As with the standard Document List, you can supp
**row filter** function (to hide items that can't be chosen) and a custom **image resolver**
function (to select an image to show in a particular list cell). For example, you could use
a row filter to hide document nodes in a folder selector. See the
[Row Filter Model](row-filter.model.md) and [Image Resolver Model](image-resolver.model.md)
[Row Filter Model](../models/row-filter.model.md) and [Image Resolver Model](../models/image-resolver.model.md)
pages for more information.
### Using the breadcrumbTransform function
The `breadcrumbTransform` property of [`ContentNodeSelectorComponentData`](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) lets you modify
The `breadcrumbTransform` property of [`ContentNodeSelectorComponentData`](../../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) lets you modify
the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) object that is used to generate the
list of breadcrumbs. You can use this, for example, to remove path elements that are not
relevant to the use case. See the [Breadcrumb component](breadcrumb.component.md) page for an
@ -133,4 +133,4 @@ example of how to use this function.
- [Document list component](document-list.component.md)
- [Content Node Selector Panel component](content-node-selector-panel.component.md)
- [Content Node Dialog service](content-node-dialog.service.md)
- [Content Node Dialog service](../services/content-node-dialog.service.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-02-08
---
# [Document List component](../../lib/content-services/document-list/components/document-list.component.ts "Defined in document-list.component.ts")
# [Document List component](../../../lib/content-services/document-list/components/document-list.component.ts "Defined in document-list.component.ts")
Displays the documents from a repository.
![Custom columns](../docassets/images/custom-columns.png)
![Custom columns](../../docassets/images/custom-columns.png)
## Contents
@ -56,13 +56,13 @@ Displays the documents from a repository.
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list. 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/upload.directive.md) for further details about how the file drop is handled. |
| allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list. 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 |
| 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' |
| 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. |
| imageResolver | `any \| null` | null | Custom function to choose image file paths to show. See the [Image Resolver Model](../models/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). |
@ -70,8 +70,8 @@ Displays the documents from a repository.
| multiselect | `boolean` | false | Toggles multiselect mode |
| navigate | `boolean` | true | Toggles navigation to folder content or file preview |
| navigationMode | `string` | | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" |
| node | [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) | null | The Document list will show all the nodes contained in the [NodePaging](../../lib/content-services/document-list/models/document-library.model.ts) entity |
| permissionsStyle | [`PermissionStyleModel`](../../lib/content-services/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/document-list/models/permissions-style.model.ts) page for further details and examples. |
| node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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/development/src/api/content-rest-api/docs/NodePaging.md) entity |
| permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/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/document-list/models/permissions-style.model.ts) page for further details and examples. |
| 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. |
@ -81,18 +81,18 @@ Displays the documents from a repository.
| thumbnails | `boolean` | false | Show document thumbnails rather than icons |
| where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/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. |
| currentFolderId | `string` | | The ID of the folder node to display or a reserved string alias for special sources |
| 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. |
| rowFilter | `RowFilter` | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](../models/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 |
| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../lib/content-services/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/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/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node |
| preview | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../lib/content-services/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/viewer.component.md). |
| ready | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the Document List has loaded all items and is ready for use |
| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/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/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/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node |
| preview | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/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/development/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when the Document List has loaded all items and is ready for use |
## Details
@ -102,7 +102,7 @@ best.
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)
![Document List Folders](../../docassets/images/document-list-special-folder-icon.png)
### DOM Events
@ -126,8 +126,8 @@ have at least the following properties as part of the `Event.detail` property va
}
```
See the [DataTable](../core/datatable.component.md) documentation for further details about
the other DOM events that the [Document List component](../content-services/document-list.component.md) bubbles up from the DataTable.
See the [DataTable](../../core/components/datatable.component.md) documentation for further details about
the other DOM events that the [Document List component](document-list.component.md) bubbles up from the DataTable.
Below is a basic example of handling DOM events in the parent elements.
@ -161,7 +161,7 @@ You can use `ngIf` directives to provide conditional visibility support for the
The Document List has an option to display items as "cards" instead of the
standard view:
![card-view](../docassets/images/document-list-card-view.png)
![card-view](../../docassets/images/document-list-card-view.png)
Set the `[display]` property to "gallery" to enable card view mode:
@ -174,7 +174,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/pagination.component.md) and [Infinite pagination component](../core/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
@ -215,7 +215,7 @@ You can use one of the well-known reserved aliases:
#### Document List aliases
The [Document List component](../content-services/document-list.component.md) also provides support for the following reserved aliases:
The [Document List component](document-list.component.md) also provides support for the following reserved aliases:
- `-trashcan-`,
- `-sharedlinks-`
@ -227,7 +227,7 @@ The [Document List component](../content-services/document-list.component.md) al
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.
The [Document List component](../content-services/document-list.component.md) supports default presets for all the custom sources mentioned earlier.
The [Document List component](document-list.component.md) supports default presets for all the custom sources mentioned earlier.
If you don't provide any custom column definition with the [Data Column](#custom-columns)
component then a default preset will be automatically used at runtime.
@ -395,7 +395,7 @@ export class FilesComponent implements OnInit {
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)
![documentLibrary](../../docassets/images/documentLibrary.png)
**Important note**: for this particular scenario you must also trigger `changeDetector.detectChanges()` as in the example above.
@ -456,7 +456,7 @@ export class MyAppComponent implements AfterViewInit {
The example above should produce the following browser console output:
![view-child](../docassets/images/viewchild.png)
![view-child](../../docassets/images/viewchild.png)
Now you can access Document List properties or call methods directly:
@ -475,7 +475,7 @@ documentation for a full explanation of the component lifecycle.
### Underlying node object
The [Document List component](../content-services/document-list.component.md) assigns an instance of
The [Document List component](document-list.component.md) assigns an instance of
[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)
(defined in the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api)) as the data context
for each row. You can make use of the properties of this object when defining custom columns:
@ -554,10 +554,10 @@ A custom set of columns might look like the following:
</adf-document-list>
```
![Custom columns](../docassets/images/custom-columns.png)
![Custom columns](../../docassets/images/custom-columns.png)
You can also use the HTML-based schema declaration used by
[DataTable](../core/datatable.component.md), [Task List](../process-services/task-list.component.md) and other components:
[DataTable](../../core/components/datatable.component.md), [Task List](../../process-services/components/task-list.component.md) and other components:
```html
<adf-datatable [data]="data" ...>
@ -571,7 +571,7 @@ You can also use the HTML-based schema declaration used by
</adf-datatable>
```
You can also add tooltips, styling, automatic column title translation and other features. See the [DataColumn component page](../core/data-column.component.md) for more information about specifying and customizing columns.
You can also add tooltips, styling, automatic column title translation and other features. See the [DataColumn component page](../../core/components/data-column.component.md) for more information about specifying and customizing columns.
### Column templates
@ -598,7 +598,7 @@ For example:
</data-column>
```
All the components above also participate in [Extensibility](../user-guide/app-extensions.md)
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.
### Date Column
@ -666,8 +666,8 @@ 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/context-menu.directive.md) from the
[ADF Core](https://www.npmjs.com/package/ng2-alfresco-core) library to show 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:
```ts
@ -682,13 +682,13 @@ export class MyView {
}
```
![Folder context menu](../docassets/images/folder-context-menu.png)
![Folder context menu](../../docassets/images/folder-context-menu.png)
This single extra line in the template enables context menu items for documents and folders.
### Navigation mode
By default, the [Document List component](../content-services/document-list.component.md) uses 'double-click' mode for navigation.
By default, the [Document List component](document-list.component.md) uses 'double-click' mode for navigation.
That means that the user will see the contents of the folder when they double-click its name
or icon (in a similar manner to Google Drive). However, there is also a single-click mode that
may be sometimes be useful.
@ -711,15 +711,15 @@ 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.
See the [Image Resolver Model](image-resolver.model.md)
and [Row Filter Model](row-filter.model.md) pages for details of how to
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
implement these functions.
### Custom 'empty folder' template
By default, the Document List provides the following content for the empty folder:
![Default empty folder](../docassets/images/empty-folder-template-default.png)
![Default empty folder](../../docassets/images/empty-folder-template-default.png)
However, you can change this by defining your own custom HTML template:
@ -733,14 +733,14 @@ However, you can change this by defining your own custom HTML template:
This will give the following output:
![Custom empty folder](../docassets/images/empty-folder-template-custom.png)
![Custom empty folder](../../docassets/images/empty-folder-template-custom.png)
### Custom 'permission denied' template
By default, the Document List shows the following content when permission
is denied:
![Default no permission](../docassets/images/no-permission-default.png)
![Default no permission](../../docassets/images/no-permission-default.png)
You can change this by defining your own custom HTML template:
@ -754,13 +754,13 @@ You can change this by defining your own custom HTML template:
This will give the following output:
![Custom no permission](../docassets/images/no-permission-custom.png)
![Custom no permission](../../docassets/images/no-permission-custom.png)
### Custom 'loading' template
By default, the Document List shows the following content when the content is loading:
![Default loading](../docassets/images/default-loading.png)
![Default loading](../../docassets/images/default-loading.png)
You can change this by defining your own custom HTML template:
@ -775,22 +775,22 @@ You can change this by defining your own custom HTML template:
This will give the following output:
![Custom loading](../docassets/images/custom-loading.png)
![Custom loading](../../docassets/images/custom-loading.png)
## See also
- [Datatable component](../core/datatable.component.md)
- [Data column component](../core/data-column.component.md)
- [Pagination component](../core/pagination.component.md)
- [Infinite pagination component](../core/infinite-pagination.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/nodes-api.service.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](document-list.service.md)
- [Document list service](../services/document-list.service.md)
- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md)
- [Permissions style model](permissions-style.model.md)
- [Permissions style model](../models/permissions-style.model.md)
- [Version manager component](version-manager.component.md)
- [Viewer component](../core/viewer.component.md)
- [Viewer component](../../core/components/viewer.component.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Dropdown Breadcrumb Component](../../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts "Defined in dropdown-breadcrumb.component.ts")
# [Dropdown Breadcrumb Component](../../../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts "Defined in dropdown-breadcrumb.component.ts")
Indicates the current position within a navigation hierarchy using a dropdown menu.
![Dropdown Breadcrumb screenshot](../docassets/images/DropdownBreadcrumb.png)
![Dropdown Breadcrumb screenshot](../../docassets/images/DropdownBreadcrumb.png)
## Basic Usage
@ -30,7 +30,7 @@ Indicates the current position within a navigation hierarchy using a dropdown me
| 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/document-list.component.md) | | (optional) [Document List component](../content-services/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. |
| 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
@ -41,8 +41,8 @@ Indicates the current position within a navigation hierarchy using a dropdown me
## Details
Although this component inherits the `maxItems` property from the [Breadcrumb component,](../content-services/breadcrumb.component.md) the
"crumbs" are _always_ shown on a menu. By contrast, the [Breadcrumb component](../content-services/breadcrumb.component.md) only falls back
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.
## See also

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [File Uploading Dialog Component](../../lib/content-services/upload/components/file-uploading-dialog.component.ts "Defined in file-uploading-dialog.component.ts")
# [File Uploading Dialog Component](../../../lib/content-services/upload/components/file-uploading-dialog.component.ts "Defined in file-uploading-dialog.component.ts")
Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components.
@ -39,4 +39,4 @@ This component should be used in combination with the
- [Upload button component](upload-button.component.md)
- [Upload drag area component](upload-drag-area.component.md)
- [File upload error pipe](../content-services/file-upload-error.pipe.md)
- [File upload error pipe](../pipes/file-upload-error.pipe.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-14
---
# [Like component](../../lib/content-services/social/like.component.ts "Defined in like.component.ts")
# [Like component](../../../lib/content-services/social/like.component.ts "Defined in like.component.ts")
Allows a user to add "likes" to an item.
![Custom columns](../docassets/images/social1.png)
![Custom columns](../../docassets/images/social1.png)
## Basic Usage
@ -34,4 +34,4 @@ Allows a user to add "likes" to an item.
## See also
- [Rating component](rating.component.md)
- [Rating service](rating.service.md)
- [Rating service](../services/rating.service.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Permission List Component](../../lib/content-services/permission-manager/components/permission-list/permission-list.component.ts "Defined in permission-list.component.ts")
# [Permission List Component](../../../lib/content-services/permission-manager/components/permission-list/permission-list.component.ts "Defined in permission-list.component.ts")
Shows node permissions as a table.
![Permission List](../docassets/images/adf-permission-list.png)
![Permission List](../../docassets/images/adf-permission-list.png)
## Basic Usage
@ -18,7 +18,7 @@ Shows node permissions as a table.
</adf-permission-list>
```
### [Transclusions](../user-guide/transclusion.md)
### [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:
@ -44,11 +44,11 @@ but you can also supply your own content:
| 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>` | Emitted when the permission is updated. |
| update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/PermissionElement.md)`>` | Emitted when the permission is updated. |
## Details
This component uses a [Datatable component](../core/datatable.component.md) to show the
permissions retrieved from the [Node service](../core/node.service.md).
This component uses a [Datatable component](../../core/components/datatable.component.md) to show the
permissions retrieved from the [Node service](../../core/services/node.service.md).
For the locally set permissions a role dropdown will be shown to let the user select a new role.
When the user selects a new value, the permission role is automatically updated and the `update` event is emitted.

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-14
---
# [Rating component](../../lib/content-services/social/rating.component.ts "Defined in rating.component.ts")
# [Rating component](../../../lib/content-services/social/rating.component.ts "Defined in rating.component.ts")
Allows a user to add ratings to an item.
![Rating component screenshot](../docassets/images/social2.png)
![Rating component screenshot](../../docassets/images/social2.png)
## Basic Usage
@ -36,4 +36,4 @@ Allows a user to add ratings to an item.
## See also
- [Like component](like.component.md)
- [Rating service](rating.service.md)
- [Rating service](../services/rating.service.md)

20
docs/content-services/search-check-list.component.md → docs/content-services/components/search-check-list.component.md
View File

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-11
---
# [Search check list component](../../lib/content-services/search/components/search-check-list/search-check-list.component.ts "Defined in search-check-list.component.ts")
# [Search check list component](../../../lib/content-services/search/components/search-check-list/search-check-list.component.ts "Defined in search-check-list.component.ts")
Implements a checklist widget for the [Search Filter component](../content-services/search-filter.component.md).
Implements a checklist widget for the [Search Filter component](search-filter.component.md).
![Check list widget screenshot](../docassets/images/search-check-list.png)
![Check list widget screenshot](../../docassets/images/search-check-list.png)
## Basic usage
@ -48,7 +48,7 @@ Implements a checklist widget for the [Search Filter component](../content-servi
## Details
This widget displays a list of checkboxes, each of which toggles a particular query fragment
in the search. See the [Search filter component](../content-services/search-filter.component.md) for full details of how to use the widgets
in the search. See the [Search filter component](search-filter.component.md) for full details of how to use the widgets
in a search query.
In the settings, the `options` array, defines the checkboxes that toggle the supplied query
@ -70,9 +70,9 @@ items in the list.
## See also
- [Search filter component](../content-services/search-filter.component.md)
- [Search date range component](../content-services/search-date-range.component.md)
- [Search number range component](../content-services/search-number-range.component.md)
- [Search radio component](../content-services/search-radio.component.md)
- [Search slider component](../content-services/search-slider.component.md)
- [Search text component](../content-services/search-text.component.md)
- [Search filter component](search-filter.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)

28
docs/content-services/components/search-chip-list.component.md Normal file
View File

@ -0,0 +1,28 @@
---
Title: Search Chip List Component
Added: v2.3.0
Status: Active
Last reviewed: 2018-09-14
---
# [Search Chip List Component](../../../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts "Defined in search-chip-list.component.ts")
Displays search criteria as a set of "chips".
![Selected Facets](../../docassets/images/selected-facets.png)
## Basic usage
```html
<adf-search-chip-list [searchFilter]="searchFilter"></adf-search-chip-list>
<adf-search-filter #searchFilter></adf-search-filter>
```
## Class members
### 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. |

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Search control component](../../lib/content-services/search/components/search-control.component.ts "Defined in search-control.component.ts")
# [Search control component](../../../lib/content-services/search/components/search-control.component.ts "Defined in search-control.component.ts")
Displays a input text that shows find-as-you-type suggestions.
![adf-search-control](../docassets/images/search-control-component.png)
![adf-search-control](../../docassets/images/search-control-component.png)
## Basic usage
@ -21,7 +21,7 @@ Displays a input text that shows find-as-you-type suggestions.
</adf-search-control>
```
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
You can show your own custom template when no results are found for the search:

20
docs/content-services/search-date-range.component.md → docs/content-services/components/search-date-range.component.md
View File

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-11
---
# [Search date range component](../../lib/content-services/search/components/search-date-range/search-date-range.component.ts "Defined in search-date-range.component.ts")
# [Search date range component](../../../lib/content-services/search/components/search-date-range/search-date-range.component.ts "Defined in search-date-range.component.ts")
Implements a date range widget for the [Search Filter component](../content-services/search-filter.component.md).
Implements a date range widget for the [Search Filter component](search-filter.component.md).
![Date Range Widget](../docassets/images/search-date-range.png)
![Date Range Widget](../../docassets/images/search-date-range.png)
## Basic usage
@ -43,7 +43,7 @@ Implements a date range widget for the [Search Filter component](../content-serv
## Details
This component lets the user select a range between two dates based on the particular `field`.
See the [Search filter component](../content-services/search-filter.component.md) for full details of how to use widgets
See the [Search filter component](search-filter.component.md) for full details of how to use widgets
in a search query.
### Custom date format
@ -75,9 +75,9 @@ in the `dateFormat` setting:
## See also
- [Search filter component](../content-services/search-filter.component.md)
- [Search check list component](../content-services/search-check-list.component.md)
- [Search number range component](../content-services/search-number-range.component.md)
- [Search radio component](../content-services/search-radio.component.md)
- [Search slider component](../content-services/search-slider.component.md)
- [Search text component](../content-services/search-text.component.md)
- [Search filter component](search-filter.component.md)
- [Search check list component](search-check-list.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)

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-12
---
# [Search Filter component](../../lib/content-services/search/components/search-filter/search-filter.component.ts "Defined in search-filter.component.ts")
# [Search Filter component](../../../lib/content-services/search/components/search-filter/search-filter.component.ts "Defined in search-filter.component.ts")
Represents a main container component for custom search and faceted search settings.
@ -19,6 +19,7 @@ Represents a main container component for custom search and faceted search setti
- [Categories and widgets](#categories-and-widgets)
- [Facet Fields](#facet-fields)
- [Facet Queries](#facet-queries)
- [Facet Intervals](#facet-intervals)
- [See also](#see-also)
## Basic usage
@ -30,7 +31,7 @@ Represents a main container component for custom search and faceted search setti
## Details
The component UI uses dynamically created widgets to specify the search query and its
options. It then uses the [Search Query Builder service](search-query-builder.service.md)
options. It then uses the [Search Query Builder service](../services/search-query-builder.service.md)
to build and execute the query.
You may find it useful to check out the following resources for background information
@ -188,8 +189,8 @@ The properties of the `options` objects are as follows:
| Name | Type | Description |
| ---- | ---- | ----------- |
| key | string | Unique key to identify the entry. This can also be used to map [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) instances. |
| label | string | Display text, which can also be an [i18n resource key](../user-guide/internationalization.md). |
| key | string | Unique key to identify the entry. This can also be used to map [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) instances. |
| label | string | Display text, which can also be an [i18n resource key](../../user-guide/internationalization.md). |
| type | string | This specifies how to order the results. It can be based on a field, based on the position of the document in the index, or by score/relevance. |
| field | string | The name of the field. |
| ascending | boolean | The sorting order defined as `true` for ascending order and `false` for descending order |
@ -222,7 +223,7 @@ export interface SearchCategory {
The interface above also describes entries in the `search.query.categories` section for the `app.config.json` file.
![Search Categories](../docassets/images/search-categories-01.png)
![Search Categories](../../docassets/images/search-categories-01.png)
> **Note:** you must provide at least one category field in order to execute the query,
> so that filters and selected facets are applied.
@ -240,9 +241,9 @@ a category:
| [Slider](search-slider.component.md) | `slider` | Selects a single numeric value in a given range that a field may contain |
| [Text](search-text.component.md) | `text` | Specifies a text value that a field may contain |
See the individual [search widget](../../lib/content-services/search/search-widget.interface.ts) pages for full details of their usage and settings.
See the individual [Search Widget](../interfaces/search-widget.interface.md) pages for full details of their usage and settings.
You can also implement your own custom search widgets. See the [`SearchWidget`](../../lib/content-services/search/search-widget.interface.ts) interface
You can also implement your own custom search widgets. See the [Search Widget Interface](../interfaces/search-widget.interface.md) interface
page for full details of how to do this.
#### Widget settings
@ -251,7 +252,7 @@ Each type of widget 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 using the
[`SearchWidgetSettings`](../../lib/content-services/search/search-widget-settings.interface.ts) interface:
[`SearchWidgetSettings`](../../../lib/content-services/search/search-widget-settings.interface.ts) interface:
```ts
export interface SearchWidgetSettings {
@ -285,7 +286,7 @@ 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.
![Facet Fields](../docassets/images/search-facet-fields.png)
![Facet Fields](../../docassets/images/search-facet-fields.png)
#### FacetField Properties
@ -332,6 +333,7 @@ exceeds the `pageSize` value.
You can also provide a custom `label` (or i18n resource key) for the default resulting collapsible category.
If you need to display more resulting collapsible categories, you can group different facet queries under custom labels by using the `group` property on those facet queries:
```json
{
"search": {
@ -356,27 +358,29 @@ If you need to display more resulting collapsible categories, you can group diff
}
}
```
This will result in the following display of the grouped facet queries:
![Grouped Facet Queries](../docassets/images/search-facet-queries-groups.png)
![Grouped Facet Queries](../../docassets/images/search-facet-queries-groups.png)
The `pageSize` property allows you to define the number of results to display.
Users will see `Show more` or `Show less` buttons as appropriate for the result set.
The default page size of 5 will be used if you set the value to 0 or omit it entirely.
![Facet Queries](../docassets/images/search-facet-queries.png)
![Facet Queries](../../docassets/images/search-facet-queries.png)
### Facet Intervals
These provide custom categories based on admin defined ranges inside `intervals`. What is wanted for every interval can be specified exactly in the config file, and having overlapping ranges could also be possible.
#### FacetIntervals Properties
| Name | Type | Description |
| ---- | ---- | ----------- |
|intervals|array|Specifies the fields to facet by interval.|
|expanded|boolean|Toggles expanded state of the facet intervals.|
Note: `sets` parameter from Search API (Sets the intervals for all fields) is not yet supported.
| intervals | array | Specifies the fields to facet by interval. |
| expanded | boolean | Toggles expanded state of the facet intervals. |
Note: `sets` parameter from Search API (Sets the intervals for all fields) is not yet supported.
```json
{
@ -414,17 +418,17 @@ for more details about what is the structure and the properties of `intervals` t
Each `intervals` item defined is collected into its collapsible category identified uniquely by its `label`. The top code snippet will result in the following display of the facet intervals:
![Facet Intervals](../docassets/images/search-facet-intervals.png)
![Facet Intervals](../../docassets/images/search-facet-intervals.png)
## See also
- [Search Query Builder service](search-query-builder.service.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)
- [`SearchWidget`](../../lib/content-services/search/search-widget.interface.ts)
- [Search check list component](../content-services/search-check-list.component.md)
- [Search date range component](../content-services/search-date-range.component.md)
- [Search number range component](../content-services/search-number-range.component.md)
- [Search radio component](../content-services/search-radio.component.md)
- [Search slider component](../content-services/search-slider.component.md)
- [Search text component](../content-services/search-text.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)

22
docs/content-services/search-number-range.component.md → docs/content-services/components/search-number-range.component.md
View File

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-11
---
# [Search number range component](../../lib/content-services/search/components/search-number-range/search-number-range.component.ts "Defined in search-number-range.component.ts")
# [Search number range component](../../../lib/content-services/search/components/search-number-range/search-number-range.component.ts "Defined in search-number-range.component.ts")
Implements a number range widget for the [Search Filter component](../content-services/search-filter.component.md).
Implements a number range widget for the [Search Filter component](search-filter.component.md).
![Number Range Widget](../docassets/images/search-number-range.png)
![Number Range Widget](../../docassets/images/search-number-range.png)
## Basic usage
@ -44,7 +44,7 @@ Implements a number range widget for the [Search Filter component](../content-se
## Details
This component lets the user specify a range between two predefined numbers based on the
particular `field`. See the [Search filter component](../content-services/search-filter.component.md) for full details of how to use widgets
particular `field`. See the [Search filter component](search-filter.component.md) for full details of how to use widgets
in a search query.
#### Range query format
@ -70,10 +70,10 @@ cm:content.size:[0 TO 100]
## See also
- [Search filter component](../content-services/search-filter.component.md)
- [Search check list component](../content-services/search-check-list.component.md)
- [Search date range component](../content-services/search-date-range.component.md)
- [Search number range component](../content-services/search-number-range.component.md)
- [Search radio component](../content-services/search-radio.component.md)
- [Search slider component](../content-services/search-slider.component.md)
- [Search text component](../content-services/search-text.component.md)
- [Search filter component](search-filter.component.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)

22
docs/content-services/search-radio.component.md → docs/content-services/components/search-radio.component.md
View File

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-08-10
---
# [Search radio component](../../lib/content-services/search/components/search-radio/search-radio.component.ts "Defined in search-radio.component.ts")
# [Search radio component](../../../lib/content-services/search/components/search-radio/search-radio.component.ts "Defined in search-radio.component.ts")
Implements a radio button list widget for the [Search Filter component](../content-services/search-filter.component.md).
Implements a radio button list widget for the [Search Filter component](search-filter.component.md).
![Radio Widget screenshot](../docassets/images/search-radio.png)
![Radio Widget screenshot](../../docassets/images/search-radio.png)
## Basic usage
@ -50,8 +50,8 @@ Implements a radio button list widget for the [Search Filter component](../conte
This component displays a list of radio buttons, each of which toggles a particular
query fragment in the search. This behaviour is very similar to that of the
[Search check list component](../content-services/search-check-list.component.md) except only one item at a time can be selected. See the
[Search filter component](../content-services/search-filter.component.md) for full details of how to use the widgets in a search query.
[Search check list component](search-check-list.component.md) except only one item at a time can be selected. See the
[Search filter component](search-filter.component.md) for full details of how to use the widgets in a search query.
The component can be set to split a long list of buttons into separate pages
using the `pageSize` value as the number of buttons to show per page (default is 5).
@ -60,9 +60,9 @@ buttons as appropriate.
## See also
- [Search filter component](../content-services/search-filter.component.md)
- [Search check list component](../content-services/search-check-list.component.md)
- [Search date range component](../content-services/search-date-range.component.md)
- [Search number range component](../content-services/search-number-range.component.md)
- [Search slider component](../content-services/search-slider.component.md)
- [Search text component](../content-services/search-text.component.md)
- [Search filter component](search-filter.component.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 slider component](search-slider.component.md)
- [Search text component](search-text.component.md)

20
docs/content-services/search-slider.component.md → docs/content-services/components/search-slider.component.md
View File

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-11
---
# [Search slider component](../../lib/content-services/search/components/search-slider/search-slider.component.ts "Defined in search-slider.component.ts")
# [Search slider component](../../../lib/content-services/search/components/search-slider/search-slider.component.ts "Defined in search-slider.component.ts")
Implements a numeric slider widget for the [Search Filter component](../content-services/search-filter.component.md).
Implements a numeric slider widget for the [Search Filter component](search-filter.component.md).
![Slider Widget](../docassets/images/search-slider.png)
![Slider Widget](../../docassets/images/search-slider.png)
## Basic usage
@ -50,7 +50,7 @@ Implements a numeric slider widget for the [Search Filter component](../content-
## Details
This component lets the user select from a range between two predefined numbers based on the
particular `field`. See the [Search filter component](../content-services/search-filter.component.md) for full
particular `field`. See the [Search filter component](search-filter.component.md) for full
details of how to use widgets in a search query.
### Resetting the slider value
@ -67,9 +67,9 @@ or zero and the corresponsing query fragment is removed from the query.
## See also
- [Search filter component](../content-services/search-filter.component.md)
- [Search check list component](../content-services/search-check-list.component.md)
- [Search date range component](../content-services/search-date-range.component.md)
- [Search number range component](../content-services/search-number-range.component.md)
- [Search radio component](../content-services/search-radio.component.md)
- [Search text component](../content-services/search-text.component.md)
- [Search filter component](search-filter.component.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 text component](search-text.component.md)

2
docs/content-services/search-sorting-picker.component.md → docs/content-services/components/search-sorting-picker.component.md
View File

@ -4,7 +4,7 @@ Added: v2.3.0
Status: Active
---
# [Search Sorting Picker Component](../../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts "Defined in search-sorting-picker.component.ts")
# [Search Sorting Picker Component](../../../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts "Defined in search-sorting-picker.component.ts")
Provides an ability to select one of the predefined sorting definitions for search results:

20
docs/content-services/search-text.component.md → docs/content-services/components/search-text.component.md
View File

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-11
---
# [Search text component](../../lib/content-services/search/components/search-text/search-text.component.ts "Defined in search-text.component.ts")
# [Search text component](../../../lib/content-services/search/components/search-text/search-text.component.ts "Defined in search-text.component.ts")
Implements a text input widget for the [Search Filter component](../content-services/search-filter.component.md).
Implements a text input widget for the [Search Filter component](search-filter.component.md).
![Text Widget](../docassets/images/search-text.png)
![Text Widget](../../docassets/images/search-text.png)
## Basic usage
@ -47,14 +47,14 @@ Implements a text input widget for the [Search Filter component](../content-serv
## Details
This component lets the user add a text value to search for in the specified
`field`. See the [Search filter component](../content-services/search-filter.component.md) for full
`field`. See the [Search filter component](search-filter.component.md) for full
details of how to use widgets in a search query.
## See also
- [Search filter component](../content-services/search-filter.component.md)
- [Search check list component](../content-services/search-check-list.component.md)
- [Search date range component](../content-services/search-date-range.component.md)
- [Search number range component](../content-services/search-number-range.component.md)
- [Search radio component](../content-services/search-radio.component.md)
- [Search slider component](../content-services/search-slider.component.md)
- [Search filter component](search-filter.component.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)

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Search component](../../lib/content-services/search/components/search.component.ts "Defined in search.component.ts")
# [Search component](../../../lib/content-services/search/components/search.component.ts "Defined in search.component.ts")
Searches items for supplied search terms.
@ -47,7 +47,7 @@ Searches items for supplied search terms.
| 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`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when search results have fully loaded. |
| resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when search results have fully loaded. |
## Details
@ -73,7 +73,7 @@ You can add a custom template to show the search results when once they are load
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)
![adf-search-control](../../docassets/images/search-component-simple-template.png)
However, you can use a more complex template if necessary:
@ -121,11 +121,11 @@ However, you can use a more complex template if necessary:
<!-- {% endraw %} -->
![adf-search-control](../docassets/images/search-component-complex-template.png)
![adf-search-control](../../docassets/images/search-component-complex-template.png)
### Attach an input field to the search
You can also attach an input field to the [search component](../content-services/search.component.md) via the `searchAutocomplete` property.
You can also attach an input field to the [search component](search.component.md) via the `searchAutocomplete` property.
Export the search panel instance into a local template variable and bind that variable to the
input's `searchAutocomplete` property. The example below demonstrates this with an
instance called "search":
@ -153,12 +153,12 @@ By doing this, you can get the results as the user types into the input text.
You can get finer control over the parameters of a search by defining them in a custom
[QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md)
object. The recommended way to do this is with a custom implementation of the
[Search Configuration interface](../core/search-configuration.interface.md). The ADF source provides a standard implementation of this
interface, [`SearchConfigurationService`](../core/search-configuration.service.md) that you can use as a base to adapt to your needs. See the
[Search Configuration interface](../core/search-configuration.interface.md) page for full details of how to
[Search Configuration interface](../../core/interfaces/search-configuration.interface.md). The ADF source provides a standard implementation of this
interface, [`SearchConfigurationService`](../../core/services/search-configuration.service.md) that you can use as a base to adapt to your needs. See the
[Search Configuration interface](../../core/interfaces/search-configuration.interface.md) page for full details of how to
customize your search.
## See Also
- [Search configuration interface](../core/search-configuration.interface.md)
- [Search configuration service](../core/search-configuration.service.md)
- [Search configuration interface](../../core/interfaces/search-configuration.interface.md)
- [Search configuration service](../../core/services/search-configuration.service.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Sites Dropdown component](../../lib/content-services/site-dropdown/sites-dropdown.component.ts "Defined in sites-dropdown.component.ts")
# [Sites Dropdown component](../../../lib/content-services/site-dropdown/sites-dropdown.component.ts "Defined in sites-dropdown.component.ts")
Displays a dropdown menu to show and interact with the sites of the current user.
![Dropdown sites](../docassets/images/document-list-dropdown-list.png)
![Dropdown sites](../../docassets/images/document-list-dropdown-list.png)
## Basic Usage

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Tag Node Actions List component](../../lib/content-services/tag/tag-actions.component.ts "Defined in tag-actions.component.ts")
# [Tag Node Actions List component](../../../lib/content-services/tag/tag-actions.component.ts "Defined in tag-actions.component.ts")
Shows available actions for tags.
![Custom columns](../docassets/images/tag3.png)
![Custom columns](../../docassets/images/tag3.png)
## Basic Usage

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-14
---
# [Tag List component](../../lib/content-services/tag/tag-list.component.ts "Defined in tag-list.component.ts")
# [Tag List component](../../../lib/content-services/tag/tag-list.component.ts "Defined in tag-list.component.ts")
Shows tags for an item.
![Custom columns](../docassets/images/tag2.png)
![Custom columns](../../docassets/images/tag2.png)
## Class members
@ -21,4 +21,4 @@ Shows tags for an item.
## See Also
- [Tag service](tag.service.md)
- [Tag service](../services/tag.service.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Tag Node List component](../../lib/content-services/tag/tag-node-list.component.ts "Defined in tag-node-list.component.ts")
# [Tag Node List component](../../../lib/content-services/tag/tag-node-list.component.ts "Defined in tag-node-list.component.ts")
Shows tags for a node.
![Custom columns](../docassets/images/tag1.png)
![Custom columns](../../docassets/images/tag1.png)
## Basic Usage

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Tree View component](../../lib/content-services/tree-view/components/tree-view.component.ts "Defined in tree-view.component.ts")
# [Tree View component](../../../lib/content-services/tree-view/components/tree-view.component.ts "Defined in tree-view.component.ts")
Shows the folder and subfolders of a node as a tree view.
![TreeView component screenshot](../docassets/images/tree-view.png)
![TreeView component screenshot](../../docassets/images/tree-view.png)
## Basic Usage

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Upload Button Component](../../lib/content-services/upload/components/upload-button.component.ts "Defined in upload-button.component.ts")
# [Upload Button Component](../../../lib/content-services/upload/components/upload-button.component.ts "Defined in upload-button.component.ts")
Activates a file upload.
@ -46,9 +46,9 @@ Activates a file upload.
| Name | Type | Description |
| ---- | ---- | ----------- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../lib/content-services/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the file is uploaded successfully. |
## Details
@ -58,7 +58,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
[Notification service](../core/notification.service.md) to show a message.
[Notification service](../../core/services/notification.service.md) to show a message.
```html
<adf-upload-button
@ -79,9 +79,9 @@ export class MyComponent {
}
```
![Upload notification message](../docassets/images/upload-notification-message.png)
![Upload notification message](../../docassets/images/upload-notification-message.png)
## See also
- [Upload Version Button component](upload-version-button.component.md)
- [File upload error pipe](../content-services/file-upload-error.pipe.md)
- [File upload error pipe](../pipes/file-upload-error.pipe.md)

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Upload Drag Area Component](../../lib/content-services/upload/components/upload-drag-area.component.ts "Defined in upload-drag-area.component.ts")
# [Upload Drag Area Component](../../../lib/content-services/upload/components/upload-drag-area.component.ts "Defined in upload-drag-area.component.ts")
Adds a drag and drop area to upload files to ACS.
@ -42,7 +42,7 @@ export class AppComponent {
}
```
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
You can supply any content in the `<adf-upload-drag-area>` to display
as the drag/drop target:
@ -74,7 +74,7 @@ as the drag/drop target:
| Name | Type | Description |
| ---- | ---- | ----------- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the file is uploaded successfully. |
@ -84,9 +84,9 @@ as the drag/drop target:
You can intercept the upload process using the `beginUpload` event.
The event has a type of [`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts) and provides the following APIs:
The event has a type of [`UploadFilesEvent`](../../../lib/content-services/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
- **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
@ -138,6 +138,6 @@ This could be either a selection of 2 or more files, or a folder with multiple e
## See also
- [File uploading dialog component](../content-services/file-uploading-dialog.component.md)
- [Upload button component](../content-services/upload-button.component.md)
- [File upload error pipe](../content-services/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)

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

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2018-03-23
---
# [Upload Version Button Component (Workaround)](../../lib/content-services/upload/components/upload-version-button.component.ts "Defined in upload-version-button.component.ts")
# [Upload Version Button Component (Workaround)](../../../lib/content-services/upload/components/upload-version-button.component.ts "Defined in upload-version-button.component.ts")
Activates a file version upload.
@ -49,9 +49,9 @@ to enrich the features and decrease the restrictions currently applied to node v
| Name | Type | Description |
| ---- | ---- | ----------- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../lib/content-services/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the file is uploaded successfully. |
## Details
@ -59,7 +59,7 @@ to enrich the features and decrease the restrictions currently applied to node v
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
sense when applied to the [Upload Version Button component,](../content-services/upload-version-button.component.md) so they are simply ignored.
sense when applied to the [Upload Version Button component](upload-version-button.component.md) so they are simply ignored.
## See also

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

@ -5,9 +5,9 @@ Status: Experimental
Last reviewed: 2019-01-16
---
# [Version List component](../../lib/content-services/version-manager/version-list.component.ts "Defined in version-list.component.ts")
# [Version List component](../../../lib/content-services/version-manager/version-list.component.ts "Defined in version-list.component.ts")
Displays the version history of a node in a [Version Manager component](../content-services/version-manager.component.md).
Displays the version history of a node in a [Version Manager component](version-manager.component.md).
### Basic Usage
@ -22,7 +22,7 @@ Displays the version history of a node in a [Version Manager component](../conte
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| node | `Node` | | The target node. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | The target node. |
| showActions | `boolean` | true | Toggles showing/hiding of version actions |
| showComments | `boolean` | true | Toggles showing/hiding of comments |
@ -30,12 +30,12 @@ Displays the version history of a node in a [Version Manager component](../conte
| Name | Type | Description |
| ---- | ---- | ----------- |
| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when a version is deleted |
| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when a version is restored |
| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is deleted |
| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is restored |
## Details
This component is used by the [Version Manager component](../content-services/version-manager.component.md) to
This component is used by the [Version Manager component](version-manager.component.md) to
load and displays the version history of a node.
If you want show readonly version list you set this component with showActions false:

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

@ -5,11 +5,11 @@ Status: Experimental
Last reviewed: 2019-01-16
---
# [Version Manager Component](../../lib/content-services/version-manager/version-manager.component.ts "Defined in version-manager.component.ts")
# [Version Manager Component](../../../lib/content-services/version-manager/version-manager.component.ts "Defined in version-manager.component.ts")
Displays the version history of a node with the ability to upload a new version.
![Version Manager](../docassets/images/version-manager.png)
![Version Manager](../../docassets/images/version-manager.png)
`This component is still in experimental phase. It has several limitations which will be resolved soon.`

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14
---
# [Webscript component](../../lib/content-services/webscript/webscript.component.ts "Defined in webscript.component.ts")
# [Webscript component](../../../lib/content-services/webscript/webscript.component.ts "Defined in webscript.component.ts")
Provides access to Webscript features.
@ -36,7 +36,7 @@ Provides access to Webscript features.
Another example:
**[app.component](../../demo-shell/src/app/app.component.ts).html**
**app.component.html**
```html
<adf-webscript-get
@ -48,7 +48,7 @@ Another example:
</adf-webscript-get>
```
**[app.component](../../demo-shell/src/app/app.component.ts).ts**
**app.component.ts**
```ts
export class AppComponent {
@ -81,7 +81,7 @@ export class AppComponent {
### Webscript View HTML example
This sample demonstrates how to implement a [Webscript component](../content-services/webscript.component.md) that renders the HTML contents that come from a webscript
This sample demonstrates how to implement a [Webscript component](webscript.component.md) that renders the HTML contents that come from a webscript
This sample Web Scripts reside in your Alfresco Server. You can access the folder webscript here:
`http://localhost:8080/alfresco/service/sample/folder/Company%20Home`
@ -96,11 +96,11 @@ 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
This sample demonstrates how to implement a [Webscript component](../content-services/webscript.component.md) that renders the JSON contents that come from a webscript
This sample demonstrates how to implement a [Webscript component](webscript.component.md) that renders the JSON contents that come from a webscript
`http://localhost:8080/alfresco/service/sample/folder/DATATABLE`
@ -115,7 +115,7 @@ This sample demonstrates how to implement a [Webscript component](../content-ser
```
If you want to show the result from a webscript inside a
[datatable component](../core/datatable.component.md)
[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:
@ -155,11 +155,11 @@ data: [
This will render the following table:
![Custom columns](../docassets/images/datatable.png)
![Custom columns](../../docassets/images/datatable.png)
### Webscript View JSON example
This sample demonstrates how to implement a [Webscript component](../content-services/webscript.component.md) that renders the JSON contents that come from a webscript.
This sample demonstrates how to implement a [Webscript component](webscript.component.md) that renders the JSON contents that come from a webscript.
This sample webscript resides in your Alfresco Server. You can access the folder webscript here:
`http://localhost:8080/alfresco/service/sample/folder/JSON%EXAMPLE`

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

@ -1,77 +0,0 @@
---
Title: Custom Resources service
Added: v2.3.0
Status: Active
Last reviewed: 2018-11-16
---
# [Custom Resources service](../../lib/content-services/document-list/services/custom-resources.service.ts "Defined in custom-resources.service.ts")
Manages Document List information that is specific to a user.
## Class members
### Methods
- **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
- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - 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 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/>
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[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of favorite files
- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts), includeFields: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of items contained in the folder
- **loadMemberSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of sites
- **loadSharedLinks**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of shared links
- **loadSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
Gets all sites in the repository.
- _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - 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
## Details
The `includeFields` parameter used by some of the methods lets you specify which data fields
you want in the result objects. See the
[Alfresco JSAPI](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SharedlinksApi.md#findSharedLinks)
for further details of the returned data and the available fields.
## See also
- [Document List component](document-list.component.md)

4
docs/content-services/confirm.dialog.md → docs/content-services/dialogs/confirm.dialog.md
View File

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-01-22
---
# [Confirm dialog component](../../lib/content-services/dialogs/confirm.dialog.ts "Defined in confirm.dialog.ts")
# [Confirm dialog component](../../../lib/content-services/dialogs/confirm.dialog.ts "Defined in confirm.dialog.ts")
Requests a yes/no choice from the user.
![Confirm dialog](../docassets/images/ConfirmDialog.png)
![Confirm dialog](../../docassets/images/ConfirmDialog.png)
## Basic Usage

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-12-07
---
# [Library dialog component](../../lib/content-services/dialogs/library/library.dialog.ts "Defined in library.dialog.ts")
# [Library dialog component](../../../lib/content-services/dialogs/library/library.dialog.ts "Defined in library.dialog.ts")
Creates a new Content Services document library/site.
![Dropdown sites](../docassets/images/CreateLibraryDialog.png)
![Dropdown sites](../../docassets/images/CreateLibraryDialog.png)
## Basic Usage
@ -39,4 +39,4 @@ section of the Content Services documentation for more information.
## See also
- [Sites dropdown component](sites-dropdown.component.md)
- [Sites dropdown component](../components/sites-dropdown.component.md)

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

@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-09-13
---
# [Node Public File Share Directive](../../lib/content-services/content-node-share/content-node-share.directive.ts "Defined in content-node-share.directive.ts")
# [Node Public File Share Directive](../../../lib/content-services/content-node-share/content-node-share.directive.ts "Defined in content-node-share.directive.ts")
Creates and manages public shared links for files.
![adf-share](../docassets/images/share-directive.png)
![adf-share](../../docassets/images/share-directive.png)
## Basic Usage
@ -53,13 +53,13 @@ For example, if you set the input parameter as follows:
...
}
...then the directive will ask the [Content service](../core/content.service.md) to generate
...then the directive will ask the [Content service](../../core/services/content.service.md) to generate
a `sharedId` for the file. This will create a URL like the following:
http://localhost:8080/myrouteForShareFile/NEW_GENERATED_SHAREID
To use this, you will need to implement some code that gets the `NEW_GENERATED_SHAREID` with the router
and passes it to a [Viewer component](../core/viewer.component.md):
and passes it to a [Viewer component](../../core/components/viewer.component.md):
```html
<adf-viewer

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-04-10
---
# [File Draggable directive](../../lib/content-services/upload/directives/file-draggable.directive.ts "Defined in file-draggable.directive.ts")
# [File Draggable directive](../../../lib/content-services/upload/directives/file-draggable.directive.ts "Defined in file-draggable.directive.ts")
Provides drag-and-drop features for an element such as a `div`.
@ -51,7 +51,7 @@ Some sample CSS to show the drag and drop area:
## Details
Typically you would use the [Upload Drag Area component](../content-services/upload-drag-area.component.md) instead of this directive.
Typically you would use the [Upload Drag Area component](../components/upload-drag-area.component.md) instead of this directive.
### Event handler implementations
@ -75,4 +75,4 @@ export class SomeComponent implements OnInit {
## See also
- [Upload Drag Area component](../content-services/upload-drag-area.component.md)
- [Upload Drag Area component](../components/upload-drag-area.component.md)

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Folder Create directive](../../lib/content-services/folder-directive/folder-create.directive.ts "Defined in folder-create.directive.ts")
# [Folder Create directive](../../../lib/content-services/folder-directive/folder-create.directive.ts "Defined in folder-create.directive.ts")
Creates folders.
@ -47,7 +47,7 @@ Creates folders.
Pass this directive the id of the parent folder where you want the new folder node to be created.
If no value is provided, the '-my-' alias is used.
This will open a [Folder Dialog component](../../lib/content-services/dialogs/folder.dialog.ts) to receive data for the new folder. If the data is valid
This will open a [Folder Dialog component](../../../lib/content-services/dialogs/folder.dialog.ts) to receive data for the new folder. If the data is valid
then the dialog will emit a `success` event when it closes.
## See also

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Folder Edit directive](../../lib/content-services/folder-directive/folder-edit.directive.ts "Defined in folder-edit.directive.ts")
# [Folder Edit directive](../../../lib/content-services/folder-directive/folder-edit.directive.ts "Defined in folder-edit.directive.ts")
Allows folders to be edited.
@ -44,5 +44,5 @@ Allows folders to be edited.
## Details
Pass this directive a folder to edit its name and description using a [Folder Dialog component](../../lib/content-services/dialogs/folder.dialog.ts).
Pass this directive a folder to edit its name and description using a [Folder Dialog component](../../../lib/content-services/dialogs/folder.dialog.ts).
If the data is valid then the dialog emits a `folderEdit` event when it closes.

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Inherit Permission directive](../../lib/content-services/permission-manager/components/inherited-button.directive.ts "Defined in inherited-button.directive.ts")
# [Inherit Permission directive](../../../lib/content-services/permission-manager/components/inherited-button.directive.ts "Defined in inherited-button.directive.ts")
Update the current node by adding/removing the inherited permissions.

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-17
---
# [Node Lock directive](../../lib/content-services/directives/node-lock.directive.ts "Defined in node-lock.directive.ts")
# [Node Lock directive](../../../lib/content-services/directives/node-lock.directive.ts "Defined in node-lock.directive.ts")
Locks or unlocks a node.
@ -35,10 +35,10 @@ but the indefinite lock remains in place until the user cancels it.
When a file is locked it can be locked and unlocked by default only by the user that creates the lock but you can also allow the other file owners to modify it:
![adf-lock](../docassets/images/lock-directive.png)
![adf-lock](../../docassets/images/lock-directive.png)
This directive calls the `openLockNodeDialog` method from the
[Content Node Dialog service](content-node-dialog.service.md)
[Content Node Dialog service](../services/content-node-dialog.service.md)
when clicked.
It disables the target button if the provided node is not a file or the user doesn't
have permissions.

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

@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2018-06-12
---
# [Search widget interface](../../lib/content-services/search/search-widget.interface.ts "Defined in search-widget.interface.ts")
# [Search widget interface](../../../lib/content-services/search/search-widget.interface.ts "Defined in search-widget.interface.ts")
Specifies required properties for [Search filter component](../content-services/search-filter.component.md) widgets.
Specifies required properties for [Search filter component](../components/search-filter.component.md) widgets.
## Contents
@ -35,21 +35,21 @@ export interface SearchWidget {
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| id | `string` | | Unique identifying value for the widget |
| settings | [`SearchWidgetSettings`](../../lib/content-services/search/search-widget-settings.interface.ts) | | Settings for component properties |
| context | [`SearchQueryBuilderService`](../content-services/search-query-builder.service.md) | | Instance of the [Search Query Builder service](../content-services/search-query-builder.service.md) to process the query |
| settings | [`SearchWidgetSettings`](../../../lib/content-services/search/search-widget-settings.interface.ts) | | Settings for component properties |
| context | [`SearchQueryBuilderService`](../services/search-query-builder.service.md) | | Instance of the [Search Query Builder service](../services/search-query-builder.service.md) to process the query |
## Details
The [Search Filter component](../content-services/search-filter.component.md) uses widgets to provide the UI that lets the user customize the
The [Search Filter component](../components/search-filter.component.md) uses widgets to provide the UI that lets the user customize the
search. ADF provides a number of widgets out of the box (see the [See Also](#see-also) section
for a full list) but you can also implement your own. Both built-in and custom widgets must
implement the [Search Widget](../../lib/content-services/search/search-widget.interface.ts) interface to operate with the [Search Filter component](../content-services/search-filter.component.md).
implement the [Search Widget](../../../lib/content-services/search/search-widget.interface.ts) interface to operate with the [Search Filter component](../components/search-filter.component.md).
### Implementing a custom widget
To create a custom Search Filter widget, start by generating a blank Angular component
that implements the
[`SearchWidget`](../../lib/content-services/search/search-widget.interface.ts)
[`SearchWidget`](../../../lib/content-services/search/search-widget.interface.ts)
interface:
```ts
@ -61,7 +61,7 @@ export interface SearchWidget {
```
Every widget implementation must have an `id`, and may also support external `settings`.
At runtime, every time a new instance of the widget is created, it also receives a reference to the [`SearchQueryBuilderService`](../content-services/search-query-builder.service.md)
At runtime, every time a new instance of the widget is created, it also receives a reference to the [Search Query Builder Service](../services/search-query-builder.service.md)
so that you component can access query related information, events and methods.
```ts
@ -110,7 +110,7 @@ export class MyComponent implements SearchWidget, OnInit {
### Updating the final query
The [`SearchQueryBuilderService`](../content-services/search-query-builder.service.md) keeps track of all query fragments that have been added by search widgets.
The [Search Query Builder Service](../services/search-query-builder.service.md) keeps track of all query fragments that have been added by search widgets.
When the query is complete, it composes the fragments together alongside other settings
that will be used when performing the actual query.
@ -142,7 +142,7 @@ When executed, your fragment will be injected into the resulting query based on
### Registering a custom widget
You must register your custom widgets with the [Search Filter service](../content-services/search-filter.service.md):
You must register your custom widgets with the [Search Filter service](../services/search-filter.service.md):
```ts
import { MyComponent } from './my-component.ts'
@ -184,10 +184,10 @@ and pass custom attributes, if your component supports them:
## See also
- [Search filter component](../content-services/search-filter.component.md)
- [Search check list component](../content-services/search-check-list.component.md)
- [Search date range component](../content-services/search-date-range.component.md)
- [Search number range component](../content-services/search-number-range.component.md)
- [Search radio component](../content-services/search-radio.component.md)
- [Search slider component](../content-services/search-slider.component.md)
- [Search text component](../content-services/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)

20
docs/content-services/image-resolver.model.md → docs/content-services/models/image-resolver.model.md
View File

@ -5,28 +5,28 @@ Status: Active
Last reviewed: 2019-02-08
---
# [Image Resolver Model](../../lib/content-services/document-list/data/image-resolver.model.ts "Defined in image-resolver.model.ts")
# [Image Resolver Model](../../../lib/content-services/document-list/data/image-resolver.model.ts "Defined in image-resolver.model.ts")
Defines the Image Resolver function used by the [Document List Component](../content-services/document-list.component.md).
Defines the Image Resolver function used by the [Document List Component](../components/document-list.component.md).
## Definitions
- `type` **ImageResolver** = (row: [`DataRow`](../../lib/core/datatable/data/data-row.model.ts), column: [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts)) => `string`
- _row:_ [`DataRow`](../../lib/core/datatable/data/data-row.model.ts) - Data that defines the row
- _column:_ [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) - Data that defines the column
- `type` **ImageResolver** = (row: [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts), column: [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts)) => `string`
- _row:_ [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) - Data that defines the row
- _column:_ [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) - Data that defines the column
- **Returns** File path for the image
## Details
An image resolver function selects an image file path for an item in
a [Document List Component](../content-services/document-list.component.md)
a [Document List Component](../components/document-list.component.md)
or another component that uses the Document List (such as the
[Content Node Selector Panel Component](content-node-selector-panel.component.md)). You can supply your own image resolver
[Content Node Selector Panel Component](../components/content-node-selector-panel.component.md)). You can supply your own image resolver
to manage the way folder/file icons and thumbnails are resolved (ie, which image is shown for which item).
**Note:** Image resolvers are executed only for columns of the `image` type.
A typical image resolver implementation receives [`DataRow`](../../lib/core/datatable/data/data-row.model.ts) and [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) objects as parameters:
A typical image resolver implementation receives [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) and [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) objects as parameters:
```ts
myImageResolver(row: DataRow, col: DataColumn): string {
@ -88,5 +88,5 @@ export class View1 {
## See also
- [Document List Component](../content-services/document-list.component.md)
- [Content Node Selector Panel Component](content-node-selector-panel.component.md)
- [Document List Component](../components/document-list.component.md)
- [Content Node Selector Panel Component](../components/content-node-selector-panel.component.md)

12
docs/content-services/permissions-style.model.md → docs/content-services/models/permissions-style.model.md
View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-02-13
---
# [Permission Style model](../../lib/content-services/document-list/models/permissions-style.model.ts "Defined in permissions-style.model.ts")
# [Permission Style model](../../../lib/content-services/document-list/models/permissions-style.model.ts "Defined in permissions-style.model.ts")
Sets custom CSS styles for rows of a Document List according to the item's permissions.
@ -13,8 +13,8 @@ Sets custom CSS styles for rows of a Document List according to the item's permi
### Properties
| Property | Type | Description |
| -------- | ---- | ----------- |
| [`Property`](../../../lib/content-services/content-metadata/interfaces/property.interface.ts) | Type | Description |
| --------------------------------------------------------------------------------------------- | ---- | ----------- |
| isFile | boolean | Does this style apply to files? |
| isFolder | boolean | Does this style apply to folders? |
| permission | Permissions | An enum value defining the permissions that this style applies to (see below) |
@ -22,9 +22,9 @@ Sets custom CSS styles for rows of a Document List according to the item's permi
## Details
You can customize the style of a [Document List](document-list.component.md) row based on the user's
You can customize the style of a [Document List](../components/document-list.component.md) row based on the user's
permissions for that item. The list has a `permissionsStyle` property containing an array of
[Permission Style model](../../lib/content-services/document-list/models/permissions-style.model.ts) objects. These objects associate a particular CSS style with a permission level
[Permission Style model](permissions-style.model.md) objects. These objects associate a particular CSS style with a permission level
and can be applied separately to files and folders by setting `isFile` and `isFolder` appropriately.
### Permissions enum
@ -75,4 +75,4 @@ adf-document-list ::ng-deep adf-datatable tr.document-list__disable {
## See also
- [Document list component](document-list.component.md)
- [Document list component](../components/document-list.component.md)

20
docs/content-services/row-filter.model.md → docs/content-services/models/row-filter.model.md
View File

@ -5,28 +5,28 @@ Status: Active
Last reviewed: 2019-02-08
---
# [Row Filter Model](../../lib/content-services/document-list/data/row-filter.model.ts "Defined in row-filter.model.ts")
# [Row Filter Model](../../../lib/content-services/document-list/data/row-filter.model.ts "Defined in row-filter.model.ts")
Defines the Row Filter function used by the [Document List Component](../content-services/document-list.component.md).
Defines the Row Filter function used by the [Document List Component](../components/document-list.component.md).
## Definitions
- `type` **RowFilter** = (value: [`ShareDataRow`](../../lib/content-services/document-list/data/share-data-row.model.ts), index: `number`, array: [`ShareDataRow`](../../lib/content-services/document-list/data/share-data-row.model.ts)`[]`) => any
- _value:_ [`ShareDataRow`](../../lib/content-services/document-list/data/share-data-row.model.ts) - Data that defines the row
- `type` **RowFilter** = (value: [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts), index: `number`, array: [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts)`[]`) => any
- _value:_ [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts) - Data that defines the row
- _index:_ `number` - Index of the row within the list
- _array:_ [`ShareDataRow`](../../lib/content-services/document-list/data/share-data-row.model.ts)`[]` - The full set of rows for the list
- _array:_ [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts)`[]` - The full set of rows for the list
- **Returns** True if the row should be shown, false otherwise
## Details
A row filter function selectively hides or shows rows from a [Document List Component](../content-services/document-list.component.md)
A row filter function selectively hides or shows rows from a [Document List Component](../components/document-list.component.md)
or another component that uses the Document List (such as the
[Content Node Selector Panel Component](content-node-selector-panel.component.md)).
[Content Node Selector Panel Component](../components/content-node-selector-panel.component.md)).
You can supply your own row filter to customize the behavior of the list.
The function returns `true` if the row should be
displayed or `false` if it should be hidden.
A typical row filter implementation receives at least a [`ShareDataRow`](../../lib/content-services/document-list/data/share-data-row.model.ts) object as a parameter:
A typical row filter implementation receives at least a [`ShareDataRow`](../../../lib/content-services/document-list/data/share-data-row.model.ts) object as a parameter:
```ts
myFilter(row: ShareDataRow): boolean {
@ -72,5 +72,5 @@ export class View1 {
## See also
- [Document List Component](../content-services/document-list.component.md)
- [Content Node Selector Panel Component](content-node-selector-panel.component.md)
- [Document List Component](../components/document-list.component.md)
- [Content Node Selector Panel Component](../components/content-node-selector-panel.component.md)

8
docs/content-services/file-upload-error.pipe.md → docs/content-services/pipes/file-upload-error.pipe.md
View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-17
---
# [File upload error pipe](../../lib/content-services/upload/pipes/file-upload-error.pipe.ts "Defined in file-upload-error.pipe.ts")
# [File upload error pipe](../../../lib/content-services/upload/pipes/file-upload-error.pipe.ts "Defined in file-upload-error.pipe.ts")
Converts an upload error code to an error message.
@ -29,6 +29,6 @@ automatically translated to the user's chosen language.
## See also
- [File uploading dialog component](../content-services/file-uploading-dialog.component.md)
- [Upload drag area component](../content-services/upload-drag-area.component.md)
- [Upload button component](../content-services/upload-button.component.md)
- [File uploading dialog component](../components/file-uploading-dialog.component.md)
- [Upload drag area component](../components/upload-drag-area.component.md)
- [Upload button component](../components/upload-button.component.md)

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

@ -1,48 +0,0 @@
---
Title: Rating service
Added: v2.0.0
Status: Active
Last reviewed: 2018-05-04
---
# [Rating service](../../lib/content-services/social/services/rating.service.ts "Defined in rating.service.ts")
Manages ratings for items in Content Services.
## Class members
### Methods
- **deleteRating**(nodeId: `string`, ratingType: `any`): `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** `any` - Null response indicating that the operation is complete
- **getRating**(nodeId: `string`, ratingType: `any`): `any`<br/>
Gets the current user's rating for a node.
- _nodeId:_ `string` - Node to get the rating from
- _ratingType:_ `any` - Type of rating (can be "likes" or "fiveStar")
- **Returns** `any` - The rating value
- **postRating**(nodeId: `string`, ratingType: `any`, vote: `any`): `any`<br/>
Adds the current user's rating for a node.
- _nodeId:_ `string` - Target node for the rating
- _ratingType:_ `any` - Type of rating (can be "likes" or "fiveStar")
- _vote:_ `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
- **Returns** `any` - Details about the rating, including the new value
## Details
The `ratingType` string currently has two possible options, "likes"
and "fiveStar". When the "likes" scheme is used, the result of
`getRating` and the `vote` parameter of `postRating` are boolean
values. When "fiveStar" is used, the value is an integer representing
the number of stars out of five.
See the [Ratings API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RatingsApi.md)
in the Alfresco JS API for more information about the returned data and the
REST API that this service is based on.
## See also
- [Like component](like.component.md)
- [Rating component](rating.component.md)

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

@ -1,28 +0,0 @@
---
Title: Search Chip List Component
Added: v2.3.0
Status: Active
Last reviewed: 2018-09-14
---
# [Search Chip List Component](../../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts "Defined in search-chip-list.component.ts")
Displays search criteria as a set of "chips".
![Selected Facets](../docassets/images/selected-facets.png)
## Basic usage
```html
<adf-search-chip-list [searchFilter]="searchFilter"></adf-search-chip-list>
<adf-search-filter #searchFilter></adf-search-filter>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| searchFilter | [`SearchFilterComponent`](../content-services/search-filter.component.md) | | Search filter to supply the data for the chips. |
| clearAll | boolean | false | Enables or disables the display of a clear-all-filters button. |

37
docs/content-services/search-filter.service.md
View File

@ -1,37 +0,0 @@
---
Title: Search filter service
Added: v2.4.0
Status: Active
Last reviewed: 2018-06-12
---
# [Search filter service](../../lib/content-services/search/components/search-filter/search-filter.service.ts "Defined in search-filter.service.ts")
Registers widgets for use with the [Search Filter component](../content-services/search-filter.component.md).
## Details
This component keeps track of all widgets registered for use with the
[Search Filter component](../content-services/search-filter.component.md). All the built-in widgets are registered by default
but you should register any new custom widgets you create explicitly:
```ts
import { MyComponent } from './my-component.ts'
@Component({...})
export class MyAppOrComponent {
constructor(searchFilterService: SearchFilterService) {
searchFilterService.widgets['my-widget'] = MyComponent;
}
}
```
See the [Search Widget](../../lib/content-services/search/search-widget.interface.ts) interface page for details about creating your own
custom search widgets.
## See also
- [`SearchWidget`](../../lib/content-services/search/search-widget.interface.ts)
- [Search Filter component](../content-services/search-filter.component.md)

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

@ -1,99 +0,0 @@
---
Title: Search Query Builder service
Added: v2.3.0
Status: Active
Last reviewed: 2018-06-12
---
# [Search Query Builder service](../../lib/content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts")
Stores information from all the custom search and faceted search widgets, compiles and runs the final search query.
## Class members
### Methods
- **addFilterQuery**(query: `string`)<br/>
Adds a filter query to the current query.
- _query:_ `string` - Query string to add
- **addUserFacetBucket**(field: [`FacetField`](../../lib/content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts))<br/>
Adds a facet bucket to a field.
- _field:_ [`FacetField`](../../lib/content-services/search/facet-field.interface.ts) - The target field
- _bucket:_ [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts) - Bucket to add
- **buildQuery**(): `QueryBody`<br/>
Builds the current query.
- **Returns** `QueryBody` - The finished query
- **execute**()<br/>
Builds and executes the current query.
- **getFacetField**(label: `string`): [`FacetField`](../../lib/content-services/search/facet-field.interface.ts)<br/>
Gets a facet field by label.
- _label:_ `string` - Label of the facet field
- **Returns** [`FacetField`](../../lib/content-services/search/facet-field.interface.ts) - Facet field data
- **getFacetQuery**(label: `string`): [`FacetQuery`](../../lib/content-services/search/facet-query.interface.ts)<br/>
Gets a facet query by label.
- _label:_ `string` - Label of the query
- **Returns** [`FacetQuery`](../../lib/content-services/search/facet-query.interface.ts) - Facet query data
- **getPrimarySorting**(): [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts)<br/>
Gets the primary sorting definition.
- **Returns** [`SearchSortingDefinition`](../../lib/content-services/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/search/search-sorting-definition.interface.ts)`[]`<br/>
Gets all pre-configured sorting options that users can choose from.
- **Returns** [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
- **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../lib/content-services/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/search/facet-field-bucket.interface.ts)`[]` - Bucket array
- **removeFilterQuery**(query: `string`)<br/>
Removes an existing filter query.
- _query:_ `string` - The query to remove
- **removeUserFacetBucket**(field: [`FacetField`](../../lib/content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts))<br/>
Removes an existing bucket from a field.
- _field:_ [`FacetField`](../../lib/content-services/search/facet-field.interface.ts) - The target field
- _bucket:_ [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts) - Bucket to remove
- **resetToDefaults**()<br/>
Resets the query to the defaults specified in the app config.
- **update**()<br/>
Builds the current query and triggers the `updated` event.
## Details
See the [Search filter component](search-filter.component.md) page for full details about the format of queries,
facet fields, and sorting options.
The Query Builder is UI agnostic and does not rely on Angular components.
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
```ts
constructor(queryBuilder: SearchQueryBuilderService) {
queryBuilder.updated.subscribe(query => {
this.queryBuilder.execute();
});
queryBuilder.executed.subscribe(data => {
this.onDataLoaded(data);
});
}
```
> **Note:** Since ADF 3.0.0, the query contains the `"facetFormat": "V2"` parameter so that all the responses have the same structure even if coming from search queries containing facetFields, facetQueries, grouped facetQueries or facetIntervals.
## See also
- [Search filter component](search-filter.component.md)
- [Search Widget interface](search-widget.interface.md)

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14
---
# [Content Node Dialog service](../../lib/content-services/content-node-selector/content-node-dialog.service.ts "Defined in content-node-dialog.service.ts")
# [Content Node Dialog service](../../../lib/content-services/content-node-selector/content-node-dialog.service.ts "Defined in content-node-dialog.service.ts")
Displays and manages dialogs for selecting content to open, copy or upload.
@ -85,5 +85,5 @@ dialog operation, say) or be set to one of the well-known names "-my-" , "-share
## See Also
- [Content node selector panel component](content-node-selector-panel.component.md)
- [Content node selector component](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)

82
docs/content-services/services/custom-resources.service.md Normal file
View File

@ -0,0 +1,82 @@
---
Title: Custom Resources service
Added: v2.3.0
Status: Active
Last reviewed: 2018-11-16
---
# [Custom Resources service](../../../lib/content-services/document-list/services/custom-resources.service.ts "Defined in custom-resources.service.ts")
Manages Document List information that is specific to a user.
## Class members
### Methods
- **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/>
Chooses the correct ID for a node entry.
- _node:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/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)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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/development/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/>
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[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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[]` = `[]`): `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
- **Returns** `any` - List of items contained in the folder
- **loadMemberSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - List of sites
- **loadSharedLinks**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/SharedLinkPaging.md)`>` - List of shared links
- **loadSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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
## Details
The `includeFields` parameter used by some of the methods lets you specify which data fields
you want in the result objects. See the
[Alfresco JSAPI](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SharedlinksApi.md#findSharedLinks)
for further details of the returned data and the available fields.
## See also
- [Document List component](../components/document-list.component.md)

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

@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Document Actions service](../../lib/content-services/document-list/services/document-actions.service.ts "Defined in document-actions.service.ts")
# [Document Actions service](../../../lib/content-services/document-list/services/document-actions.service.ts "Defined in document-actions.service.ts")
Implements the document menu actions for the [Document List component](../content-services/document-list.component.md).
Implements the document menu actions for the [Document List component](../components/document-list.component.md).
## Class members
@ -30,9 +30,9 @@ Implements the document menu actions for the [Document List component](../conten
## Details
This service implements the built-in actions that can be applied to a document
shown in a [Document List component](document-list.component.md): **delete**,
shown in a [Document List component](../components/document-list.component.md): **delete**,
**download**, **copy** and **move** (see the
[Content Action component](content-action.component.md) for further details and examples
[Content Action component](../components/content-action.component.md) for further details and examples
of these menu items). However, you can also use the service to add extra actions or
replace the built-in ones with your own implementation.
@ -99,5 +99,5 @@ with a custom application service.
## See also
- [Content action component](content-action.component.md)
- [Content action component](../components/content-action.component.md)
- [Folder actions service](folder-actions.service.md)

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

@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Document List service](../../lib/content-services/document-list/services/document-list.service.ts "Defined in document-list.service.ts")
# [Document List service](../../../lib/content-services/document-list/services/document-list.service.ts "Defined in document-list.service.ts")
Implements node operations used by the [Document List component](../content-services/document-list.component.md).
Implements node operations used by the [Document List component](../components/document-list.component.md).
## Class members
@ -29,12 +29,12 @@ Implements node operations used by the [Document List component](../content-serv
Get thumbnail URL for the given document node.
- _node:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to get URL for.
- **Returns** `string` - Thumbnail URL string
- **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
- **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - Details of the folder
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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
@ -93,4 +93,4 @@ values via their string equivalents.
## See also
- [Document list component](document-list.component.md)
- [Document list component](../components/document-list.component.md)

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

@ -5,17 +5,17 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Folder Actions service](../../lib/content-services/document-list/services/folder-actions.service.ts "Defined in folder-actions.service.ts")
# [Folder Actions service](../../../lib/content-services/document-list/services/folder-actions.service.ts "Defined in folder-actions.service.ts")
Implements the folder menu actions for the [Document List component](../content-services/document-list.component.md).
Implements the folder menu actions for the [Document List component](../components/document-list.component.md).
## Class members
### Methods
- **canExecuteAction**(obj: `any`): `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.
- _obj:_ `any` - Item to check
- _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`<br/>
Gets the handler function for an action.
@ -30,9 +30,9 @@ Implements the folder menu actions for the [Document List component](../content-
## Details
This service implements the built-in actions that can be applied to a folder
shown in a [Document List component](document-list.component.md): **delete**,
shown in a [Document List component](../components/document-list.component.md): **delete**,
**download**, **copy** and **move** (see the
[Content Action component](content-action.component.md) for further details and examples
[Content Action component](../components/content-action.component.md) for further details and examples
of these menu items). However, you can also use the service to add extra actions or
replace the built-in ones with your own implementation.
@ -100,4 +100,4 @@ with a custom application service.
## See also
- [Document actions service](document-actions.service.md)
- [Content action component](content-action.component.md)
- [Content action component](../components/content-action.component.md)

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Node permission dialog service](../../lib/content-services/permission-manager/services/node-permission-dialog.service.ts "Defined in node-permission-dialog.service.ts")
# [Node permission dialog service](../../../lib/content-services/permission-manager/services/node-permission-dialog.service.ts "Defined in node-permission-dialog.service.ts")
Displays dialogs to let the user set node permissions.
@ -28,10 +28,10 @@ Displays dialogs to let the user set node permissions.
## Details
This service sets up an [Add Permission Dialog component](../content-services/add-permission-dialog.component.md) to provide a user
This service sets up an [Add Permission Dialog component](../components/add-permission-dialog.component.md) to provide a user
interface for updating permissions.
## See also
- [Node Permission service](node-permission.service.md)
- [Add Permission Dialog component](add-permission-dialog.component.md)
- [Add Permission Dialog component](../components/add-permission-dialog.component.md)

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

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Node Permission service](../../lib/content-services/permission-manager/services/node-permission.service.ts "Defined in node-permission.service.ts")
# [Node Permission service](../../../lib/content-services/permission-manager/services/node-permission.service.ts "Defined in node-permission.service.ts")
Manages role permissions for content nodes.
@ -22,10 +22,10 @@ Manages role permissions for content nodes.
Gets a list of roles for the current node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - The target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Array of strings representing the roles
- **removePermission**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), permissionToRemove: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>`<br/>
- **removePermission**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), permissionToRemove: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>`<br/>
Removes a permission setting from a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - ID of the target node
- _permissionToRemove:_ `PermissionElement` - Permission setting to remove
- _permissionToRemove:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/development/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/development/src/api/content-rest-api/docs/Node.md)`>` - Node with modified permissions
- **updateLocallySetPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), nodes: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>`<br/>
Updates the locally set permissions for a node.
@ -38,10 +38,10 @@ Manages role permissions for content nodes.
- _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/development/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
- **updatePermissionRole**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), updatedPermissionRole: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>`<br/>
- **updatePermissionRole**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), updatedPermissionRole: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>`<br/>
Updates the permission role for a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - Target node
- _updatedPermissionRole:_ `PermissionElement` - Permission role to update or add
- _updatedPermissionRole:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/development/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/development/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permission
## Details
@ -56,4 +56,4 @@ based on.
## See also
- [Permission list component](permission-list.component.md)
- [Permission list component](../components/permission-list.component.md)

48
docs/content-services/services/rating.service.md Normal file
View File

@ -0,0 +1,48 @@
---
Title: Rating service
Added: v2.0.0
Status: Active
Last reviewed: 2018-05-04
---
# [Rating service](../../../lib/content-services/social/services/rating.service.ts "Defined in rating.service.ts")
Manages ratings for items in Content Services.
## Class members
### Methods
- **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/development/src/api/content-rest-api/docs/RatingEntry.md)`|__type>`<br/>
Gets the current user's rating for a node.
- _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/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/development/src/api/content-rest-api/docs/RatingEntry.md)`|__type>` - 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/development/src/api/content-rest-api/docs/RatingEntry.md)`|__type>`<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/development/src/api/content-rest-api/docs/RatingEntry.md)`|__type>` - Details about the rating, including the new value
## Details
The `ratingType` string currently has two possible options, "likes"
and "fiveStar". When the "likes" scheme is used, the result of
`getRating` and the `vote` parameter of `postRating` are boolean
values. When "fiveStar" is used, the value is an integer representing
the number of stars out of five.
See the [Ratings API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RatingsApi.md)
in the Alfresco JS API for more information about the returned data and the
REST API that this service is based on.
## See also
- [Like component](../components/like.component.md)
- [Rating component](../components/rating.component.md)

37
docs/content-services/services/search-filter.service.md Normal file
View File

@ -0,0 +1,37 @@
---
Title: Search filter service
Added: v2.4.0
Status: Active
Last reviewed: 2018-06-12
---
# [Search filter service](../../../lib/content-services/search/components/search-filter/search-filter.service.ts "Defined in search-filter.service.ts")
Registers widgets for use with the [Search Filter component](../components/search-filter.component.md).
## Details
This component keeps track of all widgets registered for use with the
[Search Filter component](../components/search-filter.component.md). All the built-in widgets are registered by default
but you should register any new custom widgets you create explicitly:
```ts
import { MyComponent } from './my-component.ts'
@Component({...})
export class MyAppOrComponent {
constructor(searchFilterService: SearchFilterService) {
searchFilterService.widgets['my-widget'] = MyComponent;
}
}
```
See the [Search Widget Interface](../interfaces/search-widget.interface.md) interface page for details about creating your own
custom search widgets.
## See also
- [Search Widget Interface](../interfaces/search-widget.interface.md)
- [Search Filter component](../components/search-filter.component.md)

104
docs/content-services/services/search-query-builder.service.md Normal file
View File

@ -0,0 +1,104 @@
---
Title: Search Query Builder service
Added: v2.3.0
Status: Active
Last reviewed: 2018-06-12
---
# [Search Query Builder service](../../../lib/content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts")
Stores information from all the custom search and faceted search widgets, compiles and runs the final search query.
## Class members
### Methods
- **addFilterQuery**(query: `string`)<br/>
Adds a filter query to the current query.
- _query:_ `string` - Query string to add
- **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts))<br/>
Adds a facet bucket to a field.
- _field:_ [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts) - The target field
- _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts) - Bucket to add
- **buildQuery**(): `QueryBody`<br/>
Builds the current query.
- **Returns** `QueryBody` - The finished query
- **execute**()<br/>
Builds and executes the current query.
- **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts)<br/>
Gets a facet field by label.
- _label:_ `string` - Label of the facet field
- **Returns** [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts) - Facet field data
- **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/search/facet-query.interface.ts)<br/>
Gets a facet query by label.
- _label:_ `string` - Label of the query
- **Returns** [`FacetQuery`](../../../lib/content-services/search/facet-query.interface.ts) - Facet query data
- **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/search/search-sorting-definition.interface.ts)<br/>
Gets the primary sorting definition.
- **Returns** [`SearchSortingDefinition`](../../../lib/content-services/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/search/search-sorting-definition.interface.ts)`[]`<br/>
Gets all pre-configured sorting options that users can choose from.
- **Returns** [`SearchSortingDefinition`](../../../lib/content-services/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
- **getSupportedLabel**(configLabel: `string`): `string`<br/>
- _configLabel:_ `string` -
- **Returns** `string` -
- **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/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/search/facet-field-bucket.interface.ts)`[]` - Bucket array
- **removeFilterQuery**(query: `string`)<br/>
Removes an existing filter query.
- _query:_ `string` - The query to remove
- **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts))<br/>
Removes an existing bucket from a field.
- _field:_ [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts) - The target field
- _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts) - Bucket to remove
- **resetToDefaults**()<br/>
Resets the query to the defaults specified in the app config.
- **update**()<br/>
Builds the current query and triggers the `updated` event.
## Details
See the [Search filter component](../components/search-filter.component.md) page for full details about the format of queries,
facet fields, and sorting options.
The Query Builder is UI agnostic and does not rely on Angular components.
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
```ts
constructor(queryBuilder: SearchQueryBuilderService) {
queryBuilder.updated.subscribe(query => {
this.queryBuilder.execute();
});
queryBuilder.executed.subscribe(data => {
this.onDataLoaded(data);
});
}
```
> **Note:** Since ADF 3.0.0, the query contains the `"facetFormat": "V2"` parameter so that all the responses have the same structure even if coming from search queries containing facetFields, facetQueries, grouped facetQueries or facetIntervals.
## See also
- [Search filter component](../components/search-filter.component.md)
- [Search Widget interface](../interfaces/search-widget.interface.md)

18
docs/content-services/tag.service.md → docs/content-services/services/tag.service.md
View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Tag service](../../lib/content-services/tag/services/tag.service.ts "Defined in tag.service.ts")
# [Tag service](../../../lib/content-services/tag/services/tag.service.ts "Defined in tag.service.ts")
Manages tags in Content Services.
@ -13,24 +13,24 @@ Manages tags in Content Services.
### Methods
- **addTag**(nodeId: `string`, tagName: `string`): `any`<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** `any` - [TagEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md) object (defined in JS-API) with details of the new tag
- **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`): `any`<br/>
- **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** `any` - [TagPaging](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md) object (defined in JS-API) containing the tags
- **removeTag**(nodeId: `string`, tag: `string`): `any`<br/>
- **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** `any` - Null object when the operation completes
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null object when the operation completes
## Details
@ -48,9 +48,9 @@ construct a list like this.
See the
[Tags API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagsApi.md)
in the Alfresco JS API for more information about the types returned by [Tag
service](../content-services/tag.service.md) methods and for the implementation of the REST API the service is
service](tag.service.md) methods and for the implementation of the REST API the service is
based on.
## See also
- [Tag list component](tag-list.component.md)
- [Tag list component](../components/tag-list.component.md)

382
docs/versionIndex.md
View File

@ -35,15 +35,15 @@ backend services have been tested with each released version of ADF.
- [Edit process filter cloud component](process-services-cloud/edit-process-filter-cloud.component.md)
- [Edit task filter cloud component](process-services-cloud/edit-task-filter-cloud.component.md)
- [Extension service](extensions/extension.service.md)
- [File upload error pipe](content-services/file-upload-error.pipe.md)
- [Format space pipe](core/format-space.pipe.md)
- [Full name pipe](core/full-name.pipe.md)
- [File upload error pipe](content-services/pipes/file-upload-error.pipe.md)
- [Format space pipe](core/pipes/format-space.pipe.md)
- [Full name pipe](core/pipes/full-name.pipe.md)
- [Group cloud component](process-services-cloud/group-cloud.component.md)
- [Group cloud service](process-services-cloud/group-cloud.service.md)
- [Group initial pipe](process-services-cloud/group-initial.pipe.md)
- [Icon component](core/icon.component.md)
- [Identity user service](core/identity-user.service.md)
- [Jwt helper service](core/jwt-helper.service.md)
- [Icon component](core/components/icon.component.md)
- [Identity user service](core/services/identity-user.service.md)
- [Jwt helper service](core/services/jwt-helper.service.md)
- [People cloud component](process-services-cloud/people-cloud.component.md)
- [Process filter cloud service](process-services-cloud/process-filter-cloud.service.md)
- [Process filters cloud component](process-services-cloud/process-filters-cloud.component.md)
@ -59,7 +59,7 @@ backend services have been tested with each released version of ADF.
- [Task header cloud service](process-services-cloud/task-header-cloud.service.md)
- [Task list cloud component](process-services-cloud/task-list-cloud.component.md)
- [Task list cloud service](process-services-cloud/task-list-cloud.service.md)
- [Tree view component](content-services/tree-view.component.md)
- [Tree view component](content-services/components/tree-view.component.md)
<!--v300 end-->
@ -82,9 +82,9 @@ backend services have been tested with each released version of ADF.
<!--v260 start-->
- [Login dialog panel component](core/login-dialog-panel.component.md)
- [Login dialog component](core/login-dialog.component.md)
- [Login dialog service](core/login-dialog.service.md)
- [Login dialog panel component](core/components/login-dialog-panel.component.md)
- [Login dialog component](core/components/login-dialog.component.md)
- [Login dialog service](core/services/login-dialog.service.md)
<!--v260 end-->
@ -100,7 +100,7 @@ backend services have been tested with each released version of ADF.
<!--v250 start-->
- [Header component](core/header.component.md)
- [Header component](core/components/header.component.md)
<!--v250 end-->
@ -116,24 +116,24 @@ backend services have been tested with each released version of ADF.
<!--v240 start-->
- [About component](core/about.component.md)
- [Add permission dialog component](content-services/add-permission-dialog.component.md)
- [Add permission panel component](content-services/add-permission-panel.component.md)
- [Add permission component](content-services/add-permission.component.md)
- [App config pipe](core/app-config.pipe.md)
- [Buttons menu component](core/buttons-menu.component.md)
- [Empty content component](core/empty-content.component.md)
- [Error content component](core/error-content.component.md)
- [Info drawer tab component](core/info-drawer-tab.component.md)
- [Node permission dialog service](content-services/node-permission-dialog.service.md)
- [Search check list component](content-services/search-check-list.component.md)
- [Search date range component](content-services/search-date-range.component.md)
- [Search filter service](content-services/search-filter.service.md)
- [Search number range component](content-services/search-number-range.component.md)
- [Search radio component](content-services/search-radio.component.md)
- [Search slider component](content-services/search-slider.component.md)
- [Search text component](content-services/search-text.component.md)
- [Sorting picker component](core/sorting-picker.component.md)
- [About component](core/components/about.component.md)
- [Add permission dialog component](content-services/components/add-permission-dialog.component.md)
- [Add permission panel component](content-services/components/add-permission-panel.component.md)
- [Add permission component](content-services/components/add-permission.component.md)
- [App config pipe](core/pipes/app-config.pipe.md)
- [Buttons menu component](core/components/buttons-menu.component.md)
- [Empty content component](core/components/empty-content.component.md)
- [Error content component](core/components/error-content.component.md)
- [Info drawer tab component](core/components/info-drawer-tab.component.md)
- [Node permission dialog service](content-services/services/node-permission-dialog.service.md)
- [Search check list component](content-services/components/search-check-list.component.md)
- [Search date range component](content-services/components/search-date-range.component.md)
- [Search filter service](content-services/services/search-filter.service.md)
- [Search number range component](content-services/components/search-number-range.component.md)
- [Search radio component](content-services/components/search-radio.component.md)
- [Search slider component](content-services/components/search-slider.component.md)
- [Search text component](content-services/components/search-text.component.md)
- [Sorting picker component](core/components/sorting-picker.component.md)
<!--v240 end-->
@ -149,17 +149,17 @@ backend services have been tested with each released version of ADF.
<!--v230 start-->
- [Comment content service](core/comment-content.service.md)
- [Content node share directive](content-services/content-node-share.directive.md)
- [Custom resources service](content-services/custom-resources.service.md)
- [Inherited button directive](content-services/inherited-button.directive.md)
- [Permission list component](content-services/permission-list.component.md)
- [Search chip list component](content-services/search-chip-list.component.md)
- [Search filter component](content-services/search-filter.component.md)
- [Search query builder service](content-services/search-query-builder.service.md)
- [Search sorting picker component](content-services/search-sorting-picker.component.md)
- [Sidenav layout component](core/sidenav-layout.component.md)
- [Upload version button component](content-services/upload-version-button.component.md)
- [Comment content service](core/services/comment-content.service.md)
- [Content node share directive](content-services/directives/content-node-share.directive.md)
- [Custom resources service](content-services/services/custom-resources.service.md)
- [Inherited button directive](content-services/directives/inherited-button.directive.md)
- [Permission list component](content-services/components/permission-list.component.md)
- [Search chip list component](content-services/components/search-chip-list.component.md)
- [Search filter component](content-services/components/search-filter.component.md)
- [Search query builder service](content-services/services/search-query-builder.service.md)
- [Search sorting picker component](content-services/components/search-sorting-picker.component.md)
- [Sidenav layout component](core/components/sidenav-layout.component.md)
- [Upload version button component](content-services/components/upload-version-button.component.md)
<!--v230 end-->
@ -175,8 +175,8 @@ backend services have been tested with each released version of ADF.
<!--v220 start-->
- [Node download directive](core/node-download.directive.md)
- [Node lock directive](content-services/node-lock.directive.md)
- [Node download directive](core/directives/node-download.directive.md)
- [Node lock directive](content-services/directives/node-lock.directive.md)
<!--v220 end-->
@ -192,12 +192,12 @@ backend services have been tested with each released version of ADF.
<!--v210 start-->
- [Content metadata card component](content-services/content-metadata-card.component.md)
- [Content metadata component](content-services/content-metadata.component.md)
- [Content node dialog service](content-services/content-node-dialog.service.md)
- [Content node selector panel component](content-services/content-node-selector-panel.component.md)
- [Search configuration service](core/search-configuration.service.md)
- [Sidebar action menu component](core/sidebar-action-menu.component.md)
- [Content metadata card component](content-services/components/content-metadata-card.component.md)
- [Content metadata component](content-services/components/content-metadata.component.md)
- [Content node dialog service](content-services/services/content-node-dialog.service.md)
- [Content node selector panel component](content-services/components/content-node-selector-panel.component.md)
- [Search configuration service](core/services/search-configuration.service.md)
- [Sidebar action menu component](core/components/sidebar-action-menu.component.md)
<!--v210 end-->
@ -213,153 +213,153 @@ backend services have been tested with each released version of ADF.
<!--v200 start-->
- [Activiti alfresco service](core/activiti-alfresco.service.md)
- [Alfresco api service](core/alfresco-api.service.md)
- [Activiti alfresco service](core/services/activiti-alfresco.service.md)
- [Alfresco api service](core/services/alfresco-api.service.md)
- [Analytics generator component](insights/analytics-generator.component.md)
- [Analytics report list component](insights/analytics-report-list.component.md)
- [Analytics component](insights/analytics.component.md)
- [App config service](core/app-config.service.md)
- [Apps list component](process-services/apps-list.component.md)
- [Apps process service](core/apps-process.service.md)
- [Attach form component](process-services/attach-form.component.md)
- [Auth guard bpm service](core/auth-guard-bpm.service.md)
- [Auth guard ecm service](core/auth-guard-ecm.service.md)
- [Auth guard service](core/auth-guard.service.md)
- [Authentication service](core/authentication.service.md)
- [Bpm user model](core/bpm-user.model.md)
- [Bpm user service](core/bpm-user.service.md)
- [Breadcrumb component](content-services/breadcrumb.component.md)
- [Card item types service](core/card-item-types.service.md)
- [Card view update service](core/card-view-update.service.md)
- [Card view component](core/card-view.component.md)
- [Check allowable operation directive](core/check-allowable-operation.directive.md)
- [Checklist component](process-services/checklist.component.md)
- [Comment list component](core/comment-list.component.md)
- [Comment process service](core/comment-process.service.md)
- [Comments component](core/comments.component.md)
- [Content action component](content-services/content-action.component.md)
- [Content node selector component](content-services/content-node-selector.component.md)
- [Content service](core/content.service.md)
- [Content widget](core/content.widget.md)
- [Context menu directive](core/context-menu.directive.md)
- [Cookie service](core/cookie.service.md)
- [Create process attachment component](process-services/create-process-attachment.component.md)
- [Create task attachment component](process-services/create-task-attachment.component.md)
- [Data column component](core/data-column.component.md)
- [Datatable component](core/datatable.component.md)
- [Deleted nodes api service](core/deleted-nodes-api.service.md)
- [App config service](core/services/app-config.service.md)
- [Apps list component](process-services/components/apps-list.component.md)
- [Apps process service](core/services/apps-process.service.md)
- [Attach form component](process-services/components/attach-form.component.md)
- [Auth guard bpm service](core/services/auth-guard-bpm.service.md)
- [Auth guard ecm service](core/services/auth-guard-ecm.service.md)
- [Auth guard service](core/services/auth-guard.service.md)
- [Authentication service](core/services/authentication.service.md)
- [Bpm user model](core/models/bpm-user.model.md)
- [Bpm user service](core/services/bpm-user.service.md)
- [Breadcrumb component](content-services/components/breadcrumb.component.md)
- [Card item types service](core/services/card-item-types.service.md)
- [Card view update service](core/services/card-view-update.service.md)
- [Card view component](core/components/card-view.component.md)
- [Check allowable operation directive](core/directives/check-allowable-operation.directive.md)
- [Checklist component](process-services/components/checklist.component.md)
- [Comment list component](core/components/comment-list.component.md)
- [Comment process service](core/services/comment-process.service.md)
- [Comments component](core/components/comments.component.md)
- [Content action component](content-services/components/content-action.component.md)
- [Content node selector component](content-services/components/content-node-selector.component.md)
- [Content service](core/services/content.service.md)
- [Content widget](core/widgets/content.widget.md)
- [Context menu directive](core/directives/context-menu.directive.md)
- [Cookie service](core/services/cookie.service.md)
- [Create process attachment component](process-services/components/create-process-attachment.component.md)
- [Create task attachment component](process-services/components/create-task-attachment.component.md)
- [Data column component](core/components/data-column.component.md)
- [Datatable component](core/components/datatable.component.md)
- [Deleted nodes api service](core/services/deleted-nodes-api.service.md)
- [Diagram component](insights/diagram.component.md)
- [Discovery api service](core/discovery-api.service.md)
- [Document actions service](content-services/document-actions.service.md)
- [Document list component](content-services/document-list.component.md)
- [Document list service](content-services/document-list.service.md)
- [Download zip service](core/download-zip.service.md)
- [Dropdown breadcrumb component](content-services/dropdown-breadcrumb.component.md)
- [Ecm user model](core/ecm-user.model.md)
- [Ecm user service](core/ecm-user.service.md)
- [Empty list component](core/empty-list.component.md)
- [Favorites api service](core/favorites-api.service.md)
- [File draggable directive](content-services/file-draggable.directive.md)
- [File size pipe](core/file-size.pipe.md)
- [File uploading dialog component](content-services/file-uploading-dialog.component.md)
- [Folder actions service](content-services/folder-actions.service.md)
- [Folder create directive](content-services/folder-create.directive.md)
- [Folder edit directive](content-services/folder-edit.directive.md)
- [Form field component](core/form-field.component.md)
- [Form field model](core/form-field.model.md)
- [Form list component](core/form-list.component.md)
- [Form rendering service](core/form-rendering.service.md)
- [Form component](core/form.component.md)
- [Form service](core/form.service.md)
- [Highlight transform service](core/highlight-transform.service.md)
- [Highlight directive](core/highlight.directive.md)
- [Host settings component](core/host-settings.component.md)
- [Image resolver model](content-services/image-resolver.model.md)
- [Infinite pagination component](core/infinite-pagination.component.md)
- [Info drawer layout component](core/info-drawer-layout.component.md)
- [Info drawer component](core/info-drawer.component.md)
- [Language menu component](core/language-menu.component.md)
- [Like component](content-services/like.component.md)
- [Log service](core/log.service.md)
- [Login component](core/login.component.md)
- [Logout directive](core/logout.directive.md)
- [Mime type icon pipe](core/mime-type-icon.pipe.md)
- [Node delete directive](core/node-delete.directive.md)
- [Node favorite directive](core/node-favorite.directive.md)
- [Node name tooltip pipe](core/node-name-tooltip.pipe.md)
- [Node permission service](content-services/node-permission.service.md)
- [Node restore directive](core/node-restore.directive.md)
- [Node service](core/node.service.md)
- [Nodes api service](core/nodes-api.service.md)
- [Notification service](core/notification.service.md)
- [Page title service](core/page-title.service.md)
- [Pagination component](core/pagination.component.md)
- [People content service](core/people-content.service.md)
- [People list component](process-services/people-list.component.md)
- [People process service](core/people-process.service.md)
- [People search component](process-services/people-search.component.md)
- [People component](process-services/people.component.md)
- [Permissions style model](content-services/permissions-style.model.md)
- [Process attachment list component](process-services/process-attachment-list.component.md)
- [Process audit directive](process-services/process-audit.directive.md)
- [Process comments component](process-services/process-comments.component.md)
- [Process content service](core/process-content.service.md)
- [Process filter service](process-services/process-filter.service.md)
- [Process filters component](process-services/process-filters.component.md)
- [Process instance details component](process-services/process-instance-details.component.md)
- [Process instance header component](process-services/process-instance-header.component.md)
- [Process instance tasks component](process-services/process-instance-tasks.component.md)
- [Process list component](process-services/process-list.component.md)
- [Process service](process-services/process.service.md)
- [Product version model](core/product-version.model.md)
- [Rating component](content-services/rating.component.md)
- [Rating service](content-services/rating.service.md)
- [Renditions service](core/renditions.service.md)
- [Row filter model](content-services/row-filter.model.md)
- [Search control component](content-services/search-control.component.md)
- [Search component](content-services/search.component.md)
- [Search service](core/search.service.md)
- [Select apps dialog component](process-services/select-apps-dialog.component.md)
- [Shared links api service](core/shared-links-api.service.md)
- [Sites dropdown component](content-services/sites-dropdown.component.md)
- [Sites service](core/sites.service.md)
- [Start form component](core/start-form.component.md)
- [Start process component](process-services/start-process.component.md)
- [Start task component](process-services/start-task.component.md)
- [Storage service](core/storage.service.md)
- [Tag actions component](content-services/tag-actions.component.md)
- [Tag list component](content-services/tag-list.component.md)
- [Tag node list component](content-services/tag-node-list.component.md)
- [Tag service](content-services/tag.service.md)
- [Task attachment list component](process-services/task-attachment-list.component.md)
- [Task audit directive](process-services/task-audit.directive.md)
- [Task details component](process-services/task-details.component.md)
- [Task filter service](process-services/task-filter.service.md)
- [Task filters component](process-services/task-filters.component.md)
- [Task header component](process-services/task-header.component.md)
- [Task list component](process-services/task-list.component.md)
- [Task standalone component](process-services/task-standalone.component.md)
- [Tasklist service](process-services/tasklist.service.md)
- [Text highlight pipe](core/text-highlight.pipe.md)
- [Text mask component](core/text-mask.component.md)
- [Thumbnail service](core/thumbnail.service.md)
- [Time ago pipe](core/time-ago.pipe.md)
- [Toolbar divider component](core/toolbar-divider.component.md)
- [Toolbar title component](core/toolbar-title.component.md)
- [Toolbar component](core/toolbar.component.md)
- [Translation service](core/translation.service.md)
- [Upload button component](content-services/upload-button.component.md)
- [Upload drag area component](content-services/upload-drag-area.component.md)
- [Upload directive](core/upload.directive.md)
- [Upload service](core/upload.service.md)
- [User info component](core/user-info.component.md)
- [User initial pipe](core/user-initial.pipe.md)
- [User preferences service](core/user-preferences.service.md)
- [User process model](core/user-process.model.md)
- [Version list component](content-services/version-list.component.md)
- [Version manager component](content-services/version-manager.component.md)
- [Viewer component](core/viewer.component.md)
- [Webscript component](content-services/webscript.component.md)
- [Discovery api service](core/services/discovery-api.service.md)
- [Document actions service](content-services/services/document-actions.service.md)
- [Document list component](content-services/components/document-list.component.md)
- [Document list service](content-services/services/document-list.service.md)
- [Download zip service](core/services/download-zip.service.md)
- [Dropdown breadcrumb component](content-services/components/dropdown-breadcrumb.component.md)
- [Ecm user model](core/models/ecm-user.model.md)
- [Ecm user service](core/services/ecm-user.service.md)
- [Empty list component](core/components/empty-list.component.md)
- [Favorites api service](core/services/favorites-api.service.md)
- [File draggable directive](content-services/directives/file-draggable.directive.md)
- [File size pipe](core/pipes/file-size.pipe.md)
- [File uploading dialog component](content-services/components/file-uploading-dialog.component.md)
- [Folder actions service](content-services/services/folder-actions.service.md)
- [Folder create directive](content-services/directives/folder-create.directive.md)
- [Folder edit directive](content-services/directives/folder-edit.directive.md)
- [Form field component](core/components/form-field.component.md)
- [Form field model](core/models/form-field.model.md)
- [Form list component](core/components/form-list.component.md)
- [Form rendering service](core/services/form-rendering.service.md)
- [Form component](core/components/form.component.md)
- [Form service](core/services/form.service.md)
- [Highlight transform service](core/services/highlight-transform.service.md)
- [Highlight directive](core/directives/highlight.directive.md)
- [Host settings component](core/components/host-settings.component.md)
- [Image resolver model](content-services/models/image-resolver.model.md)
- [Infinite pagination component](core/components/infinite-pagination.component.md)
- [Info drawer layout component](core/components/info-drawer-layout.component.md)
- [Info drawer component](core/components/info-drawer.component.md)
- [Language menu component](core/components/language-menu.component.md)
- [Like component](content-services/components/like.component.md)
- [Log service](core/services/log.service.md)
- [Login component](core/components/login.component.md)
- [Logout directive](core/directives/logout.directive.md)
- [Mime type icon pipe](core/pipes/mime-type-icon.pipe.md)
- [Node delete directive](core/directives/node-delete.directive.md)
- [Node favorite directive](core/directives/node-favorite.directive.md)
- [Node name tooltip pipe](core/pipes/node-name-tooltip.pipe.md)
- [Node permission service](content-services/services/node-permission.service.md)
- [Node restore directive](core/directives/node-restore.directive.md)
- [Node service](core/services/node.service.md)
- [Nodes api service](core/services/nodes-api.service.md)
- [Notification service](core/services/notification.service.md)
- [Page title service](core/services/page-title.service.md)
- [Pagination component](core/components/pagination.component.md)
- [People content service](core/services/people-content.service.md)
- [People list component](process-services/components/people-list.component.md)
- [People process service](core/services/people-process.service.md)
- [People search component](process-services/components/people-search.component.md)
- [People component](process-services/components/people.component.md)
- [Permissions style model](content-services/models/permissions-style.model.md)
- [Process attachment list component](process-services/components/process-attachment-list.component.md)
- [Process audit directive](process-services/directives/process-audit.directive.md)
- [Process comments component](process-services/components/process-comments.component.md)
- [Process content service](core/services/process-content.service.md)
- [Process filter service](process-services/services/process-filter.service.md)
- [Process filters component](process-services/components/process-filters.component.md)
- [Process instance details component](process-services/components/process-instance-details.component.md)
- [Process instance header component](process-services/components/process-instance-header.component.md)
- [Process instance tasks component](process-services/components/process-instance-tasks.component.md)
- [Process list component](process-services/components/process-list.component.md)
- [Process service](process-services/services/process.service.md)
- [Product version model](core/models/product-version.model.md)
- [Rating component](content-services/components/rating.component.md)
- [Rating service](content-services/services/rating.service.md)
- [Renditions service](core/services/renditions.service.md)
- [Row filter model](content-services/models/row-filter.model.md)
- [Search control component](content-services/components/search-control.component.md)
- [Search component](content-services/components/search.component.md)
- [Search service](core/services/search.service.md)
- [Select apps dialog component](process-services/components/select-apps-dialog.component.md)
- [Shared links api service](core/services/shared-links-api.service.md)
- [Sites dropdown component](content-services/components/sites-dropdown.component.md)
- [Sites service](core/services/sites.service.md)
- [Start form component](core/components/start-form.component.md)
- [Start process component](process-services/components/start-process.component.md)
- [Start task component](process-services/components/start-task.component.md)
- [Storage service](core/services/storage.service.md)
- [Tag actions component](content-services/components/tag-actions.component.md)
- [Tag list component](content-services/components/tag-list.component.md)
- [Tag node list component](content-services/components/tag-node-list.component.md)
- [Tag service](content-services/services/tag.service.md)
- [Task attachment list component](process-services/components/task-attachment-list.component.md)
- [Task audit directive](process-services/directives/task-audit.directive.md)
- [Task details component](process-services/components/task-details.component.md)
- [Task filter service](process-services/services/task-filter.service.md)
- [Task filters component](process-services/components/task-filters.component.md)
- [Task header component](process-services/components/task-header.component.md)
- [Task list component](process-services/components/task-list.component.md)
- [Task standalone component](process-services/components/task-standalone.component.md)
- [Tasklist service](process-services/services/tasklist.service.md)
- [Text highlight pipe](core/pipes/text-highlight.pipe.md)
- [Text mask component](core/components/text-mask.component.md)
- [Thumbnail service](core/services/thumbnail.service.md)
- [Time ago pipe](core/pipes/time-ago.pipe.md)
- [Toolbar divider component](core/components/toolbar-divider.component.md)
- [Toolbar title component](core/components/toolbar-title.component.md)
- [Toolbar component](core/components/toolbar.component.md)
- [Translation service](core/services/translation.service.md)
- [Upload button component](content-services/components/upload-button.component.md)
- [Upload drag area component](content-services/components/upload-drag-area.component.md)
- [Upload directive](core/directives/upload.directive.md)
- [Upload service](core/services/upload.service.md)
- [User info component](core/components/user-info.component.md)
- [User initial pipe](core/pipes/user-initial.pipe.md)
- [User preferences service](core/services/user-preferences.service.md)
- [User process model](core/models/user-process.model.md)
- [Version list component](content-services/components/version-list.component.md)
- [Version manager component](content-services/components/version-manager.component.md)
- [Viewer component](core/components/viewer.component.md)
- [Webscript component](content-services/components/webscript.component.md)
- [Widget component](insights/widget.component.md)
<!--v200 end-->

16
tools/doc/docProcessor.js
View File

@ -11,7 +11,7 @@ var stringify = require("remark-stringify");
var frontMatter = require("remark-frontmatter");
var mdCompact = require("mdast-util-compact");
var tdoc = require("typedoc");
//var tdoc = require("typedoc");
var ngHelpers = require("./ngHelpers");
var si = require("./SourceInfoClasses");
@ -142,7 +142,7 @@ function initMdCache(filenames) {
return mdCache;
}
/*
function getSourceInfo(infoFolder) {
var sourceInfo = {};
@ -155,7 +155,7 @@ function getSourceInfo(infoFolder) {
});
}
/*
function initSourceInfo(aggData, mdCache) {
var app = new tdoc.Application({
@ -177,10 +177,10 @@ function initSourceInfo(aggData, mdCache) {
var mdFiles = Object.keys(mdCache);
mdFiles.forEach(mdFile => {
/*
var className = ngHelpers.ngNameToClassName(path.basename(mdFile, ".md"), aggData.config.typeNameExceptions);
var classRef = aggData.projData.findReflectionByName(className);
*/
var className = ngHelpers.ngNameToClassName(path.basename(mdFile, ".md"), aggData.config.typeNameExceptions);
var yamlText = fs.readFileSync(path.resolve(sourceInfoFolder, className + ".yml"), "utf8");
@ -189,15 +189,15 @@ function initSourceInfo(aggData, mdCache) {
if (yaml) {
aggData.classInfo[className] = new si.ComponentInfo(yaml);
}
/*
if (classRef) {
aggData.classInfo[className] = new si.ComponentInfo(classRef);
}
*/
});
}
*/
function initClassInfo(aggData) {
var yamlFilenames = fs.readdirSync(path.resolve(sourceInfoFolder));

2
tools/doc/tools/gqIndex.js
View File

@ -9,7 +9,7 @@ var replaceZone = require("mdast-zone");
var graphql_1 = require("graphql");
var MQ = require("../mqDefs");
var libNamesRegex = /content-services|core|extensions|insights|process-services|process-services-cloud/;
var libNamesList = ['core', 'process-services'];
var libNamesList = ['content-services', 'core', 'process-services'];
var query = "\n query libIndex($libName: String) {\n documents(idFilter: $libName) {\n title: metadata(key: \"Title\")\n status: metadata(key: \"Status\")\n id\n classType: folder(depth: 2)\n heading {\n link {\n url\n }\n }\n paragraph {\n plaintext\n }\n }\n }\n";
function processDocs(mdCache, aggData, _errorMessages) {
var docset = new GQDocset(mdCache);

2
tools/doc/tools/gqIndex.ts
View File

@ -12,7 +12,7 @@ import { graphql, buildSchema } from 'graphql';
import * as MQ from '../mqDefs';
let libNamesRegex = /content-services|core|extensions|insights|process-services|process-services-cloud/;
let libNamesList = ['core', 'process-services'];
let libNamesList = ['content-services', 'core', 'process-services'];
let query = `