[ADF-2764] Updated doc files with latest script features (#3368)

* [ADF-2764] Updated doc files with latest script features

* [ADF-2764] Rebuilt full index instead of just content services index
This commit is contained in:
Andy Stark 2018-05-23 00:40:02 +01:00 committed by Eugenio Romano
parent f69bad3732
commit c8f04193c7
39 changed files with 353 additions and 280 deletions

View File

@ -55,11 +55,14 @@ for more information about installing and using the source code.
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [About component](core/about.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component allow you to have a general overview of the version of ADF installed and the status of the Content service and Process service. | [Source](../lib/core/about/about.component.ts) |
| [Buttons menu component](core/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/buttons-menu/buttons-menu.component.ts) |
| [Card view component](core/card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) | | [Card view component](core/card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) |
| [Accordion group component](core/accordion-group.component.md) | Adds a collapsible panel to an accordion menu. | [Source](../lib/core/collapsable/accordion-group.component.ts) | | [Accordion group component](core/accordion-group.component.md) | Adds a collapsible panel to an accordion menu. | [Source](../lib/core/collapsable/accordion-group.component.ts) |
| [Accordion component](core/accordion.component.md) | Creates a collapsible accordion menu. | [Source](../lib/core/collapsable/accordion.component.ts) | | [Accordion component](core/accordion.component.md) | Creates a collapsible accordion menu. | [Source](../lib/core/collapsable/accordion.component.ts) |
| [Comment list component](core/comment-list.component.md) | Shows a list of comments. | [Source](../lib/core/comments/comment-list.component.ts) | | [Comment list component](core/comment-list.component.md) | Shows a list of comments. | [Source](../lib/core/comments/comment-list.component.ts) |
| [Comments component](core/comments.component.md) | Displays comments from users involved in a specified task or content and allows an involved user to add a comment to a task or a content. | [Source](../lib/core/comments/comments.component.ts) | | [Comments component](core/comments.component.md) | Displays comments from users involved in a specified task or content and allows an involved user to add a comment to a task or a content. | [Source](../lib/core/comments/comments.component.ts) |
| [Sorting picker component](core/sorting-picker.component.md) | Provides an ability to pick one of the predefined sorting definitions and define sorting direction: | [Source](../lib/core/components/sorting-picker/sorting-picker.component.ts) |
| [Data column component](core/data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) | | [Data column component](core/data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) |
| [Datatable component](core/datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) | | [Datatable component](core/datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) |
| [Form field component](core/form-field.component.md) | A form field in an APS form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) | | [Form field component](core/form-field.component.md) | A form field in an APS form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) |
@ -74,8 +77,10 @@ for more information about installing and using the source code.
| [Infinite pagination component](core/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | | [Infinite pagination component](core/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) |
| [Pagination component](core/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | | [Pagination component](core/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) |
| [Host settings component](core/host-settings.component.md) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | | [Host settings component](core/host-settings.component.md) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) |
| [Sidebar action menu component](core/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/sidebar/sidebar-action-menu.component.ts) | | [Sidebar action menu component](core/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/sidenav-layout/components/sidebar-action/sidebar-action-menu.component.ts) |
| [Sidenav layout component](core/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/sidenav-layout/components/sidenav-layout/sidenav-layout.component.ts) | | [Sidenav layout component](core/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/sidenav-layout/components/sidenav-layout/sidenav-layout.component.ts) |
| [Empty content component](core/empty-content.component.md) | Provides a generic "Empty Content" UI and can used as a placeholder for components that need to show different content when being empty. | [Source](../lib/core/templates/empty-content/empty-content.component.ts) |
| [Error content component](core/error-content.component.md) | Displays info about a specific error. | [Source](../lib/core/templates/error-content/error-content.component.ts) |
| [Toolbar divider component](core/toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) | | [Toolbar divider component](core/toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) |
| [Toolbar title component](core/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | | [Toolbar title component](core/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) |
| [Toolbar component](core/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) | | [Toolbar component](core/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) |
@ -121,6 +126,7 @@ for more information about installing and using the source code.
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Card item types service](core/card-item-types.service.md) | Maps type names to field component types for the Card View component. | [Source](../lib/core/card-view/services/card-item-types.service.ts) |
| [Card view update service](core/card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | [Source](../lib/core/card-view/services/card-view-update.service.ts) | | [Card view update service](core/card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | [Source](../lib/core/card-view/services/card-view-update.service.ts) |
| [Activiti alfresco service](core/activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) | | [Activiti alfresco service](core/activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) |
| [Form rendering service](core/form-rendering.service.md) | Maps an APS form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | | [Form rendering service](core/form-rendering.service.md) | Maps an APS form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) |
@ -197,10 +203,14 @@ for more information about installing and using the source code.
| [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 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) | | [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) | | [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) | Allow user to search people or group that could be added 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) | Allow user to search people or group that could be added 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) | | [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 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 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 which shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.component.ts) | | [Search control component](content-services/search-control.component.md) | Displays a input text which shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.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 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 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 component](content-services/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.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) | | [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) | | [Like component](content-services/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/social/like.component.ts) |
@ -212,7 +222,7 @@ for more information about installing and using the source code.
| [Upload button component](content-services/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/upload/components/upload-button.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 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) | | [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 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](../content-services/version-manager.component.md). | [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) | | [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) | | [Webscript component](content-services/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/webscript/webscript.component.ts) |
@ -241,13 +251,14 @@ for more information about installing and using the source code.
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [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) | | [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) | | [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 actions service](content-services/document-actions.service.md) | Implements the document menu actions for the [Document List component](../content-services/document-list.component.md). | [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) | | [Document list service](content-services/document-list.service.md) | Implements node operations used by the [Document List component](../content-services/document-list.component.md). | [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) | | [Folder actions service](content-services/folder-actions.service.md) | Implements the folder menu actions for the [Document List component](../content-services/document-list.component.md). | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) |
| [Node permission service](content-services/node-permission.service.md) | Manages the role permissions for the content nodes | [Source](../lib/content-services/permission-manager/services/node-permission.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 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) | | [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) | | [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) | | [Tag service](content-services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/tag/services/tag.service.ts) |
| _Node permission dialog service_ | _Not currently documented_ | [Source](../lib/content-services/permission-manager/services/node-permission-dialog.service.ts) |
<!--content-services end--> <!--content-services end-->

View File

@ -18,10 +18,14 @@ for more information about installing and using the source code.
| [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 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) | | [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) | | [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) | Allow user to search people or group that could be added 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) | Allow user to search people or group that could be added 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) | | [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 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 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 which shows find-as-you-type suggestions. | [Source](../../lib/content-services/search/components/search-control.component.ts) | | [Search control component](search-control.component.md) | Displays a input text which shows find-as-you-type suggestions. | [Source](../../lib/content-services/search/components/search-control.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 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 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 component](search.component.md) | Searches items for supplied search terms. | [Source](../../lib/content-services/search/components/search.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) | | [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) | | [Like component](like.component.md) | Allows a user to add "likes" to an item. | [Source](../../lib/content-services/social/like.component.ts) |
@ -33,7 +37,7 @@ for more information about installing and using the source code.
| [Upload button component](upload-button.component.md) | Activates a file upload. | [Source](../../lib/content-services/upload/components/upload-button.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 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) | | [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 list component](version-list.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a [Version Manager component](../content-services/version-manager.component.md). | [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) | | [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) | | [Webscript component](webscript.component.md) | Provides access to Webscript features. | [Source](../../lib/content-services/webscript/webscript.component.ts) |
@ -62,12 +66,13 @@ for more information about installing and using the source code.
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [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) | | [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) | | [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 actions service](document-actions.service.md) | Implements the document menu actions for the [Document List component](../content-services/document-list.component.md). | [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) | | [Document list service](document-list.service.md) | Implements node operations used by the [Document List component](../content-services/document-list.component.md). | [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) | | [Folder actions service](folder-actions.service.md) | Implements the folder menu actions for the [Document List component](../content-services/document-list.component.md). | [Source](../../lib/content-services/document-list/services/folder-actions.service.ts) |
| [Node permission service](node-permission.service.md) | Manages the role permissions for the content nodes | [Source](../../lib/content-services/permission-manager/services/node-permission.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 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) | | [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) | | [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) | | [Tag service](tag.service.md) | Manages tags in Content Services. | [Source](../../lib/content-services/tag/services/tag.service.ts) |
| _Node permission dialog service_ | _Not currently documented_ | [Source](../../lib/content-services/permission-manager/services/node-permission-dialog.service.ts) |
<!--content-services end--> <!--content-services end-->

View File

@ -26,21 +26,6 @@ import { NodePermissionDialogService } from '@alfresco/adf-content-services';
}); });
``` ```
## Class members
### Properties
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| nodeId | `string` | "" | |
### Events
| Name | Type | Description |
| -- | -- | -- |
| success | `EventEmitter<MinimalNodeEntryEntity>` | |
| error | `EventEmitter<any>` | |
## Details ## Details
This component extends the [Add permission panel component](../add-permission-panel.component.md) This component extends the [Add permission panel component](../add-permission-panel.component.md)
@ -60,4 +45,4 @@ import { NodePermissionDialogService } from '@alfresco/adf-content-services';
(error) => { (error) => {
this.showErrorMessage(error); this.showErrorMessage(error);
}); });
``` ```

View File

@ -20,18 +20,14 @@ Allow user to search people or group that could be added to the current node per
## Class members ## Class members
### Properties
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| select | `EventEmitter<MinimalNodeEntryEntity>` | | | select | `EventEmitter<any>` | Emitted when a permission list item is selected. |
## Details ## Details
This component uses a [Search component](../search.component.md) to retrieve the 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. groups and people that could be added to the permission list of the current node.
The `select` event will be emitted when a result is clicked from the list. The `select` event will be emitted when a result is clicked from the list.

View File

@ -37,4 +37,3 @@ Searches for people or groups to add to the current node permissions.
This component extends the [Add permission panel component](../add-permission-panel.component.md) This component extends the [Add permission panel component](../add-permission-panel.component.md)
and apply the action confirm when the selection made is accepted. and apply the action confirm when the selection made is accepted.

View File

