diff --git a/docs/README.md b/docs/README.md index fe7bacbcc7..cc8ea2c26f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,11 +13,11 @@ its main source file. Note that ADF is developed continuously, so the source fil Components are sometimes marked with an icon to show their status. No icon indicates that the component is complete and suitable for normal use. The other status levels are: -- **Deprecated** ![](docassets/images/DeprecatedIcon.png) - The component is still available +* **Deprecated** ![](docassets/images/DeprecatedIcon.png) - The component is still available but is now obsolete and will probably be removed in a future version of ADF. -- **Experimental** ![](docassets/images/ExperimentalIcon.png) - The component is available for +* **Experimental** ![](docassets/images/ExperimentalIcon.png) - The component is available for experimentation but not fully complete and tested for production code. -- **Internal** ![](docassets/images/InternalIcon.png) - The component is available for +* **Internal** ![](docassets/images/InternalIcon.png) - The component is available for internal test use but not meant to be used in production There is also a set of ADF tutorials that describe how to accomplish tasks step-by-step. @@ -25,45 +25,45 @@ See the [Tutorials index](tutorials/README.md) for the full list. A few other pages of information are also available: -- The [Version Index](versionIndex.md) has a list of components ordered by +* The [Version Index](versionIndex.md) has a list of components ordered by the ADF version where they were introduced. -- The [Release notes](release-notes/README.md) section has details of all +* The [Release notes](release-notes/README.md) section has details of all the features introduced and bugs fixed with each release. -- The [Version compatibility](compatibility.md) page shows which versions +* The [Version compatibility](compatibility.md) page shows which versions of Alfresco's backend servies (ACS and APS) are compatible with each released version of ADF. -- The [Roadmap](roadmap.md) +* The [Roadmap](roadmap.md) contains a preview of features we hope to release in future versions of ADF. -- The [License info](license-info/README.md) section lists the third-party libraries used by ADF along with links to their Open Source licenses. -- The [Vulnerability](vulnerability/README.md) section lists the third-party +* The [License info](license-info/README.md) section lists the third-party libraries used by ADF along with links to their Open Source licenses. +* The [Vulnerability](vulnerability/README.md) section lists the third-party libraries known vulnerability. libraries used by ADF along with links to their Open Source licenses. -- The [Breaking changes](breaking-changes/breaking-change-2.6.0-3.0.0.md) section lists +* The [Breaking changes](breaking-changes/breaking-change-2.6.0-3.0.0.md) section lists all breaking changes between major versions, such as removal of deprecated items. -- The [Upgrade guide](upgrade-guide/README.md) explains how to upgrade your project from an earlier version of ADF to the current version. +* The [Upgrade guide](upgrade-guide/README.md) explains how to upgrade your project from an earlier version of ADF to the current version. ## Contents -- [User Guide](#user-guide) -- [Core API](#core-api) -- [Content Services API](#content-services-api) -- [Process Services API](#process-services-api) -- [Process Services Cloud API](#process-services-cloud-api) -- [Extensions API](#extensions-api) -- [Insights API](#insights-api) +* [User Guide](#user-guide) +* [Core API](#core-api) +* [Content Services API](#content-services-api) +* [Process Services API](#process-services-api) +* [Process Services Cloud API](#process-services-cloud-api) +* [Extensions API](#extensions-api) +* [Insights API](#insights-api) ## User guide -- [Angular Material Design](user-guide/angular-material-design.md) -- [Form Extensibility and Customisation](user-guide/extensibility.md) -- [Internationalization in ADF](user-guide/internationalization.md) -- [Localization in ADF](user-guide/localization.md) -- [Theming](user-guide/theming.md) -- [Transclusion](user-guide/transclusion.md) -- [Typography](user-guide/typography.md) -- [Walkthrough - adding indicators to highlight information about a node](user-guide/metadata-indicators.md) +* [Angular Material Design](user-guide/angular-material-design.md) +* [Form Extensibility and Customisation](user-guide/extensibility.md) +* [Internationalization in ADF](user-guide/internationalization.md) +* [Localization in ADF](user-guide/localization.md) +* [Theming](user-guide/theming.md) +* [Transclusion](user-guide/transclusion.md) +* [Typography](user-guide/typography.md) +* [Walkthrough - adding indicators to highlight information about a node](user-guide/metadata-indicators.md) @@ -80,164 +80,164 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| [About Application Modules Component](core/components/about-application.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which ADF libraries and plugins an application is using. | [Source](../lib/core/about/about-application-modules/about-application-modules.component.ts) | -| [About GitHub Link Component](core/components/about-github-link.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application. | [Source](../lib/core/about/about-github-link/about-github-link.component.ts) | -| [About Product Version Component](core/components/about-product-version.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application. | [Source](../lib/core/about/about-product-version/about-product-version.component.ts) | -| [Buttons Menu Component](core/components/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/buttons-menu/buttons-menu.component.ts) | -| [Card View component](core/components/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/components/comment-list.component.md) | Shows a list of comments. | [Source](../lib/core/comments/comment-list.component.ts) | -| [Comments Component](core/components/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) | -| [Data Column Component](core/components/data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) | -| [DataTable component](core/components/datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) | -| [Empty Content Component](core/components/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../lib/core/templates/empty-content/empty-content.component.ts) | -| [Empty list component](core/components/empty-list.component.md) | Displays a message indicating that a list is empty. | [Source](../lib/core/datatable/components/empty-list/empty-list.component.ts) | -| [Error Content Component](core/components/error-content.component.md) | Displays info about a specific error. | [Source](../lib/core/templates/error-content/error-content.component.ts) | -| [Form field component](core/components/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/components/form-list.component.md) | Shows forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | -| [Header component](core/components/header.component.md) | Reusable header for Alfresco applications. | [Source](../lib/core/layout/components/header/header.component.ts) | -| [Host settings component](core/components/host-settings.component.md) ![Internal](docassets/images/InternalIcon.png) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | -| [Icon Component](core/components/icon.component.md) | Provides a universal way of rendering registered and named icons. | [Source](../lib/core/icon/icon.component.ts) | -| [Infinite Pagination component](core/components/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | -| [Info drawer layout component](core/components/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | -| [Info Drawer Tab component](core/components/info-drawer-tab.component.md) | Renders tabs in a Info drawer component. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | -| [Info Drawer component](core/components/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | -| [Json Cell component](core/components/json-cell.component.md) | Shows a JSON-formatted value inside a datatable component. | [Source](../lib/core/datatable/components/json-cell/json-cell.component.ts) | -| [Language Menu component](core/components/language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) | -| [Login Dialog Panel component](core/components/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/login/components/login-dialog-panel.component.ts) | -| [Login Dialog component](core/components/login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../lib/core/login/components/login-dialog.component.ts) | -| [Login component](core/components/login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | -| [Notification History component](core/components/notification-history.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component is in the current status just an experimental component. | | -| The main purpose of the Notification history component is list all the notification received in the current session. They will disappear from the list after the refresh. | [Source](../lib/core/notifications/components/notification-history.component.ts) | | -| [Pagination Component](core/components/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | -| [Search Text Input Component](core/components/search-text-input.component.md) | Displays a input text that supports autocompletion | [Source](../lib/core/search-text/search-text-input.component.ts) | -| [Sidebar action menu component](core/components/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) | -| [Sidenav Layout component](core/components/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) | -| [Sorting Picker Component](core/components/sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../lib/core/sorting-picker/sorting-picker.component.ts) | -| [Start Form component](core/components/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/process-services/src/lib/form/start-form.component.ts) | -| [Text Mask directive](core/components/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) | -| [Toolbar Divider Component](core/components/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/components/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | -| [Toolbar Component](core/components/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) | -| [User Info component](core/components/user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) | -| [Viewer component](core/components/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [About Application Modules Component](core/components/about-application.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which ADF libraries and plugins an application is using. | [Source](../lib/core/about/about-application-modules/about-application-modules.component.ts) | +| [About GitHub Link Component](core/components/about-github-link.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application. | [Source](../lib/core/about/about-github-link/about-github-link.component.ts) | +| [About Product Version Component](core/components/about-product-version.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application. | [Source](../lib/core/about/about-product-version/about-product-version.component.ts) | +| [Buttons Menu Component](core/components/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/buttons-menu/buttons-menu.component.ts) | +| [Card View component](core/components/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/components/comment-list.component.md) | Shows a list of comments. | [Source](../lib/core/comments/comment-list.component.ts) | +| [Comments Component](core/components/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) | +| [Data Column Component](core/components/data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) | +| [DataTable component](core/components/datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) | +| [Empty Content Component](core/components/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../lib/core/templates/empty-content/empty-content.component.ts) | +| [Empty list component](core/components/empty-list.component.md) | Displays a message indicating that a list is empty. | [Source](../lib/core/datatable/components/empty-list/empty-list.component.ts) | +| [Error Content Component](core/components/error-content.component.md) | Displays info about a specific error. | [Source](../lib/core/templates/error-content/error-content.component.ts) | +| [Form field component](core/components/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/components/form-list.component.md) | Shows forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | +| [Header component](core/components/header.component.md) | Reusable header for Alfresco applications. | [Source](../lib/core/layout/components/header/header.component.ts) | +| [Host settings component](core/components/host-settings.component.md) ![Internal](docassets/images/InternalIcon.png) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | +| [Icon Component](core/components/icon.component.md) | Provides a universal way of rendering registered and named icons. | [Source](../lib/core/icon/icon.component.ts) | +| [Infinite Pagination component](core/components/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | +| [Info drawer layout component](core/components/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | +| [Info Drawer Tab component](core/components/info-drawer-tab.component.md) | Renders tabs in a Info drawer component. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | +| [Info Drawer component](core/components/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | +| [Json Cell component](core/components/json-cell.component.md) | Shows a JSON-formatted value inside a datatable component. | [Source](../lib/core/datatable/components/json-cell/json-cell.component.ts) | +| [Language Menu component](core/components/language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) | +| [Login Dialog Panel component](core/components/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/login/components/login-dialog-panel.component.ts) | +| [Login Dialog component](core/components/login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../lib/core/login/components/login-dialog.component.ts) | +| [Login component](core/components/login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | +| [Notification History component](core/components/notification-history.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component is in the current status just an experimental component. +The main purpose of the Notification history component is list all the notification received in the current session. They will disappear from the list after the refresh. | [Source](../lib/core/notifications/components/notification-history.component.ts) | +| [Pagination Component](core/components/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | +| [Search Text Input Component](core/components/search-text-input.component.md) | Displays a input text that supports autocompletion | [Source](../lib/core/search-text/search-text-input.component.ts) | +| [Sidebar action menu component](core/components/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) | +| [Sidenav Layout component](core/components/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) | +| [Sorting Picker Component](core/components/sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../lib/core/sorting-picker/sorting-picker.component.ts) | +| [Start Form component](core/components/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/process-services/src/lib/form/start-form.component.ts) | +| [Text Mask directive](core/components/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) | +| [Toolbar Divider Component](core/components/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/components/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | +| [Toolbar Component](core/components/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) | +| [User Info component](core/components/user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) | +| [Viewer component](core/components/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) | ### Directives -| Name | Description | Source link | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [Check Allowable Operation directive](core/directives/check-allowable-operation.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../lib/core/directives/check-allowable-operation.directive.ts) | -| [Clipboard directive](core/directives/clipboard.directive.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.directive.ts) | -| [Context Menu directive](core/directives/context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) | -| [Highlight directive](core/directives/highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) | -| [Logout directive](core/directives/logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) | -| [Node Delete directive](core/directives/node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/core/directives/node-delete.directive.ts) | -| [Node Download directive](core/directives/node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../lib/core/directives/node-download.directive.ts) | -| [Node Favorite directive](core/directives/node-favorite.directive.md) | Selectively toggles nodes as favorites. | [Source](../lib/core/directives/node-favorite.directive.ts) | -| [Node Restore directive](core/directives/node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/core/directives/node-restore.directive.ts) | -| [Upload Directive](core/directives/upload.directive.md) | Uploads content in response to file drag and drop. | [Source](../lib/core/directives/upload.directive.ts) | -| [Version Compatibility Directive](core/directives/version-compatibility.directive.md) | Enables/disables components based on ACS version in use. | [Source](../lib/core/directives/version-compatibility.directive.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Check Allowable Operation directive](core/directives/check-allowable-operation.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../lib/core/directives/check-allowable-operation.directive.ts) | +| [Clipboard directive](core/directives/clipboard.directive.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.directive.ts) | +| [Context Menu directive](core/directives/context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) | +| [Highlight directive](core/directives/highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) | +| [Logout directive](core/directives/logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) | +| [Node Delete directive](core/directives/node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/core/directives/node-delete.directive.ts) | +| [Node Download directive](core/directives/node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../lib/core/directives/node-download.directive.ts) | +| [Node Favorite directive](core/directives/node-favorite.directive.md) | Selectively toggles nodes as favorites. | [Source](../lib/core/directives/node-favorite.directive.ts) | +| [Node Restore directive](core/directives/node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/core/directives/node-restore.directive.ts) | +| [Upload Directive](core/directives/upload.directive.md) | Uploads content in response to file drag and drop. | [Source](../lib/core/directives/upload.directive.ts) | +| [Version Compatibility Directive](core/directives/version-compatibility.directive.md) | Enables/disables components based on ACS version in use. | [Source](../lib/core/directives/version-compatibility.directive.ts) | ### Dialogs -| Name | Description | Source link | -| ---------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------- | +| Name | Description | Source link | +| --- | --- | --| | [Edit JSON Dialog](core/dialogs/edit-json.dialog.md) | Allows a user to preview or edit a JSON content in a dialog. | [Source](../lib/testing/src/lib/core/dialog/edit-json-dialog.ts) | ### Interfaces -| Name | Description | Source link | -| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [Card View Item interface](core/interfaces/card-view-item.interface.md) | Defines the implementation of an item in a Card View component. | [Source](../lib/core/card-view/interfaces/card-view-item.interface.ts) | -| [DataTableAdapter interface](core/interfaces/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | -| [FormFieldValidator interface](core/interfaces/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | -| [Search Configuration interface](core/interfaces/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/interface/search-configuration.interface.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Card View Item interface](core/interfaces/card-view-item.interface.md) | Defines the implementation of an item in a Card View component. | [Source](../lib/core/card-view/interfaces/card-view-item.interface.ts) | +| [DataTableAdapter interface](core/interfaces/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | +| [FormFieldValidator interface](core/interfaces/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | +| [Search Configuration interface](core/interfaces/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/interface/search-configuration.interface.ts) | ### Models -| Name | Description | Source link | -| ------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [Bpm User model](core/models/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/models/bpm-user.model.ts) | -| [Ecm User model](core/models/ecm-user.model.md) | Contains information about a Content Services user. | [Source](../lib/core/models/ecm-user.model.ts) | -| [Form Field model](core/models/form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | -| [Product Version model](core/models/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/models/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Bpm User model](core/models/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/models/bpm-user.model.ts) | +| [Ecm User model](core/models/ecm-user.model.md) | Contains information about a Content Services user. | [Source](../lib/core/models/ecm-user.model.ts) | +| [Form Field model](core/models/form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | +| [Product Version model](core/models/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/models/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) | ### Pipes -| Name | Description | Source link | -| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------- | -| [App Config Pipe](core/pipes/app-config.pipe.md) | Retrieves values from the application configuration file directly. | [Source](../lib/core/app-config/app-config.pipe.ts) | -| [Decimal Number Pipe](core/pipes/decimal-number.pipe.md) | Transforms a number to have a certain amount of digits in its integer part and also in its decimal part. | [Source](../lib/core/pipes/decimal-number.pipe.ts) | -| [File Size pipe](core/pipes/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/pipes/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/pipes/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) | -| [Localized Date pipe](core/pipes/localized-date.pipe.md) | Converts a date to a given format and locale. | [Source](../lib/core/pipes/localized-date.pipe.ts) | -| [Mime Type Icon pipe](core/pipes/mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) | -| [Multi Value Pipe](core/pipes/multi-value.pipe.md) | Takes an array of strings and turns it into one string where items are separated by a separator. The default separator applied to the list is the comma , however, you can set your own separator in the params of the pipe. | [Source](../lib/core/pipes/multi-value.pipe.ts) | -| [Node Name Tooltip pipe](core/pipes/node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) | -| [Text Highlight pipe](core/pipes/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/pipes/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/pipes/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) | +| Name | Description | Source link | +| --- | --- | --| +| [App Config Pipe](core/pipes/app-config.pipe.md) | Retrieves values from the application configuration file directly. | [Source](../lib/core/app-config/app-config.pipe.ts) | +| [Decimal Number Pipe](core/pipes/decimal-number.pipe.md) | Transforms a number to have a certain amount of digits in its integer part and also in its decimal part. | [Source](../lib/core/pipes/decimal-number.pipe.ts) | +| [File Size pipe](core/pipes/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/pipes/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/pipes/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) | +| [Localized Date pipe](core/pipes/localized-date.pipe.md) | Converts a date to a given format and locale. | [Source](../lib/core/pipes/localized-date.pipe.ts) | +| [Mime Type Icon pipe](core/pipes/mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) | +| [Multi Value Pipe](core/pipes/multi-value.pipe.md) | Takes an array of strings and turns it into one string where items are separated by a separator. The default separator applied to the list is the comma , however, you can set your own separator in the params of the pipe. | [Source](../lib/core/pipes/multi-value.pipe.ts) | +| [Node Name Tooltip pipe](core/pipes/node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) | +| [Text Highlight pipe](core/pipes/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/pipes/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/pipes/user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | ### Services -| Name | Description | Source link | -| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [APS Alfresco Content Service](core/services/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) | -| [Alfresco Api Service](core/services/alfresco-api.service.md) | Provides access to an initialized AlfrescoJSApi instance. | [Source](../lib/core/services/alfresco-api.service.ts) | -| [App Config service](core/services/app-config.service.md) | Supports app configuration settings, stored server side. | [Source](../lib/core/app-config/app-config.service.ts) | -| [Apps Process service](core/services/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) | -| [Auth Guard Bpm service](core/services/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) | -| [Auth Guard Ecm service](core/services/auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) | -| [Auth Guard SSO Role service](core/services/auth-guard-sso-role.service.md) | Checks the user roles of a user. | [Source](../lib/core/services/auth-guard-sso-role.service.ts) | -| [Auth Guard service](core/services/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) | -| [Authentication Service](core/services/authentication.service.md) | Provides authentication to ACS and APS. | [Source](../lib/core/services/authentication.service.ts) | -| [Bpm User service](core/services/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/services/bpm-user.service.ts) | -| [Card Item Type service](core/services/card-item-types.service.md) | Maps type names to field component types for the Card View component. | [Source](../lib/core/card-view/services/card-item-types.service.ts) | -| [Card View Update service](core/services/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) | -| [Clipboard service](core/services/clipboard.service.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.service.ts) | -| [Comment Content service](core/services/comment-content.service.md) | Adds and retrieves comments for nodes in Content Services. | [Source](../lib/core/services/comment-content.service.ts) | -| [Comment Process service](core/services/comment-process.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../lib/core/services/comment-process.service.ts) | -| [Content service](core/services/content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/services/content.service.ts) | -| [Cookie service](core/services/cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/services/cookie.service.ts) | -| [Deleted Nodes Api service](core/services/deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/services/deleted-nodes-api.service.ts) | -| [Discovery Api service](core/services/discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/services/discovery-api.service.ts) | -| [Download zip service](core/services/download-zip.service.md) | Creates and manages downloads. | [Source](../lib/core/services/download-zip.service.ts) | -| [Ecm User service](core/services/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/ecm-user.service.ts) | -| [Favorites Api service](core/services/favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/services/favorites-api.service.ts) | -| [Form Rendering service](core/services/form-rendering.service.md) | Maps a form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | -| [Form service](core/services/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | -| [Highlight Transform service](core/services/highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/services/highlight-transform.service.ts) | -| [Identity Group service](core/services/identity-group.service.md) | Performs CRUD operations on identity groups. | [Source](../lib/core/services/identity-group.service.ts) | -| [Identity role service](core/services/identity-role.service.md) | Provides APIs for working with the Roles in Identity Services. | [Source](../lib/core/services/identity-role.service.ts) | -| [Identity user service](core/services/identity-user.service.md) | Gets OAuth2 personal details and roles for users and performs CRUD operations on identity users. | [Source](../lib/core/services/identity-user.service.ts) | -| [JWT helper service](core/services/jwt-helper.service.md) | Decodes a JSON Web Token (JWT) to a JavaScript object. | [Source](../lib/core/services/jwt-helper.service.ts) | -| [Log Service](core/services/log.service.md) | Provides log functionality. | [Source](../lib/core/services/log.service.ts) | -| [Login Dialog service](core/services/login-dialog.service.md) | Manages login dialogs. | [Source](../lib/core/services/login-dialog.service.ts) | -| [Node Service](core/services/node.service.md) | use Nodes Api service instead of this. | [Source](../lib/core/form/services/node.service.ts) | -| [Nodes Api service](core/services/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/services/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/notifications/services/notification.service.ts) | -| [Page Title service](core/services/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | -| [People Content service](core/services/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | -| [People Process service](core/services/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) | -| [Process Content Service](core/services/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) | -| [Renditions service](core/services/renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) | -| [Search Configuration service](core/services/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | -| [Search service](core/services/search.service.md) | Accesses the Content Services Search API. | [Source](../lib/core/services/search.service.ts) | -| [Shared Links Api service](core/services/shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../lib/core/services/shared-links-api.service.ts) | -| [Sites service](core/services/sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../lib/core/services/sites.service.ts) | -| [Storage service](core/services/storage.service.md) | Stores items in the form of key-value pairs. | [Source](../lib/core/services/storage.service.ts) | -| [Thumbnail service](core/services/thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../lib/core/services/thumbnail.service.ts) | -| [Translation service](core/services/translation.service.md) | Supports localisation. | [Source](../lib/core/services/translation.service.ts) | -| [Upload Service](core/services/upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/services/upload.service.ts) | -| [User Preferences Service](core/services/user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../lib/core/services/user-preferences.service.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [APS Alfresco Content Service](core/services/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) | +| [Alfresco Api Service](core/services/alfresco-api.service.md) | Provides access to an initialized AlfrescoJSApi instance. | [Source](../lib/core/services/alfresco-api.service.ts) | +| [App Config service](core/services/app-config.service.md) | Supports app configuration settings, stored server side. | [Source](../lib/core/app-config/app-config.service.ts) | +| [Apps Process service](core/services/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) | +| [Auth Guard Bpm service](core/services/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) | +| [Auth Guard Ecm service](core/services/auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) | +| [Auth Guard SSO Role service](core/services/auth-guard-sso-role.service.md) | Checks the user roles of a user. | [Source](../lib/core/services/auth-guard-sso-role.service.ts) | +| [Auth Guard service](core/services/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) | +| [Authentication Service](core/services/authentication.service.md) | Provides authentication to ACS and APS. | [Source](../lib/core/services/authentication.service.ts) | +| [Bpm User service](core/services/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/services/bpm-user.service.ts) | +| [Card Item Type service](core/services/card-item-types.service.md) | Maps type names to field component types for the Card View component. | [Source](../lib/core/card-view/services/card-item-types.service.ts) | +| [Card View Update service](core/services/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) | +| [Clipboard service](core/services/clipboard.service.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.service.ts) | +| [Comment Content service](core/services/comment-content.service.md) | Adds and retrieves comments for nodes in Content Services. | [Source](../lib/core/services/comment-content.service.ts) | +| [Comment Process service](core/services/comment-process.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../lib/core/services/comment-process.service.ts) | +| [Content service](core/services/content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/services/content.service.ts) | +| [Cookie service](core/services/cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/services/cookie.service.ts) | +| [Deleted Nodes Api service](core/services/deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/services/deleted-nodes-api.service.ts) | +| [Discovery Api service](core/services/discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/services/discovery-api.service.ts) | +| [Download zip service](core/services/download-zip.service.md) | Creates and manages downloads. | [Source](../lib/core/services/download-zip.service.ts) | +| [Ecm User service](core/services/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/ecm-user.service.ts) | +| [Favorites Api service](core/services/favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/services/favorites-api.service.ts) | +| [Form Rendering service](core/services/form-rendering.service.md) | Maps a form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | +| [Form service](core/services/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | +| [Highlight Transform service](core/services/highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/services/highlight-transform.service.ts) | +| [Identity Group service](core/services/identity-group.service.md) | Performs CRUD operations on identity groups. | [Source](../lib/core/services/identity-group.service.ts) | +| [Identity role service](core/services/identity-role.service.md) | Provides APIs for working with the Roles in Identity Services. | [Source](../lib/core/services/identity-role.service.ts) | +| [Identity user service](core/services/identity-user.service.md) | Gets OAuth2 personal details and roles for users and performs CRUD operations on identity users. | [Source](../lib/core/services/identity-user.service.ts) | +| [JWT helper service](core/services/jwt-helper.service.md) | Decodes a JSON Web Token (JWT) to a JavaScript object. | [Source](../lib/core/services/jwt-helper.service.ts) | +| [Log Service](core/services/log.service.md) | Provides log functionality. | [Source](../lib/core/services/log.service.ts) | +| [Login Dialog service](core/services/login-dialog.service.md) | Manages login dialogs. | [Source](../lib/core/services/login-dialog.service.ts) | +| [Node Service](core/services/node.service.md) | use Nodes Api service instead of this. | [Source](../lib/core/form/services/node.service.ts) | +| [Nodes Api service](core/services/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/services/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/notifications/services/notification.service.ts) | +| [Page Title service](core/services/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | +| [People Content service](core/services/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | +| [People Process service](core/services/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) | +| [Process Content Service](core/services/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) | +| [Renditions service](core/services/renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) | +| [Search Configuration service](core/services/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | +| [Search service](core/services/search.service.md) | Accesses the Content Services Search API. | [Source](../lib/core/services/search.service.ts) | +| [Shared Links Api service](core/services/shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../lib/core/services/shared-links-api.service.ts) | +| [Sites service](core/services/sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../lib/core/services/sites.service.ts) | +| [Storage service](core/services/storage.service.md) | Stores items in the form of key-value pairs. | [Source](../lib/core/services/storage.service.ts) | +| [Thumbnail service](core/services/thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../lib/core/services/thumbnail.service.ts) | +| [Translation service](core/services/translation.service.md) | Supports localisation. | [Source](../lib/core/services/translation.service.ts) | +| [Upload Service](core/services/upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/services/upload.service.ts) | +| [User Preferences Service](core/services/user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../lib/core/services/user-preferences.service.ts) | ### Widgets -| Name | Description | Source link | -| ------------------------------------------------------- | -------------------------- | ----------------------------------------------------------------------- | +| Name | Description | Source link | +| --- | --- | --| | [APS Content Component](core/widgets/content.widget.md) | Shows the content preview. | [Source](../lib/core/form/components/widgets/content/content.widget.ts) | @@ -255,101 +255,103 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [Add Permission Dialog Component](content-services/components/add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-dialog.component.ts) | -| [Add Permission Panel Component](content-services/components/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-panel.component.ts) | -| [Add Permission Component](content-services/components/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission.component.ts) | -| [Breadcrumb Component](content-services/components/breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/src/lib/breadcrumb/breadcrumb.component.ts) | -| [Content Action component](content-services/components/content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/src/lib/document-list/components/content-action/content-action.component.ts) | -| [Content Metadata Card component](content-services/components/content-metadata-card.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/src/lib/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) | -| [Content Node Selector Panel component](content-services/components/content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | -| [Content Node Selector component](content-services/components/content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector.component.ts) | -| [Document List component](content-services/components/document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/src/lib/document-list/components/document-list.component.ts) | -| [Dropdown Breadcrumb Component](content-services/components/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts) | -| [File Uploading Dialog Component](content-services/components/file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/src/lib/upload/components/file-uploading-dialog.component.ts) | -| [Like component](content-services/components/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/src/lib/social/like.component.ts) | -| [Permission List Component](content-services/components/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/src/lib/permission-manager/components/permission-list/permission-list.component.ts) | -| [Rating component](content-services/components/rating.component.md) | Allows a user to add and remove rating to an item. | [Source](../lib/content-services/src/lib/social/rating.component.ts) | -| [Search check list component](content-services/components/search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-check-list/search-check-list.component.ts) | -| [Search Chip List Component](content-services/components/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/src/lib/search/components/search-chip-list/search-chip-list.component.ts) | -| [Search control component](content-services/components/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/src/lib/search/components/search-control.component.ts) | -| [Search date range component](content-services/components/search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-date-range/search-date-range.component.ts) | -| [Search Filter component](content-services/components/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts) | -| [Search number range component](content-services/components/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-number-range/search-number-range.component.ts) | -| [Search radio component](content-services/components/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-radio/search-radio.component.ts) | -| [Search slider component](content-services/components/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-slider/search-slider.component.ts) | -| [Search Sorting Picker Component](content-services/components/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/src/lib/search/components/search-sorting-picker/search-sorting-picker.component.ts) | -| [Search text component](content-services/components/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-text/search-text.component.ts) | -| [Search component](content-services/components/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/src/lib/search/components/search.component.ts) | -| [Sites Dropdown component](content-services/components/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/src/lib/site-dropdown/sites-dropdown.component.ts) | -| [Tag Node Actions List component](content-services/components/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/src/lib/tag/tag-actions.component.ts) | -| [Tag List component](content-services/components/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/src/lib/tag/tag-list.component.ts) | -| [Tag Node List component](content-services/components/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/src/lib/tag/tag-node-list.component.ts) | -| [Tree View component](content-services/components/tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../lib/content-services/src/lib/tree-view/components/tree-view.component.ts) | -| [Upload Button Component](content-services/components/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/src/lib/upload/components/upload-button.component.ts) | -| [Upload Drag Area Component](content-services/components/upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../lib/content-services/src/lib/upload/components/upload-drag-area.component.ts) | -| [Upload Version Button Component (Workaround)](content-services/components/upload-version-button.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../lib/content-services/src/lib/upload/components/upload-version-button.component.ts) | -| [Version Comparison Component](content-services/components/version-comparison.component.md) | Displays the side by side comparison between the current target node (type, name, icon) and the new file that should update it's version. | [Source](../lib/content-services/src/lib/version-manager/version-comparison.component.ts) | -| [Version List component](content-services/components/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/src/lib/version-manager/version-list.component.ts) | -| [Version Manager Component](content-services/components/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/src/lib/version-manager/version-manager.component.ts) | -| [Webscript component](content-services/components/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/src/lib/webscript/webscript.component.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Add Permission Dialog Component](content-services/components/add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-dialog.component.ts) | +| [Add Permission Panel Component](content-services/components/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-panel.component.ts) | +| [Add Permission Component](content-services/components/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission.component.ts) | +| [Breadcrumb Component](content-services/components/breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/src/lib/breadcrumb/breadcrumb.component.ts) | +| [Content Action component](content-services/components/content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/src/lib/document-list/components/content-action/content-action.component.ts) | +| [Content Metadata Card component](content-services/components/content-metadata-card.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/src/lib/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) | +| [Content Node Selector Panel component](content-services/components/content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | +| [Content Node Selector component](content-services/components/content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector.component.ts) | +| [Document List component](content-services/components/document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/src/lib/document-list/components/document-list.component.ts) | +| [Dropdown Breadcrumb Component](content-services/components/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts) | +| [File Uploading Dialog Component](content-services/components/file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/src/lib/upload/components/file-uploading-dialog.component.ts) | +| [Like component](content-services/components/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/src/lib/social/like.component.ts) | +| [Permission List Component](content-services/components/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/src/lib/permission-manager/components/permission-list/permission-list.component.ts) | +| [Rating component](content-services/components/rating.component.md) | Allows a user to add and remove rating to an item. | [Source](../lib/content-services/src/lib/social/rating.component.ts) | +| [Search check list component](content-services/components/search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-check-list/search-check-list.component.ts) | +| [Search Chip List Component](content-services/components/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/src/lib/search/components/search-chip-list/search-chip-list.component.ts) | +| [Search control component](content-services/components/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/src/lib/search/components/search-control.component.ts) | +| [Search date range component](content-services/components/search-date-range.component.md) | Implements a search widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-date-range/search-date-range.component.ts) | +| [Search datetime range component](content-services/components/search-datetime-range.component.md) | Implements a search widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-datetime-range/search-datetime-range.component.ts) | +| [Search Filter component](content-services/components/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts) | +| [Search number range component](content-services/components/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-number-range/search-number-range.component.ts) | +| [Search radio component](content-services/components/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-radio/search-radio.component.ts) | +| [Search slider component](content-services/components/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-slider/search-slider.component.ts) | +| [Search Sorting Picker Component](content-services/components/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/src/lib/search/components/search-sorting-picker/search-sorting-picker.component.ts) | +| [Search text component](content-services/components/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-text/search-text.component.ts) | +| [Search component](content-services/components/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/src/lib/search/components/search.component.ts) | +| [Sites Dropdown component](content-services/components/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/src/lib/site-dropdown/sites-dropdown.component.ts) | +| [Tag Node Actions List component](content-services/components/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/src/lib/tag/tag-actions.component.ts) | +| [Tag List component](content-services/components/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/src/lib/tag/tag-list.component.ts) | +| [Tag Node List component](content-services/components/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/src/lib/tag/tag-node-list.component.ts) | +| [Tree View component](content-services/components/tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../lib/content-services/src/lib/tree-view/components/tree-view.component.ts) | +| [Upload Button Component](content-services/components/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/src/lib/upload/components/upload-button.component.ts) | +| [Upload Drag Area Component](content-services/components/upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../lib/content-services/src/lib/upload/components/upload-drag-area.component.ts) | +| [Upload Version Button Component (Workaround)](content-services/components/upload-version-button.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../lib/content-services/src/lib/upload/components/upload-version-button.component.ts) | +| [Version Comparison Component](content-services/components/version-comparison.component.md) | Displays the side by side comparison between the current target node (type, name, icon) and the new file that should update it's version. | [Source](../lib/content-services/src/lib/version-manager/version-comparison.component.ts) | +| [Version List component](content-services/components/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/src/lib/version-manager/version-list.component.ts) | +| [Version Manager Component](content-services/components/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/src/lib/version-manager/version-manager.component.ts) | +| [Version Upload component](content-services/components/version-upload.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the new version's minor/major changes and the optional comment of a node in a Version Manager component. | [Source](../lib/content-services/src/lib/version-manager/version-upload.component.ts) | +| [Webscript component](content-services/components/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/src/lib/webscript/webscript.component.ts) | ### Directives -| Name | Description | Source link | -| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| [Node Public File Share Directive](content-services/directives/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/src/lib/content-node-share/content-node-share.directive.ts) | -| [File Draggable directive](content-services/directives/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a div. | [Source](../lib/content-services/src/lib/upload/directives/file-draggable.directive.ts) | -| [Folder Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/src/lib/folder-directive/folder-create.directive.ts) | -| [Folder Edit directive](content-services/directives/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/src/lib/folder-directive/folder-edit.directive.ts) | -| [Inherit Permission directive](content-services/directives/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/inherited-button.directive.ts) | -| [Node Lock directive](content-services/directives/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/src/lib/directives/node-lock.directive.ts) | -| [Toggle Icon directive](content-services/directives/toggle-icon.directive.md) | Toggle icon on mouse or keyboard event for a selectable element. | [Source](../lib/content-services/src/lib/upload/directives/toggle-icon.directive.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Node Public File Share Directive](content-services/directives/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/src/lib/content-node-share/content-node-share.directive.ts) | +| [File Draggable directive](content-services/directives/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a div. | [Source](../lib/content-services/src/lib/upload/directives/file-draggable.directive.ts) | +| [Folder Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/src/lib/folder-directive/folder-create.directive.ts) | +| [Folder Edit directive](content-services/directives/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/src/lib/folder-directive/folder-edit.directive.ts) | +| [Inherit Permission directive](content-services/directives/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/inherited-button.directive.ts) | +| [Node Lock directive](content-services/directives/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/src/lib/directives/node-lock.directive.ts) | +| [Toggle Icon directive](content-services/directives/toggle-icon.directive.md) | Toggle icon on mouse or keyboard event for a selectable element. | [Source](../lib/content-services/src/lib/upload/directives/toggle-icon.directive.ts) | ### Dialogs -| Name | Description | Source link | -| ---------------------------------------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------- | -| [Confirm dialog component](content-services/dialogs/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/src/lib/dialogs/confirm.dialog.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Confirm dialog component](content-services/dialogs/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/src/lib/dialogs/confirm.dialog.ts) | | [Library dialog component](content-services/dialogs/library.dialog.md) | Creates a new Content Services document library/site. | [Source](../lib/content-services/src/lib/dialogs/library/library.dialog.ts) | ### Interfaces -| Name | Description | Source link | -| --------------------------------------------------------------------------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------- | +| Name | Description | Source link | +| --- | --- | --| | [Search widget interface](content-services/interfaces/search-widget.interface.md) | Specifies required properties for Search filter component widgets. | [Source](../lib/content-services/src/lib/search/search-widget.interface.ts) | ### Models -| Name | Description | Source link | -| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [Image Resolver Model](content-services/models/image-resolver.model.md) | Defines the Image Resolver function used by the Document List Component. | [Source](../lib/content-services/document-list/data/image-resolver.model.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Image Resolver Model](content-services/models/image-resolver.model.md) | Defines the Image Resolver function used by the Document List Component. | [Source](../lib/content-services/document-list/data/image-resolver.model.ts) | | [Permission Style model](content-services/models/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) | -| [Row Filter Model](content-services/models/row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../lib/content-services/document-list/data/row-filter.model.ts) | +| [Row Filter Model](content-services/models/row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../lib/content-services/document-list/data/row-filter.model.ts) | ### Pipes -| Name | Description | Source link | -| -------------------------------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | +| Name | Description | Source link | +| --- | --- | --| | [File upload error pipe](content-services/pipes/file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../lib/content-services/src/lib/upload/pipes/file-upload-error.pipe.ts) | ### Services -| Name | Description | Source link | -| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| [Audit Service](content-services/services/audit.service.md) | Manages Audit apps and entries. | [Source](../lib/content-services/src/lib/audit/audit.service.ts) | -| [Content Node Dialog service](content-services/services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts) | -| [Custom Resources service](content-services/services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/src/lib/document-list/services/custom-resources.service.ts) | -| [Document Actions service](content-services/services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-actions.service.ts) | -| [Document List service](content-services/services/document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-list.service.ts) | -| [Folder Actions service](content-services/services/folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/folder-actions.service.ts) | -| [Node permission dialog service](content-services/services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts) | -| [Node Permission service](content-services/services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission.service.ts) | -| [Rating service](content-services/services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/src/lib/social/services/rating.service.ts) | -| [Search filter service](content-services/services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.service.ts) | -| [Search Query Builder service](content-services/services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/src/lib/search/search-query-builder.service.ts) | -| [Tag service](content-services/services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/src/lib/tag/services/tag.service.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Audit Service](content-services/services/audit.service.md) | Manages Audit apps and entries. | [Source](../lib/content-services/src/lib/audit/audit.service.ts) | +| [Content Node Dialog service](content-services/services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts) | +| [Custom Resources service](content-services/services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/src/lib/document-list/services/custom-resources.service.ts) | +| [Document Actions service](content-services/services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-actions.service.ts) | +| [Document List service](content-services/services/document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-list.service.ts) | +| [Folder Actions service](content-services/services/folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/folder-actions.service.ts) | +| [Node permission dialog service](content-services/services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts) | +| [Node Permission service](content-services/services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission.service.ts) | +| [Rating service](content-services/services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/src/lib/social/services/rating.service.ts) | +| [Search filter service](content-services/services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.service.ts) | +| [Search Query Builder service](content-services/services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/src/lib/search/search-query-builder.service.ts) | +| [Tag service](content-services/services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/src/lib/tag/services/tag.service.ts) | @@ -366,59 +368,59 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- | -| [Apps List Component](process-services/components/apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/src/lib/app-list/apps-list.component.ts) | -| [Attach Form component](process-services/components/attach-form.component.md) | This component can be used when there is no form attached to a task and you want to add one. | [Source](../lib/process-services/src/lib/task-list/components/attach-form.component.ts) | -| [Checklist Component](process-services/components/checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/src/lib/task-list/components/checklist.component.ts) | -| [Create Process Attachment component](process-services/components/create-process-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified process instance. | [Source](../lib/process-services/src/lib/attachment/create-process-attachment.component.ts) | -| [Create Task Attachment Component](process-services/components/create-task-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified task. | [Source](../lib/process-services/src/lib/attachment/create-task-attachment.component.ts) | -| [Form custom outcomes component](process-services/components/form-custom-outcome.component.md) | Supplies custom outcome buttons to be included in Form component. | [Source](../lib/process-services/src/lib/form/form-custom-outcomes.component.ts) | -| [Form component](process-services/components/form.component.md) | Shows a Form from APS | [Source](../lib/process-services/src/lib/form/form.component.ts) | -| [People list component](process-services/components/people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/src/lib/people/components/people-list/people-list.component.ts) | -| [People Search component](process-services/components/people-search.component.md) | Searches users/people. | [Source](../lib/process-services/src/lib/people/components/people-search/people-search.component.ts) | -| [People Component](process-services/components/people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/src/lib/people/components/people/people.component.ts) | -| [Process Attachment List component](process-services/components/process-attachment-list.component.md) | Displays documents attached to a specified process instance. | [Source](../lib/process-services/src/lib/attachment/process-attachment-list.component.ts) | -| [Process Instance Comments component](process-services/components/process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments. | [Source](../lib/process-services/src/lib/process-comments/process-comments.component.ts) | -| [Process Filters Component](process-services/components/process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/src/lib/process-list/components/process-filters.component.ts) | -| [Process Details component](process-services/components/process-instance-details.component.md) | Displays detailed information about a specified process instance | [Source](../lib/process-services/src/lib/process-list/components/process-instance-details.component.ts) | -| [Process Instance Details Header component](process-services/components/process-instance-header.component.md) | Sub-component of the process details component, which renders some general information about the selected process. | [Source](../lib/process-services/src/lib/process-list/components/process-instance-header.component.ts) | -| [Process Instance Tasks component](process-services/components/process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../lib/process-services/src/lib/process-list/components/process-instance-tasks.component.ts) | -| [Process Instance List](process-services/components/process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/src/lib/process-list/components/process-list.component.ts) | -| [Select App Component](process-services/components/select-apps-dialog.component.md) | Shows all available apps and returns the selected app. | [Source](../lib/process-services/src/lib/app-list/select-apps-dialog.component.ts) | -| [Start Process component](process-services/components/start-process.component.md) | Starts a process. | [Source](../lib/process-services/src/lib/process-list/components/start-process.component.ts) | -| [Start Task Component](process-services/components/start-task.component.md) | Creates/Starts a new task for the specified app. | [Source](../lib/process-services/src/lib/task-list/components/start-task.component.ts) | -| [Task Attachment List Component](process-services/components/task-attachment-list.component.md) | Displays documents attached to a specified task. | [Source](../lib/process-services/src/lib/attachment/task-attachment-list.component.ts) | -| [Task Details component](process-services/components/task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../lib/process-services/src/lib/task-list/components/task-details.component.ts) | -| [Task Filters component](process-services/components/task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/src/lib/task-list/components/task-filters.component.ts) | -| [Task Form component](process-services/components/task-form.component.md) | Shows a form for a task. | [Source](../lib/process-services/src/lib/task-list/components/task-form/task-form.component.ts) | -| [Task Header component](process-services/components/task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/src/lib/task-list/components/task-header.component.ts) | -| [Task List component](process-services/components/task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/src/lib/task-list/components/task-list.component.ts) | -| [Task Standalone component](process-services/components/task-standalone.component.md) | This component can be used when the task doesn't belong to any processes. | [Source](../lib/process-services/src/lib/task-list/components/task-standalone.component.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Apps List Component](process-services/components/apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/src/lib/app-list/apps-list.component.ts) | +| [Attach Form component](process-services/components/attach-form.component.md) | This component can be used when there is no form attached to a task and you want to add one. | [Source](../lib/process-services/src/lib/task-list/components/attach-form.component.ts) | +| [Checklist Component](process-services/components/checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/src/lib/task-list/components/checklist.component.ts) | +| [Create Process Attachment component](process-services/components/create-process-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified process instance. | [Source](../lib/process-services/src/lib/attachment/create-process-attachment.component.ts) | +| [Create Task Attachment Component](process-services/components/create-task-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified task. | [Source](../lib/process-services/src/lib/attachment/create-task-attachment.component.ts) | +| [Form custom outcomes component](process-services/components/form-custom-outcome.component.md) | Supplies custom outcome buttons to be included in Form component. | [Source](../lib/process-services/src/lib/form/form-custom-outcomes.component.ts) | +| [Form component](process-services/components/form.component.md) | Shows a Form from APS | [Source](../lib/process-services/src/lib/form/form.component.ts) | +| [People list component](process-services/components/people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/src/lib/people/components/people-list/people-list.component.ts) | +| [People Search component](process-services/components/people-search.component.md) | Searches users/people. | [Source](../lib/process-services/src/lib/people/components/people-search/people-search.component.ts) | +| [People Component](process-services/components/people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/src/lib/people/components/people/people.component.ts) | +| [Process Attachment List component](process-services/components/process-attachment-list.component.md) | Displays documents attached to a specified process instance. | [Source](../lib/process-services/src/lib/attachment/process-attachment-list.component.ts) | +| [Process Instance Comments component](process-services/components/process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments. | [Source](../lib/process-services/src/lib/process-comments/process-comments.component.ts) | +| [Process Filters Component](process-services/components/process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/src/lib/process-list/components/process-filters.component.ts) | +| [Process Details component](process-services/components/process-instance-details.component.md) | Displays detailed information about a specified process instance | [Source](../lib/process-services/src/lib/process-list/components/process-instance-details.component.ts) | +| [Process Instance Details Header component](process-services/components/process-instance-header.component.md) | Sub-component of the process details component, which renders some general information about the selected process. | [Source](../lib/process-services/src/lib/process-list/components/process-instance-header.component.ts) | +| [Process Instance Tasks component](process-services/components/process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../lib/process-services/src/lib/process-list/components/process-instance-tasks.component.ts) | +| [Process Instance List](process-services/components/process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/src/lib/process-list/components/process-list.component.ts) | +| [Select App Component](process-services/components/select-apps-dialog.component.md) | Shows all available apps and returns the selected app. | [Source](../lib/process-services/src/lib/app-list/select-apps-dialog.component.ts) | +| [Start Process component](process-services/components/start-process.component.md) | Starts a process. | [Source](../lib/process-services/src/lib/process-list/components/start-process.component.ts) | +| [Start Task Component](process-services/components/start-task.component.md) | Creates/Starts a new task for the specified app. | [Source](../lib/process-services/src/lib/task-list/components/start-task.component.ts) | +| [Task Attachment List Component](process-services/components/task-attachment-list.component.md) | Displays documents attached to a specified task. | [Source](../lib/process-services/src/lib/attachment/task-attachment-list.component.ts) | +| [Task Details component](process-services/components/task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../lib/process-services/src/lib/task-list/components/task-details.component.ts) | +| [Task Filters component](process-services/components/task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/src/lib/task-list/components/task-filters.component.ts) | +| [Task Form component](process-services/components/task-form.component.md) | Shows a form for a task. | [Source](../lib/process-services/src/lib/task-list/components/task-form/task-form.component.ts) | +| [Task Header component](process-services/components/task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/src/lib/task-list/components/task-header.component.ts) | +| [Task List component](process-services/components/task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/src/lib/task-list/components/task-list.component.ts) | +| [Task Standalone component](process-services/components/task-standalone.component.md) | This component can be used when the task doesn't belong to any processes. | [Source](../lib/process-services/src/lib/task-list/components/task-standalone.component.ts) | ### Directives -| Name | Description | Source link | -| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | -| [Claim Task Directive](process-services/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/claim-task.directive.ts) | -| [Process Audit Directive](process-services/directives/process-audit.directive.md) | Fetches the Process Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/process-list/components/process-audit.directive.ts) | -| [Task Audit Directive](process-services/directives/task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/task-list/components/task-audit.directive.ts) | -| [Unclaim Task Directive](process-services/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/unclaim-task.directive.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Claim Task Directive](process-services/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/claim-task.directive.ts) | +| [Process Audit Directive](process-services/directives/process-audit.directive.md) | Fetches the Process Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/process-list/components/process-audit.directive.ts) | +| [Task Audit Directive](process-services/directives/task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/task-list/components/task-audit.directive.ts) | +| [Unclaim Task Directive](process-services/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/unclaim-task.directive.ts) | ### Pipes -| Name | Description | Source link | -| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | +| Name | Description | Source link | +| --- | --- | --| | [Process name pipe](process-services/pipes/process-name.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services/src/lib/pipes/process-name.pipe.ts) | ### Services -| Name | Description | Source link | -| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| Name | Description | Source link | +| --- | --- | --| | [Process Filter Service](process-services/services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/src/lib/process-list/services/process-filter.service.ts) | -| [Process Service](process-services/services/process.service.md) | Manages process instances, process variables, and process audit Log. | [Source](../lib/process-services/src/lib/process-list/services/process.service.ts) | -| [Task Filter Service](process-services/services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/src/lib/task-list/services/task-filter.service.ts) | -| [Tasklist Service](process-services/services/tasklist.service.md) | Manages Task Instances. | [Source](../lib/process-services/src/lib/task-list/services/tasklist.service.ts) | +| [Process Service](process-services/services/process.service.md) | Manages process instances, process variables, and process audit Log. | [Source](../lib/process-services/src/lib/process-list/services/process.service.ts) | +| [Task Filter Service](process-services/services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/src/lib/task-list/services/task-filter.service.ts) | +| [Tasklist Service](process-services/services/tasklist.service.md) | Manages Task Instances. | [Source](../lib/process-services/src/lib/task-list/services/tasklist.service.ts) | @@ -435,59 +437,61 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| [App List Cloud Component](process-services-cloud/components/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) | -| [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows/edits process filter details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) | -| [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits task filter details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter-cloud.component.ts) | -| [Form cloud custom outcomes component](process-services-cloud/components/form-cloud-custom-outcome.component.md) | Supplies custom outcome buttons to be included in Form cloud component. | [Source](../lib/process-services-cloud/src/lib/form/components/form-cloud-custom-outcomes.component.ts) | -| [Form cloud component](process-services-cloud/components/form-cloud.component.md) | Shows a form from Process Services. | [Source](../lib/process-services-cloud/src/lib/form/components/form-cloud.component.ts) | -| [Form Definition Selector Cloud](process-services-cloud/components/form-definition-selector-cloud.component.md) | Allows one form to be selected from a dropdown list. For forms to be displayed in this component they will need to be compatible with standAlone tasks. | [Source](../lib/process-services-cloud/src/lib/form/components/form-definition-selector-cloud.component.ts) | -| [Group Cloud component](process-services-cloud/components/group-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) | -| [People Cloud Component](process-services-cloud/components/people-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Allows one or more users to be selected (with auto-suggestion) based on the input parameters. | [Source](../lib/process-services-cloud/src/lib/people/components/people-cloud.component.ts) | -| [Process Filters Cloud Component](process-services-cloud/components/process-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) | -| [Process Header Cloud Component](process-services-cloud/components/process-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a process instance. | [Source](../lib/process-services-cloud/src/lib/process/process-header/components/process-header-cloud.component.ts) | -| [Process Instance List Cloud component](process-services-cloud/components/process-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) | -| [Start Process Cloud Component](process-services-cloud/components/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | -| [Start Task Cloud Component](process-services-cloud/components/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | -| [Task Filters Cloud component](process-services-cloud/components/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | -| [Form cloud component](process-services-cloud/components/task-form-cloud.component.md) | Shows a form for a task. | [Source](../lib/process-services-cloud/src/lib/task/task-form/components/task-form-cloud.component.ts) | -| [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | -| [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [App List Cloud Component](process-services-cloud/components/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) | +| [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows/edits process filter details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) | +| [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits task filter details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter-cloud.component.ts) | +| [Form cloud custom outcomes component](process-services-cloud/components/form-cloud-custom-outcome.component.md) | Supplies custom outcome buttons to be included in Form cloud component. | [Source](../lib/process-services-cloud/src/lib/form/components/form-cloud-custom-outcomes.component.ts) | +| [Form cloud component](process-services-cloud/components/form-cloud.component.md) | Shows a form from Process Services. | [Source](../lib/process-services-cloud/src/lib/form/components/form-cloud.component.ts) | +| [Form Definition Selector Cloud](process-services-cloud/components/form-definition-selector-cloud.component.md) | Allows one form to be selected from a dropdown list. For forms to be displayed in this component they will need to be compatible with standAlone tasks. | [Source](../lib/process-services-cloud/src/lib/form/components/form-definition-selector-cloud.component.ts) | +| [Group Cloud component](process-services-cloud/components/group-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) | +| [](process-services-cloud/components/people-cloud.component.md) | Title: People Cloud Component +Added: v3.0.0 +Status: Experimental | [Source]() | +| [Process Filters Cloud Component](process-services-cloud/components/process-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) | +| [Process Header Cloud Component](process-services-cloud/components/process-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a process instance. | [Source](../lib/process-services-cloud/src/lib/process/process-header/components/process-header-cloud.component.ts) | +| [Process Instance List Cloud component](process-services-cloud/components/process-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) | +| [Start Process Cloud Component](process-services-cloud/components/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | +| [Start Task Cloud Component](process-services-cloud/components/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | +| [Task Filters Cloud component](process-services-cloud/components/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | +| [Form cloud component](process-services-cloud/components/task-form-cloud.component.md) | Shows a form for a task. | [Source](../lib/process-services-cloud/src/lib/task/task-form/components/task-form-cloud.component.ts) | +| [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | +| [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | ### Directives -| Name | Description | Source link | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------- | -| [Cancel Process Directive](process-services-cloud/directives/cancel-process.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Cancels a process | [Source](../lib/process-services-cloud/src/lib/process/directives/cancel-process.directive.ts) | -| [Claim Task Cloud Directive](process-services-cloud/directives/claim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task-cloud.directive.ts) | -| [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) | -| [Unclaim Task Cloud Directive](process-services-cloud/directives/unclaim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task-cloud.directive.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Cancel Process Directive](process-services-cloud/directives/cancel-process.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Cancels a process | [Source](../lib/process-services-cloud/src/lib/process/directives/cancel-process.directive.ts) | +| [Claim Task Cloud Directive](process-services-cloud/directives/claim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task-cloud.directive.ts) | +| [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) | +| [Unclaim Task Cloud Directive](process-services-cloud/directives/unclaim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task-cloud.directive.ts) | ### Pipes -| Name | Description | Source link | -| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | | [Process name cloud pipe](process-services-cloud/pipes/process-name-cloud.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services-cloud/src/lib/pipes/process-name-cloud.pipe.ts) | ### Services -| Name | Description | Source link | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| [Apps Process Cloud Service](process-services-cloud/services/apps-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets details of deployed apps for the current user. | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | -| [Form cloud service](process-services-cloud/services/form-cloud.service.md) | Implements Process Services form methods | [Source](../lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts) | -| [Group Cloud Service](process-services-cloud/services/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | -| [Local Preference Cloud Service](process-services-cloud/services/local-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages Local Storage preferences. | [Source](../lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts) | -| [Process Cloud Service](process-services-cloud/services/process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud process instances. | [Source](../lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts) | -| [Process Filter Cloud Service](process-services-cloud/services/process-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) | -| [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | -| [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | -| [Start Task Cloud Service](process-services-cloud/services/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/services/start-task-cloud.service.ts) | -| [Task Cloud Service](process-services-cloud/services/task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task cloud. | [Source](../lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts) | -| [Task Filter Cloud Service](process-services-cloud/services/task-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) | -| [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | -| [User Preference Cloud Service](process-services-cloud/services/user-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages user preferences. | [Source](../lib/process-services-cloud/src/lib/services/user-preference-cloud.service.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Apps Process Cloud Service](process-services-cloud/services/apps-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets details of deployed apps for the current user. | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | +| [Form cloud service](process-services-cloud/services/form-cloud.service.md) | Implements Process Services form methods | [Source](../lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts) | +| [Group Cloud Service](process-services-cloud/services/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | +| [Local Preference Cloud Service](process-services-cloud/services/local-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages Local Storage preferences. | [Source](../lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts) | +| [Process Cloud Service](process-services-cloud/services/process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud process instances. | [Source](../lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts) | +| [Process Filter Cloud Service](process-services-cloud/services/process-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) | +| [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | +| [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | +| [Start Task Cloud Service](process-services-cloud/services/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/services/start-task-cloud.service.ts) | +| [Task Cloud Service](process-services-cloud/services/task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task cloud. | [Source](../lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts) | +| [Task Filter Cloud Service](process-services-cloud/services/task-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) | +| [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | +| [User Preference Cloud Service](process-services-cloud/services/user-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages user preferences. | [Source](../lib/process-services-cloud/src/lib/services/user-preference-cloud.service.ts) | @@ -504,15 +508,15 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------------------------------------- | -| [Dynamic Component](extensions/components/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | -| [Preview Extension Component](extensions/components/preview-extension.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Supports dynamically-loaded viewer preview extensions. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Dynamic Component](extensions/components/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | +| [Preview Extension Component](extensions/components/preview-extension.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Supports dynamically-loaded viewer preview extensions. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) | ### Services -| Name | Description | Source link | -| -------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------- | +| Name | Description | Source link | +| --- | --- | --| | [Extension Service](extensions/services/extension.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages and runs basic extension functionality. | [Source](../lib/extensions/src/lib/services/extension.service.ts) | @@ -530,13 +534,13 @@ for more information about installing and using the source code. ### Components -| Name | Description | Source link | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [Analytics Generator Component](insights/components/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/src/lib/analytics-process/components/analytics-generator.component.ts) | -| [APS Analytics List Component](insights/components/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts) | -| [APS Analytics Component](insights/components/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/src/lib/analytics-process/components/analytics.component.ts) | -| [Diagram Component](insights/components/diagram.component.md) | Displays process diagrams. | [Source](../lib/insights/src/lib/diagram/components/diagram.component.ts) | -| [Widget component](insights/components/widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/src/lib/analytics-process/components/widgets/widget.component.ts) | +| Name | Description | Source link | +| --- | --- | --| +| [Analytics Generator Component](insights/components/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/src/lib/analytics-process/components/analytics-generator.component.ts) | +| [APS Analytics List Component](insights/components/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts) | +| [APS Analytics Component](insights/components/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/src/lib/analytics-process/components/analytics.component.ts) | +| [Diagram Component](insights/components/diagram.component.md) | Displays process diagrams. | [Source](../lib/insights/src/lib/diagram/components/diagram.component.ts) | +| [Widget component](insights/components/widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/src/lib/analytics-process/components/widgets/widget.component.ts) | diff --git a/docs/abn-tree.yml b/docs/abn-tree.yml index 6f2e83d412..560db8f26a 100644 --- a/docs/abn-tree.yml +++ b/docs/abn-tree.yml @@ -60,6 +60,7 @@ - release-notes: title: 'Release notes' children: + - RelNote420.md: 'Release notes v4.2.0' - RelNote410.md: 'Release notes v4.1.0' - RelNote400.md: 'Release notes v4.0.0' - RelNote390.md: 'Release notes v3.9.0' @@ -87,6 +88,7 @@ - upgrade-guide: title: 'Upgrade Guide' children: + - upgrade40-41.md: 'From 4.1.0 to 4.2.0' - upgrade40-41.md: 'From 4.0.0 to 4.1.0' - upgrade39-40.md: 'From 3.9.0 to 4.0.0' - upgrade37-38.md: 'From 3.7.0 to 3.8.0' @@ -97,6 +99,7 @@ - vulnerability: title: 'Vulnerability' children: + - audit-info-4.1.0.md: 'Audit for 4.2.0' - audit-info-4.1.0.md: 'Audit for 4.1.0' - audit-info-4.0.0.md: 'Audit for 4.0.0' - audit-info-3.9.0.md: 'Audit for 3.9.0' @@ -109,6 +112,7 @@ - license-info: title: 'License info' children: + - license-info-4.1.0.md: 'License info for 4.2.0' - license-info-4.1.0.md: 'License info for 4.1.0' - license-info-4.0.0.md: 'License info for 4.0.0' - license-info-3.9.0.md: 'License info for 3.9.0' diff --git a/docs/compatibility.md b/docs/compatibility.md index 1f6cc11adf..c735f625c1 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -21,6 +21,7 @@ You can find further information about released versions of ADF in the | ADF version | Content Services | Process Services | | --- | --- | --- | +| [4.2.0](versionIndex.md#v410) |v6.2.2 (AGS 3.3.1)|v7.1.0 M11 (latest CI pipeline build), v1.11.1| | [4.1.0](versionIndex.md#v410) |v6.2.2 (AGS 3.3.1)|v7.1.0 M10 (latest CI pipeline build), v1.11.1| | [4.0.0](versionIndex.md#v400) |v6.2.2 (AGS 3.3.1)|v7.1.0 M9 (latest CI pipeline build), v1.11.1| | [3.9.0](versionIndex.md#v390) |v6.2.2 (AGS 3.3.1)|v7.1.0 M8 (latest CI pipeline build), v1.11.1| diff --git a/docs/content-services/components/add-permission-panel.component.md b/docs/content-services/components/add-permission-panel.component.md index 334c2b5b8d..f9bf4ffd13 100644 --- a/docs/content-services/components/add-permission-panel.component.md +++ b/docs/content-services/components/add-permission-panel.component.md @@ -25,8 +25,8 @@ Searches for people or groups to add to the current node permissions. ### Events -| Name | Type | Description | -| ------ | ----------------------------------------------------------------- | ------------------------------------------------ | +| Name | Type | Description | +| --- | --- | --- | | select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission list item is selected. | ## Details @@ -41,5 +41,5 @@ permissions to the node once the selection has been made. ## See also -- [Add permission dialog component](add-permission-dialog.component.md) -- [Add permission component](add-permission.component.md) +* [Add permission dialog component](add-permission-dialog.component.md) +* [Add permission component](add-permission.component.md) diff --git a/docs/content-services/components/add-permission.component.md b/docs/content-services/components/add-permission.component.md index 4300df47ab..1c6c910f1c 100644 --- a/docs/content-services/components/add-permission.component.md +++ b/docs/content-services/components/add-permission.component.md @@ -25,16 +25,16 @@ Searches for people or groups to add to the current node permissions. ### Properties -| Name | Type | Default value | Description | -| ------ | -------- | ------------- | ---------------------- | -| nodeId | `string` | | ID of the target node. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeId | `string` | | ID of the target node. | ### Events -| Name | Type | Description | -| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the update. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated successfully. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the update. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated successfully. | ## Details @@ -44,5 +44,5 @@ use the [Add permission dialog component](add-permission-dialog.component.md) to ## See also -- [Add permission panel component](add-permission-panel.component.md) -- [Add permission dialog component](add-permission-dialog.component.md) +* [Add permission panel component](add-permission-panel.component.md) +* [Add permission dialog component](add-permission-dialog.component.md) diff --git a/docs/content-services/components/breadcrumb.component.md b/docs/content-services/components/breadcrumb.component.md index 6508380846..da272b2724 100644 --- a/docs/content-services/components/breadcrumb.component.md +++ b/docs/content-services/components/breadcrumb.component.md @@ -23,19 +23,19 @@ Indicates the current position within a navigation hierarchy. ### Properties -| Name | Type | Default value | Description | -| ---------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | -| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | -| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | -| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | -| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | -| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | +| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | +| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | +| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | +| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | +| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | ### Events -| Name | Type | Description | -| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | ## Details @@ -52,7 +52,7 @@ uses to find the "crumbs" for the list. You can use this, for example, to remove the list by altering the node's `path.elements` property. Below is an example of how you might do this with the -[Content Node Selector component](content-node-selector.component.md). In this case, you pass the +[Content Node Selector component](content-node-selector.component.md). In this case, you pass the transform function via the `breadcrumbTransform` property of [`ContentNodeSelectorComponentData`](../../../lib/content-services/src/lib/content-node-selector/content-node-selector.component-data.interface.ts) during initialization: @@ -96,5 +96,5 @@ Below, the breadcrumb is shown before and after the transform function is applie ## See also -- [Document list component](document-list.component.md) -- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) +* [Document list component](document-list.component.md) +* [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) diff --git a/docs/content-services/components/content-action.component.md b/docs/content-services/components/content-action.component.md index 4373055bcd..c327688015 100644 --- a/docs/content-services/components/content-action.component.md +++ b/docs/content-services/components/content-action.component.md @@ -13,17 +13,17 @@ Adds options to a Document List actions menu for a particular content type. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Examples](#examples) - - [Conditional visibility](#conditional-visibility) - - [Conditional disabled state](#conditional-disabled-state) - - [Customizing built-in actions](#customizing-built-in-actions) - - [Error, Permission and Success callbacks](#error-permission-and-success-callbacks) -- [See also](#see-also) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Examples](#examples) + * [Conditional visibility](#conditional-visibility) + * [Conditional disabled state](#conditional-disabled-state) + * [Customizing built-in actions](#customizing-built-in-actions) + * [Error, Permission and Success callbacks](#error-permission-and-success-callbacks) +* [See also](#see-also) ## Basic Usage @@ -82,25 +82,25 @@ export class MyView { ### Properties -| Name | Type | Default value | Description | -| ----------------------- | --------------------- | ------------- | -------------------------------------------------------------------------------------- | -| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? | -| disabled | `boolean \| Function` | false | Is the menu item disabled? | -| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". | -| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). | -| permission | `string` | | The permission type. | -| target | `string` | | Type of item that the action applies to. Can be "document" or "folder" | -| title | `string` | "Action" | The title of the action as shown in the menu. | -| visible | `boolean \| Function` | true | Visibility state (see examples). | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? | +| disabled | `boolean \| Function` | false | Is the menu item disabled? | +| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". | +| icon | `string` | | The name of the icon to display next to the menu command (can be left blank). | +| permission | `string` | | The permission type. | +| target | `string` | | Type of item that the action applies to. Can be "document" or "folder" | +| title | `string` | "Action" | The title of the action as shown in the menu. | +| visible | `boolean \| Function` | true | Visibility state (see examples). | ### Events -| Name | Type | Description | -| --------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the action. Applies to copy and move actions. | -| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects the action from the menu. | -| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission error occurs | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the action. Applies to copy and move actions. | +| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects the action from the menu. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission error occurs | +| success | `EventEmitter` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | ## Details @@ -109,18 +109,18 @@ The document actions are rendered on a dropdown menu for each items of content. A number of built-in actions are defined to handle common use cases: -- **Download** (document) -- **lock** (document) -- **Copy** (document, folder) -- **Move** (document, folder) -- **Delete** (document, folder) +* **Download** (document) +* **lock** (document) +* **Copy** (document, folder) +* **Move** (document, folder) +* **Delete** (document, folder) You can use one of the built-in handlers by assigning its name to the `handler` property. (The names are case-insensitive, so `handler="download"` and `handler="DOWNLOAD"` will trigger the same action.) You can also add your own handler by implementing the `execute` event. -Note that you can use _both_ a built-in handler and your own `execute` +Note that you can use *both* a built-in handler and your own `execute` function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](../../../lib/content-services/src/lib/document-list/models/document-library.model.ts) as its parameter. For example, with `handler="delete"` you could use `execute` to show a message with the name, @@ -212,7 +212,7 @@ If you specify both a system handler and your own custom handler with `(execute)="myCustomActionAfterDelete($event)"`, your handler will run after the system handler completes successfully. A system operation is considered successful if there are no permission or network-related errors for the system request. You can avoid permission errors simply -by disabling an item for users who don't have permission to use it (set `disableWithNoPermission="true"`). +by disabling an item for users who don't have permission to use it (set `disableWithNoPermission="true"`). ```html @@ -322,8 +322,8 @@ allow the item being copied/moved to be the destination if it is itself a folder The `` component allows you to control visibility with the help of the `visible` property and supports the following scenarios: -- direct value of `boolean` type -- binding to a property of the `Function` type that evaluates condition and returns `boolean` value +* direct value of `boolean` type +* binding to a property of the `Function` type that evaluates condition and returns `boolean` value #### Using direct boolean value @@ -363,7 +363,7 @@ export class MyComponent { ``` The code above checks the node name and evaluates to `true` only if the corresponding -node is called "For Sale.docx". +node is called "For Sale.docx". Note that if you want to preserve `this` context within the evaluator function then you should declare it as a lambda function: @@ -379,8 +379,8 @@ funcName = (parameters): boolean => { As with the `visible` property, you can control the `disabled` state with the following options: -- direct value of `boolean` type -- binding to a property of the `Function` type that evaluates a condition and returns a `boolean` value +* direct value of `boolean` type +* binding to a property of the `Function` type that evaluates a condition and returns a `boolean` value #### Using direct value of boolean type @@ -418,7 +418,7 @@ export class MyComponent { } ``` -The code above checks the node name, and evaluates to `true` only if the corresponding node is called "custom". +The code above checks the node name, and evaluates to `true` only if the corresponding node is called "custom". Note that if you want to preserve the `this` context within the evaluator function, you should declare it as a lambda function: @@ -442,14 +442,14 @@ for details and examples. You can define error, permission and success callbacks in much the same way as for the delete permission handling. -- The error handler callback gets the error object that was raised -- The success callback's only parameter is the translatable success message string (which could be shown in a snackbar, for example) -- The `permissionEvent` callback is the same as described above for the delete action +* The error handler callback gets the error object that was raised +* The success callback's only parameter is the translatable success message string (which could be shown in a snackbar, for example) +* The `permissionEvent` callback is the same as described above for the delete action ![Copy/move document action](../../docassets/images/document-action-copymove.png) ## See also -- [Document list component](document-list.component.md) -- [Document actions service](../services/document-actions.service.md) -- [Folder actions service](../services/folder-actions.service.md) +* [Document list component](document-list.component.md) +* [Document actions service](../services/document-actions.service.md) +* [Folder actions service](../services/folder-actions.service.md) diff --git a/docs/content-services/components/content-metadata-card.component.md b/docs/content-services/components/content-metadata-card.component.md index 56d7e3f196..2300b8ea3e 100644 --- a/docs/content-services/components/content-metadata-card.component.md +++ b/docs/content-services/components/content-metadata-card.component.md @@ -13,19 +13,19 @@ Displays and edits metadata related to a node. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) -- [Details](#details) - - [Application config presets](#application-config-presets) - - [Layout oriented config](#layout-oriented-config) - - [Displaying all properties](#displaying-all-properties) - - [Making aspects and properties read only](#making-aspects-and-properties-read-only) -- [What happens when there is a whitelisted aspect in the config but the given node doesn't relate to that aspect](#what-happens-when-there-is-a-whitelisted-aspect-in-the-config-but-the-given-node-doesnt-relate-to-that-aspect) -- [Multi value card properties](#multi-value-card-properties) - - [Use chips for multi value properties](#use-chips-for-multi-value-properties) -- [Copy to Clipboard on click](#copy-to-clipboard-on-click) -- [Search select options (ACS 7+)](#search-select-options-acs-7) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) +* [Details](#details) + * [Application config presets](#application-config-presets) + * [Layout oriented config](#layout-oriented-config) + * [Displaying all properties](#displaying-all-properties) + * [Making aspects and properties read only](#making-aspects-and-properties-read-only) +* [What happens when there is a whitelisted aspect in the config but the given node doesn't relate to that aspect](#what-happens-when-there-is-a-whitelisted-aspect-in-the-config-but-the-given-node-doesnt-relate-to-that-aspect) +* [Multi value card properties](#multi-value-card-properties) + * [Use chips for multi value properties](#use-chips-for-multi-value-properties) +* [Copy to Clipboard on click](#copy-to-clipboard-on-click) +* [Search select options (ACS 7+)](#search-select-options-acs-7) ## Basic Usage @@ -42,15 +42,15 @@ Displays and edits metadata related to a node. ### Properties -| Name | Type | Default value | Description | -| ------------------------ | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------- | -| displayAspect | `string` | null | (optional) This flag displays desired aspect when open for the first time fields. | -| displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. | -| multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (required) The node entity to fetch metadata about | -| preset | `string` | | (required) Name of the metadata preset, which defines aspects and their properties. | -| readOnly | `boolean` | false | (optional) This flag sets the metadata in read only mode preventing changes. | -| displayDefaultProperties | `boolean` | | (optional) This flag displays/hides the metadata properties. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| displayAspect | `string` | null | (optional) This flag displays desired aspect when open for the first time fields. | +| displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. | +| multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (required) The node entity to fetch metadata about | +| preset | `string` | | (required) Name of the metadata preset, which defines aspects and their properties. | +| readOnly | `boolean` | false | (optional) This flag sets the metadata in read only mode preventing changes. | +| displayDefaultProperties | `boolean` | | (optional) This flag displays/hides the metadata properties. | ## Details @@ -65,7 +65,7 @@ properties. You can define different presets for the metadata component or override the default presets in the `app.config.json` file. If nothing else is set, the **default** preset is "\*", -which will use the "indifferent" config described below. +which will use the "indifferent" config described below. You can define as many extra presets as you need for your components. @@ -151,7 +151,7 @@ can be "cherry picked" and grouped into an accordion drawer, along with a transl #### Basic elements -The following config will produce one accordion group named "TRANSLATABLE_TITLE_FOR_GROUP_1", +The following config will produce one accordion group named "TRANSLATABLE_TITLE_FOR_GROUP\_1", with all the properties from `custom:aspect` followed by the two properties (`exif:pixelXDimension` and `exif:pixelYDimension`) from the `exif:exif` aspect and then one property (`custom:myPropertyName`) from `custom:type`: @@ -349,9 +349,9 @@ example below shows this with an aspect-oriented config: ### Making aspects and properties read only -Whenever you have properties that you want to protect from users editing their values you can add them to your configuration to make them read only. `readOnlyAspects` will make the whole aspect and its properties non editable. +Whenever you have properties that you want to protect from users editing their values you can add them to your configuration to make them read only. `readOnlyAspects` will make the whole aspect and its properties non editable. -If you want to disable the editing for specific properties you will need to add them to the `readOnlyProperties` property. +If you want to disable the editing for specific properties you will need to add them to the `readOnlyProperties` property. ```json "content-metadata": { @@ -392,13 +392,13 @@ To customize the separator used by this card you can set it in your `app.config. ### Use chips for multi value properties -If you want to display chips fo each value instead of a composed string you just need to enable it in the content-metadata config. +If you want to display chips fo each value instead of a composed string you just need to enable it in the content-metadata config. ![Chips for multi value properties](../../docassets/images/metadata-chips.png) ## Copy to Clipboard on click -For easier interaction with metadata properties you can enable the Copy to Clipboard feature from your configuration in the `app.config.json` file. +For easier interaction with metadata properties you can enable the Copy to Clipboard feature from your configuration in the `app.config.json` file. Once you have enabled this feature you will be able to double click on your metadata properties and they will get copied to your clipboard for you to use. diff --git a/docs/content-services/components/content-node-selector-panel.component.md b/docs/content-services/components/content-node-selector-panel.component.md index ff31d078ba..5d1f8795be 100644 --- a/docs/content-services/components/content-node-selector-panel.component.md +++ b/docs/content-services/components/content-node-selector-panel.component.md @@ -28,37 +28,38 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own ### Properties -| Name | Type | Default value | Description | -| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | -| currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. | -| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | -| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). | -| imageResolver | [`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. | -| isSelectionValid | [`ValidationFunction`](../../../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | -| pageSize | `number` | | Number of items shown per page in the list. | -| restrictRootToCurrentFolderId | `boolean` | false | If true will restrict the search and breadcrumbs to the currentFolderId | -| selectionMode | `"single" \| "multiple"` | "single" | Define the selection mode for document list. The allowed values are single or multiple | -| where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. | -| excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | -| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. | -| showDropdownSiteList | `boolean` | | Toggle sites list dropdown rendering | -| showFilesInResult | `void` | | Shows the files and folders in the search result | -| showSearch | `boolean` | | Toggle search input rendering | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | +| currentFolderId | `string` | null | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. | +| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | +| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). | +| imageResolver | [`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. | +| isSelectionValid | [`ValidationFunction`](../../../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | +| pageSize | `number` | | Number of items shown per page in the list. | +| restrictRootToCurrentFolderId | `boolean` | false | If true will restrict the search and breadcrumbs to the currentFolderId | +| selectionMode | `"single" \| "multiple"` | "single" | Define the selection mode for document list. The allowed values are single or multiple | +| where | `string` | | Custom *where* filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. | +| excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | +| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. | +| showDropdownSiteList | `boolean` | | Toggle sites list dropdown rendering | +| showFilesInResult | `void` | | Shows the files and folders in the search result | +| showSearch | `boolean` | | Toggle search input rendering | ### Events -| Name | Type | Description | -| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| navigationChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the navigation changes. | -| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` | Emitted when the user has chosen an item. | -| showingSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when search is running. | -| siteChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the select site changes. | -| currentFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` | Emitted when current folder loaded. | +| Name | Type | Description | +| --- | --- | --- | +| currentFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when current folder loaded. | +| folderLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when folder loaded. | +| navigationChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the navigation changes. | +| select | `EventEmitter` | Emitted when the user has chosen an item. | +| showingSearch | `EventEmitter` | Emitted when search is running. | +| siteChange | `EventEmitter` | Emitted when the select site changes. | ## Details -This component opens a _content node selector_ in its own dialog window. This behaves a lot like the +This component opens a *content node selector* in its own dialog window. This behaves a lot like the standard file open/save dialogs used by applications to choose files. Full details are given in the [Content Node Selector component](content-node-selector.component.md) page (this is similar but does not manage the dialog window for you). Also, the @@ -74,5 +75,5 @@ example of how to use this function. ## See also -- [Content Node Selector component](content-node-selector.component.md) -- [Content Node Dialog service](../services/content-node-dialog.service.md) +* [Content Node Selector component](content-node-selector.component.md) +* [Content Node Dialog service](../services/content-node-dialog.service.md) diff --git a/docs/content-services/components/document-list.component.md b/docs/content-services/components/document-list.component.md index ebef33f89f..5a1af65394 100644 --- a/docs/content-services/components/document-list.component.md +++ b/docs/content-services/components/document-list.component.md @@ -13,32 +13,32 @@ Displays the documents from a repository. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [DOM Events](#dom-events) - - [Conditional visibility](#conditional-visibility) - - [Card view](#card-view) - - [Pagination strategy](#pagination-strategy) - - [Data Sources](#data-sources) - - [Setting default folder](#setting-default-folder) - - [Calling DocumentList api directly](#calling-documentlist-api-directly) - - [Underlying node object](#underlying-node-object) - - [Custom columns](#custom-columns) - - [Column templates](#column-templates) - - [Date Column](#date-column) - - [Location Column](#location-column) - - [Actions](#actions) - - [Navigation mode](#navigation-mode) - - [Header filters](#header-filters) -- [Advanced usage and customization](#advanced-usage-and-customization) - - [Image Resolver and Row Filter functions](#image-resolver-and-row-filter-functions) - - [Custom 'empty folder' template](#custom-empty-folder-template) - - [Custom 'permission denied' template](#custom-permission-denied-template) - - [Custom 'loading' template](#custom-loading-template) -- [See also](#see-also) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [DOM Events](#dom-events) + * [Conditional visibility](#conditional-visibility) + * [Card view](#card-view) + * [Pagination strategy](#pagination-strategy) + * [Data Sources](#data-sources) + * [Setting default folder](#setting-default-folder) + * [Calling DocumentList api directly](#calling-documentlist-api-directly) + * [Underlying node object](#underlying-node-object) + * [Custom columns](#custom-columns) + * [Column templates](#column-templates) + * [Date Column](#date-column) + * [Location Column](#location-column) + * [Actions](#actions) + * [Navigation mode](#navigation-mode) + * [Header filters](#header-filters) +* [Advanced usage and customization](#advanced-usage-and-customization) + * [Image Resolver and Row Filter functions](#image-resolver-and-row-filter-functions) + * [Custom 'empty folder' template](#custom-empty-folder-template) + * [Custom 'permission denied' template](#custom-permission-denied-template) + * [Custom 'loading' template](#custom-loading-template) +* [See also](#see-also) ## Basic Usage @@ -55,52 +55,52 @@ Displays the documents from a repository. ### Properties -| Name | Type | Default value | Description | -| ---------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| additionalSorting | [`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | | Defines default sorting. The format is an array of strings `[key direction, otherKey otherDirection]` i.e. `['name desc', 'nodeType asc']` or `['name asc']`. Set this value if you want a base rule to be added to the sorting apart from the one driven by the header. | -| allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list or into another file to trigger updating it's version. When false, the dropped file will be added to the current folder (ie, the one containing all the items shown in the list). See the [Upload directive](../../core/directives/upload.directive.md) for further details about how the file drop is handled. | -| contentActions | `boolean` | false | Toggles content actions for each row | -| contentActionsPosition | `string` | "right" | Position of the content actions dropdown menu. Can be set to "left" or "right". | -| contextMenuActions | `boolean` | false | Toggles context menus for each row | -| currentFolderId | `string` | null | The ID of the folder node to display or a reserved string alias for special sources | -| display | `string` | DisplayMode.List | Change the display mode of the table. Can be "list" or "gallery". | -| emptyFolderImageUrl | `string` | | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' | -| filterValue | `any` | | Initial value for filter. | -| headerFilters | `boolean` | false | Toggles the header filters mode. | -| imageResolver | `any \| null` | null | Custom function to choose image file paths to show. See the [Image Resolver Model](image-resolver.model.md) page for more information. | -| includeFields | `string[]` | | Include additional information about the node in the server request. For example: association, isLink, isLocked and others. | -| loading | `boolean` | false | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. | -| locationFormat | `string` | "/" | The default route for all the location-based columns (if declared). | -| maxItems | `number` | | Default value is stored in the user preference settings. Use this only if you are not using pagination. | -| multiselect | `boolean` | false | Toggles multiselect mode | -| navigate | `boolean` | true | Toggles navigation to folder content or file preview | -| navigationMode | `string` | | [User](../../../lib/core/pipes/user-initial.pipe.ts) interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | -| node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) | null | The Document list will show all the nodes contained in the [NodePaging](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) entity | -| permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) page for further details and examples. | -| preselectNodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to be pre-selected. All nodes in the array are pre-selected in multi selection mode, but only the first node is pre-selected in single selection mode. | -| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. | -| rowStyleClass | `string` | | The CSS class to apply to every row | -| selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showHeader | `string` | ShowHeaderMode.Data | Toggles the header | -| sorting | `string[] \| `[`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. | -| sortingMode | `string` | "server" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | -| thumbnails | `boolean` | false | Show document thumbnails rather than icons | -| where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. | -| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](row-filter.model.md) page for more information. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| additionalSorting | [`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | | Defines default sorting. The format is an array of strings `[key direction, otherKey otherDirection]` i.e. `['name desc', 'nodeType asc']` or `['name asc']`. Set this value if you want a base rule to be added to the sorting apart from the one driven by the header. | +| allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list or into another file to trigger updating it's version. When false, the dropped file will be added to the current folder (ie, the one containing all the items shown in the list). See the [Upload directive](../../core/directives/upload.directive.md) for further details about how the file drop is handled. | +| contentActions | `boolean` | false | Toggles content actions for each row | +| contentActionsPosition | `string` | "right" | Position of the content actions dropdown menu. Can be set to "left" or "right". | +| contextMenuActions | `boolean` | false | Toggles context menus for each row | +| currentFolderId | `string` | null | The ID of the folder node to display or a reserved string alias for special sources | +| display | `string` | DisplayMode.List | Change the display mode of the table. Can be "list" or "gallery". | +| emptyFolderImageUrl | `string` | | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' | +| filterValue | `any` | | Initial value for filter. | +| headerFilters | `boolean` | false | Toggles the header filters mode. | +| imageResolver | `any \| null` | null | Custom function to choose image file paths to show. See the [Image Resolver Model](image-resolver.model.md) page for more information. | +| includeFields | `string[]` | | Include additional information about the node in the server request. For example: association, isLink, isLocked and others. | +| loading | `boolean` | false | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. | +| locationFormat | `string` | "/" | The default route for all the location-based columns (if declared). | +| maxItems | `number` | | Default value is stored in the user preference settings. Use this only if you are not using pagination. | +| multiselect | `boolean` | false | Toggles multiselect mode | +| navigate | `boolean` | true | Toggles navigation to folder content or file preview | +| navigationMode | `string` | | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | +| node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) | null | The Document list will show all the nodes contained in the [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) entity | +| permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) page for further details and examples. | +| preselectNodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to be pre-selected. All nodes in the array are pre-selected in multi selection mode, but only the first node is pre-selected in single selection mode. | +| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. | +| rowStyleClass | `string` | | The CSS class to apply to every row | +| selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showHeader | `string` | ShowHeaderMode.Data | Toggles the header | +| sorting | ` string[] \| `[`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | \['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. | +| sortingMode | `string` | "server" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option *does not* request the server to sort the data before delivering it. | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| thumbnails | `boolean` | false | Show document thumbnails rather than icons | +| where | `string` | | Filters the Node list using the *where* condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. | +| rowFilter | `RowFilter` | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](row-filter.model.md) page for more information. | ### Events -| Name | Type | Description | -| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the API fails to get the Document List data | -| filterSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterSearch`](../../../lib/content-services/src/lib/search/filter-search.interface.ts)`[]>` | Emitted when a filter value is selected | -| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes | -| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node | -| nodeDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node | -| nodeSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` | Emitted when the node selection change | -| preview | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the [Viewer component](../../core/components/viewer.component.md). | -| ready | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when the Document List has loaded all items and is ready for use | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the API fails to get the Document List data | +| filterSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterSearch`](../../../lib/content-services/src/lib/search/filter-search.interface.ts)`[]>` | Emitted when a filter value is selected | +| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes | +| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node | +| nodeDblClick | `EventEmitter` | Emitted when the user double-clicks a list node | +| nodeSelected | `EventEmitter` | Emitted when the node selection change | +| preview | `EventEmitter` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the Viewer component. | +| ready | `EventEmitter` | Emitted when the Document List has loaded all items and is ready for use | ## Details @@ -108,14 +108,14 @@ The properties `currentFolderId` and `node` set the initial folder shown by the Document List. They cannot be used together, so choose the one that suits your use case best. -The Document list will automatically show special icons for : `Smart Folder`, `Link to a Folder` and `Folder with rules` as shown below : +The Document list will automatically show special icons for : `Smart Folder`, `Link to a Folder` and `Folder with rules` as shown below : ![Document List Folders](../../docassets/images/document-list-special-folder-icon.png) ### DOM Events Below are the DOM events the DocumentList component emits. -All of them are _bubbling_, meaning you can handle them in any component up the parent hierarchy, even if the DocumentList is wrapped by one or more other components. +All of them are *bubbling*, meaning you can handle them in any component up the parent hierarchy, even if the DocumentList is wrapped by one or more other components. | Name | Description | | ------------- | ---------------------------------------- | @@ -182,7 +182,7 @@ Set the `[display]` property to "gallery" to enable card view mode: ### Pagination strategy -The Document List by default supports 2 types of pagination: [Pagination component](../../core/components/pagination.component.md) and [Infinite pagination component](../../core/components/infinite-pagination.component.md) +The Document List by default supports 2 types of pagination: [Pagination component](../../core/components/pagination.component.md) and [Infinite pagination component](../../core/components/infinite-pagination.component.md) #### Pagination component @@ -217,20 +217,20 @@ The unique identifier of the [`Node`](https://github.com/Alfresco/alfresco-js-ap You can use one of the well-known reserved aliases: -- `-root-` -- `-shared-` -- `-my-` +* `-root-` +* `-shared-` +* `-my-` #### Document List aliases The [Document List component](document-list.component.md) also provides support for the following reserved aliases: -- `-trashcan-`, -- `-sharedlinks-` -- `-sites-` -- `-mysites-` -- `-favorites-` -- `-recent-` +* `-trashcan-`, +* `-sharedlinks-` +* `-sites-` +* `-mysites-` +* `-favorites-` +* `-recent-` Note that due to the nature of the data, these sources do not support navigation. You may want to handle single and double clicks yourself to perform navigation to other sources. @@ -245,11 +245,11 @@ You can set the default location format using the `locationFormat` property to a The default column layout for non-reserved views is: -- Icon -- Name -- Size -- Modified (date) -- Modified by +* Icon +* Name +* Size +* Modified (date) +* Modified by **Trashcan** @@ -262,12 +262,12 @@ The default column layout for non-reserved views is: Default layout: -- Icon -- Name -- Location -- Size -- Deleted -- Deleted by +* Icon +* Name +* Location +* Size +* Deleted +* Deleted by **Shared Links** @@ -280,13 +280,13 @@ Default layout: Default layout: -- Icon -- Name -- Location -- Size -- Modified -- Modified by -- Shared by +* Icon +* Name +* Location +* Size +* Modified +* Modified by +* Shared by **Sites** @@ -298,9 +298,9 @@ Default layout: Default layout: -- Icon -- Title -- Status +* Icon +* Title +* Status **My Sites** @@ -312,9 +312,9 @@ Default layout: Default layout: -- Icon -- Title -- Status +* Icon +* Title +* Status **Favorites** @@ -327,12 +327,12 @@ Default layout: Default layout: -- Icon -- Name -- Location -- Size -- Modified -- Modified by +* Icon +* Name +* Location +* Size +* Modified +* Modified by **Recent Files** @@ -345,13 +345,13 @@ Default layout: Default layout: -- Icon -- Name -- Location +* Icon +* Name +* Location ### Setting default folder -You can set the current folder path by assigning a value to the `currentFolderId` property. +You can set the current folder path by assigning a value to the `currentFolderId` property. It can be either one of the well-known locations (such as **-root-**, **-shared-** or **-my-**), or a node ID (guid). @@ -400,12 +400,12 @@ export class FilesComponent implements OnInit { ``` -The `console.log(node)` for the `getNodeInfo` callback is just for study and debug purposes. +The `console.log(node)` for the `getNodeInfo` callback is just for study and debug purposes. It is useful for examining other information that you can access if necessary: ![documentLibrary](../../docassets/images/documentLibrary.png) -**Important note**: for this particular scenario you must also trigger `changeDetector.detectChanges()` as in the example above. +**Important note**: for this particular scenario you must also trigger `changeDetector.detectChanges()` as in the example above. ### Calling DocumentList api directly @@ -428,9 +428,9 @@ export class MyAppComponent { } ``` -However there may be scenarios where you need direct access to the Document List APIs. +However there may be scenarios where you need direct access to the Document List APIs. You can get a reference to the Document List instance using the Angular **Component Interaction** API. -See the [Parent calls a ViewChild](https://angular.io/docs/ts/latest/cookbook/component-communication.html#!#parent-to-view-child) +See the [Parent calls a ViewChild](https://angular.io/docs/ts/latest/cookbook/component-communication.html#!#parent-to-view-child) section of the Angular docs for more information. Below is an example of getting a reference: @@ -473,7 +473,7 @@ Now you can access Document List properties or call methods directly: console.log(documentList.currentFolderId); ``` -**Important note**: +**Important note**:\ You must not access child components any earlier in the component lifecycle than the `AfterViewInit` state. Any UI click (buttons, links, etc.) event handlers are fine but an earlier event like `ngOnInit` is not. @@ -483,7 +483,7 @@ documentation for a full explanation of the component lifecycle. ### Underlying node object -The [Document List component](document-list.component.md) assigns an instance of +The [Document List component](document-list.component.md) assigns an instance of the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) class (defined in the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api)) as the data context for each row. You can make use of the properties of this object when defining custom columns: @@ -589,7 +589,7 @@ For example: ``` All the components above also participate in [Extensibility](../../user-guide/app-extensions.md) -and can be used to compose DocumentList layouts from within the plugins. +and can be used to compose DocumentList layouts from within the plugins. ### Date Column @@ -607,16 +607,16 @@ This column displays a clickable location link pointing to the parent path of th **Important note**: -_For granular permissions, the Location Column may or may not render the link location_ +*For granular permissions, the Location Column may or may not render the link location* You would normally use this with custom navigation or when displaying content from sources like: -- Sites -- My Sites -- Shared Links -- Recent Files -- Favorites -- Trashcan +* Sites +* My Sites +* Shared Links +* Recent Files +* Favorites +* Trashcan ...or any other location where the user needs to be able to navigate to the node parent folder easily. @@ -656,7 +656,7 @@ you can also define your own actions. See the [Content Action component](content-action.component.md) for more information and examples. -You can also use the [Context Menu directive](../../core/directives/context-menu.directive.md) from the +You can also use the [Context Menu directive](../../core/directives/context-menu.directive.md) from the ADF Core library to show the actions you have defined in a context menu: @@ -711,8 +711,8 @@ You can enable Header filters in your document list simply setting to true its ` The Document List has two properties that let you modify behavior with custom functions: -- `imageResolver` - Specifies a function to choose image file paths for icons and thumbnails. -- `rowFilter` - Selects whether a row is shown or hidden according to its data content. +* `imageResolver` - Specifies a function to choose image file paths for icons and thumbnails. +* `rowFilter` - Selects whether a row is shown or hidden according to its data content. See the [Image Resolver Model](../models/image-resolver.model.md) and [Row Filter Model](../models/row-filter.model.md) pages for details of how to @@ -782,18 +782,18 @@ This will give the following output: ## See also -- [Datatable component](../../core/components/datatable.component.md) -- [Data column component](../../core/components/data-column.component.md) -- [Pagination component](../../core/components/pagination.component.md) -- [Infinite pagination component](../../core/components/infinite-pagination.component.md) -- [Sites dropdown component](sites-dropdown.component.md) -- [Metadata indicators](../../user-guide/metadata-indicators.md) -- [Nodes api service](../../core/services/nodes-api.service.md) -- [Breadcrumb component](breadcrumb.component.md) -- [Content action component](content-action.component.md) -- [Content node selector component](content-node-selector.component.md) -- [Document list service](../services/document-list.service.md) -- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) -- [Permissions style model](../models/permissions-style.model.md) -- [Version manager component](version-manager.component.md) -- [Viewer component](../../core/components/viewer.component.md) +* [Datatable component](../../core/components/datatable.component.md) +* [Data column component](../../core/components/data-column.component.md) +* [Pagination component](../../core/components/pagination.component.md) +* [Infinite pagination component](../../core/components/infinite-pagination.component.md) +* [Sites dropdown component](sites-dropdown.component.md) +* [Metadata indicators](../../user-guide/metadata-indicators.md) +* [Nodes api service](../../core/services/nodes-api.service.md) +* [Breadcrumb component](breadcrumb.component.md) +* [Content action component](content-action.component.md) +* [Content node selector component](content-node-selector.component.md) +* [Document list service](../services/document-list.service.md) +* [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) +* [Permissions style model](../models/permissions-style.model.md) +* [Version manager component](version-manager.component.md) +* [Viewer component](../../core/components/viewer.component.md) diff --git a/docs/content-services/components/dropdown-breadcrumb.component.md b/docs/content-services/components/dropdown-breadcrumb.component.md index 16c22e83ab..e44e704473 100644 --- a/docs/content-services/components/dropdown-breadcrumb.component.md +++ b/docs/content-services/components/dropdown-breadcrumb.component.md @@ -24,28 +24,28 @@ Indicates the current position within a navigation hierarchy using a dropdown me ### Properties -| Name | Type | Default value | Description | -| ---------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | -| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | -| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | -| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | -| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | -| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | +| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | +| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | +| rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | +| target | [`DocumentListComponent`](../../content-services/components/document-list.component.md) | | (optional) [Document List component](../../content-services/components/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | +| transform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | ### Events -| Name | Type | Description | -| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | ## Details Although this component inherits the `maxItems` property from the [Breadcrumb component,](breadcrumb.component.md) the -"crumbs" are _always_ shown on a menu. By contrast, the [Breadcrumb component](breadcrumb.component.md) only falls back -to a menu when its maximum number of nodes is exceeded. +"crumbs" are *always* shown on a menu. By contrast, the [Breadcrumb component](breadcrumb.component.md) only falls back +to a menu when its maximum number of nodes is exceeded. ## See also -- [Document list component](document-list.component.md) -- [Breadcrumb component](breadcrumb.component.md) +* [Document list component](document-list.component.md) +* [Breadcrumb component](breadcrumb.component.md) diff --git a/docs/content-services/components/file-uploading-dialog.component.md b/docs/content-services/components/file-uploading-dialog.component.md index ff45494fc9..f2ee3095f4 100644 --- a/docs/content-services/components/file-uploading-dialog.component.md +++ b/docs/content-services/components/file-uploading-dialog.component.md @@ -19,14 +19,14 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are ### Properties -| Name | Type | Default value | Description | -| -------- | -------- | ------------- | ------------------------------------------ | -| position | `string` | "right" | Dialog position. Can be 'left' or 'right'. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| position | `string` | "right" | Dialog position. Can be 'left' or 'right'. | ### Events -| Name | Type | Description | -| ----- | ----------------------------------------------------------------- | --------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file in the list has an error. | ## Details @@ -37,6 +37,6 @@ This component should be used in combination with the ## See also -- [Upload button component](upload-button.component.md) -- [Upload drag area component](upload-drag-area.component.md) -- [File upload error pipe](../pipes/file-upload-error.pipe.md) +* [Upload button component](upload-button.component.md) +* [Upload drag area component](upload-drag-area.component.md) +* [File upload error pipe](../pipes/file-upload-error.pipe.md) diff --git a/docs/content-services/components/like.component.md b/docs/content-services/components/like.component.md index b64fccf501..9af0dcf856 100644 --- a/docs/content-services/components/like.component.md +++ b/docs/content-services/components/like.component.md @@ -21,17 +21,17 @@ Allows a user to add "likes" to an item. ### Properties -| Name | Type | Default value | Description | -| ------ | -------- | ------------- | --------------------------------------- | -| nodeId | `string` | | Identifier of a node to apply likes to. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeId | `string` | | Identifier of a node to apply likes to. | ### Events -| Name | Type | Description | -| ---------- | ----------------------------------------------------------------- | ------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also -- [Rating component](rating.component.md) -- [Rating service](../services/rating.service.md) +* [Rating component](rating.component.md) +* [Rating service](../services/rating.service.md) diff --git a/docs/content-services/components/permission-list.component.md b/docs/content-services/components/permission-list.component.md index 5963af5d58..c9decfa7c5 100644 --- a/docs/content-services/components/permission-list.component.md +++ b/docs/content-services/components/permission-list.component.md @@ -20,8 +20,8 @@ Shows node permissions as a table. ### [Transclusions](../../user-guide/transclusion.md) -When the list is empty, the contents will simply say "No permissions" by default, -but you can also supply your own content: +When the list is empty, the contents will simply say "No permissions" by default, +but you can also supply your own content: ```html @@ -35,15 +35,15 @@ but you can also supply your own content: ### Properties -| Name | Type | Default value | Description | -| ------ | -------- | ------------- | -------------------------------------------------- | -| nodeId | `string` | "" | ID of the node whose permissions you want to show. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeId | `string` | "" | ID of the node whose permissions you want to show. | ### Events -| Name | Type | Description | -| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`>` | Emitted when the permission is updated. | ## Details diff --git a/docs/content-services/components/rating.component.md b/docs/content-services/components/rating.component.md index c8bc7fb26d..61fd386be6 100644 --- a/docs/content-services/components/rating.component.md +++ b/docs/content-services/components/rating.component.md @@ -32,17 +32,17 @@ If the average is decimal number it will be rounded. ### Properties -| Name | Type | Default value | Description | -| ------ | -------- | ------------- | ---------------------------------------------- | -| nodeId | `string` | | Identifier of the node to apply the rating to. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeId | `string` | | Identifier of the node to apply the rating to. | ### Events -| Name | Type | Description | -| ---------- | ----------------------------------------------------------------- | ------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also -- [Like component](like.component.md) -- [Rating service](../services/rating.service.md) +* [Like component](like.component.md) +* [Rating service](../services/rating.service.md) diff --git a/docs/content-services/components/search-chip-list.component.md b/docs/content-services/components/search-chip-list.component.md index 0a2298984d..f7ce9435a5 100644 --- a/docs/content-services/components/search-chip-list.component.md +++ b/docs/content-services/components/search-chip-list.component.md @@ -22,7 +22,7 @@ Displays search criteria as a set of "chips". ### Properties -| Name | Type | Default value | Description | -| ------------ | --------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------- | -| clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. | -| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. | +| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. | diff --git a/docs/content-services/components/search-control.component.md b/docs/content-services/components/search-control.component.md index 02e5b1c63b..b1ae2e9c1f 100644 --- a/docs/content-services/components/search-control.component.md +++ b/docs/content-services/components/search-control.component.md @@ -40,22 +40,22 @@ You can show your own custom template when no results are found for the search: ### Properties -| Name | Type | Default value | Description | -| -------------------- | --------- | ------------- | ------------------------------------------------------------------------------------------ | -| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | -| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. | -| highlight | `boolean` | false | Toggles highlighting of the search term in the results. | -| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). | -| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. | -| liveSearchMaxResults | `number` | 5 | Maximum number of results to show in the live search. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | +| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. | +| highlight | `boolean` | false | Toggles highlighting of the search term in the results. | +| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). | +| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. | +| liveSearchMaxResults | `number` | 5 | Maximum number of results to show in the live search. | ### Events -| Name | Type | Description | -| ------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file item from the list of "find-as-you-type" results is selected. | -| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | -| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | +| Name | Type | Description | +| --- | --- | --- | +| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file item from the list of "find-as-you-type" results is selected. | +| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | +| submit | `EventEmitter` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | ## Details diff --git a/docs/content-services/components/search-filter.component.md b/docs/content-services/components/search-filter.component.md index 0c42d75f48..b1b18839b5 100644 --- a/docs/content-services/components/search-filter.component.md +++ b/docs/content-services/components/search-filter.component.md @@ -11,17 +11,18 @@ Represents a main container component for custom search and faceted search setti ## Contents -- [Basic usage](#basic-usage) -- [Details](#details) - - [Configuration](#configuration) - - [Extra fields and filter queries](#extra-fields-and-filter-queries) - - [Sorting](#sorting) - - [Categories and widgets](#categories-and-widgets) - - [Facet Fields](#facet-fields) - - [Facet Queries](#facet-queries) - - [Facet Intervals](#facet-intervals) - - [Highlight](#highlight) -- [See also](#see-also) +* [Basic usage](#basic-usage) + * [Properties](#properties) +* [Details](#details) + * [Configuration](#configuration) + * [Extra fields and filter queries](#extra-fields-and-filter-queries) + * [Sorting](#sorting) + * [Categories and widgets](#categories-and-widgets) + * [Facet Fields](#facet-fields) + * [Facet Queries](#facet-queries) + * [Facet Intervals](#facet-intervals) + * [Highlight](#highlight) +* [See also](#see-also) ## Basic usage @@ -44,9 +45,9 @@ to build and execute the query. You may find it useful to check out the following resources for background information before customizing the search UI: -- [Search API](https://docs.alfresco.com/5.2/concepts/search-api.html) -- [Alfresco Full Text Search Reference](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-intro.html) -- [ACS API Explorer](https://api-explorer.alfresco.com/api-explorer/#!/search/search) +* [Search API](https://docs.alfresco.com/5.2/concepts/search-api.html) +* [Alfresco Full Text Search Reference](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-intro.html) +* [ACS API Explorer](https://api-explorer.alfresco.com/api-explorer/#!/search/search) ### Configuration @@ -166,14 +167,14 @@ settings: } ``` -Note that the entries of the `filterQueries` array are joined using the `AND` operator. +Note that the entries of the `filterQueries` array are joined using the `AND` operator. ### Sorting The Sorting configuration section consists of two blocks: -- `options`: a list of items that users can select from -- `defaults`: predefined sorting to use by default +* `options`: a list of items that users can select from +* `defaults`: predefined sorting to use by default ```json { @@ -258,7 +259,7 @@ page for full details of how to do this. Each type of [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) has its own settings. For example Number editors may parse minimum and maximum values, while Text editors can support value formats or length constraints. -You can use `component.settings` to pass any information to a [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) using the +You can use `component.settings` to pass any information to a [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) using the [`SearchWidgetSettings`](../../../lib/content-services/src/lib/search/search-widget-settings.interface.ts) interface: ```ts @@ -287,9 +288,9 @@ export interface SearchWidgetSettings { } ``` -Every field declared within the `facetFields` group is presented by a separate collapsible category at runtime. +Every field declared within the `facetFields` group is presented by a separate collapsible category at runtime. -By default, users see only the top 5 entries. +By default, users see only the top 5 entries. If there are more than 5 entries, a button to show more items is displayed to let the user move to the next block of results. @@ -488,13 +489,13 @@ then be added in each node entry response. An example partial response is shown ## See also -- [Search Query Builder service](../services/search-query-builder.service.md) -- [Search Chip List Component](search-chip-list.component.md) -- [Search Sorting Picker Component](search-sorting-picker.component.md) -- [Search Widget Interface](../interfaces/search-widget.interface.md) -- [Search check list component](search-check-list.component.md) -- [Search date range component](search-date-range.component.md) -- [Search number range component](search-number-range.component.md) -- [Search radio component](search-radio.component.md) -- [Search slider component](search-slider.component.md) -- [Search text component](search-text.component.md) +* [Search Query Builder service](../services/search-query-builder.service.md) +* [Search Chip List Component](search-chip-list.component.md) +* [Search Sorting Picker Component](search-sorting-picker.component.md) +* [Search Widget Interface](../interfaces/search-widget.interface.md) +* [Search check list component](search-check-list.component.md) +* [Search date range component](search-date-range.component.md) +* [Search number range component](search-number-range.component.md) +* [Search radio component](search-radio.component.md) +* [Search slider component](search-slider.component.md) +* [Search text component](search-text.component.md) diff --git a/docs/content-services/components/search.component.md b/docs/content-services/components/search.component.md index 50cbda225e..78a7a23c28 100644 --- a/docs/content-services/components/search.component.md +++ b/docs/content-services/components/search.component.md @@ -7,19 +7,19 @@ Last reviewed: 2019-01-16 # [Search component](../../../lib/content-services/src/lib/search/components/search.component.ts "Defined in search.component.ts") -Searches items for supplied search terms. +Searches items for supplied search terms. ## Contents -- [Basic usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Customise Search Results](#customise-search-results) - - [Attach an input field to the search](#attach-an-input-field-to-the-search) - - [Custom search configuration](#custom-search-configuration) -- [See Also](#see-also) +* [Basic usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Customise Search Results](#customise-search-results) + * [Attach an input field to the search](#attach-an-input-field-to-the-search) + * [Custom search configuration](#custom-search-configuration) +* [See Also](#see-also) ## Basic usage @@ -34,19 +34,19 @@ Searches items for supplied search terms. ### Properties -| Name | Type | Default value | Description | -| ----------- | ------------------ | ------------- | --------------------------------------------------------------------------------------------------------------- | -| displayWith | `Function \| null` | null | Function that maps an option's value to its display value in the trigger. | -| maxResults | `number` | 20 | Maximum number of results to show in the search. | -| searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. | -| skipResults | `number` | 0 | Number of results to skip from the results pagination. | -| classList | `void` | | CSS class for display. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| displayWith | `Function \| null` | null | Function that maps an option's value to its display value in the trigger. | +| maxResults | `number` | 20 | Maximum number of results to show in the search. | +| searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. | +| skipResults | `number` | 0 | Number of results to skip from the results pagination. | +| classList | `void` | | CSS class for display. | ### Events -| Name | Type | Description | -| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when search results have fully loaded. | ## Details @@ -71,11 +71,11 @@ You can add a custom template to show the search results when once they are load -The results are provided via the [$implicit variable of angular2](https://angular.io/api/common/NgTemplateOutlet) and can be accessed via the sugar syntax 'let-yourChosenName'. The example above will give results like the following: +The results are provided via the [$implicit variable of angular2](https://angular.io/api/common/NgTemplateOutlet) and can be accessed via the sugar syntax 'let-yourChosenName'. The example above will give results like the following: ![adf-search-control](../../docassets/images/search-component-simple-template.png) -However, you can use a more complex template if necessary: +However, you can use a more complex template if necessary: @@ -160,5 +160,5 @@ customize your search. ## See Also -- [Search configuration interface](../../core/interfaces/search-configuration.interface.md) -- [Search configuration service](../../core/services/search-configuration.service.md) +* [Search configuration interface](../../core/interfaces/search-configuration.interface.md) +* [Search configuration service](../../core/services/search-configuration.service.md) diff --git a/docs/content-services/components/sites-dropdown.component.md b/docs/content-services/components/sites-dropdown.component.md index b4451bea6d..2826306a19 100644 --- a/docs/content-services/components/sites-dropdown.component.md +++ b/docs/content-services/components/sites-dropdown.component.md @@ -23,16 +23,16 @@ Displays a dropdown menu to show and interact with the sites of the current user ### Properties -| Name | Type | Default value | Description | -| ----------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| hideMyFiles | `boolean` | false | Hide the "My Files" option. | -| placeholder | `string` | | Text or a translation key to act as a placeholder. Default value is the key "DROPDOWN.PLACEHOLDER_LABEL". | -| relations | `string` | | Filter for the results of the sites query. Possible values are "members" and "containers". When "members" is used, the site list will be restricted to the sites that the user is a member of. | -| siteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. | -| value | `string` | null | Id of the selected site | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| hideMyFiles | `boolean` | false | Hide the "My Files" option. | +| placeholder | `string` | | Text or a translation key to act as a placeholder. Default value is the key "DROPDOWN.PLACEHOLDER_LABEL". | +| relations | `string` | | Filter for the results of the sites query. Possible values are "members" and "containers". When "members" is used, the site list will be restricted to the sites that the user is a member of. | +| siteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. | +| value | `string` | null | Id of the selected site | ### Events -| Name | Type | Description | -| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` | Emitted when the user selects a site. When the default option is selected, an empty model is emitted. | diff --git a/docs/content-services/components/tag-actions.component.md b/docs/content-services/components/tag-actions.component.md index 66515603ab..e345dd139e 100644 --- a/docs/content-services/components/tag-actions.component.md +++ b/docs/content-services/components/tag-actions.component.md @@ -23,14 +23,14 @@ Shows available actions for tags. ### Properties -| Name | Type | Default value | Description | -| ------ | -------- | ------------- | ------------------------- | -| nodeId | `string` | | The identifier of a node. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeId | `string` | | The identifier of a node. | ### Events -| Name | Type | Description | -| ---------- | ----------------------------------------------------------------- | ----------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an action is chosen. | -| successAdd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is added successfully. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an action is chosen. | +| successAdd | `EventEmitter` | Emitted when a tag is added successfully. | diff --git a/docs/content-services/components/tag-list.component.md b/docs/content-services/components/tag-list.component.md index 94cc36d920..01d389692c 100644 --- a/docs/content-services/components/tag-list.component.md +++ b/docs/content-services/components/tag-list.component.md @@ -15,10 +15,10 @@ Shows tags for an item. ### Events -| Name | Type | Description | -| ------ | ----------------------------------------------------------------- | ------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | ## See Also -- [Tag service](../services/tag.service.md) +* [Tag service](../services/tag.service.md) diff --git a/docs/content-services/components/tag-node-list.component.md b/docs/content-services/components/tag-node-list.component.md index 9e2fe3cb77..dfb6501558 100644 --- a/docs/content-services/components/tag-node-list.component.md +++ b/docs/content-services/components/tag-node-list.component.md @@ -23,13 +23,13 @@ Shows tags for a node. ### Properties -| Name | Type | Default value | Description | -| ---------- | --------- | ------------- | ------------------------- | -| nodeId | `string` | | The identifier of a node. | -| showDelete | `boolean` | true | Show delete button | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeId | `string` | | The identifier of a node. | +| showDelete | `boolean` | true | Show delete button | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | diff --git a/docs/content-services/components/tree-view.component.md b/docs/content-services/components/tree-view.component.md index b0ca5ec392..8d1965866a 100644 --- a/docs/content-services/components/tree-view.component.md +++ b/docs/content-services/components/tree-view.component.md @@ -23,13 +23,13 @@ Shows the folder and subfolders of a node as a tree view. ### Properties -| Name | Type | Default value | Description | -| ------ | -------- | ------------- | ---------------------------------- | -| nodeId | `string` | | Identifier of the node to display. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeId | `string` | | Identifier of the node to display. | ### Events -| Name | Type | Description | -| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an invalid node id is given. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an invalid node id is given. | | nodeClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` | Emitted when a node in the tree view is clicked. | diff --git a/docs/content-services/components/upload-button.component.md b/docs/content-services/components/upload-button.component.md index 5bf296b61b..38b56c7b72 100644 --- a/docs/content-services/components/upload-button.component.md +++ b/docs/content-services/components/upload-button.component.md @@ -27,31 +27,31 @@ Activates a file upload. ### Properties -| Name | Type | Default value | Description | -| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | -| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | -| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | -| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' | -| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | -| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | -| multipleFiles | `boolean` | false | Allows/disallows multiple files | -| nodeType | `string` | "cm:content" | Custom node type for uploaded file | -| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | -| staticTitle | `string` | | Defines the text of the upload button. | -| tooltip | `string` | null | Custom tooltip text. | -| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). | -| versioning | `boolean` | false | Toggles versioning. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | +| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | +| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | +| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' | +| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | +| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | +| multipleFiles | `boolean` | false | Allows/disallows multiple files | +| nodeType | `string` | "cm:content" | Custom node type for uploaded file | +| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | +| staticTitle | `string` | | Defines the text of the upload button. | +| tooltip | `string` | null | Custom tooltip text. | +| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). | +| versioning | `boolean` | false | Toggles versioning. | ### Events -| Name | Type | Description | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | -| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | +| Name | Type | Description | +| --- | --- | --- | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | +| success | `EventEmitter` | Emitted when the file is uploaded successfully. | +| updateFileVersion | `EventEmitter>` | Emitted when dropping a file over another file to update the version. | ## Details @@ -59,7 +59,7 @@ Activates a file upload. You can show a notification error when the user doesn't have the right permission to perform the action. The component emits a `permissionEvent` when the user does not have delete permission. -You can subscribe to this event from your component and use the +You can subscribe to this event from your component and use the [Notification service](../../core/services/notification.service.md) to show a message. ```html @@ -85,5 +85,5 @@ export class MyComponent { ## See also -- [Upload Version Button component](upload-version-button.component.md) -- [File upload error pipe](../pipes/file-upload-error.pipe.md) +* [Upload Version Button component](upload-version-button.component.md) +* [File upload error pipe](../pipes/file-upload-error.pipe.md) diff --git a/docs/content-services/components/upload-drag-area.component.md b/docs/content-services/components/upload-drag-area.component.md index 1e27528df0..fc667c4c1c 100644 --- a/docs/content-services/components/upload-drag-area.component.md +++ b/docs/content-services/components/upload-drag-area.component.md @@ -11,15 +11,15 @@ Adds a drag and drop area to upload files to ACS. ## Contents -- [Basic Usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Intercepting uploads](#intercepting-uploads) - - [Example](#example) -- [See also](#see-also) +* [Basic Usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Intercepting uploads](#intercepting-uploads) + * [Example](#example) +* [See also](#see-also) ## Basic Usage @@ -59,37 +59,37 @@ as the drag/drop target: ### Properties -| Name | Type | Default value | Description | -| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | -| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | -| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | -| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | -| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | -| nodeType | `string` | "cm:content" | Custom node type for uploaded file | -| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | -| versioning | `boolean` | false | Toggles versioning. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | +| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | +| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | +| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | +| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | +| nodeType | `string` | "cm:content" | Custom node type for uploaded file | +| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | +| versioning | `boolean` | false | Toggles versioning. | ### Events -| Name | Type | Description | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | -| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | +| Name | Type | Description | +| --- | --- | --- | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | `EventEmitter` | Emitted when the file is uploaded successfully. | +| updateFileVersion | `EventEmitter>` | Emitted when dropping a file over another file to update the version. | ## Details ### Intercepting uploads -You can intercept the upload process using the `beginUpload` event. +You can intercept the upload process using the `beginUpload` event. The event has a type of [`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts) and provides the following APIs: -- **files**: accesses the [`FileInfo`](../../../lib/core/utils/file-utils.ts) objects that are prepared for the upload -- **pauseUpload**: pauses the upload and performs additional tasks, like showing the confirmation dialog -- **resumeUpload**: resumes the upload process +* **files**: accesses the [`FileInfo`](../../../lib/core/utils/file-utils.ts) objects that are prepared for the upload +* **pauseUpload**: pauses the upload and performs additional tasks, like showing the confirmation dialog +* **resumeUpload**: resumes the upload process ### Example @@ -139,6 +139,6 @@ This could be either a selection of 2 or more files, or a folder with multiple e ## See also -- [File uploading dialog component](file-uploading-dialog.component.md) -- [Upload button component](upload-button.component.md) -- [File upload error pipe](../pipes/file-upload-error.pipe.md) +* [File uploading dialog component](file-uploading-dialog.component.md) +* [Upload button component](upload-button.component.md) +* [File upload error pipe](../pipes/file-upload-error.pipe.md) diff --git a/docs/content-services/components/upload-version-button.component.md b/docs/content-services/components/upload-version-button.component.md index c4f3a127dc..1773b26b7b 100644 --- a/docs/content-services/components/upload-version-button.component.md +++ b/docs/content-services/components/upload-version-button.component.md @@ -29,40 +29,40 @@ to enrich the features and decrease the restrictions currently applied to node v ### Properties -| Name | Type | Default value | Description | -| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | -| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | -| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | -| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' | -| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | -| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | -| multipleFiles | `boolean` | false | Allows/disallows multiple files | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (**Required**) The node to be versioned. | -| nodeType | `string` | "cm:content" | Custom node type for uploaded file | -| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | -| staticTitle | `string` | | Defines the text of the upload button. | -| tooltip | `string` | null | Custom tooltip text. | -| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). | -| versioning | `boolean` | false | Toggles versioning. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | +| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | +| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | +| file | `File` | | Custom added file. The upload button type will be 'button' instead of 'file' | +| majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | +| maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | +| multipleFiles | `boolean` | false | Allows/disallows multiple files | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | (**Required**) The node to be versioned. | +| nodeType | `string` | "cm:content" | Custom node type for uploaded file | +| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | +| staticTitle | `string` | | Defines the text of the upload button. | +| tooltip | `string` | null | Custom tooltip text. | +| uploadFolders | `boolean` | false | Allows/disallows upload folders (only for Chrome). | +| versioning | `boolean` | false | Toggles versioning. | ### Events -| Name | Type | Description | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | -| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | +| Name | Type | Description | +| --- | --- | --- | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | +| success | `EventEmitter` | Emitted when the file is uploaded successfully. | +| updateFileVersion | `EventEmitter>` | Emitted when dropping a file over another file to update the version. | ## Details This component extends the [Upload Button component](upload-button.component.md). The properties and events are the same except for the `node` property that specifies the node -to be versioned (this is a _required_ input parameter). However, some properties don't make +to be versioned (this is a *required* input parameter). However, some properties don't make sense when applied to the [Upload Version Button component](upload-version-button.component.md) so they are simply ignored. ## See also -- [Upload Button component](upload-button.component.md) +* [Upload Button component](upload-button.component.md) diff --git a/docs/content-services/components/version-comparison.component.md b/docs/content-services/components/version-comparison.component.md index 9f96219c59..3b48157b60 100644 --- a/docs/content-services/components/version-comparison.component.md +++ b/docs/content-services/components/version-comparison.component.md @@ -24,7 +24,7 @@ Displays the side by side comparison between the current target node (type, name ### Properties -| Name | Type | Default value | Description | -| -------------- | -------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- | -| newFileVersion | `File` | | New file for updating current version. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| newFileVersion | `File` | | New file for updating current version. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node. | diff --git a/docs/content-services/components/version-list.component.md b/docs/content-services/components/version-list.component.md index 69cafb70d8..8a687a45cc 100644 --- a/docs/content-services/components/version-list.component.md +++ b/docs/content-services/components/version-list.component.md @@ -19,21 +19,21 @@ Displays the version history of a node in a [Version Manager component](version- ### Properties -| Name | Type | Default value | Description | -| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------- | -| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | -| allowViewVersions | `boolean` | true | Enable/disable viewing a version of the current node. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. | -| showActions | `boolean` | true | Toggles showing/hiding of version actions | -| showComments | `boolean` | true | Toggles showing/hiding of comments | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | +| allowViewVersions | `boolean` | true | Enable/disable viewing a version of the current node. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. | +| showActions | `boolean` | true | Toggles showing/hiding of version actions | +| showComments | `boolean` | true | Toggles showing/hiding of comments | ### Events -| Name | Type | Description | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- | -| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is deleted | -| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is restored | -| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when viewing a version | +| Name | Type | Description | +| --- | --- | --- | +| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is deleted | +| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is restored | +| viewVersion | `EventEmitter` | Emitted when viewing a version | ## Details @@ -48,4 +48,4 @@ If you want show readonly version list you set this component with showActions f ## See also -- [Version manager component](version-manager.component.md) +* [Version manager component](version-manager.component.md) diff --git a/docs/content-services/components/version-manager.component.md b/docs/content-services/components/version-manager.component.md index bf97e16285..d10c29bf99 100644 --- a/docs/content-services/components/version-manager.component.md +++ b/docs/content-services/components/version-manager.component.md @@ -27,22 +27,22 @@ Displays the version history of a node with the ability to upload a new version. ### Properties -| Name | Type | Default value | Description | -| --------------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | -| newFileVersion | `File` | | New file for updating current version. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node to manage version history. | -| showComments | `boolean` | true | Toggles showing/hiding of comments. | -| showVersionComparison | `boolean` | false | Toggles showing/hiding the [version comparison component](../../content-services/components/version-comparison.component.md). | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | +| newFileVersion | `File` | | New file for updating current version. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node to manage version history. | +| showComments | `boolean` | true | Toggles showing/hiding of comments. | +| showVersionComparison | `boolean` | false | Toggles showing/hiding the [version comparison component](../../content-services/components/version-comparison.component.md). | ### Events -| Name | Type | Description | -| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | -| uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an cancelling during upload. | -| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when an error occurs during upload. | -| uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a file is uploaded successfully. | -| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when viewing a version. | +| Name | Type | Description | +| --- | --- | --- | +| uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an cancelling during upload. | +| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when an error occurs during upload. | +| uploadSuccess | `EventEmitter` | Emitted when a file is uploaded successfully. | +| viewVersion | `EventEmitter` | Emitted when viewing a version. | ## Details @@ -56,5 +56,5 @@ Each version has a context menu on the right, with the following actions. ## See also -- [Version list component](version-list.component.md) -- [Document list component](document-list.component.md) +* [Version list component](version-list.component.md) +* [Document list component](document-list.component.md) diff --git a/docs/content-services/components/version-upload.component.md b/docs/content-services/components/version-upload.component.md index 377ae6926f..1c0228eea2 100644 --- a/docs/content-services/components/version-upload.component.md +++ b/docs/content-services/components/version-upload.component.md @@ -5,7 +5,7 @@ Status: Experimental Last reviewed: 2020-11-06 --- -# [Version Upload component](../../../lib/content-services/src/lib/version-manager/version-upload.component.ts "Defined in version-list.component.ts") +# [Version Upload component](../../../lib/content-services/src/lib/version-manager/version-upload.component.ts "Defined in version-upload.component.ts") Displays the new version's minor/major changes and the optional comment of a node in a [Version Manager component](version-manager.component.md). @@ -19,22 +19,22 @@ Displays the new version's minor/major changes and the optional comment of a nod ### Properties -| Name | Type | Default value | Description | -| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------- | -| showUploadButton | `boolean` | true | Toggles showing/hiding the upload button. | -| showCancelButton | `boolean` | true | Toggles showing/hiding the cancel button. | -| newFileVersion | `File` | | Used to create a new version of the current node. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| newFileVersion | `File` | | New file for updating current version. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. | +| showCancelButton | `boolean` | true | Toggles showing/hiding of cancel button. | +| showUploadButton | `boolean` | true | Toggles showing/hiding upload button. | ### Events -| Name | Type | Description | -| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter) | Emitted when a new version is successfully uploaded | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter) | Emitted when a new version throws an error | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter) | Emitted when cancelling uploading a new version | -| versionChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the type of the new version is picked (minor/major) | -| commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the comment of the new version has changed. | +| Name | Type | Description | +| --- | --- | --- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an cancelling during upload. | +| commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the comment is changed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | +| versionChanged | `EventEmitter` | Emitted when the version is changed. | ## Details @@ -43,4 +43,4 @@ load and displays the new node's version choice - minor/major & comment. ## See also -- [Version manager component](version-manager.component.md) +* [Version manager component](version-manager.component.md) diff --git a/docs/content-services/components/webscript.component.md b/docs/content-services/components/webscript.component.md index be7d65f4aa..8ae95eefd2 100644 --- a/docs/content-services/components/webscript.component.md +++ b/docs/content-services/components/webscript.component.md @@ -11,14 +11,14 @@ Provides access to Webscript features. ## Contents -- [Basic usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Webscript View HTML example](#webscript-view-html-example) - - [Webscript View DATATABLE example](#webscript-view-datatable-example) - - [Webscript View JSON example](#webscript-view-json-example) +* [Basic usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Webscript View HTML example](#webscript-view-html-example) + * [Webscript View DATATABLE example](#webscript-view-datatable-example) + * [Webscript View JSON example](#webscript-view-json-example) ## Basic usage @@ -62,19 +62,19 @@ export class AppComponent { ### Properties -| Name | Type | Default value | Description | -| ----------- | --------- | ------------- | -------------------------------------------------------------------------------------------------------------- | -| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" | -| contextRoot | `string` | "alfresco" | Path where the application is deployed | -| scriptArgs | `any` | | Arguments to pass to the webscript. | -| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). | -| servicePath | `string` | "service" | Path that the webscript service is mapped to. | -| showData | `boolean` | true | Toggles whether to show or hide the data. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" | +| contextRoot | `string` | "alfresco" | Path where the application is deployed | +| scriptArgs | `any` | | Arguments to pass to the webscript. | +| scriptPath | `string` | | (required) Path to the webscript (as defined by webscript). | +| servicePath | `string` | "service" | Path that the webscript service is mapped to. | +| showData | `boolean` | true | Toggles whether to show or hide the data. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. | ## Details @@ -96,7 +96,7 @@ This sample Web Scripts reside in your Alfresco Server. You can access the folde ``` -![Custom columns](../../docassets/images/HTML.png) +![Custom columns](../../docassets/images/HTML.png) ### Webscript View DATATABLE example @@ -114,7 +114,7 @@ This sample demonstrates how to implement a [Webscript component](webscript.comp ``` -If you want to show the result from a webscript inside a +If you want to show the result from a webscript inside a [datatable component](../../core/components/datatable.component.md) you have to return the data structure below (subdivided into data and schema) from the GET method of the webscript: @@ -124,7 +124,7 @@ data: [], schema: [] ``` -Here is an example: +Here is an example: ```ts data: [ @@ -144,7 +144,7 @@ schema: [{ }] ``` -Alternatively, you can send just the array data and the component will create a schema for you: +Alternatively, you can send just the array data and the component will create a schema for you: ```ts data: [ diff --git a/docs/content-services/dialogs/library.dialog.md b/docs/content-services/dialogs/library.dialog.md index c35678433b..92d2249304 100644 --- a/docs/content-services/dialogs/library.dialog.md +++ b/docs/content-services/dialogs/library.dialog.md @@ -25,10 +25,10 @@ Creates a new Content Services document library/site. ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the new library is created successfully. The event parameter is a [SiteEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md) object with the details of the newly-created library. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the new library is created successfully. The event parameter is a SiteEntry object with the details of the newly-created library. | ## Details @@ -39,4 +39,4 @@ section of the Content Services documentation for more information. ## See also -- [Sites dropdown component](../components/sites-dropdown.component.md) +* [Sites dropdown component](../components/sites-dropdown.component.md) diff --git a/docs/content-services/directives/content-node-share.directive.md b/docs/content-services/directives/content-node-share.directive.md index 03baabd13f..19e85eb342 100644 --- a/docs/content-services/directives/content-node-share.directive.md +++ b/docs/content-services/directives/content-node-share.directive.md @@ -33,10 +33,10 @@ Creates and manages public shared links for files. ### Properties -| Name | Type | Default value | Description | -| ------------ | ------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------- | -| baseShareUrl | `string` | | Prefix to add to the generated link. | -| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to share. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| baseShareUrl | `string` | | Prefix to add to the generated link. | +| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to share. | ## Details diff --git a/docs/content-services/directives/file-draggable.directive.md b/docs/content-services/directives/file-draggable.directive.md index 6dee9418bb..5aeb456e28 100644 --- a/docs/content-services/directives/file-draggable.directive.md +++ b/docs/content-services/directives/file-draggable.directive.md @@ -38,16 +38,16 @@ Some sample CSS to show the drag and drop area: ### Properties -| Name | Type | Default value | Description | -| ------- | --------- | ------------- | --------------------------------------------- | -| enabled | `boolean` | true | Enables/disables drag-and-drop functionality. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| enabled | `boolean` | true | Enables/disables drag-and-drop functionality. | ### Events -| Name | Type | Description | -| ------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when one or more files are dragged and dropped onto the draggable element. | -| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a directory is dragged and dropped onto the draggable element. | +| Name | Type | Description | +| --- | --- | --- | +| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when one or more files are dragged and dropped onto the draggable element. | +| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a directory is dragged and dropped onto the draggable element. | ## Details @@ -75,4 +75,4 @@ export class SomeComponent implements OnInit { ## See also -- [Upload Drag Area component](../components/upload-drag-area.component.md) +* [Upload Drag Area component](../components/upload-drag-area.component.md) diff --git a/docs/content-services/directives/folder-create.directive.md b/docs/content-services/directives/folder-create.directive.md index 84ba995213..32b9f83cbf 100644 --- a/docs/content-services/directives/folder-create.directive.md +++ b/docs/content-services/directives/folder-create.directive.md @@ -30,18 +30,18 @@ Creates folders. ### Properties -| Name | Type | Default value | Description | -| ------------ | -------- | ------------- | ------------------------------------------------------------------ | -| nodeType | `string` | "cm:folder" | Type of node to create. | -| parentNodeId | `string` | | Parent folder where the new folder will be located after creation. | -| title | `string` | null | Title of folder creation dialog. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeType | `string` | "cm:folder" | Type of node to create. | +| parentNodeId | `string` | | Parent folder where the new folder will be located after creation. | +| title | `string` | null | Title of folder creation dialog. | ### Events -| Name | Type | Description | -| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. | ## Details @@ -52,4 +52,4 @@ then the dialog will emit a `success` event when it closes. ## See also -- [Folder Edit directive](folder-edit.directive.md) +* [Folder Edit directive](folder-edit.directive.md) diff --git a/docs/content-services/directives/folder-edit.directive.md b/docs/content-services/directives/folder-edit.directive.md index 8ce868cc99..a9cd584e9f 100644 --- a/docs/content-services/directives/folder-edit.directive.md +++ b/docs/content-services/directives/folder-edit.directive.md @@ -30,17 +30,17 @@ Allows folders to be edited. ### Properties -| Name | Type | Default value | Description | -| ------ | -------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------- | -| folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. | -| title | `string` | null | Title of folder edit dialog. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. | +| title | `string` | null | Title of folder edit dialog. | ### Events -| Name | Type | Description | -| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. | ## Details diff --git a/docs/content-services/directives/inherited-button.directive.md b/docs/content-services/directives/inherited-button.directive.md index 8d1347343d..02aa7c524f 100644 --- a/docs/content-services/directives/inherited-button.directive.md +++ b/docs/content-services/directives/inherited-button.directive.md @@ -22,15 +22,15 @@ Update the current node by adding/removing the inherited permissions. ### Properties -| Name | Type | Default value | Description | -| ------ | -------- | ------------- | --------------------------------------------------- | -| nodeId | `string` | | ID of the node to add/remove inherited permissions. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeId | `string` | | ID of the node to add/remove inherited permissions. | ### Events -| Name | Type | Description | -| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated. | ## Details diff --git a/docs/content-services/directives/node-lock.directive.md b/docs/content-services/directives/node-lock.directive.md index 7768fbac2f..9419449915 100644 --- a/docs/content-services/directives/node-lock.directive.md +++ b/docs/content-services/directives/node-lock.directive.md @@ -21,9 +21,9 @@ Locks or unlocks a node. ### Properties -| Name | Type | Default value | Description | -| ---- | -------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------- | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock/unlock. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock/unlock. | ## Details diff --git a/docs/content-services/interfaces/search-widget.interface.md b/docs/content-services/interfaces/search-widget.interface.md index 333184f999..4fb7a1701b 100644 --- a/docs/content-services/interfaces/search-widget.interface.md +++ b/docs/content-services/interfaces/search-widget.interface.md @@ -11,14 +11,14 @@ Specifies required properties for [Search filter component](../components/search ## Contents -- [Basic usage](#basic-usage) - - [Properties](#properties) -- [Details](#details) - - [Implementing a custom widget](#implementing-a-custom-widget) - - [Reading external settings](#reading-external-settings) - - [Updating the final query](#updating-the-final-query) - - [Registering a custom widget](#registering-a-custom-widget) -- [See also](#see-also) +* [Basic usage](#basic-usage) + * [Properties](#properties) +* [Details](#details) + * [Implementing a custom widget](#implementing-a-custom-widget) + * [Reading external settings](#reading-external-settings) + * [Updating the final query](#updating-the-final-query) + * [Registering a custom widget](#registering-a-custom-widget) +* [See also](#see-also) ## Basic usage @@ -157,7 +157,7 @@ export class MyAppOrComponent { } ``` -When you have done this, you can declare your [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) in `app.config.json` +When you have done this, you can declare your [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) in `app.config.json` and pass custom attributes, if your component supports them: ```json @@ -184,10 +184,10 @@ and pass custom attributes, if your component supports them: ## See also -- [Search filter component](../components/search-filter.component.md) -- [Search check list component](../components/search-check-list.component.md) -- [Search date range component](../components/search-date-range.component.md) -- [Search number range component](../components/search-number-range.component.md) -- [Search radio component](../components/search-radio.component.md) -- [Search slider component](../components/search-slider.component.md) -- [Search text component](../components/search-text.component.md) +* [Search filter component](../components/search-filter.component.md) +* [Search check list component](../components/search-check-list.component.md) +* [Search date range component](../components/search-date-range.component.md) +* [Search number range component](../components/search-number-range.component.md) +* [Search radio component](../components/search-radio.component.md) +* [Search slider component](../components/search-slider.component.md) +* [Search text component](../components/search-text.component.md) diff --git a/docs/content-services/services/audit.service.md b/docs/content-services/services/audit.service.md index bf64ad0e40..727813c597 100644 --- a/docs/content-services/services/audit.service.md +++ b/docs/content-services/services/audit.service.md @@ -13,44 +13,44 @@ Manages Audit apps and entries. ### Methods -- **deleteAuditEntries**(auditApplicationId: `string`, where: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **deleteAuditEntries**(auditApplicationId: `string`, where: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Permanently delete audit entries for an audit application. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _where:_ `string` - Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - -- **deleteAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *auditApplicationId:* `string` - The identifier of an audit application. + * *where:* `string` - Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - +* **deleteAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Permanently delete an audit entry. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _auditEntryId:_ `string` - The identifier of an audit entry. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - -- **getAuditApp**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>`
+ * *auditApplicationId:* `string` - The identifier of an audit application. + * *auditEntryId:* `string` - The identifier of an audit entry. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - +* **getAuditApp**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>`
Get audit application info. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>` - -- **getAuditApps**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>`
+ * *auditApplicationId:* `string` - The identifier of an audit application. + * *opts:* `any` - (Optional) Options. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>` - +* **getAuditApps**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>`
List audit applications. - - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>` - -- **getAuditEntries**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`
+ * *opts:* `any` - (Optional) Options. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>` - +* **getAuditEntries**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`
List audit entries for an audit application. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - -- **getAuditEntriesForNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`
+ * *auditApplicationId:* `string` - The identifier of an audit application. + * *opts:* `any` - (Optional) Options. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - +* **getAuditEntriesForNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`
List audit entries for a node. - - _nodeId:_ `string` - The identifier of a node. - - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - -- **getAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>`
+ * *nodeId:* `string` - The identifier of a node. + * *opts:* `any` - (Optional) Options. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - +* **getAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>`
Get audit entry. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _auditEntryId:_ `string` - The identifier of an audit entry. - - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>` - -- **updateAuditApp**(auditApplicationId: `string`, auditAppBodyUpdate: `boolean`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>`
+ * *auditApplicationId:* `string` - The identifier of an audit application. + * *auditEntryId:* `string` - The identifier of an audit entry. + * *opts:* `any` - (Optional) Options. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>` - +* **updateAuditApp**(auditApplicationId: `string`, auditAppBodyUpdate: `boolean`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>`
Update audit application info. - - _auditApplicationId:_ `string` - The identifier of an audit application. - - _auditAppBodyUpdate:_ `boolean` - The audit application to update. - - _opts:_ `any` - (Optional) (Optional) (Optional) Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>` - + * *auditApplicationId:* `string` - The identifier of an audit application. + * *auditAppBodyUpdate:* `boolean` - The audit application to update. + * *opts:* `any` - (Optional) Options. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>` - diff --git a/docs/content-services/services/content-node-dialog.service.md b/docs/content-services/services/content-node-dialog.service.md index eac9c8136d..9ec3a35b26 100644 --- a/docs/content-services/services/content-node-dialog.service.md +++ b/docs/content-services/services/content-node-dialog.service.md @@ -13,56 +13,56 @@ Displays and manages dialogs for selecting content to open, copy or upload. ### Methods -- **close**()
+* **close**()
Closes the currently open dialog. -- **getTitleTranslation**(action: `string`, name: `string`): `string`
+* **getTitleTranslation**(action: `string`, name: `string`): `string`
Gets the translation of the dialog title. - - _action:_ `string` - Name of the action to display in the dialog title - - _name:_ `string` - Name of the item on which the action is being performed - - **Returns** `string` - Translated version of the title -- **openCopyMoveDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
+ * *action:* `string` - Name of the action to display in the dialog title + * *name:* `string` - Name of the item on which the action is being performed + * **Returns** `string` - Translated version of the title +* **openCopyMoveDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a dialog to copy or move an item to a new location. - - _action:_ `string` - Name of the action (eg, "Copy" or "Move") to show in the title - - _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to be copied or moved - - _permission:_ `string` - (Optional) Permission for the operation - - _excludeSiteContent:_ `string[]` - (Optional) The site content that should be filtered out - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about files that were copied/moved -- **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
+ * *action:* `string` - Name of the action (eg, "Copy" or "Move") to show in the title + * *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to be copied or moved + * *permission:* `string` - (Optional) Permission for the operation + * *excludeSiteContent:* `string[]` - (Optional) The site content that should be filtered out + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about files that were copied/moved +* **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a file browser at a default myFile location. shows files and folders in the dialog search result. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) -- **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) +* **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a file browser at a chosen folder location. shows files and folders in the dialog search result. - - _folderNodeId:_ `string` - ID of the folder to use - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) -- **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
+ * *folderNodeId:* `string` - ID of the folder to use + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) +* **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a file browser at a chosen site location. shows files and folders in the dialog search result. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) -- **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) +* **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a folder browser at a chosen folder location. - - _folderNodeId:_ `string` - ID of the folder to use - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s) -- **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
+ * *folderNodeId:* `string` - ID of the folder to use + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s) +* **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a folder browser at a chosen site location. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s) -- **openLockNodeDialog**(contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Subject`](http://reactivex.io/documentation/subject.html)``
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s) +* **openLockNodeDialog**(contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Subject`](http://reactivex.io/documentation/subject.html)``
Opens a lock node dialog. - - _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock - - **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`` - Error/status message (if any) -- **openUploadFileDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), showFilesInResult: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
+ * *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock + * **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`` - Error/status message (if any) +* **openUploadFileDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), showFilesInResult: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a dialog to choose a file to upload. - - _action:_ `string` - Name of the action to show in the title - - _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload - - _showFilesInResult:_ `boolean` - Show files in dialog search result - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen file(s) -- **openUploadFolderDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
+ * *action:* `string` - Name of the action to show in the title + * *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload + * *showFilesInResult:* `boolean` - Show files in dialog search result + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen file(s) +* **openUploadFolderDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`
Opens a dialog to choose folders to upload. - - _action:_ `string` - Name of the action to show in the title - - _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen folder(s) + * *action:* `string` - Name of the action to show in the title + * *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen folder(s) ## Details -The `openXXX` methods return an +The `openXXX` methods return an [`Observable`](http://reactivex.io/documentation/observable.html) that you can subscribe to in order to get the information from the result: @@ -89,5 +89,5 @@ dialog operation, say) or be set to one of the well-known names "-my-" , "-share ## See Also -- [Content node selector panel component](../components/content-node-selector-panel.component.md) -- [Content node selector component](../components/content-node-selector.component.md) +* [Content node selector panel component](../components/content-node-selector-panel.component.md) +* [Content node selector component](../components/content-node-selector.component.md) diff --git a/docs/content-services/services/custom-resources.service.md b/docs/content-services/services/custom-resources.service.md index 5d9a0a9f05..ccc2331703 100644 --- a/docs/content-services/services/custom-resources.service.md +++ b/docs/content-services/services/custom-resources.service.md @@ -13,68 +13,68 @@ Manages Document List information that is specific to a user. ### Methods -- **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the contents of one of the well-known aliases in the form of node ID strings. - - _nodeId:_ `string` - ID of the target folder node - - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of node IDs -- **getIdFromEntry**(node: `any`, nodeId: `string`): `string`
+ * *nodeId:* `string` - ID of the target folder node + * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of node IDs +* **getIdFromEntry**(node: `any`, nodeId: `string`): `string`
Chooses the correct ID for a node entry. - - _node:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) object - - _nodeId:_ `string` - ID of the node object - - **Returns** `string` - ID value -- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+ * *node:* `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) object + * *nodeId:* `string` - ID of the node object + * **Returns** `string` - ID value +* **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets files recently accessed by a user. - - _personId:_ `string` - ID of the user - - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - _filters:_ `string[]` - (Optional) Specifies additional filters to apply (joined with **AND**) - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes for the recently used files -- **hasCorrespondingNodeIds**(nodeId: `string`): `boolean`
+ * *personId:* `string` - ID of the user + * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + * *filters:* `string[]` - (Optional) Specifies additional filters to apply (joined with **AND**) + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes for the recently used files +* **hasCorrespondingNodeIds**(nodeId: `string`): `boolean`
Does the well-known alias have a corresponding node ID? - - _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check - - **Returns** `boolean` - True if the alias has a corresponding node ID, false otherwise -- **isCustomSource**(folderId: `string`): `boolean`
+ * *nodeId:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check + * **Returns** `boolean` - True if the alias has a corresponding node ID, false otherwise +* **isCustomSource**(folderId: `string`): `boolean`
Is the folder ID one of the well-known aliases? - - _folderId:_ `string` - Folder ID name to check - - **Returns** `boolean` - True if the ID is a well-known name, false otherwise -- **isSupportedSource**(folderId: `string`): `boolean`
+ * *folderId:* `string` - Folder ID name to check + * **Returns** `boolean` - True if the ID is a well-known name, false otherwise +* **isSupportedSource**(folderId: `string`): `boolean`
Is the folder ID a "-my", "-root-", or "-shared-" alias? - - _folderId:_ `string` - Folder ID name to check - - **Returns** `boolean` - True if the ID is one of the supported sources, false otherwise -- **loadFavorites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+ * *folderId:* `string` - Folder ID name to check + * **Returns** `boolean` - True if the ID is one of the supported sources, false otherwise +* **loadFavorites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets favorite files for the current user. - - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - _includeFields:_ `string[]` - List of data field names to include in the results - - _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorite files -- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): `any`
+ * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + * *includeFields:* `string[]` - List of data field names to include in the results + * *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorite files +* **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): `any`
Gets a folder's contents. - - _nodeId:_ `string` - ID of the target folder node - - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - _includeFields:_ `string[]` - List of data field names to include in the results - - _where:_ `string` - (Optional) Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. - - **Returns** `any` - List of items contained in the folder -- **loadMemberSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`
+ * *nodeId:* `string` - ID of the target folder node + * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + * *includeFields:* `string[]` - List of data field names to include in the results + * *where:* `string` - (Optional) Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the *where* condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. + * **Returns** `any` - List of items contained in the folder +* **loadMemberSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`
Gets sites that the current user is a member of. - - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - List of sites -- **loadSharedLinks**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>`
+ * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + * *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - List of sites +* **loadSharedLinks**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>`
Gets shared links for the current user. - - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - _includeFields:_ `string[]` - List of data field names to include in the results - - _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>` - List of shared links -- **loadSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+ * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + * *includeFields:* `string[]` - List of data field names to include in the results + * *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>` - List of shared links +* **loadSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets all sites in the repository. - - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of sites -- **loadTrashcan**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`
+ * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + * *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of sites +* **loadTrashcan**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`
Gets all items currently in the trash. - - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - _includeFields:_ `string[]` - List of data field names to include in the results - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>` - List of deleted items + * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + * *includeFields:* `string[]` - List of data field names to include in the results + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>` - List of deleted items ## Details @@ -85,4 +85,4 @@ for further details of the returned data and the available fields. ## See also -- [Document List component](../components/document-list.component.md) +* [Document List component](../components/document-list.component.md) diff --git a/docs/content-services/services/document-actions.service.md b/docs/content-services/services/document-actions.service.md index 62d3966c40..9b6725bb74 100644 --- a/docs/content-services/services/document-actions.service.md +++ b/docs/content-services/services/document-actions.service.md @@ -13,19 +13,19 @@ Implements the document menu actions for the [Document List component](../compon ### Methods -- **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`
+* **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`
Checks if actions can be executed for an item. - - _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to receive an action - - **Returns** `boolean` - True if the action can be executed on this item, false otherwise -- **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)
+ * *nodeEntry:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to receive an action + * **Returns** `boolean` - True if the action can be executed on this item, false otherwise +* **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)
Gets the handler for an action. - - _key:_ `string` - Identifier of the action - - **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler for the action -- **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`
+ * *key:* `string` - Identifier of the action + * **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler for the action +* **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`
Sets a new handler for an action. - - _key:_ `string` - Identifier of the action - - _handler:_ [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - Handler for the action - - **Returns** `boolean` - False if the key was an empty/null string, true otherwise + * *key:* `string` - Identifier of the action + * *handler:* [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - Handler for the action + * **Returns** `boolean` - False if the key was an empty/null string, true otherwise ## Details @@ -99,5 +99,5 @@ with a custom [application service](../../../lib/testing/src/lib/core/actions/AP ## See also -- [Content action component](../components/content-action.component.md) -- [Folder actions service](folder-actions.service.md) +* [Content action component](../components/content-action.component.md) +* [Folder actions service](folder-actions.service.md) diff --git a/docs/content-services/services/document-list.service.md b/docs/content-services/services/document-list.service.md index 792e49fc49..299778c8f2 100644 --- a/docs/content-services/services/document-list.service.md +++ b/docs/content-services/services/document-list.service.md @@ -13,48 +13,48 @@ Implements node operations used by the [Document List component](../components/d ### Methods -- **copyNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+* **copyNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Copy a node to destination node - - _nodeId:_ `string` - The id of the node to be copied - - _targetParentId:_ `string` - The id of the folder where the node will be copied - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the copied node -- **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *nodeId:* `string` - The id of the node to be copied + * *targetParentId:* `string` - The id of the folder where the node will be copied + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the copied node +* **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a node. - - _nodeId:_ `string` - ID of the node to delete - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the operation is complete -- **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+ * *nodeId:* `string` - ID of the node to delete + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the operation is complete +* **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets the folder node with the specified relative name path below the root node. - - _folder:_ `string` - Path to folder. - - _opts:_ `any` - (Optional) Options. - - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - Details of the folder -- **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+ * *folder:* `string` - Path to folder. + * *opts:* `any` - (Optional) Options. + * *includeFields:* `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - Details of the folder +* **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Gets a folder node via its node ID. - - _nodeId:_ `string` - ID of the folder node - - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder -- **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+ * *nodeId:* `string` - ID of the folder node + * *includeFields:* `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder +* **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Gets a node via its node ID. - - _nodeId:_ `string` - ID of the target node - - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder -- **isCustomSourceService**(nodeId: `any`): `boolean`
+ * *nodeId:* `string` - ID of the target node + * *includeFields:* `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder +* **isCustomSourceService**(nodeId: `any`): `boolean`
- - _nodeId:_ `any` - - - **Returns** `boolean` - -- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`, orderBy?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`
+ * *nodeId:* `any` - + * **Returns** `boolean` - +* **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`, orderBy?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`
Load a folder by Node Id. - - _nodeId:_ `string` - ID of the folder node - - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - - - _includeFields:_ `string[]` - List of data field names to include in the results - - _where:_ `string` - (Optional) Optionally filter the list - - _orderBy:_ `string[]` - (Optional) order by node property - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>` - Details of the folder -- **moveNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+ * *nodeId:* `string` - ID of the folder node + * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - + * *includeFields:* `string[]` - List of data field names to include in the results + * *where:* `string` - (Optional) Optionally filter the list + * *orderBy:* `string[]` - (Optional) order by node property + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>` - Details of the folder +* **moveNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Moves a node to destination node. - - _nodeId:_ `string` - The id of the node to be moved - - _targetParentId:_ `string` - The id of the folder where the node will be moved - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the moved node + * *nodeId:* `string` - The id of the node to be moved + * *targetParentId:* `string` - The id of the folder where the node will be moved + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the moved node ## Details @@ -94,4 +94,4 @@ values via their string equivalents. ## See also -- [Document list component](../components/document-list.component.md) +* [Document list component](../components/document-list.component.md) diff --git a/docs/content-services/services/folder-actions.service.md b/docs/content-services/services/folder-actions.service.md index 53d099c579..7ed9209f45 100644 --- a/docs/content-services/services/folder-actions.service.md +++ b/docs/content-services/services/folder-actions.service.md @@ -13,19 +13,19 @@ Implements the folder menu actions for the [Document List component](../componen ### Methods -- **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`
+* **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`
Checks if an action is available for a particular item. - - _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to check - - **Returns** `boolean` - True if the action is available, false otherwise -- **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)
+ * *nodeEntry:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to check + * **Returns** `boolean` - True if the action is available, false otherwise +* **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)
Gets the handler function for an action. - - _key:_ `string` - Identifier for the action - - **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler function -- **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`
+ * *key:* `string` - Identifier for the action + * **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler function +* **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`
Sets a new handler function for an action. - - _key:_ `string` - Identifier for the action - - _handler:_ [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The new handler function - - **Returns** `boolean` - True if the key was a valid action identifier, false otherwise + * *key:* `string` - Identifier for the action + * *handler:* [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The new handler function + * **Returns** `boolean` - True if the key was a valid action identifier, false otherwise ## Details @@ -99,5 +99,5 @@ with a custom [application service](../../../lib/testing/src/lib/core/actions/AP ## See also -- [Document actions service](document-actions.service.md) -- [Content action component](../components/content-action.component.md) +* [Document actions service](document-actions.service.md) +* [Content action component](../components/content-action.component.md) diff --git a/docs/content-services/services/node-permission-dialog.service.md b/docs/content-services/services/node-permission-dialog.service.md index 751247e64c..0aaf7e5a87 100644 --- a/docs/content-services/services/node-permission-dialog.service.md +++ b/docs/content-services/services/node-permission-dialog.service.md @@ -13,25 +13,25 @@ Displays dialogs to let the user set node permissions. ### Methods -- **close**()
+* **close**()
Closes the currently-open dialog. -- **openAddPermissionDialog**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>`
+* **openAddPermissionDialog**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>`
Opens a dialog to add permissions to a node. - - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node - - _title:_ `string` - (Optional) Dialog title - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` - Node with updated permissions -- **updateNodePermissionByDialog**(nodeId?: `string`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
+ * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node + * *title:* `string` - (Optional) Dialog title + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` - Node with updated permissions +* **updateNodePermissionByDialog**(nodeId?: `string`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
Opens a dialog to update permissions for a node. - - _nodeId:_ `string` - (Optional) ID of the target node - - _title:_ `string` - (Optional) Dialog title - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions + * *nodeId:* `string` - (Optional) ID of the target node + * *title:* `string` - (Optional) Dialog title + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions ## Details This service sets up an [Add Permission Dialog component](../components/add-permission-dialog.component.md) to provide a user -interface for updating permissions. +interface for updating permissions. ## See also -- [Node Permission service](node-permission.service.md) -- [Add Permission Dialog component](../components/add-permission-dialog.component.md) +* [Node Permission service](node-permission.service.md) +* [Add Permission Dialog component](../components/add-permission-dialog.component.md) diff --git a/docs/content-services/services/node-permission.service.md b/docs/content-services/services/node-permission.service.md index c16c378022..76b47f1e73 100644 --- a/docs/content-services/services/node-permission.service.md +++ b/docs/content-services/services/node-permission.service.md @@ -13,36 +13,36 @@ Manages role permissions for content nodes. ### Methods -- **getGroupMemberByGroupName**(groupName: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>`
+* **getGroupMemberByGroupName**(groupName: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>`
Gets all members related to a group name. - - _groupName:_ `string` - Name of group to look for members - - _opts:_ `any` - (Optional) Extra options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>` - List of members -- **getNodeRoles**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupName:* `string` - Name of group to look for members + * *opts:* `any` - (Optional) Extra options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>` - List of members +* **getNodeRoles**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets a list of roles for the current node. - - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - The target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Array of strings representing the roles -- **removePermission**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permissionToRemove: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
+ * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - The target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Array of strings representing the roles +* **removePermission**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permissionToRemove: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
Removes a permission setting from a node. - - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node - - _permissionToRemove:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission setting to remove - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with modified permissions -- **updateLocallySetPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), nodes: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
+ * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node + * *permissionToRemove:* [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission setting to remove + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with modified permissions +* **updateLocallySetPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), nodes: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
Updates the locally set permissions for a node. - - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node - - _nodes:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - Permission settings - - _nodeRole:_ `string[]` - Permission role - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions -- **updateNodePermissions**(nodeId: `string`, permissionList: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
+ * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node + * *nodes:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - Permission settings + * *nodeRole:* `string[]` - Permission role + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions +* **updateNodePermissions**(nodeId: `string`, permissionList: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
Update permissions for a node. - - _nodeId:_ `string` - ID of the target node - - _permissionList:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - New permission settings - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions -- **updatePermissionRole**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), updatedPermissionRole: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
+ * *nodeId:* `string` - ID of the target node + * *permissionList:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - New permission settings + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions +* **updatePermissionRole**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), updatedPermissionRole: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`
Updates the permission role for a node. - - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Target node - - _updatedPermissionRole:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission role to update or add - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permission + * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Target node + * *updatedPermissionRole:* [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission role to update or add + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permission ## Details @@ -56,4 +56,4 @@ based on. ## See also -- [Permission list component](../components/permission-list.component.md) +* [Permission list component](../components/permission-list.component.md) diff --git a/docs/content-services/services/rating.service.md b/docs/content-services/services/rating.service.md index 9bffc82364..ed7d32f339 100644 --- a/docs/content-services/services/rating.service.md +++ b/docs/content-services/services/rating.service.md @@ -13,22 +13,22 @@ Manages ratings for items in Content Services. ### Methods -- **deleteRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **deleteRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Removes the current user's rating for a node. - - _nodeId:_ `string` - Target node - - _ratingType:_ `any` - Type of rating to remove (can be "likes" or "fiveStar") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response indicating that the operation is complete -- **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`
+ * *nodeId:* `string` - Target node + * *ratingType:* `any` - Type of rating to remove (can be "likes" or "fiveStar") + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response indicating that the operation is complete +* **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`
Gets the current user's rating for a node. - - _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to get the rating from - - _ratingType:_ `any` - Type of rating (can be "likes" or "fiveStar") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - The rating value -- **postRating**(nodeId: `string`, ratingType: `string`, vote: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`
+ * *nodeId:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to get the rating from + * *ratingType:* `any` - Type of rating (can be "likes" or "fiveStar") + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - The rating value +* **postRating**(nodeId: `string`, ratingType: `string`, vote: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`
Adds the current user's rating for a node. - - _nodeId:_ `string` - Target node for the rating - - _ratingType:_ `string` - Type of rating (can be "likes" or "fiveStar") - - _vote:_ `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - Details about the rating, including the new value + * *nodeId:* `string` - Target node for the rating + * *ratingType:* `string` - Type of rating (can be "likes" or "fiveStar") + * *vote:* `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar") + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - Details about the rating, including the new value ## Details @@ -44,5 +44,5 @@ REST API that this service is based on. ## See also -- [Like component](../components/like.component.md) -- [Rating component](../components/rating.component.md) +* [Like component](../components/like.component.md) +* [Rating component](../components/rating.component.md) diff --git a/docs/content-services/services/search-query-builder.service.md b/docs/content-services/services/search-query-builder.service.md index 89b1123368..248e7c975f 100644 --- a/docs/content-services/services/search-query-builder.service.md +++ b/docs/content-services/services/search-query-builder.service.md @@ -13,66 +13,91 @@ Stores information from all the custom search and faceted search widgets, compil ### Methods -- **addFilterQuery**(query: `string`)
+* **addFilterQuery**(query: `string`)
Adds a filter query to the current query. - - _query:_ `string` - Query string to add -- **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))
+ * *query:* `string` - Query string to add + +* **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))
Adds a facet bucket to a field. - - _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field - - _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to add -- **buildQuery**(): `QueryBody`
+ * *field:* [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field + * *bucket:* [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to add + +* **buildQuery**(): `QueryBody`
Builds the current query. - - **Returns** `QueryBody` - The finished query -- **execute**(queryBody?: `QueryBody`)
+ * **Returns** `QueryBody` - The finished query + +* **execute**(queryBody?: `QueryBody`)
Builds and executes the current query. - - _queryBody:_ `QueryBody` - (Optional) (Optional) -- **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)
+ * *queryBody:* `QueryBody` - (Optional) + +* **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)
Gets a facet field by label. - - _label:_ `string` - Label of the facet field - - **Returns** [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - Facet field data -- **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts)
+ * *label:* `string` - Label of the facet field + * **Returns** [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - Facet field data + +* **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts)
Gets a facet query by label. - - _label:_ `string` - Label of the query - - **Returns** [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts) - Facet query data -- **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)
+ * *label:* `string` - Label of the query + * **Returns** [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts) - Facet query data + +* **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)
Gets the primary sorting definition. - - **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts) - The primary sorting definition -- **getQueryGroup**(query: `any`): `any`
+ * **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts) - The primary sorting definition + +* **getQueryGroup**(query: `any`): `any`
Gets the query group. - - _query:_ `any` - Target query - - **Returns** `any` - Query group -- **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]`
+ * *query:* `any` - Target query + * **Returns** `any` - Query group + +* **getScope**(): [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts)
+ + * **Returns** [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts) - + +* **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]`
Gets all pre-configured sorting options that users can choose from. - - **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options -- **getSupportedLabel**(configLabel: `string`): `string`
+ * **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options + +* **getSupportedLabel**(configLabel: `string`): `string`
Encloses a label name with double quotes if it contains whitespace characters. - - _configLabel:_ `string` - Original label text - - **Returns** `string` - Label, possibly with quotes if it contains spaces -- **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]`
+ * *configLabel:* `string` - Original label text + * **Returns** `string` - Label, possibly with quotes if it contains spaces + +* **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]`
Gets the buckets currently added to a field - - _field:_ `string` - The target fields - - **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array -- **isFilterServiceActive**(): `boolean`
+ * *field:* `string` - The target fields + * **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array - - **Returns** `boolean` - -- **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)
+* **isFilterServiceActive**(): `boolean`
- - **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) - -- **removeFilterQuery**(query: `string`)
+ * **Returns** `boolean` - + +* **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)
+ + * **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) - + +* **removeFilterQuery**(query: `string`)
Removes an existing filter query. - - _query:_ `string` - The query to remove -- **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))
- Removes an existing bucket from a field. - - _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field - - _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to remove -- **resetToDefaults**()
-- **search**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`
+ * *query:* `string` - The query to remove - - _queryBody:_ `QueryBody` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - -- **update**(queryBody?: `QueryBody`)
+* **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))
+ Removes an existing bucket from a field. + * *field:* [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field + * *bucket:* [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to remove + +* **resetToDefaults**()
+ +* **search**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`
+ + * *queryBody:* `QueryBody` - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - + +* **setScope**(scope: [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts))
+ + * *scope:* [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts) - + +* **update**(queryBody?: `QueryBody`)
Builds the current query and triggers the `updated` event. - - _queryBody:_ `QueryBody` - (Optional) (Optional) + * *queryBody:* `QueryBody` - (Optional) ## Details @@ -84,13 +109,13 @@ You can reuse it with multiple component implementations. You can use custom widgets to populate and edit the following parts of the resulting query: -- categories -- query fragments that form a query expression -- include fields -- scope settings -- filter queries -- facet fields -- range queries +* categories +* query fragments that form a query expression +* include fields +* scope settings +* filter queries +* facet fields +* range queries ```ts constructor(queryBuilder: SearchQueryBuilderService) { @@ -110,5 +135,5 @@ constructor(queryBuilder: SearchQueryBuilderService) { ## See also -- [Search filter component](../components/search-filter.component.md) -- [Search Widget interface](../interfaces/search-widget.interface.md) +* [Search filter component](../components/search-filter.component.md) +* [Search Widget interface](../interfaces/search-widget.interface.md) diff --git a/docs/content-services/services/tag.service.md b/docs/content-services/services/tag.service.md index e067f2eba3..03c5391a43 100644 --- a/docs/content-services/services/tag.service.md +++ b/docs/content-services/services/tag.service.md @@ -13,24 +13,24 @@ Manages tags in Content Services. ### Methods -- **addTag**(nodeId: `string`, tagName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`
+* **addTag**(nodeId: `string`, tagName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`
Adds a tag to a node. - - _nodeId:_ `string` - ID of the target node - - _tagName:_ `string` - Name of the tag to add - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - TagEntry object (defined in JS-API) with details of the new tag -- **getAllTheTags**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`
+ * *nodeId:* `string` - ID of the target node + * *tagName:* `string` - Name of the tag to add + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - TagEntry object (defined in JS-API) with details of the new tag +* **getAllTheTags**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`
Gets a list of all the tags already defined in the repository. - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags -- **getTagsByNodeId**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`
+ * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags +* **getTagsByNodeId**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`
Gets a list of tags added to a node. - - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags -- **removeTag**(nodeId: `string`, tag: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *nodeId:* `string` - ID of the target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags +* **removeTag**(nodeId: `string`, tag: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Removes a tag from a node. - - _nodeId:_ `string` - ID of the target node - - _tag:_ `string` - Name of the tag to remove - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null object when the operation completes + * *nodeId:* `string` - ID of the target node + * *tag:* `string` - Name of the tag to remove + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null object when the operation completes ## Details @@ -53,4 +53,4 @@ based on. ## See also -- [Tag list component](../components/tag-list.component.md) +* [Tag list component](../components/tag-list.component.md) diff --git a/docs/core/components/card-view.component.md b/docs/core/components/card-view.component.md index 1780139528..1f811d35d5 100644 --- a/docs/core/components/card-view.component.md +++ b/docs/core/components/card-view.component.md @@ -106,31 +106,31 @@ Defining properties from Typescript: ### Properties -| Name | Type | Default value | Description | -| ----------------------------- | ---------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------ | -| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. | -| displayClearAction | `boolean` | true | Toggles whether or not to display clear action. | -| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. | -| displayNoneOption | `boolean` | true | Toggles whether or not to display none option. | -| editable | `boolean` | | Toggles whether or not the items can be edited. | -| multiValueSeparator | `string` | DEFAULT_SEPARATOR | String separator between multi-value property items. | -| properties | [`CardViewItem`](../../../lib/core/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. | -| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. | +| displayClearAction | `boolean` | true | Toggles whether or not to display clear action. | +| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. | +| displayNoneOption | `boolean` | true | Toggles whether or not to display none option. | +| editable | `boolean` | | Toggles whether or not the items can be edited. | +| multiValueSeparator | `string` | DEFAULT_SEPARATOR | String separator between multi-value property items. | +| properties | [`CardViewItem`](../../../lib/core/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. | +| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. | ## Details You define the property list, the [`CardViewComponent`](../../core/components/card-view.component.md) does the rest. Each property represents a card view item (a row) in the [card view component](card-view.component.md). The following item types are available by default: -- [**CardViewTextItemModel**](#card-text-item) - _for text items_ -- [**CardViewMapItemModel**](#card-map-item) - _for map items_ -- [**CardViewDateItemModel**](#card-date-item) - _for date items_ -- [**CardViewDatetimeItemModel**](#card-datetime-item) - _for datetime items_ -- [**CardViewBoolItemModel**](#card-bool-item) - _for bool items (checkbox)_ -- [**CardViewIntItemModel**](#card-int-item) - _for integer items_ -- [**CardViewFloatItemModel**](#card-float-item) - _for float items_ -- [**CardViewKeyValuePairsItemModel**](#card-key-value-pairs-item) - _for key-value-pairs items_ -- [**CardViewSelectItemModel**](#card-select-item) - _for select items_ -- [**CardViewArrayItemModel**](#card-array-item) - _for array items_ +* [**CardViewTextItemModel**](#card-text-item) - *for text items* +* [**CardViewMapItemModel**](#card-map-item) - *for map items* +* [**CardViewDateItemModel**](#card-date-item) - *for date items* +* [**CardViewDatetimeItemModel**](#card-datetime-item) - *for datetime items* +* [**CardViewBoolItemModel**](#card-bool-item) - *for bool items (checkbox)* +* [**CardViewIntItemModel**](#card-int-item) - *for integer items* +* [**CardViewFloatItemModel**](#card-float-item) - *for float items* +* [**CardViewKeyValuePairsItemModel**](#card-key-value-pairs-item) - *for key-value-pairs items* +* [**CardViewSelectItemModel**](#card-select-item) - *for select items* +* [**CardViewArrayItemModel**](#card-array-item) - *for array items* Each of these types implements the [Card View Item interface](../interfaces/card-view-item.interface.md): @@ -156,8 +156,8 @@ this. You can optionally set up the card view so that its properties can be edited. You can control the editing of properties at two levels: -- **Global level** - _via the editable parameter of the card-view.component_ -- **[`Property`](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) level** - _in each property via the editable attribute_ +* **Global level** - *via the editable parameter of the card-view.component* +* **[`Property`](../../../lib/content-services/src/lib/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 individual `editable` settings. @@ -353,7 +353,7 @@ const selectItemProperty = new CardViewSelectItemModel(options); | key\* | string | | Identifying key (important when editing the item) | | editable | boolean | false | Toggles whether the item is editable | | value | string | | 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 | +| 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 | #### Card Array Item @@ -368,9 +368,9 @@ const arrayItemProperty = new CardViewArrayItemModel(items); | label\* | string | | Item label | | key\* | string | | Identifying key (important when editing the item) | | editable | boolean | false | Toggles whether the item is editable | -| value | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item | +| value | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item | ## See also -- [Card View Update service](../services/card-view-update.service.md) -- [Card View Item interface](../interfaces/card-view-item.interface.md) +* [Card View Update service](../services/card-view-update.service.md) +* [Card View Item interface](../interfaces/card-view-item.interface.md) diff --git a/docs/core/components/comment-list.component.md b/docs/core/components/comment-list.component.md index ff26de9ce3..0a09d937ba 100644 --- a/docs/core/components/comment-list.component.md +++ b/docs/core/components/comment-list.component.md @@ -63,12 +63,12 @@ In the component template use the [comment list component](comment-list.componen ### Properties -| Name | Type | Default value | Description | -| -------- | --------------------------------------------------------------- | ------------- | -------------------------------------------- | -| comments | [`CommentModel`](../../../lib/core/models/comment.model.ts)`[]` | | The comments data used to populate the list. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| comments | [`CommentModel`](../../../lib/core/models/comment.model.ts)`[]` | | The comments data used to populate the list. | ### Events -| Name | Type | Description | -| -------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` | Emitted when the user clicks on one of the comment rows. | diff --git a/docs/core/components/comments.component.md b/docs/core/components/comments.component.md index 15bd52599a..3031ad95a7 100644 --- a/docs/core/components/comments.component.md +++ b/docs/core/components/comments.component.md @@ -32,14 +32,14 @@ Displays comments from users involved in a specified task or content and allows ### Properties -| Name | Type | Default value | Description | -| -------- | --------- | ------------- | --------------------------- | -| nodeId | `string` | | The numeric ID of the node. | -| readOnly | `boolean` | false | Are the comments read only? | -| taskId | `string` | | The numeric ID of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodeId | `string` | | The numeric ID of the node. | +| readOnly | `boolean` | false | Are the comments read only? | +| taskId | `string` | | The numeric ID of the task. | ### Events -| Name | Type | Description | -| ----- | ----------------------------------------------------------------- | --------------------------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while displaying/adding a comment. | diff --git a/docs/core/components/data-column.component.md b/docs/core/components/data-column.component.md index 4141e5ebcd..546aba12f4 100644 --- a/docs/core/components/data-column.component.md +++ b/docs/core/components/data-column.component.md @@ -11,17 +11,17 @@ Defines column properties for DataTable, Tasklist, Document List and other compo ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) -- [Details](#details) - - [Conditional visibility](#conditional-visibility) - - [Automatic column header translation](#automatic-column-header-translation) - - [Custom tooltips](#custom-tooltips) - - [Column Template](#column-template) - - [Styling Techniques](#styling-techniques) - - [Using the copyContent option](#using-the-copycontent-option) -- [See also](#see-also) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) +* [Details](#details) + * [Conditional visibility](#conditional-visibility) + * [Automatic column header translation](#automatic-column-header-translation) + * [Custom tooltips](#custom-tooltips) + * [Column Template](#column-template) + * [Styling Techniques](#styling-techniques) + * [Using the copyContent option](#using-the-copycontent-option) +* [See also](#see-also) ## Basic Usage @@ -41,20 +41,20 @@ Defines column properties for DataTable, Tasklist, Document List and other compo ### Properties -| Name | Type | Default value | Description | -| ------------- | ---------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of cell contents. | -| cssClass | `string` | | Additional CSS class to be applied to column (header and cells). | -| editable | `boolean` | false | Toggles the editing support of the column data. | -| focus | `boolean` | true | Enable or disable cell focus | -| format | `string` | | Value format (if supported by the parent component), for example format of the date. | -| formatTooltip | `Function` | | Custom tooltip formatter function. | -| key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. | -| sortable | `boolean` | true | Toggles ability to sort by this column, for example by clicking the column header. | -| sortingKey | `string` | | When using server side sorting the column used by the api call where the sorting will be performed | -| srTitle | `string` | | Title to be used for screen readers. | -| title | `string` | "" | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. | -| type | `string` | "text" | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize', 'location', and 'json'. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of cell contents. | +| cssClass | `string` | | Additional CSS class to be applied to column (header and cells). | +| editable | `boolean` | false | Toggles the editing support of the column data. | +| focus | `boolean` | true | Enable or disable cell focus | +| format | `string` | | Value format (if supported by the parent component), for example format of the date. | +| formatTooltip | `Function` | | Custom tooltip formatter function. | +| key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. | +| sortable | `boolean` | true | Toggles ability to sort by this column, for example by clicking the column header. | +| sortingKey | `string` | | When using server side sorting the column used by the api call where the sorting will be performed | +| srTitle | `string` | | Title to be used for screen readers. | +| title | `string` | "" | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. | +| type | `string` | "text" | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize', 'location', and 'json'. | ## Details @@ -334,6 +334,6 @@ HTML `` element example: ## See also -- [Document list component](../../content-services/components/document-list.component.md) -- [Datatable component](datatable.component.md) -- [Task list component](../../process-services/components/task-list.component.md) +* [Document list component](../../content-services/components/document-list.component.md) +* [Datatable component](datatable.component.md) +* [Task list component](../../process-services/components/task-list.component.md) diff --git a/docs/core/components/datatable.component.md b/docs/core/components/datatable.component.md index b106ea58cb..98b361a40c 100644 --- a/docs/core/components/datatable.component.md +++ b/docs/core/components/datatable.component.md @@ -15,21 +15,21 @@ See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/ ## Contents -- [Basic usage](#basic-usage) - - [Setting the rows and column schema](#setting-the-rows-and-column-schema) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Supplying data for the table](#supplying-data-for-the-table) - - [Customizing columns](#customizing-columns) - - [DataTable DOM Events](#datatable-dom-events) - - [Card view](#card-view) - - [Using events](#using-events) - - [Customizing the component's styles](#customizing-the-components-styles) -- [Resolver Function](#resolver-function) -- [See also](#see-also) +* [Basic usage](#basic-usage) + * [Setting the rows and column schema](#setting-the-rows-and-column-schema) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Supplying data for the table](#supplying-data-for-the-table) + * [Customizing columns](#customizing-columns) + * [DataTable DOM Events](#datatable-dom-events) + * [Card view](#card-view) + * [Using events](#using-events) + * [Customizing the component's styles](#customizing-the-components-styles) +* [Resolver Function](#resolver-function) +* [See also](#see-also) ## Basic usage @@ -331,7 +331,7 @@ When adding your custom templates you can style them as you like. However, for a Notice above those two classes. Apply `adf-datatable-content-cell` for the container of the value that you are going to place in that column and `adf-datatable-cell-value` for the value itself. -If you follow these structure you will be able to apply classes like `.adf-ellipsis-cell` and much more. +If you follow these structure you will be able to apply classes like `.adf-ellipsis-cell` and much more. Note that you can use both the `` and the `` together in the same datatable. @@ -342,38 +342,38 @@ Learm more about styling your datatable: [Customizing the component's styles](#c ### Properties -| Name | Type | Default value | Description | -| ------------------- | --------------------------------------------------------------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| actions | `boolean` | false | Toggles the data actions column. | -| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | -| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. | -| columns | `any[]` | \[] | The columns that the datatable will show. | -| contextMenu | `boolean` | false | Toggles custom context menu for the component. | -| 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". | -| 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). | -| multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row. | -| noPermission | `boolean` | false | Flag that indicates if the datatable should show the "no permission" template. | -| resolverFn | `Function` | null | Custom resolver function which is used to parse dynamic column objects see the docs to learn how to configure a resolverFn. | -| rowMenuCacheEnabled | `boolean` | true | Should the items for the row actions menu be cached for reuse after they are loaded the first time? | -| rowStyle | `string` | | The inline style to apply to every row. See [NgStyle](https://angular.io/docs/ts/latest/api/common/index/NgStyle-directive.html) docs for more details and usage examples. | -| rowStyleClass | `string` | "" | The CSS class to apply to every row. | -| rows | `any[]` | \[] | The rows that the datatable will show. | -| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showHeader | `string` | ShowHeaderMode.Data | Toggles the header. | -| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : [`created`, `desc`], [`created`, `asc`], [`due`, `desc`], [`due`, `asc`] | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| actions | `boolean` | false | Toggles the data actions column. | +| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | +| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. | +| columns | `any[]` | \[] | The columns that the datatable will show. | +| contextMenu | `boolean` | false | Toggles custom context menu for the component. | +| 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". | +| 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). | +| multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row. | +| noPermission | `boolean` | false | Flag that indicates if the datatable should show the "no permission" template. | +| resolverFn | `Function` | null | Custom resolver function which is used to parse dynamic column objects see the docs to learn how to configure a resolverFn. | +| rowMenuCacheEnabled | `boolean` | true | Should the items for the row actions menu be cached for reuse after they are loaded the first time? | +| rowStyle | `string` | | The inline style to apply to every row. See [NgStyle](https://angular.io/docs/ts/latest/api/common/index/NgStyle-directive.html) docs for more details and usage examples. | +| rowStyleClass | `string` | "" | The CSS class to apply to every row. | +| rows | `any[]` | \[] | The rows that the datatable will show. | +| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showHeader | `string` | ShowHeaderMode.Data | Toggles the header. | +| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : \[`created`, `desc`], \[`created`, `asc`], \[`due`, `desc`], \[`due`, `asc`] | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | ### Events -| Name | Type | Description | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | -| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | -| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| Name | Type | Description | +| --- | --- | --- | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | +| rowDblClick | `EventEmitter` | Emitted when the user double-clicks a row. | +| showRowActionsMenu | `EventEmitter` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | `EventEmitter` | Emitted before the context menu is displayed for a row. | ## Details @@ -820,11 +820,11 @@ here is the sample resolver which merge the users property and status and it wil ``` - ![](../../docassets/images/custom-data-table-resolver.png) +![](../../docassets/images/custom-data-table-resolver.png) ## See also -- [Data column component](data-column.component.md) -- [Pagination component](pagination.component.md) -- [Data Table Adapter interface](../interfaces/datatable-adapter.interface.md) -- [Document list component](../../content-services/components/document-list.component.md) +* [Data column component](data-column.component.md) +* [Pagination component](pagination.component.md) +* [Data Table Adapter interface](../interfaces/datatable-adapter.interface.md) +* [Document list component](../../content-services/components/document-list.component.md) diff --git a/docs/core/components/empty-content.component.md b/docs/core/components/empty-content.component.md index 79290a0af0..3bf11859d1 100644 --- a/docs/core/components/empty-content.component.md +++ b/docs/core/components/empty-content.component.md @@ -29,11 +29,11 @@ Provides a generic "Empty Content" placeholder for components. ### Properties -| Name | Type | Default value | Description | -| -------- | -------- | ------------- | ---------------------------------------- | -| icon | `string` | "cake" | Material Icon to use. | -| subtitle | `string` | "" | String or Resource Key for the subtitle. | -| title | `string` | "" | String or Resource Key for the title. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| icon | `string` | "cake" | Material Icon to use. | +| subtitle | `string` | "" | String or Resource Key for the subtitle. | +| title | `string` | "" | String or Resource Key for the title. | ## Details @@ -72,4 +72,4 @@ You can also use multiple lines instead of the subtitle section: ## See also -- [Error content component](error-content.component.md) +* [Error content component](error-content.component.md) diff --git a/docs/core/components/error-content.component.md b/docs/core/components/error-content.component.md index e7d8338cf4..29c20df251 100644 --- a/docs/core/components/error-content.component.md +++ b/docs/core/components/error-content.component.md @@ -11,7 +11,7 @@ Displays info about a specific error. ## Basic Usage -Once you have caught the error in your server you will need to redirect to `/error/errorCode` to display information about that error. +Once you have caught the error in your server you will need to redirect to `/error/errorCode` to display information about that error. ```ts this.router.navigate(['/error', errorCode]); @@ -21,9 +21,9 @@ this.router.navigate(['/error', errorCode]); ### Properties -| Name | Type | Default value | Description | -| --------- | -------- | ------------- | -------------------------------------- | -| errorCode | `string` | | Error code associated with this error. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| errorCode | `string` | | Error code associated with this error. | ## Details @@ -49,7 +49,7 @@ You can customize your error messages by adding them to the translate files insi ## How to customise the action button. -The errorContentComponent allows you to customise the actions section using the selector `adf-error-content-actions`. +The errorContentComponent allows you to customise the actions section using the selector `adf-error-content-actions`. For example you can have a custom action button with the following code @@ -63,4 +63,4 @@ For example you can have a custom action button with the following code ## See also -- [Empty Content component](empty-content.component.md) +* [Empty Content component](empty-content.component.md) diff --git a/docs/core/components/form-field.component.md b/docs/core/components/form-field.component.md index 7495b262c3..25aee2a925 100644 --- a/docs/core/components/form-field.component.md +++ b/docs/core/components/form-field.component.md @@ -25,9 +25,9 @@ based on the field type or the metadata information. ### Properties -| Name | Type | Default value | Description | -| ----- | --------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. | ## Details @@ -38,7 +38,7 @@ uses `` components to render the form fields. Forms defined in APS have the following default mappings for the form fields: -| _APS [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Designer_ [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | Field Type | Component Type | +| *APS [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Designer* [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | Field Type | Component Type | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | 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) | diff --git a/docs/core/components/form-list.component.md b/docs/core/components/form-list.component.md index 663f189801..b566e642dd 100644 --- a/docs/core/components/form-list.component.md +++ b/docs/core/components/form-list.component.md @@ -21,6 +21,6 @@ Shows forms as a list. ### Properties -| Name | Type | Default value | Description | -| ----- | ------- | ------------- | ---------------------------------------------------------------- | -| forms | `any[]` | \[] | The array that contains the information to show inside the list. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| forms | `any[]` | \[] | The array that contains the information to show inside the list. | diff --git a/docs/core/components/header.component.md b/docs/core/components/header.component.md index 976bf6abf5..30206f69e6 100644 --- a/docs/core/components/header.component.md +++ b/docs/core/components/header.component.md @@ -36,25 +36,25 @@ body of the element: ### Properties -| Name | Type | Default value | Description | -| ----------------- | ----------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| color | `string` | | Background color for the header. It can be any hex color code or one of the Material theme colors: 'primary', 'accent' or 'warn'. | -| expandedSidenav | `boolean` | true | expandedSidenav: Toggles the expanded state of the component. | -| logo | `string` | | Path to an image file for the application logo. | -| position | `string` | "start" | The side of the page that the drawer is attached to (can be 'start' or 'end') | -| redirectUrl | `string \| any[]` | "/" | The router link for the application logo, when clicked. | -| showSidenavToggle | `boolean` | true | Toggles whether the sidenav button will be displayed in the header or not. | -| title | `string` | | Title of the application. | -| tooltip | `string` | | The tooltip text for the application logo. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| color | `string` | | Background color for the header. It can be any hex color code or one of the Material theme colors: 'primary', 'accent' or 'warn'. | +| expandedSidenav | `boolean` | true | expandedSidenav: Toggles the expanded state of the component. | +| logo | `string` | | Path to an image file for the application logo. | +| position | `string` | "start" | The side of the page that the drawer is attached to (can be 'start' or 'end') | +| redirectUrl | `string \| any[]` | "/" | The router link for the application logo, when clicked. | +| showSidenavToggle | `boolean` | true | Toggles whether the sidenav button will be displayed in the header or not. | +| title | `string` | | Title of the application. | +| tooltip | `string` | | The tooltip text for the application logo. | ### Events -| Name | Type | Description | -| ------- | --------------------------------------------------------------------- | ------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the sidenav button is clicked. | ## Details This component displays a customizable header that can be reused. Use the input properties to configure the left side (title, button) and the primary color of the header. The right part of the -header can contain other components which are transcluded in the header component. +header can contain other components which are transcluded in the header component. diff --git a/docs/core/components/host-settings.component.md b/docs/core/components/host-settings.component.md index c289952347..ff77ef9a1d 100644 --- a/docs/core/components/host-settings.component.md +++ b/docs/core/components/host-settings.component.md @@ -32,14 +32,14 @@ Validates the URLs for ACS and APS and saves them in the user's local storage ### Properties -| Name | Type | Default value | Description | -| --------- | ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| providers | `string[]` | | Tells the component which provider options are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| providers | `string[]` | | Tells the component which provider options are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO. | ### Events -| Name | Type | Description | -| ------- | --------------------------------------------------------------------- | -------------------------------------------------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user cancels the changes. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the URL is invalid. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the changes are successfully applied. | +| Name | Type | Description | +| --- | --- | --- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user cancels the changes. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the URL is invalid. | +| success | `EventEmitter` | Emitted when the changes are successfully applied. | diff --git a/docs/core/components/icon.component.md b/docs/core/components/icon.component.md index 25fb45fb25..9badb21479 100644 --- a/docs/core/components/icon.component.md +++ b/docs/core/components/icon.component.md @@ -26,10 +26,10 @@ Provides a universal way of rendering registered and named icons. ### Properties -| Name | Type | Default value | Description | -| ----- | --------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------- | -| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Theme color palette for the component. | -| value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Theme color palette for the component. | +| value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. | ## Details @@ -80,4 +80,4 @@ using the `adf:` namespace. ## See also -- [Thumbnail service](../services/thumbnail.service.md) +* [Thumbnail service](../services/thumbnail.service.md) diff --git a/docs/core/components/infinite-pagination.component.md b/docs/core/components/infinite-pagination.component.md index 305ba25557..b7115ba889 100644 --- a/docs/core/components/infinite-pagination.component.md +++ b/docs/core/components/infinite-pagination.component.md @@ -36,16 +36,16 @@ Adds "infinite" pagination to the component it is used with. ### Properties -| Name | Type | Default value | Description | -| --------- | ------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------- | -| isLoading | `boolean` | false | Is a new page loading? | -| pageSize | `number` | | Number of items that are added with each "load more" event. | -| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| isLoading | `boolean` | false | Is a new page loading? | +| pageSize | `number` | | Number of items that are added with each "load more" event. | +| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | ### Events -| Name | Type | Description | -| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RequestPaginationModel`](../../../lib/core/models/request-pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. | ## Details @@ -65,5 +65,5 @@ See the [Pagination component](pagination.component.md) for more information abo ## See also -- [Document list component](../../content-services/components/document-list.component.md) -- [Pagination component](pagination.component.md) +* [Document list component](../../content-services/components/document-list.component.md) +* [Pagination component](pagination.component.md) diff --git a/docs/core/components/info-drawer-layout.component.md b/docs/core/components/info-drawer-layout.component.md index aa2f9b25e1..da372fc6f4 100644 --- a/docs/core/components/info-drawer-layout.component.md +++ b/docs/core/components/info-drawer-layout.component.md @@ -18,9 +18,9 @@ Displays a sidebar-style information panel. There are three regions where you can add your own content using `
` elements with the following names: -- info-drawer-title -- info-drawer-buttons -- info-drawer-content +* info-drawer-title +* info-drawer-buttons +* info-drawer-content ```html @@ -42,9 +42,9 @@ with the following names: ### Properties -| Name | Type | Default value | Description | -| ---------- | --------- | ------------- | ----------------------------- | -| showHeader | `boolean` | true | The visibility of the header. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| showHeader | `boolean` | true | The visibility of the header. | ## Details @@ -54,5 +54,5 @@ See the [Info drawer tab component](info-drawer-tab.component.md) for an alterna ## See also -- [Info drawer component](info-drawer.component.md) -- [Info drawer tab component](info-drawer-tab.component.md) +* [Info drawer component](info-drawer.component.md) +* [Info drawer tab component](info-drawer-tab.component.md) diff --git a/docs/core/components/info-drawer-tab.component.md b/docs/core/components/info-drawer-tab.component.md index a81e407dc0..ed13368754 100644 --- a/docs/core/components/info-drawer-tab.component.md +++ b/docs/core/components/info-drawer-tab.component.md @@ -53,10 +53,10 @@ You can also combine `icon` and `label` properties. ### Properties -| Name | Type | Default value | Description | -| ----- | -------- | ------------- | ------------------------------------------------- | -| icon | `string` | null | Icon to render for the tab. | -| label | `string` | "" | The title of the tab (string or translation key). | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| icon | `string` | null | Icon to render for the tab. | +| label | `string` | "" | The title of the tab (string or translation key). | ## Details @@ -64,5 +64,5 @@ See the [Info drawer component](info-drawer.component.md) page for details of ho ## See also -- [Info drawer component](info-drawer.component.md) -- [Info drawer layout component](info-drawer-layout.component.md) +* [Info drawer component](info-drawer.component.md) +* [Info drawer layout component](info-drawer-layout.component.md) diff --git a/docs/core/components/info-drawer.component.md b/docs/core/components/info-drawer.component.md index 27b3724e71..503cf4be34 100644 --- a/docs/core/components/info-drawer.component.md +++ b/docs/core/components/info-drawer.component.md @@ -18,9 +18,9 @@ Displays a sidebar-style information panel with tabs. There are three regions where you can add your own content using `
` elements with the following names (as with the [Info drawer layout component](info-drawer-layout.component.md)): -- info-drawer-title -- info-drawer-buttons -- info-drawer-content +* info-drawer-title +* info-drawer-buttons +* info-drawer-content The tabs are added using one or more `` elements, which can have any content you like: @@ -47,16 +47,16 @@ have any content you like: ### Properties -| Name | Type | Default value | Description | -| ------------- | ---------------- | ------------- | --------------------------------------------------------- | -| selectedIndex | `number` | 0 | The selected index tab. | -| showHeader | `boolean` | true | The visibility of the header. | -| title | `string \| null` | null | The title of the info drawer (string or translation key). | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| selectedIndex | `number` | 0 | The selected index tab. | +| showHeader | `boolean` | true | The visibility of the header. | +| title | `string \| null` | null | The title of the info drawer (string or translation key). | ### Events -| Name | Type | Description | -| ---------- | -------------------------------------------------------------------- | ---------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | currentTab | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the currently active tab changes. | ## Details @@ -65,5 +65,5 @@ This is a variant of the [Info Drawer Layout component](info-drawer-layout.compo ## See also -- [Info drawer layout component](info-drawer-layout.component.md) -- [Info drawer tab component](info-drawer-tab.component.md) +* [Info drawer layout component](info-drawer-layout.component.md) +* [Info drawer tab component](info-drawer-tab.component.md) diff --git a/docs/core/components/json-cell.component.md b/docs/core/components/json-cell.component.md index d4517394a5..02ba94e1f3 100644 --- a/docs/core/components/json-cell.component.md +++ b/docs/core/components/json-cell.component.md @@ -39,21 +39,21 @@ You can specify the cell inside the `app.config.json` file: ### Properties -| Name | Type | Default value | Description | -| ----------- | --------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| column | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | | Data that defines the column. | -| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of the cell's content. | -| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data table adapter instance. | -| editable | `boolean` | false | Editable JSON. | -| resolverFn | `Function` | null | Custom resolver function which is used to parse dynamic column objects | -| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | | Data that defines the row. | -| tooltip | `string` | | Text for the cell's tooltip. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| column | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | | Data that defines the column. | +| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of the cell's content. | +| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data table adapter instance. | +| editable | `boolean` | false | Editable JSON. | +| resolverFn | `Function` | null | Custom resolver function which is used to parse dynamic column objects | +| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | | Data that defines the row. | +| tooltip | `string` | | Text for the cell's tooltip. | ## Details -This component provides a custom display to show JSON data in a +This component provides a custom display to show JSON data in a [Datatable component](datatable.component.md) cell ## See also -- [Datatable component](datatable.component.md) +* [Datatable component](datatable.component.md) diff --git a/docs/core/components/login-dialog-panel.component.md b/docs/core/components/login-dialog-panel.component.md index d238f1cf39..808c3189d1 100644 --- a/docs/core/components/login-dialog-panel.component.md +++ b/docs/core/components/login-dialog-panel.component.md @@ -13,8 +13,8 @@ Shows and manages a login dialog. ### Events -| Name | Type | Description | -| ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. | ## Details @@ -24,4 +24,4 @@ but it also creates and manages the dialog for you. ## See also -- [Login Dialog component](login-dialog.component.md) +* [Login Dialog component](login-dialog.component.md) diff --git a/docs/core/components/login.component.md b/docs/core/components/login.component.md index cd15bc7494..a0df01c9dd 100644 --- a/docs/core/components/login.component.md +++ b/docs/core/components/login.component.md @@ -13,20 +13,20 @@ Authenticates to Alfresco Content Services and Alfresco Process Services. ## Contents -- [Basic usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Handling events](#handling-events) - - [Custom logo and background](#custom-logo-and-background) - - [Customizing validation rules](#customizing-validation-rules) - - [Call an external identity provider to fetch the auth token](#call-an-external-identity-provider-to-fetch-the-auth-token) - - [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour) - - [Single Sign-On (SSO)](#single-sign-on-sso) - - [Kerberos](#kerberos) -- [See Also](#see-also) +* [Basic usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Handling events](#handling-events) + * [Custom logo and background](#custom-logo-and-background) + * [Customizing validation rules](#customizing-validation-rules) + * [Call an external identity provider to fetch the auth token](#call-an-external-identity-provider-to-fetch-the-auth-token) + * [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour) + * [Single Sign-On (SSO)](#single-sign-on-sso) + * [Kerberos](#kerberos) +* [See Also](#see-also) ## Basic usage @@ -75,25 +75,25 @@ with custom input fields handled by your application or parent component: ### Properties -| Name | Type | Default value | Description | -| ------------------ | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| backgroundImageUrl | `string` | | Path to a custom background image. | -| copyrightText | `string` | | The copyright text below the login box. | -| fieldsValidation | `any` | | Custom validation rules for the login form. | -| logoImageUrl | `string` | | Path to a custom logo image. | -| needHelpLink | `string` | "" | Sets the URL of the NEED HELP link in the footer. | -| registerLink | `string` | "" | Sets the URL of the REGISTER link in the footer. | -| showLoginActions | `boolean` | true | Should the extra actions (`Need Help`, `Register`, etc) be shown? | -| showRememberMe | `boolean` | true | Should the `Remember me` checkbox be shown? When selected, this option will remember the logged-in user after the browser is closed to avoid logging in repeatedly. | -| successRoute | `string` | null | Route to redirect to on successful login. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| backgroundImageUrl | `string` | | Path to a custom background image. | +| copyrightText | `string` | | The copyright text below the login box. | +| fieldsValidation | `any` | | Custom validation rules for the login form. | +| logoImageUrl | `string` | | Path to a custom logo image. | +| needHelpLink | `string` | "" | Sets the URL of the NEED HELP link in the footer. | +| registerLink | `string` | "" | Sets the URL of the REGISTER link in the footer. | +| showLoginActions | `boolean` | true | Should the extra actions (`Need Help`, `Register`, etc) be shown? | +| showRememberMe | `boolean` | true | Should the `Remember me` checkbox be shown? When selected, this option will remember the logged-in user after the browser is closed to avoid logging in repeatedly. | +| successRoute | `string` | null | Route to redirect to on successful login. | ### Events -| Name | Type | Description | -| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. | -| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. | +| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. | +| success | `EventEmitter` | Emitted when the login is successful. | ## Details @@ -264,8 +264,8 @@ export class MyCustomLogin { } ``` -Note that if you do not call `event.preventDefault()` then the default behaviour -will execute _after_ your custom code has completed. +Note that if you do not call `event.preventDefault()` then the default behaviour +will execute *after* your custom code has completed. ### Single Sign-On (SSO) @@ -301,8 +301,8 @@ automatically to the authorization server when the user is not logged-in You can also enable automatic redirection to the OAuth provider using the following properties: -- `silentLogin` -- `redirectSilentIframeUri` +* `silentLogin` +* `redirectSilentIframeUri` ```json { @@ -323,7 +323,7 @@ You can also enable automatic redirection to the OAuth provider using the follow Note that if you deploy the application to a virtual folder (for example `http://
/my-app`) then `redirectSilentIframeUri` -must contain the full URI value: +must contain the full URI value: ```json { @@ -352,8 +352,8 @@ The configuration for Kerberos authentication will allow users to access Alfresc **You don't need to use the [login component](../../core/components/login.component.md) in order to enable Kerberos SSO in ADF**. -See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app. +See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app. ## See Also -- [Logout directive](../directives/logout.directive.md) +* [Logout directive](../directives/logout.directive.md) diff --git a/docs/core/components/notification-history.component.md b/docs/core/components/notification-history.component.md index 902f4d60ea..b1ee768e4b 100644 --- a/docs/core/components/notification-history.component.md +++ b/docs/core/components/notification-history.component.md @@ -7,7 +7,7 @@ Last reviewed: 2019-06-05 # [Notification History component](../../../lib/core/notifications/components/notification-history.component.ts "Defined in notification-history.component.ts") -This component is in the current status just an experimental component. +This component is in the current status just an experimental component. The main purpose of the [Notification history component](../../core/components/notification-history.component.md) is list all the notification received in the current session. They will disappear from the list after the refresh. ![Notification history component](../../docassets/notification-history-component.png) @@ -22,7 +22,7 @@ The main purpose of the [Notification history component](../../core/components/n ### Properties -| Name | Type | Default value | Description | -| ------------- | -------- | ------------- | ----------------------------------------------------------------------------- | -| menuPositionX | `string` | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | -| menuPositionY | `string` | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| menuPositionX | `string` | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | +| menuPositionY | `string` | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | diff --git a/docs/core/components/pagination.component.md b/docs/core/components/pagination.component.md index 01d4200316..97cc6e46d7 100644 --- a/docs/core/components/pagination.component.md +++ b/docs/core/components/pagination.component.md @@ -13,14 +13,14 @@ Adds pagination to the component it is used with. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Integrating with the Document List component](#integrating-with-the-document-list-component) - - [Custom pagination](#custom-pagination) -- [See also](#see-also) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Integrating with the Document List component](#integrating-with-the-document-list-component) + * [Custom pagination](#custom-pagination) +* [See also](#see-also) ## Basic Usage @@ -40,21 +40,21 @@ Adds pagination to the component it is used with. ### Properties -| Name | Type | Default value | Description | -| ------------------ | ------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------- | -| supportedPageSizes | `number[]` | | An array of page sizes. | -| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | -| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| supportedPageSizes | `number[]` | | An array of page sizes. | +| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | +| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. | ### Events -| Name | Type | Description | -| ---------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. | -| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. | -| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page size changes. | -| nextPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the next page is requested. | -| prevPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the previous page is requested. | +| Name | Type | Description | +| --- | --- | --- | +| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. | +| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. | +| changePageSize | `EventEmitter` | Emitted when the page size changes. | +| nextPage | `EventEmitter` | Emitted when the next page is requested. | +| prevPage | `EventEmitter` | Emitted when the previous page is requested. | ## Details @@ -67,7 +67,7 @@ can pass to a subsequent API call. Each event corresponds to a particular action from the user. For the `change` event, a PaginationQueryParams object is returned. This contains the query -parameters supported by the REST API, `skipCount` and `maxItems`. +parameters supported by the REST API, `skipCount` and `maxItems`. For all events other than `change`, a new [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) object is returned as in the following example. The new object contains updated properties that you can use to fetch the next page of information. @@ -102,4 +102,4 @@ and pass the updated parameters. ## See also -- [Infinite Pagination component](infinite-pagination.component.md) +* [Infinite Pagination component](infinite-pagination.component.md) diff --git a/docs/core/components/search-text-input.component.md b/docs/core/components/search-text-input.component.md index 069dc6c7e0..cf0f417eac 100644 --- a/docs/core/components/search-text-input.component.md +++ b/docs/core/components/search-text-input.component.md @@ -26,24 +26,24 @@ Displays a input text that supports autocompletion ### Properties -| Name | Type | Default value | Description | -| ------------------ | ------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------ | -| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | -| collapseOnSubmit | `boolean` | true | Collapse search bar on submit. | -| debounceTime | `number` | 0 | Debounce time in milliseconds. | -| defaultState | `SearchTextStateEnum` | | Default state expanded or Collapsed. | -| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. | -| focusListener | [`Observable`](http://reactivex.io/documentation/observable.html)`` | | Listener for results-list events (focus, blur and focusout). | -| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). | -| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. | -| searchAutocomplete | `any` | false | Trigger autocomplete results on input change. | -| searchTerm | `string` | "" | Search term preselected | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | +| collapseOnSubmit | `boolean` | true | Collapse search bar on submit. | +| debounceTime | `number` | 0 | Debounce time in milliseconds. | +| defaultState | `SearchTextStateEnum` | | Default state expanded or Collapsed. | +| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. | +| focusListener | [`Observable`](http://reactivex.io/documentation/observable.html)`` | | Listener for results-list events (focus, blur and focusout). | +| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). | +| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. | +| searchAutocomplete | `any` | false | Trigger autocomplete results on input change. | +| searchTerm | `string` | "" | Search term preselected | ### Events -| Name | Type | Description | -| ------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| reset | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the result list is reset | -| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | -| selectResult | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the result list is selected | -| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | +| Name | Type | Description | +| --- | --- | --- | +| reset | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the result list is reset | +| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | +| selectResult | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the result list is selected | +| submit | `EventEmitter` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | diff --git a/docs/core/components/sidebar-action-menu.component.md b/docs/core/components/sidebar-action-menu.component.md index 843cb181af..0565e9124b 100644 --- a/docs/core/components/sidebar-action-menu.component.md +++ b/docs/core/components/sidebar-action-menu.component.md @@ -19,9 +19,9 @@ Displays a sidebar-action menu information panel. There are three regions where you can add your own content in `
` elements with the following names: -- adf-sidebar-menu-title-icon -- adf-sidebar-menu-options -- adf-sidebar-menu-expand-icon +* adf-sidebar-menu-title-icon +* adf-sidebar-menu-options +* adf-sidebar-menu-expand-icon ```html @@ -42,12 +42,12 @@ the following names: ### Properties -| Name | Type | Default value | Description | -| -------- | --------- | ------------- | ------------------------------------------------ | -| expanded | `boolean` | | Toggle the sidebar action menu on expand. | -| title | `string` | | The title of the sidebar action. | -| width | `number` | 272 | Width in pixels for sidebar action menu options. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| expanded | `boolean` | | Toggle the sidebar action menu on expand. | +| title | `string` | | The title of the sidebar action. | +| width | `number` | 272 | Width in pixels for sidebar action menu options. | ## Details -As the name suggests, this is basically just a layout with CSS styling. +As the name suggests, this is basically just a layout with CSS styling. diff --git a/docs/core/components/sidenav-layout.component.md b/docs/core/components/sidenav-layout.component.md index 669e86a05c..4ce3c00943 100644 --- a/docs/core/components/sidenav-layout.component.md +++ b/docs/core/components/sidenav-layout.component.md @@ -13,22 +13,22 @@ Displays the standard three-region ADF application layout. ## Contents -- [Basic Usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Template context](#template-context) - - [menuOpenState$](#menuopenstate) - - [Preserving the menu state](#preserving-the-menu-state) +* [Basic Usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Template context](#template-context) + * [menuOpenState$](#menuopenstate) + * [Preserving the menu state](#preserving-the-menu-state) ## Basic Usage ### [Transclusions](../../user-guide/transclusion.md) The content for the header, navigation area, and main content are transcluded using three special -sub-components (note the use of `` in the sub-components' body sections): +sub-components (note the use of `` in the sub-components' body sections): ```html ` in the sub-components' body sect ### Properties -| Name | Type | Default value | Description | -| --------------- | --------- | ------------- | -------------------------------------------------------------------------------------- | -| expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? | -| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. | -| position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. | -| sidenavMax | `number` | | Maximum size of the navigation region. | -| sidenavMin | `number` | | Minimum size of the navigation region. | -| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? | +| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. | +| position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. | +| sidenavMax | `number` | | Maximum size of the navigation region. | +| sidenavMin | `number` | | Minimum size of the navigation region. | +| stepOver | `number` | | Screen size at which display switches from small screen to large screen configuration. | ### Events -| Name | Type | Description | -| -------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. | ## Details @@ -114,10 +114,10 @@ Mobile layout (screen width less than the `stepOver` value): Each template is given a context containing the following methods: -- `toggleMenu(): void` +* `toggleMenu(): void` Triggers menu toggling. -- `isMenuMinimized(): boolean` +* `isMenuMinimized(): boolean` The expanded/compact (minimized) state of the navigation. This one only makes sense in case of desktop size, when the screen size is above the value of stepOver. ### menuOpenState$ @@ -126,12 +126,12 @@ Beside the template context's **isMenuMinimized** variable, another way to liste | Name | Type | Default | Description | | -------------- | ----------------------------------------------------------------------------- | ------- | ----------------------------------------------- | -| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)<boolean> | true | Another way to listen to menu open/closed state | +| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)\ | true | Another way to listen to menu open/closed state | Every time the menu state is changed, the following values are emitted: -- true, if the menu changed to the opened state -- false, if the menu changed to the closed state +* true, if the menu changed to the opened state +* false, if the menu changed to the closed state ### Preserving the menu state @@ -147,7 +147,7 @@ set a property in the `app.config.json` file: When this property is set, the collapsed/expanded state will be stored in the local storage and restored when the page is reloaded or when the user next uses the app. -You can also set the default state in the `app.config.json` file: +You can also set the default state in the `app.config.json` file: ```json "sideNav" : { diff --git a/docs/core/components/sorting-picker.component.md b/docs/core/components/sorting-picker.component.md index e1009d5143..2351a21444 100644 --- a/docs/core/components/sorting-picker.component.md +++ b/docs/core/components/sorting-picker.component.md @@ -26,18 +26,18 @@ Selects from a set of predefined sorting definitions and directions. ### Properties -| Name | Type | Default value | Description | -| --------- | ----------------- | ------------- | ----------------------------- | -| ascending | `boolean` | true | Current sorting direction | -| options | `Array` | \[] | Available sorting options | -| selected | `string` | | Currently selected option key | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| ascending | `boolean` | true | Current sorting direction | +| options | `Array` | \[] | Available sorting options | +| selected | `string` | | Currently selected option key | ### Events -| Name | Type | Description | -| ------------- | --------------------------------------------------------------------- | ------------------------------------------ | -| sortingChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time direction gets changed. | -| valueChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time sorting key gets changed. | +| Name | Type | Description | +| --- | --- | --- | +| sortingChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time direction gets changed. | +| valueChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time sorting key gets changed. | ## Details diff --git a/docs/core/components/start-form.component.md b/docs/core/components/start-form.component.md index 75184ed33d..0a933ac2af 100644 --- a/docs/core/components/start-form.component.md +++ b/docs/core/components/start-form.component.md @@ -24,46 +24,46 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode ### Properties -| Name | Type | Default value | Description | -| ------------------------- | -------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 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. | -| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | -| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | -| enableFixedSpacedForm | `boolean` | true | The form will set a prefixed space for invisible fields. | -| 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. | -| formId | `number` | | 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. | -| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | -| nodeId | `string` | | Content Services node ID for the form metadata. | -| path | `string` | | Path of the folder where the metadata will be stored. | -| processDefinitionId | `string` | | [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId | -| processId | `string` | | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId | -| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | -| readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? | -| saveMetadata | `boolean` | false | Toggle saving of form metadata. | -| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | -| showOutcomeButtons | `boolean` | true | Should form outcome buttons be shown? | -| showRefreshButton | `boolean` | true | Should the refresh button be shown? | -| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | -| showTitle | `boolean` | true | Toggle rendering of the form title. | -| showValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | -| taskId | `string` | | Task id to fetch corresponding form and values. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| 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. | +| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | +| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | +| enableFixedSpacedForm | `boolean` | true | The form will set a prefixed space for invisible fields. | +| 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. | +| formId | `number` | | 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. | +| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | +| nodeId | `string` | | Content Services node ID for the form metadata. | +| path | `string` | | Path of the folder where the metadata will be stored. | +| processDefinitionId | `string` | | [`Definition`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId | +| processId | `string` | | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId | +| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | +| readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? | +| saveMetadata | `boolean` | false | Toggle saving of form metadata. | +| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | +| showOutcomeButtons | `boolean` | true | Should form outcome buttons be shown? | +| showRefreshButton | `boolean` | true | Should the refresh button be shown? | +| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | +| showTitle | `boolean` | true | Toggle rendering of the form title. | +| showValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | +| taskId | `string` | | Task id to fetch corresponding form and values. | ### Events -| Name | Type | Description | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| 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. | -| 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/models/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. | -| 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. | -| outcomeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks one of the outcome buttons that completes the form. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| 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. | +| 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` | Emitted when the supplied form values have a validation error. | +| formLoaded | `EventEmitter` | Emitted when the form is loaded or reloaded. | +| formSaved | `EventEmitter` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| outcomeClick | `EventEmitter` | Emitted when the user clicks one of the outcome buttons that completes the form. | ## Details @@ -78,4 +78,4 @@ the user clicked. You can pass this value to the `startProcess` method (defined ## See also -- [Process service](../../process-services/services/process.service.md) +* [Process service](../../process-services/services/process.service.md) diff --git a/docs/core/components/text-mask.component.md b/docs/core/components/text-mask.component.md index ab45dd881d..d4ae6f65a7 100644 --- a/docs/core/components/text-mask.component.md +++ b/docs/core/components/text-mask.component.md @@ -19,9 +19,9 @@ Implements text field input masks. ### Properties -| Name | Type | Default value | Description | -| --------- | ---------- | ------------- | ------------------------------------------- | -| inputMask | `Function` | | Object defining mask and "reversed" status. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| inputMask | `Function` | | Object defining mask and "reversed" status. | ## Details @@ -45,11 +45,11 @@ text mask in ADF would be: The following characters have special meaning within a mask; all other characters are included in the text as they are: -- **"0"**: Denotes a digit -- **"9"**: Denotes a digit that can optionally be left out -- **"A"**: Denotes a alphanumeric character (upper- or lower-case A-Z and digits 0-9) -- **"S"**: Denotes a alphabetic character (upper- or lower-case A-Z) -- **"#"**: Denotes a string of zero or more digits +* **"0"**: Denotes a digit +* **"9"**: Denotes a digit that can optionally be left out +* **"A"**: Denotes a alphanumeric character (upper- or lower-case A-Z and digits 0-9) +* **"S"**: Denotes a alphabetic character (upper- or lower-case A-Z) +* **"#"**: Denotes a string of zero or more digits The mask is passed to the directive in the `mask` field of the parameter object. The `reversed` field indicates that digits in the mask are "filled up" in diff --git a/docs/core/components/toolbar.component.md b/docs/core/components/toolbar.component.md index 3124e7b9c9..c555741304 100644 --- a/docs/core/components/toolbar.component.md +++ b/docs/core/components/toolbar.component.md @@ -13,14 +13,14 @@ Simple container for headers, titles, actions and breadcrumbs. ## Contents -- [Basic Usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) -- [Details](#details) - - [Dropdown menu](#dropdown-menu) - - [Custom color](#custom-color) -- [See also](#see-also) +* [Basic Usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) +* [Details](#details) + * [Dropdown menu](#dropdown-menu) + * [Custom color](#custom-color) +* [See also](#see-also) ## Basic Usage @@ -72,10 +72,10 @@ pushed to the right by a spacer: ### Properties -| Name | Type | Default value | Description | -| ----- | --------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------- | -| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Toolbar color. Can be changed to empty value (default), `primary`, `accent` or `warn`. | -| title | `string` | "" | Toolbar title. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Toolbar color. Can be changed to empty value (default), `primary`, `accent` or `warn`. | +| title | `string` | "" | Toolbar title. | ## Details @@ -133,5 +133,5 @@ For example: ## See also -- [Toolbar Divider component](toolbar-divider.component.md) -- [Toolbar Title component](toolbar-title.component.md) +* [Toolbar Divider component](toolbar-divider.component.md) +* [Toolbar Title component](toolbar-title.component.md) diff --git a/docs/core/components/user-info.component.md b/docs/core/components/user-info.component.md index 40c1759929..01c3dcb737 100644 --- a/docs/core/components/user-info.component.md +++ b/docs/core/components/user-info.component.md @@ -19,14 +19,14 @@ Shows user information. ### Properties -| Name | Type | Default value | Description | -| ------------------ | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------- | -| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. | -| ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. | -| menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | -| menuPositionY | [`MenuPositionY`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | -| namePosition | `string` | "right" | When the username is shown, this defines its position relative to the user info button. Can be `right` or `left`. | -| showName | `boolean` | true | Shows/hides the username next to the user info button. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. | +| ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. | +| menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | +| menuPositionY | [`MenuPositionY`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | +| namePosition | `string` | "right" | When the username is shown, this defines its position relative to the user info button. Can be `right` or `left`. | +| showName | `boolean` | true | Shows/hides the username next to the user info button. | ## Details diff --git a/docs/core/components/viewer.component.md b/docs/core/components/viewer.component.md index 2bf0590b69..ade9902997 100644 --- a/docs/core/components/viewer.component.md +++ b/docs/core/components/viewer.component.md @@ -13,22 +13,22 @@ See it live: [Viewer Quickstart](https://embed.plnkr.co/iTuG1lFIXfsP95l6bDW6/) ## Contents -- [Basic usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Keyboard shortcuts](#keyboard-shortcuts) -- [Details](#details) - - [Integrating with the Document List component](#integrating-with-the-document-list-component) - - [Custom file parameters](#custom-file-parameters) - - [Supported file formats](#supported-file-formats) - - [Content Renditions](#content-renditions) - - [Configuring PDF.js library](#configuring-pdfjs-library) - - [Extending the Viewer](#extending-the-viewer) - - [Custom layout](#custom-layout) - - [Printing](#printing) -- [See also](#see-also) +* [Basic usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Keyboard shortcuts](#keyboard-shortcuts) +* [Details](#details) + * [Integrating with the Document List component](#integrating-with-the-document-list-component) + * [Custom file parameters](#custom-file-parameters) + * [Supported file formats](#supported-file-formats) + * [Content Renditions](#content-renditions) + * [Configuring PDF.js library](#configuring-pdfjs-library) + * [Extending the Viewer](#extending-the-viewer) + * [Custom layout](#custom-layout) + * [Printing](#printing) +* [See also](#see-also) ## Basic usage @@ -74,48 +74,48 @@ See the [Custom layout](#custom-layout) section for full details of all availabl ### Properties -| Name | Type | Default value | Description | -| -------------------- | --------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| allowDownload | `boolean` | true | Toggles downloading. | -| allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. | -| allowGoBack | `boolean` | true | Allows `back` navigation | -| allowLeftSidebar | `boolean` | false | Allow the left the sidebar. | -| allowNavigate | `boolean` | false | Toggles before/next navigation. You can use the arrow buttons to navigate between documents in the collection. | -| allowPrint | `boolean` | false | Toggles printing. | -| allowRightSidebar | `boolean` | false | Allow the right sidebar. | -| allowThumbnails | `boolean` | true | Toggles PDF thumbnails. | -| blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File | -| canNavigateBefore | `boolean` | true | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. | -| canNavigateNext | `boolean` | true | Toggles the next (">") button. Requires `allowNavigate` to be enabled. | -| displayName | `string` | | Specifies the name of the file when it is not available from the URL. | -| fileName | `string` | | Content filename. | -| maxRetries | `number` | 30 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. | -| mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). | -| nodeId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) Id of the file to load. | -| overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. | -| sharedLinkId | `string` | null | Shared link id (to display shared file). | -| showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. | -| showRightSidebar | `boolean` | false | Toggles right sidebar visibility. Requires `allowRightSidebar` to be set to `true`. | -| showToolbar | `boolean` | true | Hide or show the toolbar | -| showViewer | `boolean` | true | Hide or show the viewer | -| sidebarLeftTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the left sidebar. The template context contains the loaded node data. | -| sidebarRightTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the right sidebar. The template context contains the loaded node data. | -| thumbnailsTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the pdf thumbnails. | -| urlFile | `string` | "" | If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from. | -| urlFileViewer | `string` | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. | -| versionId | `string` | null | Version Id of the file to load. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| allowDownload | `boolean` | true | Toggles downloading. | +| allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. | +| allowGoBack | `boolean` | true | Allows `back` navigation | +| allowLeftSidebar | `boolean` | false | Allow the left the sidebar. | +| allowNavigate | `boolean` | false | Toggles before/next navigation. You can use the arrow buttons to navigate between documents in the collection. | +| allowPrint | `boolean` | false | Toggles printing. | +| allowRightSidebar | `boolean` | false | Allow the right sidebar. | +| allowThumbnails | `boolean` | true | Toggles PDF thumbnails. | +| blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File | +| canNavigateBefore | `boolean` | true | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. | +| canNavigateNext | `boolean` | true | Toggles the next (">") button. Requires `allowNavigate` to be enabled. | +| displayName | `string` | | Specifies the name of the file when it is not available from the URL. | +| fileName | `string` | | Content filename. | +| maxRetries | `number` | 30 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. | +| mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). | +| nodeId | `string` | null | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) Id of the file to load. | +| overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. | +| sharedLinkId | `string` | null | Shared link id (to display shared file). | +| showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. | +| showRightSidebar | `boolean` | false | Toggles right sidebar visibility. Requires `allowRightSidebar` to be set to `true`. | +| showToolbar | `boolean` | true | Hide or show the toolbar | +| showViewer | `boolean` | true | Hide or show the viewer | +| sidebarLeftTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the left sidebar. The template context contains the loaded node data. | +| sidebarRightTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the right sidebar. The template context contains the loaded node data. | +| thumbnailsTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the pdf thumbnails. | +| urlFile | `string` | "" | If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from. | +| urlFileViewer | `string` | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. | +| versionId | `string` | null | Version Id of the file to load. | ### Events -| Name | Type | Description | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the filename extension changes. | -| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Back' button. | -| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the shared link used is not valid. | -| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Before' ("<") button. | -| navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Next' (">") button. | -| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Print' button. | -| showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the viewer is shown or hidden. | +| Name | Type | Description | +| --- | --- | --- | +| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the filename extension changes. | +| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Back' button. | +| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the shared link used is not valid. | +| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Before' ("<") button. | +| navigateNext | `EventEmitter` | Emitted when user clicks 'Navigate Next' (">") button. | +| print | `EventEmitter>` | Emitted when user clicks the 'Print' button. | +| showViewerChange | `EventEmitter` | Emitted when the viewer is shown or hidden. | ## Keyboard shortcuts @@ -130,7 +130,7 @@ See the [Custom layout](#custom-layout) section for full details of all availabl ### Integrating with the Document List component -Below is the most simple integration of the Viewer and +Below is the most simple integration of the Viewer and [Document List](../../content-services/components/document-list.component.md) components within your custom component: ```html @@ -182,45 +182,45 @@ You can provide custom file parameters, for example a value for the `mimeType` o The [Viewer component](viewer.component.md) consists of separate Views that handle particular file types or type families based on either a file extension or a mime type: -- PDF View - - application/pdf - - \*.pdf -- Image View - - image/png - - image/jpeg - - image/gif - - image/bmp - - image/svg+xml - - \*.png - - \*.jpg - - \*.jpeg - - \*.gif - - \*.bpm - - \*.svg -- Text View - - text/plain - - text/csv - - text/xml - - text/html - - application/x-javascript - - \*.txt - - \*.xml - - \*.js - - \*.html - - \*.json - - \*.ts -- Media View - - video/mp4 - - video/webm - - video/ogg - - audio/mpeg - - audio/ogg - - audio/wav - - \*.wav - - \*.mp4 - - \*.mp3 - - \*.webm - - \*.ogg +* PDF View + * application/pdf + * \*.pdf +* Image View + * image/png + * image/jpeg + * image/gif + * image/bmp + * image/svg+xml + * \*.png + * \*.jpg + * \*.jpeg + * \*.gif + * \*.bpm + * \*.svg +* Text View + * text/plain + * text/csv + * text/xml + * text/html + * application/x-javascript + * \*.txt + * \*.xml + * \*.js + * \*.html + * \*.json + * \*.ts +* Media View + * video/mp4 + * video/webm + * video/ogg + * audio/mpeg + * audio/ogg + * audio/wav + * \*.wav + * \*.mp4 + * \*.mp3 + * \*.webm + * \*.ogg ### Content Renditions @@ -474,14 +474,14 @@ You can set a default zoom scaling value for pdf viewer by adding the following Note: For the pdf viewer the value has to be within the range of 25 - 1000. "adf-viewer": { - "pdf-viewer-scaling": 150 - } +"pdf-viewer-scaling": 150 +} In the same way you can set a default zoom scaling value for the image viewer by adding the following code in `app.config.json`. "adf-viewer": { - "image-viewer-scaling": 150 - } +"image-viewer-scaling": 150 +} By default the viewer's zoom scaling is set to 100%. @@ -502,4 +502,4 @@ content. ## See also -- [Document List component](../../content-services/components/document-list.component.md) +* [Document List component](../../content-services/components/document-list.component.md) diff --git a/docs/core/directives/check-allowable-operation.directive.md b/docs/core/directives/check-allowable-operation.directive.md index ebdb870565..e02f24b598 100644 --- a/docs/core/directives/check-allowable-operation.directive.md +++ b/docs/core/directives/check-allowable-operation.directive.md @@ -11,14 +11,14 @@ Selectively disables an HTML element or Angular component. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) -- [Details](#details) - - [HTML element example](#html-element-example) - - [Angular component example](#angular-component-example) - - [Implementing the NodeAllowableOperationSubject interface](#implementing-the-nodeallowableoperationsubject-interface) - - [Defining your component as an EXTENDIBLE_COMPONENT parent component](#defining-your-component-as-an-extendible_component-parent-component) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) +* [Details](#details) + * [HTML element example](#html-element-example) + * [Angular component example](#angular-component-example) + * [Implementing the NodeAllowableOperationSubject interface](#implementing-the-nodeallowableoperationsubject-interface) + * [Defining your component as an EXTENDIBLE_COMPONENT parent component](#defining-your-component-as-an-extendible_component-parent-component) ## Basic Usage @@ -40,10 +40,10 @@ Selectively disables an HTML element or Angular component. ### Properties -| Name | Type | Default value | Description | -| ---------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. | -| permission | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. | +| permission | `string` | null | Node permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). | ## Details @@ -52,8 +52,8 @@ by taking a collection of [`NodeEntry`](https://github.com/Alfresco/alfresco-js- The decorated element will be disabled if: -- there are no nodes in the collection -- at least one of the nodes does not have the required permission +* there are no nodes in the collection +* at least one of the nodes does not have the required permission ### HTML element example diff --git a/docs/core/directives/clipboard.directive.md b/docs/core/directives/clipboard.directive.md index 913fdfdf2c..3e86d993f9 100644 --- a/docs/core/directives/clipboard.directive.md +++ b/docs/core/directives/clipboard.directive.md @@ -25,11 +25,11 @@ Copies text to the clipboard. ### Properties -| Name | Type | Default value | Description | -| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------- | -| message | `string` | | Translation key or message for snackbar notification. | -| placeholder | `string` | | Translation key or message for the tooltip. | -| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| message | `string` | | Translation key or message for snackbar notification. | +| placeholder | `string` | | Translation key or message for the tooltip. | +| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. | ## Details @@ -42,4 +42,4 @@ the user hovers the mouse over the element. You can also provide a snackbar mess ## See also -- [Clipboard service](../../core/services/clipboard.service.md) +* [Clipboard service](../../core/services/clipboard.service.md) diff --git a/docs/core/directives/context-menu.directive.md b/docs/core/directives/context-menu.directive.md index 24b0b86215..410029e39b 100644 --- a/docs/core/directives/context-menu.directive.md +++ b/docs/core/directives/context-menu.directive.md @@ -47,10 +47,10 @@ export class MyComponent implements OnInit { ### Properties -| Name | Type | Default value | Description | -| ------- | --------- | ------------- | -------------------- | -| enabled | `boolean` | false | Is the menu enabled? | -| links | `any[]` | | Items for the menu. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| enabled | `boolean` | false | Is the menu enabled? | +| links | `any[]` | | Items for the menu. | ## Details diff --git a/docs/core/directives/highlight.directive.md b/docs/core/directives/highlight.directive.md index 4219debf39..331c7ea354 100644 --- a/docs/core/directives/highlight.directive.md +++ b/docs/core/directives/highlight.directive.md @@ -25,11 +25,11 @@ Adds highlighting to selected sections of an HTML element's content. ### Properties -| Name | Type | Default value | Description | -| ------------ | -------- | --------------- | ------------------------------------------ | -| classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. | -| search | `string` | "" | Text to highlight. | -| selector | `string` | "" | Class selector for highlightable elements. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. | +| search | `string` | "" | Text to highlight. | +| selector | `string` | "" | Class selector for highlightable elements. | ## Details @@ -52,8 +52,8 @@ If the search string contain spaces then each section between the spaces will be treated as a separate item to highlight. For example, you could use this to highlight all occurrences of words in a list. -The highlighting works by adding an HTML <span> element around the -selected text. The <span> includes a CSS class; this defaults to +The highlighting works by adding an HTML \ element around the +selected text. The \ includes a CSS class; this defaults to "adf-highlight" but you can supply your own class using the `adf-highlight-class` property: @@ -70,5 +70,5 @@ property: ## See also -- [Text highlight pipe](../pipes/text-highlight.pipe.md) -- [Highlight transform service](../services/highlight-transform.service.md) +* [Text highlight pipe](../pipes/text-highlight.pipe.md) +* [Highlight transform service](../services/highlight-transform.service.md) diff --git a/docs/core/directives/logout.directive.md b/docs/core/directives/logout.directive.md index 3d155f441c..489aa17d6c 100644 --- a/docs/core/directives/logout.directive.md +++ b/docs/core/directives/logout.directive.md @@ -19,19 +19,19 @@ Logs the user out when the decorated element is clicked. ### Properties -| Name | Type | Default value | Description | -| -------------- | --------- | ------------- | ------------------------------------- | -| enableRedirect | `boolean` | true | Enable redirecting after logout | -| redirectUri | `string` | "/login" | URI to redirect to after logging out. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| enableRedirect | `boolean` | true | Enable redirecting after logout | +| redirectUri | `string` | "/login" | URI to redirect to after logging out. | ## Kerberos The configuration for Kerberos authentication will allow users to access Alfresco products by entering their credentials only once when logging into their Windows environment. -**You don't need to use the [logout directive](../../core/directives/logout.directive.md) when Kerberos SSO is enabled in ADF**. +**You don't need to use the [logout directive](../../core/directives/logout.directive.md) when Kerberos SSO is enabled in ADF**. -See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app. +See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app. ## See also -- [Login component](../components/login.component.md) +* [Login component](../components/login.component.md) diff --git a/docs/core/directives/node-delete.directive.md b/docs/core/directives/node-delete.directive.md index d6366b01a8..78affceb2e 100644 --- a/docs/core/directives/node-delete.directive.md +++ b/docs/core/directives/node-delete.directive.md @@ -28,15 +28,15 @@ Deletes multiple files and folders. ### Properties -| Name | Type | Default value | Description | -| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------- | -| permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash | -| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash | +| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. | ### Events -| Name | Type | Description | -| ------ | ----------------------------------------------------------------- | ----------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | delete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the nodes have been deleted. | ## Details @@ -46,4 +46,4 @@ this action will delete the file permanently. ## See also -- [Node Restore directive](node-restore.directive.md) +* [Node Restore directive](node-restore.directive.md) diff --git a/docs/core/directives/node-download.directive.md b/docs/core/directives/node-download.directive.md index 4591af63bc..f7a36e0cd7 100644 --- a/docs/core/directives/node-download.directive.md +++ b/docs/core/directives/node-download.directive.md @@ -29,7 +29,7 @@ Allows folders and/or files to be downloaded, with multiple nodes packed as a '. ### Properties -| Name | Type | Default value | Description | -| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)` \| `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | | Nodes to download. | -| version | [`VersionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/VersionEntry.md) | | [Node's](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) version to download. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)` \| `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | | Nodes to download. | +| version | `VersionEntry` | | Node's version to download. | diff --git a/docs/core/directives/node-favorite.directive.md b/docs/core/directives/node-favorite.directive.md index 8a40233c78..e74b6f2452 100644 --- a/docs/core/directives/node-favorite.directive.md +++ b/docs/core/directives/node-favorite.directive.md @@ -41,15 +41,15 @@ export class MyComponent { ### Properties -| Name | Type | Default value | Description | -| --------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- | -| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. | ### Events -| Name | Type | Description | -| ------ | ----------------------------------------------------------------- | ---------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting fails. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting fails. | | toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting is complete. | ## Details @@ -75,9 +75,9 @@ which also lets you add extra styling to the element: The directive behaves as follows: -- If there are no favorite nodes in the selection, then all are marked as favorites -- If there are one or more favorite nodes in the selection, then only those that are not +* If there are no favorite nodes in the selection, then all are marked as favorites +* If there are one or more favorite nodes in the selection, then only those that are not favorites are marked -- If all nodes in the selection are favorites, then they all have their favorite status removed +* If all nodes in the selection are favorites, then they all have their favorite status removed See the **Demo Shell** for examples of usage. diff --git a/docs/core/directives/node-restore.directive.md b/docs/core/directives/node-restore.directive.md index 4eaf6d24b9..de10c1bc48 100644 --- a/docs/core/directives/node-restore.directive.md +++ b/docs/core/directives/node-restore.directive.md @@ -48,14 +48,14 @@ Restores deleted nodes to their original location. ### Properties -| Name | Type | Default value | Description | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------- | ---------------------------------- | -| selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` | | Array of deleted nodes to restore. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` | | Array of deleted nodes to restore. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | restore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RestoreMessageModel`](../../../lib/core/directives/node-restore.directive.ts)`>` | Emitted when restoration is complete. | ## Details @@ -69,4 +69,4 @@ been restored. The property specifies the route path where the list of nodes are ## See Also -- [Node delete directive](node-delete.directive.md) +* [Node delete directive](node-delete.directive.md) diff --git a/docs/core/directives/upload.directive.md b/docs/core/directives/upload.directive.md index 960ea0714e..6c2204ae0a 100644 --- a/docs/core/directives/upload.directive.md +++ b/docs/core/directives/upload.directive.md @@ -21,14 +21,14 @@ Uploads content in response to file drag and drop. ### Properties -| Name | Type | Default value | Description | -| --------- | ---------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| accept | `string` | | (Click mode only) MIME type filter for files to accept. | -| data | `any` | | Data to upload. | -| directory | `boolean` | | (Click mode only) Toggles uploading of directories. | -| enabled | `boolean` | true | Enables/disables uploading. | -| mode | `string[]` | ['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. | -| multiple | `boolean` | | Toggles multiple file uploads. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| accept | `string` | | (Click mode only) MIME type filter for files to accept. | +| data | `any` | | Data to upload. | +| directory | `boolean` | | (Click mode only) Toggles uploading of directories. | +| enabled | `boolean` | true | Enables/disables uploading. | +| mode | `string[]` | \['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. | +| multiple | `boolean` | | Toggles multiple file uploads. | ## Details @@ -65,8 +65,8 @@ value or expression: The [Upload directive](upload.directive.md) supports two modes: -- **drop** mode, where the decorated element acts like a drop zone for files (enabled by default) -- **click** mode, where the decorated element invokes a file dialog to select files or folders. +* **drop** mode, where the decorated element acts like a drop zone for files (enabled by default) +* **click** mode, where the decorated element invokes a file dialog to select files or folders. You can also use both modes together: @@ -80,9 +80,9 @@ You can also use both modes together: In click mode you can provide extra attributes for the file dialog: -- **directory**, enables directory selection -- **multiple**, enables multiple file/folder selection -- **accept**, filters the content accepted +* **directory**, enables directory selection +* **multiple**, enables multiple file/folder selection +* **accept**, filters the content accepted ```html
``` -It can be set to match major, minor and patches of ACS versions. Fox example, if the version `6` is specifed it will enable the component from `6.0.0` onwards. +It can be set to match major, minor and patches of ACS versions. Fox example, if the version `6` is specifed it will enable the component from `6.0.0` onwards. If the minimum version required is not matched the component will not be initialized and will disappear from the DOM tree. diff --git a/docs/core/services/app-config.service.md b/docs/core/services/app-config.service.md index 0e205e91a2..3da6d856b7 100644 --- a/docs/core/services/app-config.service.md +++ b/docs/core/services/app-config.service.md @@ -13,27 +13,27 @@ Supports app configuration settings, stored server side. ### Methods -- **get**(key: `string`, defaultValue?: \`\`)
+* **get**(key: `string`, defaultValue?: \`\`)
Gets the value of a named property. - - _key:_ `string` - Name of the property - - _defaultValue:_ \`\` - (Optional) Value to return if the key is not found -- **getLocationHostname**(): `string`
+ * *key:* `string` - Name of the property + * *defaultValue:* \`\` - (Optional) Value to return if the key is not found +* **getLocationHostname**(): `string`
Gets the location.hostname property. - - **Returns** `string` - Value of the property -- **getLocationPort**(prefix: `string` = `""`): `string`
+ * **Returns** `string` - Value of the property +* **getLocationPort**(prefix: `string` = `""`): `string`
Gets the location.port property. - - _prefix:_ `string` - Text added before port value - - **Returns** `string` - Port with prefix -- **getLocationProtocol**(): `string`
+ * *prefix:* `string` - Text added before port value + * **Returns** `string` - Port with prefix +* **getLocationProtocol**(): `string`
Gets the location.protocol value. - - **Returns** `string` - The location.protocol string -- **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
+ * **Returns** `string` - The location.protocol string +* **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
Loads the config file. - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - Notification when loading is complete -- **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - Notification when loading is complete +* **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Requests notification of a property value when it is loaded. - - _property:_ `string` - The desired property value - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Property value, when loaded + * *property:* `string` - The desired property value + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Property value, when loaded ## Details @@ -64,9 +64,9 @@ Example of the default settings file content: ``` Note that the settings in the example above are the default ones supplied with the server. -You can override the values in your custom `app.config.json` file if necessary. +You can override the values in your custom `app.config.json` file if necessary. -Below is a simple example of using the [`AppConfigService`](../../core/services/app-config.service.md) in practice. +Below is a simple example of using the [`AppConfigService`](../../core/services/app-config.service.md) in practice. **app.component.ts** diff --git a/docs/core/services/apps-process.service.md b/docs/core/services/apps-process.service.md index 4575df2b26..b25919a2c9 100644 --- a/docs/core/services/apps-process.service.md +++ b/docs/core/services/apps-process.service.md @@ -13,17 +13,17 @@ Gets details of the Process Services apps that are deployed for the user. ### Methods -- **getApplicationDetailsById**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`
+* **getApplicationDetailsById**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`
Gets the details for a specific app ID number. - - _appId:_ `number` - ID of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>` - Details of the app -- **getDeployedApplications**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`[]>`
+ * *appId:* `number` - ID of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>` - Details of the app +* **getDeployedApplications**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`[]>`
Gets a list of deployed apps for this user. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`[]>` - The list of deployed apps -- **getDeployedApplicationsByName**(name: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`[]>` - The list of deployed apps +* **getDeployedApplicationsByName**(name: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`
Gets a list of deployed apps for this user, where the app name is `name`. - - _name:_ `string` - Name of the app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>` - The list of deployed apps + * *name:* `string` - Name of the app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>` - The list of deployed apps ## Details diff --git a/docs/core/services/authentication.service.md b/docs/core/services/authentication.service.md index 5cd285868f..f0f488a450 100644 --- a/docs/core/services/authentication.service.md +++ b/docs/core/services/authentication.service.md @@ -13,85 +13,85 @@ Provides authentication to ACS and APS. ### Methods -- **addTokenToHeader**(headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **addTokenToHeader**(headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Adds the auth token to an HTTP header using the 'bearer' scheme. - - _headersArg:_ `HttpHeaders` - (Optional) Header that will receive the token - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - The new header with the token added -- **getBearerExcludedUrls**(): `string[]`
+ * *headersArg:* `HttpHeaders` - (Optional) Header that will receive the token + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - The new header with the token added +* **getBearerExcludedUrls**(): `string[]`
Gets the set of URLs that the token bearer is excluded from. - - **Returns** `string[]` - Array of URL strings -- **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>`
+ * **Returns** `string[]` - Array of URL strings +* **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>`
Gets information about the user currently logged into APS. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>` - User information -- **getBpmUsername**(): `string`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>` - User information +* **getBpmUsername**(): `string`
Gets the BPM username - - **Returns** `string` - The BPM username -- **getEcmUsername**(): `string`
+ * **Returns** `string` - The BPM username +* **getEcmUsername**(): `string`
Gets the ECM username. - - **Returns** `string` - The ECM username -- **getRedirect**(): `string`
+ * **Returns** `string` - The ECM username +* **getRedirect**(): `string`
Gets the URL to redirect to after login. - - **Returns** `string` - The redirect URL -- **getTicketBpm**(): `string|null`
+ * **Returns** `string` - The redirect URL +* **getTicketBpm**(): `string|null`
Gets the BPM ticket stored in the Storage. - - **Returns** `string|null` - The ticket or `null` if none was found -- **getTicketEcm**(): `string|null`
+ * **Returns** `string|null` - The ticket or `null` if none was found +* **getTicketEcm**(): `string|null`
Gets the ECM ticket stored in the Storage. - - **Returns** `string|null` - The ticket or `null` if none was found -- **getTicketEcmBase64**(): `string|null`
+ * **Returns** `string|null` - The ticket or `null` if none was found +* **getTicketEcmBase64**(): `string|null`
Gets the BPM ticket from the Storage in Base 64 format. - - **Returns** `string|null` - The ticket or `null` if none was found -- **getToken**(): `string`
+ * **Returns** `string|null` - The ticket or `null` if none was found +* **getToken**(): `string`
Gets the auth token. - - **Returns** `string` - Auth token string -- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * **Returns** `string` - Auth token string +* **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Prints an error message in the console browser - - _error:_ `any` - Error message - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object representing the error message -- **isALLProvider**(): `boolean`
+ * *error:* `any` - Error message + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object representing the error message +* **isALLProvider**(): `boolean`
Does the provider support both ECM and BPM? - - **Returns** `boolean` - True if both are supported, false otherwise -- **isBPMProvider**(): `boolean`
+ * **Returns** `boolean` - True if both are supported, false otherwise +* **isBPMProvider**(): `boolean`
Does the provider support BPM? - - **Returns** `boolean` - True if supported, false otherwise -- **isBpmLoggedIn**(): `boolean`
+ * **Returns** `boolean` - True if supported, false otherwise +* **isBpmLoggedIn**(): `boolean`
Checks if the user is logged in on a BPM provider. - - **Returns** `boolean` - True if logged in, false otherwise -- **isECMProvider**(): `boolean`
+ * **Returns** `boolean` - True if logged in, false otherwise +* **isECMProvider**(): `boolean`
Does the provider support ECM? - - **Returns** `boolean` - True if supported, false otherwise -- **isEcmLoggedIn**(): `boolean`
+ * **Returns** `boolean` - True if supported, false otherwise +* **isEcmLoggedIn**(): `boolean`
Checks if the user is logged in on an ECM provider. - - **Returns** `boolean` - True if logged in, false otherwise -- **isLoggedIn**(): `boolean`
+ * **Returns** `boolean` - True if logged in, false otherwise +* **isLoggedIn**(): `boolean`
Checks if the user logged in. - - **Returns** `boolean` - True if logged in, false otherwise -- **isLoggedInWith**(provider: `string`): `boolean`
+ * **Returns** `boolean` - True if logged in, false otherwise +* **isLoggedInWith**(provider: `string`): `boolean`
- - _provider:_ `string` - - - **Returns** `boolean` - -- **isOauth**(): `boolean`
+ * *provider:* `string` - + * **Returns** `boolean` - +* **isOauth**(): `boolean`
Does the provider support OAuth? - - **Returns** `boolean` - True if supported, false otherwise -- **isPublicUrl**(): `boolean`
+ * **Returns** `boolean` - True if supported, false otherwise +* **isPublicUrl**(): `boolean`
- - **Returns** `boolean` - -- **isRememberMeSet**(): `boolean`
+ * **Returns** `boolean` - +* **isRememberMeSet**(): `boolean`
Checks whether the "remember me" cookie was set or not. - - **Returns** `boolean` - True if set, false otherwise -- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * **Returns** `boolean` - True if set, false otherwise +* **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Logs the user in. - - _username:_ `string` - Username for the login - - _password:_ `string` - Password for the login - - _rememberMe:_ `boolean` - Stores the user's login details if true - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket -- **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *username:* `string` - Username for the login + * *password:* `string` - Password for the login + * *rememberMe:* `boolean` - Stores the user's login details if true + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket +* **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Logs the user out. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Response event called when logout is complete -- **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Response event called when logout is complete +* **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))
Sets the URL to redirect to after login. - - _url:_ [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to -- **ssoImplicitLogin**()
+ * *url:* [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to +* **ssoImplicitLogin**()
Logs the user in with SSO ## Details @@ -118,4 +118,4 @@ export class AppComponent { ## See also -- [Login component](../components/login.component.md) +* [Login component](../components/login.component.md) diff --git a/docs/core/services/bpm-user.service.md b/docs/core/services/bpm-user.service.md index 3c622dc385..ee821ba2ed 100644 --- a/docs/core/services/bpm-user.service.md +++ b/docs/core/services/bpm-user.service.md @@ -13,12 +13,12 @@ Gets information about the current Process Services user. ### Methods -- **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>`
+* **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>`
Gets information about the current user. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>` - User information object -- **getCurrentUserProfileImage**(): `string`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>` - User information object +* **getCurrentUserProfileImage**(): `string`
Gets the current user's profile image as a URL. - - **Returns** `string` - URL string + * **Returns** `string` - URL string ## Details @@ -33,5 +33,5 @@ methods in the Alfresco JS API for more information about the REST calls used by ## See also -- [Ecm user service](../services/ecm-user.service.md) -- [Bpm user model](../models/bpm-user.model.md) +* [Ecm user service](../services/ecm-user.service.md) +* [Bpm user model](../models/bpm-user.model.md) diff --git a/docs/core/services/card-item-types.service.md b/docs/core/services/card-item-types.service.md index e33efad583..1048848aa1 100644 --- a/docs/core/services/card-item-types.service.md +++ b/docs/core/services/card-item-types.service.md @@ -13,25 +13,25 @@ Maps type names to field component types for the [Card View component](../compon ### Methods -- **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
+* **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - - _type:_ `string` - The type whose resolver you want - - _defaultValue:_ `Type` - Default type returned for types that are not yet mapped - - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function -- **register**(components: `Function`, override: `boolean` = `false`)
+ * *type:* `string` - The type whose resolver you want + * *defaultValue:* `Type` - Default type returned for types that are not yet mapped + * **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function +* **register**(components: `Function`, override: `boolean` = `false`)
Register multiple components - - _components:_ `Function` - - - _override:_ `boolean` - -- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
+ * *components:* `Function` - + * *override:* `boolean` - +* **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
Finds the component type that is needed to render a form field. - - _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render - - _defaultValue:_ `Type` - Default type returned for field types that are not yet mapped. - - **Returns** `Type` - Component type -- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
+ * *model:* [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render + * *defaultValue:* `Type` - Default type returned for field types that are not yet mapped. + * **Returns** `Type` - Component type +* **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - - _type:_ `string` - The type whose resolver you want to set - - _resolver:_ [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function - - _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true + * *type:* `string` - The type whose resolver you want to set + * *resolver:* [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function + * *override:* `boolean` - The new resolver will only replace an existing one if this parameter is true ## Details @@ -75,5 +75,5 @@ export class SomeParentComponent { ## See also -- [Card View component](../components/card-view.component.md) -- [Card View Item interface](../interfaces/card-view-item.interface.md) +* [Card View component](../components/card-view.component.md) +* [Card View Item interface](../interfaces/card-view-item.interface.md) diff --git a/docs/core/services/clipboard.service.md b/docs/core/services/clipboard.service.md index cdea589991..0228655c00 100644 --- a/docs/core/services/clipboard.service.md +++ b/docs/core/services/clipboard.service.md @@ -13,18 +13,18 @@ Copies text to the clipboard. ### Methods -- **copyContentToClipboard**(content: `string`, message: `string`)
+* **copyContentToClipboard**(content: `string`, message: `string`)
Copies a text string to the clipboard. - - _content:_ `string` - Text to copy - - _message:_ `string` - Snackbar message to alert when copying happens -- **copyToClipboard**(target: [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement), message?: `string`)
+ * *content:* `string` - Text to copy + * *message:* `string` - Snackbar message to alert when copying happens +* **copyToClipboard**(target: [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement), message?: `string`)
Copies text from an HTML element to the clipboard. - - _target:_ [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) - HTML element to be copied - - _message:_ `string` - (Optional) Snackbar message to alert when copying happens -- **isTargetValid**(target: [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement)): `boolean`
+ * *target:* [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) - HTML element to be copied + * *message:* `string` - (Optional) Snackbar message to alert when copying happens +* **isTargetValid**(target: [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement)): `boolean`
Checks if the target element can have its text copied. - - _target:_ [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) - Target HTML element - - **Returns** `boolean` - True if the text can be copied, false otherwise + * *target:* [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) - Target HTML element + * **Returns** `boolean` - True if the text can be copied, false otherwise ## Details @@ -35,4 +35,4 @@ copying operation takes place. ## See also -- [Clipboard directive](../../core/directives/clipboard.directive.md) +* [Clipboard directive](../../core/directives/clipboard.directive.md) diff --git a/docs/core/services/comment-content.service.md b/docs/core/services/comment-content.service.md index c061aef5dc..e72246c398 100644 --- a/docs/core/services/comment-content.service.md +++ b/docs/core/services/comment-content.service.md @@ -13,15 +13,15 @@ Adds and retrieves comments for nodes in Content Services. ### Methods -- **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
+* **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
Adds a comment to a node. - - _nodeId:_ `string` - ID of the target node - - _message:_ `string` - Text for the comment - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added -- **getNodeComments**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
+ * *nodeId:* `string` - ID of the target node + * *message:* `string` - Text for the comment + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added +* **getNodeComments**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
Gets all comments that have been added to a node. - - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment + * *nodeId:* `string` - ID of the target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment ## Details @@ -31,4 +31,4 @@ for more information about the underlying REST API. ## See also -- [Comment process service](comment-process.service.md) +* [Comment process service](comment-process.service.md) diff --git a/docs/core/services/comment-process.service.md b/docs/core/services/comment-process.service.md index 87bccb60fc..07c4d5ed2b 100644 --- a/docs/core/services/comment-process.service.md +++ b/docs/core/services/comment-process.service.md @@ -13,24 +13,24 @@ Adds and retrieves comments for task and process instances in Process Services. ### Methods -- **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
+* **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
Adds a comment to a process instance. - - _processInstanceId:_ `string` - ID of the target process instance - - _message:_ `string` - Text for the comment - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added -- **addTaskComment**(taskId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
+ * *processInstanceId:* `string` - ID of the target process instance + * *message:* `string` - Text for the comment + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added +* **addTaskComment**(taskId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
Adds a comment to a task. - - _taskId:_ `string` - ID of the target task - - _message:_ `string` - Text for the comment - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details about the comment -- **getProcessInstanceComments**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
+ * *taskId:* `string` - ID of the target task + * *message:* `string` - Text for the comment + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details about the comment +* **getProcessInstanceComments**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
Gets all comments that have been added to a process instance. - - _processInstanceId:_ `string` - ID of the target process instance - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment -- **getTaskComments**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
+ * *processInstanceId:* `string` - ID of the target process instance + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment +* **getTaskComments**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
Gets all comments that have been added to a task. - - _taskId:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment + * *taskId:* `string` - ID of the target task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment ## Details diff --git a/docs/core/services/content.service.md b/docs/core/services/content.service.md index 5f09d52b64..c06b6ecc93 100644 --- a/docs/core/services/content.service.md +++ b/docs/core/services/content.service.md @@ -13,53 +13,53 @@ Accesses app-generated data objects via URLs and file downloads. ### Methods -- **createTrustedUrl**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)): `string`
+* **createTrustedUrl**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)): `string`
Creates a trusted object URL from the [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob). WARNING: calling this method with untrusted user data exposes your application to XSS security risks! - - _blob:_ [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) - Data to wrap into object URL - - **Returns** `string` - URL string -- **downloadBlob**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob), fileName: `string`)
- (**Deprecated:** in 3.2.0, use [DownloadService](../../../lib/core/services/download.service.ts) instead. Invokes content download for a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) with a file name.) - - _blob:_ [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) - Content to download. - - _fileName:_ `string` - Name of the resulting file. -- **downloadData**(data: `any`, fileName: `string`)
- (**Deprecated:** in 3.2.0, use [DownloadService](../../../lib/core/services/download.service.ts) instead. Invokes content download for a data array with a file name.) - - _data:_ `any` - Data to download. - - _fileName:_ `string` - Name of the resulting file. -- **downloadJSON**(json: `any`, fileName: `string`)
- (**Deprecated:** in 3.2.0, use [DownloadService](../../../lib/core/services/download.service.ts) instead. Invokes content download for a JSON object with a file name.) - - _json:_ `any` - JSON object to download. - - _fileName:_ `string` - Name of the resulting file. -- **getContentUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string`, attachment?: `boolean`, ticket?: `string`): `string`
+ * *blob:* [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) - Data to wrap into object URL + * **Returns** `string` - URL string +* **downloadBlob**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob), fileName: `string`)
+ (**Deprecated:** in 3.2.0, use [DownloadService](../../../lib/core/services/download.service.ts) instead. Invokes content download for a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) with a file name.) + * *blob:* [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) - Content to download. + * *fileName:* `string` - Name of the resulting file. +* **downloadData**(data: `any`, fileName: `string`)
+ (**Deprecated:** in 3.2.0, use [DownloadService](../../../lib/core/services/download.service.ts) instead. Invokes content download for a data array with a file name.) + * *data:* `any` - Data to download. + * *fileName:* `string` - Name of the resulting file. +* **downloadJSON**(json: `any`, fileName: `string`)
+ (**Deprecated:** in 3.2.0, use [DownloadService](../../../lib/core/services/download.service.ts) instead. Invokes content download for a JSON object with a file name.) + * *json:* `any` - JSON object to download. + * *fileName:* `string` - Name of the resulting file. +* **getContentUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string`, attachment?: `boolean`, ticket?: `string`): `string`
Gets a content URL for the given node. - - _node:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string` - Node or Node ID to get URL for. - - _attachment:_ `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download - - _ticket:_ `string` - (Optional) Custom ticket to use for authentication - - **Returns** `string` - URL string or `null` -- **getDocumentThumbnailUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string`, attachment?: `boolean`, ticket?: `string`): `string`
- (**Deprecated:** in 3.2.0, use ThumbnailService instead. Gets a thumbnail URL for the given document node.) - - _node:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string` - Node or Node ID to get URL for. - - _attachment:_ `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download - - _ticket:_ `string` - (Optional) Custom ticket to use for authentication - - **Returns** `string` - URL string -- **getNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+ * *node:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string` - Node or Node ID to get URL for. + * *attachment:* `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download + * *ticket:* `string` - (Optional) Custom ticket to use for authentication + * **Returns** `string` - URL string or `null` +* **getDocumentThumbnailUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string`, attachment?: `boolean`, ticket?: `string`): `string`
+ (**Deprecated:** in 3.2.0, use ThumbnailService instead. Gets a thumbnail URL for the given document node.) + * *node:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string` - Node or Node ID to get URL for. + * *attachment:* `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download + * *ticket:* `string` - (Optional) Custom ticket to use for authentication + * **Returns** `string` - URL string +* **getNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Gets a Node via its node ID. - - _nodeId:_ `string` - ID of the target node - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder -- **getNodeContent**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *nodeId:* `string` - ID of the target node + * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder +* **getNodeContent**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets content for the given node. - - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Content data -- **hasAllowableOperations**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), allowableOperation: [`AllowableOperationsEnum`](../../../lib/core/models/allowable-operations.enum.ts)`|string`): `boolean`
+ * *nodeId:* `string` - ID of the target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Content data +* **hasAllowableOperations**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), allowableOperation: [`AllowableOperationsEnum`](../../../lib/core/models/allowable-operations.enum.ts)`|string`): `boolean`
Checks if the user has permissions on that node - - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check allowableOperations - - _allowableOperation:_ [`AllowableOperationsEnum`](../../../lib/core/models/allowable-operations.enum.ts)`|string` - Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions - - **Returns** `boolean` - True if the user has the required permissions, false otherwise -- **hasPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permission: [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string`): `boolean`
+ * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check allowableOperations + * *allowableOperation:* [`AllowableOperationsEnum`](../../../lib/core/models/allowable-operations.enum.ts)`|string` - Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions + * **Returns** `boolean` - True if the user has the required permissions, false otherwise +* **hasPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permission: [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string`): `boolean`
Checks if the user has permission on that node - - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check permissions - - _permission:_ [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string` - Required permission type - - **Returns** `boolean` - True if the user has the required permissions, false otherwise + * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check permissions + * *permission:* [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string` - Required permission type + * **Returns** `boolean` - True if the user has the required permissions, false otherwise ## Details @@ -73,7 +73,7 @@ some cases by viewing it directly in the browser via a special URL that referenc the [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob). For example, you could use the [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) interface to construct an image in the [PNG format](https://en.wikipedia.org/wiki/Portable_Network_Graphics). Since PNG is a format the browser can display, you could use the [Blob's](https://developer.mozilla.org/en-US/docs/Web/API/Blob) URL in an -<img> element to view the image within the page. Alternatively, you could let +\ element to view the image within the page. Alternatively, you could let the user download it as a PNG file. The `downloadBlob` method starts a download of the [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) data to the `filename` @@ -85,7 +85,7 @@ for details of how a [Blob's](https://developer.mozilla.org/en-US/docs/Web/API/B Use `createdTrustedUrl` to generate a URL string for a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob). The URL refers to the [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) as though it were a file but it is actually an object stored in memory, so it does not persist across browser sessions. This URL can be used much like any -other, so you could use it for the `src` attribute of an <img> element or the +other, so you could use it for the `src` attribute of an \ element or the `href` of a download link. Note that while the URL is 'trusted', the data it contains is not necessarily trustworthy unless you can vouch for it yourself; be careful that the data doesn't expose your app to @@ -94,5 +94,5 @@ attacks. ## See also -- [Cookie service](cookie.service.md) -- [Storage service](storage.service.md) +* [Cookie service](cookie.service.md) +* [Storage service](storage.service.md) diff --git a/docs/core/services/cookie.service.md b/docs/core/services/cookie.service.md index 44f09e9ca9..514f40e384 100644 --- a/docs/core/services/cookie.service.md +++ b/docs/core/services/cookie.service.md @@ -13,24 +13,25 @@ Stores key-value data items as browser cookies. ### Methods -- **clear**()
+* **clear**()
Placeholder for testing purposes - do not use. -- **deleteCookie**(key: `string`)
+* **deleteCookie**(key: `string`, path: `string|null` = `null`)
Delete a cookie Key. - - _key:_ `string` - Key to identify the cookie -- **getItem**(key: `string`): `string|null`
+ * *key:* `string` - Key to identify the cookie + * *path:* `string|null` - "Pathname" to store the cookie +* **getItem**(key: `string`): `string|null`
Retrieves a cookie by its key. - - _key:_ `string` - Key to identify the cookie - - **Returns** `string|null` - The cookie data or null if it is not found -- **isEnabled**(): `boolean`
+ * *key:* `string` - Key to identify the cookie + * **Returns** `string|null` - The cookie data or null if it is not found +* **isEnabled**(): `boolean`
Checks if cookies are enabled. - - **Returns** `boolean` - True if enabled, false otherwise -- **setItem**(key: `string`, data: `string`, expiration: `Date|null` = `null`, path: `string|null` = `null`)
+ * **Returns** `boolean` - True if enabled, false otherwise +* **setItem**(key: `string`, data: `string`, expiration: `Date|null` = `null`, path: `string|null` = `null`)
Sets a cookie. - - _key:_ `string` - Key to identify the cookie - - _data:_ `string` - Data value to set for the cookie - - _expiration:_ `Date|null` - Expiration date of the data - - _path:_ `string|null` - "Pathname" to store the cookie + * *key:* `string` - Key to identify the cookie + * *data:* `string` - Data value to set for the cookie + * *expiration:* `Date|null` - Expiration date of the data + * *path:* `string|null` - "Pathname" to store the cookie ## Details @@ -45,5 +46,5 @@ beyond this size. ## See also -- [Content service](content.service.md) -- [Storage service](storage.service.md) +* [Content service](content.service.md) +* [Storage service](storage.service.md) diff --git a/docs/core/services/deleted-nodes-api.service.md b/docs/core/services/deleted-nodes-api.service.md index cb40491ae6..1984d983fc 100644 --- a/docs/core/services/deleted-nodes-api.service.md +++ b/docs/core/services/deleted-nodes-api.service.md @@ -13,10 +13,10 @@ Gets a list of Content Services nodes currently in the trash. ### Methods -- **getDeletedNodes**(options?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+* **getDeletedNodes**(options?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets a list of nodes in the trash. - - _options:_ `Object` - (Optional) Options for JS-API call - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes in the trash + * *options:* `Object` - (Optional) Options for JS-API call + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes in the trash ## Details @@ -27,5 +27,5 @@ page of the Alfresco JS API docs. ## See also -- [Nodes api service](nodes-api.service.md) -- [Node service](node.service.md) +* [Nodes api service](nodes-api.service.md) +* [Node service](node.service.md) diff --git a/docs/core/services/discovery-api.service.md b/docs/core/services/discovery-api.service.md index c032ac6443..95b8122b48 100644 --- a/docs/core/services/discovery-api.service.md +++ b/docs/core/services/discovery-api.service.md @@ -13,15 +13,15 @@ Gets version and license information for Process Services and Content Services. ### Methods -- **getBPMSystemProperties**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SystemPropertiesRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/SystemPropertiesRepresentation.md)`>`
+* **getBPMSystemProperties**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SystemPropertiesRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/SystemPropertiesRepresentation.md)`>`
- - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SystemPropertiesRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/SystemPropertiesRepresentation.md)`>` - -- **getBpmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SystemPropertiesRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/SystemPropertiesRepresentation.md)`>` - +* **getBpmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>`
Gets product information for Process Services. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details -- **getEcmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details +* **getEcmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>`
Gets product information for Content Services. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details ## Details @@ -33,4 +33,4 @@ to learn more about the REST API used by this service. ## See also -- [Product version model](../models/product-version.model.md) +* [Product version model](../models/product-version.model.md) diff --git a/docs/core/services/download-zip.service.md b/docs/core/services/download-zip.service.md index f0fc311621..1609a7c32a 100644 --- a/docs/core/services/download-zip.service.md +++ b/docs/core/services/download-zip.service.md @@ -13,26 +13,26 @@ Creates and manages downloads. ### Methods -- **cancelDownload**(downloadId: `string`)
+* **cancelDownload**(downloadId: `string`)
Cancels a download. - - _downloadId:_ `string` - ID of the target download node -- **createDownload**(payload: [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadBodyCreate.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadEntry.md)`>`
+ * *downloadId:* `string` - ID of the target download node +* **createDownload**(payload: [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadBodyCreate.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadEntry.md)`>`
Creates a new download. - - _payload:_ [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadBodyCreate.md) - Object containing the node IDs of the items to add to the ZIP file - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadEntry.md)`>` - Status object for the download -- **getContentUrl**(nodeId: `string`, attachment?: `boolean`): `string`
+ * *payload:* [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadBodyCreate.md) - Object containing the node IDs of the items to add to the ZIP file + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadEntry.md)`>` - Status object for the download +* **getContentUrl**(nodeId: `string`, attachment?: `boolean`): `string`
Gets a content URL for the given node. - - _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to get URL for. - - _attachment:_ `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download - - **Returns** `string` - URL string -- **getDownload**(downloadId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadEntry.md)`>`
+ * *nodeId:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to get URL for. + * *attachment:* `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download + * **Returns** `string` - URL string +* **getDownload**(downloadId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadEntry.md)`>`
Gets status information for a download node. - - _downloadId:_ `string` - ID of the download node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadEntry.md)`>` - Status object for the download -- **getNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+ * *downloadId:* `string` - ID of the download node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DownloadEntry.md)`>` - Status object for the download +* **getNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Gets a Node via its node ID. - - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the node + * *nodeId:* `string` - ID of the target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the node ## Details diff --git a/docs/core/services/ecm-user.service.md b/docs/core/services/ecm-user.service.md index d579ab010d..36192ee988 100644 --- a/docs/core/services/ecm-user.service.md +++ b/docs/core/services/ecm-user.service.md @@ -13,17 +13,17 @@ Gets information about a Content Services user. ### Methods -- **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
+* **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
Gets information about the user who is currently logged-in. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - User information as for getUserInfo -- **getUserInfo**(userName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - User information as for getUserInfo +* **getUserInfo**(userName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
Gets information about a user identified by their username. - - _userName:_ `string` - Target username - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - User information -- **getUserProfileImage**(avatarId: `string`): `string`
+ * *userName:* `string` - Target username + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - User information +* **getUserProfileImage**(avatarId: `string`): `string`
Returns a profile image as a URL. - - _avatarId:_ `string` - Target avatar - - **Returns** `string` - Image URL + * *avatarId:* `string` - Target avatar + * **Returns** `string` - Image URL ## Details @@ -38,5 +38,5 @@ method in the Alfresco JS API for more information about the REST calls used by ## See also -- [Bpm user service](../services/bpm-user.service.md) -- [Ecm user model](../models/ecm-user.model.md) +* [Bpm user service](../services/bpm-user.service.md) +* [Ecm user model](../models/ecm-user.model.md) diff --git a/docs/core/services/favorites-api.service.md b/docs/core/services/favorites-api.service.md index 8209cda25b..7679f66c89 100644 --- a/docs/core/services/favorites-api.service.md +++ b/docs/core/services/favorites-api.service.md @@ -13,23 +13,23 @@ Gets a list of items a user has marked as their favorites. ### Methods -- **getFavorites**(personId: `string`, options?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+* **getFavorites**(personId: `string`, options?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets the favorites for a user. - - _personId:_ `string` - ID of the user - - _options:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorites -- **remapFavoriteEntries**(entries: `any[]`): `any[]`
+ * *personId:* `string` - ID of the user + * *options:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorites +* **remapFavoriteEntries**(entries: `any[]`): `any[]`
- - _entries:_ `any[]` - - - **Returns** `any[]` - -- **remapFavoritesData**(data: `any` = `{}`): [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)
+ * *entries:* `any[]` - + * **Returns** `any[]` - +* **remapFavoritesData**(data: `any` = `{}`): [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)
- - _data:_ `any` - - - **Returns** [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) - -- **remapEntry**(\_\_namedParameters: `Function`): `any`
+ * *data:* `any` - + * **Returns** [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) - +* **remapEntry**(\__namedParameters: `Function`): `any`
- - _\_\_namedParameters:_ `Function` - - - **Returns** `any` - + * *\__namedParameters:* `Function` - + * **Returns** `any` - ## Details @@ -38,7 +38,7 @@ items that are important or frequently used. Use `getFavorites` to find a user's favorite items. You could use this, for example, to create a menu for the user to access their favorites quickly rather than by -navigating or searching. Using "-me-" for the `personId` indicates that the target +navigating or searching. Using "-me-" for the `personId` indicates that the target person is the currently logged-in user. You can specify a number of `options` to modify the search further. See the diff --git a/docs/core/services/form-rendering.service.md b/docs/core/services/form-rendering.service.md index 88b29fdcc5..56a582f3e1 100644 --- a/docs/core/services/form-rendering.service.md +++ b/docs/core/services/form-rendering.service.md @@ -13,25 +13,25 @@ Maps a form field type string onto the corresponding form [widget component](../ ### Methods -- **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
+* **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - - _type:_ `string` - The type whose resolver you want - - _defaultValue:_ `Type` - Default type returned for types that are not yet mapped - - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function -- **register**(components: `Function`, override: `boolean` = `false`)
+ * *type:* `string` - The type whose resolver you want + * *defaultValue:* `Type` - Default type returned for types that are not yet mapped + * **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function +* **register**(components: `Function`, override: `boolean` = `false`)
Register multiple components - - _components:_ `Function` - - - _override:_ `boolean` - -- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
+ * *components:* `Function` - + * *override:* `boolean` - +* **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
Finds the component type that is needed to render a form field. - - _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render - - _defaultValue:_ `Type` - Default type returned for field types that are not yet mapped. - - **Returns** `Type` - Component type -- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
+ * *model:* [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render + * *defaultValue:* `Type` - Default type returned for field types that are not yet mapped. + * **Returns** `Type` - Component type +* **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. - - _type:_ `string` - The type whose resolver you want to set - - _resolver:_ [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function - - _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true + * *type:* `string` - The type whose resolver you want to set + * *resolver:* [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function + * *override:* `boolean` - The new resolver will only replace an existing one if this parameter is true ## Details @@ -106,6 +106,6 @@ of this technique. ## See also -- [Extensibility](../../user-guide/extensibility.md) -- [Form field model](../models/form-field.model.md) -- [Form component](../components/form.component.md) +* [Extensibility](../../user-guide/extensibility.md) +* [Form field model](../models/form-field.model.md) +* [Form component](../components/form.component.md) diff --git a/docs/core/services/highlight-transform.service.md b/docs/core/services/highlight-transform.service.md index b1b79b85db..78b93f0cb0 100644 --- a/docs/core/services/highlight-transform.service.md +++ b/docs/core/services/highlight-transform.service.md @@ -13,12 +13,12 @@ Adds HTML to a string to highlight chosen sections. ### Methods -- **highlight**(text: `string`, search: `string`, wrapperClass: `string` = `"adf-highlight"`): [`HighlightTransformResult`](../../../lib/core/services/highlight-transform.service.ts)
+* **highlight**(text: `string`, search: `string`, wrapperClass: `string` = `"adf-highlight"`): [`HighlightTransformResult`](../../../lib/core/services/highlight-transform.service.ts)
Searches for `search` string(s) within `text` and highlights all occurrences. - - _text:_ `string` - Text to search within - - _search:_ `string` - Text pattern to search for - - _wrapperClass:_ `string` - CSS class used to provide highlighting style - - **Returns** [`HighlightTransformResult`](../../../lib/core/services/highlight-transform.service.ts) - New text along with boolean value to indicate whether anything was highlighted + * *text:* `string` - Text to search within + * *search:* `string` - Text pattern to search for + * *wrapperClass:* `string` - CSS class used to provide highlighting style + * **Returns** [`HighlightTransformResult`](../../../lib/core/services/highlight-transform.service.ts) - New text along with boolean value to indicate whether anything was highlighted ## Details @@ -26,10 +26,10 @@ A typical use case for this service is to display the results from a search engi An excerpt of a retrieved document can be shown with the matching search terms highlighted to indicate where they were found. -The service works by adding HTML <span> elements around all sections of text +The service works by adding HTML \ elements around all sections of text that match the `search` string. You can specify multiple search strings at once by separating them with spaces, so passing "Apple Banana Cherry" in `search` will -highlight any of those words individually. The <span> element includes a +highlight any of those words individually. The \ element includes a `class` attribute which defaults to "highlight" but you can pass any class name you like using the `wrapperClass` parameter. @@ -48,5 +48,5 @@ took place) and true otherwise. ## See also -- [Text highlight pipe](../pipes/text-highlight.pipe.md) -- [Highlight directive](../directives/highlight.directive.md) +* [Text highlight pipe](../pipes/text-highlight.pipe.md) +* [Highlight directive](../directives/highlight.directive.md) diff --git a/docs/core/services/identity-group.service.md b/docs/core/services/identity-group.service.md index 0dd020bd92..2be631bdb8 100644 --- a/docs/core/services/identity-group.service.md +++ b/docs/core/services/identity-group.service.md @@ -13,85 +13,85 @@ Performs CRUD operations on identity groups. ### Methods -- **assignRoles**(groupId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **assignRoles**(groupId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Assigns roles to the group - - _groupId:_ `string` - The ID of the group - - _roles:_ [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - Array of roles to assign - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - -- **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupId:* `string` - The ID of the group + * *roles:* [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - Array of roles to assign + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - +* **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Check if a group has any of the client app roles in the supplied list. - - _groupId:_ `string` - Id of the target group - - _clientId:_ `string` - Id of the client - - _roleNames:_ `string[]` - Array of role names to check - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise -- **checkGroupHasClientApp**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupId:* `string` - Id of the target group + * *clientId:* `string` - Id of the client + * *roleNames:* `string[]` - Array of role names to check + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise +* **checkGroupHasClientApp**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Checks if a group has a client app. - - _groupId:_ `string` - Id of the target group - - _clientId:_ `string` - Id of the client - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has the client app, false otherwise -- **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupId:* `string` - Id of the target group + * *clientId:* `string` - Id of the client + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has the client app, false otherwise +* **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Check that a group has one or more roles from the supplied list. - - _groupId:_ `string` - Id of the target group - - _roleNames:_ `string[]` - Array of role names - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise -- **createGroup**(newGroup: [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupId:* `string` - Id of the target group + * *roleNames:* `string[]` - Array of role names + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise +* **createGroup**(newGroup: [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Creates new group. - - _newGroup:_ [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts) - Object of containing the new group details. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group created. -- **deleteGroup**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *newGroup:* [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts) - Object of containing the new group details. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group created. +* **deleteGroup**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes Group. - - _groupId:_ `string` - Id of the group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group deleted. -- **findGroupsByName**(searchParams: [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`
+ * *groupId:* `string` - Id of the group. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group deleted. +* **findGroupsByName**(searchParams: [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`
Finds groups filtered by name. - - _searchParams:_ [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts) - Object containing the name filter string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - List of group information -- **getAssignedRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ * *searchParams:* [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts) - Object containing the name filter string + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - List of group information +* **getAssignedRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets assigned roles - - _groupId:_ `string` - Id of the group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles -- **getAvailableRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ * *groupId:* `string` - Id of the group. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles +* **getAvailableRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets available roles - - _groupId:_ `string` - Id of the group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles information objects -- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupId:* `string` - Id of the group. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles information objects +* **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the client Id using the app name. - - _applicationName:_ `string` - Name of the app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - client Id string -- **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ * *applicationName:* `string` - Name of the app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - client Id string +* **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets client roles. - - _groupId:_ `string` - Id of the target group - - _clientId:_ `string` - Id of the client - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - List of roles -- **getEffectiveRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ * *groupId:* `string` - Id of the target group + * *clientId:* `string` - Id of the client + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - List of roles +* **getEffectiveRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Get effective roles - - _groupId:_ `string` - Id of the group - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of effective roles -- **getGroupRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ * *groupId:* `string` - Id of the group + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of effective roles +* **getGroupRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets details for a specified group. - - _groupId:_ `string` - Id of the target group - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Group details -- **getGroups**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`
+ * *groupId:* `string` - Id of the target group + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Group details +* **getGroups**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`
Gets all groups. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - Array of group information objects -- **getTotalGroupsCount**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupCountModel`](../../../lib/core/models/identity-group.model.ts)`>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - Array of group information objects +* **getTotalGroupsCount**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupCountModel`](../../../lib/core/models/identity-group.model.ts)`>`
Gets groups total count. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupCountModel`](../../../lib/core/models/identity-group.model.ts)`>` - Number of groups count. -- **queryGroups**(requestQuery: [`IdentityGroupQueryCloudRequestModel`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupQueryResponse`](../../../lib/core/models/identity-group.model.ts)`>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupCountModel`](../../../lib/core/models/identity-group.model.ts)`>` - Number of groups count. +* **queryGroups**(requestQuery: [`IdentityGroupQueryCloudRequestModel`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupQueryResponse`](../../../lib/core/models/identity-group.model.ts)`>`
Queries groups. - - _requestQuery:_ [`IdentityGroupQueryCloudRequestModel`](../../../lib/core/models/identity-group.model.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupQueryResponse`](../../../lib/core/models/identity-group.model.ts)`>` - Array of user information objects -- **removeRoles**(groupId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *requestQuery:* [`IdentityGroupQueryCloudRequestModel`](../../../lib/core/models/identity-group.model.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupQueryResponse`](../../../lib/core/models/identity-group.model.ts)`>` - Array of user information objects +* **removeRoles**(groupId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Removes roles from the group - - _groupId:_ `string` - The ID of the group - - _roles:_ [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - Array of roles to remove - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - -- **updateGroup**(groupId: `string`, updatedGroup: [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupId:* `string` - The ID of the group + * *roles:* [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - Array of roles to remove + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - +* **updateGroup**(groupId: `string`, updatedGroup: [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Updates group details. - - _groupId:_ `string` - Id of the targeted group. - - _updatedGroup:_ [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts) - Object of containing the group details - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group updated. + * *groupId:* `string` - Id of the targeted group. + * *updatedGroup:* [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts) - Object of containing the group details + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group updated. ## See also -- [Identity user service](../../core/userInfo/services/identity-user.service.md) +* [Identity user service](../../core/userInfo/services/identity-user.service.md) diff --git a/docs/core/services/identity-user.service.md b/docs/core/services/identity-user.service.md index 6b1a741df7..e8212cba57 100644 --- a/docs/core/services/identity-user.service.md +++ b/docs/core/services/identity-user.service.md @@ -13,137 +13,137 @@ Gets OAuth2 personal details and roles for users and performs CRUD operations on ### Methods -- **assignRoles**(userId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **assignRoles**(userId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Assigns roles to the user. - - _userId:_ `string` - Id of the user. - - _roles:_ [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - Array of roles. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the role assigned. -- **changePassword**(userId: `string`, newPassword: [`IdentityUserPasswordModel`](../../../lib/core/services/identity-user.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - Id of the user. + * *roles:* [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - Array of roles. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the role assigned. +* **changePassword**(userId: `string`, newPassword: [`IdentityUserPasswordModel`](../../../lib/core/services/identity-user.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Changes user password. - - _userId:_ `string` - Id of the user. - - _newPassword:_ [`IdentityUserPasswordModel`](../../../lib/core/services/identity-user.service.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the password changed. -- **checkUserHasAnyApplicationRole**(userId: `string`, applicationName: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - Id of the user. + * *newPassword:* [`IdentityUserPasswordModel`](../../../lib/core/services/identity-user.service.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the password changed. +* **checkUserHasAnyApplicationRole**(userId: `string`, applicationName: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Checks if a user has any application role. - - _userId:_ `string` - ID of the target user - - _applicationName:_ `string` - Name of the application - - _roleNames:_ `string[]` - List of role names to check for - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has one or more of the roles, false otherwise -- **checkUserHasAnyClientAppRole**(userId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - ID of the target user + * *applicationName:* `string` - Name of the application + * *roleNames:* `string[]` - List of role names to check for + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has one or more of the roles, false otherwise +* **checkUserHasAnyClientAppRole**(userId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Checks whether a user has any of the client app roles. - - _userId:_ `string` - ID of the target user - - _clientId:_ `string` - ID of the client app - - _roleNames:_ `string[]` - List of role names to check for - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has one or more of the roles, false otherwise -- **checkUserHasApplicationAccess**(userId: `string`, applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - ID of the target user + * *clientId:* `string` - ID of the client app + * *roleNames:* `string[]` - List of role names to check for + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has one or more of the roles, false otherwise +* **checkUserHasApplicationAccess**(userId: `string`, applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Checks if a user has access to an application. - - _userId:_ `string` - ID of the user - - _applicationName:_ `string` - Name of the application - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has access, false otherwise -- **checkUserHasClientApp**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - ID of the user + * *applicationName:* `string` - Name of the application + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has access, false otherwise +* **checkUserHasClientApp**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Checks whether user has access to a client app. - - _userId:_ `string` - ID of the target user - - _clientId:_ `string` - ID of the client app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has access, false otherwise -- **checkUserHasRole**(userId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - ID of the target user + * *clientId:* `string` - ID of the client app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has access, false otherwise +* **checkUserHasRole**(userId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Checks if a user has one of the roles from a list. - - _userId:_ `string` - ID of the target user - - _roleNames:_ `string[]` - Array of roles to check for - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has one of the roles, false otherwise -- **createUser**(newUser: [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - ID of the target user + * *roleNames:* `string[]` - Array of roles to check for + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has one of the roles, false otherwise +* **createUser**(newUser: [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Creates new user. - - _newUser:_ [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts) - Object containing the new user details. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user created. -- **deleteUser**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *newUser:* [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts) - Object containing the new user details. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user created. +* **deleteUser**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes User. - - _userId:_ `string` - Id of the user. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user deleted. -- **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
+ * *userId:* `string` - Id of the user. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user deleted. +* **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
Find users based on email input. - - _email:_ `string` - Search query string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users -- **findUserById**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *email:* `string` - Search query string + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users +* **findUserById**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Find users based on id input. - - _id:_ `string` - Search query string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - users object -- **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
+ * *id:* `string` - Search query string + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - users object +* **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
Find users based on username input. - - _username:_ `string` - Search query string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users -- **findUsersByName**(search: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
+ * *username:* `string` - Search query string + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users +* **findUsersByName**(search: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
Find users based on search input. - - _search:_ `string` - Search query string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users -- **getAssignedRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ * *search:* `string` - Search query string + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users +* **getAssignedRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets assigned roles. - - _userId:_ `string` - Id of the user. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of assigned roles information objects -- **getAvailableRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ * *userId:* `string` - Id of the user. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of assigned roles information objects +* **getAvailableRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets available roles - - _userId:_ `string` - Id of the user. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles information objects -- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - Id of the user. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles information objects +* **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the client ID for an application. - - _applicationName:_ `string` - Name of the application - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Client ID string -- **getClientRoles**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *applicationName:* `string` - Name of the application + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Client ID string +* **getClientRoles**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Get client roles of a user for a particular client. - - _userId:_ `string` - ID of the target user - - _clientId:_ `string` - ID of the client app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of client roles -- **getCurrentUserInfo**(): [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)
+ * *userId:* `string` - ID of the target user + * *clientId:* `string` - ID of the client app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of client roles +* **getCurrentUserInfo**(): [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)
Gets the name and other basic details of the current user. - - **Returns** [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts) - The user's details -- **getEffectiveRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ * **Returns** [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts) - The user's details +* **getEffectiveRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets effective roles. - - _userId:_ `string` - Id of the user. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of composite roles information objects -- **getInvolvedGroups**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`
+ * *userId:* `string` - Id of the user. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of composite roles information objects +* **getInvolvedGroups**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`
Gets involved groups. - - _userId:_ `string` - Id of the user. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - Array of involved groups information objects. -- **getTotalUsersCount**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - Id of the user. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - Array of involved groups information objects. +* **getTotalUsersCount**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets users total count. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Number of users count. -- **getUserRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Number of users count. +* **getUserRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets a list of roles for a user. - - _userId:_ `string` - ID of the user - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of role info objects -- **getUsers**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
+ * *userId:* `string` - ID of the user + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of role info objects +* **getUsers**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
Gets details for all users. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - Array of user info objects -- **getUsersByRolesWithCurrentUser**(roleNames: `string[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - Array of user info objects +* **getUsersByRolesWithCurrentUser**(roleNames: `string[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
Gets an array of users (including the current user) who have any of the roles in the supplied list. - - _roleNames:_ `string[]` - List of role names to look for - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - Array of user info objects -- **getUsersByRolesWithoutCurrentUser**(roleNames: `string[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
+ * *roleNames:* `string[]` - List of role names to look for + * **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - Array of user info objects +* **getUsersByRolesWithoutCurrentUser**(roleNames: `string[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
Gets an array of users (not including the current user) who have any of the roles in the supplied list. - - _roleNames:_ `string[]` - List of role names to look for - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - Array of user info objects -- **joinGroup**(joinGroupRequest: [`IdentityJoinGroupRequestModel`](../../../lib/core/services/identity-user.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *roleNames:* `string[]` - List of role names to look for + * **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - Array of user info objects +* **joinGroup**(joinGroupRequest: [`IdentityJoinGroupRequestModel`](../../../lib/core/services/identity-user.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Joins group. - - _joinGroupRequest:_ [`IdentityJoinGroupRequestModel`](../../../lib/core/services/identity-user.service.ts) - Details of join group request (IdentityJoinGroupRequestModel). - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user joined the group. -- **leaveGroup**(userId: `any`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *joinGroupRequest:* [`IdentityJoinGroupRequestModel`](../../../lib/core/services/identity-user.service.ts) - Details of join group request (IdentityJoinGroupRequestModel). + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user joined the group. +* **leaveGroup**(userId: `any`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Leaves group. - - _userId:_ `any` - Id of the user. - - _groupId:_ `string` - Id of the group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user left the group. -- **queryUsers**(requestQuery: [`IdentityUserQueryCloudRequestModel`](../../../lib/core/services/identity-user.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserQueryResponse`](../../../lib/core/services/identity-user.service.ts)`>`
+ * *userId:* `any` - Id of the user. + * *groupId:* `string` - Id of the group. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user left the group. +* **queryUsers**(requestQuery: [`IdentityUserQueryCloudRequestModel`](../../../lib/core/services/identity-user.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserQueryResponse`](../../../lib/core/services/identity-user.service.ts)`>`
Gets details for all users. - - _requestQuery:_ [`IdentityUserQueryCloudRequestModel`](../../../lib/core/services/identity-user.service.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserQueryResponse`](../../../lib/core/services/identity-user.service.ts)`>` - Array of user information objects. -- **removeRoles**(userId: `string`, removedRoles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *requestQuery:* [`IdentityUserQueryCloudRequestModel`](../../../lib/core/services/identity-user.service.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserQueryResponse`](../../../lib/core/services/identity-user.service.ts)`>` - Array of user information objects. +* **removeRoles**(userId: `string`, removedRoles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Removes assigned roles. - - _userId:_ `string` - Id of the user. - - _removedRoles:_ [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the role removed. -- **updateUser**(userId: `string`, updatedUser: [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *userId:* `string` - Id of the user. + * *removedRoles:* [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the role removed. +* **updateUser**(userId: `string`, updatedUser: [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Updates user details. - - _userId:_ `string` - Id of the user. - - _updatedUser:_ [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts) - Object containing the user details. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user updated. + * *userId:* `string` - Id of the user. + * *updatedUser:* [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts) - Object containing the user details. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user updated. ## See also -- [JWT helper service](jwt-helper.service.md) +* [JWT helper service](jwt-helper.service.md) diff --git a/docs/core/services/jwt-helper.service.md b/docs/core/services/jwt-helper.service.md index 140a1f3c26..7c4c3b66c1 100644 --- a/docs/core/services/jwt-helper.service.md +++ b/docs/core/services/jwt-helper.service.md @@ -7,51 +7,51 @@ Last reviewed: 2019-01-09 # [JWT helper service](../../../lib/core/services/jwt-helper.service.ts "Defined in jwt-helper.service.ts") -Decodes a JSON Web Token (JWT) to a JavaScript object. +Decodes a JSON Web Token (JWT) to a JavaScript object. ## Class members ### Methods -- **decodeToken**(token: `any`): `Object`
+* **decodeToken**(token: `any`): `Object`
Decodes a JSON web token into a JS object. - - _token:_ `any` - Token in encoded form - - **Returns** `Object` - Decoded token data object -- **getAccessToken**(): `string`
+ * *token:* `any` - Token in encoded form + * **Returns** `Object` - Decoded token data object +* **getAccessToken**(): `string`
Gets access token - - **Returns** `string` - access token -- **getClientRoles**(clientName: `string`): `string[]`
+ * **Returns** `string` - access token +* **getClientRoles**(clientName: `string`): `string[]`
Gets Client roles. - - _clientName:_ `string` - - - **Returns** `string[]` - Array of client roles -- **getRealmRoles**(): `string[]`
+ * *clientName:* `string` - + * **Returns** `string[]` - Array of client roles +* **getRealmRoles**(): `string[]`
Gets realm roles. - - **Returns** `string[]` - Array of realm roles -- **getValueFromLocalAccessToken**(key: `string`)
+ * **Returns** `string[]` - Array of realm roles +* **getValueFromLocalAccessToken**(key: `string`)
Gets a named value from the user access token. - - _key:_ `string` - Key name of the field to retrieve -- **getValueFromToken**(accessToken: `string`, key: `string`)
+ * *key:* `string` - Key name of the field to retrieve +* **getValueFromToken**(accessToken: `string`, key: `string`)
Gets a named value from the user access token. - - _accessToken:_ `string` - your SSO access token where the value is encode - - _key:_ `string` - Key name of the field to retrieve -- **hasClientRole**(clientName: `string`, role: `string`): `boolean`
+ * *accessToken:* `string` - your SSO access token where the value is encode + * *key:* `string` - Key name of the field to retrieve +* **hasClientRole**(clientName: `string`, role: `string`): `boolean`
Checks for client role. - - _clientName:_ `string` - Targeted client name - - _role:_ `string` - Role name to check - - **Returns** `boolean` - True if it contains given role, false otherwise -- **hasRealmRole**(role: `string`): `boolean`
+ * *clientName:* `string` - Targeted client name + * *role:* `string` - Role name to check + * **Returns** `boolean` - True if it contains given role, false otherwise +* **hasRealmRole**(role: `string`): `boolean`
Checks for single realm role. - - _role:_ `string` - Role name to check - - **Returns** `boolean` - True if it contains given role, false otherwise -- **hasRealmRoles**(rolesToCheck: `string[]`): `boolean`
+ * *role:* `string` - Role name to check + * **Returns** `boolean` - True if it contains given role, false otherwise +* **hasRealmRoles**(rolesToCheck: `string[]`): `boolean`
Checks for realm roles. - - _rolesToCheck:_ `string[]` - List of role names to check - - **Returns** `boolean` - True if it contains at least one of the given roles, false otherwise -- **hasRealmRolesForClientRole**(clientName: `string`, rolesToCheck: `string[]`): `boolean`
+ * *rolesToCheck:* `string[]` - List of role names to check + * **Returns** `boolean` - True if it contains at least one of the given roles, false otherwise +* **hasRealmRolesForClientRole**(clientName: `string`, rolesToCheck: `string[]`): `boolean`
Checks for client roles. - - _clientName:_ `string` - Targeted client name - - _rolesToCheck:_ `string[]` - List of role names to check - - **Returns** `boolean` - True if it contains at least one of the given roles, false otherwise + * *clientName:* `string` - Targeted client name + * *rolesToCheck:* `string[]` - List of role names to check + * **Returns** `boolean` - True if it contains at least one of the given roles, false otherwise ## Details @@ -61,4 +61,4 @@ for full details of the standard and its uses. ## See also -- [Identity user service](identity-user.service.md) +* [Identity user service](identity-user.service.md) diff --git a/docs/core/services/log.service.md b/docs/core/services/log.service.md index 3c1b8f3b4e..2e2b5e8139 100644 --- a/docs/core/services/log.service.md +++ b/docs/core/services/log.service.md @@ -51,49 +51,49 @@ export class AppComponent { ### Methods -- **assert**(test?: `boolean`, message?: `string`, optionalParams: `any[]`)
+* **assert**(test?: `boolean`, message?: `string`, optionalParams: `any[]`)
Logs a message if a boolean test fails. - - _test:_ `boolean` - (Optional) Test value (typically a boolean expression) - - _message:_ `string` - (Optional) Message to show if test is false - - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **debug**(message?: `any`, optionalParams: `any[]`)
+ * *test:* `boolean` - (Optional) Test value (typically a boolean expression) + * *message:* `string` - (Optional) Message to show if test is false + * *optionalParams:* `any[]` - Interpolation values for the message in "printf" format +* **debug**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "DEBUG" level. - - _message:_ `any` - (Optional) Message to log - - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **error**(message?: `any`, optionalParams: `any[]`)
+ * *message:* `any` - (Optional) Message to log + * *optionalParams:* `any[]` - Interpolation values for the message in "printf" format +* **error**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "ERROR" level. - - _message:_ `any` - (Optional) Message to log - - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts)
+ * *message:* `any` - (Optional) Message to log + * *optionalParams:* `any[]` - Interpolation values for the message in "printf" format +* **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts)
Converts a log level name string into its numeric equivalent. - - _level:_ `string` - Level name - - **Returns** [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts) - Numeric log level -- **group**(groupTitle?: `string`, optionalParams: `any[]`)
+ * *level:* `string` - Level name + * **Returns** [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts) - Numeric log level +* **group**(groupTitle?: `string`, optionalParams: `any[]`)
Starts an indented group of log messages. - - _groupTitle:_ `string` - (Optional) Title shown at the start of the group - - _optionalParams:_ `any[]` - Interpolation values for the title in "printf" format -- **groupEnd**()
+ * *groupTitle:* `string` - (Optional) Title shown at the start of the group + * *optionalParams:* `any[]` - Interpolation values for the title in "printf" format +* **groupEnd**()
Ends a indented group of log messages. -- **info**(message?: `any`, optionalParams: `any[]`)
+* **info**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "INFO" level. - - _message:_ `any` - (Optional) Message to log - - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **log**(message?: `any`, optionalParams: `any[]`)
+ * *message:* `any` - (Optional) Message to log + * *optionalParams:* `any[]` - Interpolation values for the message in "printf" format +* **log**(message?: `any`, optionalParams: `any[]`)
Logs a message at any level from "TRACE" upwards. - - _message:_ `any` - (Optional) Message to log - - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **messageBus**(text: `string`, logLevel: `string`)
+ * *message:* `any` - (Optional) Message to log + * *optionalParams:* `any[]` - Interpolation values for the message in "printf" format +* **messageBus**(text: `string`, logLevel: `string`)
Triggers notification callback for log messages. - - _text:_ `string` - Message text - - _logLevel:_ `string` - Log level for the message -- **trace**(message?: `any`, optionalParams: `any[]`)
+ * *text:* `string` - Message text + * *logLevel:* `string` - Log level for the message +* **trace**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "TRACE" level. - - _message:_ `any` - (Optional) Message to log - - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **warn**(message?: `any`, optionalParams: `any[]`)
+ * *message:* `any` - (Optional) Message to log + * *optionalParams:* `any[]` - Interpolation values for the message in "printf" format +* **warn**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "WARN" level. - - _message:_ `any` - (Optional) Message to log - - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format + * *message:* `any` - (Optional) Message to log + * *optionalParams:* `any[]` - Interpolation values for the message in "printf" format ## Details @@ -110,7 +110,7 @@ There are 6 levels of logs that you can use: | ERROR | 1 | | SILENT | 0 | -You can set the default log level using the **_logLevel_** property in `app.config.json`. +You can set the default log level using the ***logLevel*** property in `app.config.json`. The factory setting for this property is `TRACE`. For example, you can set the default log level to `WARNING` as follows: @@ -127,7 +127,7 @@ For example, you can set the default log level to `WARNING` as follows: The [log service](log.service.md) also provides an [`Observable`](http://reactivex.io/documentation/observable.html) called `_onMessage_` -that you can subscribe to if you want to receive all the log messages. +that you can subscribe to if you want to receive all the log messages. The message object passed as a parameter to the `onMessage` handler has the following format: ```ts diff --git a/docs/core/services/node.service.md b/docs/core/services/node.service.md index 6b591b8457..c1b2c8722a 100644 --- a/docs/core/services/node.service.md +++ b/docs/core/services/node.service.md @@ -9,31 +9,31 @@ Last reviewed: 2018-11-20 use [Nodes Api service](./nodes-api.service.md) instead of this. -Gets Alfresco Repository node metadata and creates nodes with metadata. +Gets Alfresco Repository node metadata and creates nodes with metadata. ## Class members ### Methods -- **createNode**(name: `string`, nodeType: `string`, properties: `any`, path: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
- (**Deprecated:** in 3.8.0, use `createNodeInsideRoot` method from NodesApiService instead. Create a new Node from form metadata) - - _name:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name - - _nodeType:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type - - _properties:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) body properties - - _path:_ `string` - Path to the node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node -- **createNodeMetadata**(nodeType: `string`, nameSpace: `any`, data: `any`, path: `string`, name?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
- (**Deprecated:** in 3.8.0, use NodesApiService instead. Create a new Node from form metadata.) - - _nodeType:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type - - _nameSpace:_ `any` - Namespace for properties - - _data:_ `any` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) data to store in the node under namespace - - _path:_ `string` - Path to the node - - _name:_ `string` - (Optional) [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node -- **getNodeMetadata**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/models/node-metadata.model.ts)`>`
- (**Deprecated:** in 3.8.0, use NodesApiService instead. Get the metadata and the nodeType for a nodeId cleaned by the prefix.) - - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/models/node-metadata.model.ts)`>` - Node metadata +* **createNode**(name: `string`, nodeType: `string`, properties: `any`, path: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+ (**Deprecated:** in 3.8.0, use `createNodeInsideRoot` method from NodesApiService instead. Create a new Node from form metadata) + * *name:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name + * *nodeType:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type + * *properties:* `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) body properties + * *path:* `string` - Path to the node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node +* **createNodeMetadata**(nodeType: `string`, nameSpace: `any`, data: `any`, path: `string`, name?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+ (**Deprecated:** in 3.8.0, use NodesApiService instead. Create a new Node from form metadata.) + * *nodeType:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type + * *nameSpace:* `any` - Namespace for properties + * *data:* `any` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) data to store in the node under namespace + * *path:* `string` - Path to the node + * *name:* `string` - (Optional) [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node +* **getNodeMetadata**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/models/node-metadata.model.ts)`>`
+ (**Deprecated:** in 3.8.0, use NodesApiService instead. Get the metadata and the nodeType for a nodeId cleaned by the prefix.) + * *nodeId:* `string` - ID of the target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/models/node-metadata.model.ts)`>` - Node metadata ## Details @@ -55,5 +55,5 @@ export class SomePageComponent implements OnInit { ## See also -- [Nodes api service](nodes-api.service.md) -- [Deleted nodes api service](deleted-nodes-api.service.md) +* [Nodes api service](nodes-api.service.md) +* [Deleted nodes api service](deleted-nodes-api.service.md) diff --git a/docs/core/services/nodes-api.service.md b/docs/core/services/nodes-api.service.md index 3f6b623201..058cccc930 100644 --- a/docs/core/services/nodes-api.service.md +++ b/docs/core/services/nodes-api.service.md @@ -11,75 +11,75 @@ Accesses and manipulates ACS document nodes using their node IDs. ## Contents -- [Class members](#class-members) - - [Methods](#methods) -- [Details](#details) - - [Getting node information](#getting-node-information) - - [Getting folder node contents](#getting-folder-node-contents) - - [Creating and updating nodes](#creating-and-updating-nodes) - - [Deleting and restoring nodes](#deleting-and-restoring-nodes) -- [See also](#see-also) +* [Class members](#class-members) + * [Methods](#methods) +* [Details](#details) + * [Getting node information](#getting-node-information) + * [Getting folder node contents](#getting-folder-node-contents) + * [Creating and updating nodes](#creating-and-updating-nodes) + * [Deleting and restoring nodes](#deleting-and-restoring-nodes) +* [See also](#see-also) ## Class members ### Methods -- **createFolder**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
+* **createFolder**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Creates a new folder node inside a parent folder. - - _parentNodeId:_ `string` - ID of the parent folder node - - _nodeBody:_ `any` - Data for the new folder - - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the new folder -- **createNode**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
+ * *parentNodeId:* `string` - ID of the parent folder node + * *nodeBody:* `any` - Data for the new folder + * *options:* `any` - Optional parameters supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the new folder +* **createNode**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Creates a new document node inside a folder. - - _parentNodeId:_ `string` - ID of the parent folder node - - _nodeBody:_ `any` - Data for the new node - - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the new node -- **createNodeInsideRoot**(name: `string`, nodeType: `string`, properties: `any`, path: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+ * *parentNodeId:* `string` - ID of the parent folder node + * *nodeBody:* `any` - Data for the new node + * *options:* `any` - Optional parameters supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the new node +* **createNodeInsideRoot**(name: `string`, nodeType: `string`, properties: `any`, path: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Create a new Node inside `-root-` folder - - _name:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name - - _nodeType:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type - - _properties:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) body properties - - _path:_ `string` - Path to the node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node -- **createNodeMetadata**(nodeType: `string`, nameSpace: `any`, data: `any`, path: `string`, name?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+ * *name:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name + * *nodeType:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type + * *properties:* `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) body properties + * *path:* `string` - Path to the node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node +* **createNodeMetadata**(nodeType: `string`, nameSpace: `any`, data: `any`, path: `string`, name?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Create a new Node from form metadata. - - _nodeType:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type - - _nameSpace:_ `any` - Namespace for properties - - _data:_ `any` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) data to store in the node under namespace - - _path:_ `string` - Path to the node - - _name:_ `string` - (Optional) [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node -- **deleteNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *nodeType:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) type + * *nameSpace:* `any` - Namespace for properties + * *data:* `any` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) data to store in the node under namespace + * *path:* `string` - Path to the node + * *name:* `string` - (Optional) [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) name + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node +* **deleteNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Moves a node to the trashcan. - - _nodeId:_ `string` - ID of the target node - - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty result that notifies when the deletion is complete -- **getNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
+ * *nodeId:* `string` - ID of the target node + * *options:* `any` - Optional parameters supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty result that notifies when the deletion is complete +* **getNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Gets the stored information about a node. - - _nodeId:_ `string` - ID of the target node - - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Node information -- **getNodeChildren**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+ * *nodeId:* `string` - ID of the target node + * *options:* `any` - Optional parameters supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Node information +* **getNodeChildren**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets the items contained in a folder node. - - _nodeId:_ `string` - ID of the target node - - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of child items from the folder -- **getNodeMetadata**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/models/node-metadata.model.ts)`>`
+ * *nodeId:* `string` - ID of the target node + * *options:* `any` - Optional parameters supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of child items from the folder +* **getNodeMetadata**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/models/node-metadata.model.ts)`>`
Get the metadata and the nodeType for a nodeId cleaned by the prefix. - - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/models/node-metadata.model.ts)`>` - Node metadata -- **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
+ * *nodeId:* `string` - ID of the target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/models/node-metadata.model.ts)`>` - Node metadata +* **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Restores a node previously moved to the trashcan. - - _nodeId:_ `string` - ID of the node to restore - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the restored node -- **updateNode**(nodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
+ * *nodeId:* `string` - ID of the node to restore + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Details of the restored node +* **updateNode**(nodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Updates the information about a node. - - _nodeId:_ `string` - ID of the target node - - _nodeBody:_ `any` - New data for the node - - _options:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Updated node information + * *nodeId:* `string` - ID of the target node + * *nodeBody:* `any` - New data for the node + * *options:* `any` - Optional parameters supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Updated node information ## Details @@ -89,14 +89,14 @@ by dashes, eg: `53ef6110-ed9c-4739-a520-e7b4336229c0` -The string is convenient for storage, for passing as an +The string is convenient for storage, for passing as an [Angular route parameter](https://angular.io/guide/router) and other purposes but doesn't enable you to do very much with the node itself. The [Nodes Api Service](nodes-api.service.md) has methods for getting information about nodes and managing them within the repository (creating, deleting, etc). Other lower level interfaces to the ACS nodes API are also available - see the -[Alfresco Api service](alfresco-api.service.md), the +[Alfresco Api service](alfresco-api.service.md), the [Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-core-rest-api) and the [REST API Explorer](https://api-explorer.alfresco.com/api-explorer/#/nodes) @@ -185,7 +185,7 @@ existing node. See the [addNode](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#addNode) and [updateNode](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#updateNode) -entries in the Alfresco JS API for further information about the available options and +entries in the Alfresco JS API for further information about the available options and the format of the new node data. ### Deleting and restoring nodes @@ -206,6 +206,6 @@ pages in the Alfresco JS API for further details and options. Note that you can ## See also -- [Deleted nodes api service](deleted-nodes-api.service.md) -- [Document list component](../../content-services/components/document-list.component.md) -- [Node service](node.service.md) +* [Deleted nodes api service](deleted-nodes-api.service.md) +* [Document list component](../../content-services/components/document-list.component.md) +* [Node service](node.service.md) diff --git a/docs/core/services/notification.service.md b/docs/core/services/notification.service.md index f5034f18a3..09d38a60a5 100644 --- a/docs/core/services/notification.service.md +++ b/docs/core/services/notification.service.md @@ -15,39 +15,39 @@ Shows a notification message with optional feedback. ### Methods -- **dismissSnackMessageAction**()
+* **dismissSnackMessageAction**()
dismiss the notification snackbar -- **openSnackMessage**(message: `string`, config?: `number|MatSnackBarConfig`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+* **openSnackMessage**(message: `string`, config?: `number|MatSnackBarConfig`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Opens a SnackBar notification to show a message. - - _message:_ `string` - The message (or resource key) to show. - - _config:_ `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object - - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar -- **openSnackMessageAction**(message: `string`, action: `string`, config?: `number|MatSnackBarConfig`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+ * *message:* `string` - The message (or resource key) to show. + * *config:* `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object + * *interpolateArgs:* `any` - (Optional) The interpolation parameters to add for the translation + * **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar +* **openSnackMessageAction**(message: `string`, action: `string`, config?: `number|MatSnackBarConfig`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Opens a SnackBar notification with a message and a response button. - - _message:_ `string` - The message (or resource key) to show. - - _action:_ `string` - Caption for the response button - - _config:_ `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object - - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar -- **showError**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+ * *message:* `string` - The message (or resource key) to show. + * *action:* `string` - Caption for the response button + * *config:* `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object + * *interpolateArgs:* `any` - (Optional) The interpolation parameters to add for the translation + * **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar +* **showError**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Rase error message - - _message:_ `string` - Text message or translation key for the message. - - _action:_ `string` - (Optional) Action name - - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - -- **showInfo**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+ * *message:* `string` - Text message or translation key for the message. + * *action:* `string` - (Optional) Action name + * *interpolateArgs:* `any` - (Optional) The interpolation parameters to add for the translation + * **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - +* **showInfo**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Rase info message - - _message:_ `string` - Text message or translation key for the message. - - _action:_ `string` - (Optional) Action name - - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - -- **showWarning**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+ * *message:* `string` - Text message or translation key for the message. + * *action:* `string` - (Optional) Action name + * *interpolateArgs:* `any` - (Optional) The interpolation parameters to add for the translation + * **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - +* **showWarning**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Rase warning message - - _message:_ `string` - Text message or translation key for the message. - - _action:_ `string` - (Optional) Action name - - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - + * *message:* `string` - Text message or translation key for the message. + * *action:* `string` - (Optional) Action name + * *interpolateArgs:* `any` - (Optional) The interpolation parameters to add for the translation + * **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - ## Details diff --git a/docs/core/services/page-title.service.md b/docs/core/services/page-title.service.md index 428e9bfbb3..ba4812f008 100644 --- a/docs/core/services/page-title.service.md +++ b/docs/core/services/page-title.service.md @@ -13,9 +13,9 @@ Sets the page title. ### Methods -- **setTitle**(value: `string` = `""`)
+* **setTitle**(value: `string` = `""`)
Sets the page title. - - _value:_ `string` - The new title + * *value:* `string` - The new title ## Details @@ -28,4 +28,4 @@ is not supplied then just the app name is used; this will default to ## See also -- [App config service](app-config.service.md) +* [App config service](app-config.service.md) diff --git a/docs/core/services/people-content.service.md b/docs/core/services/people-content.service.md index 2b91ec0a22..73b52e5c2d 100644 --- a/docs/core/services/people-content.service.md +++ b/docs/core/services/people-content.service.md @@ -7,19 +7,19 @@ Last reviewed: 2018-04-06 # [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. ## Class members ### Methods -- **getCurrentPerson**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **getCurrentPerson**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets information about the user who is currently logged in. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - User information -- **getPerson**(personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - User information +* **getPerson**(personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets information about a user identified by their username. - - _personId:_ `string` - ID of the target user - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - User information + * *personId:* `string` - ID of the target user + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - User information ## Details @@ -34,5 +34,5 @@ method in the Alfresco JS API for more information about the REST calls used by ## See also -- [People process service](people-process.service.md) -- [Ecm user model](../models/ecm-user.model.md) +* [People process service](people-process.service.md) +* [Ecm user model](../models/ecm-user.model.md) diff --git a/docs/core/services/people-process.service.md b/docs/core/services/people-process.service.md index 10a4a3abbf..ff70a4835c 100644 --- a/docs/core/services/people-process.service.md +++ b/docs/core/services/people-process.service.md @@ -13,30 +13,30 @@ Gets information about Process Services users. ### Methods -- **getUserImage**(user: [`UserProcessModel`](../../core/models/user-process.model.md)): `string`
+* **getUserImage**(user: [`UserProcessModel`](../../core/models/user-process.model.md)): `string`
Gets the profile picture URL for the specified user. - - _user:_ [`UserProcessModel`](../../core/models/user-process.model.md) - The target user - - **Returns** `string` - Profile picture URL -- **getWorkflowUsers**(taskId?: `string`, searchWord?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>`
+ * *user:* [`UserProcessModel`](../../core/models/user-process.model.md) - The target user + * **Returns** `string` - Profile picture URL +* **getWorkflowUsers**(taskId?: `string`, searchWord?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>`
Gets information about users across all tasks. - - _taskId:_ `string` - (Optional) ID of the task - - _searchWord:_ `string` - (Optional) Filter text to search for - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` - Array of user information objects -- **involveUserWithTask**(taskId: `string`, idToInvolve: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>`
+ * *taskId:* `string` - (Optional) ID of the task + * *searchWord:* `string` - (Optional) Filter text to search for + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` - Array of user information objects +* **involveUserWithTask**(taskId: `string`, idToInvolve: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>`
Sets a user to be involved with a task. - - _taskId:_ `string` - ID of the target task - - _idToInvolve:_ `string` - ID of the user to involve - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` - Empty response when the update completes -- **removeInvolvedUser**(taskId: `string`, idToRemove: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>`
+ * *taskId:* `string` - ID of the target task + * *idToInvolve:* `string` - ID of the user to involve + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` - Empty response when the update completes +* **removeInvolvedUser**(taskId: `string`, idToRemove: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>`
Removes a user who is currently involved with a task. - - _taskId:_ `string` - ID of the target task - - _idToRemove:_ `string` - ID of the user to remove - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` - Empty response when the update completes + * *taskId:* `string` - ID of the target task + * *idToRemove:* `string` - ID of the user to remove + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` - Empty response when the update completes ## Details Use `getWorkflowUsers` to find users across all tasks, optionally filtering by the `searchWord` -in the task name. The `taskId` parameter, if used, specifies a task to be _excluded_ from the +in the task name. The `taskId` parameter, if used, specifies a task to be *excluded* from the results. You would typically use this feature to find new users to assign to a task, in which case you would want to exclude users already assigned to that task. @@ -53,6 +53,6 @@ You can find more information about the REST API methods used by this service in ## See also -- [User process model](../models/user-process.model.md) -- [Bpm user model](../models/bpm-user.model.md) -- [People content service](people-content.service.md) +* [User process model](../models/user-process.model.md) +* [Bpm user model](../models/bpm-user.model.md) +* [People content service](people-content.service.md) diff --git a/docs/core/services/process-content.service.md b/docs/core/services/process-content.service.md index e614f4b85b..73d895d81c 100644 --- a/docs/core/services/process-content.service.md +++ b/docs/core/services/process-content.service.md @@ -12,68 +12,68 @@ Manipulates content related to a Process Instance or Task Instance in APS. ### Methods -- **createProcessRelatedContent**(processInstanceId: `string`, content: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **createProcessRelatedContent**(processInstanceId: `string`, content: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Associates an uploaded file with a process instance. - - _processInstanceId:_ `string` - ID of the target process instance - - _content:_ `any` - File to associate - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of created content -- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *processInstanceId:* `string` - ID of the target process instance + * *content:* `any` - File to associate + * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of created content +* **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Associates an uploaded file with a task instance. - - _taskId:_ `string` - ID of the target task - - _file:_ `any` - File to associate - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - 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)`>`
+ * *taskId:* `string` - ID of the target task + * *file:* `any` - File to associate + * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - 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)`>`
Create temporary related content from an uploaded file. - - _file:_ `any` - File to use for content - - **Returns** [`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)`>` - The created content data -- **deleteRelatedContent**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *file:* `any` - File to use for content + * **Returns** [`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)`>` - The created content data +* **deleteRelatedContent**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes related content. - - _contentId:_ `number` - Identifier of the content to delete - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response that notifies when the deletion is complete -- **getContentPreview**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+ * *contentId:* `number` - Identifier of the content to delete + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response that notifies when the deletion is complete +* **getContentPreview**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Gets the preview for a related content file. - - _contentId:_ `number` - ID of the related content - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary data of the content preview -- **getContentThumbnail**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+ * *contentId:* `number` - ID of the related content + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary data of the content preview +* **getContentThumbnail**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Gets the thumbnail for a related content file. - - _contentId:_ `number` - ID of the related content - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary data of the thumbnail image -- **getFileContent**(contentId: `number`): [`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)`>`
+ * *contentId:* `number` - ID of the related content + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary data of the thumbnail image +* **getFileContent**(contentId: `number`): [`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)`>`
Gets the metadata for a related content item. - - _contentId:_ `number` - ID of the content item - - **Returns** [`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)`>` - Metadata for the content -- **getFileRawContent**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+ * *contentId:* `number` - ID of the content item + * **Returns** [`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)`>` - Metadata for the content +* **getFileRawContent**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Gets raw binary content data for a related content file. - - _contentId:_ `number` - ID of the related content - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary data of the related content -- **getFileRawContentUrl**(contentId: `number`): `string`
+ * *contentId:* `number` - ID of the related content + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary data of the related content +* **getFileRawContentUrl**(contentId: `number`): `string`
Gets a URL for direct access to a related content file. - - _contentId:_ `number` - ID of the related content - - **Returns** `string` - URL to access the content -- **getProcessRelatedContent**(processId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *contentId:* `number` - ID of the related content + * **Returns** `string` - URL to access the content +* **getProcessRelatedContent**(processId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets related content items for a process instance. - - _processId:_ `string` - ID of the target process - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Metadata for the content -- **getTaskRelatedContent**(taskId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *processId:* `string` - ID of the target process + * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Metadata for the content +* **getTaskRelatedContent**(taskId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets related content items for a task instance. - - _taskId:_ `string` - ID of the target task - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Metadata for the content -- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *taskId:* `string` - ID of the target task + * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Metadata for the content +* **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Reports an error message. - - _error:_ `any` - Data object with optional `message` and `status` fields for the error - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Callback when an error occurs -- **toJson**(res: `any`): `any`
+ * *error:* `any` - Data object with optional `message` and `status` fields for the error + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Callback when an error occurs +* **toJson**(res: `any`): `any`
Creates a JSON representation of data. - - _res:_ `any` - Object representing data - - **Returns** `any` - JSON object -- **toJsonArray**(res: `any`): `any`
+ * *res:* `any` - Object representing data + * **Returns** `any` - JSON object +* **toJsonArray**(res: `any`): `any`
Creates a JSON array representation of data. - - _res:_ `any` - Object representing data - - **Returns** `any` - JSON array object + * *res:* `any` - Object representing data + * **Returns** `any` - JSON array object ## Methods @@ -81,7 +81,7 @@ Manipulates content related to a Process Instance or Task Instance in APS. Associate an uploaded file with a Process Instance. -Let's say we have an upload button as follows: +Let's say we have an upload button as follows: ```html
@@ -119,8 +119,8 @@ export class SomePageComponent implements OnInit { } ``` -In the above sample code the `file` is uploaded via an HTML input element. -The `processInstanceId` refers to a process instance ID for a running process in APS. +In the above sample code the `file` is uploaded via an HTML input element. +The `processInstanceId` refers to a process instance ID for a running process in APS.\ The returned `relContent` object looks like in this sample: Related content: @@ -136,14 +136,14 @@ The returned `relContent` object looks like in this sample: simpleType: "pdf" thumbnailStatus: "queued" -The related content `id` can be used by other methods in this service to get to the content and to +The related content `id` can be used by other methods in this service to get to the content and to delete it. It is referred to as the `contentId`. If you look at attachments for the process instance it should now display the new file. #### createTaskRelatedContent(taskId: string, file: any, opts?: any) -Associate an uploaded file with a Task Instance. This is in effect very similar +Associate an uploaded file with a Task Instance. This is in effect very similar to the `createProcessRelatedContent` call. Just use `taskInstanceId` instead of `processInstanceId`. ```ts @@ -165,7 +165,7 @@ onUploadFile() { } ``` -For more information see the docs for `createProcessRelatedContent`. +For more information see the docs for `createProcessRelatedContent`. #### createTemporaryRawRelatedContent(file: any): Observable`` @@ -187,11 +187,11 @@ is not yet associated with a process instance or a task instance. } ``` -For more information see the docs for `createProcessRelatedContent`. +For more information see the docs for `createProcessRelatedContent`. #### deleteRelatedContent(contentId: number): Observable`` -Delete related content via the content identifier: +Delete related content via the content identifier: ```ts const contentId = 6008; @@ -209,7 +209,7 @@ See `getProcessRelatedContent` and `getTaskRelatedContent` for how to get to the #### getFileContent(contentId: number): Observable`` -Get the metadata for a related content item in the format of a [`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md) object: +Get the metadata for a related content item in the format of a [`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md) object: ```ts const contentId = 6008; @@ -239,7 +239,7 @@ See `getProcessRelatedContent` and `getTaskRelatedContent` for how to get to the #### getFileRawContentUrl(contentId: number): string -Get the URL for direct access to a related content file: +Get the URL for direct access to a related content file: ```ts const contentId = 6008; @@ -277,8 +277,8 @@ See `getProcessRelatedContent` and `getTaskRelatedContent` for how to get to the #### getContentPreview(contentId: number): Observable`` -Get the preview file for a related content file. A content file might be for example a -MS Word document. This method would give you the PDF preview for this document, +Get the preview file for a related content file. A content file might be for example a\ +MS Word document. This method would give you the PDF preview for this document, if it has been generated: ```ts @@ -299,8 +299,8 @@ See `getProcessRelatedContent` and `getTaskRelatedContent` for how to get to the #### getContentThumbnail(contentId: number): Observable`` -Get the thumbnail file for a related content file. A content file might be for example a -MS Word document. This method would give you the image thumbnail for this document, +Get the thumbnail file for a related content file. A content file might be for example a\ +MS Word document. This method would give you the image thumbnail for this document, if it has been generated: ```ts @@ -321,7 +321,7 @@ See `getProcessRelatedContent` and `getTaskRelatedContent` for how to get to the #### getProcessRelatedContent(processId: string): Observable`` -Get related content items for passed in Process Instance ID, only metadata for related content is returned: +Get related content items for passed in Process Instance ID, only metadata for related content is returned: ```ts const processId = '11337'; @@ -363,7 +363,7 @@ The `id` property corresponds to the `contentId` property used in many of the ot #### getTaskRelatedContent(taskId: string): Observable`` -Get related content items for passed in Task Instance ID, only metadata for related content is returned: +Get related content items for passed in Task Instance ID, only metadata for related content is returned: ```ts const taskId = '15303'; @@ -375,7 +375,7 @@ this.contentService.getTaskRelatedContent(taskId).subscribe( }); ``` -The response format is the same as for the `getProcessRelatedContent` method, see its docs. +The response format is the same as for the `getProcessRelatedContent` method, see its docs. ## Details diff --git a/docs/core/services/renditions.service.md b/docs/core/services/renditions.service.md index d301f78ab0..d1b9aea90f 100644 --- a/docs/core/services/renditions.service.md +++ b/docs/core/services/renditions.service.md @@ -13,57 +13,57 @@ Manages prearranged conversions of content to different formats. ### Methods -- **convert**(nodeId: `string`, encoding: `string`, pollingInterval: `number` = `1000`, retries: `number` = `5`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>`
+* **convert**(nodeId: `string`, encoding: `string`, pollingInterval: `number` = `1000`, retries: `number` = `5`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>`
Repeatedly attempts to create a rendition, through to success or failure. - - _nodeId:_ `string` - ID of the target node - - _encoding:_ `string` - Name of the rendition encoding - - _pollingInterval:_ `number` - Time interval (in milliseconds) between checks for completion - - _retries:_ `number` - Number of attempts to make before declaring failure - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - True if the rendition was created, false otherwise -- **createRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *nodeId:* `string` - ID of the target node + * *encoding:* `string` - Name of the rendition encoding + * *pollingInterval:* `number` - Time interval (in milliseconds) between checks for completion + * *retries:* `number` - Number of attempts to make before declaring failure + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - True if the rendition was created, false otherwise +* **createRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Creates a rendition for a node. - - _nodeId:_ `string` - ID of the target node - - _encoding:_ `string` - Name of the rendition encoding - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response to indicate completion -- **generateRenditionForNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *nodeId:* `string` - ID of the target node + * *encoding:* `string` - Name of the rendition encoding + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response to indicate completion +* **generateRenditionForNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Generates a rendition for a node using the first available encoding. - - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response to indicate completion -- **getAvailableRenditionForNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>`
+ * *nodeId:* `string` - ID of the target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response to indicate completion +* **getAvailableRenditionForNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>`
Gets the first available rendition found for a node. - - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - Information object for the rendition -- **getRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>`
+ * *nodeId:* `string` - ID of the target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - Information object for the rendition +* **getRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>`
Gets information about a rendition of a node. - - _nodeId:_ `string` - ID of the target node - - _encoding:_ `string` - Name of the rendition encoding - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - Information object about the rendition -- **getRenditionUrl**(nodeId: `string`, encoding: `string`): `string`
+ * *nodeId:* `string` - ID of the target node + * *encoding:* `string` - Name of the rendition encoding + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md)`>` - Information object about the rendition +* **getRenditionUrl**(nodeId: `string`, encoding: `string`): `string`
Gets a URL linking to the specified rendition of a node. - - _nodeId:_ `string` - ID of the target node - - _encoding:_ `string` - Name of the rendition encoding - - **Returns** `string` - URL string -- **getRenditionsListByNodeId**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionPaging.md)`>`
+ * *nodeId:* `string` - ID of the target node + * *encoding:* `string` - Name of the rendition encoding + * **Returns** `string` - URL string +* **getRenditionsListByNodeId**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionPaging.md)`>`
Gets a list of all renditions for a node. - - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionPaging.md)`>` - Paged list of rendition details -- **isConversionPossible**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *nodeId:* `string` - ID of the target node + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RenditionPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionPaging.md)`>` - Paged list of rendition details +* **isConversionPossible**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Checks if the node can be converted using the specified rendition. - - _nodeId:_ `string` - ID of the target node - - _encoding:_ `string` - Name of the rendition encoding - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the node can be converted, false otherwise -- **isRenditionAvailable**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *nodeId:* `string` - ID of the target node + * *encoding:* `string` - Name of the rendition encoding + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the node can be converted, false otherwise +* **isRenditionAvailable**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Checks if the specified rendition is available for a node. - - _nodeId:_ `string` - ID of the target node - - _encoding:_ `string` - Name of the rendition encoding - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the rendition is available, false otherwise + * *nodeId:* `string` - ID of the target node + * *encoding:* `string` - Name of the rendition encoding + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the rendition is available, false otherwise ## Details ACS allows content items to be converted to other formats for display or delivery. For example, a raw text file might be converted to HTML to enable better formatting in a web browser or a PDF might be converted to an equivalent bitmap image. A -_rendition_ is a prearranged conversion that is set up for an item for convenient +*rendition* is a prearranged conversion that is set up for an item for convenient repeated use. More information about renditions is available in the [Content Services documentation](https://docs.alfresco.com/5.2/references/dev-extension-points-content-transformer.html). diff --git a/docs/core/services/search-configuration.service.md b/docs/core/services/search-configuration.service.md index 008e8e0bba..28453e8058 100644 --- a/docs/core/services/search-configuration.service.md +++ b/docs/core/services/search-configuration.service.md @@ -13,12 +13,12 @@ Provides fine control of parameters to a search. ### Methods -- **generateQueryBody**(searchTerm: `string`, maxResults: `number`, skipCount: `number`): `QueryBody`
+* **generateQueryBody**(searchTerm: `string`, maxResults: `number`, skipCount: `number`): `QueryBody`
Generates a QueryBody object with custom search parameters. - - _searchTerm:_ `string` - Term text to search for - - _maxResults:_ `number` - Maximum number of search results to show in a page - - _skipCount:_ `number` - The offset of the start of the page within the results list - - **Returns** `QueryBody` - Query body defined by the parameters + * *searchTerm:* `string` - Term text to search for + * *maxResults:* `number` - Maximum number of search results to show in a page + * *skipCount:* `number` - The offset of the start of the page within the results list + * **Returns** `QueryBody` - Query body defined by the parameters ## Details @@ -35,5 +35,5 @@ example code. ## See also -- [Search component](../../content-services/components/search.component.md) -- [Search configuration interface](../interfaces/search-configuration.interface.md) +* [Search component](../../content-services/components/search.component.md) +* [Search configuration interface](../interfaces/search-configuration.interface.md) diff --git a/docs/core/services/search.service.md b/docs/core/services/search.service.md index 04b645532d..a810c762b7 100644 --- a/docs/core/services/search.service.md +++ b/docs/core/services/search.service.md @@ -13,32 +13,32 @@ Accesses the Content Services Search API. ### Methods -- **getNodeQueryResults**(term: `string`, options?: [`SearchOptions`](../../../lib/core/services/search.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+* **getNodeQueryResults**(term: `string`, options?: [`SearchOptions`](../../../lib/core/services/search.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets a list of nodes that match the given search criteria. - - _term:_ `string` - Term to search for - - _options:_ [`SearchOptions`](../../../lib/core/services/search.service.ts) - (Optional) Options for delivery of the search results - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes resulting from the search -- **search**(searchTerm: `string`, maxResults: `number`, skipCount: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`
+ * *term:* `string` - Term to search for + * *options:* [`SearchOptions`](../../../lib/core/services/search.service.ts) - (Optional) Options for delivery of the search results + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes resulting from the search +* **search**(searchTerm: `string`, maxResults: `number`, skipCount: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`
Performs a search. - - _searchTerm:_ `string` - Term to search for - - _maxResults:_ `number` - Maximum number of items in the list of results - - _skipCount:_ `number` - Number of higher-ranked items to skip over in the list - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - List of search results -- **searchByQueryBody**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`
+ * *searchTerm:* `string` - Term to search for + * *maxResults:* `number` - Maximum number of items in the list of results + * *skipCount:* `number` - Number of higher-ranked items to skip over in the list + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - List of search results +* **searchByQueryBody**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`
Performs a search with its parameters supplied by a QueryBody object. - - _queryBody:_ `QueryBody` - Object containing the search parameters - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - List of search results + * *queryBody:* `QueryBody` - Object containing the search parameters + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - List of search results ## Details See the [search method](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-search-rest-api/docs/SearchApi.md#search) in the Alfresco JS-API for the format of the query and returned data. -The [Search Configuration service](../services/search-configuration.service.md) +The [Search Configuration service](../services/search-configuration.service.md) has a method to generate the QueryBody object used by `searchByQueryBody`. The properties of the [`SearchOptions`](../../../lib/core/services/search.service.ts) interface are documented in source file comments. ## See also -- [Search Configuration service](../services/search-configuration.service.md) +* [Search Configuration service](../services/search-configuration.service.md) diff --git a/docs/core/services/shared-links-api.service.md b/docs/core/services/shared-links-api.service.md index 073cdd78da..4f4e93e67d 100644 --- a/docs/core/services/shared-links-api.service.md +++ b/docs/core/services/shared-links-api.service.md @@ -13,25 +13,25 @@ Finds shared links to Content Services items. ### Methods -- **createSharedLinks**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkEntry.md)`>`
+* **createSharedLinks**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkEntry.md)`>`
Creates a shared link available to the current user. - - _nodeId:_ `string` - ID of the node to link to - - _options:_ `any` - Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkEntry.md)`>` - The shared link just created -- **deleteSharedLink**(sharedId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *nodeId:* `string` - ID of the node to link to + * *options:* `any` - Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkEntry.md)`>` - The shared link just created +* **deleteSharedLink**(sharedId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a shared link. - - _sharedId:_ `string` - ID of the link to delete - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **getSharedLinks**(options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+ * *sharedId:* `string` - ID of the link to delete + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +* **getSharedLinks**(options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets shared links available to the current user. - - _options:_ `any` - Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of shared links + * *options:* `any` - Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of shared links ## Details Content Services allows users to generate URLs that can be shared with other people, even if they don't have a Content Services account. These -URLs are known as _shared links_. +URLs are known as *shared links*. Use `getSharedLinks` to find all the shared links that are available to the current user. You can supply a number of `options` to refine the diff --git a/docs/core/services/sites.service.md b/docs/core/services/sites.service.md index c95d93de4b..4ce1a51d7d 100644 --- a/docs/core/services/sites.service.md +++ b/docs/core/services/sites.service.md @@ -13,100 +13,100 @@ Accesses and manipulates sites from a Content Services repository. ### Methods -- **approveSiteMembershipRequest**(siteId: `string`, inviteeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>`
+* **approveSiteMembershipRequest**(siteId: `string`, inviteeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>`
Accept site membership requests. - - _siteId:_ `string` - The identifier of a site. - - _inviteeId:_ `string` - The invitee user name. - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>` - Null response notifying when the operation is complete -- **createSiteGroupMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>`
+ * *siteId:* `string` - The identifier of a site. + * *inviteeId:* `string` - The invitee user name. + * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>` - Null response notifying when the operation is complete +* **createSiteGroupMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>`
Create a site membership for group - - _siteId:_ `string` - The identifier of a site. - - _siteMembershipBodyCreate:_ [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md) - The Group to add and its role - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> -- **createSiteMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>`
+ * *siteId:* `string` - The identifier of a site. + * *siteMembershipBodyCreate:* [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md) - The Group to add and its role + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - Observable\ +* **createSiteMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>`
Creates a site membership for person **personId** on site **siteId**. - - _siteId:_ `string` - The identifier of a site - - _siteMembershipBodyCreate:_ [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md) - The person to add and their role - - _opts:_ `any` - (Optional) Optional parameters - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteMemberEntry> -- **deleteSite**(siteId: `string`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *siteId:* `string` - The identifier of a site + * *siteMembershipBodyCreate:* [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md) - The person to add and their role + * *opts:* `any` - (Optional) Optional parameters + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>` - Observable\ +* **deleteSite**(siteId: `string`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a site. - - _siteId:_ `string` - Site to delete - - _permanentFlag:_ `boolean` - True: deletion is permanent; False: site is moved to the trash - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **deleteSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *siteId:* `string` - Site to delete + * *permanentFlag:* `boolean` - True: deletion is permanent; False: site is moved to the trash + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +* **deleteSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Delete a group membership for site - - _siteId:_ `string` - The identifier of a site. - - _groupId:_ `string` - The authorityId of a group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - [`Observable`](http://reactivex.io/documentation/observable.html)<void> -- **deleteSiteMembership**(siteId: `string`, personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *siteId:* `string` - The identifier of a site. + * *groupId:* `string` - The authorityId of a group. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable\ +* **deleteSiteMembership**(siteId: `string`, personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Delete a site membership - - _siteId:_ `string` - The identifier of a site. - - _personId:_ `string` - The identifier of a person. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **getEcmCurrentLoggedUserName**(): `string`
+ * *siteId:* `string` - The identifier of a site. + * *personId:* `string` - The identifier of a person. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +* **getEcmCurrentLoggedUserName**(): `string`
Gets the username of the user currently logged into ACS. - - **Returns** `string` - Username string -- **getSite**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
+ * **Returns** `string` - Username string +* **getSite**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
Gets the details for a site. - - _siteId:_ `string` - ID of the target site - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>` - Information about the site -- **getSiteContent**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
+ * *siteId:* `string` - ID of the target site + * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>` - Information about the site +* **getSiteContent**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
Gets a site's content. - - _siteId:_ `string` - ID of the target site - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>` - Site content -- **getSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>`
+ * *siteId:* `string` - ID of the target site + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>` - Site content +* **getSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>`
Get information about site membership of group - - _siteId:_ `string` - The identifier of a site. - - _groupId:_ `string` - The authorityId of a group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> -- **getSiteMembers**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
+ * *siteId:* `string` - The identifier of a site. + * *groupId:* `string` - The authorityId of a group. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - Observable\ +* **getSiteMembers**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
Gets a list of all a site's members. - - _siteId:_ `string` - ID of the target site - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>` - Site members -- **getSiteMembershipRequests**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>`
+ * *siteId:* `string` - ID of the target site + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>` - Site members +* **getSiteMembershipRequests**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>`
Gets a list of site membership requests. - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>` - Site membership requests -- **getSiteNameFromNodePath**(node: [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)): `string`
+ * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>` - Site membership requests +* **getSiteNameFromNodePath**(node: [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)): `string`
Looks for a site inside the path of a [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) and returns its guid if it finds one. (return an empty string if no site is found) - - _node:_ [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to look for parent site - - **Returns** `string` - Site guid -- **getSites**(opts: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>`
+ * *node:* [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to look for parent site + * **Returns** `string` - Site guid +* **getSites**(opts: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>`
Gets a list of all sites in the repository. - - _opts:_ `any` - Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>` - List of sites -- **listSiteGroups**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>`
+ * *opts:* `any` - Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>` - List of sites +* **listSiteGroups**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>`
List group membership for site - - _siteId:_ `string` - The identifier of a site. - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupPaging> -- **listSiteMemberships**(siteId: `string`, opts: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`
+ * *siteId:* `string` - The identifier of a site. + * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>` - Observable\ +* **listSiteMemberships**(siteId: `string`, opts: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`
Gets a list of all a site's members. - - _siteId:_ `string` - ID of the target site - - _opts:_ `any` - Optional parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteMemberPaging> -- **rejectSiteMembershipRequest**(siteId: `string`, inviteeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>`
+ * *siteId:* `string` - ID of the target site + * *opts:* `any` - Optional parameters supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - Observable\ +* **rejectSiteMembershipRequest**(siteId: `string`, inviteeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>`
Reject site membership requests. - - _siteId:_ `string` - The identifier of a site. - - _inviteeId:_ `string` - The invitee user name. - - _opts:_ `any` - (Optional) Options supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>` - Null response notifying when the operation is complete -- **updateSiteGroupMembership**(siteId: `string`, groupId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>`
+ * *siteId:* `string` - The identifier of a site. + * *inviteeId:* `string` - The invitee user name. + * *opts:* `any` - (Optional) Options supported by JS-API + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>` - Null response notifying when the operation is complete +* **updateSiteGroupMembership**(siteId: `string`, groupId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>`
Update site membership of group - - _siteId:_ `string` - The identifier of a site. - - _groupId:_ `string` - The authorityId of a group. - - _siteMembershipBodyUpdate:_ [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md) - The group new role - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteGroupEntry> -- **updateSiteMembership**(siteId: `string`, personId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>`
+ * *siteId:* `string` - The identifier of a site. + * *groupId:* `string` - The authorityId of a group. + * *siteMembershipBodyUpdate:* [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md) - The group new role + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - Observable\ +* **updateSiteMembership**(siteId: `string`, personId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>`
Update a site membership - - _siteId:_ `string` - The identifier of a site. - - _personId:_ `string` - The identifier of a person. - - _siteMembershipBodyUpdate:_ [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md) - The persons new role - - _opts:_ `any` - (Optional) Optional parameters - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>` - [Observable](http://reactivex.io/documentation/observable.html)<SiteMemberEntry> + * *siteId:* `string` - The identifier of a site. + * *personId:* `string` - The identifier of a person. + * *siteMembershipBodyUpdate:* [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md) - The persons new role + * *opts:* `any` - (Optional) Optional parameters + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>` - Observable\ ## Details diff --git a/docs/core/services/storage.service.md b/docs/core/services/storage.service.md index bd8a7f3e0c..916947e6a6 100644 --- a/docs/core/services/storage.service.md +++ b/docs/core/services/storage.service.md @@ -13,23 +13,23 @@ Stores items in the form of key-value pairs. ### Methods -- **clear**()
+* **clear**()
Removes all currently stored items. -- **getItem**(key: `string`): `string|null`
+* **getItem**(key: `string`): `string|null`
Gets an item. - - _key:_ `string` - Key to identify the item - - **Returns** `string|null` - The item (if any) retrieved by the key -- **hasItem**(key: `string`): `boolean`
+ * *key:* `string` - Key to identify the item + * **Returns** `string|null` - The item (if any) retrieved by the key +* **hasItem**(key: `string`): `boolean`
Is any item currently stored under `key`? - - _key:_ `string` - Key identifying item to check - - **Returns** `boolean` - True if key retrieves an item, false otherwise -- **removeItem**(key: `string`)
+ * *key:* `string` - Key identifying item to check + * **Returns** `boolean` - True if key retrieves an item, false otherwise +* **removeItem**(key: `string`)
Removes a single item. - - _key:_ `string` - Key to identify the item -- **setItem**(key: `string`, data: `string`)
+ * *key:* `string` - Key to identify the item +* **setItem**(key: `string`, data: `string`)
Stores an item - - _key:_ `string` - Key to identify the item - - _data:_ `string` - Data to store + * *key:* `string` - Key to identify the item + * *data:* `string` - Data to store ## Details @@ -59,15 +59,15 @@ In order to achieve this, you will only need to set your app identifier under th ``` **Important note** -This identifier must be unique to the app to guarantee that it has its own storage. +This identifier must be unique to the app to guarantee that it has its own storage. ### SSO storagePrefix related scenario The storagePrefix can allow you to login with multiple user in the same browser only if: - \- Or You don't use the implicit flow - \- Or You use implicit flow you use different AIMS instances for any app +\- Or You don't use the implicit flow +\- Or You use implicit flow you use different AIMS instances for any app ## See also -- [Cookie service](cookie.service.md) -- [Content service](content.service.md) +* [Cookie service](cookie.service.md) +* [Content service](content.service.md) diff --git a/docs/core/services/thumbnail.service.md b/docs/core/services/thumbnail.service.md index 0afae9895b..2f2aa71081 100644 --- a/docs/core/services/thumbnail.service.md +++ b/docs/core/services/thumbnail.service.md @@ -13,19 +13,19 @@ Retrieves an SVG thumbnail image to represent a document type. ### Methods -- **getDefaultMimeTypeIcon**(): `string`
+* **getDefaultMimeTypeIcon**(): `string`
Gets a "miscellaneous" thumbnail URL for types with no other icon defined. - - **Returns** `string` - URL string -- **getDocumentThumbnailUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string`, attachment?: `boolean`, ticket?: `string`): `string`
+ * **Returns** `string` - URL string +* **getDocumentThumbnailUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string`, attachment?: `boolean`, ticket?: `string`): `string`
Gets a thumbnail URL for the given document node. - - _node:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string` - Node or Node ID to get URL for. - - _attachment:_ `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download - - _ticket:_ `string` - (Optional) Custom ticket to use for authentication - - **Returns** `string` - URL string -- **getMimeTypeIcon**(mimeType: `string`): `string`
+ * *node:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`|string` - Node or Node ID to get URL for. + * *attachment:* `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download + * *ticket:* `string` - (Optional) Custom ticket to use for authentication + * **Returns** `string` - URL string +* **getMimeTypeIcon**(mimeType: `string`): `string`
Gets a thumbnail URL for a MIME type. - - _mimeType:_ `string` - MIME type for the thumbnail - - **Returns** `string` - URL string + * *mimeType:* `string` - MIME type for the thumbnail + * **Returns** `string` - URL string ## Details @@ -53,7 +53,7 @@ and icons is shown in the table below: ### Mat-icon All the ADF icons for MIME types are now registered into the [`MatIconRegistry`](https://material.angular.io/components/icon/api), so you can use all -the icons via the <mat-icon> tag: +the icons via the \ tag: ```javascript import { ThumbnailService } from '@alfresco/adf-core'; @@ -71,4 +71,4 @@ GIF ## See also -- [Mime type icon pipe](../pipes/mime-type-icon.pipe.md) +* [Mime type icon pipe](../pipes/mime-type-icon.pipe.md) diff --git a/docs/core/services/translation.service.md b/docs/core/services/translation.service.md index 884a07958b..c4bd61657c 100644 --- a/docs/core/services/translation.service.md +++ b/docs/core/services/translation.service.md @@ -13,31 +13,31 @@ Supports localisation. ### Methods -- **addTranslationFolder**(name: `string` = `""`, path: `string` = `""`)
+* **addTranslationFolder**(name: `string` = `""`, path: `string` = `""`)
Adds a new folder of translation source files. - - _name:_ `string` - Name for the translation provider - - _path:_ `string` - Path to the folder -- **get**(key: `string|Array`, interpolateParams?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *name:* `string` - Name for the translation provider + * *path:* `string` - Path to the folder +* **get**(key: `string|Array`, interpolateParams?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the translation for the supplied key. - - _key:_ `string|Array` - Key to translate - - _interpolateParams:_ `Object` - (Optional) String(s) to be interpolated into the main message - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Translated text -- **instant**(key: `string|Array`, interpolateParams?: `Object`): `string|any`
+ * *key:* `string|Array` - Key to translate + * *interpolateParams:* `Object` - (Optional) String(s) to be interpolated into the main message + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Translated text +* **instant**(key: `string|Array`, interpolateParams?: `Object`): `string|any`
Directly returns the translation for the supplied key. - - _key:_ `string|Array` - Key to translate - - _interpolateParams:_ `Object` - (Optional) String(s) to be interpolated into the main message - - **Returns** `string|any` - Translated text -- **loadTranslation**(lang: `string`, fallback?: `string`)
+ * *key:* `string|Array` - Key to translate + * *interpolateParams:* `Object` - (Optional) String(s) to be interpolated into the main message + * **Returns** `string|any` - Translated text +* **loadTranslation**(lang: `string`, fallback?: `string`)
Loads a translation file. - - _lang:_ `string` - Language code for the language to load - - _fallback:_ `string` - (Optional) Language code to fall back to if the first one was unavailable -- **onTranslationChanged**(lang: `string`)
+ * *lang:* `string` - Language code for the language to load + * *fallback:* `string` - (Optional) Language code to fall back to if the first one was unavailable +* **onTranslationChanged**(lang: `string`)
Triggers a notification callback when the translation language changes. - - _lang:_ `string` - The new language code -- **use**(lang: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *lang:* `string` - The new language code +* **use**(lang: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Sets the target language for translations. - - _lang:_ `string` - Code name for the language - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Translations available for the language + * *lang:* `string` - Code name for the language + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Translations available for the language ## Details @@ -180,4 +180,4 @@ class MyComponent { ## See Also -- [Internationalization](../../user-guide/internationalization.md) +* [Internationalization](../../user-guide/internationalization.md) diff --git a/docs/core/services/upload.service.md b/docs/core/services/upload.service.md index d6cbc8ba24..72747875ec 100644 --- a/docs/core/services/upload.service.md +++ b/docs/core/services/upload.service.md @@ -13,28 +13,28 @@ Provides access to various APIs related to file upload features. ### Methods -- **addToQueue**(files: [`FileModel`](../../../lib/core/models/file.model.ts)`[]`): [`FileModel`](../../../lib/core/models/file.model.ts)`[]`
+* **addToQueue**(files: [`FileModel`](../../../lib/core/models/file.model.ts)`[]`): [`FileModel`](../../../lib/core/models/file.model.ts)`[]`
Adds files to the uploading queue to be uploaded - - _files:_ [`FileModel`](../../../lib/core/models/file.model.ts)`[]` - One or more separate parameters or an array of files to queue - - **Returns** [`FileModel`](../../../lib/core/models/file.model.ts)`[]` - Array of files that were not blocked from upload by the ignore list -- **cancelUpload**(files: [`FileModel`](../../../lib/core/models/file.model.ts)`[]`)
+ * *files:* [`FileModel`](../../../lib/core/models/file.model.ts)`[]` - One or more separate parameters or an array of files to queue + * **Returns** [`FileModel`](../../../lib/core/models/file.model.ts)`[]` - Array of files that were not blocked from upload by the ignore list +* **cancelUpload**(files: [`FileModel`](../../../lib/core/models/file.model.ts)`[]`)
Cancels uploading of files. If the file is smaller than 1 MB the file will be uploaded and then the node deleted to prevent having files that were aborted but still uploaded. - - _files:_ [`FileModel`](../../../lib/core/models/file.model.ts)`[]` - One or more separate parameters or an array of files specifying uploads to cancel -- **clearQueue**()
+ * *files:* [`FileModel`](../../../lib/core/models/file.model.ts)`[]` - One or more separate parameters or an array of files specifying uploads to cancel +* **clearQueue**()
Clears the upload queue -- **getQueue**(): [`FileModel`](../../../lib/core/models/file.model.ts)`[]`
+* **getQueue**(): [`FileModel`](../../../lib/core/models/file.model.ts)`[]`
Gets the file Queue - - **Returns** [`FileModel`](../../../lib/core/models/file.model.ts)`[]` - Array of files that form the queue -- **getUploadPromise**(file: [`FileModel`](../../../lib/core/models/file.model.ts)): `any`
+ * **Returns** [`FileModel`](../../../lib/core/models/file.model.ts)`[]` - Array of files that form the queue +* **getUploadPromise**(file: [`FileModel`](../../../lib/core/models/file.model.ts)): `any`
Gets an upload promise for a file. - - _file:_ [`FileModel`](../../../lib/core/models/file.model.ts) - The target file - - **Returns** `any` - [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises) that is resolved if the upload is successful or error otherwise -- **isUploading**(): `boolean`
+ * *file:* [`FileModel`](../../../lib/core/models/file.model.ts) - The target file + * **Returns** `any` - [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises) that is resolved if the upload is successful or error otherwise +* **isUploading**(): `boolean`
Checks whether the service is uploading a file. - - **Returns** `boolean` - True if a file is uploading, false otherwise -- **uploadFilesInTheQueue**(emitter?: [`EventEmitter`](https://angular.io/api/core/EventEmitter)``)
+ * **Returns** `boolean` - True if a file is uploading, false otherwise +* **uploadFilesInTheQueue**(emitter?: [`EventEmitter`](https://angular.io/api/core/EventEmitter)``)
Finds all the files in the queue that are not yet uploaded and uploads them into the directory folder. - - _emitter:_ [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` - (Optional) Emitter to invoke on file status change + * *emitter:* [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` - (Optional) Emitter to invoke on file status change ## Events @@ -108,5 +108,5 @@ From vesion 3.8.0 It's possible filter also for the folder whilst uploading a w } ``` -In this way all the files present in the .git folder won't be uploaded. +In this way all the files present in the .git folder won't be uploaded. Please note that the filtering options available for the folders is the same as the one for the files. diff --git a/docs/core/services/user-preferences.service.md b/docs/core/services/user-preferences.service.md index e4f4026656..a7a579f7cb 100644 --- a/docs/core/services/user-preferences.service.md +++ b/docs/core/services/user-preferences.service.md @@ -13,40 +13,40 @@ Stores preferences for the app and for individual components. ### Methods -- **get**(property: `string`, defaultValue?: `string`): `string`
+* **get**(property: `string`, defaultValue?: `string`): `string`
Gets a preference property. - - _property:_ `string` - Name of the property - - _defaultValue:_ `string` - (Optional) Default to return if the property is not found - - **Returns** `string` - Preference property -- **getDefaultLocale**(): `string`
+ * *property:* `string` - Name of the property + * *defaultValue:* `string` - (Optional) Default to return if the property is not found + * **Returns** `string` - Preference property +* **getDefaultLocale**(): `string`
Gets the default locale. - - **Returns** `string` - Default locale language code -- **getPropertyKey**(property: `string`): `string`
+ * **Returns** `string` - Default locale language code +* **getPropertyKey**(property: `string`): `string`
Gets the full property key with prefix. - - _property:_ `string` - The property name - - **Returns** `string` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) key -- **getStoragePrefix**(): `string`
+ * *property:* `string` - The property name + * **Returns** `string` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) key +* **getStoragePrefix**(): `string`
Gets the active storage prefix for preferences. - - **Returns** `string` - Storage prefix -- **hasItem**(property: `string`): `boolean`
+ * **Returns** `string` - Storage prefix +* **hasItem**(property: `string`): `boolean`
Check if an item is present in the storage - - _property:_ `string` - Name of the property - - **Returns** `boolean` - True if the item is present, false otherwise -- **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *property:* `string` - Name of the property + * **Returns** `boolean` - True if the item is present, false otherwise +* **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Sets up a callback to notify when a property has changed. - - _property:_ `string` - The property to watch - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Notification callback -- **set**(property: `string`, value: `any`)
+ * *property:* `string` - The property to watch + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Notification callback +* **set**(property: `string`, value: `any`)
Sets a preference property. - - _property:_ `string` - Name of the property - - _value:_ `any` - New value for the property -- **setStoragePrefix**(value: `string`)
+ * *property:* `string` - Name of the property + * *value:* `any` - New value for the property +* **setStoragePrefix**(value: `string`)
Sets the active storage prefix for preferences. - - _value:_ `string` - Name of the prefix -- **setWithoutStore**(property: `string`, value: `any`)
+ * *value:* `string` - Name of the prefix +* **setWithoutStore**(property: `string`, value: `any`)
Sets a preference property. - - _property:_ `string` - Name of the property - - _value:_ `any` - New value for the property + * *property:* `string` - Name of the property + * *value:* `any` - New value for the property ## Details diff --git a/docs/core/widgets/content.widget.md b/docs/core/widgets/content.widget.md index f00cd495d0..b971d5f6c4 100644 --- a/docs/core/widgets/content.widget.md +++ b/docs/core/widgets/content.widget.md @@ -20,16 +20,16 @@ Shows the content preview. ### Properties -| Name | Type | Default value | Description | -| ------------------- | --------- | ------------- | --------------------------------- | -| id | `string` | | The content id to show. | -| showDocumentContent | `boolean` | true | Toggles showing document content. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| id | `string` | | The content id to show. | +| showDocumentContent | `boolean` | true | Toggles showing document content. | ### Events -| Name | Type | Description | -| --------------- | ----------------------------------------------------------------- | -------------------------------------- | -| contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content is clicked. | -| contentLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content has loaded. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| thumbnailLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the thumbnail has loaded. | +| Name | Type | Description | +| --- | --- | --- | +| contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content is clicked. | +| contentLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the content has loaded. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| thumbnailLoaded | `EventEmitter` | Emitted when the thumbnail has loaded. | diff --git a/docs/extensions/components/dynamic.component.md b/docs/extensions/components/dynamic.component.md index ff37d9d7c7..8bb4fd6209 100644 --- a/docs/extensions/components/dynamic.component.md +++ b/docs/extensions/components/dynamic.component.md @@ -13,10 +13,10 @@ Displays dynamically-loaded extension components. ### Properties -| Name | Type | Default value | Description | -| ---- | -------- | ------------- | --------------------------------------------------- | -| data | `any` | | Data for the dynamically-loaded component instance. | -| id | `string` | | Unique ID string for the component to show. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| data | `any` | | Data for the dynamically-loaded component instance. | +| id | `string` | | Unique ID string for the component to show. | ## Details @@ -54,4 +54,4 @@ simply by registering that class with `setComponents` before use. ## See also -- [Extension service](../services/extension.service.md) +* [Extension service](../services/extension.service.md) diff --git a/docs/extensions/components/preview-extension.component.md b/docs/extensions/components/preview-extension.component.md index 148d53c1a8..050f99efae 100644 --- a/docs/extensions/components/preview-extension.component.md +++ b/docs/extensions/components/preview-extension.component.md @@ -16,12 +16,12 @@ an example of a real working viewer extension project. ### Properties -| Name | Type | Default value | Description | -| --------- | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| extension | `string` | | File extension (.jpg, .png, etc) for the viewer. | -| id | `string` | | ID string of the component to preview. | -| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) containing the content to display. | -| url | `string` | | URL of the content in the repository. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| extension | `string` | | File extension (.jpg, .png, etc) for the viewer. | +| id | `string` | | ID string of the component to preview. | +| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) containing the content to display. | +| url | `string` | | URL of the content in the repository. | ## Details @@ -101,5 +101,5 @@ further details of how to develop extensions. ## See also -- [Extension service](../services/extension.service.md) -- [App extensions](../../user-guide/app-extensions.md) +* [Extension service](../services/extension.service.md) +* [App extensions](../../user-guide/app-extensions.md) diff --git a/docs/extensions/services/extension.service.md b/docs/extensions/services/extension.service.md index 618961b623..2a0588c1a3 100644 --- a/docs/extensions/services/extension.service.md +++ b/docs/extensions/services/extension.service.md @@ -13,64 +13,64 @@ Manages and runs basic extension functionality. ### Methods -- **evaluateRule**(ruleId: `string`, context?: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`
+* **evaluateRule**(ruleId: `string`, context?: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`
Evaluates a rule. - - _ruleId:_ `string` - ID of the rule to evaluate - - _context:_ [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - (Optional) Custom rule execution context. - - **Returns** `boolean` - True if the rule passed, false otherwise -- **getActionById**(id: `string`): [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts)
+ * *ruleId:* `string` - ID of the rule to evaluate + * *context:* [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - (Optional) Custom rule execution context. + * **Returns** `boolean` - True if the rule passed, false otherwise +* **getActionById**(id: `string`): [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts)
Retrieves an action using its ID value. - - _id:_ `string` - The ID value to look for - - **Returns** [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts) - Action or null if not found -- **getAuthGuards**(ids: `string[]`): `Array>`
+ * *id:* `string` - The ID value to look for + * **Returns** [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts) - Action or null if not found +* **getAuthGuards**(ids: `string[]`): `Array>`
Retrieves one or more auth guards using an array of ID values. - - _ids:_ `string[]` - Array of ID value to look for - - **Returns** `Array>` - Array of auth guards or empty array if none were found -- **getComponentById**(id: `string`): `Type<>`
+ * *ids:* `string[]` - Array of ID value to look for + * **Returns** `Array>` - Array of auth guards or empty array if none were found +* **getComponentById**(id: `string`): `Type<>`
Retrieves a registered [extension component](../../../lib/extensions/src/lib/services/component-register.service.ts) using its ID value. - - _id:_ `string` - The ID value to look for - - **Returns** `Type<>` - The component or null if not found -- **getElements**(key: `string`, fallback: `Array<>` = `[]`): `Array<>`
+ * *id:* `string` - The ID value to look for + * **Returns** `Type<>` - The component or null if not found +* **getElements**(key: `string`, fallback: `Array<>` = `[]`): `Array<>`
- - _key:_ `string` - - - _fallback:_ `Array<>` - - - **Returns** `Array<>` - -- **getEvaluator**(key: `string`): [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts)
+ * *key:* `string` - + * *fallback:* `Array<>` - + * **Returns** `Array<>` - +* **getEvaluator**(key: `string`): [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts)
Retrieves a [RuleEvaluator](../../../lib/extensions/src/lib/config/rule.extensions.ts) function using its key name. - - _key:_ `string` - Key name to look for - - **Returns** [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - [RuleEvaluator](../../../lib/extensions/src/lib/config/rule.extensions.ts) or null if not found -- **getFeature**(key: `string`): `any[]`
+ * *key:* `string` - Key name to look for + * **Returns** [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - [RuleEvaluator](../../../lib/extensions/src/lib/config/rule.extensions.ts) or null if not found +* **getFeature**(key: `string`): `any[]`
Gets features by key. - - _key:_ `string` - Key string, using dot notation - - **Returns** `any[]` - Features array found by key -- **getRouteById**(id: `string`): [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts)
+ * *key:* `string` - Key string, using dot notation + * **Returns** `any[]` - Features array found by key +* **getRouteById**(id: `string`): [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts)
Retrieves a route using its ID value. - - _id:_ `string` - The ID value to look for - - **Returns** [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts) - The route or null if not found -- **getRuleById**(id: `string`): [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts)
+ * *id:* `string` - The ID value to look for + * **Returns** [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts) - The route or null if not found +* **getRuleById**(id: `string`): [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts)
Retrieves a rule using its ID value. - - _id:_ `string` - The ID value to look for - - **Returns** [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - The rule or null if not found -- **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>`
+ * *id:* `string` - The ID value to look for + * **Returns** [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - The rule or null if not found +* **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>`
Loads and registers an extension config file and plugins (specified by path properties). - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>` - The loaded config data -- **runExpression**(value: `string|Function`, context?: `any`): `Function`
+ * **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>` - The loaded config data +* **runExpression**(value: `string|Function`, context?: `any`): `Function`
Runs a lightweight expression stored in a string. - - _value:_ `string|Function` - String containing the expression or literal value - - _context:_ `any` - (Optional) Parameter object for the expression with details of app state - - **Returns** `Function` - Result of evaluated expression, if found, or the literal value otherwise -- **setAuthGuards**(values: `Function`)
+ * *value:* `string|Function` - String containing the expression or literal value + * *context:* `any` - (Optional) Parameter object for the expression with details of app state + * **Returns** `Function` - Result of evaluated expression, if found, or the literal value otherwise +* **setAuthGuards**(values: `Function`)
Adds one or more new auth guards to the existing set. - - _values:_ `Function` - The new auth guards to add -- **setComponents**(values: `Function`)
+ * *values:* `Function` - The new auth guards to add +* **setComponents**(values: `Function`)
Adds one or more new components to the existing set. - - _values:_ `Function` - The new components to add -- **setEvaluators**(values: `Function`)
+ * *values:* `Function` - The new components to add +* **setEvaluators**(values: `Function`)
Adds one or more new rule evaluators to the existing set. - - _values:_ `Function` - The new evaluators to add -- **setup**(config: [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts))
+ * *values:* `Function` - The new evaluators to add +* **setup**(config: [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts))
Registers extensions from a config object. - - _config:_ [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts) - Object with config data + * *config:* [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts) - Object with config data ## Details diff --git a/docs/insights/components/analytics-generator.component.md b/docs/insights/components/analytics-generator.component.md index cf92b9f8c9..39cc72dbf3 100644 --- a/docs/insights/components/analytics-generator.component.md +++ b/docs/insights/components/analytics-generator.component.md @@ -21,14 +21,14 @@ Generates and shows charts ### Properties -| Name | Type | Default value | Description | -| ---------------- | ------------------------------------------------------------------------------------------ | ------------- | ----------------- | -| reportId | `number` | | reportId. | -| reportParamQuery | [`ReportQuery`](../../../lib/insights/src/lib/diagram/models/report/report-query.model.ts) | undefined | reportParamQuery. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| reportId | `number` | | reportId. | +| reportParamQuery | [`ReportQuery`](../../../lib/insights/src/lib/diagram/models/report/report-query.model.ts) | undefined | reportParamQuery. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/insights/components/analytics-report-list.component.md b/docs/insights/components/analytics-report-list.component.md index 24bb4c1903..93278decba 100644 --- a/docs/insights/components/analytics-report-list.component.md +++ b/docs/insights/components/analytics-report-list.component.md @@ -20,16 +20,16 @@ Shows a list of all available reports ### Properties -| Name | Type | Default value | Description | -| ----------- | --------- | ------------- | --------------------------- | -| appId | `number` | | appId ID of the target app. | -| layoutType | `string` | | layout Type LIST or GRID. | -| selectFirst | `boolean` | false | selectFirst. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appId | `number` | | appId ID of the target app. | +| layoutType | `string` | | layout Type LIST or GRID. | +| selectFirst | `boolean` | false | selectFirst. | ### Events -| Name | Type | Description | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | | reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../../lib/insights/src/lib/diagram/models/report/report-parameters.model.ts)`>` | report Click. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | +| success | `EventEmitter` | success. | diff --git a/docs/insights/components/analytics.component.md b/docs/insights/components/analytics.component.md index be89e87690..d3f15b184a 100644 --- a/docs/insights/components/analytics.component.md +++ b/docs/insights/components/analytics.component.md @@ -23,16 +23,16 @@ Shows the charts related to the reportId passed as input ### Properties -| Name | Type | Default value | Description | -| -------------- | --------- | ------------- | --------------------------- | -| appId | `number` | | appId ID of the target app. | -| hideParameters | `boolean` | false | hideParameters. | -| reportId | `number` | | reportId. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appId | `number` | | appId ID of the target app. | +| hideParameters | `boolean` | false | hideParameters. | +| reportId | `number` | | reportId. | ### Events -| Name | Type | Description | -| ------------- | ----------------------------------------------------------------- | --------------------------- | -| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when editReport. | +| Name | Type | Description | +| --- | --- | --- | +| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when editReport. | | reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when reportDeleted. | -| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | emitted when reportSaved. | +| reportSaved | `EventEmitter` | emitted when reportSaved. | diff --git a/docs/insights/components/diagram.component.md b/docs/insights/components/diagram.component.md index ef24c82af2..fe2ac45619 100644 --- a/docs/insights/components/diagram.component.md +++ b/docs/insights/components/diagram.component.md @@ -30,19 +30,19 @@ The below component shows the diagram of a running process instance with the act ### Properties -| Name | Type | Default value | Description | -| ------------------- | -------- | ------------- | -------------------- | -| height | `number` | 500 | height. | -| metricColor | `any` | | metricColor. | -| metricPercentages | `any` | | metricPercentages. | -| metricType | `string` | "" | metricType. | -| processDefinitionId | `any` | | processDefinitionId. | -| processInstanceId | `any` | | processInstanceId. | -| width | `number` | 1000 | width. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| height | `number` | 500 | height. | +| metricColor | `any` | | metricColor. | +| metricPercentages | `any` | | metricPercentages. | +| metricType | `string` | "" | metricType. | +| processDefinitionId | `any` | | processDefinitionId. | +| processInstanceId | `any` | | processInstanceId. | +| width | `number` | 1000 | width. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | error. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | success. | diff --git a/docs/insights/components/widget.component.md b/docs/insights/components/widget.component.md index b2f19bc972..722012fe33 100644 --- a/docs/insights/components/widget.component.md +++ b/docs/insights/components/widget.component.md @@ -28,14 +28,14 @@ export class CustomEditorComponent extends WidgetComponent {} ### Properties -| Name | Type | Default value | Description | -| ----- | ----- | ------------- | ----------- | -| field | `any` | | field. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| field | `any` | | field. | ### Events -| Name | Type | Description | -| ------------ | ----------------------------------------------------------------- | ------------- | +| Name | Type | Description | +| --- | --- | --- | | fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | fieldChanged. | ## Details @@ -46,4 +46,4 @@ implementing custom widgets. ## See also -- [Extensibility](../../user-guide/extensibility.md) +* [Extensibility](../../user-guide/extensibility.md) diff --git a/docs/process-services-cloud/components/app-list-cloud.component.md b/docs/process-services-cloud/components/app-list-cloud.component.md index 885b5860eb..18ea2cfd13 100644 --- a/docs/process-services-cloud/components/app-list-cloud.component.md +++ b/docs/process-services-cloud/components/app-list-cloud.component.md @@ -45,12 +45,12 @@ For example : ### Properties -| Name | Type | Default value | Description | -| ---------- | -------- | ------------- | ------------------------------------------------------------------------------------------------ | -| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | ### Events -| Name | Type | Description | -| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`>` | Emitted when an app entry is clicked. | diff --git a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md index fc6bc14a5f..7d604ce968 100644 --- a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md @@ -13,17 +13,17 @@ Shows/edits process filter details. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Editing APS2 process filters](#editing-aps2-process-filters) - - [Filter properties](#filter-properties) - - [Sort properties](#sort-properties) - - [Action properties](#action-properties) -- [Saving custom filters](#saving-custom-filters) -- [See also](#see-also) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Editing APS2 process filters](#editing-aps2-process-filters) + * [Filter properties](#filter-properties) + * [Sort properties](#sort-properties) + * [Action properties](#action-properties) +* [Saving custom filters](#saving-custom-filters) +* [See also](#see-also) ## Basic Usage @@ -41,24 +41,24 @@ Shows/edits process filter details. ### Properties -| Name | Type | Default value | Description | -| --------------------- | ---------- | ------------- | --------------------------------------------------- | -| actions | `string[]` | | List of sort actions. | -| appName | `string` | "" | The name of the application. | -| filterProperties | `string[]` | | List of process filter properties to display | -| id | `string` | | Id of the process instance filter. | -| role | `string` | "" | roles to filter the apps | -| showFilterActions | `boolean` | true | Toggles editing of process filter actions. | -| showProcessFilterName | `boolean` | true | Toggles the appearance of the process filter name . | -| showTitle | `boolean` | true | Toggles editing of the process filter title. | -| sortProperties | `string[]` | | List of sort properties to display. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| actions | `string[]` | | List of sort actions. | +| appName | `string` | "" | The name of the application. | +| filterProperties | `string[]` | | List of process filter properties to display | +| id | `string` | | Id of the process instance filter. | +| role | `string` | "" | roles to filter the apps | +| showFilterActions | `boolean` | true | Toggles editing of process filter actions. | +| showProcessFilterName | `boolean` | true | Toggles the appearance of the process filter name . | +| showTitle | `boolean` | true | Toggles editing of the process filter title. | +| sortProperties | `string[]` | | List of sort properties to display. | ### Events -| Name | Type | Description | -| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | -| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterAction`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. | -| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a process instance filter property changes. | +| Name | Type | Description | +| --- | --- | --- | +| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterAction`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. | +| filterChange | `EventEmitter` | Emitted when a process instance filter property changes. | ## Details @@ -75,28 +75,28 @@ Use the `appName` and `id` properties to choose which process filter to edit: ### Filter properties -You can supply various _filter properties_ to edit. These will determine +You can supply various *filter properties* to edit. These will determine which processes are found by a filter. The full set of properties is given below: | Name | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| **_appName_** | Name of the app | -| **_id_** | Process instance ID | -| **_name_** | Process name. | -| **_initiator_** | ID of the user who initiated the process | -| **_status_** | Execution status of the process. | -| **_processDefinitionId_** | Process definition ID | -| **_processDefinitionKey_** | Process definition key | -| **_lastModified_** | Date the process was last modified. If lastModified defined the component will show the range **_lastModifiedTo_**, **_lastModifiedFrom_** | -| **_sort_** | Field on which the filter results will be sorted. Can be "id", "name", "status", "startDate". | -| **_order_** | Sort ordering of the filter results (this doesn't participate in the filtering itself) | +| ***appName*** | Name of the app | +| ***id*** | Process instance ID | +| ***name*** | Process name. | +| ***initiator*** | ID of the user who initiated the process | +| ***status*** | Execution status of the process. | +| ***processDefinitionId*** | Process definition ID | +| ***processDefinitionKey*** | Process definition key | +| ***lastModified*** | Date the process was last modified. If lastModified defined the component will show the range ***lastModifiedTo***, ***lastModifiedFrom*** | +| ***sort*** | Field on which the filter results will be sorted. Can be "id", "name", "status", "startDate". | +| ***order*** | Sort ordering of the filter results (this doesn't participate in the filtering itself) | -By default, the **_status_**, **_sort_** and **_order_** properties are +By default, the ***status***, ***sort*** and ***order*** properties are displayed in the editor. However, you can also choose which properties to show using the `filterProperties` array. -For example, the code below initializes the editor with the **_appName_**, -**_id_**, **_name_** and **_lastModified_** properties: +For example, the code below initializes the editor with the ***appName***, +***id***, ***name*** and ***lastModified*** properties: ```ts export class SomeComponent implements OnInit { @@ -129,14 +129,14 @@ With this configuration, only the four listed properties will be shown. ### Sort properties -You can supply a list of _sort properties_ to sort the processes. You can use +You can supply a list of *sort properties* to sort the processes. You can use any of the [filter properties](#filter-properties) listed above as -sort properties and you can also use the process's **_startDate_**. +sort properties and you can also use the process's ***startDate***. -By default, the **_id_**, **_name_**, **_status_** and **_startDate_** properties are +By default, the ***id***, ***name***, ***status*** and ***startDate*** properties are displayed in the editor. However, you can also choose which sort properties to show using the `sortProperties` array. -For example, the code below initializes the editor with the **_startDate_** and **_lastModified_** properties: +For example, the code below initializes the editor with the ***startDate*** and ***lastModified*** properties: ```ts export class SomeComponent implements OnInit { @@ -166,18 +166,18 @@ With this configuration, only the two listed sort properties will be shown. ### Action properties -You can supply various _actions_ to apply on process filter. +You can supply various *actions* to apply on process filter. | Name | Description | | ------------ | ----------------------------- | -| **_save_** | Save process filter. | -| **_saveAs_** | Creates a new process filter. | -| **_delete_** | Delete process filter. | +| ***save*** | Save process filter. | +| ***saveAs*** | Creates a new process filter. | +| ***delete*** | Delete process filter. | -By default, the **_save_**, **_saveAs_** and **_delete_** actions are +By default, the ***save***, ***saveAs*** and ***delete*** actions are displayed in the editor. However, you can also choose which actions to show using the `actions` array. -For example, the code below initializes the editor with the **_save_** and **_delete_** actions: +For example, the code below initializes the editor with the ***save*** and ***delete*** actions: ```ts export class SomeComponent implements OnInit { @@ -205,15 +205,15 @@ With this configuration, only the two actions will be shown. ## Saving custom filters -Users can save a filter if they make any changes to it in an application using the **Save** icon. How it is saved is dictated by the Activiti version used: +Users can save a filter if they make any changes to it in an application using the **Save** icon. How it is saved is dictated by the Activiti version used: -- An Activiti 7 community version stores saved filters in the local browser storage. This restricts a user's custom filters to that single session. +* An Activiti 7 community version stores saved filters in the local browser storage. This restricts a user's custom filters to that single session. -- An Activiti Enterprise version uses the preference service to store saved filters. This allows for user's custom filters to be available between sessions and between devices. +* An Activiti Enterprise version uses the preference service to store saved filters. This allows for user's custom filters to be available between sessions and between devices. ## See also -- [Edit task filter cloud component](edit-task-filter-cloud.component.md) -- [Process Filter Cloud Service](../services/process-filter-cloud.service.md) -- [Local preference Cloud Service](../services/local-preference-cloud.service.md) -- [User preference Cloud Service](../services/user-preference-cloud.service.md) +* [Edit task filter cloud component](edit-task-filter-cloud.component.md) +* [Process Filter Cloud Service](../services/process-filter-cloud.service.md) +* [Local preference Cloud Service](../services/local-preference-cloud.service.md) +* [User preference Cloud Service](../services/user-preference-cloud.service.md) diff --git a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md index ab0cc4438f..c2a77f1159 100644 --- a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md @@ -13,17 +13,17 @@ Edits task filter details. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Editing APS2 task filters](#editing-aps2-task-filters) - - [Filter properties](#filter-properties) - - [Sort properties](#sort-properties) - - [Action properties](#action-properties) -- [Saving custom filters](#saving-custom-filters) -- [See also](#see-also) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Editing APS2 task filters](#editing-aps2-task-filters) + * [Filter properties](#filter-properties) + * [Sort properties](#sort-properties) + * [Action properties](#action-properties) +* [Saving custom filters](#saving-custom-filters) +* [See also](#see-also) ## Basic Usage @@ -41,24 +41,24 @@ Edits task filter details. ### Properties -| Name | Type | Default value | Description | -| ------------------ | ---------- | ------------- | ------------------------------------------ | -| actions | `string[]` | | List of task filter actions. | -| appName | `string` | "" | (required) Name of the app. | -| filterProperties | `string[]` | \[] | List of task filter properties to display. | -| id | `string` | | (required) ID of the task filter. | -| role | `string` | "" | user role. | -| showFilterActions | `boolean` | true | Toggles the filter actions. | -| showTaskFilterName | `boolean` | true | Toggles display of task filter name | -| showTitle | `boolean` | true | Toggles the title. | -| sortProperties | `string[]` | \[] | List of sort properties to display. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| actions | `string[]` | | List of task filter actions. | +| appName | `string` | "" | (required) Name of the app. | +| filterProperties | `string[]` | \[] | List of task filter properties to display. | +| id | `string` | | (required) ID of the task filter. | +| role | `string` | "" | user role. | +| showFilterActions | `boolean` | true | Toggles the filter actions. | +| showTaskFilterName | `boolean` | true | Toggles display of task filter name | +| showTitle | `boolean` | true | Toggles the title. | +| sortProperties | `string[]` | \[] | List of sort properties to display. | ### Events -| Name | Type | Description | -| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- | -| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterAction`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). | -| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a task filter property changes. | +| Name | Type | Description | +| --- | --- | --- | +| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterAction`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). | +| filterChange | `EventEmitter<>` | Emitted when a task filter property changes. | ## Details @@ -75,33 +75,33 @@ Use the `appName` and `id` properties to choose which task filter to edit: ### Filter properties -You can supply various _filter properties_ to edit that will determine +You can supply various *filter properties* to edit that will determine which tasks are found by a filter. The full set of properties is given below: | Name | Description | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **_appName_** | Name of the app | -| **_status_** | Execution state of the task. | -| **_assignee_** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) the task is assigned to | -| **_taskName_** | Name of the task | -| **_taskId_** | ID of the task | -| **_parentTaskId_** | ID of the task's parent task | -| **_priority_** | Task priority | -| **_createdDate_** | Date the task was created | -| **_standalone_** | Standalone status of the task | -| **_owner_** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) ID of the task's owner | -| **_processDefinitionId_** | Process definition ID | -| **_processInstanceId_** | Process instance ID | -| **_lastModified_** | Date the task was last modified. If lastModified defined the component will show the range **_lastModifiedFrom_**, **_lastModifiedTo_** | -| **_sort_** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "createdDate", "priority", "processDefinitionId". | -| **_order_** | Sort ordering of the filter results it can be ASC or DESC (doesn't participate in the filtering itself). | +| ***appName*** | Name of the app | +| ***status*** | Execution state of the task. | +| ***assignee*** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) the task is assigned to | +| ***taskName*** | Name of the task | +| ***taskId*** | ID of the task | +| ***parentTaskId*** | ID of the task's parent task | +| ***priority*** | Task priority | +| ***createdDate*** | Date the task was created | +| ***standalone*** | Standalone status of the task | +| ***owner*** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) ID of the task's owner | +| ***processDefinitionId*** | Process definition ID | +| ***processInstanceId*** | Process instance ID | +| ***lastModified*** | Date the task was last modified. If lastModified defined the component will show the range ***lastModifiedFrom***, ***lastModifiedTo*** | +| ***sort*** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "createdDate", "priority", "processDefinitionId". | +| ***order*** | Sort ordering of the filter results it can be ASC or DESC (doesn't participate in the filtering itself). | -By default, the **_status_**, **_assignee_**, **_sort_** and **_order_** properties +By default, the ***status***, ***assignee***, ***sort*** and ***order*** properties are displayed in the editor. However, you can also choose which properties to show using the `filterProperties` array. For example, the code below initializes -the editor with the **_appName_**, **_processInstanceId_**, **_createdDate_** and -**_lastModified_** properties: +the editor with the ***appName***, ***processInstanceId***, ***createdDate*** and +***lastModified*** properties: ```ts import { UserProcessModel } from '@alfresco/adf-core'; @@ -127,15 +127,15 @@ With this configuration, only the four listed properties will be shown. ### Sort properties -You can supply a list of _sort properties_ to sort the tasks. You can use +You can supply a list of *sort properties* to sort the tasks. You can use any of the [filter properties](#filter-properties) listed above as -sort properties and you can also use the task **_id_** property and -use **_name_** as a shorthand for **_taskName_**. +sort properties and you can also use the task ***id*** property and +use ***name*** as a shorthand for ***taskName***. -By default, the **_id_**, **_name_**, **_createdDate_** and **_priority_** properties are +By default, the ***id***, ***name***, ***createdDate*** and ***priority*** properties are displayed in the editor. However, you can also choose which sort properties to show using the `sortProperties` array. -For example, the code below initializes the editor with the **_createdDate_** , **_lastModified_** and **_priority_** properties: +For example, the code below initializes the editor with the ***createdDate*** , ***lastModified*** and ***priority*** properties: ```ts export class SomeComponent implements OnInit { @@ -166,18 +166,18 @@ With this configuration, only the three listed sort properties will be shown. ### Action properties -You can supply various _actions_ to apply on task filter. +You can supply various *actions* to apply on task filter. | Name | Description | | ------------ | -------------------------- | -| **_save_** | Save task filter. | -| **_saveAs_** | Creates a new task filter. | -| **_delete_** | Delete task filter. | +| ***save*** | Save task filter. | +| ***saveAs*** | Creates a new task filter. | +| ***delete*** | Delete task filter. | -By default, the **_save_**, **_saveAs_** and **_delete_** actions are +By default, the ***save***, ***saveAs*** and ***delete*** actions are displayed in the editor. However, you can also choose which actions to show using the `actions` array. -For example, the code below initializes the editor with the **_save_** and **_delete_** actions: +For example, the code below initializes the editor with the ***save*** and ***delete*** actions: ```ts export class SomeComponent implements OnInit { @@ -205,15 +205,15 @@ With this configuration, only the two actions will be shown. ## Saving custom filters -Users can save a filter if they make any changes to it in an application using the **Save** icon. How it is saved is dictated by the Activiti version used: +Users can save a filter if they make any changes to it in an application using the **Save** icon. How it is saved is dictated by the Activiti version used: -- An Activiti 7 community version stores saved filters in the local browser storage. This restricts a user's custom filters to that single session. +* An Activiti 7 community version stores saved filters in the local browser storage. This restricts a user's custom filters to that single session. -- An Activiti Enterprise version uses the preference service to store saved filters. This allows for user's custom filters to be available between sessions and between devices. +* An Activiti Enterprise version uses the preference service to store saved filters. This allows for user's custom filters to be available between sessions and between devices. ## See also -- [Edit process filter cloud component](edit-process-filter-cloud.component.md) -- [Task filters Cloud Service](../services/task-filter-cloud.service.md) -- [Local preference Cloud Service](../services/local-preference-cloud.service.md) -- [User preference Cloud Service](../services/user-preference-cloud.service.md) +* [Edit process filter cloud component](edit-process-filter-cloud.component.md) +* [Task filters Cloud Service](../services/task-filter-cloud.service.md) +* [Local preference Cloud Service](../services/local-preference-cloud.service.md) +* [User preference Cloud Service](../services/user-preference-cloud.service.md) diff --git a/docs/process-services-cloud/components/form-cloud.component.md b/docs/process-services-cloud/components/form-cloud.component.md index a720bc3de8..0a78c61149 100644 --- a/docs/process-services-cloud/components/form-cloud.component.md +++ b/docs/process-services-cloud/components/form-cloud.component.md @@ -11,18 +11,18 @@ Shows a [`form`](../../../lib/process-services-cloud/src/lib/form/models/form-cl ## Contents -- [Basic Usage](#basic-usage) - - [Custom form outcomes template](#custom-form-outcomes-template) - - [Empty form template](#empty-form-template) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Displaying a form](#displaying-a-form) - - [Controlling outcome execution behaviour](#controlling-outcome-execution-behaviour) - - [Field Validators](#field-validators) - - [Common scenarios](#common-scenarios) -- [See also](#see-also) +* [Basic Usage](#basic-usage) + * [Custom form outcomes template](#custom-form-outcomes-template) + * [Empty form template](#empty-form-template) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Displaying a form](#displaying-a-form) + * [Controlling outcome execution behaviour](#controlling-outcome-execution-behaviour) + * [Field Validators](#field-validators) + * [Common scenarios](#common-scenarios) +* [See also](#see-also) ## Basic Usage @@ -74,40 +74,40 @@ The template defined inside `empty-form` will be shown when no form definition i ### Properties -| Name | Type | Default value | Description | -| ------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| appName | `string` | "" | App name to fetch corresponding form and values. | -| appVersion | `number` | | The application version to use when fetching data | -| data | [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.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. | -| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | -| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | -| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | | [FormFieldValidator](../../../lib/core/form/components/widgets/core/form-field-validator.ts) allow to override the form field validators provided. | -| 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` | | Task id to fetch corresponding form and values. | -| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | -| path | `string` | | Path of the folder where the metadata will be stored. | -| processInstanceId | `string` | | ProcessInstanceId id to fetch corresponding form and values. | -| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | -| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | -| showRefreshButton | `boolean` | true | Toggle rendering of the `Refresh` button. | -| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | -| showTitle | `boolean` | true | Toggle rendering of the form title. | -| showValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | -| taskId | `string` | | Task id to fetch corresponding form and values. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | App name to fetch corresponding form and values. | +| appVersion | `number` | | The application version to use when fetching data | +| data | [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.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. | +| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | +| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) allow to override the form field validators provided. | +| 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` | | Task id to fetch corresponding form and values. | +| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | +| path | `string` | | Path of the folder where the metadata will be stored. | +| processInstanceId | `string` | | ProcessInstanceId id to fetch corresponding form and values. | +| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | +| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | +| showRefreshButton | `boolean` | true | Toggle rendering of the `Refresh` button. | +| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | +| showTitle | `boolean` | true | Toggle rendering of the form title. | +| showValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | +| taskId | `string` | | Task id to fetch corresponding form and values. | ### Events -| Name | Type | Description | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| 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 form content 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. | -| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/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. | -| 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. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| 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 form content is clicked. | +| formDataRefreshed | `EventEmitter` | Emitted when form values are refreshed due to a data property change. | +| formError | `EventEmitter` | Emitted when the supplied form values have a validation error. | +| formLoaded | `EventEmitter` | Emitted when the form is loaded or reloaded. | +| formSaved | `EventEmitter` | Emitted when the form is submitted with the `Save` or custom outcomes. | ## Details @@ -166,7 +166,7 @@ In unusual circumstances, you may need to take complete control of form outcome You can do this by implementing the `executeOutcome` event, which is emitted for both system outcomes and custom ones. -Note that by default, the code in your `executeOutcome` handler is executed _before_ the default +Note that by default, the code in your `executeOutcome` handler is executed *before* the default behavior but you can switch the default behavior off using `event.preventDefault()`. You might want to do this, for example, to provide custom form validation or to show a summary of the form validation before it is submitted. @@ -209,8 +209,8 @@ export class MyView { There are two other functions that can be very useful when you need to control form outcomes: -- `saveTaskForm()` - Saves the current form -- `completeTaskForm(outcome?: string)` Saves and completes the form with a given outcome name +* `saveTaskForm()` - Saves the current form +* `completeTaskForm(outcome?: string)` Saves and completes the form with a given outcome name ### Field Validators @@ -284,8 +284,8 @@ In the CSS, you can target any outcome ID and change the style as in this exampl ## See also -- [Form Field Validator interface](../../core/interfaces/form-field-validator.interface.md) -- [Extensibility](../../user-guide/extensibility.md) -- [Form rendering service](../../core/services/form-rendering.service.md) -- [Form field model](../../core/models/form-field.model.md) -- [Form cloud service](../services/form-cloud.service.md) +* [Form Field Validator interface](../../core/interfaces/form-field-validator.interface.md) +* [Extensibility](../../user-guide/extensibility.md) +* [Form rendering service](../../core/services/form-rendering.service.md) +* [Form field model](../../core/models/form-field.model.md) +* [Form cloud service](../services/form-cloud.service.md) diff --git a/docs/process-services-cloud/components/form-definition-selector-cloud.component.md b/docs/process-services-cloud/components/form-definition-selector-cloud.component.md index 050e262389..b32023a434 100644 --- a/docs/process-services-cloud/components/form-definition-selector-cloud.component.md +++ b/docs/process-services-cloud/components/form-definition-selector-cloud.component.md @@ -6,7 +6,7 @@ Status: Active # [Form Definition Selector Cloud](../../../lib/process-services-cloud/src/lib/form/components/form-definition-selector-cloud.component.ts "Defined in form-definition-selector-cloud.component.ts") -Allows one form to be selected from a dropdown list. For forms to be displayed in this component they will need to be compatible with standAlone tasks. +Allows one form to be selected from a dropdown list. For forms to be displayed in this component they will need to be compatible with standAlone tasks. ## Basic Usage @@ -21,12 +21,12 @@ Allows one form to be selected from a dropdown list. For forms to be displayed i ### Properties -| Name | Type | Default value | Description | -| ------- | -------- | ------------- | --------------------------------------------------------------------------------------- | -| appName | `string` | "" | Name of the application. If specified, this shows the users who have access to the app. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | Name of the application. If specified, this shows the users who have access to the app. | ### Events -| Name | Type | Description | -| ---------- | -------------------------------------------------------------------- | -------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | selectForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a form is selected. | diff --git a/docs/process-services-cloud/components/group-cloud.component.md b/docs/process-services-cloud/components/group-cloud.component.md index aba1998f7e..66d7e16e6d 100644 --- a/docs/process-services-cloud/components/group-cloud.component.md +++ b/docs/process-services-cloud/components/group-cloud.component.md @@ -11,14 +11,14 @@ Searches Groups. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Selection Mode](#selection-mode) - - [Pre-selection](#pre-selection) - - [Read-only](#read-only) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Selection Mode](#selection-mode) + * [Pre-selection](#pre-selection) + * [Read-only](#read-only) ## Basic Usage @@ -35,26 +35,26 @@ Searches Groups. ### Properties -| Name | Type | Default value | Description | -| ------------------- | -------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| appName | `string` | | Name of the application. If specified this shows the groups who have access to the app. | -| groupChipsCtrl | `FormControl` | | FormControl to list of group | -| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | Group selection mode (single/multiple). | -| preSelectGroups | [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]` | \[] | Array of groups to be pre-selected. This pre-selects all groups in multi selection mode and only the first group of the array in single selection mode. | -| readOnly | `boolean` | false | Show the info in readonly mode | -| roles | `string[]` | \[] | Role names of the groups to be listed. | -| searchGroupsControl | `FormControl` | | FormControl to search the group | -| title | `string` | | Title of the field | -| validate | `Boolean` | false | This flag enables the validation on the preSelectGroups passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | | Name of the application. If specified this shows the groups who have access to the app. | +| groupChipsCtrl | `FormControl` | | FormControl to list of group | +| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | Group selection mode (single/multiple). | +| preSelectGroups | [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]` | \[] | Array of groups to be pre-selected. This pre-selects all groups in multi selection mode and only the first group of the array in single selection mode. | +| readOnly | `boolean` | false | Show the info in readonly mode | +| roles | `string[]` | \[] | Role names of the groups to be listed. | +| searchGroupsControl | `FormControl` | | FormControl to search the group | +| title | `string` | | Title of the field | +| validate | `Boolean` | false | This flag enables the validation on the preSelectGroups passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. | ### Events -| Name | Type | Description | -| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | changedGroups | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` | Emitted when a group selection change. | -| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is removed. | -| selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is selected. | -| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | +| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is removed. | +| selectGroup | `EventEmitter` | Emitted when a group is selected. | +| warning | `EventEmitter` | Emitted when an warning occurs. | ## Details diff --git a/docs/process-services-cloud/components/people-cloud.component.md b/docs/process-services-cloud/components/people-cloud.component.md index 769e9b242c..2510114d2e 100644 --- a/docs/process-services-cloud/components/people-cloud.component.md +++ b/docs/process-services-cloud/components/people-cloud.component.md @@ -1,4 +1,4 @@ -* * * +*** Title: [People Cloud Component](../../process-services-cloud/components/people-cloud.component.md) Added: v3.0.0 @@ -23,27 +23,27 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu ### Properties -| Name | Type | Default value | Description | -| -------------- | -------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. | -| excludedUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be excluded. Mandatory properties are: id, email, username | -| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | [User](../../../lib/core/pipes/user-initial.pipe.ts) selection mode (single/multiple). | -| preSelectUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | -| readOnly | `boolean` | false | Show the info in readonly mode | -| roles | `string[]` | | Role names of the users to be listed. | -| searchUserCtrl | `FormControl` | | FormControl to search the user | -| title | `string` | | Placeholder translation key | -| userChipsCtrl | `FormControl` | | FormControl to list of users | -| validate | `boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. | +| excludedUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be excluded. Mandatory properties are: id, email, username | +| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) selection mode (single/multiple). | +| preSelectUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | +| readOnly | `boolean` | false | Show the info in readonly mode | +| roles | `string[]` | | Role names of the users to be listed. | +| searchUserCtrl | `FormControl` | | FormControl to search the user | +| title | `string` | | Placeholder translation key | +| userChipsCtrl | `FormControl` | | FormControl to list of users | +| validate | `boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. | ### Events -| Name | Type | Description | -| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. | -| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. | -| selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a user is selected. | -| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | +| Name | Type | Description | +| --- | --- | --- | +| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. | +| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. | +| selectUser | `EventEmitter` | Emitted when a user is selected. | +| warning | `EventEmitter` | Emitted when an warning occurs. | ## Details diff --git a/docs/process-services-cloud/components/process-filters-cloud.component.md b/docs/process-services-cloud/components/process-filters-cloud.component.md index 49b5920bbd..9e99eb22f4 100644 --- a/docs/process-services-cloud/components/process-filters-cloud.component.md +++ b/docs/process-services-cloud/components/process-filters-cloud.component.md @@ -22,23 +22,23 @@ Lists all available process filters and allows to select a filter. ### Properties -| Name | Type | Default value | Description | -| ----------- | --------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------- | -| appName | `string` | "" | (required) The application name | -| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default | -| showIcons | `boolean` | false | (optional) Toggles showing an icon by the side of each filter | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | (required) The application name | +| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default | +| showIcons | `boolean` | false | (optional) Toggles showing an icon by the side of each filter | ### Events -| Name | Type | Description | -| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs while loading the filters | -| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is being selected based on the filterParam input. | -| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is being clicked from the UI. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when filters are loaded successfully | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs while loading the filters | +| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is being clicked from the UI. | +| filterSelected | `EventEmitter` | Emitted when a filter is being selected based on the filterParam input. | +| success | `EventEmitter` | Emitted when filters are loaded successfully | ## See also -- [Process Filter Cloud Service](./services/process-filter-cloud.service.md) -- [Local preference Cloud Service](./services/local-preference-cloud.service.md) -- [User preference Cloud Service](./services/user-preference-cloud.service.md) +* [Process Filter Cloud Service](./services/process-filter-cloud.service.md) +* [Local preference Cloud Service](./services/local-preference-cloud.service.md) +* [User preference Cloud Service](./services/user-preference-cloud.service.md) diff --git a/docs/process-services-cloud/components/process-header-cloud.component.md b/docs/process-services-cloud/components/process-header-cloud.component.md index 553c455af9..026723f1fa 100644 --- a/docs/process-services-cloud/components/process-header-cloud.component.md +++ b/docs/process-services-cloud/components/process-header-cloud.component.md @@ -24,10 +24,10 @@ Shows all the information related to a process instance. ### Properties -| Name | Type | Default value | Description | -| ----------------- | -------- | ------------- | ------------------------------------------ | -| appName | `string` | "" | (Required) The name of the application. | -| processInstanceId | `string` | | (Required) The id of the process instance. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | (Required) The name of the application. | +| processInstanceId | `string` | | (Required) The id of the process instance. | ## Details @@ -36,7 +36,7 @@ The component populates an internal array of By default all properties are displayed: -**_id_**, **_name_**, **_status_**, **_initiator_**, **_startDate_**, **_lastModified_**, **_parentId_**, **_businessKey_**. +***id***, ***name***, ***status***, ***initiator***, ***startDate***, ***lastModified***, ***parentId***, ***businessKey***. However, you can also choose which properties to show using a configuration in `app.config.json`: @@ -52,4 +52,4 @@ With this configuration, only the four listed properties will be shown. ## See also -- [Process header cloud service](../../process-services-cloud/services/process-header-cloud.service.md) +* [Process header cloud service](../../process-services-cloud/services/process-header-cloud.service.md) diff --git a/docs/process-services-cloud/components/process-list-cloud.component.md b/docs/process-services-cloud/components/process-list-cloud.component.md index d70e547a7a..ba452ff479 100644 --- a/docs/process-services-cloud/components/process-list-cloud.component.md +++ b/docs/process-services-cloud/components/process-list-cloud.component.md @@ -11,15 +11,15 @@ Renders a list containing all the process instances matched by the parameters sp ## Contents -- [Basic Usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) - - [Pagination strategy](#pagination-strategy) -- [See also](#see-also) +* [Basic Usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) + * [Pagination strategy](#pagination-strategy) +* [See also](#see-also) ## Basic Usage @@ -48,45 +48,45 @@ when the process list is empty: ### Properties -| Name | Type | Default value | Description | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | -| appName | `string` | "" | The name of the application. | -| appVersion | `number | number[]` | | The release version of the application. | -| businessKey | `string` | "" | Filter the processes to display only the ones with this businessKey value. | -| completedDate | `string` | "" | Filter the processes. Display only process with completedDate equal to the supplied date. | -| completedFrom | `string` | "" | Filter the processes. Display only process with completedFrom equal to the supplied date. | -| completedTo | `string` | "" | Filter the processes. Display only process with completedTo equal to the supplied date. | -| id | `string` | "" | Filter the processes to display only the ones with this ID. | -| initiator | `string` | "" | Name of the initiator of the process. | -| lastModifiedFrom | `string` | "" | Filter the processes. Display only process with lastModifiedTo equal to the supplied date. | -| lastModifiedTo | `string` | "" | Filter the processes. Display only process with lastModifiedTo equal to the supplied date. | -| multiselect | `boolean` | false | Toggles multiple row selection and renders checkboxes at the beginning of each row | -| name | `string` | "" | Filter the processes to display only the ones with this name. | -| presetColumn | `string` | | Custom preset column schema in JSON format. | -| processDefinitionId | `string` | "" | Filter the processes to display only the ones with this process definition ID. | -| processDefinitionKey | `string` | "" | Filter the processes to display only the ones with this process definition key. | -| processDefinitionName | `string` | "" | Filter the processes to display only the ones with this process definition name. | -| selectionMode | `string` | "single" | Row selection mode. Can be "none", "single" or "multiple". For multiple mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showActions | `boolean` | false | Toggles the data actions column. | -| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | -| sorting | [`ProcessListCloudSortingModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-list-sorting.model.ts)`[]` | | Array of objects specifying the sort order and direction for the list. The sort parameters are for BE sorting. | -| startFrom | `string` | "" | Filter the processes. Display only process with startedDate greater then the supplied date. | -| startTo | `string` | "" | Filter the processes. Display only process with startedDate less than the supplied date. | -| status | `string` | "" | Filter the processes to display only the ones with this status. | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | +| appName | `string` | "" | The name of the application. | +| appVersion | `number \| number[]` | | The version of the application. | +| businessKey | `string` | "" | Filter the processes to display only the ones with this businessKey value. | +| completedDate | `string` | "" | Filter the processes. Display only process with completedDate equal to the supplied date. | +| completedFrom | `string` | "" | Filter the processes. Display only process with completedFrom equal to the supplied date. | +| completedTo | `string` | "" | Filter the processes. Display only process with completedTo equal to the supplied date. | +| id | `string` | "" | Filter the processes to display only the ones with this ID. | +| initiator | `string` | "" | Name of the initiator of the process. | +| lastModifiedFrom | `string` | "" | Filter the processes. Display only process with lastModifiedTo equal to the supplied date. | +| lastModifiedTo | `string` | "" | Filter the processes. Display only process with lastModifiedTo equal to the supplied date. | +| multiselect | `boolean` | false | Toggles multiple row selection and renders checkboxes at the beginning of each row | +| name | `string` | "" | Filter the processes to display only the ones with this name. | +| presetColumn | `string` | | Custom preset column schema in JSON format. | +| processDefinitionId | `string` | "" | Filter the processes to display only the ones with this process definition ID. | +| processDefinitionKey | `string` | "" | Filter the processes to display only the ones with this process definition key. | +| processDefinitionName | `string` | "" | Filter the processes to display only the ones with this process definition name. | +| selectionMode | `string` | "single" | Row selection mode. Can be "none", "single" or "multiple". For multiple mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showActions | `boolean` | false | Toggles the data actions column. | +| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | +| sorting | [`ProcessListCloudSortingModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-list-sorting.model.ts)`[]` | | Array of objects specifying the sort order and direction for the list. The sort parameters are for BE sorting. | +| startFrom | `string` | "" | Filter the processes. Display only process with startedDate greater then the supplied date. | +| startTo | `string` | "" | Filter the processes. Display only process with startedDate less than the supplied date. | +| status | `string` | "" | Filter the processes to display only the ones with this status. | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | ### Events -| Name | Type | Description | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | -| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | -| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected. | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list of process instances has been loaded successfully from the server. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | +| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected. | +| showRowActionsMenu | `EventEmitter` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | `EventEmitter` | Emitted before the context menu is displayed for a row. | +| success | `EventEmitter` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details @@ -161,7 +161,7 @@ information defined in `app.config.json` as in the example below: ``` These are all the available columns that can be displayed in this component: -**_appName_**, **_businessKey_**, **_description_**, **_id_**, **_initiator_**, **_lastModified_**, **_processName_**, **_parentId_**, **_processDefinitionId_**, **_processDefinitionKey_**, and **_status_**. +***appName***, ***businessKey***, ***description***, ***id***, ***initiator***, ***lastModified***, ***processName***, ***parentId***, ***processDefinitionId***, ***processDefinitionKey***, and ***status***. ### Setting Sorting Order for the list @@ -319,6 +319,6 @@ earlier), and perform the corresponding actions. ## See also -- [Data column component](../../core/components/data-column.component.md) -- [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) -- [Pagination component](../../core/components/pagination.component.md) +* [Data column component](../../core/components/data-column.component.md) +* [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) +* [Pagination component](../../core/components/pagination.component.md) diff --git a/docs/process-services-cloud/components/start-process-cloud.component.md b/docs/process-services-cloud/components/start-process-cloud.component.md index c02e2f6ee1..d540d5b02e 100644 --- a/docs/process-services-cloud/components/start-process-cloud.component.md +++ b/docs/process-services-cloud/components/start-process-cloud.component.md @@ -13,14 +13,14 @@ Starts a process. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Starting a process with a default name and a pre-selected process definition name](#starting-a-process-with-a-default-name-and-a-pre-selected-process-definition-name) - - [Starting a process with variables](#starting-a-process-with-variables) - - [Starting a process with values passed to the form](#starting-a-process-with-values-passed-to-the-form) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Starting a process with a default name and a pre-selected process definition name](#starting-a-process-with-a-default-name-and-a-pre-selected-process-definition-name) + * [Starting a process with variables](#starting-a-process-with-variables) + * [Starting a process with values passed to the form](#starting-a-process-with-values-passed-to-the-form) ## Basic Usage @@ -34,25 +34,25 @@ Starts a process. ### Properties -| Name | Type | Default value | Description | -| ------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------- | -| appName | `string` | "" | (required) Name of the app. | -| maxNameLength | `number` | | Maximum length of the process name. | -| name | `string` | "" | Name of the process. | -| processDefinitionName | `string` | | Name of the process definition. | -| showSelectProcessDropdown | `boolean` | true | Show/hide the process dropdown list. | -| values | [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` | | Parameter to pass form field values in the start form if one is associated. | -| variables | `Function` | | Variables to attach to the payload. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | (required) Name of the app. | +| maxNameLength | `number` | | Maximum length of the process name. | +| name | `string` | "" | Name of the process. | +| processDefinitionName | `string` | | Name of the process definition. | +| showSelectProcessDropdown | `boolean` | true | Show/hide the process dropdown list. | +| values | [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` | | Parameter to pass form field values in the start form if one is associated. | +| variables | `Function` | | Variables to attach to the payload. | ### Events -| Name | Type | Description | -| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the starting process is cancelled | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | -| processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`>` | Emitted when process definition selection changes. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the process is successfully started. | +| Name | Type | Description | +| --- | --- | --- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the starting process is cancelled | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. | +| formContentClicked | `EventEmitter` | Emitted when form content is clicked. | +| processDefinitionSelection | `EventEmitter` | Emitted when process definition selection changes. | +| success | `EventEmitter` | Emitted when the process is successfully started. | ## Details diff --git a/docs/process-services-cloud/components/start-task-cloud.component.md b/docs/process-services-cloud/components/start-task-cloud.component.md index 2a09146999..370c5429cb 100644 --- a/docs/process-services-cloud/components/start-task-cloud.component.md +++ b/docs/process-services-cloud/components/start-task-cloud.component.md @@ -23,16 +23,16 @@ Creates/starts a new task for the specified app. ### Properties -| Name | Type | Default value | Description | -| ------------- | -------- | ------------- | -------------------------------- | -| appName | `string` | "" | (required) Name of the app. | -| maxNameLength | `number` | | Maximum length of the task name. | -| name | `string` | "" | Name of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | (required) Name of the app. | +| maxNameLength | `number` | | Maximum length of the task name. | +| name | `string` | "" | Name of the task. | ### Events -| Name | Type | Description | -| ------- | ------------------------------------------------------------------ | ------------------------------------------------------ | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is successfully created. | +| Name | Type | Description | +| --- | --- | --- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | `EventEmitter` | Emitted when the task is successfully created. | diff --git a/docs/process-services-cloud/components/task-filters-cloud.component.md b/docs/process-services-cloud/components/task-filters-cloud.component.md index 9400e6463c..478a534611 100644 --- a/docs/process-services-cloud/components/task-filters-cloud.component.md +++ b/docs/process-services-cloud/components/task-filters-cloud.component.md @@ -19,20 +19,20 @@ Shows all available filters. ### Properties -| Name | Type | Default value | Description | -| ----------- | --------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| appName | `string` | "" | Display filters available to the current user for the application with the specified name. | -| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. | -| showIcons | `boolean` | false | Toggles display of the filter's icons. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | Display filters available to the current user for the application with the specified name. | +| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. | +| showIcons | `boolean` | false | Toggles display of the filter's icons. | ### Events -| Name | Type | Description | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | -| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter is being selected based on the filterParam input. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | | filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter is being clicked from the UI. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | +| filterSelected | `EventEmitter` | Emitted when a filter is being selected based on the filterParam input. | +| success | `EventEmitter` | Emitted when the list is loaded. | ## Details @@ -58,6 +58,6 @@ as the value of `filterParam` as shown in the table below: ## See also -- [Task filter Cloud Service](../services/task-filter-cloud.service.md) -- [Local preference Cloud Service](../services/local-preference-cloud.service.md) -- [User preference Cloud Service](../services/user-preference-cloud.service.md) +* [Task filter Cloud Service](../services/task-filter-cloud.service.md) +* [Local preference Cloud Service](../services/local-preference-cloud.service.md) +* [User preference Cloud Service](../services/user-preference-cloud.service.md) diff --git a/docs/process-services-cloud/components/task-form-cloud.component.md b/docs/process-services-cloud/components/task-form-cloud.component.md index d2e0cef03f..63287da476 100644 --- a/docs/process-services-cloud/components/task-form-cloud.component.md +++ b/docs/process-services-cloud/components/task-form-cloud.component.md @@ -33,32 +33,32 @@ Save and Complete buttons get disabled when at least one of the form's inputs ar ### Properties -| Name | Type | Default value | Description | -| ------------------ | --------- | ------------- | ----------------------------------------------- | -| appName | `string` | "" | App id to fetch corresponding form and values. | -| readOnly | `boolean` | false | Toggle readonly state of the task. | -| showTitle | `boolean` | true | Toggle rendering of the form title. | -| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | -| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` button. | -| showRefreshButton | `boolean` | false | Toggle rendering of the `Refresh` button. | -| showValidationIcon | `boolean` | true | Toggle rendering of the `Validation` icon. | -| taskId | `string` | | Task id to fetch corresponding form and values. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | App id to fetch corresponding form and values. | +| readOnly | `boolean` | false | Toggle readonly state of the task. | +| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | +| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` button. | +| showRefreshButton | `boolean` | false | Toggle rendering of the `Refresh` button. | +| showTitle | `boolean` | true | Toggle rendering of the form title. | +| showValidationIcon | `boolean` | true | Toggle rendering of the `Validation` icon. | +| taskId | `string` | | Task id to fetch corresponding form and values. | ### Events -| Name | Type | Description | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| 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 form content is clicked. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is saved. | -| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | -| taskCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | -| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed. | +| Name | Type | Description | +| --- | --- | --- | +| cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| 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 form content is clicked. | +| formSaved | `EventEmitter` | Emitted when the form is saved. | +| taskClaimed | `EventEmitter` | Emitted when the task is claimed. | +| taskCompleted | `EventEmitter` | Emitted when the task is completed. | +| taskUnclaimed | `EventEmitter` | Emitted when the task is unclaimed. | ## See also -- [Form component](./form-cloud.component.md) -- [Form field model](../../core/models/form-field.model.md) -- [Form cloud service](../services/form-cloud.service.md) +* [Form component](./form-cloud.component.md) +* [Form field model](../../core/models/form-field.model.md) +* [Form cloud service](../services/form-cloud.service.md) diff --git a/docs/process-services-cloud/components/task-header-cloud.component.md b/docs/process-services-cloud/components/task-header-cloud.component.md index 7148a56a6c..0807a8ae28 100644 --- a/docs/process-services-cloud/components/task-header-cloud.component.md +++ b/docs/process-services-cloud/components/task-header-cloud.component.md @@ -24,19 +24,19 @@ Shows all the information related to a task. ### Properties -| Name | Type | Default value | Description | -| --------- | --------- | ------------- | --------------------------------------- | -| appName | `string` | "" | (Required) The name of the application. | -| showTitle | `boolean` | true | Show/Hide the task title | -| taskId | `string` | | (Required) The id of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | (Required) The name of the application. | +| showTitle | `boolean` | true | Show/Hide the task title | +| taskId | `string` | | (Required) The id of the task. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | -------------------------------------------------- | -| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the given task has errors. | -| unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued). | +| Name | Type | Description | +| --- | --- | --- | +| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the given task has errors. | +| unclaim | `EventEmitter` | Emitted when the task is unclaimed (ie, requeued). | ## Details @@ -45,7 +45,7 @@ The component populates an internal array of By default all properties are displayed: -**_assignee_**, **_status_**, **_priority_**, **_dueDate_**, **_category_**, **_parentName_**, **_created_**, **_id_**, **_description_**, **_formName_**, **_candidateUsers_**, **_candidateGroups_**. +***assignee***, ***status***, ***priority***, ***dueDate***, ***category***, ***parentName***, ***created***, ***id***, ***description***, ***formName***, ***candidateUsers***, ***candidateGroups***. However, you can also choose which properties to show using a configuration in `app.config.json`: diff --git a/docs/process-services-cloud/components/task-list-cloud.component.md b/docs/process-services-cloud/components/task-list-cloud.component.md index bebb6ac38c..0db83f46bc 100644 --- a/docs/process-services-cloud/components/task-list-cloud.component.md +++ b/docs/process-services-cloud/components/task-list-cloud.component.md @@ -11,18 +11,18 @@ Renders a list containing all the tasks matched by the parameters specified. ## Contents -- [Basic Usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Setting the column schema](#setting-the-column-schema) - - [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) - - [Pagination strategy](#pagination-strategy) - - [DataTableAdapter example](#datatableadapter-example) - - [DataColumn Features](#datacolumn-features) -- [See also](#see-also) +* [Basic Usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Setting the column schema](#setting-the-column-schema) + * [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) + * [Pagination strategy](#pagination-strategy) + * [DataTableAdapter example](#datatableadapter-example) + * [DataColumn Features](#datacolumn-features) +* [See also](#see-also) ## Basic Usage @@ -49,50 +49,53 @@ when the task list is empty: ### Properties -| Name | Type | Default value | Description | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | -| appName | `string` | "" | The name of the application. | -| assignee | `string` | "" | The assignee of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved). | -| completedBy | `number` | | Filter the tasks. Display only tasks with createdBy equal to the supplied value. | -| completedDate | `string` | "" | Filter the tasks. Display only tasks with completedDate equal to the supplied date. | -| completedFrom | `string` | "" | Filter the tasks. Display only tasks with completedFrom equal to the supplied date. | -| completedTo | `string` | "" | Filter the tasks. Display only tasks with completedTo equal to the supplied date. | -| createdDate | `string` | "" | Filter the tasks. Display only tasks created on the supplied date. | -| dueDate | `string` | "" | Filter the tasks. Display only tasks with dueDate equal to the supplied date. | -| dueDateFrom | `string` | "" | Filter the tasks. Display only tasks with dueDate greater or equal than the supplied date. | -| dueDateTo | `string` | "" | Filter the tasks. Display only tasks with dueDate less or equal to the supplied date. | -| id | `string` | "" | Filter the tasks. Display only tasks with id equal to the supplied value. | -| lastModifiedFrom | `string` | "" | Filter the tasks. Display only tasks with lastModifiedFrom equal to the supplied date. | -| lastModifiedTo | `string` | "" | Filter the tasks. Display only tasks with lastModifiedTo equal to the supplied date. | -| multiselect | `boolean` | false | Toggles multiple row selection, rendering a checkbox at the beginning of each row. | -| name | `string` | "" | Filter the tasks. Display only tasks with the supplied name. | -| owner | `string` | "" | Filter the tasks. Display only tasks with owner equal to the supplied value. | -| parentTaskId | `string` | "" | Filter the tasks. Display only tasks with parentTaskId equal to the supplied value. | -| presetColumn | `string` | | Custom preset column schema in JSON format. | -| priority | `number` | | Filter the tasks. Display only tasks with priority equal to the supplied value. | -| processDefinitionId | `string` | "" | Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value. | -| processDefinitionName | `string` | "" | Filter the tasks. Display only tasks with processDefinitionName equal to the supplied value. | -| processInstanceId | `string` | "" | Filter the tasks. Display only tasks with processInstanceId equal to the supplied value. | -| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showActions | `boolean` | false | Toggles the data actions column. | -| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | -| sorting | [`TaskListCloudSortingModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/task-list-sorting.model.ts)`[]` | | Specifies how the table should be sorted. The parameters are for BE sorting. | -| standalone | `boolean` | false | Filter the tasks. Display only the tasks that belong to a process in case is false or tasks that doesn't belong to a process in case of true. | -| status | `string` | "" | Filter the tasks. Display only tasks with status equal to the supplied value. | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | +| appName | `string` | "" | The name of the application. | +| assignee | `string` | "" | The assignee of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved). | +| candidateGroupId | `string` | "" | Filter the tasks. Display only tasks with candidateGroups equal to the supplied value. | +| completedBy | `number` | | Filter the tasks. Display only tasks with createdBy equal to the supplied value. | +| completedDate | `string` | "" | Filter the tasks. Display only tasks with completedDate equal to the supplied date. | +| completedFrom | `string` | "" | Filter the tasks. Display only tasks with completedFrom equal to the supplied date. | +| completedTo | `string` | "" | Filter the tasks. Display only tasks with completedTo equal to the supplied date. | +| createdDate | `string` | "" | Filter the tasks. Display only tasks created on the supplied date. | +| createdFrom | `string` | "" | Filter the tasks. Display only tasks with createdFrom equal to the supplied date. | +| createdTo | `string` | "" | Filter the tasks. Display only tasks with createdTo equal to the supplied date. | +| dueDate | `string` | "" | Filter the tasks. Display only tasks with dueDate equal to the supplied date. | +| dueDateFrom | `string` | "" | Filter the tasks. Display only tasks with dueDate greater or equal than the supplied date. | +| dueDateTo | `string` | "" | Filter the tasks. Display only tasks with dueDate less or equal to the supplied date. | +| id | `string` | "" | Filter the tasks. Display only tasks with id equal to the supplied value. | +| lastModifiedFrom | `string` | "" | Filter the tasks. Display only tasks with lastModifiedFrom equal to the supplied date. | +| lastModifiedTo | `string` | "" | Filter the tasks. Display only tasks with lastModifiedTo equal to the supplied date. | +| multiselect | `boolean` | false | Toggles multiple row selection, rendering a checkbox at the beginning of each row. | +| name | `string` | "" | Filter the tasks. Display only tasks with the supplied name. | +| owner | `string` | "" | Filter the tasks. Display only tasks with owner equal to the supplied value. | +| parentTaskId | `string` | "" | Filter the tasks. Display only tasks with parentTaskId equal to the supplied value. | +| presetColumn | `string` | | Custom preset column schema in JSON format. | +| priority | `number` | | Filter the tasks. Display only tasks with priority equal to the supplied value. | +| processDefinitionId | `string` | "" | Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value. | +| processDefinitionName | `string` | "" | Filter the tasks. Display only tasks with processDefinitionName equal to the supplied value. | +| processInstanceId | `string` | "" | Filter the tasks. Display only tasks with processInstanceId equal to the supplied value. | +| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showActions | `boolean` | false | Toggles the data actions column. | +| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | +| sorting | [`TaskListCloudSortingModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/task-list-sorting.model.ts)`[]` | | Specifies how the table should be sorted. The parameters are for BE sorting. | +| standalone | `boolean` | false | Filter the tasks. Display only the tasks that belong to a process in case is false or tasks that doesn't belong to a process in case of true. | +| status | `string` | "" | Filter the tasks. Display only tasks with status equal to the supplied value. | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | ### Events -| Name | Type | Description | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | -| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | -| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | +| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | +| showRowActionsMenu | `EventEmitter` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | `EventEmitter` | Emitted before the context menu is displayed for a row. | +| success | `EventEmitter` | Emitted when the task list is loaded | ## Details @@ -341,6 +344,6 @@ earlier), and perform the corresponding actions. ## See also -- [Data column component](../../core/components/data-column.component.md) -- [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) -- [Pagination component](../../core/components/pagination.component.md) +* [Data column component](../../core/components/data-column.component.md) +* [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) +* [Pagination component](../../core/components/pagination.component.md) diff --git a/docs/process-services-cloud/directives/claim-task-cloud.directive.md b/docs/process-services-cloud/directives/claim-task-cloud.directive.md index 00c6c60013..db33588cf9 100644 --- a/docs/process-services-cloud/directives/claim-task-cloud.directive.md +++ b/docs/process-services-cloud/directives/claim-task-cloud.directive.md @@ -19,14 +19,14 @@ Claims a task ### Properties -| Name | Type | Default value | Description | -| ------- | -------- | ------------- | --------------------------------------- | -| appName | `string` | "" | (Required) The name of the application. | -| taskId | `string` | | (Required) The id of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | (Required) The name of the application. | +| taskId | `string` | | (Required) The id of the task. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ------------------------------------------ | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | diff --git a/docs/process-services-cloud/directives/complete-task.directive.md b/docs/process-services-cloud/directives/complete-task.directive.md index c955450c37..019ba36f5e 100644 --- a/docs/process-services-cloud/directives/complete-task.directive.md +++ b/docs/process-services-cloud/directives/complete-task.directive.md @@ -19,14 +19,14 @@ Completes a task. ### Properties -| Name | Type | Default value | Description | -| ------- | -------- | ------------- | --------------------------------------- | -| appName | `string` | "" | (Required) The name of the application. | -| taskId | `string` | | (Required) The id of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appName | `string` | "" | (Required) The name of the application. | +| taskId | `string` | | (Required) The id of the task. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ------------------------------------------ | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | diff --git a/docs/process-services-cloud/services/apps-process-cloud.service.md b/docs/process-services-cloud/services/apps-process-cloud.service.md index 8fbbf688c8..0cf536f33e 100644 --- a/docs/process-services-cloud/services/apps-process-cloud.service.md +++ b/docs/process-services-cloud/services/apps-process-cloud.service.md @@ -7,21 +7,21 @@ Last reviewed: 2019-01-09 # [Apps Process Cloud Service](../../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts "Defined in apps-process-cloud.service.ts") -Gets details of deployed apps for the current user. +Gets details of deployed apps for the current user. ## Class members ### Methods -- **getDeployedApplicationsByStatus**(status: `string`, role?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>`
+* **getDeployedApplicationsByStatus**(status: `string`, role?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>`
Gets a list of deployed apps for this user by status. - - _status:_ `string` - Required status value - - _role:_ `string` - (Optional) to filter the apps - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>` - The list of deployed apps -- **hasDeployedApps**(): `boolean`
+ * *status:* `string` - Required status value + * *role:* `string` - (Optional) to filter the apps + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>` - The list of deployed apps +* **hasDeployedApps**(): `boolean`
- - **Returns** `boolean` - -- **loadApps**()
+ * **Returns** `boolean` - +* **loadApps**()
## Details @@ -30,4 +30,4 @@ with modifications for cloud use. ## See also -- [Apps process service](../../core/services/apps-process.service.md) +* [Apps process service](../../core/services/apps-process.service.md) diff --git a/docs/process-services-cloud/services/form-cloud.service.md b/docs/process-services-cloud/services/form-cloud.service.md index 89bf95a1fa..a26ff30637 100644 --- a/docs/process-services-cloud/services/form-cloud.service.md +++ b/docs/process-services-cloud/services/form-cloud.service.md @@ -26,67 +26,67 @@ class MyComponent { ### Methods -- **completeTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts), outcome: `string`, version: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+* **completeTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts), outcome: `string`, version: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Completes a task form. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the target task - - _processInstanceId:_ `string` - ID of processInstance - - _formId:_ `string` - ID of the form to complete - - _formValues:_ [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object - - _outcome:_ `string` - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) outcome - - _version:_ `number` - of the form - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details -- **createTemporaryRawRelatedContent**(file: `any`, nodeId: `string`, contentHost: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the target task + * *processInstanceId:* `string` - ID of processInstance + * *formId:* `string` - ID of the form to complete + * *formValues:* [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object + * *outcome:* `string` - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) outcome + * *version:* `number` - of the form + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details +* **createTemporaryRawRelatedContent**(file: `any`, nodeId: `string`, contentHost: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- - _file:_ `any` - - - _nodeId:_ `string` - - - _contentHost:_ `string` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - -- **getBasePath**(appName: `string`): `string`
+ * *file:* `any` - + * *nodeId:* `string` - + * *contentHost:* `string` - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - +* **getBasePath**(appName: `string`): `string`
- - _appName:_ `string` - - - **Returns** `string` - -- **getDropDownJsonData**(url: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - + * **Returns** `string` - +* **getDropDownJsonData**(url: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Parses JSON data to create a corresponding form. - - _url:_ `string` - String data to make the request - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Array of FormFieldOption object -- **getForm**(appName: `string`, formKey: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>`
+ * *url:* `string` - String data to make the request + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Array of FormFieldOption object +* **getForm**(appName: `string`, formKey: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>`
Gets a form definition. - - _appName:_ `string` - Name of the app - - _formKey:_ `string` - key of the target task - - _version:_ `number` - (Optional) Version of the form - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>` - Form definition -- **getTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ * *appName:* `string` - Name of the app + * *formKey:* `string` - key of the target task + * *version:* `number` - (Optional) Version of the form + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>` - Form definition +* **getTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Gets details of a task - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task -- **getTaskForm**(appName: `string`, taskId: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the target task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task +* **getTaskForm**(appName: `string`, taskId: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the form definition of a task. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the target task - - _version:_ `number` - (Optional) Version of the form - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Form definition -- **getTaskVariables**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>`
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the target task + * *version:* `number` - (Optional) Version of the form + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Form definition +* **getTaskVariables**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>`
Gets the variables of a task. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>` - Task variables -- **parseForm**(json: `any`, data?: [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]`, readOnly: `boolean` = `false`): [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the target task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>` - Task variables +* **parseForm**(json: `any`, data?: [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]`, readOnly: `boolean` = `false`): [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)
Parses JSON data to create a corresponding form. - - _json:_ `any` - JSON data to create the form - - _data:_ [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` - (Optional) Values for the form's fields - - _readOnly:_ `boolean` - Toggles whether or not the form should be read-only - - **Returns** [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) created from the JSON specification -- **saveTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, values: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ * *json:* `any` - JSON data to create the form + * *data:* [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` - (Optional) Values for the form's fields + * *readOnly:* `boolean` - Toggles whether or not the form should be read-only + * **Returns** [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) created from the JSON specification +* **saveTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, values: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Saves a task form. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the target task - - _processInstanceId:_ `string` - ID of processInstance - - _formId:_ `string` - ID of the form to save - - _values:_ [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details + * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the target task + * *processInstanceId:* `string` - ID of processInstance + * *formId:* `string` - ID of the form to save + * *values:* [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details ## See also -- [Form cloud component](../components/form-cloud.component.md) +* [Form cloud component](../components/form-cloud.component.md) diff --git a/docs/process-services-cloud/services/group-cloud.service.md b/docs/process-services-cloud/services/group-cloud.service.md index 45ad42c35b..438201f1bf 100644 --- a/docs/process-services-cloud/services/group-cloud.service.md +++ b/docs/process-services-cloud/services/group-cloud.service.md @@ -7,45 +7,45 @@ Last reviewed: 2019-02-06 # [Group Cloud Service](../../../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts "Defined in group-cloud.service.ts") -Searches and gets information for groups. +Searches and gets information for groups. ## Class members ### Methods -- **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Check if a group has any of the client app roles in the supplied list. - - _groupId:_ `string` - ID of the target group - - _clientId:_ `string` - ID of the client - - _roleNames:_ `string[]` - Array of role names to check - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise -- **checkGroupHasClientApp**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupId:* `string` - ID of the target group + * *clientId:* `string` - ID of the client + * *roleNames:* `string[]` - Array of role names to check + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise +* **checkGroupHasClientApp**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Checks if a group has a client app. - - _groupId:_ `string` - ID of the target group - - _clientId:_ `string` - ID of the client - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has the client app, false otherwise -- **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupId:* `string` - ID of the target group + * *clientId:* `string` - ID of the client + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has the client app, false otherwise +* **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Check that a group has one or more roles from the supplied list. - - _groupId:_ `string` - ID of the target group - - _roleNames:_ `string[]` - Array of role names - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise -- **findGroupsByName**(searchParams: [`GroupSearchParam`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *groupId:* `string` - ID of the target group + * *roleNames:* `string[]` - Array of role names + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise +* **findGroupsByName**(searchParams: [`GroupSearchParam`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Finds groups filtered by name. - - _searchParams:_ [`GroupSearchParam`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts) - Object containing the name filter string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of group information -- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *searchParams:* [`GroupSearchParam`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts) - Object containing the name filter string + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of group information +* **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the client ID using the app name. - - _applicationName:_ `string` - Name of the app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - client ID string -- **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *applicationName:* `string` - Name of the app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - client ID string +* **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets client roles. - - _groupId:_ `string` - ID of the target group - - _clientId:_ `string` - ID of the client - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of roles -- **getGroupRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>`
+ * *groupId:* `string` - ID of the target group + * *clientId:* `string` - ID of the client + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of roles +* **getGroupRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>`
Gets details for a specified group. - - _groupId:_ `string` - ID of the target group - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>` - Group details + * *groupId:* `string` - ID of the target group + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>` - Group details ## Details diff --git a/docs/process-services-cloud/services/local-preference-cloud.service.md b/docs/process-services-cloud/services/local-preference-cloud.service.md index fb1b3227c0..83ccd3037e 100644 --- a/docs/process-services-cloud/services/local-preference-cloud.service.md +++ b/docs/process-services-cloud/services/local-preference-cloud.service.md @@ -7,44 +7,44 @@ Last reviewed: 2019-08-06 # [Local Preference Cloud Service](../../../lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts "Defined in local-preference-cloud.service.ts") -Manages Local Storage preferences. +Manages Local Storage preferences. ## Class members ### Methods -- **createPreference**(\_: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **createPreference**(\_: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Creates local preference. - - _\_:_ `string` - Name of the target app - - _key:_ `string` - Key of the target preference - - _newPreference:_ `any` - Details of new local preference - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of created local preferences -- **deletePreference**(key: `string`, preferences: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *\_:* `string` - Name of the target app + * *key:* `string` - Key of the target preference + * *newPreference:* `any` - Details of new local preference + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of created local preferences +* **deletePreference**(key: `string`, preferences: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes local preference by given preference key. - - _key:_ `string` - Key of the target preference - - _preferences:_ `any` - Details of updated preferences - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of preferences without deleted preference -- **getPreferenceByKey**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *key:* `string` - Key of the target preference + * *preferences:* `any` - Details of updated preferences + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of preferences without deleted preference +* **getPreferenceByKey**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets local preference. - - _\_:_ `string` - Name of the target app - - _key:_ `string` - Key of the target preference - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of local preference -- **getPreferences**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *\_:* `string` - Name of the target app + * *key:* `string` - Key of the target preference + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of local preference +* **getPreferences**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets local preferences - - _\_:_ `string` - Name of the target app - - _key:_ `string` - Key of the target preference - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of local preferences -- **prepareLocalPreferenceResponse**(key: `string`): `any`
+ * *\_:* `string` - Name of the target app + * *key:* `string` - Key of the target preference + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of local preferences +* **prepareLocalPreferenceResponse**(key: `string`): `any`
- - _key:_ `string` - - - **Returns** `any` - -- **updatePreference**(\_: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *key:* `string` - + * **Returns** `any` - +* **updatePreference**(\_: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Updates local preference. - - _\_:_ `string` - Name of the target app - - _key:_ `string` - Key of the target preference - - _updatedPreference:_ `any` - Details of updated preference - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of updated local preferences + * *\_:* `string` - Name of the target app + * *key:* `string` - Key of the target preference + * *updatedPreference:* `any` - Details of updated preference + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of updated local preferences ## See also -- [User preference Cloud Service](user-preference-cloud.service.md) +* [User preference Cloud Service](user-preference-cloud.service.md) diff --git a/docs/process-services-cloud/services/process-cloud.service.md b/docs/process-services-cloud/services/process-cloud.service.md index 9e2197efe1..8243eab364 100644 --- a/docs/process-services-cloud/services/process-cloud.service.md +++ b/docs/process-services-cloud/services/process-cloud.service.md @@ -13,24 +13,28 @@ Manages cloud process instances. ### Methods -- **cancelProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+* **cancelProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Cancels a process. - - _appName:_ `string` - Name of the app - - _processInstanceId:_ `string` - Id of the process to cancel - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Operation Information -- **getBasePath**(appName: `string`): `string`
+ * *appName:* `string` - Name of the app + * *processInstanceId:* `string` - Id of the process to cancel + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Operation Information +* **getApplicationVersions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>`
+ Gets the application versions associated with an app. + * *appName:* `string` - Name of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>` - Array of Application Version Models +* **getBasePath**(appName: `string`): `string`
- - _appName:_ `string` - - - **Returns** `string` - -- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`
+ * *appName:* `string` - + * **Returns** `string` - +* **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`
Gets the process definitions associated with an app. - - _appName:_ `string` - Name of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions -- **getProcessInstanceById**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+ * *appName:* `string` - Name of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions +* **getProcessInstanceById**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Gets details of a process instance. - - _appName:_ `string` - Name of the app - - _processInstanceId:_ `string` - ID of the process instance whose details you want - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Process instance details + * *appName:* `string` - Name of the app + * *processInstanceId:* `string` - ID of the process instance whose details you want + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Process instance details ## Details @@ -41,5 +45,5 @@ but they use the cloud variants of the classes for return values. See the ## See also -- [Process list Cloud Service](process-list-cloud.service.md) -- [Process header cloud component](../../process-services-cloud/components/process-header-cloud.component.md) +* [Process list Cloud Service](process-list-cloud.service.md) +* [Process header cloud component](../../process-services-cloud/components/process-header-cloud.component.md) diff --git a/docs/process-services-cloud/services/process-filter-cloud.service.md b/docs/process-services-cloud/services/process-filter-cloud.service.md index b33af7df08..290ea2e366 100644 --- a/docs/process-services-cloud/services/process-filter-cloud.service.md +++ b/docs/process-services-cloud/services/process-filter-cloud.service.md @@ -7,37 +7,37 @@ Last reviewed: 2019-01-09 # [Process Filter Cloud Service](../../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts "Defined in process-filter-cloud.service.ts") -Manage Process Filters, which are pre-configured Process Instance queries. +Manage Process Filters, which are pre-configured Process Instance queries. ## Class members ### Methods -- **addFilter**(newFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`
+* **addFilter**(newFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`
Adds a new process instance filter - - _newFilter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process instance filters with newly added filter -- **deleteFilter**(deletedFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`
+ * *newFilter:* [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process instance filters with newly added filter +* **deleteFilter**(deletedFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`
Delete process instance filter - - _deletedFilter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process instance filters without deleted filter -- **getFilterById**(appName: `string`, id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>`
+ * *deletedFilter:* [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process instance filters without deleted filter +* **getFilterById**(appName: `string`, id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>`
Get process instance filter for given filter id - - _appName:_ `string` - Name of the target app - - _id:_ `string` - Id of the target process instance filter - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` - Observable of process instance filter details -- **getProcessFilters**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`
+ * *appName:* `string` - Name of the target app + * *id:* `string` - Id of the target process instance filter + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` - Observable of process instance filter details +* **getProcessFilters**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`
Gets all process instance filters for a process app. - - _appName:_ `string` - Name of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process filters details -- **isDefaultFilter**(filterName: `string`): `boolean`
+ * *appName:* `string` - Name of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process filters details +* **isDefaultFilter**(filterName: `string`): `boolean`
Checks if given filter is a default filter - - _filterName:_ `string` - Name of the target process filter - - **Returns** `boolean` - Boolean value for whether the filter is a default filter -- **updateFilter**(updatedFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`
+ * *filterName:* `string` - Name of the target process filter + * **Returns** `boolean` - Boolean value for whether the filter is a default filter +* **updateFilter**(updatedFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`
Update process instance filter - - _updatedFilter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process instance filters with updated filter + * *updatedFilter:* [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process instance filters with updated filter ## Inject Preference service @@ -62,7 +62,7 @@ import { LocalPreferenceCloudService, PROCESS_FILTERS_SERVICE_TOKEN } from '@alf export class ExampleModule {} ``` -If you would like to inject the [User Preference Cloud Service](../../process-services-cloud/services/user-preference-cloud.service.md), you can inject the service like below shown +If you would like to inject the [User Preference Cloud Service](../../process-services-cloud/services/user-preference-cloud.service.md), you can inject the service like below shown ```ts import { NgModule } from '@angular/core'; @@ -81,5 +81,5 @@ export class ExampleModule {} ## See also -- [Process filters cloud component](../components/process-filters-cloud.component.md) -- [Task filter cloud service](task-filter-cloud.service.md) +* [Process filters cloud component](../components/process-filters-cloud.component.md) +* [Task filter cloud service](task-filter-cloud.service.md) diff --git a/docs/process-services-cloud/services/process-list-cloud.service.md b/docs/process-services-cloud/services/process-list-cloud.service.md index e14da06598..9a59fa7092 100644 --- a/docs/process-services-cloud/services/process-list-cloud.service.md +++ b/docs/process-services-cloud/services/process-list-cloud.service.md @@ -13,14 +13,14 @@ Searches processes. ### Methods -- **getBasePath**(appName: `string`): `string`
+* **getBasePath**(appName: `string`): `string`
- - _appName:_ `string` - - - **Returns** `string` - -- **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - + * **Returns** `string` - +* **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Finds a process using an object with optional query properties. - - _requestNode:_ [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Process information + * *requestNode:* [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Process information ## Details @@ -40,4 +40,4 @@ For example : ## See also -- [App list cloud component](../components/app-list-cloud.component.md) +* [App list cloud component](../components/app-list-cloud.component.md) diff --git a/docs/process-services-cloud/services/start-process-cloud.service.md b/docs/process-services-cloud/services/start-process-cloud.service.md index e5fc3ce8c5..96f6265c9d 100644 --- a/docs/process-services-cloud/services/start-process-cloud.service.md +++ b/docs/process-services-cloud/services/start-process-cloud.service.md @@ -7,47 +7,47 @@ Last reviewed: 2019-01-09 # [Start Process Cloud Service](../../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts "Defined in start-process-cloud.service.ts") -Gets process definitions and starts processes. +Gets process definitions and starts processes. ## Class members ### Methods -- **createProcess**(appName: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+* **createProcess**(appName: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Create a process based on a process definition, name, form values or variables. - - _appName:_ `string` - name of the Application - - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just created -- **deleteProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + * *payload:* [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just created +* **deleteProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Delete an existing process instance - - _appName:_ `string` - name of the Application - - _processInstanceId:_ `string` - process instance to update - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - -- **getBasePath**(appName: `string`): `string`
+ * *appName:* `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + * *processInstanceId:* `string` - process instance to update + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - +* **getBasePath**(appName: `string`): `string`
- - _appName:_ `string` - - - **Returns** `string` - -- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`
+ * *appName:* `string` - + * **Returns** `string` - +* **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`
Gets the process definitions associated with an app. - - _appName:_ `string` - Name of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions -- **startCreatedProcess**(appName: `string`, createdProcessInstanceId: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+ * *appName:* `string` - Name of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions +* **startCreatedProcess**(appName: `string`, createdProcessInstanceId: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Starts an already created process using the process instance id. - - _appName:_ `string` - - - _createdProcessInstanceId:_ `string` - process instance id of the process previously created - - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started -- **startProcess**(appName: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+ * *appName:* `string` - + * *createdProcessInstanceId:* `string` - process instance id of the process previously created + * *payload:* [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started +* **startProcess**(appName: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Starts a process based on a process definition, name, form values or variables. - - _appName:_ `string` - name of the Application - - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started -- **updateProcess**(appName: `string`, processInstanceId: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+ * *appName:* `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + * *payload:* [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started +* **updateProcess**(appName: `string`, processInstanceId: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Update an existing process instance - - _appName:_ `string` - name of the Application - - _processInstanceId:_ `string` - process instance to update - - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started + * *appName:* `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + * *processInstanceId:* `string` - process instance to update + * *payload:* [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started ## Details @@ -59,4 +59,4 @@ combines the process details and variables conveniently into the ## See also -- [Process service](../../process-services/services/process.service.md) +* [Process service](../../process-services/services/process.service.md) diff --git a/docs/process-services-cloud/services/start-task-cloud.service.md b/docs/process-services-cloud/services/start-task-cloud.service.md index 66ca0cea96..2e501df5b0 100644 --- a/docs/process-services-cloud/services/start-task-cloud.service.md +++ b/docs/process-services-cloud/services/start-task-cloud.service.md @@ -7,20 +7,20 @@ Last reviewed: 2019-01-09 # [Start Task Cloud Service](../../../lib/process-services-cloud/src/lib/task/services/start-task-cloud.service.ts "Defined in start-task-cloud.service.ts") -Starts standalone tasks. +Starts standalone tasks. ## Class members ### Methods -- **createNewTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
- (**Deprecated:** in 3.5.0, use TaskCloudService instead. Creates a new standalone task.) - - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task to create - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task -- **getBasePath**(appName: `string`): `string`
+* **createNewTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ (**Deprecated:** in 3.5.0, use TaskCloudService instead. Creates a new standalone task.) + * *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task to create + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task +* **getBasePath**(appName: `string`): `string`
- - _appName:_ `string` - - - **Returns** `string` - + * *appName:* `string` - + * **Returns** `string` - ## Details @@ -31,4 +31,4 @@ but uses the cloud variants of the classes for the parameter and return value. S ## See also -- [Tasklist service](../../process-services/services/tasklist.service.md) +* [Tasklist service](../../process-services/services/tasklist.service.md) diff --git a/docs/process-services-cloud/services/task-cloud.service.md b/docs/process-services-cloud/services/task-cloud.service.md index d46db51767..f0aa662f17 100644 --- a/docs/process-services-cloud/services/task-cloud.service.md +++ b/docs/process-services-cloud/services/task-cloud.service.md @@ -13,84 +13,88 @@ Manages task cloud. ### Methods -- **assign**(appName: `string`, taskId: `string`, assignee: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+* **assign**(appName: `string`, taskId: `string`, assignee: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Updates the task assignee. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task to update assignee - - _assignee:_ `string` - assignee to update current user task assignee - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details with new assignee -- **canClaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the task to update assignee + * *assignee:* `string` - assignee to update current user task assignee + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details with new assignee +* **canClaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
Validate if a task can be claimed. - - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object - - **Returns** `boolean` - Boolean value if the task can be completed -- **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
+ * *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object + * **Returns** `boolean` - Boolean value if the task can be completed +* **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
Validate if a task can be completed. - - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object - - **Returns** `boolean` - Boolean value if the task can be completed -- **canUnclaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
+ * *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object + * **Returns** `boolean` - Boolean value if the task can be completed +* **canUnclaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
Validate if a task can be unclaimed. - - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object - - **Returns** `boolean` - Boolean value if the task can be completed -- **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ * *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object + * **Returns** `boolean` - Boolean value if the task can be completed +* **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Claims a task for an assignee. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task to claim - - _assignee:_ `string` - [User](../../../lib/core/pipes/user-initial.pipe.ts) to assign the task to - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the claimed task -- **completeTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the task to claim + * *assignee:* `string` - [User](../../../lib/core/pipes/user-initial.pipe.ts) to assign the task to + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the claimed task +* **completeTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Complete a task. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task to complete - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task that was completed -- **createNewTask**(startTaskRequest: [`StartTaskCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/start-task-cloud-request.model.ts), appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the task to complete + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task that was completed +* **createNewTask**(startTaskRequest: [`StartTaskCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/start-task-cloud-request.model.ts), appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Creates a new standalone task. - - _startTaskRequest:_ [`StartTaskCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/start-task-cloud-request.model.ts) - - - _appName:_ `string` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task -- **getBasePath**(appName: `string`): `string`
+ * *startTaskRequest:* [`StartTaskCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/start-task-cloud-request.model.ts) - + * *appName:* `string` - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task +* **getBasePath**(appName: `string`): `string`
- - _appName:_ `string` - - - **Returns** `string` - -- **getCandidateGroups**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - + * **Returns** `string` - +* **getCandidateGroups**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets candidate groups of the task. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Candidate groups -- **getCandidateUsers**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Candidate groups +* **getCandidateUsers**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets candidate users of the task. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Candidate users -- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`
- Gets the process definitions associated with an app. - - _appName:_ `string` - Name of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions -- **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
- Gets details of a task. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task whose details you want - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details -- **isAssigneePropertyClickable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts), candidateUsers: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`, candidateGroups: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`): `boolean`
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Candidate users +* **getPriorityLabel**(priority: `number`): `string`
- - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - - - _candidateUsers:_ [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` - - - _candidateGroups:_ [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` - - - **Returns** `boolean` - -- **isTaskEditable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
+ * *priority:* `number` - + * **Returns** `string` - +* **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`
+ Gets the process definitions associated with an app. + * *appName:* `string` - Name of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions +* **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ Gets details of a task. + * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the task whose details you want + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details +* **isAssigneePropertyClickable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts), candidateUsers: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`, candidateGroups: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`): `boolean`
+ + * *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - + * *candidateUsers:* [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` - + * *candidateGroups:* [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` - + * **Returns** `boolean` - +* **isTaskEditable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
Validate if a task is editable. - - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object - - **Returns** `boolean` - Boolean value if the task is editable -- **unclaimTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ * *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object + * **Returns** `boolean` - Boolean value if the task is editable +* **unclaimTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Un-claims a task. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task to unclaim - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task that was unclaimed -- **updateTask**(appName: `string`, taskId: `string`, payload: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the task to unclaim + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task that was unclaimed +* **updateTask**(appName: `string`, taskId: `string`, payload: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Updates the details (name, description, due date) for a task. - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task to update - - _payload:_ `any` - Data to update the task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details + * *appName:* `string` - Name of the app + * *taskId:* `string` - ID of the task to update + * *payload:* `any` - Data to update the task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details ## Details @@ -101,4 +105,4 @@ but they use the cloud variants of the classes for return values. See the ## See also -- [Tasklist service](../../process-services/services/tasklist.service.md) +* [Tasklist service](../../process-services/services/tasklist.service.md) diff --git a/docs/process-services-cloud/services/task-filter-cloud.service.md b/docs/process-services-cloud/services/task-filter-cloud.service.md index ede7437fac..57f683a0b6 100644 --- a/docs/process-services-cloud/services/task-filter-cloud.service.md +++ b/docs/process-services-cloud/services/task-filter-cloud.service.md @@ -13,31 +13,31 @@ Manages task filters. ### Methods -- **addFilter**(newFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`
+* **addFilter**(newFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`
Adds a new task filter. - - _newFilter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task instance filters with newly added filter -- **deleteFilter**(deletedFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`
+ * *newFilter:* [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task instance filters with newly added filter +* **deleteFilter**(deletedFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`
Deletes a task filter - - _deletedFilter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task instance filters without deleted filter -- **getTaskFilterById**(appName: `string`, id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>`
+ * *deletedFilter:* [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task instance filters without deleted filter +* **getTaskFilterById**(appName: `string`, id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>`
Gets a task filter. - - _appName:_ `string` - Name of the target app - - _id:_ `string` - ID of the task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` - Details of the task filter -- **getTaskListFilters**(appName?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`
+ * *appName:* `string` - Name of the target app + * *id:* `string` - ID of the task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` - Details of the task filter +* **getTaskListFilters**(appName?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`
Gets all task filters for a task app. - - _appName:_ `string` - (Optional) Name of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task filter details -- **isDefaultFilter**(filterName: `string`): `boolean`
+ * *appName:* `string` - (Optional) Name of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task filter details +* **isDefaultFilter**(filterName: `string`): `boolean`
Checks if given filter is a default filter - - _filterName:_ `string` - Name of the target task filter - - **Returns** `boolean` - Boolean value for whether the filter is a default filter -- **updateFilter**(updatedFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`
+ * *filterName:* `string` - Name of the target task filter + * **Returns** `boolean` - Boolean value for whether the filter is a default filter +* **updateFilter**(updatedFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`
Updates a task filter. - - _updatedFilter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task instance filters with updated filter + * *updatedFilter:* [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task instance filters with updated filter ## Details @@ -77,7 +77,7 @@ import { LocalPreferenceCloudService, TASK_FILTERS_SERVICE_TOKEN } from '@alfres export class ExampleModule {} ``` -If you would like to inject the [`UserPreferenceCloudService`](../../process-services-cloud/services/user-preference-cloud.service.md), you can inject the service like below shown +If you would like to inject the [`UserPreferenceCloudService`](../../process-services-cloud/services/user-preference-cloud.service.md), you can inject the service like below shown ```ts import { NgModule } from '@angular/core'; @@ -96,4 +96,4 @@ export class ExampleModule {} ## See also -- [Task filter service](../../process-services/services/task-filter.service.md) +* [Task filter service](../../process-services/services/task-filter.service.md) diff --git a/docs/process-services-cloud/services/task-list-cloud.service.md b/docs/process-services-cloud/services/task-list-cloud.service.md index b250f8b361..ed684f6026 100644 --- a/docs/process-services-cloud/services/task-list-cloud.service.md +++ b/docs/process-services-cloud/services/task-list-cloud.service.md @@ -7,20 +7,20 @@ Last reviewed: 2019-02-06 # [Task List Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts "Defined in task-list-cloud.service.ts") -Searches tasks. +Searches tasks. ## Class members ### Methods -- **getBasePath**(appName: `string`): `string`
+* **getBasePath**(appName: `string`): `string`
- - _appName:_ `string` - - - **Returns** `string` - -- **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - + * **Returns** `string` - +* **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Finds a task using an object with optional query properties. - - _requestNode:_ [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Task information + * *requestNode:* [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Task information ## Details diff --git a/docs/process-services-cloud/services/user-preference-cloud.service.md b/docs/process-services-cloud/services/user-preference-cloud.service.md index ed27c84334..4489d11c9f 100644 --- a/docs/process-services-cloud/services/user-preference-cloud.service.md +++ b/docs/process-services-cloud/services/user-preference-cloud.service.md @@ -7,43 +7,43 @@ Last reviewed: 2019-08-06 # [User Preference Cloud Service](../../../lib/process-services-cloud/src/lib/services/user-preference-cloud.service.ts "Defined in user-preference-cloud.service.ts") -Manages user preferences. +Manages user preferences. ## Class members ### Methods -- **createPreference**(appName: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **createPreference**(appName: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Creates user preference. - - _appName:_ `string` - Name of the target app - - _key:_ `string` - Key of the target preference - - _newPreference:_ `any` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of created user preferences -- **deletePreference**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - Name of the target app + * *key:* `string` - Key of the target preference + * *newPreference:* `any` - + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of created user preferences +* **deletePreference**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes user preference by given preference key. - - _appName:_ `string` - Name of the target app - - _key:_ `string` - Key of the target preference - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of delete operation status -- **getBasePath**(appName: `string`): `string`
+ * *appName:* `string` - Name of the target app + * *key:* `string` - Key of the target preference + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of delete operation status +* **getBasePath**(appName: `string`): `string`
- - _appName:_ `string` - - - **Returns** `string` - -- **getPreferenceByKey**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - + * **Returns** `string` - +* **getPreferenceByKey**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets user preference. - - _appName:_ `string` - Name of the target app - - _key:_ `string` - Key of the target preference - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of user preference -- **getPreferences**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - Name of the target app + * *key:* `string` - Key of the target preference + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of user preference +* **getPreferences**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets user preferences - - _appName:_ `string` - Name of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of user preferences -- **updatePreference**(appName: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *appName:* `string` - Name of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of user preferences +* **updatePreference**(appName: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Updates user preference. - - _appName:_ `string` - Name of the target app - - _key:_ `string` - Key of the target preference - - _updatedPreference:_ `any` - Details of updated preference - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of updated user preferences + * *appName:* `string` - Name of the target app + * *key:* `string` - Key of the target preference + * *updatedPreference:* `any` - Details of updated preference + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable of updated user preferences ## See also -- [Local preference Cloud Service](local-preference-cloud.service.md) +* [Local preference Cloud Service](local-preference-cloud.service.md) diff --git a/docs/process-services/components/apps-list.component.md b/docs/process-services/components/apps-list.component.md index 75a8a10740..09b38aad39 100644 --- a/docs/process-services/components/apps-list.component.md +++ b/docs/process-services/components/apps-list.component.md @@ -37,17 +37,17 @@ You can show custom content when there are no apps available by supplying an ### Properties -| Name | Type | Default value | Description | -| ------------ | -------- | ------------- | ------------------------------------------------------------------------------------------------ | -| filtersAppId | `any[]` | | Provides a way to filter the apps to show. | -| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| filtersAppId | `any[]` | | Provides a way to filter the apps to show. | +| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | ### Events -| Name | Type | Description | -| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when an app entry is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| error | `EventEmitter` | Emitted when an error occurs. | ## Details diff --git a/docs/process-services/components/attach-form.component.md b/docs/process-services/components/attach-form.component.md index fa2562a2e5..a711641a70 100644 --- a/docs/process-services/components/attach-form.component.md +++ b/docs/process-services/components/attach-form.component.md @@ -21,15 +21,15 @@ This component can be used when there is no form attached to a task and you want ### Properties -| Name | Type | Default value | Description | -| ------- | ----- | ------------- | --------------------------------- | -| formKey | `any` | | Identifier of the form to attach. | -| taskId | `any` | | Id of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| formKey | `any` | | Identifier of the form to attach. | +| taskId | `any` | | Id of the task. | ### Events -| Name | Type | Description | -| ---------------- | ------------------------------------------------------------------ | ----------------------------------------------- | -| cancelAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form is attached successfully. | +| Name | Type | Description | +| --- | --- | --- | +| cancelAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | `EventEmitter` | Emitted when the form is attached successfully. | diff --git a/docs/process-services/components/checklist.component.md b/docs/process-services/components/checklist.component.md index 4b636a7c6f..c22f3a4b2d 100644 --- a/docs/process-services/components/checklist.component.md +++ b/docs/process-services/components/checklist.component.md @@ -23,16 +23,16 @@ Shows the checklist task functionality. ### Properties -| Name | Type | Default value | Description | -| -------- | --------- | ------------- | --------------------------------------------------------------------------------------- | -| assignee | `string` | | (required) The assignee id that the subtasks are assigned to. | -| readOnly | `boolean` | false | Toggle readonly state of the form. All form widgets will render as readonly if enabled. | -| taskId | `string` | | (required) The id of the parent task to which subtasks are attached. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| assignee | `string` | | (required) The assignee id that the subtasks are assigned to. | +| readOnly | `boolean` | false | Toggle readonly state of the form. All form widgets will render as readonly if enabled. | +| taskId | `string` | | (required) The id of the parent task to which subtasks are attached. | ### Events -| Name | Type | Description | -| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | checklistTaskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` | Emitted when a new checklist task is created. | -| checklistTaskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklist task is deleted. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| checklistTaskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklist task is deleted. | +| error | `EventEmitter` | Emitted when an error occurs. | diff --git a/docs/process-services/components/create-process-attachment.component.md b/docs/process-services/components/create-process-attachment.component.md index 0cdc245272..51f73f297c 100644 --- a/docs/process-services/components/create-process-attachment.component.md +++ b/docs/process-services/components/create-process-attachment.component.md @@ -25,13 +25,13 @@ Displays an Upload Component (Drag and Click) to upload the attachment to a spec ### Properties -| Name | Type | Default value | Description | -| ----------------- | -------- | ------------- | ----------------------------------------------------- | -| processInstanceId | `string` | | (required) The ID of the process instance to display. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| processInstanceId | `string` | | (required) The ID of the process instance to display. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is successfully created or uploaded from within the component. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is successfully created or uploaded from within the component. | diff --git a/docs/process-services/components/create-task-attachment.component.md b/docs/process-services/components/create-task-attachment.component.md index fdac3ec614..f131e74a58 100644 --- a/docs/process-services/components/create-task-attachment.component.md +++ b/docs/process-services/components/create-task-attachment.component.md @@ -25,13 +25,13 @@ Displays an Upload Component (Drag and Click) to upload the attachment to a spec ### Properties -| Name | Type | Default value | Description | -| ------ | -------- | ------------- | ------------------------------------------------- | -| taskId | `string` | | (required) The numeric ID of the task to display. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| taskId | `string` | | (required) The numeric ID of the task to display. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is created or uploaded successfully from within the component. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is created or uploaded successfully from within the component. | diff --git a/docs/process-services/components/form.component.md b/docs/process-services/components/form.component.md index a35695e338..d8e937fcad 100644 --- a/docs/process-services/components/form.component.md +++ b/docs/process-services/components/form.component.md @@ -13,18 +13,18 @@ Shows a [`Form`](../../../lib/process-services/src/lib/task-list/models/form.mod ## Contents -- [Basic Usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Displaying a form](#displaying-a-form) - - [Controlling outcome execution behaviour](#controlling-outcome-execution-behaviour) - - [Field Validators](#field-validators) - - [Common scenarios](#common-scenarios) - - [Alfresco Repositories APS configuration](#alfresco-repositories-aps-configuration) -- [See also](#see-also) +* [Basic Usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Displaying a form](#displaying-a-form) + * [Controlling outcome execution behaviour](#controlling-outcome-execution-behaviour) + * [Field Validators](#field-validators) + * [Common scenarios](#common-scenarios) + * [Alfresco Repositories APS configuration](#alfresco-repositories-aps-configuration) +* [See also](#see-also) ## Basic Usage @@ -52,41 +52,41 @@ Any content in the body of `` will be shown when no form definition is ### Properties -| Name | Type | Default value | Description | -| ------------------------- | -------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------- | -| 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. | -| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | -| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | -| enableFixedSpacedForm | `boolean` | true | The form will set a prefixed space for invisible fields. | -| 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. | -| formId | `number` | | 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. | -| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | -| nodeId | `string` | | Content Services node ID for the form metadata. | -| path | `string` | | Path of the folder where the metadata will be stored. | -| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | -| saveMetadata | `boolean` | false | Toggle saving of form metadata. | -| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | -| showRefreshButton | `boolean` | true | Toggle rendering of the `Refresh` button. | -| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | -| showTitle | `boolean` | true | Toggle rendering of the form title. | -| showValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | -| taskId | `string` | | Task id to fetch corresponding form and values. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| 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. | +| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | +| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | +| enableFixedSpacedForm | `boolean` | true | The form will set a prefixed space for invisible fields. | +| 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. | +| formId | `number` | | 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. | +| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | +| nodeId | `string` | | Content Services node ID for the form metadata. | +| path | `string` | | Path of the folder where the metadata will be stored. | +| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | +| saveMetadata | `boolean` | false | Toggle saving of form metadata. | +| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` outcome button. | +| showRefreshButton | `boolean` | true | Toggle rendering of the `Refresh` button. | +| showSaveButton | `boolean` | true | Toggle rendering of the `Save` outcome button. | +| showTitle | `boolean` | true | Toggle rendering of the form title. | +| showValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | +| taskId | `string` | | Task id to fetch corresponding form and values. | ### Events -| Name | Type | Description | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| 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 form content 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. | -| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/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. | -| 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. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| 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 form content is clicked. | +| formDataRefreshed | `EventEmitter` | Emitted when form values are refreshed due to a data property change. | +| formError | `EventEmitter` | Emitted when the supplied form values have a validation error. | +| formLoaded | `EventEmitter` | Emitted when the form is loaded or reloaded. | +| formSaved | `EventEmitter` | Emitted when the form is submitted with the `Save` or custom outcomes. | ## Details @@ -188,7 +188,7 @@ In unusual circumstances, you may need to take complete control of form outcome You can do this by implementing the `executeOutcome` event, which is emitted for both system outcomes and custom ones. -Note that by default, the code in your `executeOutcome` handler is executed _before_ the default +Note that by default, the code in your `executeOutcome` handler is executed *before* the default behavior but you can switch the default behavior off using `event.preventDefault()`. You might want to do this, for example, to provide custom form validation or to show a summary of the form validation before it is submitted. @@ -229,8 +229,8 @@ export class MyView { There are two other functions that can be very useful when you need to control form outcomes: -- `saveTaskForm()` - Saves the current form -- `completeTaskForm(outcome?: string)` Saves and completes the form with a given outcome name +* `saveTaskForm()` - Saves the current form +* `completeTaskForm(outcome?: string)` Saves and completes the form with a given outcome name ### Field Validators @@ -362,8 +362,8 @@ Also, don't forget to set the `providers` property to `ALL` in the `app.config.j ## See also -- [Form Field Validator interface](../../core/interfaces/form-field-validator.interface.md) -- [Extensibility](../../user-guide/extensibility.md) -- [Form rendering service](../../core/services/form-rendering.service.md) -- [Form field model](../../core/models/form-field.model.md) -- [Form service](../../core/services/form.service.md) +* [Form Field Validator interface](../../core/interfaces/form-field-validator.interface.md) +* [Extensibility](../../user-guide/extensibility.md) +* [Form rendering service](../../core/services/form-rendering.service.md) +* [Form field model](../../core/models/form-field.model.md) +* [Form service](../../core/services/form.service.md) diff --git a/docs/process-services/components/people-list.component.md b/docs/process-services/components/people-list.component.md index 259b1ce3ba..d826d517cc 100644 --- a/docs/process-services/components/people-list.component.md +++ b/docs/process-services/components/people-list.component.md @@ -76,14 +76,14 @@ You can use column templates with the [people list component](people-list.compon ### Properties -| Name | Type | Default value | Description | -| ------- | ----------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------- | -| actions | `boolean` | false | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. | -| users | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | | The array of user data used to populate the people list. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| actions | `boolean` | false | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. | +| users | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | | The array of user data used to populate the people list. | ### Events -| Name | Type | Description | -| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | clickAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserEventModel`](../../../lib/process-services/src/lib/task-list/models/user-event.model.ts)`>` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. | -| clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when the user clicks a row in the people list. | +| clickRow | `EventEmitter` | Emitted when the user clicks a row in the people list. | diff --git a/docs/process-services/components/people-search.component.md b/docs/process-services/components/people-search.component.md index 8218c8c4b4..1ac06c8c5a 100644 --- a/docs/process-services/components/people-search.component.md +++ b/docs/process-services/components/people-search.component.md @@ -31,17 +31,17 @@ special sub-components in the body of the `` element: ### Properties -| Name | Type | Default value | Description | -| ------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------- | -| results | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` | | Parameters for displaying the list. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| results | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` | | Parameters for displaying the list. | ### Events -| Name | Type | Description | -| ------------ | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "close" button is clicked. | -| searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a search is performed with a new keyword. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when a user is selected and the action button is clicked. | +| Name | Type | Description | +| --- | --- | --- | +| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "close" button is clicked. | +| searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a search is performed with a new keyword. | +| success | `EventEmitter` | Emitted when a user is selected and the action button is clicked. | ## Details diff --git a/docs/process-services/components/people.component.md b/docs/process-services/components/people.component.md index c5b7317736..6f05520d2f 100644 --- a/docs/process-services/components/people.component.md +++ b/docs/process-services/components/people.component.md @@ -13,15 +13,15 @@ Displays users involved with a specified task ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) -- [Details](#details) - - [How to customize the people component behavior](#how-to-customize-the-people-component-behavior) - - [Involve People single click and close search](#involve-people-single-click-and-close-search) - - [Involve People single click without close search](#involve-people-single-click-without-close-search) - - [Involve People double click and close search](#involve-people-double-click-and-close-search) - - [Involve People double double without close search](#involve-people-double-double-without-close-search) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) +* [Details](#details) + * [How to customize the people component behavior](#how-to-customize-the-people-component-behavior) + * [Involve People single click and close search](#involve-people-single-click-and-close-search) + * [Involve People single click without close search](#involve-people-single-click-without-close-search) + * [Involve People double click and close search](#involve-people-double-click-and-close-search) + * [Involve People double double without close search](#involve-people-double-double-without-close-search) ## Basic Usage @@ -37,11 +37,11 @@ Displays users involved with a specified task ### Properties -| Name | Type | Default value | Description | -| -------- | ----------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------- | -| people | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | \[] | The array of [User](../../../lib/core/pipes/user-initial.pipe.ts) objects to display. | -| readOnly | `boolean` | false | Should the data be read-only? | -| taskId | `string` | "" | The numeric ID of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| people | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | \[] | The array of [`User`](../../../lib/core/pipes/user-initial.pipe.ts) objects to display. | +| readOnly | `boolean` | false | Should the data be read-only? | +| taskId | `string` | "" | The numeric ID of the task. | ## Details @@ -49,8 +49,8 @@ Displays users involved with a specified task The [people component](people.component.md) provides two options to customize its behavior: -- _involveUserAndCloseSearch_: The selected user gets added and then the search section is closed -- _involveUserWithoutCloseSearch_: The selected user gets added without closing the search section +* *involveUserAndCloseSearch*: The selected user gets added and then the search section is closed +* *involveUserWithoutCloseSearch*: The selected user gets added without closing the search section This makes it easy to customize the [people component](people.component.md) to involve the user via a single or double click event: diff --git a/docs/process-services/components/process-attachment-list.component.md b/docs/process-services/components/process-attachment-list.component.md index 5f62b129ed..0bea774e95 100644 --- a/docs/process-services/components/process-attachment-list.component.md +++ b/docs/process-services/components/process-attachment-list.component.md @@ -58,18 +58,18 @@ A default template will be used if you don't supply a custom one to override it: ### Properties -| Name | Type | Default value | Description | -| ----------------- | --------- | ------------- | --------------------------------------------------------- | -| disabled | `boolean` | false | Disable/Enable read-only mode for attachment list. | -| processInstanceId | `string` | | (**required**) The ID of the process instance to display. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| disabled | `boolean` | false | Disable/Enable read-only mode for attachment list. | +| processInstanceId | `string` | | (**required**) The ID of the process instance to display. | ### Events -| Name | Type | Description | -| --------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| Name | Type | Description | +| --- | --- | --- | +| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | +| success | `EventEmitter` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details @@ -78,7 +78,7 @@ A default template will be used if you don't supply a custom one to override it: You can wrap the attachment list with an [Upload Drag Area component](../../content-services/components/upload-drag-area.component.md) to let the user upload attachments to empty lists. When you do this, you can also supply -a custom _no content template_ (using <adf-empty-list>) to invite the user to add their attachments: +a custom *no content template* (using \) to invite the user to add their attachments: diff --git a/docs/process-services/components/process-comments.component.md b/docs/process-services/components/process-comments.component.md index e6d4df5b1e..099546a9fc 100644 --- a/docs/process-services/components/process-comments.component.md +++ b/docs/process-services/components/process-comments.component.md @@ -20,13 +20,13 @@ Displays comments associated with a particular process instance and allows the u ### Properties -| Name | Type | Default value | Description | -| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------ | -| processInstanceId | `string` | | (**required**) The numeric ID of the process instance to display comments for. | -| readOnly | `boolean` | true | Should the comments be read-only? | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| processInstanceId | `string` | | (**required**) The numeric ID of the process instance to display comments for. | +| readOnly | `boolean` | true | Should the comments be read-only? | ### Events -| Name | Type | Description | -| ----- | ----------------------------------------------------------------- | ----------------------------- | +| Name | Type | Description | +| --- | --- | --- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/components/process-filters.component.md b/docs/process-services/components/process-filters.component.md index 76c15814ea..72e0a2029f 100644 --- a/docs/process-services/components/process-filters.component.md +++ b/docs/process-services/components/process-filters.component.md @@ -11,14 +11,14 @@ Collection of criteria used to filter process instances, which may be customized ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [How filter the activiti process filters](#how-filter-the-activiti-process-filters) - - [FilterParamsModel](#filterparamsmodel) -- [See also](#see-also) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [How filter the activiti process filters](#how-filter-the-activiti-process-filters) + * [FilterParamsModel](#filterparamsmodel) +* [See also](#see-also) ## Basic Usage @@ -32,21 +32,21 @@ Collection of criteria used to filter process instances, which may be customized ### Properties -| Name | Type | Default value | Description | -| ----------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| appId | `number` | | Display filters available to the current user for the application with the specified ID. | -| appName | `string` | | Display filters available to the current user for the application with the specified name. | -| filterParam | [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. | -| showIcon | `boolean` | true | Toggle to show or hide the filter's icon. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appId | `number` | | Display filters available to the current user for the application with the specified ID. | +| appName | `string` | | Display filters available to the current user for the application with the specified name. | +| filterParam | [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. | +| showIcon | `boolean` | true | Toggle to show or hide the filter's icon. | ### Events -| Name | Type | Description | -| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when a filter is being selected based on the filterParam input. | -| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when a filter is being clicked from the UI. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`[]>` | Emitted when the list of filters has been successfully loaded from the server. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when a filter is being clicked from the UI. | +| filterSelected | `EventEmitter` | Emitted when a filter is being selected based on the filterParam input. | +| success | `EventEmitter` | Emitted when the list of filters has been successfully loaded from the server. | ## Details @@ -86,4 +86,4 @@ You can use inside the filterParam one of the properties defined by [`FilterPara ## See also -- [Process Filter service](../services/process-filter.service.md) +* [Process Filter service](../services/process-filter.service.md) diff --git a/docs/process-services/components/process-instance-details.component.md b/docs/process-services/components/process-instance-details.component.md index 72f42740b9..272f02a6e9 100644 --- a/docs/process-services/components/process-instance-details.component.md +++ b/docs/process-services/components/process-instance-details.component.md @@ -21,17 +21,17 @@ Displays detailed information about a specified process instance ### Properties -| Name | Type | Default value | Description | -| ----------------- | --------- | ------------- | ------------------------------------------------------------- | -| processInstanceId | `string` | | (required) The numeric ID of the process instance to display. | -| showRefreshButton | `boolean` | true | Toggles whether to show or hide the refresh button. | -| showTitle | `boolean` | true | Toggles whether to show or hide the title. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| processInstanceId | `string` | | (required) The numeric ID of the process instance to display. | +| showRefreshButton | `boolean` | true | Toggles whether to show or hide the refresh button. | +| showTitle | `boolean` | true | Toggles whether to show or hide the title. | ### Events -| Name | Type | Description | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| processCancelled | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the current process is cancelled by the user from within the component. | -| showProcessDiagram | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "show diagram" button is clicked. | -| taskClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsEvent`](../../../lib/process-services/src/lib/task-list/models/task-details.event.ts)`>` | Emitted when a task is clicked. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| processCancelled | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the current process is cancelled by the user from within the component. | +| showProcessDiagram | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "show diagram" button is clicked. | +| taskClick | `EventEmitter` | Emitted when a task is clicked. | diff --git a/docs/process-services/components/process-instance-header.component.md b/docs/process-services/components/process-instance-header.component.md index 1a505d6d66..08bbe8f26d 100644 --- a/docs/process-services/components/process-instance-header.component.md +++ b/docs/process-services/components/process-instance-header.component.md @@ -23,16 +23,16 @@ Sub-component of the process details component, which renders some general infor ### Properties -| Name | Type | Default value | Description | -| --------------- | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------- | -| processInstance | [`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts) | | (**required**) Full details of the process instance to display information about. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| processInstance | [`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts) | | (**required**) Full details of the process instance to display information about. | ## Details ### Choosing which properties are displayed By default all the properties are displayed: -**_status_**, **_ended_**, **_category_**, **_businessKey_**, **_createdBy_**, **_created_**,**_id_**, **_description_**. +***status***, ***ended***, ***category***, ***businessKey***, ***createdBy***, ***created***,***id***, ***description***. You can customize which properties are displayed using a setting in `app.config.json`. The configuration looks like the following sample: diff --git a/docs/process-services/components/process-instance-tasks.component.md b/docs/process-services/components/process-instance-tasks.component.md index b2c2fba086..3d6485e189 100644 --- a/docs/process-services/components/process-instance-tasks.component.md +++ b/docs/process-services/components/process-instance-tasks.component.md @@ -22,14 +22,14 @@ Lists both the active and completed tasks associated with a particular process i ### Properties -| Name | Type | Default value | Description | -| ---------------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------- | -| processInstanceDetails | [`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts) | | (**required**) The ID of the process instance to display tasks for. | -| showRefreshButton | `boolean` | true | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| processInstanceDetails | [`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts) | | (**required**) The ID of the process instance to display tasks for. | +| showRefreshButton | `boolean` | true | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. | ### Events -| Name | Type | Description | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | taskClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsEvent`](../../../lib/process-services/src/lib/task-list/models/task-details.event.ts)`>` | Emitted when a task is clicked. | diff --git a/docs/process-services/components/process-list.component.md b/docs/process-services/components/process-list.component.md index 7d94f26756..85ac273498 100644 --- a/docs/process-services/components/process-list.component.md +++ b/docs/process-services/components/process-list.component.md @@ -11,15 +11,15 @@ Renders a list containing all the process instances matched by the parameters sp ## Contents -- [Basic Usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) - - [Pagination strategy](#pagination-strategy) -- [See also](#see-also) +* [Basic Usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) + * [Pagination strategy](#pagination-strategy) +* [See also](#see-also) ## Basic Usage @@ -49,32 +49,32 @@ when the process list is empty: ### Properties -| Name | Type | Default value | Description | -| ------------------- | --------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| appId | `number` | | The id of the app. | -| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source to define the datatable. | -| multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row | -| page | `number` | 0 | The page number of the processes to fetch. | -| presetColumn | `string` | | Custom preset column schema in JSON format. | -| processDefinitionId | `string` | | The [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | -| processInstanceId | `number \| string` | | The id of the process instance. | -| resolverFn | `Function` | null | Resolver function is used to show dynamic complex column objects see the docs to learn how to configure a resolverFn. | -| selectFirstRow | `boolean` | true | Toggles default selection of the first row | -| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | -| size | `number` | | The number of processes to fetch in each page. | -| sort | `string` | | Defines the sort ordering of the list. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc`. | -| state | `string` | | Defines the state of the processes. Possible values are `running`, `completed` and `all` | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appId | `number` | | The id of the app. | +| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source to define the datatable. | +| multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row | +| page | `number` | 0 | The page number of the processes to fetch. | +| presetColumn | `string` | | Custom preset column schema in JSON format. | +| processDefinitionId | `string` | | The [`Definition`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | +| processInstanceId | `number \| string` | | The id of the process instance. | +| resolverFn | `Function` | null | Resolver function is used to show dynamic complex column objects see the docs to learn how to configure a resolverFn. | +| selectFirstRow | `boolean` | true | Toggles default selection of the first row | +| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | +| size | `number` | | The number of processes to fetch in each page. | +| sort | `string` | | Defines the sort ordering of the list. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc`. | +| state | `string` | | Defines the state of the processes. Possible values are `running`, `completed` and `all` | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | ### Events -| Name | Type | Description | -| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | -| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| success | `EventEmitter` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details @@ -234,6 +234,6 @@ documentation for more details on the format and behavior of context actions. ## See also -- [Data column component](../../core/components/data-column.component.md) -- [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) -- [Pagination component](../../core/components/pagination.component.md) +* [Data column component](../../core/components/data-column.component.md) +* [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) +* [Pagination component](../../core/components/pagination.component.md) diff --git a/docs/process-services/components/start-process.component.md b/docs/process-services/components/start-process.component.md index 7a4464dfb6..04cf625ce2 100644 --- a/docs/process-services/components/start-process.component.md +++ b/docs/process-services/components/start-process.component.md @@ -13,18 +13,18 @@ Starts a process. ## Contents -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Starting a process with a default name and pre-selected process definition name](#starting-a-process-with-a-default-name-and-pre-selected-process-definition-name) - - [Starting a process not included in an app](#starting-a-process-not-included-in-an-app) - - [Custom data example](#custom-data-example) - - [Attaching a File to the start form of the process](#attaching-a-file-to-the-start-form-of-the-process) - - [Starting a process with a selected application](#starting-a-process-with-a-selected-application) - - [Error handling](#error-handling) -- [See also](#see-also) +* [Basic Usage](#basic-usage) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Starting a process with a default name and pre-selected process definition name](#starting-a-process-with-a-default-name-and-pre-selected-process-definition-name) + * [Starting a process not included in an app](#starting-a-process-not-included-in-an-app) + * [Custom data example](#custom-data-example) + * [Attaching a File to the start form of the process](#attaching-a-file-to-the-start-form-of-the-process) + * [Starting a process with a selected application](#starting-a-process-with-a-selected-application) + * [Error handling](#error-handling) +* [See also](#see-also) ## Basic Usage @@ -38,27 +38,27 @@ Starts a process. ### Properties -| Name | Type | Default value | Description | -| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| appId | `number` | | (optional) Limit the list of processes that can be started to those contained in the specified app. | -| name | `string` | "" | (optional) Name to assign to the current process. | -| processDefinitionName | `string` | | (optional) [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) name of the process to start. | -| processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. | -| showSelectApplicationDropdown | `boolean` | false | (optional) Hide or show application selection dropdown. | -| showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. | -| title | `string` | | (optional) Define the header of the component. | -| values | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. | -| variables | [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/RestVariable.md). | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appId | `number` | | (optional) Limit the list of processes that can be started to those contained in the specified app. | +| name | `string` | "" | (optional) Name to assign to the current process. | +| processDefinitionName | `string` | | (optional) [`Definition`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) name of the process to start. | +| processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. | +| showSelectApplicationDropdown | `boolean` | false | (optional) Hide or show application selection dropdown. | +| showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. | +| title | `string` | | (optional) Define the header of the component. | +| values | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. | +| variables | [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md). | ### Events -| Name | Type | Description | -| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| applicationSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when application selection changes. | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the process is canceled. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`>` | Emitted when process definition selection changes. | -| start | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when the process starts. | +| Name | Type | Description | +| --- | --- | --- | +| applicationSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when application selection changes. | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the process is canceled. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| processDefinitionSelection | `EventEmitter` | Emitted when process definition selection changes. | +| start | `EventEmitter` | Emitted when the process starts. | ## Details @@ -85,7 +85,7 @@ property to set the name shown on the dropdown item. ``` -Use `processDefinitionName` to set the dropdown item as in the example above. +Use `processDefinitionName` to set the dropdown item as in the example above. ### Custom data example @@ -115,8 +115,8 @@ const formValues: FormValues = { You can see a repository in the Alfresco Repositories list once it is created in APS. If the repository is set up with an ID value of anything other than 1 then you will need to declare it in `app.config.json`. For example, if the repository's ID is 1002 and its -name is _alfresco_ then you would set the `alfrescoRepositoryName` property in`app.config.json` -to _alfresco-1002_ as follows: +name is *alfresco* then you would set the `alfrescoRepositoryName` property in`app.config.json` +to *alfresco-1002* as follows: ```json { @@ -218,4 +218,4 @@ When an error occurs, the component will emit an error event that can be used to ## See also -- [Select Apps Dialog component](select-apps-dialog.component.md) +* [Select Apps Dialog component](select-apps-dialog.component.md) diff --git a/docs/process-services/components/start-task.component.md b/docs/process-services/components/start-task.component.md index 70669d4698..29d753411a 100644 --- a/docs/process-services/components/start-task.component.md +++ b/docs/process-services/components/start-task.component.md @@ -24,15 +24,15 @@ Creates/Starts a new task for the specified app. ### Properties -| Name | Type | Default value | Description | -| ----- | -------- | ------------- | ----------------------------- | -| appId | `number` | | (required) The id of the app. | -| name | `string` | "" | Default Task Name. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appId | `number` | | (required) The id of the app. | +| name | `string` | "" | Default Task Name. | ### Events -| Name | Type | Description | -| ------- | ------------------------------------------------------------------ | ------------------------------------------------------ | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is successfully created. | +| Name | Type | Description | +| --- | --- | --- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| success | `EventEmitter` | Emitted when the task is successfully created. | diff --git a/docs/process-services/components/task-attachment-list.component.md b/docs/process-services/components/task-attachment-list.component.md index 08471c6846..1f837051f3 100644 --- a/docs/process-services/components/task-attachment-list.component.md +++ b/docs/process-services/components/task-attachment-list.component.md @@ -13,14 +13,14 @@ Displays documents attached to a specified task. ## Contents -- [Basic Usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [How to Add Drag and Drop Functionality](#how-to-add-drag-and-drop-functionality) -- [See also](#see-also) +* [Basic Usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [How to Add Drag and Drop Functionality](#how-to-add-drag-and-drop-functionality) +* [See also](#see-also) ## Basic Usage @@ -52,18 +52,18 @@ A default "no content" template is displayed if you don't supply one to override ### Properties -| Name | Type | Default value | Description | -| -------- | --------- | ------------- | -------------------------------------------------- | -| disabled | `boolean` | false | Disable/Enable read only mode for attachment list. | -| taskId | `string` | | (**required**) The ID of the task to display. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| disabled | `boolean` | false | Disable/Enable read only mode for attachment list. | +| taskId | `string` | | (**required**) The ID of the task to display. | ### Events -| Name | Type | Description | -| --------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while fetching the attachments. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| Name | Type | Description | +| --- | --- | --- | +| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while fetching the attachments. | +| success | `EventEmitter` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details @@ -71,7 +71,7 @@ A default "no content" template is displayed if you don't supply one to override You can wrap the component with an [Upload Drag Area component](../../content-services/components/upload-drag-area.component.md) to enable the user to upload attachments for empty lists. When you do this, you can also pass -a custom _no content template_ as shown below. The component invites the user to drag files to +a custom *no content template* as shown below. The component invites the user to drag files to upload whenever the list is empty. @@ -116,4 +116,4 @@ export class MyCustomTaskAttachmentComponent { ## See also -- [Upload Drag Area Component](../../content-services/components/upload-drag-area.component.md) +* [Upload Drag Area Component](../../content-services/components/upload-drag-area.component.md) diff --git a/docs/process-services/components/task-details.component.md b/docs/process-services/components/task-details.component.md index f7d58911a6..b2add16b91 100644 --- a/docs/process-services/components/task-details.component.md +++ b/docs/process-services/components/task-details.component.md @@ -21,38 +21,38 @@ Shows the details of the task ID passed in as input. ### Properties -| Name | Type | Default value | Description | -| ---------------------- | -------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------- | -| debugMode | `boolean` | false | Toggles debug mode. | -| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | -| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | -| showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. | -| showComments | `boolean` | true | Toggles `Comments` feature for the Header component. | -| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | -| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. | -| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. | -| showFormTitle | `boolean` | false | Toggles rendering of the form title. | -| showHeader | `boolean` | true | Toggles task details Header component. | -| showHeaderContent | `boolean` | true | Toggles collapsed/expanded state of the Header component. | -| showInvolvePeople | `boolean` | true | Toggles `Involve People` feature for the Header component. | -| showNextTask | `boolean` | true | Automatically renders the next task when the current one is completed. | -| taskId | `string` | | (**required**) The id of the task whose details we are asking for. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| debugMode | `boolean` | false | Toggles debug mode. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | +| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | +| showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. | +| showComments | `boolean` | true | Toggles `Comments` feature for the Header component. | +| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | +| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. | +| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. | +| showFormTitle | `boolean` | false | Toggles rendering of the form title. | +| showHeader | `boolean` | true | Toggles task details Header component. | +| showHeaderContent | `boolean` | true | Toggles collapsed/expanded state of the Header component. | +| showInvolvePeople | `boolean` | true | Toggles `Involve People` feature for the Header component. | +| showNextTask | `boolean` | true | Automatically renders the next task when the current one is completed. | +| taskId | `string` | | (**required**) The id of the task whose details we are asking for. | ### Events -| Name | Type | Description | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is assigned. | -| claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is claimed. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| 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 the form field content is clicked. | -| 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. | -| taskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` | Emitted when a checklist task is created. | -| taskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklist task is deleted. | -| unClaimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is unclaimed. | +| Name | Type | Description | +| --- | --- | --- | +| assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is assigned. | +| claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is claimed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| 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 the form field content is clicked. | +| formLoaded | `EventEmitter` | Emitted when the form is loaded or reloaded. | +| formSaved | `EventEmitter` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| taskCreated | `EventEmitter` | Emitted when a checklist task is created. | +| taskDeleted | `EventEmitter` | Emitted when a checklist task is deleted. | +| unClaimedTask | `EventEmitter` | Emitted when a task is unclaimed. | ## Details diff --git a/docs/process-services/components/task-filters.component.md b/docs/process-services/components/task-filters.component.md index 6439adfd12..7fa59d2dda 100644 --- a/docs/process-services/components/task-filters.component.md +++ b/docs/process-services/components/task-filters.component.md @@ -19,21 +19,21 @@ Shows all available filters. ### Properties -| Name | Type | Default value | Description | -| ----------- | --------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------- | -| appId | `number` | | Display filters available to the current user for the application with the specified ID. | -| appName | `string` | | Display filters available to the current user for the application with the specified name. | -| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. | -| showIcon | `boolean` | | Toggles display of the filter's icon. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appId | `number` | | Display filters available to the current user for the application with the specified ID. | +| appName | `string` | | Display filters available to the current user for the application with the specified name. | +| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. | +| showIcon | `boolean` | | Toggles display of the filter's icon. | ### Events -| Name | Type | Description | -| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | -| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when a filter is being selected based on the filterParam input. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | | filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when a filter is being clicked from the UI. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | +| filterSelected | `EventEmitter` | Emitted when a filter is being selected based on the filterParam input. | +| success | `EventEmitter` | Emitted when the list is loaded. | ## Details diff --git a/docs/process-services/components/task-form.component.md b/docs/process-services/components/task-form.component.md index 04aa47a1f1..3eab3d2ded 100644 --- a/docs/process-services/components/task-form.component.md +++ b/docs/process-services/components/task-form.component.md @@ -21,37 +21,37 @@ Shows a [`form`](../../../lib/process-services/src/lib/task-list/models/form.mod ### Properties -| Name | Type | Default value | Description | -| ---------------------- | -------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------- | -| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | -| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | -| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | -| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | -| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. | -| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. | -| showFormTitle | `boolean` | false | Toggles rendering of the form title. | -| showFormValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | -| taskId | `string` | | (**required**) The id of the task whose details we are asking for. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | +| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | +| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | +| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | +| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. | +| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. | +| showFormTitle | `boolean` | false | Toggles rendering of the form title. | +| showFormValidationIcon | `boolean` | true | Toggle rendering of the validation icon next to the form title. | +| taskId | `string` | | (**required**) The id of the task whose details we are asking for. | ### Events -| Name | Type | Description | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | -| completed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| 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 the form field content is clicked. | -| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/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. | -| 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. | -| showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | -| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | -| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued).. | +| Name | Type | Description | +| --- | --- | --- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | +| completed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | +| 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 the form field content is clicked. | +| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | +| formLoaded | `EventEmitter` | Emitted when the form is loaded or reloaded. | +| formSaved | `EventEmitter` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| showAttachForm | `EventEmitter` | Emitted when the form associated with the form task is attached. | +| taskClaimed | `EventEmitter` | Emitted when the task is claimed. | +| taskUnclaimed | `EventEmitter` | Emitted when the task is unclaimed (ie, requeued).. | ## See also -- [Form component](./form.component.md) -- [Form field model](../../core/models/form-field.model.md) -- [Form service](../../core/services/form.service.md) +* [Form component](./form.component.md) +* [Form field model](../../core/models/form-field.model.md) +* [Form service](../../core/services/form.service.md) diff --git a/docs/process-services/components/task-header.component.md b/docs/process-services/components/task-header.component.md index 16ed1e741c..c6f6070890 100644 --- a/docs/process-services/components/task-header.component.md +++ b/docs/process-services/components/task-header.component.md @@ -23,27 +23,27 @@ Shows all the information related to a task. ### Properties -| Name | Type | Default value | Description | -| ---------------- | -------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------- | -| formName | `string` | null | The name of the form. | -| showClaimRelease | `boolean` | true | Toggles display of the claim/release button. | -| taskDetails | [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) | | (required) Details related to the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| formName | `string` | null | The name of the form. | +| showClaimRelease | `boolean` | true | Toggles display of the claim/release button. | +| taskDetails | [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) | | (required) Details related to the task. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | -------------------------------------------------- | -| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| Name | Type | Description | +| --- | --- | --- | +| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | | unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued). | ## Details -The component populates an internal array of +The component populates an internal array of [CardViewModel](../../core/components/card-view.component.md) with the information that we want to display. By default all properties are displayed: -**_assignee_**, **_status_**, **_priority_**, **_dueDate_**, **_category_**, **_parentName_**, **_created_**, **_id_**, **_description_**, **_formName_**. +***assignee***, ***status***, ***priority***, ***dueDate***, ***category***, ***parentName***, ***created***, ***id***, ***description***, ***formName***. However, you can also choose which properties to show using a configuration in `app.config.json`: diff --git a/docs/process-services/components/task-list.component.md b/docs/process-services/components/task-list.component.md index b327767c2b..1fd044f641 100644 --- a/docs/process-services/components/task-list.component.md +++ b/docs/process-services/components/task-list.component.md @@ -11,18 +11,18 @@ Renders a list containing all the tasks matched by the parameters specified. ## Contents -- [Basic Usage](#basic-usage) - - [Transclusions](#transclusions) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [Setting the column schema](#setting-the-column-schema) - - [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) - - [Pagination strategy](#pagination-strategy) - - [DataTableAdapter example](#datatableadapter-example) - - [DataColumn Features](#datacolumn-features) -- [See also](#see-also) +* [Basic Usage](#basic-usage) + * [Transclusions](#transclusions) +* [Class members](#class-members) + * [Properties](#properties) + * [Events](#events) +* [Details](#details) + * [Setting the column schema](#setting-the-column-schema) + * [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) + * [Pagination strategy](#pagination-strategy) + * [DataTableAdapter example](#datatableadapter-example) + * [DataColumn Features](#datacolumn-features) +* [See also](#see-also) ## Basic Usage @@ -51,40 +51,40 @@ when the task list is empty: ### Properties -| Name | Type | Default value | Description | -| ---------------------- | --------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| appId | `number` | | The id of the app. | -| assignment | `string` | | The assignment of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate, "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved). | -| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source object that represents the number and the type of the columns that you want to show. | -| dueAfter | `string` | | Filter the tasks. Display only tasks with `created_date` after `dueAfter`. | -| dueBefore | `string` | | Filter the tasks. Display only tasks with `created_date` before `dueBefore`. | -| includeProcessInstance | `boolean` | | Toggles inclusion of Process Instances | -| landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. | -| multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | -| name | `string` | | Name of the tasklist. | -| page | `number` | 0 | The page number of the tasks to fetch. | -| presetColumn | `string` | | Custom preset column schema in JSON format. | -| processDefinitionId | `string` | | The [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | -| processInstanceId | `string` | | The Instance Id of the process. | -| selectFirstRow | `boolean` | true | Toggles default selection of the first row | -| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | -| size | `number` | | The number of tasks to fetch. Default value: 25. | -| sort | `string` | | Define the sort order of the tasks. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | -| start | `number` | | Starting point of the list within the full set of tasks. | -| state | `string` | | Current state of the process. Possible values are: `completed`, `active`. | -| stickyHeader | `boolean` | false | Toggles the sticky header mode. | -| taskId | `string` | | The id of a task | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| appId | `number` | | The id of the app. | +| assignment | `string` | | The assignment of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate, "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved). | +| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source object that represents the number and the type of the columns that you want to show. | +| dueAfter | `string` | | Filter the tasks. Display only tasks with `created_date` after `dueAfter`. | +| dueBefore | `string` | | Filter the tasks. Display only tasks with `created_date` before `dueBefore`. | +| includeProcessInstance | `boolean` | | Toggles inclusion of Process Instances | +| landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. | +| multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | +| name | `string` | | Name of the tasklist. | +| page | `number` | 0 | The page number of the tasks to fetch. | +| presetColumn | `string` | | Custom preset column schema in JSON format. | +| processDefinitionId | `string` | | The [`Definition`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) Id of the process. | +| processInstanceId | `string` | | The Instance Id of the process. | +| selectFirstRow | `boolean` | true | Toggles default selection of the first row | +| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | +| size | `number` | | The number of tasks to fetch. Default value: 25. | +| sort | `string` | | Define the sort order of the tasks. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | +| start | `number` | | Starting point of the list within the full set of tasks. | +| state | `string` | | Current state of the process. Possible values are: `completed`, `active`. | +| stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| taskId | `string` | | The id of a task | ### Events -| Name | Type | Description | -| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | -| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | +| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | | showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | +| success | `EventEmitter` | Emitted when the task list is loaded | ## Details @@ -277,6 +277,6 @@ documentation for more details on the format and behavior of context actions. ## See also -- [Data column component](../../core/components/data-column.component.md) -- [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) -- [Pagination component](../../core/components/pagination.component.md) +* [Data column component](../../core/components/data-column.component.md) +* [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) +* [Pagination component](../../core/components/pagination.component.md) diff --git a/docs/process-services/components/task-standalone.component.md b/docs/process-services/components/task-standalone.component.md index 28aa867807..40feb3e51c 100644 --- a/docs/process-services/components/task-standalone.component.md +++ b/docs/process-services/components/task-standalone.component.md @@ -21,18 +21,18 @@ This component can be used when the task doesn't belong to any processes. ### Properties -| Name | Type | Default value | Description | -| --------------------- | --------- | ------------- | -------------------------------------------------------------------------------------------- | -| hasCompletePermission | `boolean` | true | Toggles rendering of the `Complete` button. | -| hideCancelButton | `boolean` | true | Toggles rendering of the `Cancel` button. | -| isCompleted | `boolean` | false | If true then Task completed message is shown and `Complete` and `Cancel` buttons are hidden. | -| taskId | `any` | | Id of the task. | -| taskName | `any` | | Name of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| hasCompletePermission | `boolean` | true | Toggles rendering of the `Complete` button. | +| hideCancelButton | `boolean` | true | Toggles rendering of the `Cancel` button. | +| isCompleted | `boolean` | false | If true then Task completed message is shown and `Complete` and `Cancel` buttons are hidden. | +| taskId | `any` | | Id of the task. | +| taskName | `any` | | Name of the task. | ### Events -| Name | Type | Description | -| -------------- | ------------------------------------------------------------------ | ---------------------------------------------------------------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | -| complete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | -| showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | +| Name | Type | Description | +| --- | --- | --- | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | +| complete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | +| showAttachForm | `EventEmitter` | Emitted when the form associated with the form task is attached. | diff --git a/docs/process-services/directives/claim-task.directive.md b/docs/process-services/directives/claim-task.directive.md index 2fa071766e..8548a6e85b 100644 --- a/docs/process-services/directives/claim-task.directive.md +++ b/docs/process-services/directives/claim-task.directive.md @@ -19,13 +19,13 @@ Claims a task ### Properties -| Name | Type | Default value | Description | -| ------ | -------- | ------------- | ------------------------------ | -| taskId | `string` | | (Required) The id of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| taskId | `string` | | (Required) The id of the task. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ---------------------------------------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be claimed. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| Name | Type | Description | +| --- | --- | --- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be claimed. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | diff --git a/docs/process-services/directives/process-audit.directive.md b/docs/process-services/directives/process-audit.directive.md index 06247fb1fc..7d688e88f6 100644 --- a/docs/process-services/directives/process-audit.directive.md +++ b/docs/process-services/directives/process-audit.directive.md @@ -28,16 +28,16 @@ Fetches the Process Audit information in PDF or JSON format. ### Properties -| Name | Type | Default value | Description | -| --------- | --------- | ------------- | ---------------------------------------------------------- | -| download | `boolean` | true | Enables downloading of the audit file on clicking. | -| fileName | `string` | "Audit" | Name of the file to download (for PDF downloads). | -| format | `string` | "pdf" | Format for the audit information (can be "pdf" or "json"). | -| processId | `string` | | ID of the process. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| download | `boolean` | true | Enables downloading of the audit file on clicking. | +| fileName | `string` | "Audit" | Name of the file to download (for PDF downloads). | +| format | `string` | "pdf" | Format for the audit information (can be "pdf" or "json"). | +| processId | `string` | | ID of the process. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ---------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the decorated element is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/directives/task-audit.directive.md b/docs/process-services/directives/task-audit.directive.md index 86e0683d12..7631a878e6 100644 --- a/docs/process-services/directives/task-audit.directive.md +++ b/docs/process-services/directives/task-audit.directive.md @@ -27,16 +27,16 @@ Fetches the Task Audit information in PDF or JSON format. ### Properties -| Name | Type | Default value | Description | -| -------- | --------- | ------------- | ----------------------------------------------------------------------- | -| download | `boolean` | true | Enables downloading of the audit when the decorated element is clicked. | -| fileName | `string` | "Audit" | Name of the downloaded file (for PDF downloads). | -| format | `string` | "pdf" | Format of the audit information. Can be "pdf" or "json". | -| taskId | `string` | | (**required**) The id of the task. | +| Name | Type | Default value | Description | +| --- | --- | --- | --- | +| download | `boolean` | true | Enables downloading of the audit when the decorated element is clicked. | +| fileName | `string` | "Audit" | Name of the downloaded file (for PDF downloads). | +| format | `string` | "pdf" | Format of the audit information. Can be "pdf" or "json". | +| taskId | `string` | | (**required**) The id of the task. | ### Events -| Name | Type | Description | -| ------- | ----------------------------------------------------------------- | ---------------------------------------------- | +| Name | Type | Description | +| --- | --- | --- | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the decorated element is clicked. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/services/process-filter.service.md b/docs/process-services/services/process-filter.service.md index eeffb1f033..5fb7d3dcca 100644 --- a/docs/process-services/services/process-filter.service.md +++ b/docs/process-services/services/process-filter.service.md @@ -7,43 +7,43 @@ Last reviewed: 2018-11-13 # [Process Filter Service](../../../lib/process-services/src/lib/process-list/services/process-filter.service.ts "Defined in process-filter.service.ts") -Manage Process Filters, which are pre-configured Process Instance queries. +Manage Process Filters, which are pre-configured Process Instance queries. ## Class members ### Methods -- **addProcessFilter**(filter: [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>`
+* **addProcessFilter**(filter: [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>`
Adds a filter. - - _filter:_ [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - The filter to add - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>` - The filter just added -- **callApiProcessFilters**(appId?: `number`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ResultListDataRepresentationUserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ResultListDataRepresentation%C2%ABUserProcessInstanceFilterRepresentation%C2%BB.md)`>`
+ * *filter:* [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - The filter to add + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>` - The filter just added +* **callApiProcessFilters**(appId?: `number`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ResultListDataRepresentationUserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ResultListDataRepresentation%C2%ABUserProcessInstanceFilterRepresentation%C2%BB.md)`>`
Calls `getUserProcessInstanceFilters` from the Alfresco JS API. - - _appId:_ `number` - (Optional) ID of the target app - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ResultListDataRepresentationUserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ResultListDataRepresentation%C2%ABUserProcessInstanceFilterRepresentation%C2%BB.md)`>` - List of filter details -- **createDefaultFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>`
+ * *appId:* `number` - (Optional) ID of the target app + * **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ResultListDataRepresentationUserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ResultListDataRepresentation%C2%ABUserProcessInstanceFilterRepresentation%C2%BB.md)`>` - List of filter details +* **createDefaultFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>`
Creates and returns the default filters for an app. - - _appId:_ `number` - ID of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>` - Default filters just created -- **getProcessFilterById**(filterId: `number`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>`
+ * *appId:* `number` - ID of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>` - Default filters just created +* **getProcessFilterById**(filterId: `number`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>`
Retrieves the process filter by ID. - - _filterId:_ `number` - ID of the filter - - _appId:_ `number` - (Optional) ID of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>` - Details of the filter -- **getProcessFilterByName**(filterName: `string`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>`
+ * *filterId:* `number` - ID of the filter + * *appId:* `number` - (Optional) ID of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>` - Details of the filter +* **getProcessFilterByName**(filterName: `string`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>`
Retrieves the process filter by name. - - _filterName:_ `string` - Name of the filter - - _appId:_ `number` - (Optional) ID of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>` - Details of the filter -- **getProcessFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>`
+ * *filterName:* `string` - Name of the filter + * *appId:* `number` - (Optional) ID of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`>` - Details of the filter +* **getProcessFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>`
Gets all filters defined for a Process App. - - _appId:_ `number` - ID of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>` - Array of filter details -- **getRunningFilterInstance**(appId: `number`, index?: `number`): [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)
+ * *appId:* `number` - ID of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>` - Array of filter details +* **getRunningFilterInstance**(appId: `number`, index?: `number`): [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)
Creates and returns a filter that matches "running" process instances. - - _appId:_ `number` - ID of the target app - - _index:_ `number` - (Optional) of the filter (optional) - - **Returns** [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - Filter just created + * *appId:* `number` - ID of the target app + * *index:* `number` - (Optional) of the filter (optional) + * **Returns** [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - Filter just created ## Details @@ -71,10 +71,10 @@ The response is an array of [`FilterProcessRepresentationModel`](../../../lib/pr 4: {id: 3004, appId: 2, name: "Completed", recent: false, icon: "glyphicon-ok-sign", …} 5: {id: 3005, appId: 2, name: "All", recent: false, icon: "glyphicon-th", …} -You can use the returned filters to get matching process instances for the process app with ID 2, +You can use the returned filters to get matching process instances for the process app with ID 2, such as 'Running', 'Completed', 'All', etc. ## See also -- [Process Filters component](../components/process-filters.component.md) -- [Task Filter service](task-filter.service.md) +* [Process Filters component](../components/process-filters.component.md) +* [Task Filter service](task-filter.service.md) diff --git a/docs/process-services/services/process.service.md b/docs/process-services/services/process.service.md index adce157c52..1d2b290017 100644 --- a/docs/process-services/services/process.service.md +++ b/docs/process-services/services/process.service.md @@ -7,69 +7,69 @@ Last reviewed: 2019-03-20 # [Process Service](../../../lib/process-services/src/lib/process-list/services/process.service.ts "Defined in process.service.ts") -Manages process instances, process variables, and process audit Log. +Manages process instances, process variables, and process audit Log. ## Class members ### Methods -- **cancelProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+* **cancelProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Cancels a process instance. - - _processInstanceId:_ `string` - ID of process to cancel - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **createOrUpdateProcessInstanceVariables**(processInstanceId: `string`, variables: [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/RestVariable.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]>`
+ * *processInstanceId:* `string` - ID of process to cancel + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +* **createOrUpdateProcessInstanceVariables**(processInstanceId: `string`, variables: [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/RestVariable.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]>`
Creates or updates variables for a process instance. - - _processInstanceId:_ `string` - ID of the target process - - _variables:_ [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/RestVariable.md)`[]` - Variables to update - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info -- **deleteProcessInstanceVariable**(processInstanceId: `string`, variableName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *processInstanceId:* `string` - ID of the target process + * *variables:* [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/RestVariable.md)`[]` - Variables to update + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info +* **deleteProcessInstanceVariable**(processInstanceId: `string`, variableName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a variable for a process instance. - - _processInstanceId:_ `string` - ID of the target process - - _variableName:_ `string` - Name of the variable to delete - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **fetchProcessAuditJsonById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *processInstanceId:* `string` - ID of the target process + * *variableName:* `string` - Name of the variable to delete + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +* **fetchProcessAuditJsonById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Fetches the Process Audit information in a JSON format. - - _processId:_ `string` - ID of the target process - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - JSON data -- **fetchProcessAuditPdfById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+ * *processId:* `string` - ID of the target process + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - JSON data +* **fetchProcessAuditPdfById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Fetches the Process Audit information as a PDF. - - _processId:_ `string` - ID of the target process - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data -- **getProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>`
+ * *processId:* `string` - ID of the target process + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data +* **getProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>`
Gets Process Instance metadata. - - _processInstanceId:_ `string` - ID of the target process - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` - Metadata for the instance -- **getProcessDefinitions**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`[]>`
+ * *processInstanceId:* `string` - ID of the target process + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` - Metadata for the instance +* **getProcessDefinitions**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`[]>`
Gets process definitions associated with an app. - - _appId:_ `number` - (Optional) ID of a target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`[]>` - Array of process definitions -- **getProcessInstanceVariables**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]>`
+ * *appId:* `number` - (Optional) ID of a target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`[]>` - Array of process definitions +* **getProcessInstanceVariables**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]>`
Gets the variables for a process instance. - - _processInstanceId:_ `string` - ID of the target process - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info -- **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>`
+ * *processInstanceId:* `string` - ID of the target process + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info +* **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>`
Gets process instances for a filter and optionally a process definition. - - _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - Filter for instances - - _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` - List of process instances -- **getProcessTasks**(processInstanceId: `string`, state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`[]>`
+ * *requestNode:* [`ProcessFilterParamRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - Filter for instances + * *processDefinitionKey:* `string` - (Optional) Limits returned instances to a process definition + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` - List of process instances +* **getProcessTasks**(processInstanceId: `string`, state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`[]>`
Gets task instances for a process instance. - - _processInstanceId:_ `string` - ID of the process instance - - _state:_ `string` - (Optional) Task state filter (can be "active" or "completed") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`[]>` - Array of task instance details -- **getProcesses**(requestNode: [`ProcessFilterParamRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>`
+ * *processInstanceId:* `string` - ID of the process instance + * *state:* `string` - (Optional) Task state filter (can be "active" or "completed") + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`[]>` - Array of task instance details +* **getProcesses**(requestNode: [`ProcessFilterParamRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>`
Gets processes for a filter and optionally a process definition. - - _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - Filter for instances - - _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` - List of processes -- **startProcess**(processDefinitionId: `string`, name: `string`, outcome?: `string`, startFormValues?: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts), variables?: [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>`
+ * *requestNode:* [`ProcessFilterParamRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - Filter for instances + * *processDefinitionKey:* `string` - (Optional) Limits returned instances to a process definition + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` - List of processes +* **startProcess**(processDefinitionId: `string`, name: `string`, outcome?: `string`, startFormValues?: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts), variables?: [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>`
Starts a process based on a process definition, name, form values or variables. - - _processDefinitionId:_ `string` - Process definition ID - - _name:_ `string` - Process name - - _outcome:_ `string` - (Optional) Process outcome - - _startFormValues:_ [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form - - _variables:_ [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` - (Optional) Array of process instance variables - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` - Details of the process instance just started + * *processDefinitionId:* `string` - Process definition ID + * *name:* `string` - Process name + * *outcome:* `string` - (Optional) Process outcome + * *startFormValues:* [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form + * *variables:* [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` - (Optional) Array of process instance variables + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` - Details of the process instance just started ## Details diff --git a/docs/process-services/services/task-filter.service.md b/docs/process-services/services/task-filter.service.md index d17f1b7879..725de288f8 100644 --- a/docs/process-services/services/task-filter.service.md +++ b/docs/process-services/services/task-filter.service.md @@ -7,58 +7,58 @@ Last reviewed: 2018-06-07 # [Task Filter Service](../../../lib/process-services/src/lib/task-list/services/task-filter.service.ts "Defined in task-filter.service.ts") -Manage Task Filters, which are pre-configured Task Instance queries. +Manage Task Filters, which are pre-configured Task Instance queries. ## Class members ### Methods -- **addFilter**(filter: [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
+* **addFilter**(filter: [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
Adds a new task filter - - _filter:_ [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The new filter to add - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - Details of task filter just added -- **callApiTaskFilters**(appId?: `number`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
+ * *filter:* [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The new filter to add + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - Details of task filter just added +* **callApiTaskFilters**(appId?: `number`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
Calls `getUserTaskFilters` from the Alfresco JS API. - - _appId:_ `number` - (Optional) ID of the target app - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - List of task filters -- **createDefaultFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>`
+ * *appId:* `number` - (Optional) ID of the target app + * **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - List of task filters +* **createDefaultFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>`
Creates and returns the default filters for a process app. - - _appId:_ `number` - ID of the target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>` - Array of default filters just created -- **getCompletedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
+ * *appId:* `number` - ID of the target app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>` - Array of default filters just created +* **getCompletedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
Creates and returns a filter for "Completed" task instances. - - _appId:_ `number` - ID of the target app - - _index:_ `number` - (Optional) of the filter (optional) - - **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter -- **getInvolvedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
+ * *appId:* `number` - ID of the target app + * *index:* `number` - (Optional) of the filter (optional) + * **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter +* **getInvolvedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
Creates and returns a filter for "Involved" task instances. - - _appId:_ `number` - ID of the target app - - _index:_ `number` - (Optional) of the filter (optional) - - **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter -- **getMyTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
+ * *appId:* `number` - ID of the target app + * *index:* `number` - (Optional) of the filter (optional) + * **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter +* **getMyTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
Creates and returns a filter for "My Tasks" task instances. - - _appId:_ `number` - ID of the target app - - _index:_ `number` - (Optional) of the filter (optional) - - **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter -- **getQueuedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
+ * *appId:* `number` - ID of the target app + * *index:* `number` - (Optional) of the filter (optional) + * **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter +* **getQueuedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
Creates and returns a filter for "Queued Tasks" task instances. - - _appId:_ `number` - ID of the target app - - _index:_ `number` - (Optional) of the filter (optional) - - **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter -- **getTaskFilterById**(filterId: `number`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
+ * *appId:* `number` - ID of the target app + * *index:* `number` - (Optional) of the filter (optional) + * **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter +* **getTaskFilterById**(filterId: `number`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
Gets a task filter by ID. - - _filterId:_ `number` - ID of the filter - - _appId:_ `number` - (Optional) ID of the app for the filter - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - Details of task filter -- **getTaskFilterByName**(taskName: `string`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
+ * *filterId:* `number` - ID of the filter + * *appId:* `number` - (Optional) ID of the app for the filter + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - Details of task filter +* **getTaskFilterByName**(taskName: `string`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
Gets a task filter by name. - - _taskName:_ `string` - Name of the filter - - _appId:_ `number` - (Optional) ID of the app for the filter - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - Details of task filter -- **getTaskListFilters**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>`
+ * *taskName:* `string` - Name of the filter + * *appId:* `number` - (Optional) ID of the app for the filter + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - Details of task filter +* **getTaskListFilters**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>`
Gets all task filters for a process app. - - _appId:_ `number` - (Optional) Optional ID for a specific app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>` - Array of task filter details + * *appId:* `number` - (Optional) Optional ID for a specific app + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>` - Array of task filter details ## Details @@ -86,7 +86,7 @@ The response is an array of [`FilterRepresentationModel`](../../../lib/process-s 6: {id: 4006, appId: 2, name: "Queued Tasks", recent: false, icon: "glyphicon-record", …} 7: {id: 4007, appId: 2, name: "Involved Tasks", recent: false, icon: "glyphicon-align-left", …} -These filters can now be used to get matching task instances for the process app with ID 2, +These filters can now be used to get matching task instances for the process app with ID 2, such as 'Involved Tasks', 'My Tasks', 'Queued Tasks', and 'Completed Tasks'. ### Importing @@ -102,5 +102,5 @@ export class SomePageComponent implements OnInit { ## See also -- [Task Filters component](../components/task-filters.component.md) -- [Process Filter service](process-filter.service.md) +* [Task Filters component](../components/task-filters.component.md) +* [Process Filter service](process-filter.service.md) diff --git a/docs/process-services/services/tasklist.service.md b/docs/process-services/services/tasklist.service.md index d31727e4db..5ce1518848 100644 --- a/docs/process-services/services/tasklist.service.md +++ b/docs/process-services/services/tasklist.service.md @@ -13,105 +13,105 @@ Manages Task Instances. ### Methods -- **addTask**(task: [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+* **addTask**(task: [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Adds a subtask (ie, a checklist task) to a parent task. - - _task:_ [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) - The task to add - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - The subtask that was added -- **assignTask**(taskId: `string`, requestNode: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+ * *task:* [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) - The task to add + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - The subtask that was added +* **assignTask**(taskId: `string`, requestNode: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Assigns a task to a user or group. - - _taskId:_ `string` - The task to assign - - _requestNode:_ `any` - [User](../../../lib/core/pipes/user-initial.pipe.ts) or group to assign the task to - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the assigned task -- **assignTaskByUserId**(taskId: `string`, userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+ * *taskId:* `string` - The task to assign + * *requestNode:* `any` - [User](../../../lib/core/pipes/user-initial.pipe.ts) or group to assign the task to + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the assigned task +* **assignTaskByUserId**(taskId: `string`, userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Assigns a task to a user. - - _taskId:_ `string` - ID of the task to assign - - _userId:_ `string` - ID of the user to assign the task to - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the assigned task -- **attachFormToATask**(taskId: `string`, formId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *taskId:* `string` - ID of the task to assign + * *userId:* `string` - ID of the user to assign the task to + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the assigned task +* **attachFormToATask**(taskId: `string`, formId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Attaches a form to a task. - - _taskId:_ `string` - ID of the target task - - _formId:_ `number` - ID of the form to add - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **claimTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+ * *taskId:* `string` - ID of the target task + * *formId:* `number` - ID of the form to add + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +* **claimTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Claims a task for the current user. - - _taskId:_ `string` - ID of the task to claim - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the claimed task -- **completeTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *taskId:* `string` - ID of the task to claim + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the claimed task +* **completeTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gives completed status to a task. - - _taskId:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **createNewTask**(task: [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+ * *taskId:* `string` - ID of the target task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +* **createNewTask**(task: [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Creates a new standalone task. - - _task:_ [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) - Details of the new task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the newly created task -- **deleteForm**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+ * *task:* [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) - Details of the new task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Details of the newly created task +* **deleteForm**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Deletes a form from a task. - - _taskId:_ `string` - Task id related to form - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Null response notifying when the operation is complete -- **deleteTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+ * *taskId:* `string` - Task id related to form + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Null response notifying when the operation is complete +* **deleteTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Deletes a subtask (ie, a checklist task) from a parent task. - - _taskId:_ `string` - The task to delete - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Null response notifying when the operation is complete -- **fetchTaskAuditJsonById**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *taskId:* `string` - The task to delete + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Null response notifying when the operation is complete +* **fetchTaskAuditJsonById**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Fetch the Task Audit information in JSON format - - _taskId:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - JSON data -- **fetchTaskAuditPdfById**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+ * *taskId:* `string` - ID of the target task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - JSON data +* **fetchTaskAuditPdfById**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Fetches the Task Audit information in PDF format. - - _taskId:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data -- **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>`
+ * *taskId:* `string` - ID of the target task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data +* **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>`
Gets all tasks matching a query and state value. - - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks. - - _state:_ `string` - (Optional) Task state. Can be "open" or "completed". - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>` - List of tasks -- **findAllTasksWithoutState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>`
+ * *requestNode:* [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks. + * *state:* `string` - (Optional) Task state. Can be "open" or "completed". + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>` - List of tasks +* **findAllTasksWithoutState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>`
Gets all tasks matching the supplied query but ignoring the task state. - - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>` - List of tasks -- **findTasksByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>`
+ * *requestNode:* [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>` - List of tasks +* **findTasksByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>`
Gets tasks matching a query and state value. - - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks - - _state:_ `string` - (Optional) Task state. Can be "open" or "completed". - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>` - List of tasks -- **getFilterForTaskById**(taskId: `string`, filterList: [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
+ * *requestNode:* [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks + * *state:* `string` - (Optional) Task state. Can be "open" or "completed". + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>` - List of tasks +* **getFilterForTaskById**(taskId: `string`, filterList: [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
Gets all the filters in the list that belong to a task. - - _taskId:_ `string` - ID of the target task - - _filterList:_ [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]` - List of filters to search through - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - Filters belonging to the task -- **getFormList**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts)`[]>`
+ * *taskId:* `string` - ID of the target task + * *filterList:* [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]` - List of filters to search through + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - Filters belonging to the task +* **getFormList**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts)`[]>`
Gets all available reusable forms. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts)`[]>` - Array of form details -- **getTaskChecklist**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`[]>`
+ * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts)`[]>` - Array of form details +* **getTaskChecklist**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`[]>`
Gets the checklist for a task. - - _id:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`[]>` - Array of checklist task details -- **getTaskDetails**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+ * *id:* `string` - ID of the target task + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`[]>` - Array of checklist task details +* **getTaskDetails**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Gets details for a task. - - _taskId:_ `string` - ID of the target task. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Task details -- **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>`
+ * *taskId:* `string` - ID of the target task. + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Task details +* **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>`
Gets all the tasks matching the supplied query. - - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>` - List of tasks -- **getTotalTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ * *requestNode:* [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts)`>` - List of tasks +* **getTotalTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the total number of the tasks found by a query. - - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Number of tasks -- **isTaskRelatedToFilter**(taskId: `string`, filterModel: [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
+ * *requestNode:* [`TaskQueryRequestRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - Query to search for tasks + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Number of tasks +* **isTaskRelatedToFilter**(taskId: `string`, filterModel: [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
Checks if a taskId is filtered with the given filter. - - _taskId:_ `string` - ID of the target task - - _filterModel:_ [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The filter you want to check - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - The filter if it is related or null otherwise -- **unclaimTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+ * *taskId:* `string` - ID of the target task + * *filterModel:* [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The filter you want to check + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` - The filter if it is related or null otherwise +* **unclaimTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Un-claims a task for the current user. - - _taskId:_ `string` - ID of the task to unclaim - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Null response notifying when the operation is complete -- **updateTask**(taskId: `string`, updated: [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
+ * *taskId:* `string` - ID of the task to unclaim + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Null response notifying when the operation is complete +* **updateTask**(taskId: `string`, updated: [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>`
Updates the details (name, description, due date) for a task. - - _taskId:_ `string` - ID of the task to update - - _updated:_ [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md) - Data to update the task (as a [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md) instance). - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Updated task details + * *taskId:* `string` - ID of the task to update + * *updated:* [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md) - Data to update the task (as a [`TaskUpdateRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/TaskUpdateRepresentation.md) instance). + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` - Updated task details ## Details @@ -191,18 +191,18 @@ this.tasklistService.getTasks(taskQuery).subscribe( (taskListModel: TaskListMode In this example, the query specifies all Task Instances for the process app with ID 2. Setting the `size` property to 5 ensures the query will return no more than -five task instances in the results. +five task instances in the results. -You can use various query parameters to narrow down the scope of the results. -If you are only interested in task instances related to a specific process instance, +You can use various query parameters to narrow down the scope of the results. +If you are only interested in task instances related to a specific process instance, then you can set the `processInstanceId` accordingly. If you want all tasks related to -a type of process then you can use `processDefinitionId`. +a type of process then you can use `processDefinitionId`. Use the `state` property to indicate that you want only "completed" or "open" tasks (this defaults to "open" if you leave it undefined). The `assignment` property filters tasks based on how they are assigned (or not assigned yet). -Use `assignee` if you are interested in tasks that are assigned to a user. If you want to see +Use `assignee` if you are interested in tasks that are assigned to a user. If you want to see pooled tasks (i.e. tasks that needs to be claimed by a user), then use `candidate`. A successful query returns a [`TaskListModel`](../../../lib/process-services/src/lib/task-list/models/task-list.model.ts) with the `data` property set to an array of diff --git a/docs/release-notes/README.md b/docs/release-notes/README.md index 853b88fd5f..ae51445656 100644 --- a/docs/release-notes/README.md +++ b/docs/release-notes/README.md @@ -9,6 +9,7 @@ The first **General available** release was v2.0.0. ## General available +- [4.2.0](RelNote420.md) - [4.1.0](RelNote410.md) - [4.0.0](RelNote400.md) - [3.9.0](RelNote390.md) diff --git a/docs/release-notes/RelNote420.md b/docs/release-notes/RelNote420.md new file mode 100644 index 0000000000..e21f00f126 --- /dev/null +++ b/docs/release-notes/RelNote420.md @@ -0,0 +1,194 @@ +--- +Title: Release notes v4.1.0 +--- + +# Alfresco Application Development Framework (ADF) version 4.2.0 Release Note + +These release notes provide information about the **4.2.0 release** of the Alfresco Application Development Framework. + +This is the latest **General Available** release of the Application Development Framework, which contains the Angular components to build a Web Application on top of the Alfresco Platform. + +The release can be found on GitHub at [this location](https://github.com/Alfresco/alfresco-ng2-components/releases/tag/4.2.0). + +You can contact Francesco Corti (francesco.corti at alfresco.com) for details of features planned for future versions of ADF. + +## Contents + +- [New package versions](#new-package-versions) +- [Goals for this release](#goals-for-this-release) + - [TODO](#todo) +- [Localisation](#localisation) +- [References](#references) +- [PR merged](#pr-merged) + +## New package versions + + "@alfresco/adf-content-services" : "4.2.0" + "@alfresco/adf-process-services" : "4.2.0" + "@alfresco/adf-core" : "4.2.0" + "@alfresco/adf-insights" : "4.2.0", + "@alfresco/adf-extensions": "4.2.0" + "@alfresco/adf-testing": "4.2.0" + "@alfresco/adf-cli": "4.2.0" + +## Goals for this release + +This is a minor release of the Alfresco Application Development Framework, developed to receive the latest and greatest benefits of the bugfixes and the enhacements planned since the release of the previous version. + +The highlights of this release is mainly about bugfixes and enhancements related to the Alfresco Process Application (APA) use cases. + +Please report issues with this release in the [issue tracker](https://github.com/Alfresco/alfresco-ng2-components/issues/new). You can collaborate on this release or share feedback by using the discussion tools on [Gitter](http://gitter.im/Alfresco/alfresco-ng2-components). + +### TODO + +TODO + +## Localisation + +This release includes: Arabic, Brazilian Portuguese, Czech, Danish, Dutch, Finnish, French, German, Italian, Japanese, Norwegian (Bokmål), Polish, Russian, Simplified Chinese, Spanish and Swedish versions. + +## References + +The following is a brief list of references to help you get started with the new release: + +- [Getting started guides with Alfresco Application Development Framework](https://community.alfresco.com/community/application-development-framework/pages/get-started) +- [Alfresco ADF Documentation on the Builder Network](../README.md) +- [Gitter chat supporting Alfresco ADF](https://gitter.im/Alfresco/alfresco-ng2-components) +- [ADF examples on GitHub](https://github.com/Alfresco/adf-examples) +- [Official GitHub Project - alfresco-ng2-components](https://github.com/Alfresco/alfresco-ng2-components) +- [Official GitHub Project - alfresco-js-api](https://github.com/Alfresco/alfresco-js-api) +- [Official GitHub Project - generator-ng2-alfresco-app](https://github.com/Alfresco/generator-ng2-alfresco-app) + +Please refer to the [official documentation](http://docs.alfresco.com/) for further details and suggestions. + +* [Alfresco/alfresco-ng2-components#6244 - Bump snyk from 1.413.2 to 1.413.3](https://github.com/Alfresco/alfresco-ng2-components/pull/6244) +* [Alfresco/alfresco-ng2-components#6230 - Bump moment from 2.29.0 to 2.29.1](https://github.com/Alfresco/alfresco-ng2-components/pull/6230) +* [Alfresco/alfresco-ng2-components#6246 - Menu for ABN in regard of upgrade guides, vulnerability and licence info.](https://github.com/Alfresco/alfresco-ng2-components/pull/6246) +* [Alfresco/alfresco-ng2-components#6252 - adf-cli - Fix typo on namespace](https://github.com/Alfresco/alfresco-ng2-components/pull/6252) +* [Alfresco/alfresco-ng2-components#6249 - [ACA-4052] - Add today option back](https://github.com/Alfresco/alfresco-ng2-components/pull/6249) +* [Alfresco/alfresco-ng2-components#6248 - improved e2e login api](https://github.com/Alfresco/alfresco-ng2-components/pull/6248) +* [Alfresco/alfresco-ng2-components#6251 - [ACA-3662] Add setCompleteDateFilterDropDown() method](https://github.com/Alfresco/alfresco-ng2-components/pull/6251) +* [Alfresco/alfresco-ng2-components#6247 - Bump sass-loader from 10.0.2 to 10.0.3](https://github.com/Alfresco/alfresco-ng2-components/pull/6247) +* [Alfresco/alfresco-ng2-components#6250 - Try new travis Graviton](https://github.com/Alfresco/alfresco-ng2-components/pull/6250) +* [Alfresco/alfresco-ng2-components#6257 - AAE renamed APA in guides and files.](https://github.com/Alfresco/alfresco-ng2-components/pull/6257) +* [Alfresco/alfresco-ng2-components#6259 - fix error message for CSRF](https://github.com/Alfresco/alfresco-ng2-components/pull/6259) +* [Alfresco/alfresco-ng2-components#6260 - Default login with admin if not to create user e2e](https://github.com/Alfresco/alfresco-ng2-components/pull/6260) +* [Alfresco/alfresco-ng2-components#6151 - [AAE-3587] Use grid to allow using rowspan](https://github.com/Alfresco/alfresco-ng2-components/pull/6151) +* [Alfresco/alfresco-ng2-components#6262 - Bump @angular-devkit/build-angular from 0.1001.4 to 0.1001.7](https://github.com/Alfresco/alfresco-ng2-components/pull/6262) +* [Alfresco/alfresco-ng2-components#6263 - Bump snyk from 1.413.3 to 1.415.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6263) +* [Alfresco/alfresco-ng2-components#6253 - [ADF-5279] Date range type filter selection triggers list reload](https://github.com/Alfresco/alfresco-ng2-components/pull/6253) +* [Alfresco/alfresco-ng2-components#6254 - [ADF-5280] [Cloud] Tasks - Created Date filter](https://github.com/Alfresco/alfresco-ng2-components/pull/6254) +* [Alfresco/alfresco-ng2-components#6265 - [ACA-3969]Add methods for people-cloud-component.page.ts](https://github.com/Alfresco/alfresco-ng2-components/pull/6265) +* [Alfresco/alfresco-ng2-components#6214 - [AAE-3719][AAE-3720] - Fix content node selector search should align with the filtering](https://github.com/Alfresco/alfresco-ng2-components/pull/6214) +* [Alfresco/alfresco-ng2-components#6269 - [AAE-3908] - fix clear value icon on card view text item](https://github.com/Alfresco/alfresco-ng2-components/pull/6269) +* [Alfresco/alfresco-ng2-components#5907 - [ACA-3619] - add task assignment filter](https://github.com/Alfresco/alfresco-ng2-components/pull/5907) +* [Alfresco/alfresco-ng2-components#6271 - [AAE-3405] - Optimise attach file widget UI](https://github.com/Alfresco/alfresco-ng2-components/pull/6271) +* [Alfresco/alfresco-ng2-components#6272 - [ACA-3976]Add a new process with 2 parallel user tasks in candidatebaseapp](https://github.com/Alfresco/alfresco-ng2-components/pull/6272) +* [Alfresco/alfresco-ng2-components#6274 - [AAE-3925] Add support for date type searchable properties in attach …](https://github.com/Alfresco/alfresco-ng2-components/pull/6274) +* [Alfresco/alfresco-ng2-components#6275 - [AAE-3886] Cleanup the customModels when the attach file widget compo…](https://github.com/Alfresco/alfresco-ng2-components/pull/6275) +* [Alfresco/alfresco-ng2-components#6276 - [ACA-4089] Add new method in DatePickerCalendarPage](https://github.com/Alfresco/alfresco-ng2-components/pull/6276) +* [Alfresco/alfresco-ng2-components#6077 - [ACA-3706] implement startedBy process filter property](https://github.com/Alfresco/alfresco-ng2-components/pull/6077) +* [Alfresco/alfresco-ng2-components#6280 - Fix the if condition on namespaces](https://github.com/Alfresco/alfresco-ng2-components/pull/6280) +* [Alfresco/alfresco-ng2-components#6281 - [ACA-3664] Add new method in ADF to validate tasks filtering by CreatedBy filter](https://github.com/Alfresco/alfresco-ng2-components/pull/6281) +* [Alfresco/alfresco-ng2-components#6279 - [ACA-4049] Improve check for content on lists](https://github.com/Alfresco/alfresco-ng2-components/pull/6279) +* [Alfresco/alfresco-ng2-components#6277 - [AAE-3750] - add possibility to exclude user from selection on people…](https://github.com/Alfresco/alfresco-ng2-components/pull/6277) +* [Alfresco/alfresco-ng2-components#6256 - [ADF-5170] [upload] not able to upload file/folder from external content service specfic path](https://github.com/Alfresco/alfresco-ng2-components/pull/6256) +* [Alfresco/alfresco-ng2-components#6270 - move users in the users object to make loginWithProgile general purpose](https://github.com/Alfresco/alfresco-ng2-components/pull/6270) +* [Alfresco/alfresco-ng2-components#6286 - Bump @angular-devkit/build-ng-packagr from 0.1001.4 to 0.1002.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6286) +* [Alfresco/alfresco-ng2-components#6283 - Bump chart.js from 2.9.3 to 2.9.4](https://github.com/Alfresco/alfresco-ng2-components/pull/6283) +* [Alfresco/alfresco-ng2-components#6284 - Bump lint-staged from 10.4.0 to 10.5.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6284) +* [Alfresco/alfresco-ng2-components#6289 - [ACA-4089] Modify setCompletedBy method to set the selected assignee](https://github.com/Alfresco/alfresco-ng2-components/pull/6289) +* [Alfresco/alfresco-ng2-components#6293 - [ACA-4057]Create process with random name](https://github.com/Alfresco/alfresco-ng2-components/pull/6293) +* [Alfresco/alfresco-ng2-components#6288 - [ACA-3870] Fix Version Compatibility Initialization](https://github.com/Alfresco/alfresco-ng2-components/pull/6288) +* [Alfresco/alfresco-ng2-components#6295 - remove spamming of i18n warnings to console log](https://github.com/Alfresco/alfresco-ng2-components/pull/6295) +* [Alfresco/alfresco-ng2-components#6298 - [ACA-4057] Add getProcessInstanceByName method](https://github.com/Alfresco/alfresco-ng2-components/pull/6298) +* [Alfresco/alfresco-ng2-components#6300 - Bump sass-loader from 10.0.3 to 10.0.5](https://github.com/Alfresco/alfresco-ng2-components/pull/6300) +* [Alfresco/alfresco-ng2-components#6296 - [ACA-4057]Add method to create process with values](https://github.com/Alfresco/alfresco-ng2-components/pull/6296) +* [Alfresco/alfresco-ng2-components#6307 - Bump lint-staged from 10.5.0 to 10.5.1](https://github.com/Alfresco/alfresco-ng2-components/pull/6307) +* [Alfresco/alfresco-ng2-components#6308 - Bump @types/selenium-webdriver from 4.0.9 to 4.0.10](https://github.com/Alfresco/alfresco-ng2-components/pull/6308) +* [Alfresco/alfresco-ng2-components#6304 - [AAE-3966] FE - Disable the upload button when the user doesn't have permissions in a folder](https://github.com/Alfresco/alfresco-ng2-components/pull/6304) +* [Alfresco/alfresco-ng2-components#6294 - [ACA-4071] [ADW-Cloud]Task header takes too much to be loaded after claiming a task](https://github.com/Alfresco/alfresco-ng2-components/pull/6294) +* [Alfresco/alfresco-ng2-components#6301 - [AAE-3992] cleanup the code before refactoring](https://github.com/Alfresco/alfresco-ng2-components/pull/6301) +* [Alfresco/alfresco-ng2-components#6310 - Bump graphql from 15.3.0 to 15.4.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6310) +* [Alfresco/alfresco-ng2-components#6311 - Bump remark from 12.0.1 to 13.0.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6311) +* [Alfresco/alfresco-ng2-components#6299 - [ACA-4099] Fix search query in content node selector](https://github.com/Alfresco/alfresco-ng2-components/pull/6299) +* [Alfresco/alfresco-ng2-components#6309 - Bump @types/node from 14.11.2 to 14.14.6](https://github.com/Alfresco/alfresco-ng2-components/pull/6309) +* [Alfresco/alfresco-ng2-components#6297 - [AAE-3967] Add datetime-range search filter component](https://github.com/Alfresco/alfresco-ng2-components/pull/6297) +* [Alfresco/alfresco-ng2-components#6312 - exported search-datetime range component](https://github.com/Alfresco/alfresco-ng2-components/pull/6312) +* [Alfresco/alfresco-ng2-components#6306 - [MNT-22003] - fixed check on variable for visibility service](https://github.com/Alfresco/alfresco-ng2-components/pull/6306) +* [Alfresco/alfresco-ng2-components#6282 - Improve search filter component: hide a facet if there is no filter category](https://github.com/Alfresco/alfresco-ng2-components/pull/6282) +* [Alfresco/alfresco-ng2-components#6303 - [ACA-4057] Edit getProcessInstanceByName method to search the process instance directly by its name](https://github.com/Alfresco/alfresco-ng2-components/pull/6303) +* [Alfresco/alfresco-ng2-components#6317 - Bump @angular/cli from 10.1.4 to 10.2.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6317) +* [Alfresco/alfresco-ng2-components#6316 - Bump snyk from 1.415.0 to 1.424.2](https://github.com/Alfresco/alfresco-ng2-components/pull/6316) +* [Alfresco/alfresco-ng2-components#6315 - Bump mdast-zone from 4.0.0 to 4.0.1](https://github.com/Alfresco/alfresco-ng2-components/pull/6315) +* [Alfresco/alfresco-ng2-components#6313 - Bump mdast-util-heading-range from 2.1.4 to 2.1.5](https://github.com/Alfresco/alfresco-ng2-components/pull/6313) +* [Alfresco/alfresco-ng2-components#6318 - [ACA-828] Add showTitle input in TaskCloudForm component](https://github.com/Alfresco/alfresco-ng2-components/pull/6318) +* [Alfresco/alfresco-ng2-components#6319 - add missing env variables for proxy file](https://github.com/Alfresco/alfresco-ng2-components/pull/6319) +* [Alfresco/alfresco-ng2-components#6302 - [ADF-5223] Fix Amount widget styling](https://github.com/Alfresco/alfresco-ng2-components/pull/6302) +* [Alfresco/alfresco-ng2-components#6129 - [ACA-3373] Add e2e multi item select method in DataTable component](https://github.com/Alfresco/alfresco-ng2-components/pull/6129) +* [Alfresco/alfresco-ng2-components#6328 - Added optional on variable models to avoid breaking changes](https://github.com/Alfresco/alfresco-ng2-components/pull/6328) +* [Alfresco/alfresco-ng2-components#6329 - [ACS-827] - added whitelisted element and method for checking them](https://github.com/Alfresco/alfresco-ng2-components/pull/6329) +* [Alfresco/alfresco-ng2-components#6330 - AAE-3936 Tooltip card directive](https://github.com/Alfresco/alfresco-ng2-components/pull/6330) +* [Alfresco/alfresco-ng2-components#6322 - Bump unist-util-select from 3.0.1 to 3.0.2](https://github.com/Alfresco/alfresco-ng2-components/pull/6322) +* [Alfresco/alfresco-ng2-components#6320 - [MNT-21920] Fix Card View Integers initialization when they are set to 0](https://github.com/Alfresco/alfresco-ng2-components/pull/6320) +* [Alfresco/alfresco-ng2-components#6327 - [ACS-721] Improve End/Cancel Editing UX (part 1) - implement single menu option & dialog](https://github.com/Alfresco/alfresco-ng2-components/pull/6327) +* [Alfresco/alfresco-ng2-components#6305 - [ACA-4124] Change name displayed for groups in Add Permission Panel Component](https://github.com/Alfresco/alfresco-ng2-components/pull/6305) +* [Alfresco/alfresco-ng2-components#6325 - Bump rxjs-tslint-rules from 4.34.1 to 4.34.5](https://github.com/Alfresco/alfresco-ng2-components/pull/6325) +* [Alfresco/alfresco-ng2-components#6332 - [AAE-3936] Fix error in directive component](https://github.com/Alfresco/alfresco-ng2-components/pull/6332) +* [Alfresco/alfresco-ng2-components#6335 - Fix clickUntilIsNotVisible by removing one return](https://github.com/Alfresco/alfresco-ng2-components/pull/6335) +* [Alfresco/alfresco-ng2-components#6337 - Fixed floating promise](https://github.com/Alfresco/alfresco-ng2-components/pull/6337) +* [Alfresco/alfresco-ng2-components#6347 - ix build](https://github.com/Alfresco/alfresco-ng2-components/pull/6347) +* [Alfresco/alfresco-ng2-components#6349 - Bump snyk from 1.424.2 to 1.427.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6349) +* [Alfresco/alfresco-ng2-components#6350 - Bump cspell from 4.1.0 to 4.2.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6350) +* [Alfresco/alfresco-ng2-components#6331 - [ACA-4123] Unify APS and Cloud event emitters for filters](https://github.com/Alfresco/alfresco-ng2-components/pull/6331) +* [Alfresco/alfresco-ng2-components#6348 - [ADF-5284] Restore original plugin functionality](https://github.com/Alfresco/alfresco-ng2-components/pull/6348) +* [Alfresco/alfresco-ng2-components#6336 - [DRAFT] Adding script for updating users on APS1](https://github.com/Alfresco/alfresco-ng2-components/pull/6336) +* [Alfresco/alfresco-ng2-components#6353 - Bump @nrwl/workspace from 10.2.1 to 10.4.1](https://github.com/Alfresco/alfresco-ng2-components/pull/6353) +* [Alfresco/alfresco-ng2-components#6357 - Bump cspell from 4.2.0 to 4.2.2](https://github.com/Alfresco/alfresco-ng2-components/pull/6357) +* [Alfresco/alfresco-ng2-components#6360 - Bump @types/node from 14.14.6 to 14.14.8](https://github.com/Alfresco/alfresco-ng2-components/pull/6360) +* [Alfresco/alfresco-ng2-components#6351 - [AAE-3638] - implement priority drodpown widget](https://github.com/Alfresco/alfresco-ng2-components/pull/6351) +* [Alfresco/alfresco-ng2-components#6359 - Bump stylelint from 13.7.2 to 13.8.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6359) +* [Alfresco/alfresco-ng2-components#6358 - Bump markdownlint-cli from 0.23.2 to 0.25.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6358) +* [Alfresco/alfresco-ng2-components#6355 - [ACA-3957] - Replace icons on process cloud](https://github.com/Alfresco/alfresco-ng2-components/pull/6355) +* [Alfresco/alfresco-ng2-components#6361 - Improve env check](https://github.com/Alfresco/alfresco-ng2-components/pull/6361) +* [Alfresco/alfresco-ng2-components#6371 - [ACA-4124] Display authorityName when authorityDisplayName is missing](https://github.com/Alfresco/alfresco-ng2-components/pull/6371) +* [Alfresco/alfresco-ng2-components#6370 - [AAE-4127] [process-services] [APS1] Return Create Filters API response instead of the default payload](https://github.com/Alfresco/alfresco-ng2-components/pull/6370) +* [Alfresco/alfresco-ng2-components#6374 - [AAE-4188] Fix 3 invalid processes in simpleapp](https://github.com/Alfresco/alfresco-ng2-components/pull/6374) +* [Alfresco/alfresco-ng2-components#6375 - [ACA-4168] - changed to public reset pagination](https://github.com/Alfresco/alfresco-ng2-components/pull/6375) +* [Alfresco/alfresco-ng2-components#6321 - [ACA-3712] Add appVersion multi-select dropdown in edit cloud process filter](https://github.com/Alfresco/alfresco-ng2-components/pull/6321) +* [Alfresco/alfresco-ng2-components#6377 - Bump nconf from 0.10.0 to 0.11.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6377) +* [Alfresco/alfresco-ng2-components#6366 - [AAE-1379] - fixed form rapresentation](https://github.com/Alfresco/alfresco-ng2-components/pull/6366) +* [Alfresco/alfresco-ng2-components#6373 - [AAE-4090] [ADW - Cloud] Warning message is displayed for one second in destination picker when Upload button is enabled](https://github.com/Alfresco/alfresco-ng2-components/pull/6373) +* [Alfresco/alfresco-ng2-components#6376 - Bump snyk from 1.427.0 to 1.430.2](https://github.com/Alfresco/alfresco-ng2-components/pull/6376) +* [Alfresco/alfresco-ng2-components#6385 - [AAE-4077] - TaskCloud: Refactor priority](https://github.com/Alfresco/alfresco-ng2-components/pull/6385) +* [Alfresco/alfresco-ng2-components#6383 - LOC-268 - Fixed. All localised UI files updated in 16 languages](https://github.com/Alfresco/alfresco-ng2-components/pull/6383) +* [Alfresco/alfresco-ng2-components#6386 - Add upload license script](https://github.com/Alfresco/alfresco-ng2-components/pull/6386) +* [Alfresco/alfresco-ng2-components#6395 - Bump rxjs-tslint-rules from 4.34.5 to 4.34.7](https://github.com/Alfresco/alfresco-ng2-components/pull/6395) +* [Alfresco/alfresco-ng2-components#6394 - Bump snyk from 1.430.2 to 1.431.2](https://github.com/Alfresco/alfresco-ng2-components/pull/6394) +* [Alfresco/alfresco-ng2-components#6393 - Bump cspell from 4.2.2 to 4.2.3](https://github.com/Alfresco/alfresco-ng2-components/pull/6393) +* [Alfresco/alfresco-ng2-components#6391 - Fix versioncompatibility directive](https://github.com/Alfresco/alfresco-ng2-components/pull/6391) +* [Alfresco/alfresco-ng2-components#6397 - AAE-4023 fix BASE_PATH as /](https://github.com/Alfresco/alfresco-ng2-components/pull/6397) +* [Alfresco/alfresco-ng2-components#6404 - [ADF-5297] Success Snackbar messages showning as errors](https://github.com/Alfresco/alfresco-ng2-components/pull/6404) +* [Alfresco/alfresco-ng2-components#6405 - [ADF-5294] - fixed problem on form rendering](https://github.com/Alfresco/alfresco-ng2-components/pull/6405) +* [Alfresco/alfresco-ng2-components#6400 - ACA-4171 to ACA-4174 Display the number of activated and deactivated users](https://github.com/Alfresco/alfresco-ng2-components/pull/6400) +* [Alfresco/alfresco-ng2-components#6403 - Clean-up demo shell Error component](https://github.com/Alfresco/alfresco-ng2-components/pull/6403) +* [Alfresco/alfresco-ng2-components#6399 - [ADF-5295] Fix Session not reloaded after User logs in in other tab](https://github.com/Alfresco/alfresco-ng2-components/pull/6399) +* [Alfresco/alfresco-ng2-components#6378 - [ACA-2176] prevent Esc click event bubble into the Viewer](https://github.com/Alfresco/alfresco-ng2-components/pull/6378) +* [Alfresco/alfresco-ng2-components#6409 - fix jasmine and karma integration for IDEs](https://github.com/Alfresco/alfresco-ng2-components/pull/6409) +* [Alfresco/alfresco-ng2-components#6415 - Bump snyk from 1.431.2 to 1.434.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6415) +* [Alfresco/alfresco-ng2-components#6414 - Bump ts-node from 9.0.0 to 9.1.0](https://github.com/Alfresco/alfresco-ng2-components/pull/6414) +* [Alfresco/alfresco-ng2-components#6417 - [ACA-3957] - replace task icon](https://github.com/Alfresco/alfresco-ng2-components/pull/6417) +* [Alfresco/alfresco-ng2-components#6413 - [ADF-5298] Fix Service Tasks not loading](https://github.com/Alfresco/alfresco-ng2-components/pull/6413) +* [Alfresco/alfresco-ng2-components#6422 - [ACA-4202] - caching with version number for the url](https://github.com/Alfresco/alfresco-ng2-components/pull/6422) +* [Alfresco/alfresco-ng2-components#6420 - [ACA-4205] reload on sorting only for server mode](https://github.com/Alfresco/alfresco-ng2-components/pull/6420) +* [Alfresco/alfresco-ng2-components#6423 - [AAE-3638] - update priority option](https://github.com/Alfresco/alfresco-ng2-components/pull/6423) +* [Alfresco/alfresco-ng2-components#6421 - [ACA-4208] - fix date filter by range](https://github.com/Alfresco/alfresco-ng2-components/pull/6421) +* [Alfresco/alfresco-ng2-components#6427 - Bump highlight.js from 10.2.0 to 10.4.1](https://github.com/Alfresco/alfresco-ng2-components/pull/6427) +* [Alfresco/alfresco-ng2-components#6425 - Include back C587084](https://github.com/Alfresco/alfresco-ng2-components/pull/6425) +* [Alfresco/alfresco-ng2-components#6426 - AAE-4262 fix docker redirect with relative url](https://github.com/Alfresco/alfresco-ng2-components/pull/6426) +* [Alfresco/alfresco-ng2-components#6428 - Bump snyk from 1.434.0 to 1.434.2](https://github.com/Alfresco/alfresco-ng2-components/pull/6428) +* [Alfresco/alfresco-ng2-components#6429 - Bump protractor-retry from 1.2.13 to 2.0.1](https://github.com/Alfresco/alfresco-ng2-components/pull/6429) +* [Alfresco/alfresco-ng2-components#6430 - Bump lint-staged from 10.5.1 to 10.5.3](https://github.com/Alfresco/alfresco-ng2-components/pull/6430) +Please refer to the [Alfresco issue tracker](https://issues.alfresco.com/jira/projects/ADF/issues/ADF-581?filter=allopenissues) for other known issues in this release. If you have any questions about the release, please contact us using [Gitter](https://gitter.im/Alfresco/alfresco-ng2-components). + +Thanks to the whole application team and the amazing Alfresco community for the hard work. diff --git a/docs/upgrade-guide/README.md b/docs/upgrade-guide/README.md index d063b537db..b7a9bb38e5 100644 --- a/docs/upgrade-guide/README.md +++ b/docs/upgrade-guide/README.md @@ -6,6 +6,7 @@ Title: Upgrade guides Below are links to the upgrade guides notes for all released versions of ADF back to v2.6.0 +- [Upgrading from ADF v3.2 to v3.3](upgrade41-42.md) - [Upgrading from ADF v3.2 to v3.3](upgrade40-41.md) - [Upgrading from ADF v3.2 to v3.3](upgrade39-40.md) - [Upgrading from ADF v3.2 to v3.3](upgrade37-38.md) diff --git a/docs/upgrade-guide/upgrade41-42.md b/docs/upgrade-guide/upgrade41-42.md new file mode 100644 index 0000000000..2988ac88ea --- /dev/null +++ b/docs/upgrade-guide/upgrade41-42.md @@ -0,0 +1,89 @@ +--- +Title: Upgrading from ADF v4.1 to v4.2 +--- + +# Upgrading from ADF v4.1 to v4.2 + +This guide explains how to upgrade your ADF v4.1 project to work with v4.2. + +Do not skip this task, if you want your application to be updated to a most recent version of ADF. +Upgrades of multiple versions of ADF cannot be done in one step only, but should follow the chain of sequential updates. + +**Note:** the steps described below might involve making changes +to your code. If you are working with a versioning system then you should +commit any changes you are currently working on. If you aren't using versioning +then be sure to make a backup copy of your project before going ahead with the +upgrade. + +This guide explains how to upgrade your ADF v3.2 project to work with v3.3. + +Do not skip this task, if you want your application to be updated to a most recent version of ADF. Upgrades of multiple versions of ADF cannot be done in one step only, but should follow the chain of sequential updates. + +**Note:** the steps described below might involve making changes +to your code. If you are working with a versioning system then you should +commit any changes you are currently working on. If you aren't using versioning +then be sure to make a backup copy of your project before going ahead with the +upgrade. + +## Library updates + +### Automatic update using the Yeoman Generator + +If your application has few changes from the original app created by the +[Yeoman generator](https://github.com/Alfresco/generator-ng2-alfresco-app) +then you may be able to update your project with the following steps: + +1. Update the Yeoman generator to the latest version (4.1.0). Note that + you might need to run these commands with `sudo` on Linux or MacOS: + + ```sh + npm uninstall -g generator-alfresco-adf-app + npm install -g generator-alfresco-adf-app + ``` + +2. Run the new yeoman app generator: + + ```sh + yo alfresco-adf-app + ``` + +3. Clean your old distribution and dependencies by deleting the `node_modules` folder + and the `package-lock.json` file. + +4. Install the dependencies: + ```sh + npm install + ``` + +At this point, the generator might have overwritten some of your code where it differs from +the original generated app. Be sure to check for any differences from your project code +(using a versioning system might make this easier) and if there are any differences, +retrofit your changes. When you have done this, you should be able to start the application +as usual: + +```sh +npm run start +``` + +After starting the app, if everything is working fine, that's all and you don't need to do anything else. However, if things don't work as they should then recover the original version of the project and try the manual approach. + +### Manual update + +1. Update the `package.json` file with the latest library versions: + ```json + "dependencies": { + ... + "@alfresco/adf-core": "4.1.0", + "@alfresco/adf-content-services": "4.1.0", + "@alfresco/adf-process-services-cloud": "4.1.0", + "@alfresco/adf-insights": "4.1.0", + "@alfresco/js-api": "4.1.0", + ... + ``` + +2. Clean your old distribution and dependencies by deleting `node_modules` and `package-lock.json`. + +3. Reinstall your dependencies + ```sh + npm install + ``` diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 1846744d05..26eff44f6e 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -12,31 +12,42 @@ backend services have been tested with each released version of ADF. ## Versions -- [v4.1.0](#v410) -- [v4.0.0](#v400) -- [v3.9.0](#v390) -- [v3.8.0](#v380) -- [v3.7.0](#v370) -- [v3.6.0](#v360) -- [v3.5.0](#v350) -- [v3.4.0](#v340) -- [v3.3.0](#v330) -- [v3.2.1](#v321) -- [v3.2.0](#v320) -- [v3.1.0](#v310) -- [v3.0.0](#v300) -- [v2.6.0](#v260) -- [v2.5.0](#v250) -- [v2.4.0](#v240) -- [v2.3.0](#v230) -- [v2.2.0](#v220) -- [v2.1.0](#v210) -- [v2.0.0](#v200) +* [v4.2.0](#v420) +* [v4.1.0](#v410) +* [v4.0.0](#v400) +* [v3.9.0](#v390) +* [v3.8.0](#v380) +* [v3.7.0](#v370) +* [v3.6.0](#v360) +* [v3.5.0](#v350) +* [v3.4.0](#v340) +* [v3.3.0](#v330) +* [v3.2.1](#v321) +* [v3.2.0](#v320) +* [v3.1.0](#v310) +* [v3.0.0](#v300) +* [v2.6.0](#v260) +* [v2.5.0](#v250) +* [v2.4.0](#v240) +* [v2.3.0](#v230) +* [v2.2.0](#v220) +* [v2.1.0](#v210) +* [v2.0.0](#v200) + +## v4.2.0 + + + +* [Search datetime range component](content-services/components/search-datetime-range.component.md) + + ## v4.1.0 +* [Version upload component](content-services/components/version-upload.component.md) + ## v4.0.0 @@ -49,16 +60,16 @@ backend services have been tested with each released version of ADF. -- [Audit service](content-services/services/audit.service.md) -- [Claim task cloud directive](process-services-cloud/directives/claim-task-cloud.directive.md) -- [Claim task directive](process-services/directives/claim-task.directive.md) -- [Form custom outcome component](process-services/components/form-custom-outcome.component.md) -- [Process name cloud pipe](process-services-cloud/pipes/process-name-cloud.pipe.md) -- [Process name pipe](process-services/pipes/process-name.pipe.md) -- [Unclaim task cloud directive](process-services-cloud/directives/unclaim-task-cloud.directive.md) -- [Unclaim task directive](process-services/directives/unclaim-task.directive.md) -- [Version comparison component](content-services/components/version-comparison.component.md) -- [Version compatibility directive](core/directives/version-compatibility.directive.md) +* [Audit service](content-services/services/audit.service.md) +* [Claim task cloud directive](process-services-cloud/directives/claim-task-cloud.directive.md) +* [Claim task directive](process-services/directives/claim-task.directive.md) +* [Form custom outcome component](process-services/components/form-custom-outcome.component.md) +* [Process name cloud pipe](process-services-cloud/pipes/process-name-cloud.pipe.md) +* [Process name pipe](process-services/pipes/process-name.pipe.md) +* [Unclaim task cloud directive](process-services-cloud/directives/unclaim-task-cloud.directive.md) +* [Unclaim task directive](process-services/directives/unclaim-task.directive.md) +* [Version comparison component](content-services/components/version-comparison.component.md) +* [Version compatibility directive](core/directives/version-compatibility.directive.md) @@ -74,7 +85,7 @@ backend services have been tested with each released version of ADF. -- [Cancel process directive](process-services-cloud/directives/cancel-process.directive.md) +* [Cancel process directive](process-services-cloud/directives/cancel-process.directive.md) @@ -84,7 +95,7 @@ backend services have been tested with each released version of ADF. -- [Search text input component](core/components/search-text-input.component.md) +* [Search text input component](core/components/search-text-input.component.md) @@ -94,11 +105,11 @@ backend services have been tested with each released version of ADF. -- [About application component](core/components/about-application.component.md) -- [About github link component](core/components/about-github-link.component.md) -- [About product version component](core/components/about-product-version.component.md) -- [Edit json dialog](core/dialogs/edit-json.dialog.md) -- [Identity role service](core/services/identity-role.service.md) +* [About application component](core/components/about-application.component.md) +* [About github link component](core/components/about-github-link.component.md) +* [About product version component](core/components/about-product-version.component.md) +* [Edit json dialog](core/dialogs/edit-json.dialog.md) +* [Identity role service](core/services/identity-role.service.md) @@ -108,10 +119,10 @@ backend services have been tested with each released version of ADF. -- [Decimal number pipe](core/pipes/decimal-number.pipe.md) -- [Identity group service](core/services/identity-group.service.md) -- [Local preference cloud service](process-services-cloud/services/local-preference-cloud.service.md) -- [User preference cloud service](process-services-cloud/services/user-preference-cloud.service.md) +* [Decimal number pipe](core/pipes/decimal-number.pipe.md) +* [Identity group service](core/services/identity-group.service.md) +* [Local preference cloud service](process-services-cloud/services/local-preference-cloud.service.md) +* [User preference cloud service](process-services-cloud/services/user-preference-cloud.service.md) @@ -121,9 +132,9 @@ backend services have been tested with each released version of ADF. -- [Form definition selector cloud component](process-services-cloud/components/form-definition-selector-cloud.component.md) -- [Localized date pipe](core/pipes/localized-date.pipe.md) -- [Notification history component](core/components/notification-history.component.md) +* [Form definition selector cloud component](process-services-cloud/components/form-definition-selector-cloud.component.md) +* [Localized date pipe](core/pipes/localized-date.pipe.md) +* [Notification history component](core/components/notification-history.component.md) @@ -133,14 +144,14 @@ backend services have been tested with each released version of ADF. -- [Clipboard directive](core/directives/clipboard.directive.md) -- [Clipboard service](core/services/clipboard.service.md) -- [Form cloud custom outcome component](process-services-cloud/components/form-cloud-custom-outcome.component.md) -- [Form cloud component](process-services-cloud/components/form-cloud.component.md) -- [Form cloud service](process-services-cloud/services/form-cloud.service.md) -- [Json cell component](core/components/json-cell.component.md) -- [Multi value pipe](core/pipes/multi-value.pipe.md) -- [Task form cloud component](process-services-cloud/components/task-form-cloud.component.md) +* [Clipboard directive](core/directives/clipboard.directive.md) +* [Clipboard service](core/services/clipboard.service.md) +* [Form cloud custom outcome component](process-services-cloud/components/form-cloud-custom-outcome.component.md) +* [Form cloud component](process-services-cloud/components/form-cloud.component.md) +* [Form cloud service](process-services-cloud/services/form-cloud.service.md) +* [Json cell component](core/components/json-cell.component.md) +* [Multi value pipe](core/pipes/multi-value.pipe.md) +* [Task form cloud component](process-services-cloud/components/task-form-cloud.component.md) @@ -150,10 +161,10 @@ backend services have been tested with each released version of ADF. -- [Auth guard sso role service](core/services/auth-guard-sso-role.service.md) -- [Complete task directive](process-services-cloud/directives/complete-task.directive.md) -- [Preview extension component](extensions/components/preview-extension.component.md) -- [Task cloud service](process-services-cloud/services/task-cloud.service.md) +* [Auth guard sso role service](core/services/auth-guard-sso-role.service.md) +* [Complete task directive](process-services-cloud/directives/complete-task.directive.md) +* [Preview extension component](extensions/components/preview-extension.component.md) +* [Task cloud service](process-services-cloud/services/task-cloud.service.md) @@ -165,39 +176,38 @@ backend services have been tested with each released version of ADF. -- [App list cloud component](process-services-cloud/components/app-list-cloud.component.md) -- [Apps process cloud service](process-services-cloud/services/apps-process-cloud.service.md) -- [Dynamic component](extensions/components/dynamic.component.md) -- [Edit process filter cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) -- [Edit task filter cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) -- [Extension service](extensions/services/extension.service.md) -- [File upload error pipe](content-services/pipes/file-upload-error.pipe.md) -- [Format space pipe](core/pipes/format-space.pipe.md) -- [Full name pipe](core/pipes/full-name.pipe.md) -- [Group cloud component](process-services-cloud/components/group-cloud.component.md) -- [Group cloud service](process-services-cloud/services/group-cloud.service.md) -- [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) -- [Icon component](core/components/icon.component.md) -- [Identity user service](core/services/identity-user.service.md) -- [Jwt helper service](core/services/jwt-helper.service.md) -- [Library dialog](content-services/dialogs/library.dialog.md) -- [People cloud component](process-services-cloud/components/people-cloud.component.md) -- [Process cloud service](process-services-cloud/services/process-cloud.service.md) -- [Process filter cloud service](process-services-cloud/services/process-filter-cloud.service.md) -- [Process filters cloud component](process-services-cloud/components/process-filters-cloud.component.md) -- [Process header cloud component](process-services-cloud/components/process-header-cloud.component.md) -- [Process list cloud component](process-services-cloud/components/process-list-cloud.component.md) -- [Process list cloud service](process-services-cloud/services/process-list-cloud.service.md) -- [Start process cloud component](process-services-cloud/components/start-process-cloud.component.md) -- [Start process cloud service](process-services-cloud/services/start-process-cloud.service.md) -- [Start task cloud component](process-services-cloud/components/start-task-cloud.component.md) -- [Start task cloud service](process-services-cloud/services/start-task-cloud.service.md) -- [Task filter cloud service](process-services-cloud/services/task-filter-cloud.service.md) -- [Task filters cloud component](process-services-cloud/components/task-filters-cloud.component.md) -- [Task header cloud component](process-services-cloud/components/task-header-cloud.component.md) -- [Task list cloud component](process-services-cloud/components/task-list-cloud.component.md) -- [Task list cloud service](process-services-cloud/services/task-list-cloud.service.md) -- [Tree view component](content-services/components/tree-view.component.md) +* [App list cloud component](process-services-cloud/components/app-list-cloud.component.md) +* [Apps process cloud service](process-services-cloud/services/apps-process-cloud.service.md) +* [Dynamic component](extensions/components/dynamic.component.md) +* [Edit process filter cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) +* [Edit task filter cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) +* [Extension service](extensions/services/extension.service.md) +* [File upload error pipe](content-services/pipes/file-upload-error.pipe.md) +* [Format space pipe](core/pipes/format-space.pipe.md) +* [Full name pipe](core/pipes/full-name.pipe.md) +* [Group cloud component](process-services-cloud/components/group-cloud.component.md) +* [Group cloud service](process-services-cloud/services/group-cloud.service.md) +* [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) +* [Icon component](core/components/icon.component.md) +* [Identity user service](core/services/identity-user.service.md) +* [Jwt helper service](core/services/jwt-helper.service.md) +* [Library dialog](content-services/dialogs/library.dialog.md) +* [Process cloud service](process-services-cloud/services/process-cloud.service.md) +* [Process filter cloud service](process-services-cloud/services/process-filter-cloud.service.md) +* [Process filters cloud component](process-services-cloud/components/process-filters-cloud.component.md) +* [Process header cloud component](process-services-cloud/components/process-header-cloud.component.md) +* [Process list cloud component](process-services-cloud/components/process-list-cloud.component.md) +* [Process list cloud service](process-services-cloud/services/process-list-cloud.service.md) +* [Start process cloud component](process-services-cloud/components/start-process-cloud.component.md) +* [Start process cloud service](process-services-cloud/services/start-process-cloud.service.md) +* [Start task cloud component](process-services-cloud/components/start-task-cloud.component.md) +* [Start task cloud service](process-services-cloud/services/start-task-cloud.service.md) +* [Task filter cloud service](process-services-cloud/services/task-filter-cloud.service.md) +* [Task filters cloud component](process-services-cloud/components/task-filters-cloud.component.md) +* [Task header cloud component](process-services-cloud/components/task-header-cloud.component.md) +* [Task list cloud component](process-services-cloud/components/task-list-cloud.component.md) +* [Task list cloud service](process-services-cloud/services/task-list-cloud.service.md) +* [Tree view component](content-services/components/tree-view.component.md) @@ -220,9 +230,9 @@ backend services have been tested with each released version of ADF. -- [Login dialog panel component](core/components/login-dialog-panel.component.md) -- [Login dialog component](core/components/login-dialog.component.md) -- [Login dialog service](core/services/login-dialog.service.md) +* [Login dialog panel component](core/components/login-dialog-panel.component.md) +* [Login dialog component](core/components/login-dialog.component.md) +* [Login dialog service](core/services/login-dialog.service.md) @@ -238,7 +248,7 @@ backend services have been tested with each released version of ADF. -- [Header component](core/components/header.component.md) +* [Header component](core/components/header.component.md) @@ -254,23 +264,23 @@ backend services have been tested with each released version of ADF. -- [Add permission dialog component](content-services/components/add-permission-dialog.component.md) -- [Add permission panel component](content-services/components/add-permission-panel.component.md) -- [Add permission component](content-services/components/add-permission.component.md) -- [App config pipe](core/pipes/app-config.pipe.md) -- [Buttons menu component](core/components/buttons-menu.component.md) -- [Empty content component](core/components/empty-content.component.md) -- [Error content component](core/components/error-content.component.md) -- [Info drawer tab component](core/components/info-drawer-tab.component.md) -- [Node permission dialog service](content-services/services/node-permission-dialog.service.md) -- [Search check list component](content-services/components/search-check-list.component.md) -- [Search date range component](content-services/components/search-date-range.component.md) -- [Search filter service](content-services/services/search-filter.service.md) -- [Search number range component](content-services/components/search-number-range.component.md) -- [Search radio component](content-services/components/search-radio.component.md) -- [Search slider component](content-services/components/search-slider.component.md) -- [Search text component](content-services/components/search-text.component.md) -- [Sorting picker component](core/components/sorting-picker.component.md) +* [Add permission dialog component](content-services/components/add-permission-dialog.component.md) +* [Add permission panel component](content-services/components/add-permission-panel.component.md) +* [Add permission component](content-services/components/add-permission.component.md) +* [App config pipe](core/pipes/app-config.pipe.md) +* [Buttons menu component](core/components/buttons-menu.component.md) +* [Empty content component](core/components/empty-content.component.md) +* [Error content component](core/components/error-content.component.md) +* [Info drawer tab component](core/components/info-drawer-tab.component.md) +* [Node permission dialog service](content-services/services/node-permission-dialog.service.md) +* [Search check list component](content-services/components/search-check-list.component.md) +* [Search date range component](content-services/components/search-date-range.component.md) +* [Search filter service](content-services/services/search-filter.service.md) +* [Search number range component](content-services/components/search-number-range.component.md) +* [Search radio component](content-services/components/search-radio.component.md) +* [Search slider component](content-services/components/search-slider.component.md) +* [Search text component](content-services/components/search-text.component.md) +* [Sorting picker component](core/components/sorting-picker.component.md) @@ -286,18 +296,18 @@ backend services have been tested with each released version of ADF. -- [Comment content service](core/services/comment-content.service.md) -- [Confirm dialog](content-services/dialogs/confirm.dialog.md) -- [Content node share directive](content-services/directives/content-node-share.directive.md) -- [Custom resources service](content-services/services/custom-resources.service.md) -- [Inherited button directive](content-services/directives/inherited-button.directive.md) -- [Permission list component](content-services/components/permission-list.component.md) -- [Search chip list component](content-services/components/search-chip-list.component.md) -- [Search filter component](content-services/components/search-filter.component.md) -- [Search query builder service](content-services/services/search-query-builder.service.md) -- [Search sorting picker component](content-services/components/search-sorting-picker.component.md) -- [Sidenav layout component](core/components/sidenav-layout.component.md) -- [Upload version button component](content-services/components/upload-version-button.component.md) +* [Comment content service](core/services/comment-content.service.md) +* [Confirm dialog](content-services/dialogs/confirm.dialog.md) +* [Content node share directive](content-services/directives/content-node-share.directive.md) +* [Custom resources service](content-services/services/custom-resources.service.md) +* [Inherited button directive](content-services/directives/inherited-button.directive.md) +* [Permission list component](content-services/components/permission-list.component.md) +* [Search chip list component](content-services/components/search-chip-list.component.md) +* [Search filter component](content-services/components/search-filter.component.md) +* [Search query builder service](content-services/services/search-query-builder.service.md) +* [Search sorting picker component](content-services/components/search-sorting-picker.component.md) +* [Sidenav layout component](core/components/sidenav-layout.component.md) +* [Upload version button component](content-services/components/upload-version-button.component.md) @@ -313,8 +323,8 @@ backend services have been tested with each released version of ADF. -- [Node download directive](core/directives/node-download.directive.md) -- [Node lock directive](content-services/directives/node-lock.directive.md) +* [Node download directive](core/directives/node-download.directive.md) +* [Node lock directive](content-services/directives/node-lock.directive.md) @@ -330,11 +340,11 @@ backend services have been tested with each released version of ADF. -- [Content metadata card component](content-services/components/content-metadata-card.component.md) -- [Content node dialog service](content-services/services/content-node-dialog.service.md) -- [Content node selector panel component](content-services/components/content-node-selector-panel.component.md) -- [Search configuration service](core/services/search-configuration.service.md) -- [Sidebar action menu component](core/components/sidebar-action-menu.component.md) +* [Content metadata card component](content-services/components/content-metadata-card.component.md) +* [Content node dialog service](content-services/services/content-node-dialog.service.md) +* [Content node selector panel component](content-services/components/content-node-selector-panel.component.md) +* [Search configuration service](core/services/search-configuration.service.md) +* [Sidebar action menu component](core/components/sidebar-action-menu.component.md) @@ -350,156 +360,157 @@ backend services have been tested with each released version of ADF. -- [Activiti alfresco service](core/services/activiti-alfresco.service.md) -- [Alfresco api service](core/services/alfresco-api.service.md) -- [Analytics generator component](insights/components/analytics-generator.component.md) -- [Analytics report list component](insights/components/analytics-report-list.component.md) -- [Analytics component](insights/components/analytics.component.md) -- [App config service](core/services/app-config.service.md) -- [Apps list component](process-services/components/apps-list.component.md) -- [Apps process service](core/services/apps-process.service.md) -- [Attach form component](process-services/components/attach-form.component.md) -- [Auth guard bpm service](core/services/auth-guard-bpm.service.md) -- [Auth guard ecm service](core/services/auth-guard-ecm.service.md) -- [Auth guard service](core/services/auth-guard.service.md) -- [Authentication service](core/services/authentication.service.md) -- [Bpm user model](core/models/bpm-user.model.md) -- [Bpm user service](core/services/bpm-user.service.md) -- [Breadcrumb component](content-services/components/breadcrumb.component.md) -- [Card item types service](core/services/card-item-types.service.md) -- [Card view update service](core/services/card-view-update.service.md) -- [Card view component](core/components/card-view.component.md) -- [Check allowable operation directive](core/directives/check-allowable-operation.directive.md) -- [Checklist component](process-services/components/checklist.component.md) -- [Comment list component](core/components/comment-list.component.md) -- [Comment process service](core/services/comment-process.service.md) -- [Comments component](core/components/comments.component.md) -- [Content action component](content-services/components/content-action.component.md) -- [Content node selector component](content-services/components/content-node-selector.component.md) -- [Content service](core/services/content.service.md) -- [Content widget](core/widgets/content.widget.md) -- [Context menu directive](core/directives/context-menu.directive.md) -- [Cookie service](core/services/cookie.service.md) -- [Create process attachment component](process-services/components/create-process-attachment.component.md) -- [Create task attachment component](process-services/components/create-task-attachment.component.md) -- [Data column component](core/components/data-column.component.md) -- [Datatable component](core/components/datatable.component.md) -- [Deleted nodes api service](core/services/deleted-nodes-api.service.md) -- [Diagram component](insights/components/diagram.component.md) -- [Discovery api service](core/services/discovery-api.service.md) -- [Document actions service](content-services/services/document-actions.service.md) -- [Document list component](content-services/components/document-list.component.md) -- [Document list service](content-services/services/document-list.service.md) -- [Download zip service](core/services/download-zip.service.md) -- [Dropdown breadcrumb component](content-services/components/dropdown-breadcrumb.component.md) -- [Ecm user model](core/models/ecm-user.model.md) -- [Ecm user service](core/services/ecm-user.service.md) -- [Empty list component](core/components/empty-list.component.md) -- [Favorites api service](core/services/favorites-api.service.md) -- [File draggable directive](content-services/directives/file-draggable.directive.md) -- [File size pipe](core/pipes/file-size.pipe.md) -- [File uploading dialog component](content-services/components/file-uploading-dialog.component.md) -- [Folder actions service](content-services/services/folder-actions.service.md) -- [Folder create directive](content-services/directives/folder-create.directive.md) -- [Folder edit directive](content-services/directives/folder-edit.directive.md) -- [Form field component](core/components/form-field.component.md) -- [Form field model](core/models/form-field.model.md) -- [Form list component](core/components/form-list.component.md) -- [Form rendering service](core/services/form-rendering.service.md) -- [Form component](process-services/components/form.component.md) -- [Form service](core/services/form.service.md) -- [Highlight transform service](core/services/highlight-transform.service.md) -- [Highlight directive](core/directives/highlight.directive.md) -- [Host settings component](core/components/host-settings.component.md) -- [Image resolver model](content-services/models/image-resolver.model.md) -- [Infinite pagination component](core/components/infinite-pagination.component.md) -- [Info drawer layout component](core/components/info-drawer-layout.component.md) -- [Info drawer component](core/components/info-drawer.component.md) -- [Language menu component](core/components/language-menu.component.md) -- [Like component](content-services/components/like.component.md) -- [Log service](core/services/log.service.md) -- [Login component](core/components/login.component.md) -- [Logout directive](core/directives/logout.directive.md) -- [Mime type icon pipe](core/pipes/mime-type-icon.pipe.md) -- [Node delete directive](core/directives/node-delete.directive.md) -- [Node favorite directive](core/directives/node-favorite.directive.md) -- [Node name tooltip pipe](core/pipes/node-name-tooltip.pipe.md) -- [Node permission service](content-services/services/node-permission.service.md) -- [Node restore directive](core/directives/node-restore.directive.md) -- [Node service](core/services/node.service.md) -- [Nodes api service](core/services/nodes-api.service.md) -- [Notification service](core/services/notification.service.md) -- [Page title service](core/services/page-title.service.md) -- [Pagination component](core/components/pagination.component.md) -- [People content service](core/services/people-content.service.md) -- [People list component](process-services/components/people-list.component.md) -- [People process service](core/services/people-process.service.md) -- [People search component](process-services/components/people-search.component.md) -- [People component](process-services/components/people.component.md) -- [Permissions style model](content-services/models/permissions-style.model.md) -- [Process attachment list component](process-services/components/process-attachment-list.component.md) -- [Process audit directive](process-services/directives/process-audit.directive.md) -- [Process comments component](process-services/components/process-comments.component.md) -- [Process content service](core/services/process-content.service.md) -- [Process filter service](process-services/services/process-filter.service.md) -- [Process filters component](process-services/components/process-filters.component.md) -- [Process instance details component](process-services/components/process-instance-details.component.md) -- [Process instance header component](process-services/components/process-instance-header.component.md) -- [Process instance tasks component](process-services/components/process-instance-tasks.component.md) -- [Process list component](process-services/components/process-list.component.md) -- [Process service](process-services/services/process.service.md) -- [Product version model](core/models/product-version.model.md) -- [Rating component](content-services/components/rating.component.md) -- [Rating service](content-services/services/rating.service.md) -- [Renditions service](core/services/renditions.service.md) -- [Row filter model](content-services/models/row-filter.model.md) -- [Search control component](content-services/components/search-control.component.md) -- [Search component](content-services/components/search.component.md) -- [Search service](core/services/search.service.md) -- [Select apps dialog component](process-services/components/select-apps-dialog.component.md) -- [Shared links api service](core/services/shared-links-api.service.md) -- [Sites dropdown component](content-services/components/sites-dropdown.component.md) -- [Sites service](core/services/sites.service.md) -- [Start form component](core/components/start-form.component.md) -- [Start process component](process-services/components/start-process.component.md) -- [Start task component](process-services/components/start-task.component.md) -- [Storage service](core/services/storage.service.md) -- [Tag actions component](content-services/components/tag-actions.component.md) -- [Tag list component](content-services/components/tag-list.component.md) -- [Tag node list component](content-services/components/tag-node-list.component.md) -- [Tag service](content-services/services/tag.service.md) -- [Task attachment list component](process-services/components/task-attachment-list.component.md) -- [Task audit directive](process-services/directives/task-audit.directive.md) -- [Task details component](process-services/components/task-details.component.md) -- [Task filter service](process-services/services/task-filter.service.md) -- [Task filters component](process-services/components/task-filters.component.md) -- [Task form component](process-services/components/task-form.component.md) -- [Task header component](process-services/components/task-header.component.md) -- [Task list component](process-services/components/task-list.component.md) -- [Task standalone component](process-services/components/task-standalone.component.md) -- [Tasklist service](process-services/services/tasklist.service.md) -- [Text highlight pipe](core/pipes/text-highlight.pipe.md) -- [Text mask component](core/components/text-mask.component.md) -- [Thumbnail service](core/services/thumbnail.service.md) -- [Time ago pipe](core/pipes/time-ago.pipe.md) -- [Toggle icon directive](content-services/directives/toggle-icon.directive.md) -- [Toolbar divider component](core/components/toolbar-divider.component.md) -- [Toolbar title component](core/components/toolbar-title.component.md) -- [Toolbar component](core/components/toolbar.component.md) -- [Translation service](core/services/translation.service.md) -- [Upload button component](content-services/components/upload-button.component.md) -- [Upload drag area component](content-services/components/upload-drag-area.component.md) -- [Upload directive](core/directives/upload.directive.md) -- [Upload service](core/services/upload.service.md) -- [User info component](core/components/user-info.component.md) -- [User initial pipe](core/pipes/user-initial.pipe.md) -- [User preferences service](core/services/user-preferences.service.md) -- [User process model](core/models/user-process.model.md) -- [Version list component](content-services/components/version-list.component.md) -- [Version manager component](content-services/components/version-manager.component.md) -- [Viewer component](core/components/viewer.component.md) -- [Webscript component](content-services/components/webscript.component.md) -- [Widget component](insights/components/widget.component.md) +* [Activiti alfresco service](core/services/activiti-alfresco.service.md) +* [Alfresco api service](core/services/alfresco-api.service.md) +* [Analytics generator component](insights/components/analytics-generator.component.md) +* [Analytics report list component](insights/components/analytics-report-list.component.md) +* [Analytics component](insights/components/analytics.component.md) +* [App config service](core/services/app-config.service.md) +* [Apps list component](process-services/components/apps-list.component.md) +* [Apps process service](core/services/apps-process.service.md) +* [Attach form component](process-services/components/attach-form.component.md) +* [Auth guard bpm service](core/services/auth-guard-bpm.service.md) +* [Auth guard ecm service](core/services/auth-guard-ecm.service.md) +* [Auth guard service](core/services/auth-guard.service.md) +* [Authentication service](core/services/authentication.service.md) +* [Bpm user model](core/models/bpm-user.model.md) +* [Bpm user service](core/services/bpm-user.service.md) +* [Breadcrumb component](content-services/components/breadcrumb.component.md) +* [Card item types service](core/services/card-item-types.service.md) +* [Card view update service](core/services/card-view-update.service.md) +* [Card view component](core/components/card-view.component.md) +* [Check allowable operation directive](core/directives/check-allowable-operation.directive.md) +* [Checklist component](process-services/components/checklist.component.md) +* [Comment list component](core/components/comment-list.component.md) +* [Comment process service](core/services/comment-process.service.md) +* [Comments component](core/components/comments.component.md) +* [Content action component](content-services/components/content-action.component.md) +* [Content node selector component](content-services/components/content-node-selector.component.md) +* [Content service](core/services/content.service.md) +* [Content widget](core/widgets/content.widget.md) +* [Context menu directive](core/directives/context-menu.directive.md) +* [Cookie service](core/services/cookie.service.md) +* [Create process attachment component](process-services/components/create-process-attachment.component.md) +* [Create task attachment component](process-services/components/create-task-attachment.component.md) +* [Data column component](core/components/data-column.component.md) +* [Datatable component](core/components/datatable.component.md) +* [Deleted nodes api service](core/services/deleted-nodes-api.service.md) +* [Diagram component](insights/components/diagram.component.md) +* [Discovery api service](core/services/discovery-api.service.md) +* [Document actions service](content-services/services/document-actions.service.md) +* [Document list component](content-services/components/document-list.component.md) +* [Document list service](content-services/services/document-list.service.md) +* [Download zip service](core/services/download-zip.service.md) +* [Dropdown breadcrumb component](content-services/components/dropdown-breadcrumb.component.md) +* [Ecm user model](core/models/ecm-user.model.md) +* [Ecm user service](core/services/ecm-user.service.md) +* [Empty list component](core/components/empty-list.component.md) +* [Favorites api service](core/services/favorites-api.service.md) +* [File draggable directive](content-services/directives/file-draggable.directive.md) +* [File size pipe](core/pipes/file-size.pipe.md) +* [File uploading dialog component](content-services/components/file-uploading-dialog.component.md) +* [Folder actions service](content-services/services/folder-actions.service.md) +* [Folder create directive](content-services/directives/folder-create.directive.md) +* [Folder edit directive](content-services/directives/folder-edit.directive.md) +* [Form field component](core/components/form-field.component.md) +* [Form field model](core/models/form-field.model.md) +* [Form list component](core/components/form-list.component.md) +* [Form rendering service](core/services/form-rendering.service.md) +* [Form component](process-services/components/form.component.md) +* [Form service](core/services/form.service.md) +* [Highlight transform service](core/services/highlight-transform.service.md) +* [Highlight directive](core/directives/highlight.directive.md) +* [Host settings component](core/components/host-settings.component.md) +* [Image resolver model](content-services/models/image-resolver.model.md) +* [Infinite pagination component](core/components/infinite-pagination.component.md) +* [Info drawer layout component](core/components/info-drawer-layout.component.md) +* [Info drawer component](core/components/info-drawer.component.md) +* [Language menu component](core/components/language-menu.component.md) +* [Like component](content-services/components/like.component.md) +* [Log service](core/services/log.service.md) +* [Login component](core/components/login.component.md) +* [Logout directive](core/directives/logout.directive.md) +* [Mime type icon pipe](core/pipes/mime-type-icon.pipe.md) +* [Node delete directive](core/directives/node-delete.directive.md) +* [Node favorite directive](core/directives/node-favorite.directive.md) +* [Node name tooltip pipe](core/pipes/node-name-tooltip.pipe.md) +* [Node permission service](content-services/services/node-permission.service.md) +* [Node restore directive](core/directives/node-restore.directive.md) +* [Node service](core/services/node.service.md) +* [Nodes api service](core/services/nodes-api.service.md) +* [Notification service](core/services/notification.service.md) +* [Page title service](core/services/page-title.service.md) +* [Pagination component](core/components/pagination.component.md) +* [People cloud component](process-services-cloud/components/people-cloud.component.md) +* [People content service](core/services/people-content.service.md) +* [People list component](process-services/components/people-list.component.md) +* [People process service](core/services/people-process.service.md) +* [People search component](process-services/components/people-search.component.md) +* [People component](process-services/components/people.component.md) +* [Permissions style model](content-services/models/permissions-style.model.md) +* [Process attachment list component](process-services/components/process-attachment-list.component.md) +* [Process audit directive](process-services/directives/process-audit.directive.md) +* [Process comments component](process-services/components/process-comments.component.md) +* [Process content service](core/services/process-content.service.md) +* [Process filter service](process-services/services/process-filter.service.md) +* [Process filters component](process-services/components/process-filters.component.md) +* [Process instance details component](process-services/components/process-instance-details.component.md) +* [Process instance header component](process-services/components/process-instance-header.component.md) +* [Process instance tasks component](process-services/components/process-instance-tasks.component.md) +* [Process list component](process-services/components/process-list.component.md) +* [Process service](process-services/services/process.service.md) +* [Product version model](core/models/product-version.model.md) +* [Rating component](content-services/components/rating.component.md) +* [Rating service](content-services/services/rating.service.md) +* [Renditions service](core/services/renditions.service.md) +* [Row filter model](content-services/models/row-filter.model.md) +* [Search control component](content-services/components/search-control.component.md) +* [Search component](content-services/components/search.component.md) +* [Search service](core/services/search.service.md) +* [Select apps dialog component](process-services/components/select-apps-dialog.component.md) +* [Shared links api service](core/services/shared-links-api.service.md) +* [Sites dropdown component](content-services/components/sites-dropdown.component.md) +* [Sites service](core/services/sites.service.md) +* [Start form component](core/components/start-form.component.md) +* [Start process component](process-services/components/start-process.component.md) +* [Start task component](process-services/components/start-task.component.md) +* [Storage service](core/services/storage.service.md) +* [Tag actions component](content-services/components/tag-actions.component.md) +* [Tag list component](content-services/components/tag-list.component.md) +* [Tag node list component](content-services/components/tag-node-list.component.md) +* [Tag service](content-services/services/tag.service.md) +* [Task attachment list component](process-services/components/task-attachment-list.component.md) +* [Task audit directive](process-services/directives/task-audit.directive.md) +* [Task details component](process-services/components/task-details.component.md) +* [Task filter service](process-services/services/task-filter.service.md) +* [Task filters component](process-services/components/task-filters.component.md) +* [Task form component](process-services/components/task-form.component.md) +* [Task header component](process-services/components/task-header.component.md) +* [Task list component](process-services/components/task-list.component.md) +* [Task standalone component](process-services/components/task-standalone.component.md) +* [Tasklist service](process-services/services/tasklist.service.md) +* [Text highlight pipe](core/pipes/text-highlight.pipe.md) +* [Text mask component](core/components/text-mask.component.md) +* [Thumbnail service](core/services/thumbnail.service.md) +* [Time ago pipe](core/pipes/time-ago.pipe.md) +* [Toggle icon directive](content-services/directives/toggle-icon.directive.md) +* [Toolbar divider component](core/components/toolbar-divider.component.md) +* [Toolbar title component](core/components/toolbar-title.component.md) +* [Toolbar component](core/components/toolbar.component.md) +* [Translation service](core/services/translation.service.md) +* [Upload button component](content-services/components/upload-button.component.md) +* [Upload drag area component](content-services/components/upload-drag-area.component.md) +* [Upload directive](core/directives/upload.directive.md) +* [Upload service](core/services/upload.service.md) +* [User info component](core/components/user-info.component.md) +* [User initial pipe](core/pipes/user-initial.pipe.md) +* [User preferences service](core/services/user-preferences.service.md) +* [User process model](core/models/user-process.model.md) +* [Version list component](content-services/components/version-list.component.md) +* [Version manager component](content-services/components/version-manager.component.md) +* [Viewer component](core/components/viewer.component.md) +* [Webscript component](content-services/components/webscript.component.md) +* [Widget component](insights/components/widget.component.md) diff --git a/lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts b/lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts index c850f24284..d3161306d5 100644 --- a/lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts +++ b/lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts @@ -217,6 +217,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit, OnDestroy { @Output() currentFolder: EventEmitter = new EventEmitter(); + /** Emitted when folder loaded. */ @Output() folderLoaded: EventEmitter = new EventEmitter(); diff --git a/lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts b/lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts index 167d7caa66..43faaf6aae 100644 --- a/lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts +++ b/lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts @@ -41,6 +41,7 @@ export interface SelectedBucket { }) export class SearchFilterComponent implements OnInit, OnDestroy { + /** Toggles whether to show or not the context facet filters. */ @Input() showContextFacets: boolean = true; diff --git a/lib/content-services/src/lib/version-manager/version-upload.component.html b/lib/content-services/src/lib/version-manager/version-upload.component.html index b673218464..309430b28e 100644 --- a/lib/content-services/src/lib/version-manager/version-upload.component.html +++ b/lib/content-services/src/lib/version-manager/version-upload.component.html @@ -28,8 +28,8 @@ [versioning]="true" [file]="newFileVersion" [majorVersion]="isMajorVersion()" - (success)="success.emit($event)" - (error)="error.emit($event)"> + (success)="onSuccess($event)" + (error)="onError($event)">