[ADF-3745] Updated properties and doc comments (#4134)

This commit is contained in:
Andy Stark 2019-01-11 23:33:29 +00:00 committed by Eugenio Romano
parent ebde107f41
commit b32654b236
18 changed files with 242 additions and 155 deletions

View File

@ -67,7 +67,7 @@ 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) | Shows a general version and status overview of the installed ADF library. | [Source](../lib/core/about/about.component.ts) | | [About component](core/about.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows a general version and status overview of the installed ADF library. | [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) | | [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) |
| [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) |
@ -76,10 +76,10 @@ for more information about installing and using the source code.
| [Empty list component](core/empty-list.component.md) | Displays a message indicating that a list is empty. | [Source](../lib/core/datatable/components/datatable/empty-list.component.ts) | | [Empty list component](core/empty-list.component.md) | Displays a message indicating that a list is empty. | [Source](../lib/core/datatable/components/datatable/empty-list.component.ts) |
| [Form field component](core/form-field.component.md) | Represents a UI field in a form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) | | [Form field component](core/form-field.component.md) | Represents a UI field in a form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) |
| [Form list component](core/form-list.component.md) | Shows forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | | [Form list component](core/form-list.component.md) | Shows forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) |
| [Form component](core/form.component.md) | Shows a [Form](../../lib/process-services/task-list/models/form.model.ts) from APS | [Source](../lib/core/form/components/form.component.ts) | | [Form component](core/form.component.md) | Shows a Form from APS | [Source](../lib/core/form/components/form.component.ts) |
| [Start form component](core/start-form.component.md) | Displays the Start [Form](../../lib/process-services/task-list/models/form.model.ts) for a process. | [Source](../lib/core/form/components/start-form.component.ts) | | [Start form component](core/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/core/form/components/start-form.component.ts) |
| [Text mask component](core/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) | | [Text mask component](core/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) |
| [Icon component](core/icon.component.md) | Provides universal way of rendering registered and named icons. | [Source](../lib/core/icon/icon.component.ts) | | [Icon component](core/icon.component.md) | Provides a universal way of rendering registered and named icons. | [Source](../lib/core/icon/icon.component.ts) |
| [Info drawer layout component](core/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | | [Info drawer layout component](core/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) |
| [Info drawer component](core/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | | [Info drawer component](core/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) |
| [Language menu component](core/language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) | | [Language menu component](core/language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) |
@ -96,7 +96,7 @@ for more information about installing and using the source code.
| [Empty content component](core/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../lib/core/templates/empty-content/empty-content.component.ts) | | [Empty content component](core/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [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) | | [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](../core/toolbar.component.md) 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) |
| [User info component](core/user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) | | [User info component](core/user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) |
| [Viewer component](core/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) | | [Viewer component](core/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) |
@ -119,7 +119,7 @@ for more information about installing and using the source code.
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Form field model](core/form-field.model.md) | Contains the value and metadata for a field of a [Form](../../lib/process-services/task-list/models/form.model.ts) component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | | [Form field model](core/form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) |
| [Product version model](core/product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) | | [Product version model](core/product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) |
| [User process model](core/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) | | [User process model](core/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) |
| [Bpm user model](core/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/userinfo/models/bpm-user.model.ts) | | [Bpm user model](core/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/userinfo/models/bpm-user.model.ts) |
@ -131,23 +131,23 @@ for more information about installing and using the source code.
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [File size pipe](core/file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../lib/core/pipes/file-size.pipe.ts) | | [File size pipe](core/file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../lib/core/pipes/file-size.pipe.ts) |
| [Format space pipe](core/format-space.pipe.md) | Replaces all the white space in a string with a supplied character. | [Source](../lib/core/pipes/format-space.pipe.ts) | | [Format space pipe](core/format-space.pipe.md) | Replaces all the white space in a string with a supplied character. | [Source](../lib/core/pipes/format-space.pipe.ts) |
| [Full name pipe](core/full-name.pipe.md) | Joins the first and last name properties from a [UserProcessModel](../core/user-process.model.md) object into a single string. | [Source](../lib/core/pipes/full-name.pipe.ts) | | [Full name pipe](core/full-name.pipe.md) | Joins the first and last name properties from a UserProcessModel object into a single string. | [Source](../lib/core/pipes/full-name.pipe.ts) |
| [Mime type icon pipe](core/mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) | | [Mime type icon pipe](core/mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) |
| [Node name tooltip pipe](core/node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) | | [Node name tooltip pipe](core/node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) |
| [Text highlight pipe](core/text-highlight.pipe.md) | Adds highlighting to words or sections of text that match a search string. | [Source](../lib/core/pipes/text-highlight.pipe.ts) | | [Text highlight pipe](core/text-highlight.pipe.md) | Adds highlighting to words or sections of text that match a search string. | [Source](../lib/core/pipes/text-highlight.pipe.ts) |
| [Time ago pipe](core/time-ago.pipe.md) | Converts a recent past date into a number of days ago. | [Source](../lib/core/pipes/time-ago.pipe.ts) | | [Time ago pipe](core/time-ago.pipe.md) | Converts a recent past date into a number of days ago. | [Source](../lib/core/pipes/time-ago.pipe.ts) |
| [User initial pipe](core/user-initial.pipe.md) | Takes the name fields of a [UserProcessModel](../core/user-process.model.md) object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | | [User initial pipe](core/user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) |
## Services ## Services
| 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](../core/card-view.component.md). | [Source](../lib/core/card-view/services/card-item-types.service.ts) | | [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](../core/card-view.component.md). | [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 a form field type string onto the corresponding form [widget](../../e2e/pages/adf/process-services/widgets/widget.ts) component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | | [Form rendering service](core/form-rendering.service.md) | Maps a form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) |
| [Form service](core/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | | [Form service](core/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) |
| [Node service](core/node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../lib/core/form/services/node.service.ts) | | [Node service](core/node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../lib/core/form/services/node.service.ts) |
| [Process content service](core/process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../lib/core/form/services/process-content.service.ts) | | [Process content service](core/process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../lib/core/form/services/process-content.service.ts) |
| [Alfresco api service](core/alfresco-api.service.md) | Provides access to an initialized **AlfrescoJSApi** instance. | [Source](../lib/core/services/alfresco-api.service.ts) | | [Alfresco api service](core/alfresco-api.service.md) | Provides access to an initialized **AlfrescoJSApi** instance. | [Source](../lib/core/services/alfresco-api.service.ts) |
| [Apps process service](core/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) | | [Apps process service](core/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) |
@ -170,7 +170,7 @@ for more information about installing and using the source code.
| [Nodes api service](core/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) | | [Nodes api service](core/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) |
| [Notification service](core/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/services/notification.service.ts) | | [Notification service](core/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/services/notification.service.ts) |
| [Page title service](core/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | | [Page title service](core/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) |
| [People content service](core/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | | [People content service](core/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) |
| [People process service](core/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) | | [People process service](core/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) |
| [Renditions service](core/renditions.service.md) ![Deprecated](docassets/images/DeprecatedIcon.png) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) | | [Renditions service](core/renditions.service.md) ![Deprecated](docassets/images/DeprecatedIcon.png) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) |
| [Search configuration service](core/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | | [Search configuration service](core/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) |
@ -185,7 +185,6 @@ for more information about installing and using the source code.
| [Bpm user service](core/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/userinfo/services/bpm-user.service.ts) | | [Bpm user service](core/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/userinfo/services/bpm-user.service.ts) |
| [Ecm user service](core/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/userinfo/services/ecm-user.service.ts) | | [Ecm user service](core/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/userinfo/services/ecm-user.service.ts) |
| [Identity user service](core/identity-user.service.md) | Gets OAuth2 personal details and roles for users. | [Source](../lib/core/userinfo/services/identity-user.service.ts) | | [Identity user service](core/identity-user.service.md) | Gets OAuth2 personal details and roles for users. | [Source](../lib/core/userinfo/services/identity-user.service.ts) |
actions/APS-cloud/identity.ts) user service_ | _Not currently documented_ | [Source](../lib/core/userinfo/services/identity-user.service.ts) |
## Widgets ## Widgets
@ -200,7 +199,7 @@ actions/APS-cloud/identity.ts) user service_ | _Not currently documented_ | [Sou
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Data Table Adapter interface](core/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | | [Data Table Adapter interface](core/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) |
| [Form Field Validator interface](core/form-field-validator.interface.md) | Defines how the input fields of [`Form`](../../lib/process-services/task-list/models/form.model.ts) and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | | [Form Field Validator interface](core/form-field-validator.interface.md) | Defines how the input fields of [`Form`](../../process-services/task-list/models/form.model.ts) and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) |
| [Search Configuration interface](core/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | | [Search Configuration interface](core/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) |
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
@ -230,17 +229,17 @@ for more information about installing and using the source code.
| [Add permission panel component](content-services/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts) | | [Add permission panel component](content-services/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts) |
| [Add permission component](content-services/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts) | | [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 check list component](content-services/search-check-list.component.md) | Implements a checklist [widget](../../e2e/pages/adf/process-services/widgets/widget.ts) for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-check-list/search-check-list.component.ts) | | [Search check list component](content-services/search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-check-list/search-check-list.component.ts) |
| [Search chip list component](content-services/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts) | | [Search chip list component](content-services/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts) |
| [Search control component](content-services/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.component.ts) | | [Search control component](content-services/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.component.ts) |
| [Search date range component](content-services/search-date-range.component.md) | Implements a date range [widget](../../e2e/pages/adf/process-services/widgets/widget.ts) for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-date-range/search-date-range.component.ts) | | [Search date range component](content-services/search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-date-range/search-date-range.component.ts) |
| [Search filter component](content-services/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/search/components/search-filter/search-filter.component.ts) | | [Search filter component](content-services/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/search/components/search-filter/search-filter.component.ts) |
| [Search number range component](content-services/search-number-range.component.md) | Implements a number range [widget](../../e2e/pages/adf/process-services/widgets/widget.ts) for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-number-range/search-number-range.component.ts) | | [Search number range component](content-services/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-number-range/search-number-range.component.ts) |
| [Search radio component](content-services/search-radio.component.md) | Implements a radio button list [widget](../../e2e/pages/adf/process-services/widgets/widget.ts) for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-radio/search-radio.component.ts) | | [Search radio component](content-services/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-radio/search-radio.component.ts) |
| [Search slider component](content-services/search-slider.component.md) | Implements a numeric slider [widget](../../e2e/pages/adf/process-services/widgets/widget.ts) for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-slider/search-slider.component.ts) | | [Search slider component](content-services/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-slider/search-slider.component.ts) |
| [Search sorting picker component](content-services/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts) | | [Search sorting picker component](content-services/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts) |
| [Search text component](content-services/search-text.component.md) | Implements a text input [widget](../../e2e/pages/adf/process-services/widgets/widget.ts) for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-text/search-text.component.ts) | | [Search text component](content-services/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-text/search-text.component.ts) |
| [Search component](content-services/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.component.ts) | | [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) |
| [Rating component](content-services/rating.component.md) | Allows a user to add ratings to an item. | [Source](../lib/content-services/social/rating.component.ts) | | [Rating component](content-services/rating.component.md) | Allows a user to add ratings to an item. | [Source](../lib/content-services/social/rating.component.ts) |
@ -252,14 +251,9 @@ 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](../content-services/version-manager.component.md). | [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. | [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) |
| _[Library name column component](../../lib/content-services/document-list/components/library-name-column/library-name-column.component.ts)_ | _Not currently documented_ | [Source](../lib/content-services/document-list/components/library-name-column/library-name-column.component.ts) |
| _[Library role column component](../../lib/content-services/document-list/components/library-role-column/library-role-column.component.ts)_ | _Not currently documented_ | [Source](../lib/content-services/document-list/components/library-role-column/library-role-column.component.ts) |
| _[Library status column component](../../lib/content-services/document-list/components/library-status-column/library-status-column.component.ts)_ | _Not currently documented_ | [Source](../lib/content-services/document-list/components/library-status-column/library-status-column.component.ts) |
| _[Name column component](../../lib/content-services/document-list/components/name-column/name-column.component.ts)_ | _Not currently documented_ | [Source](../lib/content-services/document-list/components/name-column/name-column.component.ts) |
| _[Trashcan name column component](../../lib/content-services/document-list/components/trashcan-name-column/trashcan-name-column.component.ts)_ | _Not currently documented_ | [Source](../lib/content-services/document-list/components/trashcan-name-column/trashcan-name-column.component.ts) |
## Dialogs ## Dialogs
@ -291,12 +285,12 @@ 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](../content-services/document-list.component.md). | [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. | [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](../content-services/document-list.component.md). | [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. | [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](../content-services/document-list.component.md). | [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. | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) |
| [Node permission dialog service](content-services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/permission-manager/services/node-permission-dialog.service.ts) | | [Node permission dialog service](content-services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/permission-manager/services/node-permission-dialog.service.ts) |
| [Node permission service](content-services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/permission-manager/services/node-permission.service.ts) | | [Node permission service](content-services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/permission-manager/services/node-permission.service.ts) |
| [Search filter service](content-services/search-filter.service.md) | Registers widgets for use with the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-filter/search-filter.service.ts) | | [Search filter service](content-services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/search/components/search-filter/search-filter.service.ts) |
| [Search query builder service](content-services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/search/search-query-builder.service.ts) | | [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) |
@ -359,9 +353,9 @@ for more information about installing and using the source code.
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Process filter service](process-services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/process-list/services/process-filter.service.ts) | | [Process filter service](process-services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/process-list/services/process-filter.service.ts) |
| [Process service](process-services/process.service.md) | Manages Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) | | [Process service](process-services/process.service.md) | Manages Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) |
| [Task filter service](process-services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) | | [Task filter service](process-services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) |
| [Tasklist service](process-services/tasklist.service.md) | Manages Task Instances. | [Source](../lib/process-services/task-list/services/tasklist.service.ts) | | [Tasklist service](process-services/tasklist.service.md) | Manages Task Instances. | [Source](../lib/process-services/task-list/services/tasklist.service.ts) |
<!--process-services end--> <!--process-services end-->
@ -390,20 +384,20 @@ for more information about installing and using the source code.
| [Edit task filter cloud component](process-services-cloud/edit-task-filter-cloud.component.md) | Edits Task Filter Details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) | | [Edit task filter cloud component](process-services-cloud/edit-task-filter-cloud.component.md) | Edits Task Filter Details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) |
| [Task filters cloud component](process-services-cloud/task-filters-cloud.component.md) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | | [Task filters cloud component](process-services-cloud/task-filters-cloud.component.md) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) |
| [Task list cloud component](process-services-cloud/task-list-cloud.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | | [Task list cloud component](process-services-cloud/task-list-cloud.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) |
| _[App details cloud component](../../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.ts) | | _App details cloud component_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.ts) |
| _[People cloud component](../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) | | _People cloud component_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) |
## Services ## Services
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Process filter cloud service](process-services-cloud/process-filter-cloud.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) | | [Process filter cloud service](process-services-cloud/process-filter-cloud.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) |
| [Start process cloud service](process-services-cloud/start-process-cloud.service.md) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | | [Process list cloud service](process-services-cloud/process-list-cloud.service.md) | Manages Process lists. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
| [Start task cloud service](process-services-cloud/start-task-cloud.service.md) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) | | [Start process cloud service](process-services-cloud/start-process-cloud.service.md) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
| [Task filter cloud service](process-services-cloud/task-filter-cloud.service.md) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) | | [Start task cloud service](process-services-cloud/start-task-cloud.service.md) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
| _[Apps process cloud service](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | | [Task filter cloud service](process-services-cloud/task-filter-cloud.service.md) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
| _[Process list cloud service](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts)_ | _Not curently documented_ | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | | _Apps process cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) |
| _[Task list cloud service](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | | _Task list cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
<!--process-services-cloud end--> <!--process-services-cloud end-->
@ -424,7 +418,6 @@ for more information about installing and using the source code.
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Dynamic component](extensions/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | | [Dynamic component](extensions/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) |
| [Dynamic tab component](extensions/dynamic-tab.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extensions with tabs. | [Source](../lib/extensions/src/lib/components/dynamic-tab/dynamic-tab.component.ts) | | [Dynamic tab component](extensions/dynamic-tab.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extensions with tabs. | [Source](../lib/extensions/src/lib/components/dynamic-tab/dynamic-tab.component.ts) |
| _[Dynamic column component](../../lib/extensions/src/lib/components/dynamic-column/dynamic-column.component.ts)_ | _Not currently documented_ | [Source](../lib/extensions/src/lib/components/dynamic-column/dynamic-column.component.ts) |
## Services ## Services
@ -449,7 +442,7 @@ for more information about installing and using the source code.
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Widget component](insights/widget.component.md) | Base class for standard and custom [widget](../../e2e/pages/adf/process-services/widgets/widget.ts) classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) | | [Widget component](insights/widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) |
| [Analytics generator component](insights/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/analytics-process/components/analytics-generator.component.ts) | | [Analytics generator component](insights/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/analytics-process/components/analytics-generator.component.ts) |
| [Analytics report list component](insights/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/analytics-process/components/analytics-report-list.component.ts) | | [Analytics report list component](insights/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/analytics-process/components/analytics-report-list.component.ts) |
| [Analytics component](insights/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/analytics-process/components/analytics.component.ts) | | [Analytics component](insights/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/analytics-process/components/analytics.component.ts) |

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13 Last reviewed: 2018-11-13
--- ---
# [Document Actions service](../../lib/content-services/document-list/services/document-actions.service.ts "Defined in document-actions.service.ts") # [Document Actions service](../../content-services/document-list/services/document-actions.service.ts "Defined in document-actions.service.ts")
Implements the document menu actions for the [Document List component](../content-services/document-list.component.md). Implements the document menu actions for the [Document List component](../content-services/document-list.component.md).
@ -13,9 +13,9 @@ Implements the document menu actions for the [Document List component](../conten
### Methods ### Methods
- **canExecuteAction**(obj: `any`): `boolean`<br/> - **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/>
Checks if actions can be executed for an item. Checks if actions can be executed for an item.
- _obj:_ `any` - Item to receive an action - _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to receive an action
- **Returns** `boolean` - True if the action can be executed on this item, false otherwise - **Returns** `boolean` - True if the action can be executed on this item, false otherwise
- **getHandler**(key: `string`): `ContentActionHandler`<br/> - **getHandler**(key: `string`): `ContentActionHandler`<br/>
Gets the handler for an action. Gets the handler for an action.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-12 Last reviewed: 2018-06-12
--- ---
# [Search Query Builder service](../../lib/content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts") # [Search Query Builder service](../../content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts")
Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. Stores information from all the custom search and faceted search widgets, compiles and runs the final search query.
@ -14,58 +14,52 @@ Stores information from all the custom search and faceted search widgets, compil
### Methods ### Methods
- **addFilterQuery**(query: `string`)<br/> - **addFilterQuery**(query: `string`)<br/>
Adds a filter query to the current query.
- _query:_ `string` - - _query:_ `string` - Query string to add
- **addUserFacetBucket**(field: [`FacetField`](../../content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts))<br/>
- **addUserFacetBucket**(field: `FacetField`, bucket: `FacetFieldBucket`)<br/> Adds a facet bucket to a field.
- _field:_ [`FacetField`](../../content-services/search/facet-field.interface.ts) - The target field
- _field:_ `FacetField` - - _bucket:_ [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts) - Bucket to add
- _bucket:_ `FacetFieldBucket` - - **addUserFacetQuery**(query: [`FacetQuery`](../../content-services/search/facet-query.interface.ts))<br/>
Adds a facet query.
- **addUserFacetQuery**(query: `FacetQuery`)<br/> - _query:_ [`FacetQuery`](../../content-services/search/facet-query.interface.ts) - Query to add
- _query:_ `FacetQuery` -
- **buildQuery**(): `QueryBody`<br/> - **buildQuery**(): `QueryBody`<br/>
Builds the current query.
- **Returns** `QueryBody` - - **Returns** `QueryBody` - The finished query
- **execute**()<br/>
- **execute**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<void>`<br/> Builds and executes the current query.
- **getFacetField**(label: `string`): [`FacetField`](../../content-services/search/facet-field.interface.ts)<br/>
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<void>` - Gets a facet field by label.
- _label:_ `string` - Label of the facet field
- **getFacetField**(label: `string`): `FacetField`<br/> - **Returns** [`FacetField`](../../content-services/search/facet-field.interface.ts) - Facet field data
- **getFacetQuery**(label: `string`): [`FacetQuery`](../../content-services/search/facet-query.interface.ts)<br/>
- _label:_ `string` - Gets a facet query by label.
- **Returns** `FacetField` - - _label:_ `string` - Label of the query
- **Returns** [`FacetQuery`](../../content-services/search/facet-query.interface.ts) - Facet query data
- **getFacetQuery**(label: `string`): `FacetQuery`<br/> - **getPrimarySorting**(): [`SearchSortingDefinition`](../../content-services/search/search-sorting-definition.interface.ts)<br/>
Gets the primary sorting definition.
- _label:_ `string` - - **Returns** [`SearchSortingDefinition`](../../content-services/search/search-sorting-definition.interface.ts) - The primary sorting definition
- **Returns** `FacetQuery` - - **getSortingOptions**(): [`SearchSortingDefinition`](../../content-services/search/search-sorting-definition.interface.ts)`[]`<br/>
Gets all pre-configured sorting options that users can choose from.
- **getPrimarySorting**(): `SearchSortingDefinition`<br/> - **Returns** [`SearchSortingDefinition`](../../content-services/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
Returns primary sorting definition. - **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts)`[]`<br/>
- **Returns** `SearchSortingDefinition` - Gets the buckets currently added to a field
- **getSortingOptions**(): `SearchSortingDefinition[]`<br/> - _field:_ `string` - The target fields
Returns all pre-configured sorting options that users can choose from. - **Returns** [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts)`[]` - Bucket array
- **Returns** `SearchSortingDefinition[]` -
- **removeFilterQuery**(query: `string`)<br/> - **removeFilterQuery**(query: `string`)<br/>
Removes an existing filter query.
- _query:_ `string` - - _query:_ `string` - The query to remove
- **removeUserFacetBucket**(field: [`FacetField`](../../content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts))<br/>
- **removeUserFacetBucket**(field: `FacetField`, bucket: `FacetFieldBucket`)<br/> Removes an existing bucket from a field.
- _field:_ [`FacetField`](../../content-services/search/facet-field.interface.ts) - The target field
- _field:_ `FacetField` - - _bucket:_ [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts) - Bucket to remove
- _bucket:_ `FacetFieldBucket` - - **removeUserFacetQuery**(query: [`FacetQuery`](../../content-services/search/facet-query.interface.ts))<br/>
Removes an existing facet query.
- **removeUserFacetQuery**(query: `FacetQuery`)<br/> - _query:_ [`FacetQuery`](../../content-services/search/facet-query.interface.ts) - Query to remove
- _query:_ `FacetQuery` -
- **resetToDefaults**()<br/> - **resetToDefaults**()<br/>
Resets the query to the defaults specified in the app config.
- **update**()<br/> - **update**()<br/>
Builds the current query and triggers the `updated` event.
## Details ## Details

View File

@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active Status: Active
--- ---
# [APS Content Component](../../lib/core/form/components/widgets/content/content.widget.ts "Defined in content.widget.ts") # [APS Content Component](../../core/form/components/widgets/content/content.widget.ts "Defined in content.widget.ts")
Shows the content preview. Shows the content preview.
@ -16,16 +16,20 @@ Shows the content preview.
</adf-content> </adf-content>
``` ```
## Class members
### Properties ### Properties
The recommended set of properties can be found in the following table: | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| Name | Type | Default | Description | | id | `string` | | The content id to show. |
| ---- | ---- | ------- | ----------- | | showDocumentContent | `boolean` | true | Toggles showing document content. |
| contentId | string | | The content id to show. |
### Events ### Events
| Name | Description | | Name | Type | Description |
| ---- | ----------- | | ---- | ---- | ----------- |
| contentClick | Invoked when the content is clicked. | | contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the content is clicked. |
| contentLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the content has loaded. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| thumbnailLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the thumbnail has loaded. |

View File

@ -1,13 +1,13 @@
# [Icon Component](../../lib/core/icon/icon.component.ts "Defined in icon.component.ts") ---
Title: Icon Component
Added: v3.0.0
Status: Active
Last reviewed: 2019-01-10
---
Provides universal way of rendering registered and named icons. # [Icon Component](../../core/icon/icon.component.ts "Defined in icon.component.ts")
## Contents Provides a universal way of rendering registered and named icons.
- [Basic usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Named icons](#named-icons)
## Basic usage ## Basic usage
@ -28,14 +28,14 @@ Provides universal way of rendering registered and named icons.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| value | `string` | | Icon value, can be either ligature name or custom icon in the format `[namespace]:[name]` | | value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. |
## Named icons ## Details
You can register custom SVG files as named icons in the format `[namespace]:[name]`. You can register custom SVG files as named icons in the format `[namespace]:[name]`.
Example below shows how to register a new icon named `adf:move_file` The example below shows how to register a new icon named `adf:move_file`
that points to an external file within the `assets` folder. that points to an external file within the `assets` folder:
```ts ```ts
import { Component, OnInit } from '@angular/core'; import { Component, OnInit } from '@angular/core';
@ -62,16 +62,20 @@ export class AppComponent implements OnInit {
} }
``` ```
In the HTML you can now use it like in the following snippet: In the HTML, you can now use the icon as shown below:
```html ```html
<adf-icon value="adf:move_file"></adf-icon> <adf-icon value="adf:move_file"></adf-icon>
``` ```
## Thumbnail Service ### Thumbnail Service
You can also use icons registered with the ADF [ThumbnailService](thumbnail.service.md) You can also use icons registered with the [Thumbnail Service](thumbnail.service.md):
```html ```html
<adf-icon value="image/gif"></adf-icon> <adf-icon value="image/gif"></adf-icon>
``` ```
## See also
- [Thumbnail service](../core/thumbnail.service.md)

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-07 Last reviewed: 2018-06-07
--- ---
# [Translation service](../../lib/core/services/translation.service.ts "Defined in translation.service.ts") # [Translation service](../../core/services/translation.service.ts "Defined in translation.service.ts")
Supports localisation. Supports localisation.
@ -28,10 +28,9 @@ Supports localisation.
- _interpolateParams:_ `Object` - (Optional) String(s) to be interpolated into the main message - _interpolateParams:_ `Object` - (Optional) String(s) to be interpolated into the main message
- **Returns** `string|any` - Translated text - **Returns** `string|any` - Translated text
- **loadTranslation**(lang: `string`, fallback?: `string`)<br/> - **loadTranslation**(lang: `string`, fallback?: `string`)<br/>
Loads a translation file.
- _lang:_ `string` - - _lang:_ `string` - Language code for the language to load
- _fallback:_ `string` - (Optional) (Optional) - _fallback:_ `string` - (Optional) Language code to fall back to if the first one was unavailable
- **onTranslationChanged**(lang: `string`)<br/> - **onTranslationChanged**(lang: `string`)<br/>
Triggers a notification callback when the translation language changes. Triggers a notification callback when the translation language changes.
- _lang:_ `string` - The new language code - _lang:_ `string` - The new language code

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-03-20 Last reviewed: 2018-03-20
--- ---
# [Process Service](../../lib/process-services/process-list/services/process.service.ts "Defined in process.service.ts") # [Process Service](../../process-services/process-list/services/process.service.ts "Defined in process.service.ts")
Manages Process Instances, Process Variables, and Process Audit Log. Manages Process Instances, Process Variables, and Process Audit Log.
@ -17,11 +17,11 @@ Manages Process Instances, Process Variables, and Process Audit Log.
Cancels a process instance. Cancels a process instance.
- _processInstanceId:_ `string` - ID of process to cancel - _processInstanceId:_ `string` - ID of process to cancel
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - Null response notifying when the operation is complete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - Null response notifying when the operation is complete
- **createOrUpdateProcessInstanceVariables**(processInstanceId: `string`, variables: [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`<br/> - **createOrUpdateProcessInstanceVariables**(processInstanceId: `string`, variables: `RestVariable[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]>`<br/>
Creates or updates variables for a process instance. Creates or updates variables for a process instance.
- _processInstanceId:_ `string` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
- _variables:_ [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` - Variables to update - _variables:_ `RestVariable[]` - Variables to update
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info
- **deleteProcessInstanceVariable**(processInstanceId: `string`, variableName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/> - **deleteProcessInstanceVariable**(processInstanceId: `string`, variableName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
Deletes a variable for a process instance. Deletes a variable for a process instance.
- _processInstanceId:_ `string` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
@ -35,36 +35,41 @@ Manages Process Instances, Process Variables, and Process Audit Log.
Fetches the Process Audit information as a PDF. Fetches the Process Audit information as a PDF.
- _processId:_ `string` - ID of the target process - _processId:_ `string` - ID of the target process
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data
- **getProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`<br/> - **getProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts)`>`<br/>
Gets Process Instance metadata. Gets Process Instance metadata.
- _processInstanceId:_ `string` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` - Metadata for the instance - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts)`>` - Metadata for the instance
- **getProcessDefinitions**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>`<br/> - **getProcessDefinitions**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../process-services/process-list/models/process-definition.model.ts)`[]>`<br/>
Gets process definitions associated with an app. Gets process definitions associated with an app.
- _appId:_ `number` - (Optional) ID of a target app - _appId:_ `number` - (Optional) ID of a target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>` - Array of process definitions - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../process-services/process-list/models/process-definition.model.ts)`[]>` - Array of process definitions
- **getProcessInstanceVariables**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`<br/> - **getProcessInstanceVariables**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]>`<br/>
Gets the variables for a process instance. Gets the variables for a process instance.
- _processInstanceId:_ `string` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info
- **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<ProcessListModel>`<br/> - **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../process-services/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../process-services/process-list/models/process-list.model.ts)`>`<br/>
Gets process instances for a filter and optionally a process definition. Gets process instances for a filter and optionally a process definition.
- _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - Filter for instances - _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../process-services/process-list/models/filter-process.model.ts) - Filter for instances
- _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition - _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<ProcessListModel>` - List of process instances - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../process-services/process-list/models/process-list.model.ts)`>` - List of process instances
- **getProcessTasks**(processInstanceId: `string`, state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../lib/process-services/task-list/models/task-details.model.ts)`[]>`<br/> - **getProcessTasks**(processInstanceId: `string`, state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../process-services/task-list/models/task-details.model.ts)`[]>`<br/>
Gets task instances for a process instance. Gets task instances for a process instance.
- _processInstanceId:_ `string` - ID of the process instance - _processInstanceId:_ `string` - ID of the process instance
- _state:_ `string` - (Optional) Task state filter (can be "active" or "completed") - _state:_ `string` - (Optional) Task state filter (can be "active" or "completed")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../lib/process-services/task-list/models/task-details.model.ts)`[]>` - Array of task instance details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../process-services/task-list/models/task-details.model.ts)`[]>` - Array of task instance details
- **startProcess**(processDefinitionId: `string`, name: `string`, outcome?: `string`, startFormValues?: `FormValues`, variables?: [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`<br/> - **getProcesses**(requestNode: [`ProcessFilterParamRepresentationModel`](../../process-services/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../process-services/process-list/models/process-list.model.ts)`>`<br/>
Gets processes for a filter and optionally a process definition.
- _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../process-services/process-list/models/filter-process.model.ts) - Filter for instances
- _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../process-services/process-list/models/process-list.model.ts)`>` - List of processes
- **startProcess**(processDefinitionId: `string`, name: `string`, outcome?: `string`, startFormValues?: [`FormValues`](../../core/form/components/widgets/core/form-values.ts), variables?: [`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts)`>`<br/>
Starts a process based on a process definition, name, form values or variables. Starts a process based on a process definition, name, form values or variables.
- _processDefinitionId:_ `string` - Process definition ID - _processDefinitionId:_ `string` - Process definition ID
- _name:_ `string` - Process name - _name:_ `string` - Process name
- _outcome:_ `string` - (Optional) Process outcome - _outcome:_ `string` - (Optional) Process outcome
- _startFormValues:_ `FormValues` - (Optional) Values for the start form - _startFormValues:_ [`FormValues`](../../core/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form
- _variables:_ [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` - (Optional) Array of process instance variables - _variables:_ [`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]` - (Optional) Array of process instance variables
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` - Details of the process instance just started - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts)`>` - Details of the process instance just started
## Details ## Details
@ -108,7 +113,7 @@ this.processService.startProcess(processDefinitionId, name, outcome, startFormVa
}); });
``` ```
A [`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts) object is returned for a successfully started process. This implements the A [`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts) object is returned for a successfully started process. This implements the
[ProcessInstanceRepresentation interface](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProcessInstanceRepresentation.md). [ProcessInstanceRepresentation interface](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProcessInstanceRepresentation.md).
You can start the process with process variables instead of form field values using You can start the process with process variables instead of form field values using

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13 Last reviewed: 2018-11-13
--- ---
# [Start Task Component](../../lib/process-services/task-list/components/start-task.component.ts "Defined in start-task.component.ts") # [Start Task Component](../../process-services/task-list/components/start-task.component.ts "Defined in start-task.component.ts")
Creates/Starts a new task for the specified app Creates/Starts a new task for the specified app
@ -27,7 +27,7 @@ Creates/Starts a new task for the specified app
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| appId | `number` | | (required) The id of the app. | | appId | `number` | | (required) The id of the app. |
| name | `string` | | Default Task Name | | name | `string` | "" | Default Task Name. |
### Events ### Events