@ -28,14 +28,14 @@ Indicates the current position within a navigation hierarchy.
| folderNode | `MinimalNodeEntryEntity` | null | Active node, builds UI based on folderNode.path.elements collection. | | folderNode | `MinimalNodeEntryEntity` | null | Active node, builds UI based on folderNode.path.elements collection. |
| 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. | | 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. | | 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` | | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. | | 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. |
| 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. | | 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 ### Events
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| navigate | `EventEmitter<PathElementEntity>` | Emitted when the user clicks on a breadcrumb. | | navigate | [`EventEmitter<PathElementEntity>`](../../lib/content-services/document-list/models/document-library.model.ts) | Emitted when the user clicks on a breadcrumb. |
## Details ## Details
@ -47,7 +47,7 @@ the list by altering the node's `path.elements` property.
Below is an example of how you might do this with the Below is an example of how you might do this with the
[Content Node Selector component](content-node-selector.component.md). In this case, you pass the [Content Node Selector component](content-node-selector.component.md). In this case, you pass the
transform function via the `breadcrumbTransform` property of `ContentNodeSelectorComponentData` during transform function via the `breadcrumbTransform` property of [`ContentNodeSelectorComponentData`](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) during
initialization: initialization:
```ts ```ts

View File

@ -21,6 +21,7 @@ Adds options to a Document List actions menu for a particular content type.
- [Details](#details) - [Details](#details)
- [Examples](#examples) - [Examples](#examples)
- [Conditional visibility](#conditional-visibility)
- [Customizing built-in actions](#customizing-built-in-actions) - [Customizing built-in actions](#customizing-built-in-actions)
- [Error, Permission and Success callbacks](#error-permission-and-success-callbacks) - [Error, Permission and Success callbacks](#error-permission-and-success-callbacks)
@ -90,9 +91,9 @@ export class MyView {
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". | | handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). | | icon | `string` | | The name of the icon to display next to the menu command (can be left blank). |
| permission | `string` | | The permission type. | | permission | `string` | | The permission type. |
| target | `string` | ContentActionTarget.All | Type of item that the action applies to. Can be "document" or "folder" | | target | `string` | [`ContentActionTarget`](../../lib/content-services/document-list/models/content-action.model.ts).All | Type of item that the action appies to. Can be "document" or "folder" |
| title | `string` | "Action" | The title of the action as shown in the menu. | | title | `string` | "Action" | The title of the action as shown in the menu. |
| visible | `boolean` or `Function` | Visibility state (see examples further in the document) | | visible | `boolean | Function` | true | Visibility state (see examples). |
### Events ### Events
@ -122,7 +123,7 @@ will trigger the same action.) You can also add your own handler by implementing
`execute` event. `execute` event.
Note that you can use _both_ a built-in handler and your own `execute` Note that you can use _both_ a built-in handler and your own `execute`
function in the same action. The `execute` function is passed a `NodeMinimalEntry` 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 (see the [Document Library model](document-library.model.md) page for more parameter (see the [Document Library model](document-library.model.md) page for more
information) which contains full details of the item that the action is operating on. For information) which contains full details of the item that the action is operating on. For
example, with `handler="delete"` you could use `execute` to show a message with the name, example, with `handler="delete"` you could use `execute` to show a message with the name,
@ -324,9 +325,9 @@ allow the item being copied/moved to be the destination if it is itself a folder
The `<content-action>` component allows you to control visibility with the help of the `visible` property and supports three major scenarios: The `<content-action>` component allows you to control visibility with the help of the `visible` property and supports three major scenarios:
* direct value of `boolean` type - direct value of `boolean` type
* binding to a property of the `boolean` type - binding to a property of the `boolean` type
* binding to a property of the `Function` type that evaluates condition and returns `boolean` value - binding to a property of the `Function` type that evaluates condition and returns `boolean` value
#### Using direct value of boolean type #### Using direct value of boolean type

View File

@ -29,7 +29,7 @@ Displays and edits metadata related to a node.
| displayEmpty | `boolean` | false | Toggles whether to display empty values in the card view | | displayEmpty | `boolean` | false | Toggles whether to display empty values in the card view |
| editable | `boolean` | false | Toggles whether the edit button should be shown | | editable | `boolean` | false | Toggles whether the edit button should be shown |
| expanded | `boolean` | false | Toggles between expanded (ie, full information) and collapsed (ie, reduced information) in the display | | expanded | `boolean` | false | Toggles between expanded (ie, full information) and collapsed (ie, reduced information) in the display |
| multi | `boolean` | false | The multi="true" input allows the expansions state to be set independently of each other. When multi="false" (default) just one panel can be expanded at a given time | | multi | `boolean` | false | The multi parameter of the underlying material expansion panel |
| node | `MinimalNodeEntryEntity` | | (required) The node entity to fetch metadata about | | node | `MinimalNodeEntryEntity` | | (required) The node entity to fetch metadata about |
| preset | `string` | | Name of the metadata preset, which defines aspects and their properties | | preset | `string` | | Name of the metadata preset, which defines aspects and their properties |

View File

@ -12,46 +12,46 @@ Displays and manages dialogs for selecting content to open, copy or upload.
### Methods ### Methods
- `close()`<br/> - **close**()<br/>
Closes the currently open dialog. Closes the currently open dialog.
- `getTitleTranslation(action: string = null, name: string = null): string`<br/> - **getTitleTranslation**(action: `string` = `null`, name: `string` = `null`): `string`<br/>
Gets the translation of the dialog title. Gets the translation of the dialog title.
- `action: string = null` - Name of the action to display in the dialog title - _action:_ `string` - Name of the action to display in the dialog title
- `name: string = null` - Name of the item on which the action is being performed - _name:_ `string` - Name of the item on which the action is being performed
- **Returns** `string` - Translated version of the title - **Returns** `string` - Translated version of the title
- `openCopyMoveDialog(action: string = null, contentEntry: MinimalNodeEntryEntity = null, permission?: string = null): Observable<MinimalNodeEntryEntity[]>`<br/> - **openCopyMoveDialog**(action: `string` = `null`, contentEntry: `MinimalNodeEntryEntity` = `null`, permission?: `string` = `null`): `Observable<MinimalNodeEntryEntity[]>`<br/>
Opens a dialog to copy or move an item to a new location. Opens a dialog to copy or move an item to a new location.
- `action: string = null` - Name of the action (eg, "Copy" or "Move") to show in the title - _action:_ `string` - Name of the action (eg, "Copy" or "Move") to show in the title
- `contentEntry: MinimalNodeEntryEntity = null` - Item to be copied or moved - _contentEntry:_ `MinimalNodeEntryEntity` - Item to be copied or moved
- `permission?: string = null` - (Optional) Permission for the operation - _permission:_ `string` - (Optional)Permission for the operation
- **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about files that were copied/moved - **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about files that were copied/moved
- `openFileBrowseDialogByFolderId(folderNodeId: string = null): Observable<MinimalNodeEntryEntity[]>`<br/> - **openFileBrowseDialogByFolderId**(folderNodeId: `string` = `null`): `Observable<MinimalNodeEntryEntity[]>`<br/>
Opens a file browser at a chosen folder location. Opens a file browser at a chosen folder location.
- `folderNodeId: string = null` - ID of the folder to use - _folderNodeId:_ `string` - ID of the folder to use
- **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the selected file(s) - **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the selected file(s)
- `openFileBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`<br/> - **openFileBrowseDialogBySite**(): `Observable<MinimalNodeEntryEntity[]>`<br/>
Opens a file browser at a chosen site location. Opens a file browser at a chosen site location.
- **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the selected file(s) - **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the selected file(s)
- `openFolderBrowseDialogByFolderId(folderNodeId: string = null): Observable<MinimalNodeEntryEntity[]>`<br/> - **openFolderBrowseDialogByFolderId**(folderNodeId: `string` = `null`): `Observable<MinimalNodeEntryEntity[]>`<br/>
Opens a folder browser at a chosen folder location. Opens a folder browser at a chosen folder location.
- `folderNodeId: string = null` - ID of the folder to use - _folderNodeId:_ `string` - ID of the folder to use
- **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the selected folder(s) - **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the selected folder(s)
- `openFolderBrowseDialogBySite(): Observable<MinimalNodeEntryEntity[]>`<br/> - **openFolderBrowseDialogBySite**(): `Observable<MinimalNodeEntryEntity[]>`<br/>
Opens a folder browser at a chosen site location. Opens a folder browser at a chosen site location.
- **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the selected folder(s) - **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the selected folder(s)
- `openLockNodeDialog(contentEntry: MinimalNodeEntryEntity = null): Subject<string>`<br/> - **openLockNodeDialog**(contentEntry: `MinimalNodeEntryEntity` = `null`): `Subject<string>`<br/>
Opens a lock node dialog. Opens a lock node dialog.
- `contentEntry: MinimalNodeEntryEntity = null` - Node to lock - _contentEntry:_ `MinimalNodeEntryEntity` - Node to lock
- **Returns** `Subject<string>` - Error/status message (if any) - **Returns** `Subject<string>` - Error/status message (if any)
- `openUploadFileDialog(action: string = null, contentEntry: MinimalNodeEntryEntity = null): Observable<MinimalNodeEntryEntity[]>`<br/> - **openUploadFileDialog**(action: `string` = `null`, contentEntry: `MinimalNodeEntryEntity` = `null`): `Observable<MinimalNodeEntryEntity[]>`<br/>
Opens a dialog to choose a file to upload. Opens a dialog to choose a file to upload.
- `action: string = null` - Name of the action to show in the title - _action:_ `string` - Name of the action to show in the title
- `contentEntry: MinimalNodeEntryEntity = null` - Item to upload - _contentEntry:_ `MinimalNodeEntryEntity` - Item to upload
- **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the chosen file(s) - **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the chosen file(s)
- `openUploadFolderDialog(action: string = null, contentEntry: MinimalNodeEntryEntity = null): Observable<MinimalNodeEntryEntity[]>`<br/> - **openUploadFolderDialog**(action: `string` = `null`, contentEntry: `MinimalNodeEntryEntity` = `null`): `Observable<MinimalNodeEntryEntity[]>`<br/>
Opens a dialog to choose folders to upload. Opens a dialog to choose folders to upload.
- `action: string = null` - Name of the action to show in the title - _action:_ `string` - Name of the action to show in the title
- `contentEntry: MinimalNodeEntryEntity = null` - Item to upload - _contentEntry:_ `MinimalNodeEntryEntity` - Item to upload
- **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the chosed folder(s) - **Returns** `Observable<MinimalNodeEntryEntity[]>` - Information about the chosed folder(s)
## Details ## Details

View File

@ -41,7 +41,7 @@ Allows a user to select items from a Content Services repository.
## Details ## Details
The Content Node Selector component works a lot like the standard File Open/Save The [Content Node Selector component](../content-services/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 dialog used by desktop applications except that it chooses items from a Content Services
repository rather than the filesystem. For example, the repository rather than the filesystem. For example, the
[Document List component](document-list.component.md) uses a selector to choose the targets [Document List component](document-list.component.md) uses a selector to choose the targets
@ -53,7 +53,7 @@ more information).
Unlike most components, the Content Node Selector is typically shown in a dialog box Unlike most components, the Content Node Selector 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 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, [Angular Material Dialog](https://material.angular.io/components/dialog/overview) for this,
as shown in the usage example. ADF provides the `ContentNodeSelectorComponentData` 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 to work with the Dialog's
[data option](https://material.angular.io/components/dialog/overview#sharing-data-with-the-dialog-component-): [data option](https://material.angular.io/components/dialog/overview#sharing-data-with-the-dialog-component-):
@ -132,7 +132,7 @@ openSelectorDialog() {
} }
``` ```
All the results will be streamed to the select [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present in the `ContentNodeSelectorComponentData` 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. When the dialog action is selected by clicking, the `data.select` stream will be completed.
### RowFilter and ImageResolver ### RowFilter and ImageResolver
@ -147,7 +147,7 @@ section of the Document List page to learn how these functions are implemented.
### Using the breadcrumbTransform function ### Using the breadcrumbTransform function
The `breadcrumbTransform` property of `ContentNodeSelectorComponentData` 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 object that is used to generate the the Node object that is used to generate the
list of breadcrumbs. You can use this, for example, to remove path elements that are not 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 relevant to the use case. See the [Breadcrumb component](breadcrumb.component.md) page for an

View File

@ -12,48 +12,48 @@ Manages Document List information that is specific to a user.
### Methods ### Methods
- `getCorrespondingNodeIds(nodeId: string = null, pagination: PaginationModel = null): Observable<string[]>`<br/> - **getCorrespondingNodeIds**(nodeId: `string` = `null`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): `Observable<string[]>`<br/>
Gets the contents of one of the well-known aliases in the form of node ID strings. Gets the contents of one of the well-known aliases in the form of node ID strings.
- `nodeId: string = null` - ID of the target folder node - _nodeId:_ `string` - ID of the target folder node
- `pagination: PaginationModel = null` - Specifies how to paginate the results - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- **Returns** `Observable<string[]>` - List of node IDs - **Returns** `Observable<string[]>` - List of node IDs
- `getRecentFiles(personId: string = null, pagination: PaginationModel = null): Observable<NodePaging>`<br/> - **getRecentFiles**(personId: `string` = `null`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
Gets files recently accessed by a user. Gets files recently accessed by a user.
- `personId: string = null` - ID of the user - _personId:_ `string` - ID of the user
- `pagination: PaginationModel = null` - Specifies how to paginate the results - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- **Returns** `Observable<NodePaging>` - List of nodes for the recently used files - **Returns** [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts) - List of nodes for the recently used files
- `isCustomSource(folderId: string = null): boolean`<br/> - **isCustomSource**(folderId: `string` = `null`): `boolean`<br/>
Is the folder ID one of the well-known aliases? Is the folder ID one of the well-known aliases?
- `folderId: string = null` - Folder ID name to check - _folderId:_ `string` - Folder ID name to check
- **Returns** `boolean` - True if the ID is a well-known name, false otherwise - **Returns** `boolean` - True if the ID is a well-known name, false otherwise
- `loadFavorites(pagination: PaginationModel = null, includeFields: string[] = []): Observable<NodePaging>`<br/> - **loadFavorites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `[]`): [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
Gets favorite files for the current user. Gets favorite files for the current user.
- `pagination: PaginationModel = null` - Specifies how to paginate the results - _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 - _includeFields:_ `string[]` - List of data field names to include in the results
- **Returns** `Observable<NodePaging>` - List of favorite files - **Returns** [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts) - List of favorite files
- `loadFolderByNodeId(nodeId: string = null, pagination: PaginationModel = null, includeFields: string[] = null): Observable<NodePaging>`<br/> - **loadFolderByNodeId**(nodeId: `string` = `null`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `null`): [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
Gets a folder's contents. Gets a folder's contents.
- `nodeId: string = null` - ID of the target folder node - _nodeId:_ `string` - ID of the target folder node
- `pagination: PaginationModel = null` - Specifies how to paginate the results - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- `includeFields: string[] = null` - List of data field names to include in the results - _includeFields:_ `string[]` - List of data field names to include in the results
- **Returns** `Observable<NodePaging>` - List of items contained in the folder - **Returns** [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts) - List of items contained in the folder
- `loadMemberSites(pagination: PaginationModel = null): Observable<NodePaging>`<br/> - **loadMemberSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
Gets sites that the current user is a member of. Gets sites that the current user is a member of.
- `pagination: PaginationModel = null` - Specifies how to paginate the results - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- **Returns** `Observable<NodePaging>` - List of sites - **Returns** [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts) - List of sites
- `loadSharedLinks(pagination: PaginationModel = null, includeFields: string[] = []): Observable<NodePaging>`<br/> - **loadSharedLinks**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `[]`): [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
Gets shared links for the current user. Gets shared links for the current user.
- `pagination: PaginationModel = null` - Specifies how to paginate the results - _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 - _includeFields:_ `string[]` - List of data field names to include in the results
- **Returns** `Observable<NodePaging>` - List of shared links - **Returns** [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts) - List of shared links
- `loadSites(pagination: PaginationModel = null): Observable<NodePaging>`<br/> - **loadSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
Gets all sites in the respository. Gets all sites in the respository.
- `pagination: PaginationModel = null` - Specifies how to paginate the results - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- **Returns** `Observable<NodePaging>` - List of sites - **Returns** [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts) - List of sites
- `loadTrashcan(pagination: PaginationModel = null, includeFields: string[] = []): Observable<DeletedNodesPaging>`<br/> - **loadTrashcan**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `[]`): `Observable<DeletedNodesPaging>`<br/>
Gets all items currently in the trash. Gets all items currently in the trash.
- `pagination: PaginationModel = null` - Specifies how to paginate the results - _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 - _includeFields:_ `string[]` - List of data field names to include in the results
- **Returns** `Observable<DeletedNodesPaging>` - List of deleted items - **Returns** `Observable<DeletedNodesPaging>` - List of deleted items
## Details ## Details

View File

@ -6,24 +6,24 @@ Last reviewed: 2018-03-29
# Document Actions service # Document Actions service
Implements the document menu actions for the Document List component. Implements the document menu actions for the [Document List component](../content-services/document-list.component.md).
## Class members ## Class members
### Methods ### Methods
- `canExecuteAction(obj: any = null): boolean`<br/> - **canExecuteAction**(obj: `any` = `null`): `boolean`<br/>
Checks if actions can be executed for an item. Checks if actions can be executed for an item.
- `obj: any = null` - Item to receive an action - _obj:_ `any` - Item to receive an action
- **Returns** `boolean` - True if the action can be executed on this item, false otherwise - **Returns** `boolean` - True if the action can be executed on this item, false otherwise
- `getHandler(key: string = null): ContentActionHandler`<br/> - **getHandler**(key: `string` = `null`): `ContentActionHandler`<br/>
Gets the handler for an action. Gets the handler for an action.
- `key: string = null` - Identifier of the action - _key:_ `string` - Identifier of the action
- **Returns** `ContentActionHandler` - The handler for the action - **Returns** `ContentActionHandler` - The handler for the action
- `setHandler(key: string = null, handler: ContentActionHandler = null): boolean`<br/> - **setHandler**(key: `string` = `null`, handler: `ContentActionHandler` = `null`): `boolean`<br/>
Sets a new handler for an action. Sets a new handler for an action.
- `key: string = null` - Identifier of the action - _key:_ `string` - Identifier of the action
- `handler: ContentActionHandler = null` - Handler for the action - _handler:_ `ContentActionHandler` - Handler for the action
- **Returns** `boolean` - False if the key was an empty/null string, true otherwise - **Returns** `boolean` - False if the key was an empty/null string, true otherwise
## Details ## Details

View File

@ -61,12 +61,12 @@ Displays the documents from a repository.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -- | -- | -- | -- | | -- | -- | -- | -- |
| allowDropFiles | `boolean` | false | Toggle file drop support for rows (see Upload Directive for further details | | allowDropFiles | `boolean` | false | Toggle file drop support for rows (see [Upload Directive](../core/upload.directive.md) for further details |
| contentActions | `boolean` | false | Toggles content actions for each row | | 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". | | 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 | | contextMenuActions | `boolean` | false | Toggles context menus for each row |
| currentFolderId | `string` | null | The ID of the folder node to display or a reserved string alias for special sources | | currentFolderId | `string` | null | The ID of the folder node to display or a reserved string alias for special sources |
| display | `string` | DisplayMode.List | Change the display mode of the table. Can be "list" or "gallery". | | display | `string` | [`DisplayMode`](../../lib/core/datatable/components/datatable/datatable.component.ts).List | Change the display mode of the table. Can be "list" or "gallery". |
| emptyFolderImageUrl | `string` | "./assets/images/empty_doc_lib.svg" | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' | | emptyFolderImageUrl | `string` | "./assets/images/empty_doc_lib.svg" | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' |
| enableInfiniteScrolling | `boolean` | false | Set document list to work in infinite scrolling mode | | enableInfiniteScrolling | `boolean` | false | Set document list to work in infinite scrolling mode |
| folderNode | `MinimalNodeEntryEntity` | null | Currently displayed folder node | | folderNode | `MinimalNodeEntryEntity` | null | Currently displayed folder node |
@ -77,28 +77,28 @@ Displays the documents from a repository.
| maxItems | `number` | | Default value is stored into user preference settings use it only if you are not using the pagination | | maxItems | `number` | | Default value is stored into user preference settings use it only if you are not using the pagination |
| multiselect | `boolean` | false | Toggles multiselect mode | | multiselect | `boolean` | false | Toggles multiselect mode |
| navigate | `boolean` | true | Toggles navigation to folder content or file preview | | navigate | `boolean` | true | Toggles navigation to folder content or file preview |
| navigationMode | `string` | DocumentListComponent.DOUBLE_CLICK_NAVIGATION | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | | navigationMode | `string` | [`DocumentListComponent`](../content-services/document-list.component.md).DOUBLE_CLICK_NAVIGATION | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" |
| node | `NodePaging` | null | The Document list will show all the nodes contained in the NodePaging entity | | 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[]` | \[] | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the Permission Style model page for further details and examples. | | permissionsStyle | `PermissionStyleModel[]` | \[] | Define a set of CSS styles 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. |
| rowFilter | `any | null` | null | Custom row filter | | rowFilter | `any | null` | null | Custom row filter |
| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage 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 | | 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. | | selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| showHeader | `boolean` | true | Toggles the header | | showHeader | `boolean` | true | Toggles the header |
| skipCount | `number` | 0 | Number of elements to skip over for pagination purposes | | skipCount | `number` | 0 | Number of elements to skip over for pagination purposes |
| sorting | `string[]` | | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. | | sorting | `string[]` | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
| sortingMode | `string` | "client" | Defines sorting mode. Can be either `client` or `server`. |
| thumbnails | `boolean` | false | Show document thumbnails rather than icons | | thumbnails | `boolean` | false | Show document thumbnails rather than icons |
| sortingMode | `string` | `client` | Defines sorting mode. Can be either `client` or `server`. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when the API fails to get the Document List data | | error | `EventEmitter<any>` | Emitted when the API fails to get the Document List data |
| folderChange | `EventEmitter<NodeEntryEvent>` | Emitted when the current display folder changes | | folderChange | [`EventEmitter<NodeEntryEvent>`](../../lib/content-services/document-list/components/node.event.ts) | Emitted when the current display folder changes |
| nodeClick | `EventEmitter<NodeEntityEvent>` | Emitted when the user clicks a list node | | nodeClick | [`EventEmitter<NodeEntityEvent>`](../../lib/content-services/document-list/components/node.event.ts) | Emitted when the user clicks a list node |
| nodeDblClick | `EventEmitter<NodeEntityEvent>` | Emitted when the user double-clicks a list node | | nodeDblClick | [`EventEmitter<NodeEntityEvent>`](../../lib/content-services/document-list/components/node.event.ts) | Emitted when the user double-clicks a list node |
| preview | `EventEmitter<NodeEntityEvent>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the Viewer component. | | preview | [`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<NodePaging>` | Emitted when the Document List has loaded all items and is ready for use | | ready | `EventEmitter<NodePaging>` | Emitted when the Document List has loaded all items and is ready for use |
## Details ## Details
@ -130,7 +130,7 @@ 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 See the [DataTable](../core/datatable.component.md) documentation for further details about
the other DOM events that the Document List component bubbles up from the DataTable. the other DOM events that the [Document List component](../content-services/document-list.component.md) bubbles up from the DataTable.
Below is a basic example of handling DOM events in the parent elements. Below is a basic example of handling DOM events in the parent elements.
@ -202,7 +202,7 @@ You can use one of the well-known reserved aliases:
#### Document List aliases #### Document List aliases
The Document List component also provides support for the following reserved aliases: The [Document List component](../content-services/document-list.component.md) also provides support for the following reserved aliases:
- `-trashcan-`, - `-trashcan-`,
- `-sharedlinks-` - `-sharedlinks-`
@ -214,7 +214,7 @@ The Document List component also provides support for the following reserved ali
Note that due to the nature of the data, these sources do not support navigation. 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. You may want to handle single and double clicks yourself to perform navigation to other sources.
The Document List component supports default presets for all the custom sources mentioned earlier. The [Document List component](../content-services/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) 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. component then a default preset will be automatically used at runtime.
@ -456,8 +456,8 @@ documentation for a full explanation of the component lifecycle.
### Underlying node object ### Underlying node object
The Document List component assigns an instance of The [Document List component](../content-services/document-list.component.md) assigns an instance of
[MinimalNode]\(<https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/MinimalNode.md>] [MinimalNode](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/MinimalNode.md)
(defined in the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api)) as the data context (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: for each row. You can make use of the properties of this object when defining custom columns:
@ -641,7 +641,7 @@ This single extra line in the template enables context menu items for documents
### Navigation mode ### Navigation mode
By default, the Document List component uses 'double-click' mode for navigation. By default, the [Document List component](../content-services/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 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 or icon (in a similar manner to Google Drive). However, there is also a single-click mode that
may be sometimes be useful. may be sometimes be useful.
@ -660,7 +660,7 @@ The following example switches navigation to single clicks:
You can create a custom row filter function that returns `true` if the row should be You can create a custom row filter function that returns `true` if the row should be
displayed or `false` if it should be hidden. displayed or `false` if it should be hidden.
A typical row filter implementation receives a `ShareDataRow` object as a parameter: A typical row filter implementation receives a [`ShareDataRow`](../../lib/content-services/document-list/data/share-data-row.model.ts) object as a parameter:
```ts ```ts
myFilter(row: ShareDataRow): boolean { myFilter(row: ShareDataRow): boolean {
@ -711,7 +711,7 @@ are resolved (ie, which image is shown for which item).
**Note:** Image resolvers are executed only for columns of the `image` type. **Note:** Image resolvers are executed only for columns of the `image` type.
A typical image resolver implementation receives `DataRow` and `DataColumn` 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 ```ts
myImageResolver(row: DataRow, col: DataColumn): string { myImageResolver(row: DataRow, col: DataColumn): string {

View File

@ -6,64 +6,64 @@ Last reviewed: 2018-04-16
# Document List service # Document List service
Implements node operations used by the Document List component. Implements node operations used by the [Document List component](../content-services/document-list.component.md).
## Class members ## Class members
### Methods ### Methods
- `copyNode(nodeId: string = null, targetParentId: string = null): Observable<any>`<br/> - **copyNode**(nodeId: `string` = `null`, targetParentId: `string` = `null`): `Observable<any>`<br/>
Copy a node to destination node Copy a node to destination node
- `nodeId: string = null` - The id of the node to be copied - _nodeId:_ `string` - The id of the node to be copied
- `targetParentId: string = null` - The id of the folder where the node will be copied - _targetParentId:_ `string` - The id of the folder where the node will be copied
- **Returns** `Observable<any>` - NodeEntry for the copied node - **Returns** `Observable<any>` - NodeEntry for the copied node
- `createFolder(name: string = null, parentId: string = null): Observable<MinimalNodeEntity>`<br/> - **createFolder**(name: `string` = `null`, parentId: `string` = `null`): `Observable<MinimalNodeEntity>`<br/>
Creates a new folder in the path. Creates a new folder in the path.
- `name: string = null` - Folder name - _name:_ `string` - Folder name
- `parentId: string = null` - Parent folder ID - _parentId:_ `string` - Parent folder ID
- **Returns** `Observable<MinimalNodeEntity>` - Details of the created folder node - **Returns** `Observable<MinimalNodeEntity>` - Details of the created folder node
- `deleteNode(nodeId: string = null): Observable<any>`<br/> - **deleteNode**(nodeId: `string` = `null`): `Observable<any>`<br/>
Deletes a node. Deletes a node.
- `nodeId: string = null` - ID of the node to delete - _nodeId:_ `string` - ID of the node to delete
- **Returns** `Observable<any>` - Empty response when the operation is complete - **Returns** `Observable<any>` - Empty response when the operation is complete
- `getDefaultMimeTypeIcon(): string`<br/> - **getDefaultMimeTypeIcon**(): `string`<br/>
Gets a default icon for MIME types with no specific icon. Gets a default icon for MIME types with no specific icon.
- **Returns** `string` - Path to the icon file - **Returns** `string` - Path to the icon file
- `getDocumentThumbnailUrl(node: MinimalNodeEntity = null): string`<br/> - **getDocumentThumbnailUrl**(node: `MinimalNodeEntity` = `null`): `string`<br/>
Get thumbnail URL for the given document node. Get thumbnail URL for the given document node.
- `node: MinimalNodeEntity = null` - Node to get URL for. - _node:_ `MinimalNodeEntity` - Node to get URL for.
- **Returns** `string` - Thumbnail URL string - **Returns** `string` - Thumbnail URL string
- `getFolder(folder: string = null, opts?: any = null, includeFields: string[] = []): Observable<NodePaging>`<br/> - **getFolder**(folder: `string` = `null`, opts?: `any` = `null`, includeFields: `string[]` = `[]`): [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
Gets the folder node with the specified relative name path below the root node. Gets the folder node with the specified relative name path below the root node.
- `folder: string = null` - Path to folder. - _folder:_ `string` - Path to folder.
- `opts?: any = null` - (Optional) Options. - _opts:_ `any` - (Optional)Options.
- `includeFields: string[] = []` - Extra information to include (available options are "aspectNames", "isLink" and "association") - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** `Observable<NodePaging>` - Details of the folder - **Returns** [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts) - Details of the folder
- `getFolderNode(nodeId: string = null, includeFields: string[] = []): Observable<MinimalNodeEntryEntity>`<br/> - **getFolderNode**(nodeId: `string` = `null`, includeFields: `string[]` = `[]`): `Observable<MinimalNodeEntryEntity>`<br/>
- `nodeId: string = null` - ID of the folder node - _nodeId:_ `string` - ID of the folder node
- `includeFields: string[] = []` - Extra information to include (available options are "aspectNames", "isLink" and "association") - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** `Observable<MinimalNodeEntryEntity>` - Details of the folder - **Returns** `Observable<MinimalNodeEntryEntity>` - Details of the folder
- `getMimeTypeIcon(mimeType: string = null): string`<br/> - **getMimeTypeIcon**(mimeType: `string` = `null`): `string`<br/>
Gets the icon that represents a MIME type. Gets the icon that represents a MIME type.
- `mimeType: string = null` - MIME type to get the icon for - _mimeType:_ `string` - MIME type to get the icon for
- **Returns** `string` - Path to the icon file - **Returns** `string` - Path to the icon file
- `getNode(nodeId: string = null, includeFields: string[] = []): Observable<NodeEntry>`<br/> - **getNode**(nodeId: `string` = `null`, includeFields: `string[]` = `[]`): `Observable<NodeEntry>`<br/>
Gets a node via its node ID. Gets a node via its node ID.
- `nodeId: string = null` - ID of the target node - _nodeId:_ `string` - ID of the target node
- `includeFields: string[] = []` - Extra information to include (available options are "aspectNames", "isLink" and "association") - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** `Observable<NodeEntry>` - Details of the folder - **Returns** `Observable<NodeEntry>` - Details of the folder
- `hasPermission(node: any = null, permission: PermissionsEnum | string = null): boolean`<br/> - **hasPermission**(node: `any` = `null`, permission: `PermissionsEnum | string` = `null`): `boolean`<br/>
- `node: any = null` - Target node - _node:_ `any` - Target node
- `permission: PermissionsEnum | string = null` - Permission level to query - _permission:_ `PermissionsEnum | string` - Permission level to query
- **Returns** `boolean` - True if the node has the permission, false otherwise - **Returns** `boolean` - True if the node has the permission, false otherwise
- `moveNode(nodeId: string = null, targetParentId: string = null): Observable<any>`<br/> - **moveNode**(nodeId: `string` = `null`, targetParentId: `string` = `null`): `Observable<any>`<br/>
Moves a node to destination node. Moves a node to destination node.
- `nodeId: string = null` - The id of the node to be moved - _nodeId:_ `string` - The id of the node to be moved
- `targetParentId: string = null` - The id of the folder where the node will be moved - _targetParentId:_ `string` - The id of the folder where the node will be moved
- **Returns** `Observable<any>` - NodeEntry for the moved node - **Returns** `Observable<any>` - NodeEntry for the moved node
## Details ## Details

View File

@ -27,14 +27,14 @@ Indicates the current position within a navigation hierarchy using a dropdown me
| folderNode | `MinimalNodeEntryEntity` | null | Active node, builds UI based on folderNode.path.elements collection. | | folderNode | `MinimalNodeEntryEntity` | null | Active node, builds UI based on folderNode.path.elements collection. |
| 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. | | 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. | | 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` | | (optional) Document List component to operate with. The list will update when the breadcrumb is clicked. | | 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. |
| 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. | | 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 ### Events
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| navigate | `EventEmitter<PathElementEntity>` | Emitted when the user clicks on a breadcrumb. | | navigate | [`EventEmitter<PathElementEntity>`](../../lib/content-services/document-list/models/document-library.model.ts) | Emitted when the user clicks on a breadcrumb. |
## See also ## See also

View File

@ -52,7 +52,7 @@ Some sample CSS to show the drag and drop area:
## Details ## Details
Typically you would use the Upload Drag Area component instead of this directive. Typically you would use the [Upload Drag Area component](../content-services/upload-drag-area.component.md) instead of this directive.
### Event handler implementations ### Event handler implementations

View File

@ -6,24 +6,24 @@ Last reviewed: 2018-04-05
# Folder Actions service # Folder Actions service
Implements the folder menu actions for the Document List component. Implements the folder menu actions for the [Document List component](../content-services/document-list.component.md).
## Class members ## Class members
### Methods ### Methods
- `canExecuteAction(obj: any = null): boolean`<br/> - **canExecuteAction**(obj: `any` = `null`): `boolean`<br/>
Checks if an action is available for a particular item. Checks if an action is available for a particular item.
- `obj: any = null` - Item to check - _obj:_ `any` - Item to check
- **Returns** `boolean` - True if the action is available, false otherwise - **Returns** `boolean` - True if the action is available, false otherwise
- `getHandler(key: string = null): ContentActionHandler`<br/> - **getHandler**(key: `string` = `null`): `ContentActionHandler`<br/>
Gets the handler function for an action. Gets the handler function for an action.
- `key: string = null` - Identifier for the action - _key:_ `string` - Identifier for the action
- **Returns** `ContentActionHandler` - The handler function - **Returns** `ContentActionHandler` - The handler function
- `setHandler(key: string = null, handler: ContentActionHandler = null): boolean`<br/> - **setHandler**(key: `string` = `null`, handler: `ContentActionHandler` = `null`): `boolean`<br/>
Sets a new handler function for an action. Sets a new handler function for an action.
- `key: string = null` - Identifier for the action - _key:_ `string` - Identifier for the action
- `handler: ContentActionHandler = null` - The new handler function - _handler:_ `ContentActionHandler` - The new handler function
- **Returns** `boolean` - True if the key was a valid action identifier, false otherwise - **Returns** `boolean` - True if the key was a valid action identifier, false otherwise
## Details ## Details

View File

@ -46,9 +46,9 @@ Creates folders.
Pass this directive the id of the parent folder where you want the new folder node to be created. 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. If no value is provided, the '-my-' alias is used.
This will open a Folder Dialog component 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. then the dialog will emit a `success` event when it closes.
## See also ## See also
- [Folder Edit directive](folder-edit.directive.md) - [Folder Edit directive](folder-edit.directive.md)

View File

@ -43,5 +43,5 @@ Allows folders to be edited.
## Details ## Details
Pass this directive a folder to edit its name and description using a Folder Dialog component. 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. If the data is valid then the dialog emits a `folderEdit` event when it closes.

View File

@ -12,19 +12,38 @@ Manages role permissions for content nodes.
### Methods ### Methods
- `getGroupMemeberByGroupName(groupName: string = null, opts?: any = null): Observable<GroupMemberPaging>`<br/> - **getGroupMemeberByGroupName**(groupName: `string` = `null`, opts?: `any` = `null`): `Observable<GroupMemberPaging>`<br/>
Gets all members related to a group name. Gets all members related to a group name.
- `groupName: string = null` - Name of group to look for members - _groupName:_ `string` - Name of group to look for members
- `opts?: any = null` - (Optional) Extra options supported by JSAPI - _opts:_ `any` - (Optional)Extra options supported by JSAPI
- **Returns** `Observable<GroupMemberPaging>` - List of members - **Returns** `Observable<GroupMemberPaging>` - List of members
- `getNodeRoles(node: MinimalNodeEntryEntity = null): Observable<string[]>`<br/> - **getNodeRoles**(node: `MinimalNodeEntryEntity` = `null`): `Observable<string[]>`<br/>
Gets a list of roles for the current node. Gets a list of roles for the current node.
- `node: MinimalNodeEntryEntity = null` - The target node - _node:_ `MinimalNodeEntryEntity` - The target node
- **Returns** `Observable<string[]>` - Array of strings representing the roles - **Returns** `Observable<string[]>` - Array of strings representing the roles
- `updatePermissionRoles(node: MinimalNodeEntryEntity = null, updatedPermissionRole: PermissionElement = null): Observable<MinimalNodeEntryEntity>`<br/> - **removePermission**(node: `MinimalNodeEntryEntity` = `null`, permissionToRemove: `PermissionElement` = `null`): `Observable<MinimalNodeEntryEntity>`<br/>
- _node:_ `MinimalNodeEntryEntity` -
- _permissionToRemove:_ `PermissionElement` -
- **Returns** `Observable<MinimalNodeEntryEntity>` -
- **updateLocallySetPermissions**(node: `MinimalNodeEntryEntity` = `null`, nodes: `MinimalNodeEntity[]` = `null`, nodeRole: `string[]` = `null`): `Observable<MinimalNodeEntryEntity>`<br/>
- _node:_ `MinimalNodeEntryEntity` -
- _nodes:_ `MinimalNodeEntity[]` -
- _nodeRole:_ `string[]` -
- **Returns** `Observable<MinimalNodeEntryEntity>` -
- **updateNodePermissions**(nodeId: `string` = `null`, permissionList: `MinimalNodeEntity[]` = `null`): `Observable<MinimalNodeEntryEntity>`<br/>
- _nodeId:_ `string` -
- _permissionList:_ `MinimalNodeEntity[]` -
- **Returns** `Observable<MinimalNodeEntryEntity>` -
- **updatePermissionRole**(node: `MinimalNodeEntryEntity` = `null`, updatedPermissionRole: `PermissionElement` = `null`): `Observable<MinimalNodeEntryEntity>`<br/>
Updates the permission for a node. Updates the permission for a node.
- `node: MinimalNodeEntryEntity = null` - Target node - _node:_ `MinimalNodeEntryEntity` - Target node
- `updatedPermissionRole: PermissionElement = null` - Permission role to update or add - _updatedPermissionRole:_ `PermissionElement` - Permission role to update or add
- **Returns** `Observable<MinimalNodeEntryEntity>` - Node with updated permission - **Returns** `Observable<MinimalNodeEntryEntity>` - Node with updated permission
## Details ## Details

View File

@ -40,6 +40,7 @@ or custom template can be added:
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | |
| update | `EventEmitter<PermissionElement>` | Emitted when the permission is updated. | | update | `EventEmitter<PermissionElement>` | Emitted when the permission is updated. |
## Details ## Details

View File

@ -9,7 +9,7 @@ Sets custom CSS styles for rows of a Document List according to the item's permi
## Class members ## Class members
## Properties ### Properties
| Property | Type | Description | | Property | Type | Description |
| -------- | ---- | ----------- | | -------- | ---- | ----------- |
@ -22,7 +22,7 @@ Sets custom CSS styles for rows of a Document List according to the item's permi
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](document-list.component.md) row based on the user's
permissions for that item. The list has a `permissionsStyle` property containing an array of permissions for that item. The list has a `permissionsStyle` property containing an array of
Permission Style model objects. These objects associate a particular CSS style with a permission level [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
and can be applied separately to files and folders by setting `isFile` and `isFolder` appropriately. and can be applied separately to files and folders by setting `isFile` and `isFolder` appropriately.
### Permissions enum ### Permissions enum

View File

@ -12,21 +12,21 @@ Manages ratings for items in Content Services.
### Methods ### Methods
- `deleteRating(nodeId: string = null, ratingType: any = null): any`<br/> - **deleteRating**(nodeId: `string` = `null`, ratingType: `any` = `null`): `any`<br/>
Removes the current user's rating for a node. Removes the current user's rating for a node.
- `nodeId: string = null` - Target node - _nodeId:_ `string` - Target node
- `ratingType: any = null` - Type of rating to remove (can be "likes" or "fiveStar") - _ratingType:_ `any` - Type of rating to remove (can be "likes" or "fiveStar")
- **Returns** `any` - Null response indicating that the operation is complete - **Returns** `any` - Null response indicating that the operation is complete
- `getRating(nodeId: string = null, ratingType: any = null): any`<br/> - **getRating**(nodeId: `string` = `null`, ratingType: `any` = `null`): `any`<br/>
Gets the current user's rating for a node. Gets the current user's rating for a node.
- `nodeId: string = null` - Node to get the rating from - _nodeId:_ `string` - Node to get the rating from
- `ratingType: any = null` - Type of rating (can be "likes" or "fiveStar") - _ratingType:_ `any` - Type of rating (can be "likes" or "fiveStar")
- **Returns** `any` - The rating value - **Returns** `any` - The rating value
- `postRating(nodeId: string = null, ratingType: any = null, vote: any = null): any`<br/> - **postRating**(nodeId: `string` = `null`, ratingType: `any` = `null`, vote: `any` = `null`): `any`<br/>
Adds the current user's rating for a node. Adds the current user's rating for a node.
- `nodeId: string = null` - Target node for the rating - _nodeId:_ `string` - Target node for the rating
- `ratingType: any = null` - Type of rating (can be "likes" or "fiveStar") - _ratingType:_ `any` - Type of rating (can be "likes" or "fiveStar")
- `vote: any = null` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar") - _vote:_ `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
- **Returns** `any` - Details about the rating, including the new value - **Returns** `any` - Details about the rating, including the new value
## Details ## Details

View File

@ -8,6 +8,39 @@ Last reviewed: 2018-04-16
Represents a main container component for custom search and faceted search settings. Represents a main container component for custom search and faceted search settings.
## Contents
- [Basic usage](#basic-usage)
- [Details](#details)
- [Configuration](#configuration)
- [Extra fields and filter queries](#extra-fields-and-filter-queries)
- [Sorting](#sorting)
- [Categories](#categories)
- [Settings](#settings)
- [Facet Fields](#facet-fields)
- [Facet Queries](#facet-queries)
- [Widgets](#widgets)
- [Check List Widget](#check-list-widget)
- [Date Range Widget](#date-range-widget)
- [Number Range Widget](#number-range-widget)
- [Radio List Widget](#radio-list-widget)
- [Slider Widget](#slider-widget)
- [Resetting slider value](#resetting-slider-value)
- [Text Widget](#text-widget)
- [Custom Widgets](#custom-widgets)
- [Implementing custom widget](#implementing-custom-widget)
- [Reading external settings](#reading-external-settings)
- [Updating final query](#updating-final-query)
- [Registering custom widget](#registering-custom-widget)
- [See also](#see-also)
## Basic usage ## Basic usage
```html ```html
@ -21,9 +54,9 @@ and the [Search Query Builder service](search-query-builder.service.md)\` to bui
Before you begin with customizations, check also the following articles: Before you begin with customizations, check also the following articles:
- [Search API](https://docs.alfresco.com/5.2/concepts/search-api.html) - [Search API](https://docs.alfresco.com/5.2/concepts/search-api.html)
- [Alfresco Full Text Search Reference](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-intro.html) - [Alfresco Full Text Search Reference](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-intro.html)
- [ACS API Explorer](https://api-explorer.alfresco.com/api-explorer/#!/search/search) - [ACS API Explorer](https://api-explorer.alfresco.com/api-explorer/#!/search/search)
### Configuration ### Configuration
@ -143,15 +176,16 @@ and `defaults` that contains predefined sorting to use by default.
#### Sorting Definition Attributes #### Sorting Definition Attributes
| Name | Type | Description | | Name | Type | Description |
| --- | --- | --- | | ---- | ---- | ----------- |
| key | string | Unique key to identify the entry, can also be used to map DataColumn instances. | | key | string | Unique key to identify the entry, can also be used to map DataColumn instances. |
| label | string | Display text, can also be an i18n resource key. | | label | string | Display text, can also be an i18n resource key. |
| type | string | This specifies how to order - either by using a field or based on the position of the document in the index, or by score/relevance. | | type | string | This specifies how to order - either by using a field or based on the position of the document in the index, or by score/relevance. |
| field | string | The name of the field. | | field | string | The name of the field. |
| ascending | boolean | The sorting order. | | ascending | boolean | The sorting order. |
See also: See also:
* Alfresco Content Services API Reference / Search Api / [Sort](https://docs.alfresco.com/5.2/concepts/search-api-sort.html)
- Alfresco Content Services API Reference / Search Api / [Sort](https://docs.alfresco.com/5.2/concepts/search-api-sort.html)
### Categories ### Categories
@ -178,7 +212,7 @@ The interface above also describes entries in the `search.query.categories` sect
![Search Categories](../docassets/images/search-categories-01.png) ![Search Categories](../docassets/images/search-categories-01.png)
> **Important note: you need at least one category field to be provided in order to execute the query, > **Important note: you need at least one category field to be provided in order to execute the query,
so that filters and selected facets are applied.** > so that filters and selected facets are applied.**
### Settings ### Settings
@ -186,7 +220,7 @@ Every use case will have a different set of settings.
For example Number editors may parse minimum and maximum values, while Text editors can support value formats or length constraints. 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 your custom widget using the You can use `component.settings` to pass any information to your custom widget using the
`SearchWidgetSettings` interface: [`SearchWidgetSettings`](../../lib/content-services/search/search-widget-settings.interface.ts) interface:
```ts ```ts
export interface SearchWidgetSettings { export interface SearchWidgetSettings {
@ -221,14 +255,14 @@ If there are more than 5 entries, the "Show more" button is displayed to allow d
#### FacetField Properties #### FacetField Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | ---- | ---- | ------- | ----------- |
| field | string | | This specifies the facet field. | | field | string | | This specifies the facet field. |
| mincount | number | 1 | This specifies the minimum count required for a facet field to be included in the response. The default value is 1. | | mincount | number | 1 | This specifies the minimum count required for a facet field to be included in the response. The default value is 1. |
| label | string | | This specifies the label to include in place of the facet field. | | label | string | | This specifies the label to include in place of the facet field. |
| prefix | string | | This restricts the possible constraints to only indexed values with a specified prefix. | | prefix | string | | This restricts the possible constraints to only indexed values with a specified prefix. |
| limit | number | | Maximum number of results | | limit | number | | Maximum number of results |
| pageSize | number | 5 | Display page size | | pageSize | number | 5 | Display page size |
| offset | number | | Offset position | | offset | number | | Offset position |
### Facet Queries ### Facet Queries
@ -271,16 +305,16 @@ The default page size is `5`, it is going to be used in case you set the value t
## Widgets ## Widgets
You can use external application configuration to define a set of Angular components (aka Search Filter Widgets) You can use external application configuration to define a set of Angular components (aka Search Filter Widgets)
that provide extra features and/or behaviour for the Search Filter component. that provide extra features and/or behaviour for the [Search Filter component](../content-services/search-filter.component.md).
The Search Filter supports the following widgets out of the box: The Search Filter supports the following widgets out of the box:
- Check List (`check-list`) - Check List (`check-list`)
- Date Range (`date-range`) - Date Range (`date-range`)
- Number Range (`number-range`) - Number Range (`number-range`)
- Radio List (`radio`) - Radio List (`radio`)
- Slider (`slider`) - Slider (`slider`)
- Text (`text`) - Text (`text`)
At runtime, ADF uses `selector` attribute values to map and create corresponding Angular element. At runtime, ADF uses `selector` attribute values to map and create corresponding Angular element.
@ -327,9 +361,9 @@ If all items fit a single page, then a "Clear all" action button is displayed at
In case there are more than one page three icon buttons will be displayed to allow: In case there are more than one page three icon buttons will be displayed to allow:
- clear all values - clear all values
- show more items (if applicable) - show more items (if applicable)
- show less items (if applicable) - show less items (if applicable)
### Date Range Widget ### Date Range Widget
@ -360,13 +394,14 @@ Provides ability to select a range between two Dates based on the particular `fi
#### Widget Settings #### Widget Settings
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --- | --- | --- | --- | | ---- | ---- | ------------- | ----------- |
| field | string | `undefined` | Field to to use. Required value | | field | string | `undefined` | Field to to use. Required value |
| dateFormat | string | 'DD/MM/YYYY' | Date format. Dates used by the datepicker are Moment.js instances, so please check the documentation on [Moment](https://momentjs.com/docs/#/parsing/string-format/) so you can set your required date format. | | dateFormat | string | 'DD/MM/YYYY' | Date format. Dates used by the datepicker are Moment.js instances, so please check the documentation on [Moment](https://momentjs.com/docs/#/parsing/string-format/) so you can set your required date format. |
#### Custom date format #### Custom date format
You can set the date range picker to work with any date format your app requires. Just set the wanted value for the 'dateFormat' like this: You can set the date range picker to work with any date format your app requires. Just set the wanted value for the 'dateFormat' like this:
```json ```json
{ {
"search": { "search": {
@ -418,7 +453,7 @@ Provides ability to select a range between two Numbers based on the particular `
#### Widget Settings #### Widget Settings
| Name | Type | Description | | Name | Type | Description |
| --- | --- | --- | | ---- | ---- | ----------- |
| field | string | Field to to use | | field | string | Field to to use |
| format | string | Value format. Uses string substitution to allow all sorts of [range queries](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-ranges.html). | | format | string | Value format. Uses string substitution to allow all sorts of [range queries](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-ranges.html). |
@ -445,7 +480,7 @@ cm:content.size:[0 TO 100]
Other format examples: Other format examples:
| Format | Example | | Format | Example |
| --- | --- | | ------ | ------- |
| `[{FROM} TO {TO}]` | `[0 TO 5]` | | `[{FROM} TO {TO}]` | `[0 TO 5]` |
| `<{FROM} TO {TO}]` | `<0 TO 5]` | | `<{FROM} TO {TO}]` | `<0 TO 5]` |
| `[{FROM} TO {TO}>` | `[0 TO 5>` | | `[{FROM} TO {TO}>` | `[0 TO 5>` |
@ -488,8 +523,8 @@ The behaviour is very similar to those of the `check-list` except `radio` allows
It is possible to set the size of the page to display items. The default size is 5. It is possible to set the size of the page to display items. The default size is 5.
In case there are more than one page three icon buttons will be displayed to allow: In case there are more than one page three icon buttons will be displayed to allow:
- show more items (if applicable) - show more items (if applicable)
- show less items (if applicable) - show less items (if applicable)
### Slider Widget ### Slider Widget
@ -556,7 +591,7 @@ Upon clicking the `Clear` button slider will be reset to the `min` value or `0`,
![Text Widget](../docassets/images/search-text.png) ![Text Widget](../docassets/images/search-text.png)
> **Important note: you need at least one category field to be provided in order to execute the query, > **Important note: you need at least one category field to be provided in order to execute the query,
so that filters and selected facets are applied.** > so that filters and selected facets are applied.**
## Custom Widgets ## Custom Widgets
@ -564,7 +599,7 @@ so that filters and selected facets are applied.**
It is possible to create custom Angular components that display and/or modify resulting search query. It is possible to create custom Angular components that display and/or modify resulting search query.
You start creating a Search Filter widget by generating a blank Angular component that implements `SearchWidget` interface: You start creating a Search Filter widget by generating a blank Angular component that implements [`SearchWidget`](../../lib/content-services/search/search-widget.interface.ts) interface:
```ts ```ts
export interface SearchWidget { export interface SearchWidget {
@ -575,7 +610,7 @@ export interface SearchWidget {
``` ```
Every widget implementation must have an `id`, and may also support external `settings`. 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` 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)
so that you component can access query related information, events and methods. so that you component can access query related information, events and methods.
```ts ```ts
@ -621,7 +656,7 @@ export class MyComponent implements SearchWidget, OnInit {
### Updating final query ### Updating final query
The `SearchQueryBuilderService` keeps track on all query fragments populated by widgets The [`SearchQueryBuilderService`](../content-services/search-query-builder.service.md) keeps track on all query fragments populated by widgets
and composes them together alongside other settings when performing a final query. and composes them together alongside other settings when performing a final query.
Every query fragment is stored/retrieved using widget `id`. Every query fragment is stored/retrieved using widget `id`.
@ -651,7 +686,7 @@ When executed, your fragment will be injected into the resulting query based on
### Registering custom widget ### Registering custom widget
You can register your own Widgets by utilizing the `SearchFilterService` service: You can register your own Widgets by utilizing the [`SearchFilterService`](../../lib/content-services/search/components/search-filter/search-filter.service.ts) service:
```ts ```ts
import { MyComponent } from './my-component.ts' import { MyComponent } from './my-component.ts'
@ -693,6 +728,6 @@ and pass custom attributes in case your component supports them:
## See also ## See also
- [Search Query Builder service](search-query-builder.service.md) - [Search Query Builder service](search-query-builder.service.md)
- [Search Chip List Component](search-chip-list.component.md) - [Search Chip List Component](search-chip-list.component.md)
- [Search Sorting Picker Component](search-sorting-picker.component.md) - [Search Sorting Picker Component](search-sorting-picker.component.md)

View File

@ -11,27 +11,34 @@ Stores information from all the custom search and faceted search widgets, compil
### Methods ### Methods
- `addFilterQuery(query: string = null)`<br/> - **addFilterQuery**(query: `string` = `null`)<br/>
- `query: string = null` - - _query:_ `string` -
- `buildQuery(): QueryBody`<br/>
- **Returns** `QueryBody` - - **buildQuery**(): `QueryBody`<br/>
- `execute(): Promise<void>`<br/> - **Returns** `QueryBody` -
- **execute**(): `Promise<void>`<br/>
- **Returns** `Promise<void>` - - **Returns** `Promise<void>` -
- `getFacetQuery(label: string = null): FacetQuery`<br/> - **getFacetQuery**(label: `string` = `null`): [`FacetQuery`](../../lib/content-services/search/facet-query.interface.ts)<br/>
- `label: string = null` - - _label:_ `string` -
- **Returns** `FacetQuery` - - **Returns** [`FacetQuery`](../../lib/content-services/search/facet-query.interface.ts) -
- `removeFilterQuery(query: string = null)`<br/> - **getPrimarySorting**(): [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts)<br/>
Returns primary sorting definition.
- **Returns** [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts) -
- **getSortingOptions**(): `SearchSortingDefinition[]`<br/>
Returns all pre-configured sorting options that users can choose from.
- **Returns** `SearchSortingDefinition[]` -
- **removeFilterQuery**(query: `string` = `null`)<br/>
- `query: string = null` - - _query:_ `string` -
- `update()`<br/> - **update**()<br/>
## Details ## Details

View File

@ -52,7 +52,7 @@ Searches items for supplied search terms.
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | `EventEmitter<any>` | Emitted when an error occurs. |
| resultLoaded | `EventEmitter<NodePaging>` | Emitted when search results have fully loaded. | | resultLoaded | [`EventEmitter<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts) | Emitted when search results have fully loaded. |
## Details ## Details
@ -130,7 +130,7 @@ However, you can use a more complex template if necessary:
### Attach an input field to the search ### Attach an input field to the search
You can also attach an input field to the search component via the `searchAutocomplete` property. You can also attach an input field to the [search component](../content-services/search.component.md) via the `searchAutocomplete` property.
Export the search panel instance into a local template variable and bind that variable to the 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 input's `searchAutocomplete` property. The example below demonstrates this with an
instance called "search": instance called "search":
@ -159,7 +159,7 @@ You can get finer control over the parameters of a search by defining them in a
[QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) [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 object. The recommended way to do this is with a custom implementation of the
[Search Configuration interface](../core/search-configuration.interface.md) (the `queryBody` parameter of the `Search component` is now deprecated). The ADF source provides a standard implementation of this [Search Configuration interface](../core/search-configuration.interface.md) (the `queryBody` parameter of the `Search component` is now deprecated). The ADF source provides a standard implementation of this
interface, `SearchConfigurationService` that you can use as a base to adapt to your needs. See the 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/search-configuration.interface.md) page for full details of how to
customize your search. customize your search.

View File

@ -12,22 +12,22 @@ Manages tags in Content Services.
### Methods ### Methods
- `addTag(nodeId: string = null, tagName: string = null): any`<br/> - **addTag**(nodeId: `string` = `null`, tagName: `string` = `null`): `any`<br/>
Adds a tag to a node. Adds a tag to a node.
- `nodeId: string = null` - ID of the target node - _nodeId:_ `string` - ID of the target node
- `tagName: string = null` - Name of the tag to add - _tagName:_ `string` - Name of the tag to add
- **Returns** `any` - TagEntry object (defined in JSAPI) with details of the new tag - **Returns** `any` - TagEntry object (defined in JSAPI) with details of the new tag
- `getAllTheTags(): Observable<any>`<br/> - **getAllTheTags**(): `Observable<any>`<br/>
Gets a list of all the tags already defined in the repository. Gets a list of all the tags already defined in the repository.
- **Returns** `Observable<any>` - TagPaging object (defined in JSAPI) containing the tags - **Returns** `Observable<any>` - TagPaging object (defined in JSAPI) containing the tags
- `getTagsByNodeId(nodeId: string = null): any`<br/> - **getTagsByNodeId**(nodeId: `string` = `null`): `any`<br/>
Gets a list of tags added to a node. Gets a list of tags added to a node.
- `nodeId: string = null` - ID of the target node - _nodeId:_ `string` - ID of the target node
- **Returns** `any` - TagPaging object (defined in JSAPI) containing the tags - **Returns** `any` - TagPaging object (defined in JSAPI) containing the tags
- `removeTag(nodeId: string = null, tag: string = null): any`<br/> - **removeTag**(nodeId: `string` = `null`, tag: `string` = `null`): `any`<br/>
Removes a tag from a node. Removes a tag from a node.
- `nodeId: string = null` - ID of the target node - _nodeId:_ `string` - ID of the target node
- `tag: string = null` - Name of the tag to remove - _tag:_ `string` - Name of the tag to remove
- **Returns** `any` - Null object when the operation completes - **Returns** `any` - Null object when the operation completes
## Details ## Details
@ -45,8 +45,8 @@ construct a list like this.
See the See the
[Tags API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagsApi.md) [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 in the Alfresco JS API for more information about the types returned by [Tag
service methods and for the implementation of the REST API the service is service](../content-services/tag.service.md) methods and for the implementation of the REST API the service is
based on. based on.
## See also ## See also

View File

@ -34,12 +34,12 @@ Activates a file upload.
| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | | majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | | maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| multipleFiles | `boolean` | false | Allows/disallows multiple files | | multipleFiles | `boolean` | false | Allows/disallows multiple files |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | | rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| staticTitle | `string` | | Defines the text of the upload button. | | staticTitle | `string` | | Defines the text of the upload button. |
| tooltip | `string` | null | Custom tooltip text. | | tooltip | `string` | null | Custom tooltip text. |
| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). | | uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). |
| versioning | `boolean` | false | Toggles versioning. | | versioning | `boolean` | false | Toggles versioning. |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file. |
### Events ### Events
@ -47,7 +47,7 @@ Activates a file upload.
| -- | -- | -- | | -- | -- | -- |
| createFolder | `EventEmitter<Object>` | Emitted when a folder is created. | | createFolder | `EventEmitter<Object>` | Emitted when a folder is created. |
| error | `EventEmitter<Object>` | Emitted when an error occurs. | | error | `EventEmitter<Object>` | Emitted when an error occurs. |
| permissionEvent | `EventEmitter<PermissionModel>` | Emitted when create permission is missing. | | permissionEvent | [`EventEmitter<PermissionModel>`](../../lib/content-services/document-list/models/permissions.model.ts) | Emitted when create permission is missing. |
| success | `EventEmitter<Object>` | Emitted when the file is uploaded successfully. | | success | `EventEmitter<Object>` | Emitted when the file is uploaded successfully. |
## Details ## Details

View File

@ -40,6 +40,7 @@ export class AppComponent {
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | | disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | | majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | | maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | | rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| versioning | `boolean` | false | Toggles versioning. | | versioning | `boolean` | false | Toggles versioning. |
| parentId | `` | | **Deprecated:** 2.4.0 use rootFolderId ID of parent folder node. | | parentId | `` | | **Deprecated:** 2.4.0 use rootFolderId ID of parent folder node. |

View File

@ -27,7 +27,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 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 properties and events are the same except for the `node` property that specifies the node
to be versioned (this is a _required_ input parameter). However, some properties don't make to be versioned (this is a _required_ input parameter). However, some properties don't make
sense when applied to the Upload Version Button component, so they are simply ignored. sense when applied to the [Upload Version Button component,](../content-services/upload-version-button.component.md) so they are simply ignored.
## Class members ## Class members
@ -36,10 +36,13 @@ sense when applied to the Upload Version Button component, so they are simply ig
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -- | -- | -- | -- | | -- | -- | -- | -- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | | acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | | disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. |
| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | | maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. |
| multipleFiles | `boolean` | false | Allows/disallows multiple files | | multipleFiles | `boolean` | false | Allows/disallows multiple files |
| node | `MinimalNodeEntryEntity` | | (**Required**) The node to be versioned. | | node | `MinimalNodeEntryEntity` | | (**Required**) The node to be versioned. |
| nodeType | `string` | "cm:content" | Custom node type for uploaded file |
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | | rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| staticTitle | `string` | | Defines the text of the upload button. | | staticTitle | `string` | | Defines the text of the upload button. |
| tooltip | `string` | null | Custom tooltip text. | | tooltip | `string` | null | Custom tooltip text. |
@ -52,7 +55,7 @@ sense when applied to the Upload Version Button component, so they are simply ig
| -- | -- | -- | | -- | -- | -- |
| createFolder | `EventEmitter<Object>` | Emitted when a folder is created. | | createFolder | `EventEmitter<Object>` | Emitted when a folder is created. |
| error | `EventEmitter<Object>` | Emitted when an error occurs. | | error | `EventEmitter<Object>` | Emitted when an error occurs. |
| permissionEvent | `EventEmitter<PermissionModel>` | Emitted when delete permission is missing. | | permissionEvent | [`EventEmitter<PermissionModel>`](../../lib/content-services/document-list/models/permissions.model.ts) | Emitted when create permission is missing. |
| success | `EventEmitter<Object>` | Emitted when the file is uploaded successfully. | | success | `EventEmitter<Object>` | Emitted when the file is uploaded successfully. |
## Details ## Details

View File

@ -6,7 +6,7 @@ Last reviewed: 2018-05-08
# Version List component # Version List component
Displays the version history of a node in a Version Manager component. Displays the version history of a node in a [Version Manager component](../content-services/version-manager.component.md).
### Basic Usage ### Basic Usage
@ -20,7 +20,7 @@ Displays the version history of a node in a Version Manager component.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -- | -- | -- | -- | | -- | -- | -- | -- |
| allowDownload | `boolean` | true | Enable/disable possibility to download a version of the current node. | | allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| id | `string` | | **Deprecated:** in 2.3.0 | | id | `string` | | **Deprecated:** in 2.3.0 |
| node | `MinimalNodeEntryEntity` | | The target node. | | node | `MinimalNodeEntryEntity` | | The target node. |
| showActions | `boolean` | true | Toggles showing/hiding of version actions | | showActions | `boolean` | true | Toggles showing/hiding of version actions |
@ -28,7 +28,7 @@ Displays the version history of a node in a Version Manager component.
## Details ## Details
This component is used by the Version Manager component to This component is used by the [Version Manager component](../content-services/version-manager.component.md) to
load and displays the version history of a node. load and displays the version history of a node.
If you want show readonly version list you set this component with showActions false: If you want show readonly version list you set this component with showActions false:
@ -37,7 +37,6 @@ If you want show readonly version list you set this component with showActions f
<adf-version-list [node]="myNode" [showActions]="false" ></adf-version-list> <adf-version-list [node]="myNode" [showActions]="false" ></adf-version-list>
``` ```
## See also ## See also
- [Version manager component](version-manager.component.md) - [Version manager component](version-manager.component.md)

View File

@ -83,7 +83,7 @@ export class AppComponent {
### Webscript View HTML example ### Webscript View HTML example
This sample demonstrates how to implement a Webscript component that renders the HTML contents that come from a webscript 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 Web Scripts reside in your Alfresco Server. You can access the folder webscript here: 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` `http://localhost:8080/alfresco/service/sample/folder/Company%20Home`
@ -102,7 +102,7 @@ This sample Web Scripts reside in your Alfresco Server. You can access the folde
### Webscript View DATATABLE example ### Webscript View DATATABLE example
This sample demonstrates how to implement a Webscript component that renders the JSON contents that come from a webscript This sample demonstrates how to implement a [Webscript component](../content-services/webscript.component.md) that renders the JSON contents that come from a webscript
`http://localhost:8080/alfresco/service/sample/folder/DATATABLE` `http://localhost:8080/alfresco/service/sample/folder/DATATABLE`
@ -159,7 +159,7 @@ that will render the following table
### Webscript View JSON example ### Webscript View JSON example
This sample demonstrates how to implement a Webscript component that renders the JSON contents that come from a webscript 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 Web Scripts reside in your Alfresco Server. You can access the folder webscript here: This sample Web Scripts reside in your Alfresco Server. You can access the folder webscript here:
`http://localhost:8080/alfresco/service/sample/folder/JSON%EXAMPLE` `http://localhost:8080/alfresco/service/sample/folder/JSON%EXAMPLE`

View File

@ -29,6 +29,7 @@ of components organized by ADF libraries.
- [Search chip list component](content-services/search-chip-list.component.md) - [Search chip list component](content-services/search-chip-list.component.md)
- [Search filter component](content-services/search-filter.component.md) - [Search filter component](content-services/search-filter.component.md)
- [Search query builder service](content-services/search-query-builder.service.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) - [Sidenav layout component](core/sidenav-layout.component.md)
- [Upload version button component](content-services/upload-version-button.component.md) - [Upload version button component](content-services/upload-version-button.component.md)
@ -101,6 +102,7 @@ of components organized by ADF libraries.
- [Bpm user model](core/bpm-user.model.md) - [Bpm user model](core/bpm-user.model.md)
- [Bpm user service](core/bpm-user.service.md) - [Bpm user service](core/bpm-user.service.md)
- [Breadcrumb component](content-services/breadcrumb.component.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 update service](core/card-view-update.service.md)
- [Card view component](core/card-view.component.md) - [Card view component](core/card-view.component.md)
- [Checklist component](process-services/checklist.component.md) - [Checklist component](process-services/checklist.component.md)
@ -128,6 +130,7 @@ of components organized by ADF libraries.
- [Dropdown breadcrumb component](content-services/dropdown-breadcrumb.component.md) - [Dropdown breadcrumb component](content-services/dropdown-breadcrumb.component.md)
- [Ecm user model](core/ecm-user.model.md) - [Ecm user model](core/ecm-user.model.md)
- [Ecm user service](core/ecm-user.service.md) - [Ecm user service](core/ecm-user.service.md)
- [Error content component](core/error-content.component.md)
- [Favorites api service](core/favorites-api.service.md) - [Favorites api service](core/favorites-api.service.md)
- [File draggable directive](content-services/file-draggable.directive.md) - [File draggable directive](content-services/file-draggable.directive.md)
- [File size pipe](core/file-size.pipe.md) - [File size pipe](core/file-size.pipe.md)

View File

@ -43,6 +43,7 @@ export class ContentActionComponent implements OnInit, OnChanges {
@Input() @Input()
icon: string; icon: string;
/** Visibility state (see examples). */
@Input() @Input()
visible: boolean | Function = true; visible: boolean | Function = true;

View File

@ -5,6 +5,7 @@
"versionIndex", "versionIndex",
"tutorialIndex", "tutorialIndex",
"tsInfo", "tsInfo",
"typeLinker",
"toc" "toc"
], ],
"index": [ "index": [
@ -14,6 +15,7 @@
], ],
"enhance": [ "enhance": [
"tsInfo", "tsInfo",
"typeLinker",
"toc" "toc"
], ],
"dev": [ "dev": [

View File

@ -5,7 +5,7 @@
| -- | -- | -- | -- | | -- | -- | -- | -- |
<% properties.forEach(function(prop) { -%> <% properties.forEach(function(prop) { -%>
<% if (prop.isInput) { -%> <% if (prop.isInput) { -%>
| <%= prop.name %> | `<%- prop.type %>` | <%= prop.defaultValue %> | <%= prop.docText %> | | <%= prop.name %> | `<%- prop.type %>` | <%- prop.defaultValue %> | <%- prop.docText %> |
<% } -%> <% } -%>
<% }) -%> <% }) -%>
<% } %> <% } %>
@ -15,9 +15,9 @@
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
<% properties.forEach(function(prop) { %> <% properties.forEach(function(prop) { -%>
<% if (prop.isOutput) { %> <% if (prop.isOutput) { -%>
| <%= prop.name %> | `<%- prop.type %>` | <%= prop.docText %> | | <%= prop.name %> | `<%- prop.type %>` | <%- prop.docText %> |
<% } %> <% } -%>
<% }) %> <% }) -%>
<% } %> <% } %>

View File

@ -5,7 +5,7 @@
| -- | -- | -- | -- | | -- | -- | -- | -- |
<% properties.forEach(function(prop) { -%> <% properties.forEach(function(prop) { -%>
<% if (prop.isInput) { -%> <% if (prop.isInput) { -%>
| <%= prop.name %> | `<%- prop.type %>` | <%= prop.defaultValue %> | <%= prop.docText %> | | <%= prop.name %> | `<%- prop.type %>` | <%- prop.defaultValue %> | <%- prop.docText %> |
<% } -%> <% } -%>
<% }) -%> <% }) -%>
<% } %> <% } %>
@ -15,9 +15,9 @@
| Name | Type | Description | | Name | Type | Description |
| -- | -- | -- | | -- | -- | -- |
<% properties.forEach(function(prop) { %> <% properties.forEach(function(prop) { -%>
<% if (prop.isOutput) { %> <% if (prop.isOutput) { -%>
| <%= prop.name %> | `<%- prop.type %>` | <%= prop.docText %> | | <%= prop.name %> | `<%- prop.type %>` | <%- prop.docText %> |
<% } %> <% } -%>
<% }) %> <% }) -%>
<% } %> <% } %>

View File

@ -148,6 +148,8 @@ var ComponentInfo = /** @class */ (function () {
}); });
} }
}); });
this.hasInputs = false;
this.hasOutputs = false;
this.properties.forEach(function (prop) { this.properties.forEach(function (prop) {
if (prop.isInput) if (prop.isInput)
_this.hasInputs = true; _this.hasInputs = true;

View File

@ -230,6 +230,9 @@ class ComponentInfo {
} }
}); });
this.hasInputs = false;
this.hasOutputs = false;
this.properties.forEach(prop => { this.properties.forEach(prop => {
if (prop.isInput) if (prop.isInput)
this.hasInputs = true; this.hasInputs = true;