mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2026-09-09 18:03:21 +00:00
[ADF-3801] Added source links for core docs (#4038)
This commit is contained in:
committed by
Eugenio Romano
parent
71298982ae
commit
9fd564a78e
+37
-37
@@ -66,7 +66,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)  | 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)  | 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) |
|
||||||
@@ -75,8 +75,8 @@ 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 from APS | [Source](../lib/core/form/components/form.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) |
|
||||||
| [Start form component](core/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/core/form/components/start-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) |
|
||||||
| [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) |
|
||||||
| [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) |
|
||||||
@@ -94,7 +94,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 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](../core/toolbar.component.md) 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) |
|
||||||
@@ -116,7 +116,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 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`](../../lib/process-services/task-list/models/form.model.ts) 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) |
|
||||||
@@ -128,23 +128,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 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`](../core/user-process.model.md) 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 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`](../core/user-process.model.md) 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. | [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](../core/card-view.component.md). | [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](../core/card-view.component.md). | [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 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](../../e2e/pages/adf/process_services/widgets/widget.ts) 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) |
|
||||||
@@ -165,7 +165,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)  | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) |
|
| [Renditions service](core/renditions.service.md)  | 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) |
|
||||||
@@ -178,8 +178,8 @@ for more information about installing and using the source code.
|
|||||||
| [User preferences service](core/user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../lib/core/services/user-preferences.service.ts) |
|
| [User preferences service](core/user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../lib/core/services/user-preferences.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) |
|
| [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) |
|
||||||
| _Jwt helper service_ | _Not currently documented_ | [Source](../lib/core/services/jwt-helper.service.ts) |
|
| _[Jwt helper service](../../lib/core/services/jwt-helper.service.ts)_ | _Not currently documented_ | [Source](../lib/core/services/jwt-helper.service.ts) |
|
||||||
| _Identity user service_ | _Not currently documented_ | [Source](../lib/core/userinfo/services/identity-user.service.ts) |
|
| _[Identity user service](../../lib/core/userinfo/services/identity-user.service.ts)_ | _Not currently documented_ | [Source](../lib/core/userinfo/services/identity-user.service.ts) |
|
||||||
|
|
||||||
## Widgets
|
## Widgets
|
||||||
|
|
||||||
@@ -224,17 +224,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 for the Search Filter component. | [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](../../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 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 for the Search Filter component. | [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](../../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 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 for the Search Filter component. | [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](../../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 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 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 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 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 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 for the Search Filter component. | [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](../../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 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) |
|
||||||
@@ -246,7 +246,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)  | 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)  | 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)  | 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)  | 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)  | 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)  | 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) |
|
||||||
|
|
||||||
@@ -275,12 +275,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. | [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 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. | [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](../content-services/search-filter.component.md). | [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) |
|
||||||
@@ -343,9 +343,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-->
|
||||||
@@ -369,18 +369,18 @@ for more information about installing and using the source code.
|
|||||||
| [Process list cloud component](process-services-cloud/process-list-cloud.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process-list-cloud/components/process-list-cloud.component.ts) |
|
| [Process list cloud component](process-services-cloud/process-list-cloud.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process-list-cloud/components/process-list-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-cloud/task-filters-cloud/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-cloud/task-filters-cloud/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-list-cloud/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-list-cloud/components/task-list-cloud.component.ts) |
|
||||||
| _App details cloud component_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app-list-cloud/components/app-details-cloud.component.ts) |
|
| _[App details cloud component](../../lib/process-services-cloud/src/lib/app-list-cloud/components/app-details-cloud.component.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app-list-cloud/components/app-details-cloud.component.ts) |
|
||||||
| _Process filters cloud component_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/process-cloud/process-filters-cloud/process-filters-cloud.component.ts) |
|
| _[Process filters cloud component](../../lib/process-services-cloud/src/lib/process-cloud/process-filters-cloud/process-filters-cloud.component.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/process-cloud/process-filters-cloud/process-filters-cloud.component.ts) |
|
||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
| Name | Description | Source link |
|
| Name | Description | Source link |
|
||||||
| ---- | ----------- | ----------- |
|
| ---- | ----------- | ----------- |
|
||||||
| _Apps process cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app-list-cloud/services/apps-process-cloud.service.ts) |
|
| _[Apps process cloud service](../../lib/process-services-cloud/src/lib/app-list-cloud/services/apps-process-cloud.service.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/app-list-cloud/services/apps-process-cloud.service.ts) |
|
||||||
| _Process filter cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/process-cloud/services/process-filter-cloud.service.ts) |
|
| _[Process filter cloud service](../../lib/process-services-cloud/src/lib/process-cloud/services/process-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/process-cloud/services/process-filter-cloud.service.ts) |
|
||||||
| _Process list cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/process-list-cloud/services/process-list-cloud.service.ts) |
|
| _[Process list cloud service](../../lib/process-services-cloud/src/lib/process-list-cloud/services/process-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/process-list-cloud/services/process-list-cloud.service.ts) |
|
||||||
| _Task filter cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task-cloud/services/task-filter-cloud.service.ts) |
|
| _[Task filter cloud service](../../lib/process-services-cloud/src/lib/task-cloud/services/task-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task-cloud/services/task-filter-cloud.service.ts) |
|
||||||
| _Task list cloud service_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task-list-cloud/services/task-list-cloud.service.ts) |
|
| _[Task list cloud service](../../lib/process-services-cloud/src/lib/task-list-cloud/services/task-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/task-list-cloud/services/task-list-cloud.service.ts) |
|
||||||
|
|
||||||
<!--process-services-cloud end-->
|
<!--process-services-cloud end-->
|
||||||
|
|
||||||
@@ -399,7 +399,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 classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) |
|
| [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) |
|
||||||
| [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) |
|
||||||
|
|||||||
+14
-14
@@ -17,7 +17,7 @@ for more information about installing and using the source code.
|
|||||||
| Name | Description | Source link |
|
| Name | Description | Source link |
|
||||||
| ---- | ----------- | ----------- |
|
| ---- | ----------- | ----------- |
|
||||||
| [About component](about.component.md)  | Shows a general version and status overview of the installed ADF library. | [Source](../../lib/core/about/about.component.ts) |
|
| [About component](about.component.md)  | Shows a general version and status overview of the installed ADF library. | [Source](../../lib/core/about/about.component.ts) |
|
||||||
| [Buttons menu component](buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../../lib/core/buttons-menu/buttons-menu.component.ts) |
|
| [Buttons menu component](buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../../lib/core/buttons-menu/buttons-menu.component.ts) |
|
||||||
| [Card view component](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](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](comment-list.component.md) | Shows a list of comments. | [Source](../../lib/core/comments/comment-list.component.ts) |
|
| [Comment list component](comment-list.component.md) | Shows a list of comments. | [Source](../../lib/core/comments/comment-list.component.ts) |
|
||||||
| [Comments component](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](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) |
|
||||||
@@ -26,8 +26,8 @@ for more information about installing and using the source code.
|
|||||||
| [Empty list component](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](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](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](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](form-list.component.md) | Shows forms as a list. | [Source](../../lib/core/form/components/form-list.component.ts) |
|
| [Form list component](form-list.component.md) | Shows forms as a list. | [Source](../../lib/core/form/components/form-list.component.ts) |
|
||||||
| [Form component](form.component.md) | Shows a Form from APS | [Source](../../lib/core/form/components/form.component.ts) |
|
| [Form component](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) |
|
||||||
| [Start form component](start-form.component.md) | Displays the Start Form for a process. | [Source](../../lib/core/form/components/start-form.component.ts) |
|
| [Start form component](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) |
|
||||||
| [Text mask component](text-mask.component.md) | Implements text field input masks. | [Source](../../lib/core/form/components/widgets/text/text-mask.component.ts) |
|
| [Text mask component](text-mask.component.md) | Implements text field input masks. | [Source](../../lib/core/form/components/widgets/text/text-mask.component.ts) |
|
||||||
| [Info drawer layout component](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](info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../../lib/core/info-drawer/info-drawer-layout.component.ts) |
|
||||||
| [Info drawer component](info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../../lib/core/info-drawer/info-drawer.component.ts) |
|
| [Info drawer component](info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../../lib/core/info-drawer/info-drawer.component.ts) |
|
||||||
@@ -45,7 +45,7 @@ for more information about installing and using the source code.
|
|||||||
| [Empty content component](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](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](error-content.component.md) | Displays info about a specific error. | [Source](../../lib/core/templates/error-content/error-content.component.ts) |
|
| [Error content component](error-content.component.md) | Displays info about a specific error. | [Source](../../lib/core/templates/error-content/error-content.component.ts) |
|
||||||
| [Toolbar divider component](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](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](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](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 component](toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../../lib/core/toolbar/toolbar.component.ts) |
|
| [Toolbar component](toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../../lib/core/toolbar/toolbar.component.ts) |
|
||||||
| [User info component](user-info.component.md) | Shows user information. | [Source](../../lib/core/userinfo/components/user-info.component.ts) |
|
| [User info component](user-info.component.md) | Shows user information. | [Source](../../lib/core/userinfo/components/user-info.component.ts) |
|
||||||
| [Viewer component](viewer.component.md) | Displays content from an ACS repository. | [Source](../../lib/core/viewer/components/viewer.component.ts) |
|
| [Viewer component](viewer.component.md) | Displays content from an ACS repository. | [Source](../../lib/core/viewer/components/viewer.component.ts) |
|
||||||
@@ -67,7 +67,7 @@ for more information about installing and using the source code.
|
|||||||
|
|
||||||
| Name | Description | Source link |
|
| Name | Description | Source link |
|
||||||
| ---- | ----------- | ----------- |
|
| ---- | ----------- | ----------- |
|
||||||
| [Form field model](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) |
|
| [Form field model](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) |
|
||||||
| [Product version model](product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../../lib/core/models/product-version.model.ts) |
|
| [Product version model](product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../../lib/core/models/product-version.model.ts) |
|
||||||
| [User process model](user-process.model.md) | Represents a Process Services user. | [Source](../../lib/core/models/user-process.model.ts) |
|
| [User process model](user-process.model.md) | Represents a Process Services user. | [Source](../../lib/core/models/user-process.model.ts) |
|
||||||
| [Bpm user model](bpm-user.model.md) | Contains information about a Process Services user. | [Source](../../lib/core/userinfo/models/bpm-user.model.ts) |
|
| [Bpm user model](bpm-user.model.md) | Contains information about a Process Services user. | [Source](../../lib/core/userinfo/models/bpm-user.model.ts) |
|
||||||
@@ -79,23 +79,23 @@ for more information about installing and using the source code.
|
|||||||
| ---- | ----------- | ----------- |
|
| ---- | ----------- | ----------- |
|
||||||
| [File size pipe](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](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](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](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](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) |
|
| [Full name pipe](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) |
|
||||||
| [Mime type icon pipe](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](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](node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../../lib/core/pipes/node-name-tooltip.pipe.ts) |
|
| [Node name tooltip pipe](node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../../lib/core/pipes/node-name-tooltip.pipe.ts) |
|
||||||
| [Text highlight pipe](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](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](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](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](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) |
|
| [User initial pipe](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) |
|
||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
| Name | Description | Source link |
|
| Name | Description | Source link |
|
||||||
| ---- | ----------- | ----------- |
|
| ---- | ----------- | ----------- |
|
||||||
| [Card item types service](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 item types service](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 view update service](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](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) |
|
||||||
| [Activiti alfresco service](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](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](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 rendering service](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 service](form.service.md) | Implements Process Services form methods | [Source](../../lib/core/form/services/form.service.ts) |
|
| [Form service](form.service.md) | Implements Process Services form methods | [Source](../../lib/core/form/services/form.service.ts) |
|
||||||
| [Node service](node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../../lib/core/form/services/node.service.ts) |
|
| [Node service](node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../../lib/core/form/services/node.service.ts) |
|
||||||
| [Process content service](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](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](alfresco-api.service.md) | Provides access to an initialized **AlfrescoJSApi** instance. | [Source](../../lib/core/services/alfresco-api.service.ts) |
|
| [Alfresco api service](alfresco-api.service.md) | Provides access to an initialized **AlfrescoJSApi** instance. | [Source](../../lib/core/services/alfresco-api.service.ts) |
|
||||||
| [Apps process service](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](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) |
|
||||||
@@ -116,7 +116,7 @@ for more information about installing and using the source code.
|
|||||||
| [Nodes api service](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](nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../../lib/core/services/nodes-api.service.ts) |
|
||||||
| [Notification service](notification.service.md) | Shows a notification message with optional feedback. | [Source](../../lib/core/services/notification.service.ts) |
|
| [Notification service](notification.service.md) | Shows a notification message with optional feedback. | [Source](../../lib/core/services/notification.service.ts) |
|
||||||
| [Page title service](page-title.service.md) | Sets the page title. | [Source](../../lib/core/services/page-title.service.ts) |
|
| [Page title service](page-title.service.md) | Sets the page title. | [Source](../../lib/core/services/page-title.service.ts) |
|
||||||
| [People content service](people-content.service.md) | Gets information about a Content Services user. | [Source](../../lib/core/services/people-content.service.ts) |
|
| [People content service](people-content.service.md) | Gets information about a Content Services user. | [Source](../../lib/core/services/people-content.service.ts) |
|
||||||
| [People process service](people-process.service.md) | Gets information about Process Services users. | [Source](../../lib/core/services/people-process.service.ts) |
|
| [People process service](people-process.service.md) | Gets information about Process Services users. | [Source](../../lib/core/services/people-process.service.ts) |
|
||||||
| [Renditions service](renditions.service.md)  | Manages prearranged conversions of content to different formats. | [Source](../../lib/core/services/renditions.service.ts) |
|
| [Renditions service](renditions.service.md)  | Manages prearranged conversions of content to different formats. | [Source](../../lib/core/services/renditions.service.ts) |
|
||||||
| [Search configuration service](search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../../lib/core/services/search-configuration.service.ts) |
|
| [Search configuration service](search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../../lib/core/services/search-configuration.service.ts) |
|
||||||
@@ -129,8 +129,8 @@ for more information about installing and using the source code.
|
|||||||
| [User preferences service](user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../../lib/core/services/user-preferences.service.ts) |
|
| [User preferences service](user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../../lib/core/services/user-preferences.service.ts) |
|
||||||
| [Bpm user service](bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../../lib/core/userinfo/services/bpm-user.service.ts) |
|
| [Bpm user service](bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../../lib/core/userinfo/services/bpm-user.service.ts) |
|
||||||
| [Ecm user service](ecm-user.service.md) | Gets information about a Content Services user. | [Source](../../lib/core/userinfo/services/ecm-user.service.ts) |
|
| [Ecm user service](ecm-user.service.md) | Gets information about a Content Services user. | [Source](../../lib/core/userinfo/services/ecm-user.service.ts) |
|
||||||
| _Jwt helper service_ | _Not currently documented_ | [Source](../../lib/core/services/jwt-helper.service.ts) |
|
| _[Jwt helper service](../../lib/core/services/jwt-helper.service.ts)_ | _Not currently documented_ | [Source](../../lib/core/services/jwt-helper.service.ts) |
|
||||||
| _Identity user service_ | _Not currently documented_ | [Source](../../lib/core/userinfo/services/identity-user.service.ts) |
|
| _[Identity user service](../../lib/core/userinfo/services/identity-user.service.ts)_ | _Not currently documented_ | [Source](../../lib/core/userinfo/services/identity-user.service.ts) |
|
||||||
|
|
||||||
## Widgets
|
## Widgets
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Experimental
|
|||||||
Last reviewed: 2018-11-14
|
Last reviewed: 2018-11-14
|
||||||
---
|
---
|
||||||
|
|
||||||
# About Component
|
# [About Component](../../lib/core/about/about.component.ts "Defined in about.component.ts")
|
||||||
|
|
||||||
Shows a general version and status overview of the installed ADF library.
|
Shows a general version and status overview of the installed ADF library.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# APS Alfresco Content Service
|
# [APS Alfresco Content Service](../../lib/core/form/services/activiti-alfresco.service.ts "Defined in activiti-alfresco.service.ts")
|
||||||
|
|
||||||
Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS).
|
Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS).
|
||||||
|
|
||||||
@@ -21,6 +21,7 @@ and Task Instances as related content.
|
|||||||
providers: [ActivitiAlfrescoContentService]
|
providers: [ActivitiAlfrescoContentService]
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
And also import it in the way shown below.
|
And also import it in the way shown below.
|
||||||
|
|
||||||
## Importing
|
## Importing
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-04-13
|
Last reviewed: 2018-04-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Alfresco Api Service
|
# [Alfresco Api Service](../../lib/core/services/alfresco-api.service.ts "Defined in alfresco-api.service.ts")
|
||||||
|
|
||||||
Provides access to an initialized **AlfrescoJSApi** instance.
|
Provides access to an initialized **AlfrescoJSApi** instance.
|
||||||
|
|
||||||
|
|||||||
@@ -1,59 +0,0 @@
|
|||||||
---
|
|
||||||
Title: Alfresco Content service
|
|
||||||
Added: v2.0.0
|
|
||||||
Status: Active
|
|
||||||
---
|
|
||||||
|
|
||||||
# Alfresco Content service
|
|
||||||
|
|
||||||
Gets URLs and access info and creates folders in Content Services.
|
|
||||||
|
|
||||||
## Class members
|
|
||||||
|
|
||||||
### Methods
|
|
||||||
|
|
||||||
`getDocumentThumbnailUrl(nodeId: any, attachment?: boolean, ticket?: string): string`<br/>
|
|
||||||
Gets a thumbnail URL for a node.
|
|
||||||
|
|
||||||
`getContentUrl(nodeId: any, attachment?: boolean, ticket?: string): string`<br/>
|
|
||||||
Gets the URL for a node's content.
|
|
||||||
|
|
||||||
`getNodeContent(nodeId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
||||||
Gets a node's content.
|
|
||||||
|
|
||||||
[`createFolder(relativePath: string, name: string, parentId?: string): Observable<FolderCreatedEvent>`](../../lib/core/events/folder-created.event.ts)<br/>
|
|
||||||
Creates a folder.
|
|
||||||
|
|
||||||
`hasPermission(node: any, permission:`[`PermissionsEnum`](../../lib/core/models/permissions.enum.ts)`|string): boolean`<br/>
|
|
||||||
Checks if the user has the specified permissions for `node`.
|
|
||||||
|
|
||||||
`hasAllowableOperations(node: any): boolean`<br/>
|
|
||||||
Checks if the the node has the `allowableOperations` property.
|
|
||||||
|
|
||||||
## Details
|
|
||||||
|
|
||||||
The methods that take a `node` parameter can receive the node as either a node ID string
|
|
||||||
or as a [MinimalNode](../content-services/document-library.model.md) object. You can obtain the `ticket` string,
|
|
||||||
if you need it, from the [Authentication service](authentication.service.md). If
|
|
||||||
`attachment` is false then the content can be viewed in the browser but not downloaded; the
|
|
||||||
default value of true allows a download to take place.
|
|
||||||
|
|
||||||
The `createFolder` method adds a folder with a given `name` within the folder at `parentId`,
|
|
||||||
if supplied. You can use the well-known names "-my-" , "-shared-" or "-root-" as the `parentId`.
|
|
||||||
The `relativePath` will create a sequence of folders within `parentId` with `name` as the last
|
|
||||||
element but you can use an empty string to make the folder a direct child of `parentId`.
|
|
||||||
|
|
||||||
The `hasPermission` method reports whether the node has the specified permission. (The
|
|
||||||
[Permissions](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/models/permissions.enum.ts)
|
|
||||||
enum contains the values `DELETE`, `UPDATE`, `CREATE`, `UPDATEPERMISSIONS`, `NOT_DELETE`,
|
|
||||||
`NOT_UPDATE`, `NOT_CREATE` and `NOT_UPDATEPERMISSIONS`.
|
|
||||||
|
|
||||||
See the
|
|
||||||
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-core-rest-api)
|
|
||||||
for more information about the low-level REST API that these methods are based on.
|
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
|
|
||||||
<!-- seealso start -->
|
|
||||||
|
|
||||||
<!-- seealso end -->
|
|
||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-05-24
|
Last reviewed: 2018-05-24
|
||||||
---
|
---
|
||||||
|
|
||||||
# App Config Pipe
|
# [App Config Pipe](../../lib/core/app-config/app-config.pipe.ts "Defined in app-config.pipe.ts")
|
||||||
|
|
||||||
Retrieves values from the application configuration file directly.
|
Retrieves values from the application configuration file directly.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-09-13
|
Last reviewed: 2018-09-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# App Config service
|
# [App Config service](../../lib/core/app-config/app-config.service.ts "Defined in app-config.service.ts")
|
||||||
|
|
||||||
Supports app configuration settings, stored server side.
|
Supports app configuration settings, stored server side.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-16
|
Last reviewed: 2018-11-16
|
||||||
---
|
---
|
||||||
|
|
||||||
# Apps Process service
|
# [Apps Process service](../../lib/core/services/apps-process.service.ts "Defined in apps-process.service.ts")
|
||||||
|
|
||||||
Gets details of the Process Services apps that are deployed for the user.
|
Gets details of the Process Services apps that are deployed for the user.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Auth Guard Bpm service
|
# [Auth Guard Bpm service](../../lib/core/services/auth-guard-bpm.service.ts "Defined in auth-guard-bpm.service.ts")
|
||||||
|
|
||||||
Adds authentication with Process Services to a route within the app.
|
Adds authentication with Process Services to a route within the app.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Auth Guard Ecm service
|
# [Auth Guard Ecm service](../../lib/core/services/auth-guard-ecm.service.ts "Defined in auth-guard-ecm.service.ts")
|
||||||
|
|
||||||
Adds authentication with Content Services to a route within the app.
|
Adds authentication with Content Services to a route within the app.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Auth Guard service
|
# [Auth Guard service](../../lib/core/services/auth-guard.service.ts "Defined in auth-guard.service.ts")
|
||||||
|
|
||||||
Adds authentication to a route within the app.
|
Adds authentication to a route within the app.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-19
|
Last reviewed: 2018-11-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# Authentication Service
|
# [Authentication Service](../../lib/core/services/authentication.service.ts "Defined in authentication.service.ts")
|
||||||
|
|
||||||
Provides authentication to ACS and APS.
|
Provides authentication to ACS and APS.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Bpm User model
|
# [Bpm User model](../../lib/core/userinfo/models/bpm-user.model.ts "Defined in bpm-user.model.ts")
|
||||||
|
|
||||||
Contains information about a Process Services user.
|
Contains information about a Process Services user.
|
||||||
|
|
||||||
@@ -12,7 +12,7 @@ Contains information about a Process Services user.
|
|||||||
|
|
||||||
Instances of this class are returned by the methods of the
|
Instances of this class are returned by the methods of the
|
||||||
[Bpm User service](bpm-user.service.md). It implements the
|
[Bpm User service](bpm-user.service.md). It implements the
|
||||||
`UserRepresentation` interface, which is defined in the
|
[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserRepresentation.md) interface, which is defined in the
|
||||||
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UserRepresentation.md).
|
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UserRepresentation.md).
|
||||||
|
|
||||||
Note that the Typescript class for this model is in active development;
|
Note that the Typescript class for this model is in active development;
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-19
|
Last reviewed: 2018-11-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# Bpm User service
|
# [Bpm User service](../../lib/core/userinfo/services/bpm-user.service.ts "Defined in bpm-user.service.ts")
|
||||||
|
|
||||||
Gets information about the current Process Services user.
|
Gets information about the current Process Services user.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Buttons Menu Component
|
# [Buttons Menu Component](../../lib/core/buttons-menu/buttons-menu.component.ts "Defined in buttons-menu.component.ts")
|
||||||
|
|
||||||
Displays buttons on a responsive menu.
|
Displays buttons on a responsive menu.
|
||||||
|
|
||||||
@@ -55,4 +55,3 @@ depending on the screen size:
|
|||||||
|
|
||||||
The component has a property called `isMenuEmpty` that you can access from code. If this is
|
The component has a property called `isMenuEmpty` that you can access from code. If this is
|
||||||
set to true then the component will not show an empty menu with no buttons defined.
|
set to true then the component will not show an empty menu with no buttons defined.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Card Item Type service
|
# [Card Item Type service](../../lib/core/card-view/services/card-item-types.service.ts "Defined in card-item-types.service.ts")
|
||||||
|
|
||||||
Maps type names to field component types for the [Card View component](../core/card-view.component.md).
|
Maps type names to field component types for the [Card View component](../core/card-view.component.md).
|
||||||
|
|
||||||
@@ -18,9 +18,9 @@ Maps type names to field component types for the [Card View component](../core/c
|
|||||||
- _type:_ `string` - The type whose resolver you want
|
- _type:_ `string` - The type whose resolver you want
|
||||||
- _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped
|
- _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped
|
||||||
- **Returns** `DynamicComponentResolveFunction` - Resolver function
|
- **Returns** `DynamicComponentResolveFunction` - Resolver function
|
||||||
- **resolveComponentType**(model: `DynamicComponentModel`, defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
|
- **resolveComponentType**(model: [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
|
||||||
Finds the component type that is needed to render a form field.
|
Finds the component type that is needed to render a form field.
|
||||||
- _model:_ `DynamicComponentModel` - [Form](../../lib/process-services/task-list/models/form.model.ts) field model for the field to render
|
- _model:_ [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../lib/process-services/task-list/models/form.model.ts) field model for the field to render
|
||||||
- _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped.
|
- _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped.
|
||||||
- **Returns** `Type<__type>` - Component type
|
- **Returns** `Type<__type>` - Component type
|
||||||
- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)<br/>
|
- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)<br/>
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-05-08
|
Last reviewed: 2018-05-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Card View Item interface
|
# [Card View Item interface](../../lib/core/card-view/interfaces/card-view-item.interface.ts "Defined in card-view-item.interface.ts")
|
||||||
|
|
||||||
Defines the implementation of an item in a [Card View component](../core/card-view.component.md).
|
Defines the implementation of an item in a [Card View component](../core/card-view.component.md).
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-14
|
Last reviewed: 2018-11-14
|
||||||
---
|
---
|
||||||
|
|
||||||
# Card View Update service
|
# [Card View Update service](../../lib/core/card-view/services/card-view-update.service.ts "Defined in card-view-update.service.ts")
|
||||||
|
|
||||||
Reports edits and clicks within fields of a [Card View component](../core/card-view.component.md).
|
Reports edits and clicks within fields of a [Card View component](../core/card-view.component.md).
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-05-09
|
Last reviewed: 2018-05-09
|
||||||
---
|
---
|
||||||
|
|
||||||
# Card View component
|
# [Card View component](../../lib/core/card-view/components/card-view/card-view.component.ts "Defined in card-view.component.ts")
|
||||||
|
|
||||||
Displays a configurable property list renderer.
|
Displays a configurable property list renderer.
|
||||||
|
|
||||||
@@ -98,7 +98,7 @@ Defining properties from Typescript:
|
|||||||
| ---- | ---- | ------------- | ----------- |
|
| ---- | ---- | ------------- | ----------- |
|
||||||
| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. |
|
| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. |
|
||||||
| editable | `boolean` | | Toggles whether or not the items can be edited. |
|
| editable | `boolean` | | Toggles whether or not the items can be edited. |
|
||||||
| properties | `CardViewItem[]` | | (**required**) Items to show in the card view. |
|
| properties | [`CardViewItem`](../../lib/core/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|
||||||
@@ -139,7 +139,7 @@ You can optionally set up the card view so that its properties can be edited. Yo
|
|||||||
the editing of properties at two levels:
|
the editing of properties at two levels:
|
||||||
|
|
||||||
- **Global level** - _via the editable parameter of the card-view.component_
|
- **Global level** - _via the editable parameter of the card-view.component_
|
||||||
- **Property level** - _in each property via the editable attribute_
|
- **[`Property`](../../lib/content-services/content-metadata/interfaces/property.interface.ts) level** - _in each property via the editable attribute_
|
||||||
|
|
||||||
If you set the global editable parameter to false, no properties can be edited regardless of their
|
If you set the global editable parameter to false, no properties can be edited regardless of their
|
||||||
individual `editable` settings.
|
individual `editable` settings.
|
||||||
@@ -175,7 +175,7 @@ const textItemProperty = new CardViewTextItemModel(options);
|
|||||||
| clickable | boolean | false | Toggles whether the property responds to clicks |
|
| clickable | boolean | false | Toggles whether the property responds to clicks |
|
||||||
| icon | string | | The material icon to show beside the item if it is clickable |
|
| icon | string | | The material icon to show beside the item if it is clickable |
|
||||||
| multiline | boolean | false | Single or multiline text |
|
| multiline | boolean | false | Single or multiline text |
|
||||||
| pipes | CardViewTextItemPipeProperty\[] | \[] | Pipes to be applied to the text before display |
|
| pipes | [`CardViewTextItemPipeProperty`](../../lib/core/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display |
|
||||||
|
|
||||||
##### Using pipes with a Card Text Item
|
##### Using pipes with a Card Text Item
|
||||||
|
|
||||||
@@ -330,7 +330,7 @@ const selectItemProperty = new CardViewSelectItemModel(options);
|
|||||||
| key\* | string | | Identifying key (important when editing the item) |
|
| key\* | string | | Identifying key (important when editing the item) |
|
||||||
| editable | boolean | false | Toggles whether the item is editable |
|
| editable | boolean | false | Toggles whether the item is editable |
|
||||||
| value | string | | The original data value for the item |
|
| value | string | | The original data value for the item |
|
||||||
| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)<CardViewSelectItemOption\[]> | | The original data value for the item |
|
| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewSelectItemOption`](../../lib/core/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item |
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-04-12
|
Last reviewed: 2018-04-12
|
||||||
---
|
---
|
||||||
|
|
||||||
# Comment Content service
|
# [Comment Content service](../../lib/core/services/comment-content.service.ts "Defined in comment-content.service.ts")
|
||||||
|
|
||||||
Adds and retrieves comments for nodes in Content Services.
|
Adds and retrieves comments for nodes in Content Services.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-14
|
Last reviewed: 2018-11-14
|
||||||
---
|
---
|
||||||
|
|
||||||
# Comment list component
|
# [Comment list component](../../lib/core/comments/comment-list.component.ts "Defined in comment-list.component.ts")
|
||||||
|
|
||||||
Shows a list of comments.
|
Shows a list of comments.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-14
|
Last reviewed: 2018-11-14
|
||||||
---
|
---
|
||||||
|
|
||||||
# Comment Process service
|
# [Comment Process service](../../lib/core/services/comment-process.service.ts "Defined in comment-process.service.ts")
|
||||||
|
|
||||||
Adds and retrieves comments for task and process instances in Process Services.
|
Adds and retrieves comments for task and process instances in Process Services.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Comments Component
|
# [Comments Component](../../lib/core/comments/comments.component.ts "Defined in comments.component.ts")
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Content service
|
# [Content service](../../lib/core/services/content.service.ts "Defined in content.service.ts")
|
||||||
|
|
||||||
Accesses app-generated data objects via URLs and file downloads.
|
Accesses app-generated data objects via URLs and file downloads.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# APS Content Component
|
# [APS Content Component](../../lib/core/form/components/widgets/content/content.widget.ts "Defined in content.widget.ts")
|
||||||
|
|
||||||
Shows the content preview.
|
Shows the content preview.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Context Menu directive
|
# [Context Menu directive](../../lib/core/context-menu/context-menu.directive.ts "Defined in context-menu.directive.ts")
|
||||||
|
|
||||||
Adds a context menu to a component.
|
Adds a context menu to a component.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Cookie service
|
# [Cookie service](../../lib/core/services/cookie.service.ts "Defined in cookie.service.ts")
|
||||||
|
|
||||||
Stores key-value data items as browser cookies.
|
Stores key-value data items as browser cookies.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-12
|
Last reviewed: 2018-11-12
|
||||||
---
|
---
|
||||||
|
|
||||||
# Data Column Component
|
# [Data Column Component](../../lib/core/data-column/data-column.component.ts "Defined in data-column.component.ts")
|
||||||
|
|
||||||
Defines column properties for DataTable, Tasklist, Document List and other components.
|
Defines column properties for DataTable, Tasklist, Document List and other components.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# DataTableAdapter interface
|
# [DataTableAdapter interface](../../lib/core/datatable/data/datatable-adapter.ts "Defined in datatable-adapter.ts")
|
||||||
|
|
||||||
Defines how table data is supplied to [DataTable](datatable.component.md)
|
Defines how table data is supplied to [DataTable](datatable.component.md)
|
||||||
and [Tasklist](../process-services/task-list.component.md) components.
|
and [Tasklist](../process-services/task-list.component.md) components.
|
||||||
@@ -13,7 +13,7 @@ and [Tasklist](../process-services/task-list.component.md) components.
|
|||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| ---- | ---- | ----------- |
|
| ---- | ---- | ----------- |
|
||||||
| selectedRow | DataRow | The data for the currently selected row. |
|
| selectedRow | [`DataRow`](../../lib/core/datatable/data/data-row.model.ts) | The data for the currently selected row. |
|
||||||
|
|
||||||
## Events
|
## Events
|
||||||
|
|
||||||
@@ -31,10 +31,10 @@ Get/set the values for display in the table using an array of rows.
|
|||||||
[`setColumns(columns: Array<DataColumn>): void;`](../../lib/core/datatable/data/data-column.model.ts)<br/>
|
[`setColumns(columns: Array<DataColumn>): void;`](../../lib/core/datatable/data/data-column.model.ts)<br/>
|
||||||
Get/set an array of column specifications.
|
Get/set an array of column specifications.
|
||||||
|
|
||||||
`getValue(row: `[`DataRow,`](../../lib/core/datatable/data/data-row.model.ts)` col: DataColumn): any;`<br/>
|
`getValue(row:`[`DataRow,`](../../lib/core/datatable/data/data-row.model.ts)`col: DataColumn): any;`<br/>
|
||||||
Get the data value from a specific table cell.
|
Get the data value from a specific table cell.
|
||||||
|
|
||||||
`getSorting(): `[`DataSorting`](../../lib/core/datatable/data/data-sorting.model.ts)`;`<br/>
|
`getSorting():`[`DataSorting`](../../lib/core/datatable/data/data-sorting.model.ts)`;`<br/>
|
||||||
`setSorting(sorting: DataSorting): void;`<br/>
|
`setSorting(sorting: DataSorting): void;`<br/>
|
||||||
Get/set the sorting key and direction (ascending or descending).
|
Get/set the sorting key and direction (ascending or descending).
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-12
|
Last reviewed: 2018-11-12
|
||||||
---
|
---
|
||||||
|
|
||||||
# DataTable component
|
# [DataTable component](../../lib/core/datatable/components/datatable/datatable.component.ts "Defined in datatable.component.ts")
|
||||||
|
|
||||||
Displays data as a table with customizable columns and presentation.
|
Displays data as a table with customizable columns and presentation.
|
||||||
|
|
||||||
@@ -313,7 +313,7 @@ together in the same datatable.
|
|||||||
| allowDropFiles | `boolean` | false | Toggles file drop support for rows (see [Upload directive](upload.directive.md) for further details). |
|
| allowDropFiles | `boolean` | false | Toggles file drop support for rows (see [Upload directive](upload.directive.md) for further details). |
|
||||||
| columns | `any[]` | \[] | The columns that the datatable will show. |
|
| columns | `any[]` | \[] | The columns that the datatable will show. |
|
||||||
| contextMenu | `boolean` | false | Toggles custom context menu for the component. |
|
| contextMenu | `boolean` | false | Toggles custom context menu for the component. |
|
||||||
| data | `DataTableAdapter` | | Data source for the table |
|
| data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | | Data source for the table |
|
||||||
| display | `string` | DisplayMode.List | Selects the display mode of the table. Can be "list" or "gallery". |
|
| display | `string` | DisplayMode.List | Selects the display mode of the table. Can be "list" or "gallery". |
|
||||||
| fallbackThumbnail | `string` | | Fallback image for rows where the thumbnail is missing. |
|
| fallbackThumbnail | `string` | | Fallback image for rows where the thumbnail is missing. |
|
||||||
| loading | `boolean` | false | Flag that indicates if the datatable is in loading state and needs to show the loading template (see the docs to learn how to configure a loading template). |
|
| loading | `boolean` | false | Flag that indicates if the datatable is in loading state and needs to show the loading template (see the docs to learn how to configure a loading template). |
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-04-05
|
Last reviewed: 2018-04-05
|
||||||
---
|
---
|
||||||
|
|
||||||
# Deleted Nodes Api service
|
# [Deleted Nodes Api service](../../lib/core/services/deleted-nodes-api.service.ts "Defined in deleted-nodes-api.service.ts")
|
||||||
|
|
||||||
Gets a list of Content Services nodes currently in the trash.
|
Gets a list of Content Services nodes currently in the trash.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-19
|
Last reviewed: 2018-11-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# Discovery Api service
|
# [Discovery Api service](../../lib/core/services/discovery-api.service.ts "Defined in discovery-api.service.ts")
|
||||||
|
|
||||||
Gets version and license information for Process Services and Content Services.
|
Gets version and license information for Process Services and Content Services.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Ecm User model
|
# [Ecm User model](../../lib/core/userinfo/models/ecm-user.model.ts "Defined in ecm-user.model.ts")
|
||||||
|
|
||||||
Contains information about a Content Services user.
|
Contains information about a Content Services user.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-19
|
Last reviewed: 2018-11-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# Ecm User service
|
# [Ecm User service](../../lib/core/userinfo/services/ecm-user.service.ts "Defined in ecm-user.service.ts")
|
||||||
|
|
||||||
Gets information about a Content Services user.
|
Gets information about a Content Services user.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-09-13
|
Last reviewed: 2018-09-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Empty Content Component
|
# [Empty Content Component](../../lib/core/templates/empty-content/empty-content.component.ts "Defined in empty-content.component.ts")
|
||||||
|
|
||||||
Provides a generic "Empty Content" placeholder for components.
|
Provides a generic "Empty Content" placeholder for components.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Empty list component
|
# [Empty list component](../../lib/core/datatable/components/datatable/empty-list.component.ts "Defined in empty-list.component.ts")
|
||||||
|
|
||||||
Displays a message indicating that a list is empty.
|
Displays a message indicating that a list is empty.
|
||||||
|
|
||||||
@@ -41,15 +41,6 @@ sub-components:
|
|||||||
|
|
||||||
## Class members
|
## Class members
|
||||||
|
|
||||||
### Properties
|
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
|
||||||
| ---- | ---- | ------- | ----------- |
|
|
||||||
| emptyListImageUrl | `string` | "empty_doc_lib.svg" | The default image used as the background |
|
|
||||||
| emptyMsg | `string` | "This list is empty" | The default title message |
|
|
||||||
| dragDropMsg | `string` | "Drag and drop" | The default drag and drop message |
|
|
||||||
| additionalMsg | `string` | "Drag and drop" | The default additional message |
|
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|
||||||
This component provides a custom display to show when a [Datatable component](datatable.component.md) has
|
This component provides a custom display to show when a [Datatable component](datatable.component.md) has
|
||||||
@@ -57,4 +48,4 @@ no content.
|
|||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Datatable component](datatable.component.md)
|
- [Datatable component](datatable.component.md)
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-09-13
|
Last reviewed: 2018-09-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Error Content Component
|
# [Error Content Component](../../lib/core/templates/error-content/error-content.component.ts "Defined in error-content.component.ts")
|
||||||
|
|
||||||
Displays info about a specific error.
|
Displays info about a specific error.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-05-04
|
Last reviewed: 2018-05-04
|
||||||
---
|
---
|
||||||
|
|
||||||
# Favorites Api service
|
# [Favorites Api service](../../lib/core/services/favorites-api.service.ts "Defined in favorites-api.service.ts")
|
||||||
|
|
||||||
Gets a list of items a user has marked as their favorites.
|
Gets a list of items a user has marked as their favorites.
|
||||||
|
|
||||||
@@ -16,7 +16,7 @@ Gets a list of items a user has marked as their favorites.
|
|||||||
- **getFavorites**(personId: `string`, options?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
|
- **getFavorites**(personId: `string`, options?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
|
||||||
Gets the favorites for a user.
|
Gets the favorites for a user.
|
||||||
- _personId:_ `string` - ID of the user
|
- _personId:_ `string` - ID of the user
|
||||||
- _options:_ `any` - (Optional) Options supported by JSAPI
|
- _options:_ `any` - (Optional) Options supported by JS-API
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of favorites
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of favorites
|
||||||
- **remapFavoriteEntries**(entries: `any[]`): `any[]`<br/>
|
- **remapFavoriteEntries**(entries: `any[]`): `any[]`<br/>
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-14
|
Last reviewed: 2018-11-14
|
||||||
---
|
---
|
||||||
|
|
||||||
# File Size pipe
|
# [File Size pipe](../../lib/core/pipes/file-size.pipe.ts "Defined in file-size.pipe.ts")
|
||||||
|
|
||||||
Converts a number of bytes to the equivalent in KB, MB, etc.
|
Converts a number of bytes to the equivalent in KB, MB, etc.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# FormFieldValidator interface
|
# [FormFieldValidator interface](../../lib/core/form/components/widgets/core/form-field-validator.ts "Defined in form-field-validator.ts")
|
||||||
|
|
||||||
Defines how the input fields of [`Form`](../../lib/process-services/task-list/models/form.model.ts) and Task Details components are validated.
|
Defines how the input fields of [`Form`](../../lib/process-services/task-list/models/form.model.ts) and Task Details components are validated.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Form field component
|
# [Form field component](../../lib/core/form/components/form-field/form-field.component.ts "Defined in form-field.component.ts")
|
||||||
|
|
||||||
Represents a UI field in a form.
|
Represents a UI field in a form.
|
||||||
|
|
||||||
@@ -38,8 +38,8 @@ uses `<adf-form-field>` components to render the form fields.
|
|||||||
|
|
||||||
Forms defined in APS have the following default mappings for the form fields:
|
Forms defined in APS have the following default mappings for the form fields:
|
||||||
|
|
||||||
| _APS [Form](../../lib/process-services/task-list/models/form.model.ts) Designer_ [`Widget`](../../e2e/pages/adf/process_services/widgets/widget.ts) | Field Type | Component Type |
|
| _APS [`Form`](../../lib/process-services/task-list/models/form.model.ts) Designer_ [`Widget`](../../e2e/pages/adf/process_services/widgets/widget.ts) | Field Type | Component Type |
|
||||||
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------- |
|
||||||
| Text | text | [`TextWidgetComponent`](../../lib/core/form/components/widgets/text/text.widget.ts) |
|
| Text | text | [`TextWidgetComponent`](../../lib/core/form/components/widgets/text/text.widget.ts) |
|
||||||
| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
|
| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
|
||||||
| Number | integer | [`NumberWidgetComponent`](../../lib/core/form/components/widgets/number/number.widget.ts) |
|
| Number | integer | [`NumberWidgetComponent`](../../lib/core/form/components/widgets/number/number.widget.ts) |
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-03-20
|
Last reviewed: 2018-03-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Form Field model
|
# [Form Field model](../../lib/core/form/components/widgets/core/form-field.model.ts "Defined in form-field.model.ts")
|
||||||
|
|
||||||
Contains the value and metadata for a field of a [`Form`](../../lib/process-services/task-list/models/form.model.ts) component.
|
Contains the value and metadata for a field of a [`Form`](../../lib/process-services/task-list/models/form.model.ts) component.
|
||||||
|
|
||||||
@@ -30,7 +30,7 @@ Contains the value and metadata for a field of a [`Form`](../../lib/process-serv
|
|||||||
| minValue | string | | Minimum allowed value (eg, for number or date) |
|
| minValue | string | | Minimum allowed value (eg, for number or date) |
|
||||||
| maxValue | string | | Minimum allowed value (eg, for number or date) |
|
| maxValue | string | | Minimum allowed value (eg, for number or date) |
|
||||||
| regexPattern | string | | Regular expression that text data should match |
|
| regexPattern | string | | Regular expression that text data should match |
|
||||||
| options | FormFieldOption\[] | \[] | Option items for a dropdown menu |
|
| options | [`FormFieldOption`](../../lib/core/form/components/widgets/core/form-field-option.ts)\[] | \[] | Option items for a dropdown menu |
|
||||||
| restUrl | string | | URL for a REST call to populate a dropdown menu |
|
| restUrl | string | | URL for a REST call to populate a dropdown menu |
|
||||||
| restResponsePath | string | | Path within REST response JSON to the array of dropdown data |
|
| restResponsePath | string | | Path within REST response JSON to the array of dropdown data |
|
||||||
| restIdProperty | string | | JSON property name to use for the `id` property of a dropdown item |
|
| restIdProperty | string | | JSON property name to use for the `id` property of a dropdown item |
|
||||||
@@ -38,7 +38,7 @@ Contains the value and metadata for a field of a [`Form`](../../lib/process-serv
|
|||||||
| hasEmptyValue | boolean | | Is the field's value empty? (eg, dropdown with no item selected) |
|
| hasEmptyValue | boolean | | Is the field's value empty? (eg, dropdown with no item selected) |
|
||||||
| className | string | | CSS class name for the field |
|
| className | string | | CSS class name for the field |
|
||||||
| optionType | string | | |
|
| optionType | string | | |
|
||||||
| params | FormFieldMetadata | {} | |
|
| params | [`FormFieldMetadata`](../../lib/core/form/components/widgets/core/form-field-metadata.ts) | {} | |
|
||||||
| hyperlinkUrl | string | | URL for Hyperlink widgets |
|
| hyperlinkUrl | string | | URL for Hyperlink widgets |
|
||||||
| displayText | string | | Displayed text for Hyperlink widgets |
|
| displayText | string | | Displayed text for Hyperlink widgets |
|
||||||
| isVisible | boolean | true | Is the field shown on the form? |
|
| isVisible | boolean | true | Is the field shown on the form? |
|
||||||
@@ -49,7 +49,7 @@ Contains the value and metadata for a field of a [`Form`](../../lib/process-serv
|
|||||||
| numberOfColumns | number | 1 | Number of columns defined by a container field |
|
| numberOfColumns | number | 1 | Number of columns defined by a container field |
|
||||||
| fields | [`FormFieldModel`](../core/form-field.model.md)\[] | \[] | Fields contained within a container field |
|
| fields | [`FormFieldModel`](../core/form-field.model.md)\[] | \[] | Fields contained within a container field |
|
||||||
| columns | [`ContainerColumnModel`](../../lib/core/form/components/widgets/core/container-column.model.ts)\[] | \[] | Column definitions for a container field |
|
| columns | [`ContainerColumnModel`](../../lib/core/form/components/widgets/core/container-column.model.ts)\[] | \[] | Column definitions for a container field |
|
||||||
| emptyOption | FormFieldOption | | Dropdown menu item to use when no option is chosen |
|
| emptyOption | [`FormFieldOption`](../../lib/core/form/components/widgets/core/form-field-option.ts) | | Dropdown menu item to use when no option is chosen |
|
||||||
| validationSummary | string | | Error/information message added during field validation (see [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) interface) |
|
| validationSummary | string | | Error/information message added during field validation (see [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) interface) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Form List Component
|
# [Form List Component](../../lib/core/form/components/form-list.component.ts "Defined in form-list.component.ts")
|
||||||
|
|
||||||
Shows forms as a list.
|
Shows forms as a list.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Form Rendering service
|
# [Form Rendering service](../../lib/core/form/services/form-rendering.service.ts "Defined in form-rendering.service.ts")
|
||||||
|
|
||||||
Maps a form field type string onto the corresponding form [widget component](../insights/widget.component.md) type.
|
Maps a form field type string onto the corresponding form [widget component](../insights/widget.component.md) type.
|
||||||
|
|
||||||
@@ -18,9 +18,9 @@ Maps a form field type string onto the corresponding form [widget component](../
|
|||||||
- _type:_ `string` - The type whose resolver you want
|
- _type:_ `string` - The type whose resolver you want
|
||||||
- _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped
|
- _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped
|
||||||
- **Returns** `DynamicComponentResolveFunction` - Resolver function
|
- **Returns** `DynamicComponentResolveFunction` - Resolver function
|
||||||
- **resolveComponentType**(model: `DynamicComponentModel`, defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
|
- **resolveComponentType**(model: [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
|
||||||
Finds the component type that is needed to render a form field.
|
Finds the component type that is needed to render a form field.
|
||||||
- _model:_ `DynamicComponentModel` - [Form](../../lib/process-services/task-list/models/form.model.ts) field model for the field to render
|
- _model:_ [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../lib/process-services/task-list/models/form.model.ts) field model for the field to render
|
||||||
- _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped.
|
- _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped.
|
||||||
- **Returns** `Type<__type>` - Component type
|
- **Returns** `Type<__type>` - Component type
|
||||||
- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)<br/>
|
- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)<br/>
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-14
|
Last reviewed: 2018-11-14
|
||||||
---
|
---
|
||||||
|
|
||||||
# Form component
|
# [Form component](../../lib/core/form/components/form.component.ts "Defined in form.component.ts")
|
||||||
|
|
||||||
Shows a [`Form`](../../lib/process-services/task-list/models/form.model.ts) from APS
|
Shows a [`Form`](../../lib/process-services/task-list/models/form.model.ts) from APS
|
||||||
|
|
||||||
@@ -53,10 +53,10 @@ Any content in the body of `<adf-form>` will be shown when no form definition is
|
|||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
| ---- | ---- | ------------- | ----------- |
|
| ---- | ---- | ------------- | ----------- |
|
||||||
| data | `FormValues` | | Custom form values map to be used with the rendered form. |
|
| data | [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. |
|
||||||
| disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. |
|
| disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. |
|
||||||
| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. |
|
| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. |
|
||||||
| fieldValidators | `FormFieldValidator[]` | \[] | Contains a list of form field validator instances. |
|
| fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. |
|
||||||
| form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. |
|
| form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. |
|
||||||
| formId | `string` | | The id of the form definition to load and display with custom values. |
|
| formId | `string` | | The id of the form definition to load and display with custom values. |
|
||||||
| formName | `string` | | Name of the form definition to load and display with custom values. |
|
| formName | `string` | | Name of the form definition to load and display with custom values. |
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Form service
|
# [Form service](../../lib/core/form/services/form.service.ts "Defined in form.service.ts")
|
||||||
|
|
||||||
Implements Process Services form methods
|
Implements Process Services form methods
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-27
|
Last reviewed: 2018-11-27
|
||||||
---
|
---
|
||||||
|
|
||||||
# Format Space pipe
|
# [Format Space pipe](../../lib/core/pipes/format-space.pipe.ts "Defined in format-space.pipe.ts")
|
||||||
|
|
||||||
Replaces all the white space in a string with a supplied character.
|
Replaces all the white space in a string with a supplied character.
|
||||||
|
|
||||||
@@ -30,4 +30,3 @@ becomes `test_a_pipe`).
|
|||||||
You can specify a different replacement character by passing it as a pipe parameter.
|
You can specify a different replacement character by passing it as a pipe parameter.
|
||||||
You can also pass `false` to the `lowercase` parameter to skip the conversion to lowercase
|
You can also pass `false` to the `lowercase` parameter to skip the conversion to lowercase
|
||||||
and just replace the whitespace.
|
and just replace the whitespace.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-12
|
Last reviewed: 2018-11-12
|
||||||
---
|
---
|
||||||
|
|
||||||
# Full name pipe
|
# [Full name pipe](../../lib/core/pipes/full-name.pipe.ts "Defined in full-name.pipe.ts")
|
||||||
|
|
||||||
Joins the first and last name properties from a [`UserProcessModel`](../core/user-process.model.md) object into a single string.
|
Joins the first and last name properties from a [`UserProcessModel`](../core/user-process.model.md) object into a single string.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Header component
|
# [Header component](../../lib/core/layout/components/header/header.component.ts "Defined in header.component.ts")
|
||||||
|
|
||||||
Reusable header for Alfresco applications.
|
Reusable header for Alfresco applications.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Highlight Transform service
|
# [Highlight Transform service](../../lib/core/services/highlight-transform.service.ts "Defined in highlight-transform.service.ts")
|
||||||
|
|
||||||
Adds HTML to a string to highlight chosen sections.
|
Adds HTML to a string to highlight chosen sections.
|
||||||
|
|
||||||
@@ -13,12 +13,12 @@ Adds HTML to a string to highlight chosen sections.
|
|||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
|
|
||||||
- **highlight**(text: `string`, search: `string`, wrapperClass: `string` = `"highlight"`): `HighlightTransformResult`<br/>
|
- **highlight**(text: `string`, search: `string`, wrapperClass: `string` = `"highlight"`): [`HighlightTransformResult`](../../lib/core/services/highlight-transform.service.ts)<br/>
|
||||||
Searches for `search` string(s) within `text` and highlights all occurrences.
|
Searches for `search` string(s) within `text` and highlights all occurrences.
|
||||||
- _text:_ `string` - Text to search within
|
- _text:_ `string` - Text to search within
|
||||||
- _search:_ `string` - Text pattern to search for
|
- _search:_ `string` - Text pattern to search for
|
||||||
- _wrapperClass:_ `string` - CSS class used to provide highlighting style
|
- _wrapperClass:_ `string` - CSS class used to provide highlighting style
|
||||||
- **Returns** `HighlightTransformResult` - New text along with boolean value to indicate whether anything was highlighted
|
- **Returns** [`HighlightTransformResult`](../../lib/core/services/highlight-transform.service.ts) - New text along with boolean value to indicate whether anything was highlighted
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Highlight directive
|
# [Highlight directive](../../lib/core/directives/highlight.directive.ts "Defined in highlight.directive.ts")
|
||||||
|
|
||||||
Adds highlighting to selected sections of an HTML element's content.
|
Adds highlighting to selected sections of an HTML element's content.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Internal
|
|||||||
Last reviewed: 2018-09-13
|
Last reviewed: 2018-09-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Host settings component
|
# [Host settings component](../../lib/core/settings/host-settings.component.ts "Defined in host-settings.component.ts")
|
||||||
|
|
||||||
Validates the URLs for ACS and APS and saves them in the user's local storage
|
Validates the URLs for ACS and APS and saves them in the user's local storage
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Infinite Pagination component
|
# [Infinite Pagination component](../../lib/core/pagination/infinite-pagination.component.ts "Defined in infinite-pagination.component.ts")
|
||||||
|
|
||||||
Adds "infinite" pagination to the component it is used with.
|
Adds "infinite" pagination to the component it is used with.
|
||||||
|
|
||||||
@@ -41,7 +41,7 @@ Adds "infinite" pagination to the component it is used with.
|
|||||||
| isLoading | `boolean` | false | Is a new page loading? |
|
| isLoading | `boolean` | false | Is a new page loading? |
|
||||||
| pageSize | `number` | | Number of items that are added with each "load more" event. |
|
| pageSize | `number` | | Number of items that are added with each "load more" event. |
|
||||||
| pagination | [`PaginationModel`](../../lib/core/models/pagination.model.ts) | | (**Deprecated:** 2.3.0) [Pagination](../../lib/content-services/document-list/models/document-library.model.ts) object. |
|
| pagination | [`PaginationModel`](../../lib/core/models/pagination.model.ts) | | (**Deprecated:** 2.3.0) [Pagination](../../lib/content-services/document-list/models/document-library.model.ts) object. |
|
||||||
| target | `PaginatedComponent` | | Component that provides custom pagination support. |
|
| target | [`PaginatedComponent`](../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. |
|
||||||
|
|
||||||
### Events
|
### Events
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Info drawer layout component
|
# [Info drawer layout component](../../lib/core/info-drawer/info-drawer-layout.component.ts "Defined in info-drawer-layout.component.ts")
|
||||||
|
|
||||||
Displays a sidebar-style information panel.
|
Displays a sidebar-style information panel.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Info Drawer Tab component
|
# [Info Drawer Tab component](../../lib/core/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts")
|
||||||
|
|
||||||
Renders tabs in a [Info drawer component](../core/info-drawer.component.md).
|
Renders tabs in a [Info drawer component](../core/info-drawer.component.md).
|
||||||
|
|
||||||
@@ -53,7 +53,7 @@ Render tab with icon instead of labels:
|
|||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
| ---- | ---- | ------------- | ----------- |
|
| ---- | ---- | ------------- | ----------- |
|
||||||
| icon | `string` | null | Icon to render for the tab. |
|
| icon | `string` | null | Icon to render for the tab. |
|
||||||
| label | `string` | "Main tab" | The title of the tab. |
|
| label | `string` | "" | The title of the tab. |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Info Drawer component
|
# [Info Drawer component](../../lib/core/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts")
|
||||||
|
|
||||||
Displays a sidebar-style information panel with tabs.
|
Displays a sidebar-style information panel with tabs.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-09
|
Last reviewed: 2018-11-09
|
||||||
---
|
---
|
||||||
|
|
||||||
# Language Menu component
|
# [Language Menu component](../../lib/core/language-menu/language-menu.component.ts "Defined in language-menu.component.ts")
|
||||||
|
|
||||||
Displays all the languages that are present in "app.config.json" and the default (EN).
|
Displays all the languages that are present in "app.config.json" and the default (EN).
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Log Service
|
# [Log Service](../../lib/core/services/log.service.ts "Defined in log.service.ts")
|
||||||
|
|
||||||
Provides log functionality.
|
Provides log functionality.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-10-02
|
Last reviewed: 2018-10-02
|
||||||
---
|
---
|
||||||
|
|
||||||
# Login Dialog Panel component
|
# [Login Dialog Panel component](../../lib/core/login/components/login-dialog-panel.component.ts "Defined in login-dialog-panel.component.ts")
|
||||||
|
|
||||||
Shows and manages a login dialog.
|
Shows and manages a login dialog.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-10-02
|
Last reviewed: 2018-10-02
|
||||||
---
|
---
|
||||||
|
|
||||||
# Login Dialog component
|
# [Login Dialog component](../../lib/core/login/components/login-dialog.component.ts "Defined in login-dialog.component.ts")
|
||||||
|
|
||||||
Allows a user to perform a login via a dialog.
|
Allows a user to perform a login via a dialog.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-10-02
|
Last reviewed: 2018-10-02
|
||||||
---
|
---
|
||||||
|
|
||||||
# Login Dialog service
|
# [Login Dialog service](../../lib/core/services/login-dialog.service.ts "Defined in login-dialog.service.ts")
|
||||||
|
|
||||||
Manages login dialogs.
|
Manages login dialogs.
|
||||||
|
|
||||||
@@ -27,5 +27,5 @@ dialog directly from HTML.
|
|||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Login dialog component](login-dialog.component.md)
|
- [Login dialog component](login-dialog.component.md)
|
||||||
- [Login component](login.component.md)
|
- [Login component](login.component.md)
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Login component
|
# [Login component](../../lib/core/login/components/login.component.ts "Defined in login.component.ts")
|
||||||
|
|
||||||
Authenticates to Alfresco Content Services and Alfresco Process Services.
|
Authenticates to Alfresco Content Services and Alfresco Process Services.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Logout directive
|
# [Logout directive](../../lib/core/directives/logout.directive.ts "Defined in logout.directive.ts")
|
||||||
|
|
||||||
Logs the user out when the decorated element is clicked.
|
Logs the user out when the decorated element is clicked.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Mime Type Icon pipe
|
# [Mime Type Icon pipe](../../lib/core/pipes/mime-type-icon.pipe.ts "Defined in mime-type-icon.pipe.ts")
|
||||||
|
|
||||||
Retrieves an icon to represent a MIME type.
|
Retrieves an icon to represent a MIME type.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Node Delete directive
|
# [Node Delete directive](../../lib/core/directives/node-delete.directive.ts "Defined in node-delete.directive.ts")
|
||||||
|
|
||||||
Deletes multiple files and folders.
|
Deletes multiple files and folders.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Node Favorite directive
|
# [Node Favorite directive](../../lib/core/directives/node-favorite.directive.ts "Defined in node-favorite.directive.ts")
|
||||||
|
|
||||||
Selectively toggles nodes as favorites.
|
Selectively toggles nodes as favorites.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Node Name Tooltip pipe
|
# [Node Name Tooltip pipe](../../lib/core/pipes/node-name-tooltip.pipe.ts "Defined in node-name-tooltip.pipe.ts")
|
||||||
|
|
||||||
Formats the tooltip for a Node.
|
Formats the tooltip for a Node.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Node Permission directive
|
# [Node Permission directive](../../lib/core/directives/node-permission.directive.ts "Defined in node-permission.directive.ts")
|
||||||
|
|
||||||
Selectively disables an HTML element or Angular component.
|
Selectively disables an HTML element or Angular component.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Node Restore directive
|
# [Node Restore directive](../../lib/core/directives/node-restore.directive.ts "Defined in node-restore.directive.ts")
|
||||||
|
|
||||||
Restores deleted nodes to their original location.
|
Restores deleted nodes to their original location.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Node Service
|
# [Node Service](../../lib/core/form/services/node.service.ts "Defined in node.service.ts")
|
||||||
|
|
||||||
Gets Alfresco Repository node metadata and creates nodes with metadata.
|
Gets Alfresco Repository node metadata and creates nodes with metadata.
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ Gets Alfresco Repository node metadata and creates nodes with metadata.
|
|||||||
Create a new Node from form metadata.
|
Create a new Node from form metadata.
|
||||||
- _nodeType:_ `string` - Node type
|
- _nodeType:_ `string` - Node type
|
||||||
- _nameSpace:_ `any` - Namespace for properties
|
- _nameSpace:_ `any` - Namespace for properties
|
||||||
- _data:_ `any` - Property data to store in the node under namespace
|
- _data:_ `any` - [Property](../../lib/content-services/content-metadata/interfaces/property.interface.ts) data to store in the node under namespace
|
||||||
- _path:_ `string` - Path to the node
|
- _path:_ `string` - Path to the node
|
||||||
- _name:_ `string` - (Optional) Node name
|
- _name:_ `string` - (Optional) Node name
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - The created node
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - The created node
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Nodes Api service
|
# [Nodes Api service](../../lib/core/services/nodes-api.service.ts "Defined in nodes-api.service.ts")
|
||||||
|
|
||||||
Accesses and manipulates ACS document nodes using their node IDs.
|
Accesses and manipulates ACS document nodes using their node IDs.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Notification Service
|
# [Notification Service](../../lib/core/services/notification.service.ts "Defined in notification.service.ts")
|
||||||
|
|
||||||
Shows a notification message with optional feedback.
|
Shows a notification message with optional feedback.
|
||||||
|
|
||||||
@@ -15,6 +15,8 @@ Shows a notification message with optional feedback.
|
|||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
|
|
||||||
|
- **dismissSnackMessageAction**()<br/>
|
||||||
|
dismiss the notification snackbar
|
||||||
- **openSnackMessage**(message: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../core/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
|
- **openSnackMessage**(message: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../core/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
|
||||||
Opens a SnackBar notification to show a message.
|
Opens a SnackBar notification to show a message.
|
||||||
- _message:_ `string` - The message (or resource key) to show.
|
- _message:_ `string` - The message (or resource key) to show.
|
||||||
@@ -26,8 +28,6 @@ Shows a notification message with optional feedback.
|
|||||||
- _action:_ `string` - Caption for the response button
|
- _action:_ `string` - Caption for the response button
|
||||||
- _config:_ `number|MatSnackBarConfig` - Time before notification disappears after being shown or MatSnackBarConfig object
|
- _config:_ `number|MatSnackBarConfig` - Time before notification disappears after being shown or MatSnackBarConfig object
|
||||||
- **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>` - Information/control object for the SnackBar
|
- **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>` - Information/control object for the SnackBar
|
||||||
- **dismissSnackMessageAction()**<br/>
|
|
||||||
dismiss the notification snackbar
|
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-19
|
Last reviewed: 2018-11-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# Page Title service
|
# [Page Title service](../../lib/core/services/page-title.service.ts "Defined in page-title.service.ts")
|
||||||
|
|
||||||
Sets the page title.
|
Sets the page title.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Pagination Component
|
# [Pagination Component](../../lib/core/pagination/pagination.component.ts "Defined in pagination.component.ts")
|
||||||
|
|
||||||
Adds pagination to the component it is used with.
|
Adds pagination to the component it is used with.
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ Adds pagination to the component it is used with.
|
|||||||
| ---- | ---- | ------------- | ----------- |
|
| ---- | ---- | ------------- | ----------- |
|
||||||
| pagination | [`PaginationModel`](../../lib/core/models/pagination.model.ts) | | [Pagination](../../lib/content-services/document-list/models/document-library.model.ts) object. |
|
| pagination | [`PaginationModel`](../../lib/core/models/pagination.model.ts) | | [Pagination](../../lib/content-services/document-list/models/document-library.model.ts) object. |
|
||||||
| supportedPageSizes | `number[]` | | An array of page sizes. |
|
| supportedPageSizes | `number[]` | | An array of page sizes. |
|
||||||
| target | `PaginatedComponent` | | Component that provides custom pagination support. |
|
| target | [`PaginatedComponent`](../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. |
|
||||||
|
|
||||||
### Events
|
### Events
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-04-06
|
Last reviewed: 2018-04-06
|
||||||
---
|
---
|
||||||
|
|
||||||
# People Content service
|
# [People Content service](../../lib/core/services/people-content.service.ts "Defined in people-content.service.ts")
|
||||||
|
|
||||||
Gets information about a Content Services user.
|
Gets information about a Content Services user.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-04-05
|
Last reviewed: 2018-04-05
|
||||||
---
|
---
|
||||||
|
|
||||||
# People Process service
|
# [People Process service](../../lib/core/services/people-process.service.ts "Defined in people-process.service.ts")
|
||||||
|
|
||||||
Gets information about Process Services users.
|
Gets information about Process Services users.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Process Content Service
|
# [Process Content Service](../../lib/core/form/services/process-content.service.ts "Defined in process-content.service.ts")
|
||||||
|
|
||||||
Manipulates content related to a Process Instance or Task Instance in APS.
|
Manipulates content related to a Process Instance or Task Instance in APS.
|
||||||
|
|
||||||
@@ -16,14 +16,14 @@ Manipulates content related to a Process Instance or Task Instance in APS.
|
|||||||
Associates an uploaded file with a process instance.
|
Associates an uploaded file with a process instance.
|
||||||
- _processInstanceId:_ `string` - ID of the target process instance
|
- _processInstanceId:_ `string` - ID of the target process instance
|
||||||
- _content:_ `any` - File to associate
|
- _content:_ `any` - File to associate
|
||||||
- _opts:_ `any` - (Optional) Options supported by JSAPI
|
- _opts:_ `any` - (Optional) Options supported by JS-API
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Details of created content
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Details of created content
|
||||||
- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): `any`<br/>
|
||||||
Associates an uploaded file with a task instance.
|
Associates an uploaded file with a task instance.
|
||||||
- _taskId:_ `string` - ID of the target task
|
- _taskId:_ `string` - ID of the target task
|
||||||
- _file:_ `any` - File to associate
|
- _file:_ `any` - File to associate
|
||||||
- _opts:_ `any` - (Optional) Options supported by JSAPI
|
- _opts:_ `any` - (Optional) Options supported by JS-API
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Details of created content
|
- **Returns** `any` - Details of created content
|
||||||
- **createTemporaryRawRelatedContent**(file: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`<br/>
|
- **createTemporaryRawRelatedContent**(file: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`<br/>
|
||||||
Create temporary related content from an uploaded file.
|
Create temporary related content from an uploaded file.
|
||||||
- _file:_ `any` - File to use for content
|
- _file:_ `any` - File to use for content
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Product Version model
|
# [Product Version model](../../lib/core/models/product-version.model.ts "Defined in product-version.model.ts")
|
||||||
|
|
||||||
Contains version and license information classes for Alfresco products.
|
Contains version and license information classes for Alfresco products.
|
||||||
|
|
||||||
|
|||||||
@@ -4,22 +4,22 @@ Added: v2.0.0
|
|||||||
Status: Deprecated
|
Status: Deprecated
|
||||||
---
|
---
|
||||||
|
|
||||||
# Renditions service
|
# [Renditions service](../../lib/core/services/renditions.service.ts "Defined in renditions.service.ts")
|
||||||
|
|
||||||
Manages prearranged conversions of content to different formats.
|
Manages prearranged conversions of content to different formats.
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
`isRenditionAvailable(nodeId: string, encoding: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
`isRenditionAvailable(nodeId: string, encoding: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||||
Has the specified rendition been set up for this item?
|
Has the specified rendition been set up for this item?
|
||||||
|
|
||||||
`isConversionPossible(nodeId: string, encoding: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
`isConversionPossible(nodeId: string, encoding: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||||
Is it possible to convert this item to the specified format?
|
Is it possible to convert this item to the specified format?
|
||||||
|
|
||||||
`getRenditionUrl(nodeId: string, encoding: string): string`<br/>
|
`getRenditionUrl(nodeId: string, encoding: string): string`<br/>
|
||||||
Gets a URL linking to a rendition.
|
Gets a URL linking to a rendition.
|
||||||
|
|
||||||
`getRenditionsListByNodeId(nodeId: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`<RenditionPaging>`<br/>
|
`getRenditionsListByNodeId(nodeId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<RenditionPaging>`<br/>
|
||||||
Gets all available renditions for an item.
|
Gets all available renditions for an item.
|
||||||
|
|
||||||
`convert(nodeId: string, encoding: string, pollingInterval: number = 1000)`<br/>
|
`convert(nodeId: string, encoding: string, pollingInterval: number = 1000)`<br/>
|
||||||
|
|||||||
@@ -1,22 +0,0 @@
|
|||||||
---
|
|
||||||
Title: Search Api service
|
|
||||||
Added: v2.0.0
|
|
||||||
Status: Active
|
|
||||||
---
|
|
||||||
|
|
||||||
# Search Api service
|
|
||||||
|
|
||||||
Accesses the Content Services Search API.
|
|
||||||
|
|
||||||
## Class members
|
|
||||||
|
|
||||||
### Methods
|
|
||||||
|
|
||||||
[`search(query: any): Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
|
|
||||||
Searches the repository.
|
|
||||||
|
|
||||||
## Details
|
|
||||||
|
|
||||||
See the
|
|
||||||
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-search-rest-api/docs/SearchApi.md#search)
|
|
||||||
for the format of the query and returned data.
|
|
||||||
@@ -4,7 +4,7 @@ Added: v2.1.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Search Configuration interface
|
# [Search Configuration interface](../../lib/core/interface/search-configuration.interface.ts "Defined in search-configuration.interface.ts")
|
||||||
|
|
||||||
Provides fine control of parameters to a search.
|
Provides fine control of parameters to a search.
|
||||||
|
|
||||||
@@ -85,7 +85,7 @@ described below.
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
You also need to add the [`SearchService`](../../lib/core/services/search.service.ts) as a provider to avoid overriding the module instance. This component will have his own instance of the [`SearchService`](../../lib/core/services/search.service.ts) that will use the class you have provided
|
You also need to add the [`SearchService`](../core/search.service.md) as a provider to avoid overriding the module instance. This component will have his own instance of the [`SearchService`](../core/search.service.md) that will use the class you have provided
|
||||||
as its configuration.
|
as its configuration.
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-09-13
|
Last reviewed: 2018-09-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Search Configuration service
|
# [Search Configuration service](../../lib/core/services/search-configuration.service.ts "Defined in search-configuration.service.ts")
|
||||||
|
|
||||||
Provides fine control of parameters to a search.
|
Provides fine control of parameters to a search.
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
---
|
||||||
|
Title: Search service
|
||||||
|
Added: v2.0.0
|
||||||
|
Status: Active
|
||||||
|
---
|
||||||
|
|
||||||
|
# [Search service](../../lib/core/services/search.service.ts "Defined in search.service.ts")
|
||||||
|
|
||||||
|
Accesses the Content Services Search API.
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
|
- **getNodeQueryResults**(term: `string`, options?: [`SearchOptions`](../../lib/core/services/search.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
|
||||||
|
|
||||||
|
- _term:_ `string` -
|
||||||
|
- _options:_ [`SearchOptions`](../../lib/core/services/search.service.ts) - (Optional) (Optional)
|
||||||
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` -
|
||||||
|
|
||||||
|
- **search**(searchTerm: `string`, maxResults: `number`, skipCount: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
|
||||||
|
|
||||||
|
- _searchTerm:_ `string` -
|
||||||
|
- _maxResults:_ `number` -
|
||||||
|
- _skipCount:_ `number` -
|
||||||
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` -
|
||||||
|
|
||||||
|
- **searchByQueryBody**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
|
||||||
|
|
||||||
|
- _queryBody:_ `QueryBody` -
|
||||||
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` -
|
||||||
|
|
||||||
|
## Details
|
||||||
|
|
||||||
|
See the
|
||||||
|
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-search-rest-api/docs/SearchApi.md#search)
|
||||||
|
for the format of the query and returned data.
|
||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Shared Links Api service
|
# [Shared Links Api service](../../lib/core/services/shared-links-api.service.ts "Defined in shared-links-api.service.ts")
|
||||||
|
|
||||||
Finds shared links to Content Services items.
|
Finds shared links to Content Services items.
|
||||||
|
|
||||||
@@ -16,7 +16,7 @@ Finds shared links to Content Services items.
|
|||||||
- **createSharedLinks**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SharedLinkEntry>`<br/>
|
- **createSharedLinks**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SharedLinkEntry>`<br/>
|
||||||
Creates a shared link available to the current user.
|
Creates a shared link available to the current user.
|
||||||
- _nodeId:_ `string` - ID of the node to link to
|
- _nodeId:_ `string` - ID of the node to link to
|
||||||
- _options:_ `any` - Options supported by JSAPI
|
- _options:_ `any` - Options supported by JS-API
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SharedLinkEntry>` - The shared link just created
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SharedLinkEntry>` - The shared link just created
|
||||||
- **deleteSharedLink**(sharedId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SharedLinkEntry>`<br/>
|
- **deleteSharedLink**(sharedId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SharedLinkEntry>`<br/>
|
||||||
Deletes a shared link.
|
Deletes a shared link.
|
||||||
@@ -24,7 +24,7 @@ Finds shared links to Content Services items.
|
|||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SharedLinkEntry>` - Null response notifying when the operation is complete
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SharedLinkEntry>` - Null response notifying when the operation is complete
|
||||||
- **getSharedLinks**(options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
|
- **getSharedLinks**(options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
|
||||||
Gets shared links available to the current user.
|
Gets shared links available to the current user.
|
||||||
- _options:_ `any` - Options supported by JSAPI
|
- _options:_ `any` - Options supported by JS-API
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of shared links
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of shared links
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Sidebar action menu component
|
# [Sidebar action menu component](../../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts "Defined in sidebar-action-menu.component.ts")
|
||||||
|
|
||||||
Displays a sidebar-action menu information panel.
|
Displays a sidebar-action menu information panel.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Sidenav Layout component
|
# [Sidenav Layout component](../../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts "Defined in sidenav-layout.component.ts")
|
||||||
|
|
||||||
Displays the standard three-region ADF application layout.
|
Displays the standard three-region ADF application layout.
|
||||||
|
|
||||||
|
|||||||
@@ -1,51 +0,0 @@
|
|||||||
---
|
|
||||||
Title: Site model
|
|
||||||
Added: v2.0.0
|
|
||||||
Status: Active
|
|
||||||
---
|
|
||||||
|
|
||||||
# Site model
|
|
||||||
|
|
||||||
Provides information about a site in a Content Services repository.
|
|
||||||
|
|
||||||
## Details
|
|
||||||
|
|
||||||
`SiteModel` is returned by methods from the [Sites Api service](sites.service.md).
|
|
||||||
Also, the
|
|
||||||
[`getSite`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSite)
|
|
||||||
and
|
|
||||||
[`getSites`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSites) pages in the Alfresco JS API docs have further information about this API.
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class SiteModel {
|
|
||||||
role: string;
|
|
||||||
visibility: string;
|
|
||||||
guid: string;
|
|
||||||
description: string;
|
|
||||||
id: string;
|
|
||||||
preset: string;
|
|
||||||
title: string;
|
|
||||||
contents: SiteContentsModel[] = [];
|
|
||||||
members: SiteMembersModel[] = [];
|
|
||||||
pagination: Pagination;
|
|
||||||
}
|
|
||||||
|
|
||||||
class SiteContentsModel {
|
|
||||||
id: string;
|
|
||||||
folderId: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
class SiteMembersModel {
|
|
||||||
role: string;
|
|
||||||
firstName: string;
|
|
||||||
emailNotificationsEnabled: boolean = false;
|
|
||||||
company: any;
|
|
||||||
id: string;
|
|
||||||
enable: boolean = false;
|
|
||||||
email: string;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## See also
|
|
||||||
|
|
||||||
- [Sites service](sites.service.md)
|
|
||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Sites service
|
# [Sites service](../../lib/core/services/sites.service.ts "Defined in sites.service.ts")
|
||||||
|
|
||||||
Accesses and manipulates sites from a Content Services repository.
|
Accesses and manipulates sites from a Content Services repository.
|
||||||
|
|
||||||
@@ -42,8 +42,6 @@ Accesses and manipulates sites from a Content Services repository.
|
|||||||
## Details
|
## Details
|
||||||
|
|
||||||
You can use `getSites` to get a list of all sites in the repository.
|
You can use `getSites` to get a list of all sites in the repository.
|
||||||
The sites are returned as [`Observable`](http://reactivex.io/documentation/observable.html)`<SiteModel[]>` (see
|
|
||||||
[Site Model](site.model.md) for more information about this class).
|
|
||||||
If you are only interested in a single site and you have its ID, you
|
If you are only interested in a single site and you have its ID, you
|
||||||
can use `getSite` to access it. Alternatively, you can use `getSiteContent`
|
can use `getSite` to access it. Alternatively, you can use `getSiteContent`
|
||||||
or `getSiteMembers` to extract just the `contents` and `members` properties
|
or `getSiteMembers` to extract just the `contents` and `members` properties
|
||||||
@@ -59,7 +57,3 @@ options. See the Alfresco JS API docs about
|
|||||||
and
|
and
|
||||||
[getSite](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSite)
|
[getSite](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSite)
|
||||||
for more information about the available options.
|
for more information about the available options.
|
||||||
|
|
||||||
## See also
|
|
||||||
|
|
||||||
- [Site model](site.model.md)
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Sorting Picker Component
|
# [Sorting Picker Component](../../lib/core/sorting-picker/sorting-picker.component.ts "Defined in sorting-picker.component.ts")
|
||||||
|
|
||||||
Selects from a set of predefined sorting definitions and directions.
|
Selects from a set of predefined sorting definitions and directions.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Start Form component
|
# [Start Form component](../../lib/core/form/components/start-form.component.ts "Defined in start-form.component.ts")
|
||||||
|
|
||||||
Displays the Start [`Form`](../../lib/process-services/task-list/models/form.model.ts) for a process.
|
Displays the Start [`Form`](../../lib/process-services/task-list/models/form.model.ts) for a process.
|
||||||
|
|
||||||
@@ -26,10 +26,10 @@ Displays the Start [`Form`](../../lib/process-services/task-list/models/form.mod
|
|||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
| ---- | ---- | ------------- | ----------- |
|
| ---- | ---- | ------------- | ----------- |
|
||||||
| data | `FormValues` | | Custom form values map to be used with the rendered form. |
|
| data | [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. |
|
||||||
| disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. |
|
| disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. |
|
||||||
| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. |
|
| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. |
|
||||||
| fieldValidators | `FormFieldValidator[]` | \[] | Contains a list of form field validator instances. |
|
| fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. |
|
||||||
| form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. |
|
| form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. |
|
||||||
| formId | `string` | | The id of the form definition to load and display with custom values. |
|
| formId | `string` | | The id of the form definition to load and display with custom values. |
|
||||||
| formName | `string` | | Name of the form definition to load and display with custom values. |
|
| formName | `string` | | Name of the form definition to load and display with custom values. |
|
||||||
@@ -58,10 +58,10 @@ Displays the Start [`Form`](../../lib/process-services/task-list/models/form.mod
|
|||||||
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
|
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
|
||||||
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when a field of the form is clicked. |
|
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when a field of the form is clicked. |
|
||||||
| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. |
|
| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. |
|
||||||
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../core/form-field.model.md)`[]>` | Emitted when form validations has validation error. |
|
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../core/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
|
||||||
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
|
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
|
||||||
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
|
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
|
||||||
| onError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
|
| onError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | (**Deprecated:** in 2.4.0, will be renamed as "error" in 3.x.x) Emitted when any error occurs. |
|
||||||
| outcomeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user clicks one of the outcome buttons that completes the form. |
|
| outcomeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user clicks one of the outcome buttons that completes the form. |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-14
|
Last reviewed: 2018-11-14
|
||||||
---
|
---
|
||||||
|
|
||||||
# Storage service
|
# [Storage service](../../lib/core/services/storage.service.ts "Defined in storage.service.ts")
|
||||||
|
|
||||||
Stores items in the form of key-value pairs.
|
Stores items in the form of key-value pairs.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Added: v2.0.0
|
|||||||
Status: Active
|
Status: Active
|
||||||
---
|
---
|
||||||
|
|
||||||
# Text Highlight pipe
|
# [Text Highlight pipe](../../lib/core/pipes/text-highlight.pipe.ts "Defined in text-highlight.pipe.ts")
|
||||||
|
|
||||||
Adds highlighting to words or sections of text that match a search string.
|
Adds highlighting to words or sections of text that match a search string.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-20
|
Last reviewed: 2018-11-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Text Mask directive
|
# [Text Mask directive](../../lib/core/form/components/widgets/text/text-mask.component.ts "Defined in text-mask.component.ts")
|
||||||
|
|
||||||
Implements text field input masks.
|
Implements text field input masks.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-13
|
Last reviewed: 2018-11-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Thumbnail service
|
# [Thumbnail service](../../lib/core/services/thumbnail.service.ts "Defined in thumbnail.service.ts")
|
||||||
|
|
||||||
Retrieves an SVG thumbnail image to represent a document type.
|
Retrieves an SVG thumbnail image to represent a document type.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-11-19
|
Last reviewed: 2018-11-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# Time Ago pipe
|
# [Time Ago pipe](../../lib/core/pipes/time-ago.pipe.ts "Defined in time-ago.pipe.ts")
|
||||||
|
|
||||||
Converts a recent past date into a number of days ago.
|
Converts a recent past date into a number of days ago.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Toolbar Divider Component
|
# [Toolbar Divider Component](../../lib/core/toolbar/toolbar-divider.component.ts "Defined in toolbar-divider.component.ts")
|
||||||
|
|
||||||
Divides groups of elements in a Toolbar with a visual separator.
|
Divides groups of elements in a Toolbar with a visual separator.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Toolbar Title Component
|
# [Toolbar Title Component](../../lib/core/toolbar/toolbar-title.component.ts "Defined in toolbar-title.component.ts")
|
||||||
|
|
||||||
Supplies custom HTML to be included in a [Toolbar component](../core/toolbar.component.md) title.
|
Supplies custom HTML to be included in a [Toolbar component](../core/toolbar.component.md) title.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-08
|
Last reviewed: 2018-06-08
|
||||||
---
|
---
|
||||||
|
|
||||||
# Toolbar Component
|
# [Toolbar Component](../../lib/core/toolbar/toolbar.component.ts "Defined in toolbar.component.ts")
|
||||||
|
|
||||||
Simple container for headers, titles, actions and breadcrumbs.
|
Simple container for headers, titles, actions and breadcrumbs.
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Status: Active
|
|||||||
Last reviewed: 2018-06-07
|
Last reviewed: 2018-06-07
|
||||||
---
|
---
|
||||||
|
|
||||||
# Translation service
|
# [Translation service](../../lib/core/services/translation.service.ts "Defined in translation.service.ts")
|
||||||
|
|
||||||
Supports localisation.
|
Supports localisation.
|
||||||
|
|
||||||
@@ -27,6 +27,11 @@ Supports localisation.
|
|||||||
- _key:_ `string|Array<string>` - Key to translate
|
- _key:_ `string|Array<string>` - Key to translate
|
||||||
- _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/>
|
||||||
|
|
||||||
|
- _lang:_ `string` -
|
||||||
|
- _fallback:_ `string` - (Optional) (Optional)
|
||||||
|
|
||||||
- **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
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user