View File

@ -331,6 +331,12 @@ export class CustomResourcesService {
return of([]); return of([]);
} }
/**
* Chooses the correct ID for a node entry.
* @param node Node object
* @param nodeId ID of the node object
* @returns ID value
*/
getIdFromEntry(node: any, nodeId: string): string { getIdFromEntry(node: any, nodeId: string): string {
if (nodeId === '-sharedlinks-') { if (nodeId === '-sharedlinks-') {
return node.entry.nodeId; return node.entry.nodeId;

View File

@ -74,7 +74,7 @@ export class DocumentActionsService {
/** /**
* Checks if actions can be executed for an item. * Checks if actions can be executed for an item.
* @param obj Item to receive an action * @param nodeEntry Item to receive an action
* @returns True if the action can be executed on this item, false otherwise * @returns True if the action can be executed on this item, false otherwise
*/ */
canExecuteAction(nodeEntry: NodeEntry): boolean { canExecuteAction(nodeEntry: NodeEntry): boolean {

View File

@ -71,6 +71,9 @@ export class SearchQueryBuilderService {
this.resetToDefaults(); this.resetToDefaults();
} }
/**
* Resets the query to the defaults specified in the app config.
*/
resetToDefaults() { resetToDefaults() {
const template = this.appConfig.get<SearchConfiguration>('search'); const template = this.appConfig.get<SearchConfiguration>('search');
if (template) { if (template) {
@ -85,6 +88,10 @@ export class SearchQueryBuilderService {
} }
} }
/**
* Adds a facet query.
* @param query Query to add
*/
addUserFacetQuery(query: FacetQuery) { addUserFacetQuery(query: FacetQuery) {
if (query) { if (query) {
const existing = this.userFacetQueries.find((facetQuery) => facetQuery.label === query.label); const existing = this.userFacetQueries.find((facetQuery) => facetQuery.label === query.label);
@ -96,6 +103,10 @@ export class SearchQueryBuilderService {
} }
} }
/**
* Removes an existing facet query.
* @param query Query to remove
*/
removeUserFacetQuery(query: FacetQuery) { removeUserFacetQuery(query: FacetQuery) {
if (query) { if (query) {
this.userFacetQueries = this.userFacetQueries this.userFacetQueries = this.userFacetQueries
@ -103,6 +114,11 @@ export class SearchQueryBuilderService {
} }
} }
/**
* Adds a facet bucket to a field.
* @param field The target field
* @param bucket Bucket to add
*/
addUserFacetBucket(field: FacetField, bucket: FacetFieldBucket) { addUserFacetBucket(field: FacetField, bucket: FacetFieldBucket) {
if (field && field.field && bucket) { if (field && field.field && bucket) {
const buckets = this.userFacetBuckets[field.field] || []; const buckets = this.userFacetBuckets[field.field] || [];
@ -114,10 +130,20 @@ export class SearchQueryBuilderService {
} }
} }
/**
* Gets the buckets currently added to a field
* @param field The target fields
* @returns Bucket array
*/
getUserFacetBuckets(field: string) { getUserFacetBuckets(field: string) {
return this.userFacetBuckets[field] || []; return this.userFacetBuckets[field] || [];
} }
/**
* Removes an existing bucket from a field.
* @param field The target field
* @param bucket Bucket to remove
*/
removeUserFacetBucket(field: FacetField, bucket: FacetFieldBucket) { removeUserFacetBucket(field: FacetField, bucket: FacetFieldBucket) {
if (field && field.field && bucket) { if (field && field.field && bucket) {
const buckets = this.userFacetBuckets[field.field] || []; const buckets = this.userFacetBuckets[field.field] || [];
@ -126,6 +152,10 @@ export class SearchQueryBuilderService {
} }
} }
/**
* Adds a filter query to the current query.
* @param query Query string to add
*/
addFilterQuery(query: string): void { addFilterQuery(query: string): void {
if (query) { if (query) {
const existing = this.filterQueries.find((filterQuery) => filterQuery.query === query); const existing = this.filterQueries.find((filterQuery) => filterQuery.query === query);
@ -135,6 +165,10 @@ export class SearchQueryBuilderService {
} }
} }
/**
* Removes an existing filter query.
* @param query The query to remove
*/
removeFilterQuery(query: string): void { removeFilterQuery(query: string): void {
if (query) { if (query) {
this.filterQueries = this.filterQueries this.filterQueries = this.filterQueries
@ -142,6 +176,11 @@ export class SearchQueryBuilderService {
} }
} }
/**
* Gets a facet query by label.
* @param label Label of the query
* @returns Facet query data
*/
getFacetQuery(label: string): FacetQuery { getFacetQuery(label: string): FacetQuery {
if (label && this.hasFacetQueries) { if (label && this.hasFacetQueries) {
const result = this.config.facetQueries.queries.find((query) => query.label === label); const result = this.config.facetQueries.queries.find((query) => query.label === label);
@ -152,6 +191,11 @@ export class SearchQueryBuilderService {
return null; return null;
} }
/**
* Gets a facet field by label.
* @param label Label of the facet field
* @returns Facet field data
*/
getFacetField(label: string): FacetField { getFacetField(label: string): FacetField {
if (label) { if (label) {
const fields = this.config.facetFields.fields || []; const fields = this.config.facetFields.fields || [];
@ -163,11 +207,18 @@ export class SearchQueryBuilderService {
return null; return null;
} }
/**
* Builds the current query and triggers the `updated` event.
*/
update(): void { update(): void {
const query = this.buildQuery(); const query = this.buildQuery();
this.updated.next(query); this.updated.next(query);
} }
/**
* Builds and executes the current query.
* @returns Nothing
*/
async execute() { async execute() {
const query = this.buildQuery(); const query = this.buildQuery();
if (query) { if (query) {
@ -176,6 +227,10 @@ export class SearchQueryBuilderService {
} }
} }
/**
* Builds the current query.
* @returns The finished query
*/
buildQuery(): QueryBody { buildQuery(): QueryBody {
let query = this.getFinalQuery(); let query = this.getFinalQuery();
@ -206,7 +261,8 @@ export class SearchQueryBuilderService {
} }
/** /**
* Returns primary sorting definition. * Gets the primary sorting definition.
* @returns The primary sorting definition
*/ */
getPrimarySorting(): SearchSortingDefinition { getPrimarySorting(): SearchSortingDefinition {
if (this.sorting && this.sorting.length > 0) { if (this.sorting && this.sorting.length > 0) {
@ -216,7 +272,8 @@ export class SearchQueryBuilderService {
} }
/** /**
* Returns all pre-configured sorting options that users can choose from. * Gets all pre-configured sorting options that users can choose from.
* @returns Pre-configured sorting options
*/ */
getSortingOptions(): SearchSortingDefinition[] { getSortingOptions(): SearchSortingDefinition[] {
if (this.config && this.config.sorting) { if (this.config && this.config.sorting) {
@ -226,7 +283,8 @@ export class SearchQueryBuilderService {
} }
/** /**
* Check if FacetQueries has been defined * Checks if FacetQueries has been defined
* @returns True if defined, false otherwise
*/ */
get hasFacetQueries(): boolean { get hasFacetQueries(): boolean {
if (this.config if (this.config

View File

@ -31,21 +31,27 @@ import { FormService } from './../../../services/form.service';
}) })
export class ContentWidgetComponent implements OnChanges { export class ContentWidgetComponent implements OnChanges {
/** The content id to show. */
@Input() @Input()
id: string; id: string;
/** Toggles showing document content. */
@Input() @Input()
showDocumentContent: boolean = true; showDocumentContent: boolean = true;
/** Emitted when the content is clicked. */
@Output() @Output()
contentClick = new EventEmitter(); contentClick = new EventEmitter();
/** Emitted when the thumbnail has loaded. */
@Output() @Output()
thumbnailLoaded: EventEmitter<any> = new EventEmitter<any>(); thumbnailLoaded: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when the content has loaded. */
@Output() @Output()
contentLoaded: EventEmitter<any> = new EventEmitter<any>(); contentLoaded: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when an error occurs. */
@Output() @Output()
error: EventEmitter<any> = new EventEmitter<any>(); error: EventEmitter<any> = new EventEmitter<any>();

View File

@ -39,6 +39,7 @@ export class IconComponent {
return this._value; return this._value;
} }
/** Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. */
@Input() @Input()
set value(value: string) { set value(value: string) {
this._value = value || 'settings'; this._value = value || 'settings';

View File

@ -74,6 +74,11 @@ export class TranslationService {
} }
} }
/**
* Loads a translation file.
* @param lang Language code for the language to load
* @param fallback Language code to fall back to if the first one was unavailable
*/
loadTranslation(lang: string, fallback?: string) { loadTranslation(lang: string, fallback?: string) {
this.translate.getTranslation(lang).subscribe( this.translate.getTranslation(lang).subscribe(
() => { () => {

View File

@ -59,6 +59,12 @@ export class ProcessService {
); );
} }
/**
* Gets processes for a filter and optionally a process definition.
* @param requestNode Filter for instances
* @param processDefinitionKey Limits returned instances to a process definition
* @returns List of processes
*/
getProcesses(requestNode: ProcessFilterParamRepresentationModel, processDefinitionKey?: string): Observable<ProcessListModel> { getProcesses(requestNode: ProcessFilterParamRepresentationModel, processDefinitionKey?: string): Observable<ProcessListModel> {
return this.getProcessInstances(requestNode, processDefinitionKey || null) return this.getProcessInstances(requestNode, processDefinitionKey || null)
.pipe(catchError(() => { .pipe(catchError(() => {

View File

@ -42,18 +42,23 @@ export class StartTaskComponent implements OnInit {
public FORMAT_DATE: string = 'DD/MM/YYYY'; public FORMAT_DATE: string = 'DD/MM/YYYY';
MAX_LENGTH: number = 255; MAX_LENGTH: number = 255;
/** (required) The id of the app. */
@Input() @Input()
appId: number; appId: number;
/** Default Task Name. */
@Input() @Input()
name: string = ''; name: string = '';
/** Emitted when the task is successfully created. */
@Output() @Output()
success: EventEmitter<any> = new EventEmitter<any>(); success: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when the cancel button is clicked by the user. */
@Output() @Output()
cancel: EventEmitter<void> = new EventEmitter<void>(); cancel: EventEmitter<void> = new EventEmitter<void>();
/** Emitted when an error occurs. */
@Output() @Output()
error: EventEmitter<any> = new EventEmitter<any>(); error: EventEmitter<any> = new EventEmitter<any>();

View File

@ -5,7 +5,7 @@
"author": "Alfresco Software, Ltd.", "author": "Alfresco Software, Ltd.",
"main": "./index.js", "main": "./index.js",
"scripts": { "scripts": {
"docbuild": "node node_modules/typedoc/bin/typedoc --tsconfig tsconfig.json --json docs/docs.json --exclude '**/*.spec.ts' --ignoreCompilerErrors && node tools/doc/buildYamlSourceInfo.js docs/docs.json && node ./tools/doc/docProcessor.js", "docbuild": "node node_modules/typedoc/bin/typedoc --tsconfig lib/tsconfig.json --json docs/docs.json --exclude '**/*.spec.ts' --ignoreCompilerErrors && node tools/doc/buildYamlSourceInfo.js docs/docs.json && node ./tools/doc/docProcessor.js",
"prepublishOnly": "npm run build-lib", "prepublishOnly": "npm run build-lib",
"markdownlint": "markdownlint ./docs", "markdownlint": "markdownlint ./docs",
"stylelint": "stylelint ./**/*.scss --config stylelint-config.json", "stylelint": "stylelint ./**/*.scss --config stylelint-config.json",

View File

@ -147,7 +147,8 @@
"external-alfresco", "external-alfresco",
"content-node-share", "content-node-share",
"tree-view", "tree-view",
"dialog" "dialog",
"[Cc]olumn"
], ],
"fileCheckerFilter": [ "fileCheckerFilter": [
"README", "README",