diff --git a/docs/README.md b/docs/README.md
index d5991cf2f7..a16605e67b 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**  - The component is still available
+- **Deprecated**  - The component is still available
but is now obsolete and will probably be removed in a future version of ADF.
-* **Experimental**  - The component is available for
+- **Experimental**  - The component is available for
experimentation but not fully complete and tested for production code.
-* **Internal**  - The component is available for
+- **Internal**  - 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
<!--guide start-->
-* [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)
<!--guide end-->
@@ -81,7 +81,7 @@ 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)  | 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)  | 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)  | 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) |
@@ -108,8 +108,8 @@ for more information about installing and using the source code.
| [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)  | 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) |
+| [Notification History component](core/components/notification-history.component.md)  | 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) |
@@ -126,11 +126,12 @@ The main purpose of the Notification history component is list all the notificat
### 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) |
+| [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) |
+| [Infinite Select Scroll directive](core/directives/infinite-select-scroll.directive.md) | Load more options to select component if API returns more items | [Source](../lib/core/directives/infinite-select-scroll.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) |
@@ -138,18 +139,17 @@ The main purpose of the Notification history component is list all the notificat
| [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) |
-| [Infinite Select Scroll](core/directives/infinite-select-scroll.directive.md) | Load more options to select component if API returns more items. | [Source](../lib/core/directives/infinite-select-scroll.directive.ts) |
### Dialogs
| 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) |
@@ -158,7 +158,7 @@ The main purpose of the Notification history component is list all the notificat
### 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) |
@@ -168,7 +168,7 @@ The main purpose of the Notification history component is list all the notificat
### 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) |
@@ -176,7 +176,7 @@ The main purpose of the Notification history component is list all the notificat
| [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) |
+| [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) |
@@ -185,7 +185,7 @@ The main purpose of the Notification history component is list all the notificat
### 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) |
@@ -238,7 +238,7 @@ The main purpose of the Notification history component is list all the notificat
### Widgets
| 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) |
<!--core end-->
@@ -257,15 +257,19 @@ 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) |
+| [Aspect List Dialog component](content-services/components/aspect-list-dialog.component.md) | Allows a user to choose aspects for a node. | [Source](../lib/content-services/src/lib/aspect-list/aspect-list-dialog.component.ts) |
+| [Aspect List component](content-services/components/aspect-list.component.md) | This component will show in an expandable row list with checkboxes all the aspect of a node, if a node id is given, or otherwise a complete list. | |
+| The aspect are filtered via the app.config.json in this way : | [Source](../lib/content-services/src/lib/aspect-list/aspect-list.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) |
+| [Content Type Dialog component](content-services/components/content-type-dialog.component.md) | Confirm dialog when user changes content type of a node. | [Source](../lib/content-services/src/lib/content-type/content-type-dialog.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) |
@@ -301,7 +305,7 @@ for more information about installing and using the source code.
### 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) |
@@ -313,20 +317,20 @@ for more information about installing and using the source code.
### 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) |
| [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 |
-| --- | --- | --|
+| ---- | ----------- | ----------- |
| [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) |
| [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) |
@@ -334,13 +338,13 @@ for more information about installing and using the source code.
### Pipes
| 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) |
@@ -370,7 +374,7 @@ 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) |
@@ -402,7 +406,7 @@ for more information about installing and using the source code.
### Directives
| Name | Description | Source link |
-| --- | --- | --|
+| ---- | ----------- | ----------- |
| [Claim Task Directive](process-services/directives/claim-task.directive.md)  | 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) |
@@ -411,13 +415,13 @@ for more information about installing and using the source code.
### Pipes
| 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 |
-| --- | --- | --|
+| ---- | ----------- | ----------- |
| [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) |
@@ -439,7 +443,7 @@ 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)  | 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)  | 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)  | Edits task filter details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter-cloud.component.ts) |
@@ -447,9 +451,10 @@ for more information about installing and using the source code.
| [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)  | 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
+| [](process-services-cloud/components/people-cloud.component.md) | Title: People Cloud Component | |
+
Added: v3.0.0
-Status: Experimental | [Source]() |
+Status: Experimental | [Source](<>) |
| [Process Filters Cloud Component](process-services-cloud/components/process-filters-cloud.component.md)  | 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)  | 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)  | 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) |
@@ -463,7 +468,7 @@ Status: Experimental | [Source]() |
### Directives
| Name | Description | Source link |
-| --- | --- | --|
+| ---- | ----------- | ----------- |
| [Cancel Process Directive](process-services-cloud/directives/cancel-process.directive.md)  | 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)  | 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)  | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) |
@@ -472,14 +477,14 @@ Status: Experimental | [Source]() |
### 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) |
| [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)  | 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)  | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) |
@@ -510,14 +515,14 @@ for more information about installing and using the source code.
### Components
| Name | Description | Source link |
-| --- | --- | --|
+| ---- | ----------- | ----------- |
| [Dynamic Component](extensions/components/dynamic.component.md)  | 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)  | Supports dynamically-loaded viewer preview extensions. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) |
### Services
| Name | Description | Source link |
-| --- | --- | --|
+| ---- | ----------- | ----------- |
| [Extension Service](extensions/services/extension.service.md)  | Manages and runs basic extension functionality. | [Source](../lib/extensions/src/lib/services/extension.service.ts) |
<!--extensions end-->
@@ -536,7 +541,7 @@ 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) |
diff --git a/docs/content-services/components/add-permission-panel.component.md b/docs/content-services/components/add-permission-panel.component.md
index f9bf4ffd13..e9d6e667ca 100644
--- a/docs/content-services/components/add-permission-panel.component.md
+++ b/docs/content-services/components/add-permission-panel.component.md
@@ -26,7 +26,7 @@ Searches for people or groups to add to the current node permissions.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 1c6c910f1c..2400683c8b 100644
--- a/docs/content-services/components/add-permission.component.md
+++ b/docs/content-services/components/add-permission.component.md
@@ -26,15 +26,15 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | 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/aspect-list.component.md b/docs/content-services/components/aspect-list.component.md
index 127de32b12..46bb3abff2 100644
--- a/docs/content-services/components/aspect-list.component.md
+++ b/docs/content-services/components/aspect-list.component.md
@@ -28,17 +28,17 @@ The aspect are filtered via the app.config.json in this way :
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
-| nodeId | `string` | | Identifier of a node to apply likes to. |
+| ---- | ---- | ------------- | ----------- |
+| nodeId | `string` | "" | Node Id of the node that we want to update |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| valueChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted every time the user select a new aspect. |
+| ---- | ---- | ----------- |
+| valueChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string[]>` | Emitted every time the user select a new aspect |
## See also
-* [Aspect List Dialog component](rating.component.md)
-* [Aspect List service](../services/rating.service.md)
-* [Node Aspect service](../services/rating.service.md)
+- [Aspect List Dialog component](rating.component.md)
+- [Aspect List service](../services/rating.service.md)
+- [Node Aspect service](../services/rating.service.md)
diff --git a/docs/content-services/components/breadcrumb.component.md b/docs/content-services/components/breadcrumb.component.md
index b9d504de96..dc26e2e3e6 100644
--- a/docs/content-services/components/breadcrumb.component.md
+++ b/docs/content-services/components/breadcrumb.component.md
@@ -24,20 +24,20 @@ 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. |
+| ---- | ---- | ------------- | ----------- |
+| folderNode | `Node` | 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. |
+| readOnly | `boolean` | false | If true, prevents the user from navigating away from the active node. |
| 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. |
-| readOnly | `boolean` | false | Prevents changing the active node |
### Events
| 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. |
+| ---- | ---- | ----------- |
+| navigate | `any` | Emitted when the user clicks on a breadcrumb. |
## Details
@@ -97,5 +97,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 c327688015..be90cf2a67 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
@@ -83,7 +83,7 @@ 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". |
@@ -96,11 +96,11 @@ export class MyView {
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the action. Applies to copy and move actions. |
-| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user selects the action from the menu. |
-| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission error occurs |
-| success | `EventEmitter<any>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
+| ---- | ---- | ----------- |
+| error | `any` | Emitted when an error occurs during the action. Applies to copy and move actions. |
+| execute | `any` | Emitted when the user selects the action from the menu. |
+| permissionEvent | `any` | Emitted when a permission error occurs |
+| success | `any` | 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,
@@ -322,8 +322,8 @@ allow the item being copied/moved to be the destination if it is itself a folder
The `<content-action>` component allows you to control visibility with the help of the `visible` property and supports 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
@@ -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
@@ -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
## 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 2300b8ea3e..1e3c29de2c 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
@@ -43,11 +43,11 @@ 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 |
+| node | `Node` | | (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. |
@@ -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`:
@@ -254,20 +254,20 @@ The result of this config would be two accordion groups with the following prope
| GROUP-TITLE1-TRANSLATION-KEY |
| ---------------------------- |
-| exif:param1 |
-| exif:param2 |
-| ... |
-| exif:paramN |
-| kitten:custom1 |
-| kitten:custom3 |
-| owner:name |
-| kitten:name |
-| kitten:color |
+| exif:param1 |
+| exif:param2 |
+| ... |
+| exif:paramN |
+| kitten:custom1 |
+| kitten:custom3 |
+| owner:name |
+| kitten:name |
+| kitten:color |
| GROUP-TITLE2-TRANSLATION-KEY |
| ---------------------------- |
-| kitten:favourite-food |
-| kitten:recommended-food |
+| kitten:favourite-food |
+| kitten:recommended-food |
#### Making properties editable
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 5d1f8795be..c3ce9a4049 100644
--- a/docs/content-services/components/content-node-selector-panel.component.md
+++ b/docs/content-services/components/content-node-selector-panel.component.md
@@ -29,9 +29,9 @@ 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. |
+| currentFolderId | `string` | null | Node 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. |
@@ -39,7 +39,7 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
| 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. |
+| 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 |
@@ -49,17 +49,17 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
### Events
| 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. |
+| ---- | ---- | ----------- |
+| currentFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when current folder loaded. |
| folderLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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<Node[]>` | Emitted when the user has chosen an item. |
-| showingSearch | `EventEmitter<boolean>` | Emitted when search is running. |
-| siteChange | `EventEmitter<string>` | Emitted when the select site changes. |
+| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node[]>` | Emitted when the user has chosen an item. |
+| showingSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when search is running. |
+| siteChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | 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
@@ -75,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/content-type-dialog.component.md b/docs/content-services/components/content-type-dialog.component.md
index 30f2547289..050c64508f 100644
--- a/docs/content-services/components/content-type-dialog.component.md
+++ b/docs/content-services/components/content-type-dialog.component.md
@@ -43,7 +43,7 @@ The properties are described in the table below:
| nodeType | `string` | "" | current prefixed name of the content type selected |
If you don't want to manage the dialog yourself then it is easier to use the
-methods of the Content Type Property Service, which create
+methods of the Content Type [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) Service, which create
the dialog for you.
### Usage example
diff --git a/docs/content-services/components/document-list.component.md b/docs/content-services/components/document-list.component.md
index 5a1af65394..688dc15236 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
@@ -56,7 +56,7 @@ 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 |
@@ -74,33 +74,33 @@ Displays the documents from a repository.
| 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. |
+| navigationMode | `string` | | User 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 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. |
+| showHeader | `string` | | 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 | `"server" \| "client"` | "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. |
+| 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`](../../../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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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<NodeEntityEvent>` | Emitted when the user double-clicks a list node |
-| nodeSelected | `EventEmitter<NodeEntry[]>` | Emitted when the node selection change |
-| preview | `EventEmitter<NodeEntityEvent>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the Viewer component. |
-| ready | `EventEmitter<NodePaging>` | Emitted when the Document List has loaded all items and is ready for use |
+| 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 |
## Details
@@ -115,14 +115,14 @@ The Document list will automatically show special icons for : `Smart Folder`, `L
### 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 |
-| ------------- | ---------------------------------------- |
-| node-click | Emitted when user clicks the node |
+| Name | Description |
+| ---- | ----------- |
+| node-click | Emitted when user clicks the node |
| node-dblclick | Emitted when user double-clicks the node |
-| node-select | Emitted when user selects a node |
-| node-unselect | Emitted when user unselects a node |
+| node-select | Emitted when user selects a node |
+| node-unselect | Emitted when user unselects a node |
Every event is represented by a [CustomEvent](https://developer.mozilla.org/en/docs/Web/API/CustomEvent) instance. Each event will
have at least the following properties as part of the `Event.detail` property value:
@@ -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,9 +345,9 @@ Default layout:
Default layout:
-* Icon
-* Name
-* Location
+- Icon
+- Name
+- Location
### Setting default folder
@@ -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.
@@ -567,13 +567,13 @@ You can also add tooltips, styling, automatic column title translation and other
You can use the following components as column templates:
-| Name | Description |
-| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `adf-name-column` | Renders the hyperlink-styled name of the node. Provides a formatted tooltip. Emits the `name-click` DOM event, which can be handled by any parent component. |
-| `adf-library-name-column` | Renders the library name. Provides formatted tooltips and extra details for libraries with the same names on the page. Emits the `name-click` DOM event, which can be handled by any parent component. |
-| `adf-library-role-column` | Renders i18n-enabled information about the Library (Site) role (`Manager`, `Collaborator`, `Contributor`, `Consumer`) |
-| `adf-library-status-column` | Renders i18n-enabled information about the Library (Site) status (`Public`, `Private`, `Moderated`, `Unknown`) |
-| `adf-trashcan-name-column` | Renders the name of the deleted node. Distinguishes between a Library (Site) and File/Folder nodes. Provides proper tooltips. |
+| Name | Description |
+| ---- | ----------- |
+| `adf-name-column` | Renders the hyperlink-styled name of the node. Provides a formatted tooltip. Emits the `name-click` DOM event, which can be handled by any parent component. |
+| `adf-library-name-column` | Renders the library name. Provides formatted tooltips and extra details for libraries with the same names on the page. Emits the `name-click` DOM event, which can be handled by any parent component. |
+| `adf-library-role-column` | Renders i18n-enabled information about the Library (Site) role (`Manager`, `Collaborator`, `Contributor`, `Consumer`) |
+| `adf-library-status-column` | Renders i18n-enabled information about the Library (Site) status (`Public`, `Private`, `Moderated`, `Unknown`) |
+| `adf-trashcan-name-column` | Renders the name of the deleted node. Distinguishes between a Library (Site) and File/Folder nodes. Provides proper tooltips. |
All the components above require only the `context` property to be bound, since
each component fetches and renders the information it needs from the underlying node.
@@ -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.
@@ -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 93011a5057..7b60579362 100644
--- a/docs/content-services/components/dropdown-breadcrumb.component.md
+++ b/docs/content-services/components/dropdown-breadcrumb.component.md
@@ -25,28 +25,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. |
+| ---- | ---- | ------------- | ----------- |
+| folderNode | `Node` | 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. |
+| readOnly | `boolean` | false | If true, prevents the user from navigating away from the active node. |
| 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. |
-| readOnly | `boolean` | false | Prevents changing the active node |
### Events
| 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. |
+| ---- | ---- | ----------- |
+| navigate | `any` | 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
+"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 8bd600a8ef..813958041e 100644
--- a/docs/content-services/components/file-uploading-dialog.component.md
+++ b/docs/content-services/components/file-uploading-dialog.component.md
@@ -20,14 +20,14 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
+| alwaysVisible | `boolean` | false | Makes the dialog always visible even when there are no uploads. |
| position | `string` | "right" | Dialog position. Can be 'left' or 'right'. |
-| alwaysVisible | `boolean` | false | Dialog visibility. When true it makes the dialog visible even when there are no uploads. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file in the list has an error. |
## Details
@@ -38,6 +38,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 9af0dcf856..6ce30eb8ce 100644
--- a/docs/content-services/components/like.component.md
+++ b/docs/content-services/components/like.component.md
@@ -22,16 +22,16 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. |
+| ---- | ---- | ----------- |
+| changeVote | `any` | 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 c9decfa7c5..434de777c7 100644
--- a/docs/content-services/components/permission-list.component.md
+++ b/docs/content-services/components/permission-list.component.md
@@ -36,13 +36,13 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`>` | Emitted when the permission is updated. |
diff --git a/docs/content-services/components/rating.component.md b/docs/content-services/components/rating.component.md
index 61fd386be6..19a7e0ccb9 100644
--- a/docs/content-services/components/rating.component.md
+++ b/docs/content-services/components/rating.component.md
@@ -33,16 +33,16 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. |
+| ---- | ---- | ----------- |
+| changeVote | `any` | 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 f7ce9435a5..8adc4813ac 100644
--- a/docs/content-services/components/search-chip-list.component.md
+++ b/docs/content-services/components/search-chip-list.component.md
@@ -23,6 +23,6 @@ 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. |
diff --git a/docs/content-services/components/search-control.component.md b/docs/content-services/components/search-control.component.md
index b1ae2e9c1f..987199399c 100644
--- a/docs/content-services/components/search-control.component.md
+++ b/docs/content-services/components/search-control.component.md
@@ -41,7 +41,7 @@ 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. |
@@ -52,10 +52,10 @@ You can show your own custom template when no results are found for the search:
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file item from the list of "find-as-you-type" results is selected. |
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | 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<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |
+| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 b1b18839b5..568e9d6646 100644
--- a/docs/content-services/components/search-filter.component.md
+++ b/docs/content-services/components/search-filter.component.md
@@ -11,18 +11,18 @@ Represents a main container component for custom search and faceted search setti
## Contents
-* [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](#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
@@ -45,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
@@ -173,8 +173,8 @@ Note that the entries of the `filterQueries` array are joined using the `AND` op
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
{
@@ -195,13 +195,13 @@ The Sorting configuration section consists of two blocks:
The properties of the `options` objects are as follows:
-| Name | Type | Description |
-| --------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
-| key | string | Unique key to identify the entry. This can also be used to map [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) instances. |
-| label | string | Display text, which can also be an [i18n resource key](../../user-guide/internationalization.md). |
-| type | string | This specifies how to order the results. It can be based on a field, based on the position of the document in the index, or by score/relevance. |
-| field | string | The name of the field. |
-| ascending | boolean | The sorting order defined as `true` for ascending order and `false` for descending order |
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| key | string | Unique key to identify the entry. This can also be used to map [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) instances. |
+| label | string | Display text, which can also be an [i18n resource key](../../user-guide/internationalization.md). |
+| type | string | This specifies how to order the results. It can be based on a field, based on the position of the document in the index, or by score/relevance. |
+| field | string | The name of the field. |
+| ascending | boolean | The sorting order defined as `true` for ascending order and `false` for descending order |
See the [Sort](https://docs.alfresco.com/5.2/concepts/search-api-sort.html)
element in the [ACS Search API](https://docs.alfresco.com/5.2/concepts/search-api.html)
@@ -240,14 +240,14 @@ The Search Filter supports a number of widgets out of the box, each implemented
by an ADF component. The `selector` property specifies which [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) is used for
a category:
-| [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) name | Selector | Description |
-| ------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------ |
-| [Check List](search-check-list.component.md) | `check-list` | Toggles individual query fragments for the search |
-| [Date Range](search-date-range.component.md) | `date-range` | Specifies a range f dates that a field may contain |
-| [Number Range](search-number-range.component.md) | `number-range` | Specifies a range of numeric values that a field may contain |
-| [Radio List](search-radio.component.md) | `radio` | Selects one query fragment from a list of options |
-| [Slider](search-slider.component.md) | `slider` | Selects a single numeric value in a given range that a field may contain |
-| [Text](search-text.component.md) | `text` | Specifies a text value that a field may contain |
+| [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) name | Selector | Description |
+| ------------------------------------------------------------------------------- | -------- | ----------- |
+| [Check List](search-check-list.component.md) | `check-list` | Toggles individual query fragments for the search |
+| [Date Range](search-date-range.component.md) | `date-range` | Specifies a range f dates that a field may contain |
+| [Number Range](search-number-range.component.md) | `number-range` | Specifies a range of numeric values that a field may contain |
+| [Radio List](search-radio.component.md) | `radio` | Selects one query fragment from a list of options |
+| [Slider](search-slider.component.md) | `slider` | Selects a single numeric value in a given range that a field may contain |
+| [Text](search-text.component.md) | `text` | Specifies a text value that a field may contain |
See the individual [Search Widget](../interfaces/search-widget.interface.md) pages for full details of their usage and settings.
@@ -298,15 +298,15 @@ the next block of results.
#### FacetField Properties
-| Name | Type | Default | Description |
-| -------- | ------ | ------- | -------------------------------------------------------------------------------------------------------------- |
-| field | string | | Specifies the facet field. |
-| mincount | number | 1 | Specifies the minimum count required for a facet field to be included in the response. The default value is 1. |
-| label | string | | Specifies the label to include in place of the facet field. |
-| prefix | string | | Restricts the possible constraints to only indexed values with a specified prefix. |
-| limit | number | | Maximum number of results |
-| pageSize | number | 5 | Display page size |
-| offset | number | | Offset position |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| field | string | | Specifies the facet field. |
+| mincount | number | 1 | Specifies the minimum count required for a facet field to be included in the response. The default value is 1. |
+| label | string | | Specifies the label to include in place of the facet field. |
+| prefix | string | | Restricts the possible constraints to only indexed values with a specified prefix. |
+| limit | number | | Maximum number of results |
+| pageSize | number | 5 | Display page size |
+| offset | number | | Offset position |
### Facet Queries
@@ -385,10 +385,10 @@ use overlapping ranges if necessary.
#### FacetIntervals Properties
-| Name | Type | Description |
-| --------- | ------- | ---------------------------------------------- |
-| intervals | array | Specifies the fields to facet by interval. |
-| expanded | boolean | Toggles expanded state of the facet intervals. |
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| intervals | array | Specifies the fields to facet by interval. |
+| expanded | boolean | Toggles expanded state of the facet intervals. |
Note: the `sets` parameter from the Search API (which sets the intervals for all fields)
is not yet supported.
@@ -489,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 78a7a23c28..40eeb978b9 100644
--- a/docs/content-services/components/search.component.md
+++ b/docs/content-services/components/search.component.md
@@ -11,15 +11,15 @@ 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
@@ -35,7 +35,7 @@ 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. |
@@ -45,7 +45,7 @@ Searches items for supplied search terms.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when search results have fully loaded. |
@@ -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 2826306a19..1c558b8c7e 100644
--- a/docs/content-services/components/sites-dropdown.component.md
+++ b/docs/content-services/components/sites-dropdown.component.md
@@ -24,7 +24,7 @@ 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. |
@@ -34,5 +34,5 @@ Displays a dropdown menu to show and interact with the sites of the current user
### Events
| 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 e345dd139e..4425f234a5 100644
--- a/docs/content-services/components/tag-actions.component.md
+++ b/docs/content-services/components/tag-actions.component.md
@@ -24,13 +24,13 @@ Shows available actions for tags.
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
| nodeId | `string` | | The identifier of a node. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an action is chosen. |
-| successAdd | `EventEmitter<any>` | Emitted when a tag is added successfully. |
+| result | `any` | Emitted when an action is chosen. |
+| successAdd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 01d389692c..54e7b04841 100644
--- a/docs/content-services/components/tag-list.component.md
+++ b/docs/content-services/components/tag-list.component.md
@@ -16,9 +16,9 @@ Shows tags for an item.
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. |
+| ---- | ---- | ----------- |
+| result | `any` | 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 dfb6501558..f9562caa5e 100644
--- a/docs/content-services/components/tag-node-list.component.md
+++ b/docs/content-services/components/tag-node-list.component.md
@@ -24,12 +24,12 @@ Shows tags for a node.
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
| nodeId | `string` | | The identifier of a node. |
| showDelete | `boolean` | true | Show delete button |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. |
+| ---- | ---- | ----------- |
+| results | `any` | 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 8d1965866a..c9bf0f7fd4 100644
--- a/docs/content-services/components/tree-view.component.md
+++ b/docs/content-services/components/tree-view.component.md
@@ -24,12 +24,12 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 38b56c7b72..53d5e07388 100644
--- a/docs/content-services/components/upload-button.component.md
+++ b/docs/content-services/components/upload-button.component.md
@@ -28,7 +28,7 @@ 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). |
@@ -46,12 +46,12 @@ Activates a file upload.
### 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)`<any>` | Emitted when an error occurs. |
+| ---- | ---- | ----------- |
+| beginUpload | `any` | Emitted when the upload begins. |
+| error | `any` | 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<any>` | Emitted when the file is uploaded successfully. |
-| updateFileVersion | `EventEmitter<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
+| success | `any` | Emitted when the file is uploaded successfully. |
+| updateFileVersion | `any` | Emitted when dropping a file over another file to update the version. |
## Details
@@ -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 fc667c4c1c..8f29591352 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
@@ -60,7 +60,7 @@ 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). |
@@ -73,11 +73,11 @@ as the drag/drop target:
### 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)`<any>` | Emitted when an error occurs. |
-| success | `EventEmitter<any>` | Emitted when the file is uploaded successfully. |
-| updateFileVersion | `EventEmitter<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
+| ---- | ---- | ----------- |
+| beginUpload | `any` | Emitted when the upload begins. |
+| error | `any` | Emitted when an error occurs. |
+| success | `any` | Emitted when the file is uploaded successfully. |
+| updateFileVersion | `any` | Emitted when dropping a file over another file to update the version. |
## Details
@@ -87,9 +87,9 @@ 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 1773b26b7b..5cc2127bd2 100644
--- a/docs/content-services/components/upload-version-button.component.md
+++ b/docs/content-services/components/upload-version-button.component.md
@@ -30,7 +30,7 @@ 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). |
@@ -38,7 +38,7 @@ to enrich the features and decrease the restrictions currently applied to node v
| 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. |
+| node | `Node` | | (**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. |
@@ -49,20 +49,20 @@ to enrich the features and decrease the restrictions currently applied to node v
### 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)`<any>` | Emitted when an error occurs. |
+| ---- | ---- | ----------- |
+| beginUpload | `any` | Emitted when the upload begins. |
+| error | `any` | 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<any>` | Emitted when the file is uploaded successfully. |
-| updateFileVersion | `EventEmitter<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
+| success | `any` | Emitted when the file is uploaded successfully. |
+| updateFileVersion | `any` | 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 3b48157b60..8c870c8a46 100644
--- a/docs/content-services/components/version-comparison.component.md
+++ b/docs/content-services/components/version-comparison.component.md
@@ -25,6 +25,6 @@ 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. |
+| node | `Node` | | Target node. |
diff --git a/docs/content-services/components/version-list.component.md b/docs/content-services/components/version-list.component.md
index 8a687a45cc..ff35792d5e 100644
--- a/docs/content-services/components/version-list.component.md
+++ b/docs/content-services/components/version-list.component.md
@@ -20,20 +20,20 @@ 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. |
+| node | `Node` | | 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<string>` | Emitted when viewing a version |
+| ---- | ---- | ----------- |
+| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when a version is deleted |
+| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when a version is restored |
+| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | 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 d10c29bf99..1117f926d4 100644
--- a/docs/content-services/components/version-manager.component.md
+++ b/docs/content-services/components/version-manager.component.md
@@ -28,21 +28,21 @@ 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. |
+| node | `Node` | | 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)`<boolean>` | 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<Node>` | Emitted when a file is uploaded successfully. |
-| viewVersion | `EventEmitter<string>` | Emitted when viewing a version. |
+| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when an error occurs during upload. |
+| uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when a file is uploaded successfully. |
+| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when viewing a version. |
## Details
@@ -50,11 +50,11 @@ Displays the version history of a node with the ability to upload a new version.
Each version has a context menu on the right, with the following actions.
-| Action | Versions | Description |
-| ------- | -------- | --------------------------------------------------------------------------------- |
-| Restore | All | Revert the current version to the selected one with creating a new version of it. |
+| Action | Versions | Description |
+| ------ | -------- | ----------- |
+| Restore | All | Revert the current version to the selected one with creating a new version of it. |
## 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 1c0228eea2..48f50081c0 100644
--- a/docs/content-services/components/version-upload.component.md
+++ b/docs/content-services/components/version-upload.component.md
@@ -20,21 +20,21 @@ Displays the new version's minor/major changes and the optional comment of a nod
### 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) | | The target node. |
+| node | `Node` | | The target node. |
| showCancelButton | `boolean` | true | Toggles showing/hiding of cancel button. |
| showUploadButton | `boolean` | true | Toggles showing/hiding upload button. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an cancelling during upload. |
-| commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the comment is changed. |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
-| versionChanged | `EventEmitter<boolean>` | Emitted when the version is changed. |
+| ---- | ---- | ----------- |
+| cancel | `any` | Emitted when an cancelling during upload. |
+| commentChanged | `any` | Emitted when the comment is changed. |
+| error | `any` | Emitted when an error occurs. |
+| success | `any` | Emitted when the file is uploaded successfully. |
+| versionChanged | `any` | 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 8ae95eefd2..eae8175dd1 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
@@ -63,7 +63,7 @@ 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. |
@@ -74,8 +74,8 @@ export class AppComponent {
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
+| ---- | ---- | ----------- |
+| success | `any` | 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
diff --git a/docs/content-services/dialogs/library.dialog.md b/docs/content-services/dialogs/library.dialog.md
index 92d2249304..03e2dea6a1 100644
--- a/docs/content-services/dialogs/library.dialog.md
+++ b/docs/content-services/dialogs/library.dialog.md
@@ -26,9 +26,9 @@ Creates a new Content Services document library/site.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the new library is created successfully. The event parameter is a SiteEntry object with the details of the newly-created library. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
## 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 19e85eb342..859d7ea8bb 100644
--- a/docs/content-services/directives/content-node-share.directive.md
+++ b/docs/content-services/directives/content-node-share.directive.md
@@ -34,9 +34,9 @@ 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. |
+| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | Node to share. |
## Details
diff --git a/docs/content-services/directives/file-draggable.directive.md b/docs/content-services/directives/file-draggable.directive.md
index 5aeb456e28..458adbdf9a 100644
--- a/docs/content-services/directives/file-draggable.directive.md
+++ b/docs/content-services/directives/file-draggable.directive.md
@@ -39,15 +39,15 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<File[]>` | Emitted when one or more files are dragged and dropped onto the draggable element. |
-| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a directory is dragged and dropped onto the draggable element. |
+| ---- | ---- | ----------- |
+| filesDropped | `any` | Emitted when one or more files are dragged and dropped onto the draggable element. |
+| folderEntityDropped | `any` | 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 32b9f83cbf..ba933d5f40 100644
--- a/docs/content-services/directives/folder-create.directive.md
+++ b/docs/content-services/directives/folder-create.directive.md
@@ -31,7 +31,7 @@ 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. |
@@ -39,9 +39,9 @@ Creates folders.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | 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 a9cd584e9f..e796a6a43d 100644
--- a/docs/content-services/directives/folder-edit.directive.md
+++ b/docs/content-services/directives/folder-edit.directive.md
@@ -31,16 +31,16 @@ 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. |
+| ---- | ---- | ------------- | ----------- |
+| folder | `Node` | | Folder node to edit. |
| title | `string` | null | Title of folder edit dialog. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | 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 02aa7c524f..f836e4ef4c 100644
--- a/docs/content-services/directives/inherited-button.directive.md
+++ b/docs/content-services/directives/inherited-button.directive.md
@@ -23,15 +23,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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
+| updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | 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 9419449915..bb1de2bbe0 100644
--- a/docs/content-services/directives/node-lock.directive.md
+++ b/docs/content-services/directives/node-lock.directive.md
@@ -22,8 +22,8 @@ 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. |
+| ---- | ---- | ------------- | ----------- |
+| node | `Node` | | Node 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 4fb7a1701b..ca5ee0c57d 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
@@ -32,11 +32,11 @@ export interface SearchWidget {
### Properties
-| Name | Type | Default value | Description |
-| -------- | ---------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------- |
-| id | `string` | | Unique identifying value for the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) |
-| settings | [`SearchWidgetSettings`](../../../lib/content-services/src/lib/search/search-widget-settings.interface.ts) | | Settings for component properties |
-| context | [`SearchQueryBuilderService`](../../content-services/services/search-query-builder.service.md) | | Instance of the [Search Query Builder service](../services/search-query-builder.service.md) to process the query |
+| Name | Type | Default value | Description |
+| ---- | ---- | ------------- | ----------- |
+| id | `string` | | Unique identifying value for the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) |
+| settings | [`SearchWidgetSettings`](../../../lib/content-services/src/lib/search/search-widget-settings.interface.ts) | | Settings for component properties |
+| context | [`SearchQueryBuilderService`](../../content-services/services/search-query-builder.service.md) | | Instance of the [Search Query Builder service](../services/search-query-builder.service.md) to process the query |
## Details
@@ -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 727813c597..8995f2dc3e 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)`<any>`<br/>
+- **deleteAuditEntries**(auditApplicationId: `string`, where: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` -
-* **deleteAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _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)`<any>` -
+- **deleteAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` -
-* **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)`>`<br/>
+ - _auditApplicationId:_ `string` - The identifier of an audit application.
+ - _auditEntryId:_ `string` - The identifier of an audit entry.
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
+- **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)`>`<br/>
Get audit application info.
- * *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)`>`<br/>
+ - _auditApplicationId:_ `string` - The identifier of an audit application.
+ - _opts:_ `any` - (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)`>`<br/>
List audit applications.
- * *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)`>`<br/>
+ - _opts:_ `any` - (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)`>`<br/>
List audit entries for an audit application.
- * *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)`>`<br/>
+ - _auditApplicationId:_ `string` - The identifier of an audit application.
+ - _opts:_ `any` - (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)`>`<br/>
List audit entries for a node.
- * *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)`>`<br/>
+ - _nodeId:_ `string` - The identifier of a node.
+ - _opts:_ `any` - (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)`>`<br/>
Get audit entry.
- * *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>`<br/>
+ - _auditApplicationId:_ `string` - The identifier of an audit application.
+ - _auditEntryId:_ `string` - The identifier of an audit entry.
+ - _opts:_ `any` - (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)`|__type>`<br/>
Update audit application info.
- * *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>` -
+ - _auditApplicationId:_ `string` - The identifier of an audit application.
+ - _auditAppBodyUpdate:_ `boolean` - The audit application to update.
+ - _opts:_ `any` - (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)`|__type>` -
diff --git a/docs/content-services/services/content-node-dialog.service.md b/docs/content-services/services/content-node-dialog.service.md
index 9ec3a35b26..267dbe6390 100644
--- a/docs/content-services/services/content-node-dialog.service.md
+++ b/docs/content-services/services/content-node-dialog.service.md
@@ -13,52 +13,52 @@ Displays and manages dialogs for selecting content to open, copy or upload.
### Methods
-* **close**()<br/>
+- **close**()<br/>
Closes the currently open dialog.
-* **getTitleTranslation**(action: `string`, name: `string`): `string`<br/>
+- **getTitleTranslation**(action: `string`, name: `string`): `string`<br/>
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)`[]>`<br/>
+ - _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`, permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
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)`[]>`<br/>
+ - _action:_ `string` - Name of the action (eg, "Copy" or "Move") to show in the title
+ - _contentEntry:_ `Node` - 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[]>` - Information about files that were copied/moved
+- **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
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)`[]>`<br/>
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected file(s)
+- **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
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)`[]>`<br/>
+ - _folderNodeId:_ `string` - ID of the folder to use
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected file(s)
+- **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
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)`[]>`<br/>
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected file(s)
+- **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
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)`[]>`<br/>
+ - _folderNodeId:_ `string` - ID of the folder to use
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected folder(s)
+- **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
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)`<string>`<br/>
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected folder(s)
+- **openLockNodeDialog**(contentEntry: `Node`): [`Subject`](http://reactivex.io/documentation/subject.html)`<string>`<br/>
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)`<string>` - 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)`[]>`<br/>
+ - _contentEntry:_ `Node` - Node to lock
+ - **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`<string>` - Error/status message (if any)
+- **openUploadFileDialog**(action: `string`, contentEntry: `Node`, showFilesInResult: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
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)`[]>`<br/>
+ - _action:_ `string` - Name of the action to show in the title
+ - _contentEntry:_ `Node` - Item to upload
+ - _showFilesInResult:_ `boolean` - Show files in dialog search result
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the chosen file(s)
+- **openUploadFolderDialog**(action: `string`, contentEntry: `Node`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
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` - Item to upload
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the chosen folder(s)
## Details
@@ -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 ccc2331703..60b63f2772 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)`<string[]>`<br/>
+- **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
Gets the contents of one of the well-known aliases in the form of node ID strings.
- * *nodeId:* `string` - ID of the target folder node
- * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - List of node IDs
-* **getIdFromEntry**(node: `any`, nodeId: `string`): `string`<br/>
+ - _nodeId:_ `string` - ID of the target folder node
+ - _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - List of node IDs
+- **getIdFromEntry**(node: `any`, nodeId: `string`): `string`<br/>
Chooses the correct ID for a node entry.
- * *node:* `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/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)`>`<br/>
+ - _node:_ `any` - Node 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)`>`<br/>
Gets files recently accessed by a user.
- * *personId:* `string` - ID of the user
- * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- * *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`<br/>
+ - _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`<br/>
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`<br/>
+ - _nodeId:_ `string` - Node to check
+ - **Returns** `boolean` - True if the alias has a corresponding node ID, false otherwise
+- **isCustomSource**(folderId: `string`): `boolean`<br/>
Is the folder ID one of the well-known aliases?
- * *folderId:* `string` - Folder ID name to check
- * **Returns** `boolean` - True if the ID is a well-known name, false otherwise
-* **isSupportedSource**(folderId: `string`): `boolean`<br/>
+ - _folderId:_ `string` - Folder ID name to check
+ - **Returns** `boolean` - True if the ID is a well-known name, false otherwise
+- **isSupportedSource**(folderId: `string`): `boolean`<br/>
Is the folder ID a "-my", "-root-", or "-shared-" alias?
- * *folderId:* `string` - Folder ID name to check
- * **Returns** `boolean` - True if the ID is one of the supported sources, false otherwise
-* **loadFavorites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, 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)`>`<br/>
+ - _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)`>`<br/>
Gets favorite files for the current user.
- * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- * *includeFields:* `string[]` - List of data field names to include in the results
- * *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`<br/>
+ - _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`<br/>
Gets a folder's contents.
- * *nodeId:* `string` - ID of the target folder node
- * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- * *includeFields:* `string[]` - List of data field names to include in the results
- * *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)`>`<br/>
+ - _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 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)`>`<br/>
Gets sites that the current user is a member of.
- * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- * *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)`>`<br/>
+ - _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)`>`<br/>
Gets shared links for the current user.
- * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- * *includeFields:* `string[]` - List of data field names to include in the results
- * *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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
Gets all items currently in the trash.
- * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results
- * *includeFields:* `string[]` - List of data field names to include in the results
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>` - List of deleted items
+ - _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 9b6725bb74..62d3966c40 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`<br/>
+- **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/>
Checks if actions can be executed for an item.
- * *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)<br/>
+ - _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)<br/>
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`<br/>
+ - _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`<br/>
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 299778c8f2..00dd669257 100644
--- a/docs/content-services/services/document-list.service.md
+++ b/docs/content-services/services/document-list.service.md
@@ -13,48 +13,49 @@ 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)`>`<br/>
+- **copyNode**(nodeId: `string`, targetParentId: `string`): `any`<br/>
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)`<any>`<br/>
+ - _nodeId:_ `string` - The id of the node to be copied
+ - _targetParentId:_ `string` - The id of the folder where the node will be copied
+ - **Returns** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the copied node
+- **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Deletes a node.
- * *nodeId:* `string` - ID of the node to delete
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
+ - _nodeId:_ `string` - ID of the node to delete
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
Gets the folder node with the specified relative name path below the root node.
- * *folder:* `string` - Path to folder.
- * *opts:* `any` - (Optional) Options.
- * *includeFields:* `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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`<br/>
+ - _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`<br/>
- * *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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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`): `any`<br/>
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** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the moved node
## Details
@@ -94,4 +95,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 7ed9209f45..53d099c579 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`<br/>
+- **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/>
Checks if an action is available for a particular item.
- * *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)<br/>
+ - _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)<br/>
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`<br/>
+ - _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`<br/>
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 0aaf7e5a87..728af29589 100644
--- a/docs/content-services/services/node-permission-dialog.service.md
+++ b/docs/content-services/services/node-permission-dialog.service.md
@@ -13,18 +13,18 @@ Displays dialogs to let the user set node permissions.
### Methods
-* **close**()<br/>
+- **close**()<br/>
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)`[]>`<br/>
+- **openAddPermissionDialog**(node: `Node`, 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)`[]>`<br/>
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)`>`<br/>
+ - _node:_ `Node` - 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>`<br/>
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>` - Node with updated permissions
## Details
@@ -33,5 +33,5 @@ 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 76b47f1e73..5d0a9c4703 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)`>`<br/>
+- **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)`>`<br/>
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)`<string[]>`<br/>
+ - _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`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
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)`<string[]>` - 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)`>`<br/>
+ - _node:_ `Node` - The target node
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Array of strings representing the roles
+- **removePermission**(node: `Node`, 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>`<br/>
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)`>`<br/>
+ - _node:_ `Node` - 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>` - Node with modified permissions
+- **updateLocallySetPermissions**(node: `Node`, 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>`<br/>
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)`>`<br/>
+ - _node:_ `Node` - 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>` - 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>`<br/>
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)`>`<br/>
+ - _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>` - Node with updated permissions
+- **updatePermissionRole**(node: `Node`, 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>`<br/>
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` - 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>` - 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 ed7d32f339..6bd48bcafb 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)`<any>`<br/>
+- **deleteRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Removes the current user's rating for a node.
- * *nodeId:* `string` - Target node
- * *ratingType:* `any` - Type of rating to remove (can be "likes" or "fiveStar")
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null response indicating that the operation is complete
-* **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`<br/>
+ - _nodeId:_ `string` - Target node
+ - _ratingType:_ `any` - Type of rating to remove (can be "likes" or "fiveStar")
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null response indicating that the operation is complete
+- **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|__type>`<br/>
Gets the current user's rating for a node.
- * *nodeId:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/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>`<br/>
+ - _nodeId:_ `string` - Node 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)`|__type>` - The rating value
+- **postRating**(nodeId: `string`, ratingType: `string`, vote: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|__type>`<br/>
Adds the current user's rating for a node.
- * *nodeId:* `string` - Target node for the rating
- * *ratingType:* `string` - Type of rating (can be "likes" or "fiveStar")
- * *vote:* `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/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)`|__type>` - 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 248e7c975f..99fcbbeaad 100644
--- a/docs/content-services/services/search-query-builder.service.md
+++ b/docs/content-services/services/search-query-builder.service.md
@@ -13,91 +13,78 @@ Stores information from all the custom search and faceted search widgets, compil
### Methods
-* **addFilterQuery**(query: `string`)<br/>
+- **addFilterQuery**(query: `string`)<br/>
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))<br/>
+ - _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))<br/>
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`<br/>
+ - _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`<br/>
Builds the current query.
- * **Returns** `QueryBody` - The finished query
-
-* **execute**(queryBody?: `QueryBody`)<br/>
+ - **Returns** `QueryBody` - The finished query
+- **execute**(queryBody?: `QueryBody`)<br/>
Builds and executes the current query.
- * *queryBody:* `QueryBody` - (Optional)
-
-* **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)<br/>
+ - _queryBody:_ `QueryBody` - (Optional) (Optional)
+- **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)<br/>
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)<br/>
+ - _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)<br/>
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)<br/>
+ - _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)<br/>
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`<br/>
+ - **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts) - The primary sorting definition
+- **getQueryGroup**(query: `any`): `any`<br/>
Gets the query group.
- * *query:* `any` - Target query
- * **Returns** `any` - Query group
+ - _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)<br/>
-* **getScope**(): [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts)<br/>
+ - **Returns** [`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)`[]`<br/>
+- **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]`<br/>
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`<br/>
+ - **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
+- **getSupportedLabel**(configLabel: `string`): `string`<br/>
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)`[]`<br/>
+ - _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)`[]`<br/>
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
+ - _field:_ `string` - The target fields
+ - **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array
+- **isFilterServiceActive**(): `boolean`<br/>
-* **isFilterServiceActive**(): `boolean`<br/>
+ - **Returns** `boolean` -
- * **Returns** `boolean` -
+- **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)<br/>
-* **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)<br/>
+ - **Returns** [`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`)<br/>
+- **removeFilterQuery**(query: `string`)<br/>
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))<br/>
+ - _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))<br/>
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
+ - _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**()<br/>
-* **resetToDefaults**()<br/>
+- **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)`>`<br/>
-* **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)`>`<br/>
+ - _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)`>` -
- * *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))<br/>
-* **setScope**(scope: [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts))<br/>
+ - _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`)<br/>
+- **update**(queryBody?: `QueryBody`)<br/>
Builds the current query and triggers the `updated` event.
- * *queryBody:* `QueryBody` - (Optional)
+ - _queryBody:_ `QueryBody` - (Optional) (Optional)
## Details
@@ -109,13 +96,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) {
@@ -135,5 +122,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 03c5391a43..e067f2eba3 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)`>`<br/>
+- **addTag**(nodeId: `string`, tagName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`<br/>
Adds a tag to a node.
- * *nodeId:* `string` - ID of the target node
- * *tagName:* `string` - Name of the tag to add
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - TagEntry object (defined in JS-API) with details of the new tag
-* **getAllTheTags**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/>
+ - _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)`>`<br/>
Gets a list of all the tags already defined in the repository.
- * *opts:* `any` - (Optional) Options supported by JS-API
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags
-* **getTagsByNodeId**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/>
+ - _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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - 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)`<any>` - 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 1f811d35d5..62cef71fc2 100644
--- a/docs/core/components/card-view.component.md
+++ b/docs/core/components/card-view.component.md
@@ -107,7 +107,7 @@ 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. |
@@ -121,16 +121,16 @@ Defining properties from Typescript:
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.
@@ -182,22 +182,22 @@ specific data types, as described below.
const textItemProperty = new CardViewTextItemModel(options);
```
-| Name | Type | Default | Description |
-| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------ |
-| label\* | string | | Item label |
-| value\* | any | | The original data value for the item |
-| key\* | string | | Identifying key (important when editing the item) |
-| default | any | | The default value to display if the value is empty |
-| displayValue\* | string | | The value to display |
-| editable | boolean | false | Toggles whether the item is editable |
-| clickable | boolean | false | Toggles whether the property responds to clicks |
-| clickableCallBack | function | null | Function to execute when click the element |
-| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
-| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. |
-| multiValueSeparator | `string` | ',' | String separator between multi-value property items. |
-| icon | string | | The material icon to show beside the item if it is clickable |
-| multiline | boolean | false | Single or multiline text |
-| pipes | [`CardViewTextItemPipeProperty`](../../../lib/core/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| label\* | string | | Item label |
+| value\* | any | | The original data value for the item |
+| key\* | string | | Identifying key (important when editing the item) |
+| default | any | | The default value to display if the value is empty |
+| displayValue\* | string | | The value to display |
+| editable | boolean | false | Toggles whether the item is editable |
+| clickable | boolean | false | Toggles whether the property responds to clicks |
+| clickableCallBack | function | null | Function to execute when click the element |
+| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
+| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. |
+| multiValueSeparator | `string` | ',' | String separator between multi-value property items. |
+| icon | string | | The material icon to show beside the item if it is clickable |
+| multiline | boolean | false | Single or multiline text |
+| pipes | [`CardViewTextItemPipeProperty`](../../../lib/core/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display |
##### Using pipes with a Card Text Item
@@ -227,14 +227,14 @@ new CardViewTextItemModel({
const mapItemProperty = new CardViewMapItemModel(options);
```
-| Name | Type | Default | Description |
-| -------------- | ------- | ------- | -------------------------------------------------- |
-| label\* | string | | Item label |
-| value\* | Map | | A map that contains the key value pairs |
-| key\* | string | | Identifying key (important when editing the item) |
-| default | any | | The default value to display if the value is empty |
-| displayValue\* | string | | The value to display |
-| clickable | boolean | false | Toggles whether the property responds to clicks |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| label\* | string | | Item label |
+| value\* | Map | | A map that contains the key value pairs |
+| key\* | string | | Identifying key (important when editing the item) |
+| default | any | | The default value to display if the value is empty |
+| displayValue\* | string | | The value to display |
+| clickable | boolean | false | Toggles whether the property responds to clicks |
#### Card Date Item
@@ -244,16 +244,16 @@ const mapItemProperty = new CardViewMapItemModel(options);
const dateItemProperty = new CardViewDateItemModel(options);
```
-| Name | Type | Default | Description |
-| --------------------- | --------- | ------------- | ---------------------------------------------------------- |
-| label\* | string | | Item label |
-| value\* | any | | The original data value for the item |
-| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
-| key\* | string | | Identifying key (important when editing the item) |
-| default | any | | The default value to display if the value is empty |
-| displayValue\* | any | | The value to display |
-| editable | boolean | false | Toggles whether the item is editable |
-| format | string | "MMM DD YYYY" | Any date format that momentjs accepts |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| label\* | string | | Item label |
+| value\* | any | | The original data value for the item |
+| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
+| key\* | string | | Identifying key (important when editing the item) |
+| default | any | | The default value to display if the value is empty |
+| displayValue\* | any | | The value to display |
+| editable | boolean | false | Toggles whether the item is editable |
+| format | string | "MMM DD YYYY" | Any date format that momentjs accepts |
#### Card Datetime Item
@@ -263,15 +263,15 @@ const dateItemProperty = new CardViewDateItemModel(options);
const datetimeItemProperty = new CardViewDatetimeItemModel(options);
```
-| Name | Type | Default | Description |
-| -------------- | ------- | ------------------- | -------------------------------------------------- |
-| label\* | string | | Item label |
-| value\* | any | | The original data value for the item |
-| key\* | string | | Identifying key (important when editing the item) |
-| default | any | any | The default value to display if the value is empty |
-| displayValue\* | string | | The value to display |
-| editable | boolean | false | Toggles whether the item is editable |
-| format | string | "MMM DD YYYY HH:mm" | Any datetime format that momentjs accepts |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| label\* | string | | Item label |
+| value\* | any | | The original data value for the item |
+| key\* | string | | Identifying key (important when editing the item) |
+| default | any | any | The default value to display if the value is empty |
+| displayValue\* | string | | The value to display |
+| editable | boolean | false | Toggles whether the item is editable |
+| format | string | "MMM DD YYYY HH:mm" | Any datetime format that momentjs accepts |
#### Card Bool Item
@@ -281,14 +281,14 @@ const datetimeItemProperty = new CardViewDatetimeItemModel(options);
const boolItemProperty = new CardViewBoolItemModel(options);
```
-| Name | Type | Default | Description |
-| -------------- | ------- | ------- | -------------------------------------------------- |
-| label\* | string | | Item label |
-| value\* | boolean | | The original data value for the item |
-| key\* | string | | Identifying key (important when editing the item) |
-| default | boolean | false | The default value to display if the value is empty |
-| displayValue\* | boolean | | The value to display |
-| editable | boolean | false | Toggles whether the item is editable |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| label\* | string | | Item label |
+| value\* | boolean | | The original data value for the item |
+| key\* | string | | Identifying key (important when editing the item) |
+| default | boolean | false | The default value to display if the value is empty |
+| displayValue\* | boolean | | The value to display |
+| editable | boolean | false | Toggles whether the item is editable |
#### Card Int Item
@@ -298,14 +298,14 @@ const boolItemProperty = new CardViewBoolItemModel(options);
const intItemProperty = new CardViewIntItemModel(options);
```
-| Name | Type | Default | Description |
-| -------------- | ------- | ------- | -------------------------------------------------- |
-| label\* | string | | Item label |
-| value\* | integer | | The original data value for the item |
-| key\* | string | | Identifying key (important when editing the item) |
-| default | integer | | The default value to display if the value is empty |
-| displayValue\* | integer | | The value to display |
-| editable | boolean | false | Toggles whether the item is editable |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| label\* | string | | Item label |
+| value\* | integer | | The original data value for the item |
+| key\* | string | | Identifying key (important when editing the item) |
+| default | integer | | The default value to display if the value is empty |
+| displayValue\* | integer | | The value to display |
+| editable | boolean | false | Toggles whether the item is editable |
#### Card Float Item
@@ -315,14 +315,14 @@ const intItemProperty = new CardViewIntItemModel(options);
const floatItemProperty = new CardViewFloatItemModel(options);
```
-| Name | Type | Default | Description |
-| -------------- | ------- | ------- | -------------------------------------------------- |
-| label\* | string | | Item label |
-| value\* | float | | The original data value for the item |
-| key\* | string | | Identifying key (important when editing the item) |
-| default | float | | The default value to display if the value is empty |
-| displayValue\* | float | | The value to display |
-| editable | boolean | false | Toggles whether the item is editable |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| label\* | string | | Item label |
+| value\* | float | | The original data value for the item |
+| key\* | string | | Identifying key (important when editing the item) |
+| default | float | | The default value to display if the value is empty |
+| displayValue\* | float | | The value to display |
+| editable | boolean | false | Toggles whether the item is editable |
#### Card Key Value Pairs Item
@@ -332,12 +332,12 @@ const floatItemProperty = new CardViewFloatItemModel(options);
const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options);
```
-| Name | Type | Default | Description |
-| -------- | -------------------------------- | ------- | ------------------------------------------------- |
-| label\* | string | | Item label |
-| key\* | string | | Identifying key (important when editing the item) |
-| editable | boolean | false | Toggles whether the item is editable |
-| value\* | `[{ name: '', value: '' }, ...]` | | The original data value for the item |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| label\* | string | | Item label |
+| key\* | string | | Identifying key (important when editing the item) |
+| editable | boolean | false | Toggles whether the item is editable |
+| value\* | `[{ name: '', value: '' }, ...]` | | The original data value for the item |
#### Card Select Item
@@ -347,13 +347,13 @@ const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options);
const selectItemProperty = new CardViewSelectItemModel(options);
```
-| Name | Type | Default | Description |
-| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------- |
-| label\* | string | | Item label |
-| 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 |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| label\* | string | | Item label |
+| 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 |
#### Card Array Item
@@ -363,14 +363,14 @@ const selectItemProperty = new CardViewSelectItemModel(options);
const arrayItemProperty = new CardViewArrayItemModel(items);
```
-| Name | Type | Default | Description |
-| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------- |
-| 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 |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| 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 |
## 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 0a09d937ba..7f3c423d8c 100644
--- a/docs/core/components/comment-list.component.md
+++ b/docs/core/components/comment-list.component.md
@@ -64,11 +64,11 @@ 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. |
### Events
| 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 3031ad95a7..36e82a36c7 100644
--- a/docs/core/components/comments.component.md
+++ b/docs/core/components/comments.component.md
@@ -33,7 +33,7 @@ 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. |
@@ -41,5 +41,5 @@ Displays comments from users involved in a specified task or content and allows
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 546aba12f4..4d27f19ffd 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
@@ -42,7 +42,7 @@ 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. |
@@ -124,11 +124,11 @@ You can provide custom column/cell templates that may contain other Angular comp
Every cell in the DataTable component is bound to the dynamic data context containing the following properties:
-| Name | Type | Description |
-| ---- | --------------------------------------------------------------------------- | ----------------------------- |
-| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | Data adapter instance. |
-| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | Current data row instance. |
-| col | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | Current data column instance. |
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | Data adapter instance. |
+| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | Current data row instance. |
+| col | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | Current data column instance. |
You can use all three properties to gain full access to underlying data from within your custom templates.
In order to wire HTML templates with the data context you will need to define a variable that is bound to `$implicit` as shown below:
@@ -334,6 +334,6 @@ HTML `<data-column>` 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 98b361a40c..65faba250f 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
@@ -343,7 +343,7 @@ 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. |
@@ -361,19 +361,19 @@ Learm more about styling your datatable: [Customizing the component's styles](#c
| 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`] |
+| showHeader | `string` | | 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<DataRowEvent>` | Emitted when the user double-clicks a row. |
-| showRowActionsMenu | `EventEmitter<DataCellEvent>` | Emitted before the actions menu is displayed for a row. |
-| showRowContextMenu | `EventEmitter<DataCellEvent>` | Emitted before the context menu is displayed for a row. |
+| ---- | ---- | ----------- |
+| executeRowAction | `any` | Emitted when the user executes a row action. |
+| rowClick | `any` | Emitted when the user clicks a row. |
+| rowDblClick | `any` | Emitted when the user double-clicks a row. |
+| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. |
+| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
## Details
@@ -395,18 +395,18 @@ for more information.
Below are the DOM events emitted by the DataTable component.
These events bubble up the component tree and can be handled by any parent component.
-| Name | Description |
-| --------------- | ---------------------------------------------------- |
-| row-click | Raised when user clicks a row |
-| row-dblclick | Raised when user double-clicks a row |
-| row-select | Raised after user selects a row |
-| row-unselect | Raised after user unselects a row |
-| row-keyup | Raised on the 'keyup' event for the focused row. |
+| Name | Description |
+| ---- | ----------- |
+| row-click | Raised when user clicks a row |
+| row-dblclick | Raised when user double-clicks a row |
+| row-select | Raised after user selects a row |
+| row-unselect | Raised after user unselects a row |
+| row-keyup | Raised on the 'keyup' event for the focused row. |
| sorting-changed | Raised after user clicks the sortable column header. |
-| header-dragover | Raised when dragging content over the header. |
-| header-drop | Raised when data is dropped on the column header. |
-| cell-dragover | Raised when dragging data over the cell. |
-| cell-drop | Raised when data is dropped on the column cell. |
+| header-dragover | Raised when dragging content over the header. |
+| header-drop | Raised when data is dropped on the column header. |
+| cell-dragover | Raised when dragging data over the cell. |
+| cell-drop | Raised when data is dropped on the column cell. |
#### Drop Events
@@ -824,7 +824,7 @@ here is the sample resolver which merge the users property and status and it wil
## 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 3bf11859d1..454a8c07ea 100644
--- a/docs/core/components/empty-content.component.md
+++ b/docs/core/components/empty-content.component.md
@@ -30,7 +30,7 @@ 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. |
@@ -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 29c20df251..2138e15a9b 100644
--- a/docs/core/components/error-content.component.md
+++ b/docs/core/components/error-content.component.md
@@ -22,7 +22,7 @@ this.router.navigate(['/error', errorCode]);
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
| errorCode | `string` | | Error code associated with this error. |
## Details
@@ -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 25aee2a925..7f5d40704c 100644
--- a/docs/core/components/form-field.component.md
+++ b/docs/core/components/form-field.component.md
@@ -26,7 +26,7 @@ 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. |
## Details
@@ -38,24 +38,24 @@ uses `<adf-form-field>` 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 |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| 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) |
-| Number | integer | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) |
-| Checkbox | boolean | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
-| Date | date | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) |
-| Dropdown | dropdown | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
-| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
-| Amount | amount | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) |
-| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
-| People | people | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) |
-| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
-| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
-| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
-| Header | group | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) |
-| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
-| Display value | readonly | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
-| Display text | readonly-text | [`DisplayTextWidgetComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
-| N/A | container | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) |
-| N/A | N/A | [`UnknownWidgetComponent`](../../../lib/core/form/components/widgets/unknown/unknown.widget.ts) |
+| _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) |
+| Number | integer | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) |
+| Checkbox | boolean | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
+| Date | date | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) |
+| Dropdown | dropdown | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
+| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
+| Amount | amount | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) |
+| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
+| People | people | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) |
+| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
+| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
+| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
+| Header | group | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) |
+| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
+| Display value | readonly | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
+| Display text | readonly-text | [`DisplayTextWidgetComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
+| N/A | container | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) |
+| N/A | N/A | [`UnknownWidgetComponent`](../../../lib/core/form/components/widgets/unknown/unknown.widget.ts) |
diff --git a/docs/core/components/form-list.component.md b/docs/core/components/form-list.component.md
index b566e642dd..837d00b3c9 100644
--- a/docs/core/components/form-list.component.md
+++ b/docs/core/components/form-list.component.md
@@ -22,5 +22,5 @@ Shows forms as a list.
### Properties
| 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 30206f69e6..d27507cccc 100644
--- a/docs/core/components/header.component.md
+++ b/docs/core/components/header.component.md
@@ -37,7 +37,7 @@ 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. |
@@ -50,8 +50,8 @@ body of the element:
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the sidenav button is clicked. |
+| ---- | ---- | ----------- |
+| clicked | `any` | Emitted when the sidenav button is clicked. |
## Details
diff --git a/docs/core/components/host-settings.component.md b/docs/core/components/host-settings.component.md
index ff77ef9a1d..ad24c9a005 100644
--- a/docs/core/components/host-settings.component.md
+++ b/docs/core/components/host-settings.component.md
@@ -33,13 +33,13 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the user cancels the changes. |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the URL is invalid. |
-| success | `EventEmitter<boolean>` | Emitted when the changes are successfully applied. |
+| ---- | ---- | ----------- |
+| cancel | `any` | Emitted when the user cancels the changes. |
+| error | `any` | Emitted when the URL is invalid. |
+| success | `any` | Emitted when the changes are successfully applied. |
diff --git a/docs/core/components/icon.component.md b/docs/core/components/icon.component.md
index 9badb21479..af76fac0ad 100644
--- a/docs/core/components/icon.component.md
+++ b/docs/core/components/icon.component.md
@@ -27,7 +27,7 @@ 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]`. |
@@ -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 b7115ba889..0ea6844b7a 100644
--- a/docs/core/components/infinite-pagination.component.md
+++ b/docs/core/components/infinite-pagination.component.md
@@ -37,7 +37,7 @@ 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. |
@@ -45,7 +45,7 @@ Adds "infinite" pagination to the component it is used with.
### Events
| 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 da372fc6f4..147b26e06c 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 `<div>` elements
with the following names:
-* info-drawer-title
-* info-drawer-buttons
-* info-drawer-content
+- info-drawer-title
+- info-drawer-buttons
+- info-drawer-content
```html
<adf-info-drawer-layout [showHeader]="true">
@@ -43,7 +43,7 @@ with the following names:
### Properties
| 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 ed13368754..b3a0f54416 100644
--- a/docs/core/components/info-drawer-tab.component.md
+++ b/docs/core/components/info-drawer-tab.component.md
@@ -54,7 +54,7 @@ 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). |
@@ -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 503cf4be34..7461420194 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 `<div>` 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 `<adf-info-drawer-tab>` elements, which can
have any content you like:
@@ -48,7 +48,7 @@ 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). |
@@ -56,7 +56,7 @@ have any content you like:
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| currentTab | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<number>` | 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 b8fc7e26d5..91c6b2f7ea 100644
--- a/docs/core/components/json-cell.component.md
+++ b/docs/core/components/json-cell.component.md
@@ -42,7 +42,7 @@ 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. |
@@ -58,4 +58,4 @@ This component provides a custom display to show JSON data in a
## 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 808c3189d1..6f5939c85f 100644
--- a/docs/core/components/login-dialog-panel.component.md
+++ b/docs/core/components/login-dialog-panel.component.md
@@ -14,8 +14,8 @@ Shows and manages a login dialog.
### Events
| 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. |
+| ---- | ---- | ----------- |
+| success | `any` | 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 2450155908..0f2cb5cdb9 100644
--- a/docs/core/components/login.component.md
+++ b/docs/core/components/login.component.md
@@ -13,20 +13,21 @@ 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)
+ - [Override the successRoute from app.config.json with Basic Auth](#override-the-successroute-from-appconfigjson-with-basic-auth)
+ - [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
@@ -76,7 +77,7 @@ 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. |
@@ -90,10 +91,10 @@ with custom input fields handled by your application or parent component:
### 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<LoginSuccessEvent>` | Emitted when the login is successful. |
+| ---- | ---- | ----------- |
+| error | `any` | Emitted when the login fails. |
+| executeSubmit | `any` | Emitted when the login form is submitted. |
+| success | `any` | Emitted when the login is successful. |
## Details
@@ -277,7 +278,7 @@ export class MyCustomLogin {
```
Note that if you do not call `event.preventDefault()` then the default behaviour
-will execute *after* your custom code has completed.
+will execute _after_ your custom code has completed.
### Single Sign-On (SSO)
@@ -313,8 +314,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
{
@@ -368,4 +369,4 @@ See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructi
## 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 e5f9dfdfeb..aff3bdfb6d 100644
--- a/docs/core/components/notification-history.component.md
+++ b/docs/core/components/notification-history.component.md
@@ -23,11 +23,11 @@ The main purpose of the [Notification history component](../../core/components/n
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
+| maxNotifications | `number` | 5 | Maximum number of notifications to display. The rest will remain hidden until load more is clicked |
| 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`. |
-| maxNotifications | `number` | 5 | Maximum number of notifications to display. The rest will remain hidden until load more is clicked. |
## See also
-* [Notification Service](../../core/services/notification.service.md)
+- [Notification Service](../../core/services/notification.service.md)
diff --git a/docs/core/components/pagination.component.md b/docs/core/components/pagination.component.md
index 97cc6e46d7..530af8fe71 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
@@ -41,7 +41,7 @@ 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. |
@@ -49,12 +49,12 @@ Adds pagination to the component it is used with.
### 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<PaginationModel>` | Emitted when the page size changes. |
-| nextPage | `EventEmitter<PaginationModel>` | Emitted when the next page is requested. |
-| prevPage | `EventEmitter<PaginationModel>` | Emitted when the previous page is requested. |
+| ---- | ---- | ----------- |
+| change | `any` | Emitted when pagination changes in any way. |
+| changePageNumber | `any` | Emitted when the page number changes. |
+| changePageSize | `any` | Emitted when the page size changes. |
+| nextPage | `any` | Emitted when the next page is requested. |
+| prevPage | `any` | Emitted when the previous page is requested. |
## Details
@@ -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 cf0f417eac..8dd7540f4e 100644
--- a/docs/core/components/search-text-input.component.md
+++ b/docs/core/components/search-text-input.component.md
@@ -27,7 +27,7 @@ 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. |
@@ -42,8 +42,8 @@ Displays a input text that supports autocompletion
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| reset | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the result list is reset |
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | 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)`<any>` | Emitted when the result list is selected |
-| submit | `EventEmitter<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |
+| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 0565e9124b..e215489aa9 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 `<div>` 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
<adf-sidebar-action-menu>
@@ -43,7 +43,7 @@ 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. |
diff --git a/docs/core/components/sidenav-layout.component.md b/docs/core/components/sidenav-layout.component.md
index 6d3f8420ac..a49ce05352 100644
--- a/docs/core/components/sidenav-layout.component.md
+++ b/docs/core/components/sidenav-layout.component.md
@@ -13,15 +13,15 @@ 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
@@ -68,7 +68,7 @@ sub-components (note the use of `<ng-template>` 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'. |
@@ -79,8 +79,8 @@ sub-components (note the use of `<ng-template>` in the sub-components' body sect
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. |
+| ---- | ---- | ----------- |
+| expanded | `any` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. |
## Details
@@ -114,24 +114,24 @@ 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$
Beside the template context's **isMenuMinimized** variable, another way to listen to the component's menu's open/closed state is with the `menuOpenState$` observable, which is driven by a `BehaviorSubject` in the background. The value emitted by this observable is the opposite of the `isMenuMinimized` template variable.
-| Name | Type | Default | Description |
-| -------------- | ----------------------------------------------------------------------------- | ------- | ----------------------------------------------- |
-| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)<boolean> | true | Another way to listen to menu open/closed state |
+| Name | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)<boolean> | 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
diff --git a/docs/core/components/sorting-picker.component.md b/docs/core/components/sorting-picker.component.md
index 2351a21444..76174f53bf 100644
--- a/docs/core/components/sorting-picker.component.md
+++ b/docs/core/components/sorting-picker.component.md
@@ -27,7 +27,7 @@ Selects from a set of predefined sorting definitions and directions.
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
| ascending | `boolean` | true | Current sorting direction |
| options | `Array<Function>` | \[] | Available sorting options |
| selected | `string` | | Currently selected option key |
@@ -35,9 +35,9 @@ Selects from a set of predefined sorting definitions and directions.
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| sortingChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Raised each time direction gets changed. |
-| valueChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Raised each time sorting key gets changed. |
+| ---- | ---- | ----------- |
+| sortingChange | `any` | Raised each time direction gets changed. |
+| valueChange | `any` | 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 0a933ac2af..15d831511b 100644
--- a/docs/core/components/start-form.component.md
+++ b/docs/core/components/start-form.component.md
@@ -25,20 +25,20 @@ 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. |
+| form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying form model 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 |
+| 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)? |
@@ -54,16 +54,16 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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<FormFieldModel[]>` | Emitted when the supplied form values have a validation error. |
-| formLoaded | `EventEmitter<FormModel>` | Emitted when the form is loaded or reloaded. |
-| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
-| outcomeClick | `EventEmitter<any>` | Emitted when the user clicks one of the outcome buttons that completes the form. |
+| 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)`<any>` | 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 d4ae6f65a7..f9cf465d84 100644
--- a/docs/core/components/text-mask.component.md
+++ b/docs/core/components/text-mask.component.md
@@ -20,7 +20,7 @@ Implements text field input masks.
### Properties
| 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 c555741304..741fa577d7 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
@@ -73,7 +73,7 @@ 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. |
@@ -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 01c3dcb737..4732b194a1 100644
--- a/docs/core/components/user-info.component.md
+++ b/docs/core/components/user-info.component.md
@@ -20,7 +20,7 @@ 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`. |
diff --git a/docs/core/components/viewer.component.md b/docs/core/components/viewer.component.md
index ade9902997..abc75cf8cf 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
@@ -75,7 +75,7 @@ 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 |
@@ -84,14 +84,14 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
| 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. |
+| 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. |
+| nodeId | `string` | null | Node 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`. |
@@ -108,23 +108,23 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the filename extension changes. |
-| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Back' button. |
-| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the shared link used is not valid. |
-| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Before' ("<") button. |
-| navigateNext | `EventEmitter<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Next' (">") button. |
-| print | `EventEmitter<BaseEvent<any>>` | Emitted when user clicks the 'Print' button. |
-| showViewerChange | `EventEmitter<boolean>` | Emitted when the viewer is shown or hidden. |
+| ---- | ---- | ----------- |
+| extensionChange | `any` | Emitted when the filename extension changes. |
+| goBack | `any` | Emitted when user clicks the 'Back' button. |
+| invalidSharedLink | `any` | Emitted when the shared link used is not valid. |
+| navigateBefore | `any` | Emitted when user clicks 'Navigate Before' ("<") button. |
+| navigateNext | `any` | Emitted when user clicks 'Navigate Next' (">") button. |
+| print | `any` | Emitted when user clicks the 'Print' button. |
+| showViewerChange | `any` | Emitted when the viewer is shown or hidden. |
## Keyboard shortcuts
-| Name | Description |
-| ------ | ------------------------------------- |
-| Esc | Close the viewer (overlay mode only). |
-| Left | Invoke 'Navigate before' action. |
-| Right | Invoke 'Navigate next' action. |
-| Ctrl+F | Activate full-screen mode. |
+| Name | Description |
+| ---- | ----------- |
+| Esc | Close the viewer (overlay mode only). |
+| Left | Invoke 'Navigate before' action. |
+| Right | Invoke 'Navigate next' action. |
+| Ctrl+F | Activate full-screen mode. |
## Details
@@ -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
@@ -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 e02f24b598..aac276ffd0 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
@@ -41,7 +41,7 @@ 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 permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). |
@@ -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 3e86d993f9..0a29f4839f 100644
--- a/docs/core/directives/clipboard.directive.md
+++ b/docs/core/directives/clipboard.directive.md
@@ -26,10 +26,10 @@ 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. |
+| 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 1ea5077797..a83838d638 100644
--- a/docs/core/directives/context-menu.directive.md
+++ b/docs/core/directives/context-menu.directive.md
@@ -48,7 +48,7 @@ export class MyComponent implements OnInit {
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
| enabled | `boolean` | false | Is the menu enabled? |
| links | `any[]` | | Items for the menu. |
diff --git a/docs/core/directives/highlight.directive.md b/docs/core/directives/highlight.directive.md
index 128f1e6636..b877284716 100644
--- a/docs/core/directives/highlight.directive.md
+++ b/docs/core/directives/highlight.directive.md
@@ -26,7 +26,7 @@ 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. |
@@ -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/infinite-select-scroll.directive.md b/docs/core/directives/infinite-select-scroll.directive.md
index 3c9d911789..52c6affb7e 100644
--- a/docs/core/directives/infinite-select-scroll.directive.md
+++ b/docs/core/directives/infinite-select-scroll.directive.md
@@ -26,5 +26,5 @@ Load more options to select component if API returns more items
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| scrollEnd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Event`](https://developer.mozilla.org/en-US/docs/Web/API/Event)`>` | Emitted when scroll reaches the last item. |
+| ---- | ---- | ----------- |
+| scrollEnd | `any` | Emitted when scroll reaches the last item. |
diff --git a/docs/core/directives/logout.directive.md b/docs/core/directives/logout.directive.md
index 489aa17d6c..a1c0988278 100644
--- a/docs/core/directives/logout.directive.md
+++ b/docs/core/directives/logout.directive.md
@@ -20,9 +20,9 @@ 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. |
+| redirectUri | `string` | | URI to redirect to after logging out. |
## Kerberos
@@ -34,4 +34,4 @@ See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructi
## 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 78affceb2e..d8310c2666 100644
--- a/docs/core/directives/node-delete.directive.md
+++ b/docs/core/directives/node-delete.directive.md
@@ -29,14 +29,14 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| delete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 f7a36e0cd7..138480d3fe 100644
--- a/docs/core/directives/node-download.directive.md
+++ b/docs/core/directives/node-download.directive.md
@@ -30,6 +30,6 @@ 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` | | Node's version to download. |
+| ---- | ---- | ------------- | ----------- |
+| 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 version to download. |
diff --git a/docs/core/directives/node-favorite.directive.md b/docs/core/directives/node-favorite.directive.md
index e74b6f2452..456c265c88 100644
--- a/docs/core/directives/node-favorite.directive.md
+++ b/docs/core/directives/node-favorite.directive.md
@@ -42,13 +42,13 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting fails. |
| toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting is complete. |
@@ -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 de10c1bc48..edb2b2dc00 100644
--- a/docs/core/directives/node-restore.directive.md
+++ b/docs/core/directives/node-restore.directive.md
@@ -49,13 +49,13 @@ 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. |
### Events
| 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 6c2204ae0a..241bcb5134 100644
--- a/docs/core/directives/upload.directive.md
+++ b/docs/core/directives/upload.directive.md
@@ -22,12 +22,12 @@ 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. |
+| 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
<div style="width: 50px; height: 50px; background-color: brown"
diff --git a/docs/core/directives/version-compatibility.directive.md b/docs/core/directives/version-compatibility.directive.md
index fb17c3008c..d485e67d6e 100644
--- a/docs/core/directives/version-compatibility.directive.md
+++ b/docs/core/directives/version-compatibility.directive.md
@@ -22,7 +22,7 @@ Enables/disables components based on ACS version in use.
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
| version | `void` | | Minimum version required for component to work correctly . |
## Details
diff --git a/docs/core/services/app-config.service.md b/docs/core/services/app-config.service.md
index 3da6d856b7..c190caeeb9 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?: \`\`)<br/>
+- **get**(key: `string`, defaultValue?: )<br/>
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`<br/>
+ - _key:_ `string` - Name of the property
+ - _defaultValue:_ - (Optional) Value to return if the key is not found
+- **getLocationHostname**(): `string`<br/>
Gets the location.hostname property.
- * **Returns** `string` - Value of the property
-* **getLocationPort**(prefix: `string` = `""`): `string`<br/>
+ - **Returns** `string` - Value of the property
+- **getLocationPort**(prefix: `string` = `""`): `string`<br/>
Gets the location.port property.
- * *prefix:* `string` - Text added before port value
- * **Returns** `string` - Port with prefix
-* **getLocationProtocol**(): `string`<br/>
+ - _prefix:_ `string` - Text added before port value
+ - **Returns** `string` - Port with prefix
+- **getLocationProtocol**(): `string`<br/>
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)`<any>`<br/>
+ - **Returns** `string` - The location.protocol string
+- **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>`<br/>
Loads the config file.
- * **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>` - Notification when loading is complete
-* **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>` - Notification when loading is complete
+- **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Requests notification of a property value when it is loaded.
- * *property:* `string` - The desired property value
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Property value, when loaded
+ - _property:_ `string` - The desired property value
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Property value, when loaded
## Details
@@ -107,11 +107,11 @@ The [`AppConfigService`](../../core/services/app-config.service.md) supports a l
The supported variables are:
-| Variable name | Runtime value |
-| ------------- | ------------------- |
-| protocol | `location.protocol` |
-| hostname | `location.hostname` |
-| port | `location.port` |
+| Variable name | Runtime value |
+| ------------- | ------------- |
+| protocol | `location.protocol` |
+| hostname | `location.hostname` |
+| port | `location.port` |
## App Config onLoad Stream
diff --git a/docs/core/services/apps-process.service.md b/docs/core/services/apps-process.service.md
index b25919a2c9..4575df2b26 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)`>`<br/>
+- **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)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - **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)`>`<br/>
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 f0f488a450..7be672feb8 100644
--- a/docs/core/services/authentication.service.md
+++ b/docs/core/services/authentication.service.md
@@ -13,85 +13,87 @@ Provides authentication to ACS and APS.
### Methods
-* **addTokenToHeader**(headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>`<br/>
+- **addTokenToHeader**(headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>`<br/>
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)`<HttpHeaders>` - The new header with the token added
-* **getBearerExcludedUrls**(): `string[]`<br/>
+ - _headersArg:_ `HttpHeaders` - (Optional) Header that will receive the token
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>` - The new header with the token added
+- **getBearerExcludedUrls**(): `string[]`<br/>
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)`>`<br/>
+ - **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)`>`<br/>
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`<br/>
+ - **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`<br/>
Gets the BPM username
- * **Returns** `string` - The BPM username
-* **getEcmUsername**(): `string`<br/>
+ - **Returns** `string` - The BPM username
+- **getEcmUsername**(): `string`<br/>
Gets the ECM username.
- * **Returns** `string` - The ECM username
-* **getRedirect**(): `string`<br/>
+ - **Returns** `string` - The ECM username
+- **getRedirect**(): `string`<br/>
Gets the URL to redirect to after login.
- * **Returns** `string` - The redirect URL
-* **getTicketBpm**(): `string|null`<br/>
+ - **Returns** `string` - The redirect URL
+- **getTicketBpm**(): `string|null`<br/>
Gets the BPM ticket stored in the Storage.
- * **Returns** `string|null` - The ticket or `null` if none was found
-* **getTicketEcm**(): `string|null`<br/>
+ - **Returns** `string|null` - The ticket or `null` if none was found
+- **getTicketEcm**(): `string|null`<br/>
Gets the ECM ticket stored in the Storage.
- * **Returns** `string|null` - The ticket or `null` if none was found
-* **getTicketEcmBase64**(): `string|null`<br/>
+ - **Returns** `string|null` - The ticket or `null` if none was found
+- **getTicketEcmBase64**(): `string|null`<br/>
Gets the BPM ticket from the Storage in Base 64 format.
- * **Returns** `string|null` - The ticket or `null` if none was found
-* **getToken**(): `string`<br/>
+ - **Returns** `string|null` - The ticket or `null` if none was found
+- **getToken**(): `string`<br/>
Gets the auth token.
- * **Returns** `string` - Auth token string
-* **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - **Returns** `string` - Auth token string
+- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Prints an error message in the console browser
- * *error:* `any` - Error message
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Object representing the error message
-* **isALLProvider**(): `boolean`<br/>
+ - _error:_ `any` - Error message
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Object representing the error message
+- **isALLProvider**(): `boolean`<br/>
Does the provider support both ECM and BPM?
- * **Returns** `boolean` - True if both are supported, false otherwise
-* **isBPMProvider**(): `boolean`<br/>
+ - **Returns** `boolean` - True if both are supported, false otherwise
+- **isBPMProvider**(): `boolean`<br/>
Does the provider support BPM?
- * **Returns** `boolean` - True if supported, false otherwise
-* **isBpmLoggedIn**(): `boolean`<br/>
+ - **Returns** `boolean` - True if supported, false otherwise
+- **isBpmLoggedIn**(): `boolean`<br/>
Checks if the user is logged in on a BPM provider.
- * **Returns** `boolean` - True if logged in, false otherwise
-* **isECMProvider**(): `boolean`<br/>
+ - **Returns** `boolean` - True if logged in, false otherwise
+- **isECMProvider**(): `boolean`<br/>
Does the provider support ECM?
- * **Returns** `boolean` - True if supported, false otherwise
-* **isEcmLoggedIn**(): `boolean`<br/>
+ - **Returns** `boolean` - True if supported, false otherwise
+- **isEcmLoggedIn**(): `boolean`<br/>
Checks if the user is logged in on an ECM provider.
- * **Returns** `boolean` - True if logged in, false otherwise
-* **isLoggedIn**(): `boolean`<br/>
+ - **Returns** `boolean` - True if logged in, false otherwise
+- **isLoggedIn**(): `boolean`<br/>
Checks if the user logged in.
- * **Returns** `boolean` - True if logged in, false otherwise
-* **isLoggedInWith**(provider: `string`): `boolean`<br/>
+ - **Returns** `boolean` - True if logged in, false otherwise
+- **isLoggedInWith**(provider: `string`): `boolean`<br/>
- * *provider:* `string` -
- * **Returns** `boolean` -
-* **isOauth**(): `boolean`<br/>
+ - _provider:_ `string` -
+ - **Returns** `boolean` -
+
+- **isOauth**(): `boolean`<br/>
Does the provider support OAuth?
- * **Returns** `boolean` - True if supported, false otherwise
-* **isPublicUrl**(): `boolean`<br/>
+ - **Returns** `boolean` - True if supported, false otherwise
+- **isPublicUrl**(): `boolean`<br/>
- * **Returns** `boolean` -
-* **isRememberMeSet**(): `boolean`<br/>
+ - **Returns** `boolean` -
+
+- **isRememberMeSet**(): `boolean`<br/>
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)`<Function>`<br/>
+ - **Returns** `boolean` - True if set, false otherwise
+- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>`<br/>
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)`<Function>` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket
-* **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _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)`<Function>` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket
+- **logout**(): `any`<br/>
Logs the user out.
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Response event called when logout is complete
-* **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))<br/>
+ - **Returns** `any` - Response event called when logout is complete
+- **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))<br/>
Sets the URL to redirect to after login.
- * *url:* [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to
-* **ssoImplicitLogin**()<br/>
+ - _url:_ [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to
+- **ssoImplicitLogin**()<br/>
Logs the user in with SSO
## Details
@@ -118,4 +120,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 ee821ba2ed..3c622dc385 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)`>`<br/>
+- **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>`<br/>
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`<br/>
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>` - User information object
+- **getCurrentUserProfileImage**(): `string`<br/>
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 1048848aa1..8ea69912a0 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<Function>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)<br/>
+- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)<br/>
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<Function>` - 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`)<br/>
+ - _type:_ `string` - The type whose resolver you want
+ - _defaultValue:_ `Type<__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`)<br/>
Register multiple components
- * *components:* `Function` -
- * *override:* `boolean` -
-* **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<Function>` = `this.defaultValue`): `Type<Function>`<br/>
+ - _components:_ `Function` -
+ - _override:_ `boolean` -
+- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
Finds the component type that is needed to render a form field.
- * *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<Function>` - Default type returned for field types that are not yet mapped.
- * **Returns** `Type<Function>` - Component type
-* **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)<br/>
+ - _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<__type>` - Default type returned for field types that are not yet mapped.
+ - **Returns** `Type<__type>` - Component type
+- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)<br/>
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
@@ -42,15 +42,15 @@ model object as a parameter and returns the component type needed to display tha
The default mapping is shown below:
-| Type string | Component |
-| ----------- | ------------------------------------------------------------------------------------------------------------------------ |
-| 'text' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
-| 'int' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
-| 'float' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
-| 'date' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) |
-| 'datetime' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) |
-| 'bool' | [`CardViewBoolItemComponent`](../../../lib/core/card-view/components/card-view-boolitem/card-view-boolitem.component.ts) |
-| 'map' | [`CardViewMapItemComponent`](../../../lib/core/card-view/components/card-view-mapitem/card-view-mapitem.component.ts) |
+| Type string | Component |
+| ----------- | --------- |
+| 'text' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
+| 'int' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
+| 'float' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
+| 'date' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) |
+| 'datetime' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) |
+| 'bool' | [`CardViewBoolItemComponent`](../../../lib/core/card-view/components/card-view-boolitem/card-view-boolitem.component.ts) |
+| 'map' | [`CardViewMapItemComponent`](../../../lib/core/card-view/components/card-view-mapitem/card-view-mapitem.component.ts) |
### Adding new type mappings
@@ -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 0228655c00..cdea589991 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`)<br/>
+- **copyContentToClipboard**(content: `string`, message: `string`)<br/>
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`)<br/>
+ - _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`)<br/>
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`<br/>
+ - _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`<br/>
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 e72246c398..c061aef5dc 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)`>`<br/>
+- **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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 07c4d5ed2b..87bccb60fc 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)`>`<br/>
+- **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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 0dec622430..10287cf64e 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`<br/>
+- **createTrustedUrl**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)): `string`<br/>
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`)<br/>
- (**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`)<br/>
- (**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`)<br/>
- (**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`<br/>
+ - _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`)<br/>
+ (**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`)<br/>
+ (**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`)<br/>
+ (**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`<br/>
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`<br/>
- (**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)`>`<br/>
+ - _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`<br/>
+ (**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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
Gets content for the given node.
- * *nodeId:* `string` - ID of the target node
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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`<br/>
+ - _nodeId:_ `string` - ID of the target node
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Content data
+- **hasAllowableOperations**(node: `Node`, allowableOperation: [`AllowableOperationsEnum`](../../../lib/core/models/allowable-operations.enum.ts)`|string`): `boolean`<br/>
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`<br/>
+ - _node:_ `Node` - Node 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`, permission: [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string`): `boolean`<br/>
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` - Node 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
@@ -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 514f40e384..42443b2014 100644
--- a/docs/core/services/cookie.service.md
+++ b/docs/core/services/cookie.service.md
@@ -13,25 +13,25 @@ Stores key-value data items as browser cookies.
### Methods
-* **clear**()<br/>
+- **clear**()<br/>
Placeholder for testing purposes - do not use.
-* **deleteCookie**(key: `string`, path: `string|null` = `null`)<br/>
+- **deleteCookie**(key: `string`, path: `string|null` = `null`)<br/>
Delete a cookie Key.
- * *key:* `string` - Key to identify the cookie
- * *path:* `string|null` - "Pathname" to store the cookie
-* **getItem**(key: `string`): `string|null`<br/>
+ - _key:_ `string` - Key to identify the cookie
+ - _path:_ `string|null` - "Pathname" to store the cookie
+- **getItem**(key: `string`): `string|null`<br/>
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`<br/>
+ - _key:_ `string` - Key to identify the cookie
+ - **Returns** `string|null` - The cookie data or null if it is not found
+- **isEnabled**(): `boolean`<br/>
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`)<br/>
+ - **Returns** `boolean` - True if enabled, false otherwise
+- **setItem**(key: `string`, data: `string`, expiration: `Date|null` = `null`, path: `string|null` = `null`)<br/>
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
@@ -46,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 1984d983fc..cb40491ae6 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)`>`<br/>
+- **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)`>`<br/>
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 95b8122b48..5ef79e20b7 100644
--- a/docs/core/services/discovery-api.service.md
+++ b/docs/core/services/discovery-api.service.md
@@ -13,15 +13,16 @@ 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)`>`<br/>
+- **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)`>`<br/>
- * **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)`>`<br/>
+ - **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)`>`<br/>
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)`>`<br/>
+ - **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)`>`<br/>
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 +34,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 1609a7c32a..cba2b68869 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`)<br/>
+- **cancelDownload**(downloadId: `string`)<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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`<br/>
+ - _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`<br/>
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)`>`<br/>
+ - _nodeId:_ `string` - Node 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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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 36192ee988..4a023adadc 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)`>`<br/>
+- **getCurrentUserInfo**(): `any`<br/>
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)`>`<br/>
+ - **Returns** `any` - User information as for getUserInfo
+- **getUserInfo**(userName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`<br/>
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`<br/>
+ - _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`<br/>
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 7679f66c89..60ce2ae431 100644
--- a/docs/core/services/favorites-api.service.md
+++ b/docs/core/services/favorites-api.service.md
@@ -13,23 +13,25 @@ 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)`>`<br/>
+- **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)`>`<br/>
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[]`<br/>
+ - _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[]`<br/>
- * *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)<br/>
+ - _entries:_ `any[]` -
+ - **Returns** `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`<br/>
+- **remapFavoritesData**(data: `any` = `{}`): [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)<br/>
- * *\__namedParameters:* `Function` -
- * **Returns** `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`<br/>
+
+ - _\_\_namedParameters:_ `Function` -
+ - **Returns** `any` -
## Details
diff --git a/docs/core/services/form-rendering.service.md b/docs/core/services/form-rendering.service.md
index 56a582f3e1..e9d178a564 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<Function>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)<br/>
+- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)<br/>
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<Function>` - 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`)<br/>
+ - _type:_ `string` - The type whose resolver you want
+ - _defaultValue:_ `Type<__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`)<br/>
Register multiple components
- * *components:* `Function` -
- * *override:* `boolean` -
-* **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<Function>` = `this.defaultValue`): `Type<Function>`<br/>
+ - _components:_ `Function` -
+ - _override:_ `boolean` -
+- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
Finds the component type that is needed to render a form field.
- * *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<Function>` - Default type returned for field types that are not yet mapped.
- * **Returns** `Type<Function>` - Component type
-* **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)<br/>
+ - _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<__type>` - Default type returned for field types that are not yet mapped.
+ - **Returns** `Type<__type>` - Component type
+- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)<br/>
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
@@ -66,25 +66,25 @@ formRenderingService.setComponentTypeResolver('text', customResolver, true);
The [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Rendering service is initialized with the mapping shown in the table below:
-| Stencil name | Field type string | Component type |
-| --------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| Amount | "amount" | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) |
-| Attach | "upload" | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
-| Checkbox | "boolean" | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
-| Date | "date" | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) |
-| Display text | "readonly-text" | [`DisplayTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
-| Display value | "readonly" | DisplayValueWidgetComponent |
-| Dropdown | "dropdown" | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
-| Dynamic table | "dynamic-table" | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
-| Group of people | "functional-group" | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
-| Header | "group" | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) |
-| Hyperlink | "hyperlink" | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
-| Multi-line text | "multi-line-text" | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
-| Number | "integer" | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) |
-| People | "people" | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) |
-| Radio buttons | "radio-buttons" | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
-| Text | "text" | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
-| Typeahead | "typeahead" | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
+| Stencil name | Field type string | Component type |
+| ------------ | ----------------- | -------------- |
+| Amount | "amount" | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) |
+| Attach | "upload" | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
+| Checkbox | "boolean" | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
+| Date | "date" | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) |
+| Display text | "readonly-text" | [`DisplayTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
+| Display value | "readonly" | DisplayValueWidgetComponent |
+| Dropdown | "dropdown" | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
+| Dynamic table | "dynamic-table" | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
+| Group of people | "functional-group" | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
+| Header | "group" | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) |
+| Hyperlink | "hyperlink" | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
+| Multi-line text | "multi-line-text" | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
+| Number | "integer" | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) |
+| People | "people" | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) |
+| Radio buttons | "radio-buttons" | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
+| Text | "text" | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
+| Typeahead | "typeahead" | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
You can add new items to the mapping or replace existing items in order to customize the way
fields are rendered.
@@ -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/form.service.md b/docs/core/services/form.service.md
index dc94c3e709..4d95076b3e 100644
--- a/docs/core/services/form.service.md
+++ b/docs/core/services/form.service.md
@@ -37,42 +37,47 @@ class MyComponent {
### Events
-| Name | Args Type | Description |
-| --------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| formLoaded | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when form has been loaded or reloaded |
-| formFieldValueChanged | [`FormFieldEvent`](../../../lib/core/form/events/form-field.event.ts) | Raised when input values change |
-| taskCompleted | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is completed successfully |
-| taskCompletedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is completed unsuccessfully |
-| taskSaved | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is saved successfully |
-| taskSavedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is saved unsuccessfully |
-| executeOutcome | [`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts) | Raised when a form outcome is executed |
-| formEvents | Event | You can subscribe to this event to listen : ( click, blur, change, focus, focusin, focusout, input, invalid, select) of any elements in the form , see doc below |
-| validateForm | [`ValidateFormEvent`](../../../lib/core/form/events/validate-form.event.ts) | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. |
-| validateFormField | [`ValidateFormFieldEvent`](../../../lib/core/form/events/validate-form-field.event.ts) | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. |
+| Name | Args Type | Description |
+| ---- | --------- | ----------- |
+| formLoaded | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when form has been loaded or reloaded |
+| formFieldValueChanged | [`FormFieldEvent`](../../../lib/core/form/events/form-field.event.ts) | Raised when input values change |
+| taskCompleted | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is completed successfully |
+| taskCompletedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is completed unsuccessfully |
+| taskSaved | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is saved successfully |
+| taskSavedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is saved unsuccessfully |
+| executeOutcome | [`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts) | Raised when a form outcome is executed |
+| formEvents | Event | You can subscribe to this event to listen : ( click, blur, change, focus, focusin, focusout, input, invalid, select) of any elements in the form , see doc below |
+| validateForm | [`ValidateFormEvent`](../../../lib/core/form/events/validate-form.event.ts) | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. |
+| validateFormField | [`ValidateFormFieldEvent`](../../../lib/core/form/events/validate-form-field.event.ts) | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. |
### Methods
- `parseForm(json: any, data?:`[`FormValues,`](../../../lib/core/form/components/widgets/core/form-values.ts)`readOnly: boolean = false):`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)
Parses JSON data to create a corresponding [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) model.
+
- `json` - JSON to create the form
- `data` - (Optional) Values for the form fields
- `readOnly` - Should the form fields be read-only?
- `createFormFromANode(formName: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Create a [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) with a field for each metadata property.
+
- `formName` - Name of the new form
- `createForm(formName: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Create a [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts).
+
- `formName` - Name of the new form
- `saveForm(formId: string, formModel: FormDefinitionModel):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Saves a form.
+
- `formId` - ID of the form to save
- - `formModel` - Model data for the form
+ - `formModel` - [Model](../../../lib/cli/node_modules/@alfresco/js-api/src/api/model-rest-api/model/model.ts) data for the form
- `searchFrom(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Search for a form by name.
+
- `name` - The form name to search for
- `getForms():`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
@@ -83,6 +88,7 @@ class MyComponent {
- `getProcessVariablesById(processInstanceId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`
Get instance variables for a process.
+
- `processInstanceId` - ID of the target process
- `getTasks():`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
@@ -90,89 +96,108 @@ class MyComponent {
- `getTask(taskId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Gets a task.
+
- `taskId` - Task Id
- `saveTaskForm(taskId: string, formValues: FormValues):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Save Task [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts).
+
- `taskId` - Task Id
- `formValues` - [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Values
- `completeTaskForm(taskId: string, formValues:`[`FormValues,`](../../../lib/core/form/components/widgets/core/form-values.ts)`outcome?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Complete Task [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts)
+
- `taskId` - Task Id
- `formValues` - [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Values
- `outcome` - (Optional) [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Outcome
- `getTaskForm(taskId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) related to a taskId
+
- `taskId` - Task Id
- `getFormDefinitionById(formId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) [`Definition`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts)
+
- `formId` - [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Id
- `getFormDefinitionByName(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Returns form definition with a given name.
+
- `name` - The form name
- `getStartFormInstance(processId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Get start form instance for a given processId
+
- `processId` - Process definition ID
- `getProcessInstance(processId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Gets a process instance.
+
- `processId` - ID of the process to get
- `getStartFormDefinition(processId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Get start form definition for a given process
+
- `processId` - Process definition ID
- `getRestFieldValues(taskId: string, field: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Gets values of fields populated by a REST backend.
+
- `taskId` - Task identifier
- `field` - Field identifier
- `getRestFieldValuesByProcessId(processDefinitionId: string, field: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Gets values of fields populated by a REST backend using a process ID.
+
- `processDefinitionId` - Process identifier
- `field` - Field identifier
- `getRestFieldValuesColumnByProcessId(processDefinitionId: string, field: string, column?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Gets column values of fields populated by a REST backend using a process ID.
+
- `processDefinitionId` - Process identifier
- `field` - Field identifier
- `column` - (Optional) Column identifier
- `getRestFieldValuesColumn(taskId: string, field: string, column?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Gets column values of fields populated by a REST backend.
+
- `taskId` - Task identifier
- `field` - Field identifier
- `column` - (Optional) Column identifier
- `getUserProfileImageApi(userId: number): string`
Returns a URL for the profile picture of a user.
+
- `userId` - ID of the target user
- [`getWorkflowUsers(filter: string, groupId?: string): Observable<UserProcessModel[]>`](../../core/models/user-process.model.md)
Gets a list of workflow users.
+
- `filter` - Filter to select specific users
- `groupId` - (Optional) Group ID for the search
- [`getWorkflowGroups(filter: string, groupId?: string): Observable<GroupModel[]>`](../../../lib/core/form/components/widgets/core/group.model.ts)
Gets a list of groups in a workflow.
+
- `filter` - Filter to select specific groups
- `groupId` - (Optional) Group ID for the search
- `getFormId(res: any): string`
Gets the ID of a form.
+
- `res` - Object representing a form
- `toJson(res: any): any`
Creates a JSON representation of form data.
+
- `res` - Object representing form data
- `toJsonArray(res: any): any`
Creates a JSON array representation of form data.
+
- `res` - Object representing form data
- `handleError(error: any):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
diff --git a/docs/core/services/highlight-transform.service.md b/docs/core/services/highlight-transform.service.md
index d49de0a940..b1b79b85db 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)<br/>
+- **highlight**(text: `string`, search: `string`, wrapperClass: `string` = `"adf-highlight"`): [`HighlightTransformResult`](../../../lib/core/services/highlight-transform.service.ts)<br/>
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
@@ -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 2be631bdb8..0dd020bd92 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)`<any>`<br/>
+- **assignRoles**(groupId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` -
-* **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
+ - _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)`<any>` -
+- **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
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)`<boolean>` - 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)`<boolean>`<br/>
+ - _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)`<boolean>` - 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)`<boolean>`<br/>
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)`<boolean>` - True if the group has the client app, false otherwise
-* **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
+ - _groupId:_ `string` - Id of the target group
+ - _clientId:_ `string` - Id of the client
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has the client app, false otherwise
+- **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
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)`<boolean>` - 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)`<any>`<br/>
+ - _groupId:_ `string` - Id of the target group
+ - _roleNames:_ `string[]` - Array of role names
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - 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)`<any>`<br/>
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)`<any>` - Empty response when the group created.
-* **deleteGroup**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _newGroup:_ [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts) - Object of containing the new group details.
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the group created.
+- **deleteGroup**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Deletes Group.
- * *groupId:* `string` - Id of the group.
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`[]>`<br/>
+ - _groupId:_ `string` - Id of the group.
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`<string>`<br/>
+ - _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)`<string>`<br/>
Gets the client Id using the app name.
- * *applicationName:* `string` - Name of the app
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - client Id string
-* **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
+ - _applicationName:_ `string` - Name of the app
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - client Id string
+- **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - **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)`>`<br/>
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)`>`<br/>
+ - **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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` -
-* **updateGroup**(groupId: `string`, updatedGroup: [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _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)`<any>` -
+- **updateGroup**(groupId: `string`, updatedGroup: [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - 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)`<any>` - 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 e8212cba57..6b1a741df7 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)`<any>`<br/>
+- **assignRoles**(userId: `string`, roles: [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - 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)`<any>`<br/>
+ - _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)`<any>` - 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)`<any>`<br/>
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)`<any>` - Empty response when the password changed.
-* **checkUserHasAnyApplicationRole**(userId: `string`, applicationName: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
+ - _userId:_ `string` - Id of the user.
+ - _newPassword:_ [`IdentityUserPasswordModel`](../../../lib/core/services/identity-user.service.ts) -
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the password changed.
+- **checkUserHasAnyApplicationRole**(userId: `string`, applicationName: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
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)`<boolean>` - 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)`<boolean>`<br/>
+ - _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)`<boolean>` - 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)`<boolean>`<br/>
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)`<boolean>` - 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)`<boolean>`<br/>
+ - _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)`<boolean>` - 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)`<boolean>`<br/>
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)`<boolean>` - True if the user has access, false otherwise
-* **checkUserHasClientApp**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
+ - _userId:_ `string` - ID of the user
+ - _applicationName:_ `string` - Name of the application
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has access, false otherwise
+- **checkUserHasClientApp**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
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)`<boolean>` - True if the user has access, false otherwise
-* **checkUserHasRole**(userId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
+ - _userId:_ `string` - ID of the target user
+ - _clientId:_ `string` - ID of the client app
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has access, false otherwise
+- **checkUserHasRole**(userId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
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)`<boolean>` - 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)`<any>`<br/>
+ - _userId:_ `string` - ID of the target user
+ - _roleNames:_ `string[]` - Array of roles to check for
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - 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)`<any>`<br/>
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)`<any>` - Empty response when the user created.
-* **deleteUser**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _newUser:_ [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts) - Object containing the new user details.
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user created.
+- **deleteUser**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Deletes User.
- * *userId:* `string` - Id of the user.
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user deleted.
-* **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
+ - _userId:_ `string` - Id of the user.
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user deleted.
+- **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
Find users based on id input.
- * *id:* `string` - Search query string
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - users object
-* **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
+ - _id:_ `string` - Search query string
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - users object
+- **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`<string>`<br/>
+ - _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)`<string>`<br/>
Gets the client ID for an application.
- * *applicationName:* `string` - Name of the application
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - Client ID string
-* **getClientRoles**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`<br/>
+ - _applicationName:_ `string` - Name of the application
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - Client ID string
+- **getClientRoles**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`<br/>
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)`<any[]>` - List of client roles
-* **getCurrentUserInfo**(): [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)<br/>
+ - _userId:_ `string` - ID of the target user
+ - _clientId:_ `string` - ID of the client app
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - List of client roles
+- **getCurrentUserInfo**(): [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)<br/>
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)`[]>`<br/>
+ - **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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`<number>`<br/>
+ - _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)`<number>`<br/>
Gets users total count.
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<number>` - Number of users count.
-* **getUserRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<number>` - Number of users count.
+- **getUserRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - **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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - Empty response when the user joined the group.
-* **leaveGroup**(userId: `any`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _joinGroupRequest:_ [`IdentityJoinGroupRequestModel`](../../../lib/core/services/identity-user.service.ts) - Details of join group request (IdentityJoinGroupRequestModel).
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the user joined the group.
+- **leaveGroup**(userId: `any`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Leaves group.
- * *userId:* `any` - Id of the user.
- * *groupId:* `string` - Id of the group.
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
+ - _userId:_ `any` - Id of the user.
+ - _groupId:_ `string` - Id of the group.
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - 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)`<any>`<br/>
+ - _userId:_ `string` - Id of the user.
+ - _removedRoles:_ [`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]` -
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`<any>`<br/>
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)`<any>` - 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)`<any>` - 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 7c4c3b66c1..182c7b3463 100644
--- a/docs/core/services/jwt-helper.service.md
+++ b/docs/core/services/jwt-helper.service.md
@@ -13,45 +13,45 @@ Decodes a JSON Web Token (JWT) to a JavaScript object.
### Methods
-* **decodeToken**(token: `any`): `Object`<br/>
+- **decodeToken**(token: `any`): `Object`<br/>
Decodes a JSON web token into a JS object.
- * *token:* `any` - Token in encoded form
- * **Returns** `Object` - Decoded token data object
-* **getAccessToken**(): `string`<br/>
+ - _token:_ `any` - Token in encoded form
+ - **Returns** `Object` - Decoded token data object
+- **getAccessToken**(): `string`<br/>
Gets access token
- * **Returns** `string` - access token
-* **getClientRoles**(clientName: `string`): `string[]`<br/>
+ - **Returns** `string` - access token
+- **getClientRoles**(clientName: `string`): `string[]`<br/>
Gets Client roles.
- * *clientName:* `string` -
- * **Returns** `string[]` - Array of client roles
-* **getRealmRoles**(): `string[]`<br/>
+ - _clientName:_ `string` -
+ - **Returns** `string[]` - Array of client roles
+- **getRealmRoles**(): `string[]`<br/>
Gets realm roles.
- * **Returns** `string[]` - Array of realm roles
-* **getValueFromLocalAccessToken**(key: `string`)<br/>
+ - **Returns** `string[]` - Array of realm roles
+- **getValueFromLocalAccessToken**(key: `string`)<br/>
Gets a named value from the user access token.
- * *key:* `string` - Key name of the field to retrieve
-* **getValueFromToken**(accessToken: `string`, key: `string`)<br/>
+ - _key:_ `string` - Key name of the field to retrieve
+- **getValueFromToken**(accessToken: `string`, key: `string`)<br/>
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`<br/>
+ - _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`<br/>
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`<br/>
+ - _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`<br/>
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`<br/>
+ - _role:_ `string` - Role name to check
+ - **Returns** `boolean` - True if it contains given role, false otherwise
+- **hasRealmRoles**(rolesToCheck: `string[]`): `boolean`<br/>
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`<br/>
+ - _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`<br/>
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 2e2b5e8139..9b6f629851 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[]`)<br/>
+- **assert**(test?: `boolean`, message?: `string`, optionalParams: `any[]`)<br/>
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[]`)<br/>
+ - _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[]`)<br/>
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[]`)<br/>
+ - _message:_ `any` - (Optional) Message to log
+ - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
+- **error**(message?: `any`, optionalParams: `any[]`)<br/>
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)<br/>
+ - _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)<br/>
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[]`)<br/>
+ - _level:_ `string` - Level name
+ - **Returns** [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts) - Numeric log level
+- **group**(groupTitle?: `string`, optionalParams: `any[]`)<br/>
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**()<br/>
+ - _groupTitle:_ `string` - (Optional) Title shown at the start of the group
+ - _optionalParams:_ `any[]` - Interpolation values for the title in "printf" format
+- **groupEnd**()<br/>
Ends a indented group of log messages.
-* **info**(message?: `any`, optionalParams: `any[]`)<br/>
+- **info**(message?: `any`, optionalParams: `any[]`)<br/>
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[]`)<br/>
+ - _message:_ `any` - (Optional) Message to log
+ - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
+- **log**(message?: `any`, optionalParams: `any[]`)<br/>
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`)<br/>
+ - _message:_ `any` - (Optional) Message to log
+ - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
+- **messageBus**(text: `string`, logLevel: `string`)<br/>
Triggers notification callback for log messages.
- * *text:* `string` - Message text
- * *logLevel:* `string` - Log level for the message
-* **trace**(message?: `any`, optionalParams: `any[]`)<br/>
+ - _text:_ `string` - Message text
+ - _logLevel:_ `string` - Log level for the message
+- **trace**(message?: `any`, optionalParams: `any[]`)<br/>
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[]`)<br/>
+ - _message:_ `any` - (Optional) Message to log
+ - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
+- **warn**(message?: `any`, optionalParams: `any[]`)<br/>
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
@@ -101,16 +101,16 @@ export class AppComponent {
There are 6 levels of logs that you can use:
-| Name | Level |
-| ------ | ----- |
-| TRACE | 5 |
-| DEBUG | 4 |
-| INFO | 3 |
-| WARN | 2 |
-| ERROR | 1 |
-| SILENT | 0 |
+| Name | Level |
+| ---- | ----- |
+| TRACE | 5 |
+| DEBUG | 4 |
+| INFO | 3 |
+| WARN | 2 |
+| 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:
diff --git a/docs/core/services/node.service.md b/docs/core/services/node.service.md
index c1b2c8722a..72728f319b 100644
--- a/docs/core/services/node.service.md
+++ b/docs/core/services/node.service.md
@@ -15,25 +15,25 @@ Gets Alfresco Repository node metadata and creates nodes with metadata.
### 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)`>`<br/>
- (**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)`>`<br/>
- (**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)`>`<br/>
- (**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)`>`<br/>
+ (**Deprecated:** in 3.8.0, use `createNodeInsideRoot` method from NodesApiService instead. Create a new Node from form metadata)
+ - _name:_ `string` - Node name
+ - _nodeType:_ `string` - Node type
+ - _properties:_ `any` - Node 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)`>`<br/>
+ (**Deprecated:** in 3.8.0, use NodesApiService instead. Create a new Node from form metadata.)
+ - _nodeType:_ `string` - Node 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 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)`>`<br/>
+ (**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 058cccc930..cdcf0ed30b 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)`>`<br/>
+- **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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _name:_ `string` - Node name
+ - _nodeType:_ `string` - Node type
+ - _properties:_ `any` - Node 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)`>`<br/>
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)`<any>`<br/>
+ - _nodeType:_ `string` - Node 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 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)`<any>`<br/>
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)`<any>` - 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)`>`<br/>
+ - _nodeId:_ `string` - ID of the target node
+ - _options:_ `any` - Optional parameters supported by JS-API
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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
@@ -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 6a0f1e166c..637ff52a08 100644
--- a/docs/core/services/notification.service.md
+++ b/docs/core/services/notification.service.md
@@ -15,39 +15,43 @@ Shows a notification message with optional feedback.
### Methods
-* **dismissSnackMessageAction**()<br/>
+- **dismissSnackMessageAction**(): `any`<br/>
dismiss the notification snackbar
-* **openSnackMessage**(message: `string`, config?: `number|MatSnackBarConfig`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
+ - **Returns** `any` -
+- **openSnackMessage**(message: `string`, config?: `number|MatSnackBarConfig`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
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)`<any>` - 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)`<any>`<br/>
+ - _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)`<any>` - 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)`<any>`<br/>
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)`<any>` - Information/control object for the SnackBar
-* **showError**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
+ - _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)`<any>` - Information/control object for the SnackBar
+- **pushToNotificationHistory**(notification: [`NotificationModel`](../../../lib/core/notifications/models/notification.model.ts))<br/>
+ Push new notification to Notification History
+ - _notification:_ [`NotificationModel`](../../../lib/core/notifications/models/notification.model.ts) - Notification model to be pushed.
+- **showError**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
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)`<any>` -
-* **showInfo**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
+ - _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)`<any>` -
+- **showInfo**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
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)`<any>` -
-* **showWarning**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
+ - _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)`<any>` -
+- **showWarning**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
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)`<any>` -
+ - _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)`<any>` -
## Details
@@ -123,9 +127,9 @@ You can also change the default 5000 ms adding the following configuration in th
#### Notification types
-| Name | Description |
-| --- | --- |
+| Name | Description |
+| ---- | ----------- |
| info | To notify messages. It will be displayed with an info icon next to it. |
| warn | To notify warning messages. It will be displayed with a warning icon next to it. |
| error | To notify errors. It will be displayed with an error icon next to it. |
-| recursive | To notify recursive messages. If a message is prompt to duplicate an existing notification and you don't want to overload the notification history component with the same message use the recursive type. I.e. notifications coming from an API call that are triggered every time a component is initialized. It will be displayed with an info icon next to it. |
+| recursive | To notify recursive messages. If a message is prompt to duplicate an existing notification and you don't want to overload the [notification history component](../../core/components/notification-history.component.md) with the same message use the recursive type. I.e. notifications coming from an API call that are triggered every time a component is initialized. It will be displayed with an info icon next to it. |
diff --git a/docs/core/services/page-title.service.md b/docs/core/services/page-title.service.md
index ba4812f008..428e9bfbb3 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` = `""`)<br/>
+- **setTitle**(value: `string` = `""`)<br/>
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 73b52e5c2d..f6764d7060 100644
--- a/docs/core/services/people-content.service.md
+++ b/docs/core/services/people-content.service.md
@@ -13,13 +13,13 @@ Gets information about a Content Services user.
### Methods
-* **getCurrentPerson**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+- **getCurrentPerson**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets information about the user who is currently logged in.
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - User information
-* **getPerson**(personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - User information
+- **getPerson**(personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets information about a user identified by their username.
- * *personId:* `string` - ID of the target user
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - User information
+ - _personId:_ `string` - ID of the target user
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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 ff70a4835c..10a4a3abbf 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`<br/>
+- **getUserImage**(user: [`UserProcessModel`](../../core/models/user-process.model.md)): `string`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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 73d895d81c..9554b2932a 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)`<any>`<br/>
+- **createProcessRelatedContent**(processInstanceId: `string`, content: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Details of created content
-* **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _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)`<any>` - Details of created content
+- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): `any`<br/>
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)`<any>` - Details of created content
-* **createTemporaryRawRelatedContent**(file: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`<br/>
+ - _taskId:_ `string` - ID of the target task
+ - _file:_ `any` - File to associate
+ - _opts:_ `any` - (Optional) Options supported by JS-API
+ - **Returns** `any` - Details of created content
+- **createTemporaryRawRelatedContent**(file: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
Deletes related content.
- * *contentId:* `number` - Identifier of the content to delete
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
+ - _contentId:_ `number` - Identifier of the content to delete
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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`<br/>
+ - _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`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - Metadata for the content
-* **getTaskRelatedContent**(taskId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _processId:_ `string` - ID of the target process
+ - _opts:_ `any` - (Optional) Options supported by JS-API
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Metadata for the content
+- **getTaskRelatedContent**(taskId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Metadata for the content
-* **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _taskId:_ `string` - ID of the target task
+ - _opts:_ `any` - (Optional) Options supported by JS-API
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Metadata for the content
+- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Callback when an error occurs
-* **toJson**(res: `any`): `any`<br/>
+ - _error:_ `any` - Data object with optional `message` and `status` fields for the error
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Callback when an error occurs
+- **toJson**(res: `any`): `any`<br/>
Creates a JSON representation of data.
- * *res:* `any` - Object representing data
- * **Returns** `any` - JSON object
-* **toJsonArray**(res: `any`): `any`<br/>
+ - _res:_ `any` - Object representing data
+ - **Returns** `any` - JSON object
+- **toJsonArray**(res: `any`): `any`<br/>
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
@@ -120,7 +120,7 @@ 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.\
+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:
@@ -277,7 +277,7 @@ See `getProcessRelatedContent` and `getTaskRelatedContent` for how to get to the
#### getContentPreview(contentId: number): Observable`<Blob>`
-Get the preview file for a related content file. A content file might be for example a\
+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:
@@ -299,7 +299,7 @@ See `getProcessRelatedContent` and `getTaskRelatedContent` for how to get to the
#### getContentThumbnail(contentId: number): Observable`<Blob>`
-Get the thumbnail file for a related content file. A content file might be for example a\
+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:
diff --git a/docs/core/services/renditions.service.md b/docs/core/services/renditions.service.md
index d1b9aea90f..9fde5ac7dd 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)`>`<br/>
+- **convert**(nodeId: `string`, encoding: `string`, pollingInterval: `number` = `1000`, retries: `number` = `5`): `any`<br/>
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)`<Function>`<br/>
+ - _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** `any` - True if the rendition was created, false otherwise
+- **createRendition**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<__type>`<br/>
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)`<Function>` - Null response to indicate completion
-* **generateRenditionForNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _nodeId:_ `string` - ID of the target node
+ - _encoding:_ `string` - Name of the rendition encoding
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<__type>` - Null response to indicate completion
+- **generateRenditionForNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - 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)`>`<br/>
+ - _nodeId:_ `string` - ID of the target node
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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`<br/>
+ - _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`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`<boolean>`<br/>
+ - _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)`<boolean>`<br/>
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)`<boolean>` - True if the node can be converted, false otherwise
-* **isRenditionAvailable**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
+ - _nodeId:_ `string` - ID of the target node
+ - _encoding:_ `string` - Name of the rendition encoding
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the node can be converted, false otherwise
+- **isRenditionAvailable**(nodeId: `string`, encoding: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
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)`<boolean>` - 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)`<boolean>` - 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 28453e8058..008e8e0bba 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`<br/>
+- **generateQueryBody**(searchTerm: `string`, maxResults: `number`, skipCount: `number`): `QueryBody`<br/>
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 a810c762b7..dd6052af30 100644
--- a/docs/core/services/search.service.md
+++ b/docs/core/services/search.service.md
@@ -13,21 +13,21 @@ 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)`>`<br/>
+- **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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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
@@ -41,4 +41,4 @@ 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 4f4e93e67d..073cdd78da 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)`>`<br/>
+- **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)`>`<br/>
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)`<any|Error>`<br/>
+ - _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)`<any|Error>`<br/>
Deletes a shared link.
- * *sharedId:* `string` - ID of the link to delete
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any|Error>` - 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)`>`<br/>
+ - _sharedId:_ `string` - ID of the link to delete
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any|Error>` - 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)`>`<br/>
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 f00733631d..35fd00a480 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)`>`<br/>
+- **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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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<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)`>`<br/>
+ - _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)`>`<br/>
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<SiteMemberEntry>
-* **deleteSite**(siteId: `string`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - Null response notifying when the operation is complete
-* **deleteSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
+ - _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)`<any>` - Null response notifying when the operation is complete
+- **deleteSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
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)`<void>` - Observable<void>
-* **deleteSiteMembership**(siteId: `string`, personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
+ - _siteId:_ `string` - The identifier of a site.
+ - _groupId:_ `string` - The authorityId of a group.
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - [`Observable`](http://reactivex.io/documentation/observable.html)<void>
+- **deleteSiteMembership**(siteId: `string`, personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
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)`<void>` - Null response notifying when the operation is complete
-* **getEcmCurrentLoggedUserName**(): `string`<br/>
+ - _siteId:_ `string` - The identifier of a site.
+ - _personId:_ `string` - The identifier of a person.
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - Null response notifying when the operation is complete
+- **getEcmCurrentLoggedUserName**(): `string`<br/>
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>`<br/>
+ - **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)`|__type>`<br/>
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>`<br/>
+ - _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)`|__type>` - 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)`|__type>`<br/>
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)`>`<br/>
+ - _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)`|__type>` - 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)`>`<br/>
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<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>`<br/>
+ - _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)`|__type>`<br/>
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)`>`<br/>
+ - _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)`|__type>` - 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)`>`<br/>
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`<br/>
- 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)`>`<br/>
+ - _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`<br/>
+ Looks for a site inside the path of a Node 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 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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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<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)`>`<br/>
+ - _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)`>`<br/>
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<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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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<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)`>`<br/>
+ - _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)`>`<br/>
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<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](http://reactivex.io/documentation/observable.html)<SiteMemberEntry>
## Details
diff --git a/docs/core/services/storage.service.md b/docs/core/services/storage.service.md
index 916947e6a6..1e3ec13d2a 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**()<br/>
+- **clear**()<br/>
Removes all currently stored items.
-* **getItem**(key: `string`): `string|null`<br/>
+- **getItem**(key: `string`): `string|null`<br/>
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`<br/>
+ - _key:_ `string` - Key to identify the item
+ - **Returns** `string|null` - The item (if any) retrieved by the key
+- **hasItem**(key: `string`): `boolean`<br/>
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`)<br/>
+ - _key:_ `string` - Key identifying item to check
+ - **Returns** `boolean` - True if key retrieves an item, false otherwise
+- **removeItem**(key: `string`)<br/>
Removes a single item.
- * *key:* `string` - Key to identify the item
-* **setItem**(key: `string`, data: `string`)<br/>
+ - _key:_ `string` - Key to identify the item
+- **setItem**(key: `string`, data: `string`)<br/>
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
@@ -69,5 +69,5 @@ The storagePrefix can allow you to login with multiple user in the same browser
## 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 4b1a905bd7..8b894cc639 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`<br/>
+- **getDefaultMimeTypeIcon**(): `string`<br/>
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`<br/>
+ - **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`<br/>
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`<br/>
+ - _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`<br/>
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
@@ -33,22 +33,22 @@ The service can locate a thumbnail icon (in SVG format) for either
a document node or a MIME type. The default mapping between types
and icons is shown in the table below:
-| Document | Icon | Types |
-| -------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Compressed archive |  | 'application/x-compressed', 'application/x-zip-compressed', 'application/zip' |
-| Text |  | 'text/plain', 'application/json', 'application/x-javascript', 'application/vnd.apple.pages' |
-| Bitmap/raster image |  | 'image/png', 'image/jpeg', 'image/gif' |
-| MP4 video |  | 'video/mp4' |
-| SVG vector image |  | 'image/svg+xml' |
-| HTML file |  | 'text/html' |
-| PDF file |  | 'application/pdf' |
-| Folder |  | |
-| Disabled folder |  | |
-| Excel spreadsheet |  | 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.openxmlformats-officedocument.spreadsheetml.template' |
-| PowerPoint slideshow |  | 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.openxmlformats-officedocument.presentationml.template', 'application/vnd.openxmlformats-officedocument.presentationml.slideshow' |
-| Word document |  | 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' |
-| Keynote presentation |  | 'application/vnd.apple.keynote' |
-| Numbers spreadsheet |  | 'application/vnd.apple.numbers' |
+| Document | Icon | Types |
+| -------- | ---- | ----- |
+| Compressed archive |  | 'application/x-compressed', 'application/x-zip-compressed', 'application/zip' |
+| Text |  | 'text/plain', 'application/json', 'application/x-javascript', 'application/vnd.apple.pages' |
+| Bitmap/raster image |  | 'image/png', 'image/jpeg', 'image/gif' |
+| MP4 video |  | 'video/mp4' |
+| SVG vector image |  | 'image/svg+xml' |
+| HTML file |  | 'text/html' |
+| PDF file |  | 'application/pdf' |
+| Folder |  | |
+| Disabled folder |  | |
+| Excel spreadsheet |  | 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.openxmlformats-officedocument.spreadsheetml.template' |
+| PowerPoint slideshow |  | 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.openxmlformats-officedocument.presentationml.template', 'application/vnd.openxmlformats-officedocument.presentationml.slideshow' |
+| Word document |  | 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' |
+| Keynote presentation |  | 'application/vnd.apple.keynote' |
+| Numbers spreadsheet |  | 'application/vnd.apple.numbers' |
### Mat-icon
@@ -71,4 +71,4 @@ GIF <mat-icon svgIcon="image/gif"></mat-icon>
## 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 c4bd61657c..884a07958b 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` = `""`)<br/>
+- **addTranslationFolder**(name: `string` = `""`, path: `string` = `""`)<br/>
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<string>`, interpolateParams?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string|any>`<br/>
+ - _name:_ `string` - Name for the translation provider
+ - _path:_ `string` - Path to the folder
+- **get**(key: `string|Array<string>`, interpolateParams?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string|any>`<br/>
Gets the translation for the supplied key.
- * *key:* `string|Array<string>` - Key to translate
- * *interpolateParams:* `Object` - (Optional) String(s) to be interpolated into the main message
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string|any>` - Translated text
-* **instant**(key: `string|Array<string>`, interpolateParams?: `Object`): `string|any`<br/>
+ - _key:_ `string|Array<string>` - Key to translate
+ - _interpolateParams:_ `Object` - (Optional) String(s) to be interpolated into the main message
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string|any>` - Translated text
+- **instant**(key: `string|Array<string>`, interpolateParams?: `Object`): `string|any`<br/>
Directly returns the translation for the supplied key.
- * *key:* `string|Array<string>` - 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`)<br/>
+ - _key:_ `string|Array<string>` - 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`)<br/>
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`)<br/>
+ - _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`)<br/>
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)`<any>`<br/>
+ - _lang:_ `string` - The new language code
+- **use**(lang: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Sets the target language for translations.
- * *lang:* `string` - Code name for the language
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Translations available for the language
+ - _lang:_ `string` - Code name for the language
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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 72747875ec..6f9c8db8b8 100644
--- a/docs/core/services/upload.service.md
+++ b/docs/core/services/upload.service.md
@@ -13,43 +13,43 @@ 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)`[]`<br/>
+- **addToQueue**(files: [`FileModel`](../../../lib/core/models/file.model.ts)`[]`): [`FileModel`](../../../lib/core/models/file.model.ts)`[]`<br/>
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)`[]`)<br/>
+ - _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)`[]`)<br/>
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**()<br/>
+ - _files:_ [`FileModel`](../../../lib/core/models/file.model.ts)`[]` - One or more separate parameters or an array of files specifying uploads to cancel
+- **clearQueue**()<br/>
Clears the upload queue
-* **getQueue**(): [`FileModel`](../../../lib/core/models/file.model.ts)`[]`<br/>
+- **getQueue**(): [`FileModel`](../../../lib/core/models/file.model.ts)`[]`<br/>
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`<br/>
+ - **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`<br/>
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`<br/>
- 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)`<any>`)<br/>
+ - _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`<br/>
+ Checks whether the service still has files uploading or awaiting upload.
+ - **Returns** `boolean` - True if files in the queue are still uploading, false otherwise
+- **uploadFilesInTheQueue**(emitter?: [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>`)<br/>
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)`<any>` - (Optional) Emitter to invoke on file status change
+ - _emitter:_ [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` - (Optional) Emitter to invoke on file status change
## Events
-| Name | Type | Description |
-| ------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
-| queueChanged | [`FileModel`](../../../lib/core/models/file.model.ts)\[] | Emitted when the file queue changes. |
-| fileUpload | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when a [File model](../../../lib/core/models/file.model.ts) changes its state. |
-| fileUploadStarting | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an upload starts. |
-| fileUploadCancelled | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an upload gets cancelled by the user. |
-| fileUploadProgress | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted during the file upload process and contains the current progress for a particular [File model](../../../lib/core/models/file.model.ts). |
-| fileUploadAborted | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when a file upload gets aborted by the server. |
-| fileUploadError | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an error occurs during a file upload. |
-| fileUploadComplete | [`FileUploadCompleteEvent`](../../../lib/core/events/file.event.ts) | Emitted when a file upload is complete. |
-| fileUploadDelete | [`FileUploadDeleteEvent`](../../../lib/core/events/file.event.ts) | Emitted when an uploaded file is removed from server. |
-| fileDeleted | string | This can be invoked when a file is deleted from an external source to upload the file dialog status. |
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| queueChanged | [`FileModel`](../../../lib/core/models/file.model.ts)\[] | Emitted when the file queue changes. |
+| fileUpload | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when a [File model](../../../lib/core/models/file.model.ts) changes its state. |
+| fileUploadStarting | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an upload starts. |
+| fileUploadCancelled | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an upload gets cancelled by the user. |
+| fileUploadProgress | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted during the file upload process and contains the current progress for a particular [File model](../../../lib/core/models/file.model.ts). |
+| fileUploadAborted | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when a file upload gets aborted by the server. |
+| fileUploadError | [`FileUploadEvent`](../../../lib/core/events/file.event.ts) | Emitted when an error occurs during a file upload. |
+| fileUploadComplete | [`FileUploadCompleteEvent`](../../../lib/core/events/file.event.ts) | Emitted when a file upload is complete. |
+| fileUploadDelete | [`FileUploadDeleteEvent`](../../../lib/core/events/file.event.ts) | Emitted when an uploaded file is removed from server. |
+| fileDeleted | string | This can be invoked when a file is deleted from an external source to upload the file dialog status. |
## Details
diff --git a/docs/core/services/user-preferences.service.md b/docs/core/services/user-preferences.service.md
index a7a579f7cb..4543aaacdd 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`<br/>
+- **get**(property: `string`, defaultValue?: `string`): `string`<br/>
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`<br/>
+ - _property:_ `string` - Name of the property
+ - _defaultValue:_ `string` - (Optional) Default to return if the property is not found
+ - **Returns** `string` - Preference property
+- **getDefaultLocale**(): `string`<br/>
Gets the default locale.
- * **Returns** `string` - Default locale language code
-* **getPropertyKey**(property: `string`): `string`<br/>
+ - **Returns** `string` - Default locale language code
+- **getPropertyKey**(property: `string`): `string`<br/>
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`<br/>
+ - _property:_ `string` - The property name
+ - **Returns** `string` - [Property](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) key
+- **getStoragePrefix**(): `string`<br/>
Gets the active storage prefix for preferences.
- * **Returns** `string` - Storage prefix
-* **hasItem**(property: `string`): `boolean`<br/>
+ - **Returns** `string` - Storage prefix
+- **hasItem**(property: `string`): `boolean`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - Notification callback
-* **set**(property: `string`, value: `any`)<br/>
+ - _property:_ `string` - The property to watch
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Notification callback
+- **set**(property: `string`, value: `any`)<br/>
Sets a preference property.
- * *property:* `string` - Name of the property
- * *value:* `any` - New value for the property
-* **setStoragePrefix**(value: `string`)<br/>
+ - _property:_ `string` - Name of the property
+ - _value:_ `any` - New value for the property
+- **setStoragePrefix**(value: `string`)<br/>
Sets the active storage prefix for preferences.
- * *value:* `string` - Name of the prefix
-* **setWithoutStore**(property: `string`, value: `any`)<br/>
+ - _value:_ `string` - Name of the prefix
+- **setWithoutStore**(property: `string`, value: `any`)<br/>
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
@@ -92,12 +92,12 @@ class AppComponent {
The service also provides quick access to a set of the "known" properties used across ADF components:
-| Name | Type | Description |
-| -------------- | --------- | -------------------------------------------------------------------------------------------------- |
-| authType | `string` | Authorization type (can be "ECM", "BPM" or "ALL"). |
-| disableCSRF | `boolean` | Prevents the CSRF Token from being submitted if true. Only valid for Process Services. |
-| paginationSize | `number` | [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) size. |
-| locale | `string` | Current locale setting. |
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| authType | `string` | Authorization type (can be "ECM", "BPM" or "ALL"). |
+| disableCSRF | `boolean` | Prevents the CSRF Token from being submitted if true. Only valid for Process Services. |
+| paginationSize | `number` | [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) size. |
+| locale | `string` | Current locale setting. |
## User Preference onChange Stream
diff --git a/docs/core/widgets/content.widget.md b/docs/core/widgets/content.widget.md
index b971d5f6c4..bece9550c9 100644
--- a/docs/core/widgets/content.widget.md
+++ b/docs/core/widgets/content.widget.md
@@ -21,15 +21,15 @@ Shows the content preview.
### Properties
| 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)`<any>` | Emitted when the content is clicked. |
+| ---- | ---- | ----------- |
+| contentClick | `any` | Emitted when the content is clicked. |
| contentLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the content has loaded. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| thumbnailLoaded | `EventEmitter<any>` | Emitted when the thumbnail has loaded. |
+| thumbnailLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the thumbnail has loaded. |
diff --git a/docs/extensions/components/dynamic.component.md b/docs/extensions/components/dynamic.component.md
index 8bb4fd6209..af4ad4f28a 100644
--- a/docs/extensions/components/dynamic.component.md
+++ b/docs/extensions/components/dynamic.component.md
@@ -14,7 +14,7 @@ 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. |
@@ -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 050f99efae..369af0bc06 100644
--- a/docs/extensions/components/preview-extension.component.md
+++ b/docs/extensions/components/preview-extension.component.md
@@ -17,10 +17,10 @@ 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. |
+| node | `Node` | | Node 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 2a0588c1a3..a97ba3a96f 100644
--- a/docs/extensions/services/extension.service.md
+++ b/docs/extensions/services/extension.service.md
@@ -13,64 +13,65 @@ Manages and runs basic extension functionality.
### Methods
-* **evaluateRule**(ruleId: `string`, context?: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`<br/>
+- **evaluateRule**(ruleId: `string`, context?: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`<br/>
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)<br/>
+ - _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)<br/>
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<Type<Function>>`<br/>
+ - _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<Type<__type>>`<br/>
Retrieves one or more auth guards using an array of ID values.
- * *ids:* `string[]` - Array of ID value to look for
- * **Returns** `Array<Type<Function>>` - Array of auth guards or empty array if none were found
-* **getComponentById**(id: `string`): `Type<>`<br/>
+ - _ids:_ `string[]` - Array of ID value to look for
+ - **Returns** `Array<Type<__type>>` - Array of auth guards or empty array if none were found
+- **getComponentById**(id: `string`): `any`<br/>
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<>`<br/>
+ - _id:_ `string` - The ID value to look for
+ - **Returns** `any` - The component or null if not found
+- **getElements**(key: `string`, fallback: `Array<>` = `[]`): `Array<>`<br/>
- * *key:* `string` -
- * *fallback:* `Array<>` -
- * **Returns** `Array<>` -
-* **getEvaluator**(key: `string`): [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts)<br/>
+ - _key:_ `string` -
+ - _fallback:_ `Array<>` -
+ - **Returns** `Array<>` -
+
+- **getEvaluator**(key: `string`): [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts)<br/>
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[]`<br/>
+ - _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[]`<br/>
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)<br/>
+ - _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)<br/>
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)<br/>
+ - _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)<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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`<br/>
+ - **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|__type`, context?: `any`): `Function`<br/>
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`)<br/>
+ - _value:_ `string|__type` - 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`)<br/>
Adds one or more new auth guards to the existing set.
- * *values:* `Function` - The new auth guards to add
-* **setComponents**(values: `Function`)<br/>
+ - _values:_ `Function` - The new auth guards to add
+- **setComponents**(values: `Function`)<br/>
Adds one or more new components to the existing set.
- * *values:* `Function` - The new components to add
-* **setEvaluators**(values: `Function`)<br/>
+ - _values:_ `Function` - The new components to add
+- **setEvaluators**(values: `Function`)<br/>
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))<br/>
+ - _values:_ `Function` - The new evaluators to add
+- **setup**(config: [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts))<br/>
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/getting-started.md b/docs/getting-started.md
index 9bd89cf858..55eb603594 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -3,18 +3,15 @@ Title: Getting started (as developer) with Alfresco ADF-based applications
Level: Basic
---
-In this tutorial you are going to learn how to launch a fully-featured ADF-based application on your development environment, starting from the source code, with the purpose to have a first experience with the development principles and the best practices suggested to create front-end applications working on top of the Alfresco backend services.
-
-The stack chosen for this initial task is the Open Source version of the front-end application. In the bonus section you can try the same exercise with the Enterprise version (available for Alfresco customers and partners only).
-
# Prerequisites and requirements
The first thing to do is to check the prerequisites and the requirements to run the front-end application directly into a development environment.
More in particular check that you have:
-- Alfresco Content Services (alias ACS) Community or Enterprise edition up and running (identify the URL that will be required as configuration).
-- The latest lts version of NodeJs.
-- A recent (and supported) version of a browser (see here for further details).
+
+- Alfresco Content Services (alias ACS) Community or Enterprise edition up and running (identify the URL that will be required as configuration).
+- The latest lts version of NodeJs.
+- A recent (and supported) version of a browser (see here for further details).
# Cloning and launching the front-end application
@@ -26,7 +23,7 @@ Once done, enter the alfresco-content-app folder and create a file named .env wi
`API_CONTENT_HOST="https://..."`
-Run `npm install` and then `npm start` to get the application up and running. The application will be available at the URL http://localhost:4200 and the credentials are the ones required by ACS.
+Run `npm install` and then `npm start` to get the application up and running. The application will be available at the URL <http://localhost:4200> and the credentials are the ones required by ACS.
Congratulations! You now have the Alfresco Content App running in development mode into your development environment.
@@ -36,7 +33,6 @@ If you have any issue, don’t worry! There is an entire community available to
In case of problems raise a question into the [Alfresco Forum](https://hub.alfresco.com/ "https://hub.alfresco.com/") (Application Development Framework section) or connect with the developers into the [Alfresco Gitter channel](https://alfresco.atlassian.net/wiki/spaces/PM/overview "https://alfresco.atlassian.net/wiki/spaces/PM/overview").
-
# Bonus: Use the Enterprise stack instead of the Open Source
If you are an Alfresco Customer or an Official Partner, you might be interested in using the Enterprise stack instead of the Open Source introduced above. The changes to the tasks are not too many and you can try to do the same exercise with the following changes.
@@ -47,10 +43,10 @@ If you are an Alfresco Customer or an Official Partner, you might be interested
AUTH_TYPE="BASIC"
PROVIDER="ECM"
- API_CONTENT_HOST="https://..."
- API_PROCESS_HOST="https://..."
- OAUTH_HOST="https://.../auth/realms/alfresco"
- E2E_HOST="http://localhost:4200"
+ API_CONTENT_HOST="<https://...>"
+ API_PROCESS_HOST="<https://...>"
+ OAUTH_HOST="<https://.../auth/realms/alfresco>"
+ E2E_HOST="<http://localhost:4200>"
ADMIN_EMAIL="..."
ADMIN_PASSWORD="..."
ADF_PATH="../alfresco-ng2-components"
diff --git a/docs/insights/components/analytics-generator.component.md b/docs/insights/components/analytics-generator.component.md
index 39cc72dbf3..05c676fe6f 100644
--- a/docs/insights/components/analytics-generator.component.md
+++ b/docs/insights/components/analytics-generator.component.md
@@ -22,13 +22,13 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | error. |
-| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | success. |
+| ---- | ---- | ----------- |
+| error | `any` | error. |
+| success | `any` | success. |
diff --git a/docs/insights/components/analytics-report-list.component.md b/docs/insights/components/analytics-report-list.component.md
index 93278decba..aab11bd577 100644
--- a/docs/insights/components/analytics-report-list.component.md
+++ b/docs/insights/components/analytics-report-list.component.md
@@ -21,7 +21,7 @@ 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. |
@@ -29,7 +29,7 @@ Shows a list of all available reports
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | error. |
+| ---- | ---- | ----------- |
+| error | `any` | 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<any>` | success. |
+| success | `any` | success. |
diff --git a/docs/insights/components/analytics.component.md b/docs/insights/components/analytics.component.md
index d3f15b184a..2482cab47e 100644
--- a/docs/insights/components/analytics.component.md
+++ b/docs/insights/components/analytics.component.md
@@ -24,7 +24,7 @@ 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. |
@@ -32,7 +32,7 @@ Shows the charts related to the reportId passed as input
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | emitted when editReport. |
-| reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | emitted when reportDeleted. |
-| reportSaved | `EventEmitter<any>` | emitted when reportSaved. |
+| ---- | ---- | ----------- |
+| editReport | `any` | emitted when editReport. |
+| reportDeleted | `any` | emitted when reportDeleted. |
+| reportSaved | `any` | emitted when reportSaved. |
diff --git a/docs/insights/components/diagram.component.md b/docs/insights/components/diagram.component.md
index fe2ac45619..49e34f67e3 100644
--- a/docs/insights/components/diagram.component.md
+++ b/docs/insights/components/diagram.component.md
@@ -31,7 +31,7 @@ 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. |
@@ -43,6 +43,6 @@ The below component shows the diagram of a running process instance with the act
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | error. |
-| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | success. |
+| ---- | ---- | ----------- |
+| error | `any` | error. |
+| success | `any` | success. |
diff --git a/docs/insights/components/widget.component.md b/docs/insights/components/widget.component.md
index 722012fe33..10e9d712d3 100644
--- a/docs/insights/components/widget.component.md
+++ b/docs/insights/components/widget.component.md
@@ -29,13 +29,13 @@ export class CustomEditorComponent extends WidgetComponent {}
### Properties
| Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
| field | `any` | | field. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 18ea2cfd13..692c1d8ecb 100644
--- a/docs/process-services-cloud/components/app-list-cloud.component.md
+++ b/docs/process-services-cloud/components/app-list-cloud.component.md
@@ -46,11 +46,11 @@ 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". |
### Events
| 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. |
+| ---- | ---- | ----------- |
+| appClick | `any` | 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 7d604ce968..f67ecaa8b9 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
@@ -42,7 +42,7 @@ 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 |
@@ -52,13 +52,14 @@ Shows/edits process filter details.
| 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. |
+| processFilter | [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) | | |
### 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<ProcessFilterCloudModel>` | Emitted when a process instance filter property changes. |
+| ---- | ---- | ----------- |
+| action | `any` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. |
+| filterChange | `any` | Emitted when a process instance filter property changes. |
## Details
@@ -75,28 +76,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) |
+| 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) |
-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 +130,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 +167,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. |
+| Name | Description |
+| ---- | ----------- |
+| **_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 {
@@ -207,13 +208,13 @@ With this configuration, only the two actions will be shown.
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 c2a77f1159..2729de779a 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
@@ -42,7 +42,7 @@ 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. |
@@ -56,9 +56,9 @@ Edits task filter details.
### 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<>` | Emitted when a task filter property changes. |
+| ---- | ---- | ----------- |
+| action | `any` | Emitted when a filter action occurs (i.e Save, Save As, Delete). |
+| filterChange | `any` | 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). |
+| 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). |
-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. |
+| Name | Description |
+| ---- | ----------- |
+| **_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 {
@@ -207,13 +207,13 @@ With this configuration, only the two actions will be shown.
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 0a78c61149..1f8a5d42fc 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
@@ -75,15 +75,15 @@ 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. |
+| 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 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. |
@@ -99,15 +99,15 @@ The template defined inside `empty-form` will be shown when no form definition i
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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<FormModel>` | Emitted when form values are refreshed due to a data property change. |
-| formError | `EventEmitter<FormFieldModel[]>` | Emitted when the supplied form values have a validation error. |
-| formLoaded | `EventEmitter<FormModel>` | Emitted when the form is loaded or reloaded. |
-| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
+| formCompleted | `any` | Emitted when the form is submitted with the `Complete` outcome. |
+| formContentClicked | `any` | Emitted when form content is clicked. |
+| formDataRefreshed | `any` | 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 | `any` | Emitted when the form is loaded or reloaded. |
+| formSaved | `any` | 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 b32023a434..d75f8afe7a 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
@@ -22,11 +22,11 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| selectForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | 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 66d7e16e6d..c79cd38bc9 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
@@ -36,7 +36,7 @@ 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). |
@@ -45,16 +45,16 @@ Searches Groups.
| 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. |
+| 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. |
### Events
| 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<IdentityGroupModel>` | Emitted when a group is selected. |
-| warning | `EventEmitter<any>` | Emitted when an warning occurs. |
+| ---- | ---- | ----------- |
+| changedGroups | `any` | Emitted when a group selection change. |
+| removeGroup | `any` | Emitted when a group is removed. |
+| selectGroup | `any` | Emitted when a group is selected. |
+| warning | `any` | 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 2510114d2e..8a195737a6 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
@@ -24,26 +24,26 @@ 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). |
+| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | User 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 |
+| searchUserCtrl | `any` | | 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. |
+| 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](../../../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. |
### 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<IdentityUserModel>` | Emitted when a user is selected. |
-| warning | `EventEmitter<any>` | Emitted when an warning occurs. |
+| ---- | ---- | ----------- |
+| changedUsers | `any` | Emitted when a user selection change. |
+| removeUser | `any` | Emitted when a selected user is removed in multi selection mode. |
+| selectUser | `any` | Emitted when a user is selected. |
+| warning | `any` | 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 9e99eb22f4..fe88bc5e76 100644
--- a/docs/process-services-cloud/components/process-filters-cloud.component.md
+++ b/docs/process-services-cloud/components/process-filters-cloud.component.md
@@ -23,7 +23,7 @@ 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 |
@@ -31,14 +31,14 @@ Lists all available process filters and allows to select a filter.
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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<ProcessFilterCloudModel>` | Emitted when a filter is being selected based on the filterParam input. |
-| success | `EventEmitter<any>` | Emitted when filters are loaded successfully |
+| ---- | ---- | ----------- |
+| error | `any` | Emitted when any error occurs while loading the filters |
+| filterClicked | `any` | Emitted when a filter is being clicked from the UI. |
+| filterSelected | `any` | Emitted when a filter is being selected based on the filterParam input. |
+| success | `any` | 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 026723f1fa..dd761d040d 100644
--- a/docs/process-services-cloud/components/process-header-cloud.component.md
+++ b/docs/process-services-cloud/components/process-header-cloud.component.md
@@ -25,7 +25,7 @@ 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. |
@@ -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 ba452ff479..f019392bcd 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
@@ -49,7 +49,7 @@ 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 version of the application. |
@@ -79,14 +79,14 @@ when the process list is empty:
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
+| executeRowAction | `any` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a row in the process list is clicked. |
| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | Emitted when rows are selected/unselected. |
-| showRowActionsMenu | `EventEmitter<DataCellEvent>` | Emitted before the actions menu is displayed for a row. |
-| showRowContextMenu | `EventEmitter<DataCellEvent>` | Emitted before the context menu is displayed for a row. |
-| success | `EventEmitter<any>` | Emitted when the list of process instances has been loaded successfully from the server. |
+| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. |
+| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 d540d5b02e..82bd720b20 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
@@ -35,24 +35,24 @@ 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. |
+| variables | `__type` | | 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<ContentLinkModel>` | Emitted when form content is clicked. |
-| processDefinitionSelection | `EventEmitter<ProcessDefinitionCloud>` | Emitted when process definition selection changes. |
-| success | `EventEmitter<ProcessInstanceCloud>` | Emitted when the process is successfully started. |
+| ---- | ---- | ----------- |
+| cancel | `any` | Emitted when the starting process is cancelled |
+| error | `any` | 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 | `any` | 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 370c5429cb..ba2c013821 100644
--- a/docs/process-services-cloud/components/start-task-cloud.component.md
+++ b/docs/process-services-cloud/components/start-task-cloud.component.md
@@ -24,7 +24,7 @@ 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. |
@@ -32,7 +32,7 @@ Creates/starts a new task for the specified app.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the cancel button is clicked by the user. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| success | `EventEmitter<any>` | Emitted when the task is successfully created. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 eba4d0c67b..d5b215fbde 100644
--- a/docs/process-services-cloud/components/task-filters-cloud.component.md
+++ b/docs/process-services-cloud/components/task-filters-cloud.component.md
@@ -9,6 +9,17 @@ Last reviewed: 2019-01-08
Shows all available filters.
+## Contents
+
+- [Basic Usage](#basic-usage)
+- [Class members](#class-members)
+ - [Properties](#properties)
+ - [Events](#events)
+- [Details](#details)
+ - [Filtering APS2 task filters](#filtering-aps2-task-filters)
+ - [Showing Filter Counters](#showing-filter-counters)
+- [See also](#see-also)
+
## Basic Usage
```html
@@ -20,7 +31,7 @@ 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. |
@@ -28,11 +39,12 @@ Shows all available filters.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
-| filterSelected | `EventEmitter<TaskFilterCloudModel>` | Emitted when a filter is being selected based on the filterParam input. |
-| success | `EventEmitter<any>` | Emitted when the list is loaded. |
+| filterClicked | `any` | Emitted when a filter is being clicked from the UI. |
+| filterCounterUpdated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskCloudEngineEvent`](../../../lib/process-services-cloud/src/lib/models/engine-event-cloud.model.ts)`[]>` | Emitted when filter counters are updated. |
+| filterSelected | `any` | Emitted when a filter is being selected based on the filterParam input. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list is loaded. |
## Details
@@ -49,21 +61,21 @@ Use the `filterParam` property to restrict the range of filters that are shown:
You can use properties from [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
as the value of `filterParam` as shown in the table below:
-| Name | Type | Description |
-| ----- | ------ | --------------------------------------------------- |
-| id | string | The id of the task filter |
-| name | string | The name of the task filter, lowercase is checked |
-| key | string | The key of the task filter |
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| id | string | The id of the task filter |
+| name | string | The name of the task filter, lowercase is checked |
+| key | string | The key of the task filter |
| index | string | The zero-based position of the filter in the array. |
### Showing Filter Counters
-By default, filter counters are hidden. If you want to display filter counters you will need to add the `showCounter` property set to `true` in your TaskFilterCloudModel.
+By default, filter counters are hidden. If you want to display filter counters you will need to add the `showCounter` property set to `true` in your [TaskFilterCloudModel](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts).
## 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 63287da476..ee359bff56 100644
--- a/docs/process-services-cloud/components/task-form-cloud.component.md
+++ b/docs/process-services-cloud/components/task-form-cloud.component.md
@@ -34,7 +34,7 @@ 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. |
| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. |
@@ -47,18 +47,18 @@ Save and Complete buttons get disabled when at least one of the form's inputs ar
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the cancel button is clicked. |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
+| ---- | ---- | ----------- |
+| cancelClick | `any` | Emitted when the cancel button is clicked. |
+| error | `any` | Emitted when any error occurs. |
+| formCompleted | `any` | 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<FormModel>` | Emitted when the form is saved. |
-| taskClaimed | `EventEmitter<string>` | Emitted when the task is claimed. |
-| taskCompleted | `EventEmitter<string>` | Emitted when the task is completed. |
-| taskUnclaimed | `EventEmitter<string>` | Emitted when the task is unclaimed. |
+| formSaved | `any` | Emitted when the form is saved. |
+| taskClaimed | `any` | Emitted when the task is claimed. |
+| taskCompleted | `any` | Emitted when the task is completed. |
+| taskUnclaimed | `any` | 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 0807a8ae28..86ce975c9b 100644
--- a/docs/process-services-cloud/components/task-header-cloud.component.md
+++ b/docs/process-services-cloud/components/task-header-cloud.component.md
@@ -25,7 +25,7 @@ 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. |
@@ -33,10 +33,10 @@ Shows all the information related to a task.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is claimed. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the given task has errors. |
-| unclaim | `EventEmitter<any>` | Emitted when the task is unclaimed (ie, requeued). |
+| unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 0db83f46bc..f6ddd3cfec 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
@@ -50,7 +50,7 @@ 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). |
@@ -88,14 +88,14 @@ when the task list is empty:
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
+| executeRowAction | `any` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task in the list is clicked |
| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | Emitted when rows are selected/unselected |
-| showRowActionsMenu | `EventEmitter<DataCellEvent>` | Emitted before the actions menu is displayed for a row. |
-| showRowContextMenu | `EventEmitter<DataCellEvent>` | Emitted before the context menu is displayed for a row. |
-| success | `EventEmitter<any>` | Emitted when the task list is loaded |
+| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. |
+| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task list is loaded |
## Details
@@ -344,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 db33588cf9..a53863da05 100644
--- a/docs/process-services-cloud/directives/claim-task-cloud.directive.md
+++ b/docs/process-services-cloud/directives/claim-task-cloud.directive.md
@@ -20,13 +20,13 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task cannot be completed. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 019ba36f5e..bc7587b2a7 100644
--- a/docs/process-services-cloud/directives/complete-task.directive.md
+++ b/docs/process-services-cloud/directives/complete-task.directive.md
@@ -20,13 +20,13 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task cannot be completed. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 0cf536f33e..e87ccf8863 100644
--- a/docs/process-services-cloud/services/apps-process-cloud.service.md
+++ b/docs/process-services-cloud/services/apps-process-cloud.service.md
@@ -13,15 +13,16 @@ Gets details of deployed apps for the current user.
### 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)`[]>`<br/>
+- **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)`[]>`<br/>
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`<br/>
+ - _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`<br/>
- * **Returns** `boolean` -
-* **loadApps**()<br/>
+ - **Returns** `boolean` -
+
+- **loadApps**()<br/>
## Details
@@ -30,4 +31,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 a26ff30637..9694adba45 100644
--- a/docs/process-services-cloud/services/form-cloud.service.md
+++ b/docs/process-services-cloud/services/form-cloud.service.md
@@ -26,67 +26,69 @@ 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)`>`<br/>
+- **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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
- * *file:* `any` -
- * *nodeId:* `string` -
- * *contentHost:* `string` -
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
-* **getBasePath**(appName: `string`): `string`<br/>
+ - _file:_ `any` -
+ - _nodeId:_ `string` -
+ - _contentHost:_ `string` -
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
- * *appName:* `string` -
- * **Returns** `string` -
-* **getDropDownJsonData**(url: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+- **getBasePath**(appName: `string`): `string`<br/>
+
+ - _appName:_ `string` -
+ - **Returns** `string` -
+
+- **getDropDownJsonData**(url: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Parses JSON data to create a corresponding form.
- * *url:* `string` - String data to make the request
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
+ - _url:_ `string` - String data to make the request
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - 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)`[]>`<br/>
+ - _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)`<any>` - 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)`[]>`<br/>
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)<br/>
+ - _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)<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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 438201f1bf..dd7c40053a 100644
--- a/docs/process-services-cloud/services/group-cloud.service.md
+++ b/docs/process-services-cloud/services/group-cloud.service.md
@@ -13,39 +13,39 @@ Searches and gets information for groups.
### Methods
-* **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
+- **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
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)`<boolean>` - 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)`<boolean>`<br/>
+ - _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)`<boolean>` - 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)`<boolean>`<br/>
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)`<boolean>` - True if the group has the client app, false otherwise
-* **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
+ - _groupId:_ `string` - ID of the target group
+ - _clientId:_ `string` - ID of the client
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has the client app, false otherwise
+- **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
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)`<boolean>` - 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)`<any>`<br/>
+ - _groupId:_ `string` - ID of the target group
+ - _roleNames:_ `string[]` - Array of role names
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - 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)`<any>`<br/>
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)`<any>` - List of group information
-* **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
+ - _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)`<any>` - List of group information
+- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
Gets the client ID using the app name.
- * *applicationName:* `string` - Name of the app
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - client ID string
-* **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`<br/>
+ - _applicationName:_ `string` - Name of the app
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - client ID string
+- **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`<br/>
Gets client roles.
- * *groupId:* `string` - ID of the target group
- * *clientId:* `string` - ID of the client
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - 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)`[]>`<br/>
+ - _groupId:_ `string` - ID of the target group
+ - _clientId:_ `string` - ID of the client
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - 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)`[]>`<br/>
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 83ccd3037e..84d9291377 100644
--- a/docs/process-services-cloud/services/local-preference-cloud.service.md
+++ b/docs/process-services-cloud/services/local-preference-cloud.service.md
@@ -13,38 +13,39 @@ Manages Local Storage preferences.
### Methods
-* **createPreference**(\_: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+- **createPreference**(\_: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Observable of created local preferences
-* **deletePreference**(key: `string`, preferences: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _\_:_ `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)`<any>` - Observable of created local preferences
+- **deletePreference**(key: `string`, preferences: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Observable of preferences without deleted preference
-* **getPreferenceByKey**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _key:_ `string` - Key of the target preference
+ - _preferences:_ `any` - Details of updated preferences
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of preferences without deleted preference
+- **getPreferenceByKey**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets local preference.
- * *\_:* `string` - Name of the target app
- * *key:* `string` - Key of the target preference
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of local preference
-* **getPreferences**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _\_:_ `string` - Name of the target app
+ - _key:_ `string` - Key of the target preference
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of local preference
+- **getPreferences**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets local preferences
- * *\_:* `string` - Name of the target app
- * *key:* `string` - Key of the target preference
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of local preferences
-* **prepareLocalPreferenceResponse**(key: `string`): `any`<br/>
+ - _\_:_ `string` - Name of the target app
+ - _key:_ `string` - Key of the target preference
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of local preferences
+- **prepareLocalPreferenceResponse**(key: `string`): `any`<br/>
- * *key:* `string` -
- * **Returns** `any` -
-* **updatePreference**(\_: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _key:_ `string` -
+ - **Returns** `any` -
+
+- **updatePreference**(\_: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - 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)`<any>` - 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 8243eab364..4186fd4e87 100644
--- a/docs/process-services-cloud/services/process-cloud.service.md
+++ b/docs/process-services-cloud/services/process-cloud.service.md
@@ -13,28 +13,29 @@ 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)`>`<br/>
+- **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)`>`<br/>
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
-* **getApplicationVersions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>`<br/>
+ - _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)`[]>`<br/>
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`<br/>
+ - _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`<br/>
- * *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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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
@@ -45,5 +46,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 290ea2e366..f30a0ee44f 100644
--- a/docs/process-services-cloud/services/process-filter-cloud.service.md
+++ b/docs/process-services-cloud/services/process-filter-cloud.service.md
@@ -13,31 +13,43 @@ Manage Process Filters, which are pre-configured Process Instance queries.
### 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)`[]>`<br/>
+- **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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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`<br/>
+ - _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`<br/>
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)`[]>`<br/>
+ - _filterName:_ `string` - Name of the target process filter
+ - **Returns** `boolean` - Boolean value for whether the filter is a default filter
+- **readQueryParams**(obj: `Object`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
+
+ - _obj:_ `Object` -
+ - **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) -
+
+- **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)`[]>`<br/>
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
+- **writeQueryParams**(value: `Object`, filterProperties: `string[]`, appName?: `string`, id?: `string`): `Object`<br/>
+
+ - _value:_ `Object` -
+ - _filterProperties:_ `string[]` -
+ - _appName:_ `string` - (Optional)
+ - _id:_ `string` - (Optional)
+ - **Returns** `Object` -
## Inject Preference service
@@ -81,5 +93,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 9a59fa7092..fa1f02abd0 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,16 @@ Searches processes.
### Methods
-* **getBasePath**(appName: `string`): `string`<br/>
+- **getBasePath**(appName: `string`): `string`<br/>
- * *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)`<any>`<br/>
+ - _appName:_ `string` -
+ - **Returns** `string` -
+
+- **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts), queryUrl?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Process information
+ - _requestNode:_ [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object
+ - _queryUrl:_ `string` - (Optional) Query url
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Process information
## Details
@@ -40,4 +42,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 96f6265c9d..ff891513c6 100644
--- a/docs/process-services-cloud/services/start-process-cloud.service.md
+++ b/docs/process-services-cloud/services/start-process-cloud.service.md
@@ -13,41 +13,42 @@ Gets process definitions and starts processes.
### 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)`>`<br/>
+- **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)`>`<br/>
Create a process based on a process definition, name, form values or variables.
- * *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)`<void>`<br/>
+ - _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)`<void>`<br/>
Delete an existing process instance
- * *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)`<void>` -
-* **getBasePath**(appName: `string`): `string`<br/>
+ - _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)`<void>` -
+- **getBasePath**(appName: `string`): `string`<br/>
- * *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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
Starts a process based on a process definition, name, form values or variables.
- * *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)`>`<br/>
+ - _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)`>`<br/>
Update an existing process instance
- * *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
+ - _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 +60,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 2e501df5b0..919deabe20 100644
--- a/docs/process-services-cloud/services/start-task-cloud.service.md
+++ b/docs/process-services-cloud/services/start-task-cloud.service.md
@@ -13,14 +13,14 @@ Starts standalone tasks.
### 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)`>`<br/>
- (**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`<br/>
+- **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)`>`<br/>
+ (**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`<br/>
- * *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 f0aa662f17..8b91ae0fb7 100644
--- a/docs/process-services-cloud/services/task-cloud.service.md
+++ b/docs/process-services-cloud/services/task-cloud.service.md
@@ -13,88 +13,91 @@ 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)`>`<br/>
+- **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)`>`<br/>
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`<br/>
+ - _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`<br/>
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`<br/>
+ - _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`<br/>
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`<br/>
+ - _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`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _appName:_ `string` - Name of the app
+ - _taskId:_ `string` - ID of the task to claim
+ - _assignee:_ `string` - User 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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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`<br/>
+ - _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`<br/>
- * *appName:* `string` -
- * **Returns** `string` -
-* **getCandidateGroups**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
+ - _appName:_ `string` -
+ - **Returns** `string` -
+
+- **getCandidateGroups**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
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)`<string[]>` - Candidate groups
-* **getCandidateUsers**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
+ - _appName:_ `string` - Name of the app
+ - _taskId:_ `string` - ID of the task
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Candidate groups
+- **getCandidateUsers**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
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)`<string[]>` - Candidate users
-* **getPriorityLabel**(priority: `number`): `string`<br/>
+ - _appName:_ `string` - Name of the app
+ - _taskId:_ `string` - ID of the task
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Candidate users
+- **getPriorityLabel**(priority: `number`): `string`<br/>
- * *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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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`<br/>
+ - _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`<br/>
- * *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`<br/>
+ - _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`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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
@@ -105,4 +108,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 57f683a0b6..a95478c2c6 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,45 @@ 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)`[]>`<br/>
+- **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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - _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
+- **getBasePath**(appName: `string`): `string`<br/>
+
+ - _appName:_ `string` -
+ - **Returns** `string` -
+
+- **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)`>`<br/>
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)`[]>`<br/>
+ - _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
+- **getTaskFilterCounter**(taskFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ Finds a task using an object with optional query properties.
+ - _taskFilter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) -
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Task information
+- **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)`[]>`<br/>
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`<br/>
+ - _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
+- **getTaskNotificationSubscription**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskCloudEngineEvent`](../../../lib/process-services-cloud/src/lib/models/engine-event-cloud.model.ts)`[]>`<br/>
+
+ - _appName:_ `string` -
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskCloudEngineEvent`](../../../lib/process-services-cloud/src/lib/models/engine-event-cloud.model.ts)`[]>` -
+
+- **isDefaultFilter**(filterName: `string`): `boolean`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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
@@ -96,4 +110,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 ed684f6026..c6f84f0218 100644
--- a/docs/process-services-cloud/services/task-list-cloud.service.md
+++ b/docs/process-services-cloud/services/task-list-cloud.service.md
@@ -13,14 +13,16 @@ Searches tasks.
### Methods
-* **getBasePath**(appName: `string`): `string`<br/>
+- **getBasePath**(appName: `string`): `string`<br/>
- * *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)`<any>`<br/>
+ - _appName:_ `string` -
+ - **Returns** `string` -
+
+- **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts), queryUrl?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Task information
+ - _requestNode:_ [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object
+ - _queryUrl:_ `string` - (Optional) Query url
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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 4489d11c9f..cdf4bf1736 100644
--- a/docs/process-services-cloud/services/user-preference-cloud.service.md
+++ b/docs/process-services-cloud/services/user-preference-cloud.service.md
@@ -13,37 +13,38 @@ Manages user preferences.
### Methods
-* **createPreference**(appName: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+- **createPreference**(appName: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Observable of created user preferences
-* **deletePreference**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _appName:_ `string` - Name of the target app
+ - _key:_ `string` - Key of the target preference
+ - _newPreference:_ `any` -
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of created user preferences
+- **deletePreference**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Observable of delete operation status
-* **getBasePath**(appName: `string`): `string`<br/>
+ - _appName:_ `string` - Name of the target app
+ - _key:_ `string` - Key of the target preference
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of delete operation status
+- **getBasePath**(appName: `string`): `string`<br/>
- * *appName:* `string` -
- * **Returns** `string` -
-* **getPreferenceByKey**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _appName:_ `string` -
+ - **Returns** `string` -
+
+- **getPreferenceByKey**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - Observable of user preference
-* **getPreferences**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _appName:_ `string` - Name of the target app
+ - _key:_ `string` - Key of the target preference
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of user preference
+- **getPreferences**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets user preferences
- * *appName:* `string` - Name of the target app
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of user preferences
-* **updatePreference**(appName: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _appName:_ `string` - Name of the target app
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of user preferences
+- **updatePreference**(appName: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
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)`<any>` - 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)`<any>` - 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 09b38aad39..3412cd629e 100644
--- a/docs/process-services/components/apps-list.component.md
+++ b/docs/process-services/components/apps-list.component.md
@@ -38,16 +38,16 @@ 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". |
### Events
| 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<any>` | Emitted when an error occurs. |
+| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 a711641a70..b78b686065 100644
--- a/docs/process-services/components/attach-form.component.md
+++ b/docs/process-services/components/attach-form.component.md
@@ -22,14 +22,14 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| cancelAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the "Cancel" button is clicked. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| success | `EventEmitter<void>` | Emitted when the form is attached successfully. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | 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 c22f3a4b2d..a40e3249d3 100644
--- a/docs/process-services/components/checklist.component.md
+++ b/docs/process-services/components/checklist.component.md
@@ -24,7 +24,7 @@ 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. |
@@ -32,7 +32,7 @@ Shows the checklist task functionality.
### Events
| 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)`<string>` | Emitted when a checklist task is deleted. |
-| error | `EventEmitter<any>` | Emitted when an error occurs. |
+| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 51f73f297c..9524cedfbc 100644
--- a/docs/process-services/components/create-process-attachment.component.md
+++ b/docs/process-services/components/create-process-attachment.component.md
@@ -26,12 +26,12 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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)`<any>` | 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 f131e74a58..4ca054a808 100644
--- a/docs/process-services/components/create-task-attachment.component.md
+++ b/docs/process-services/components/create-task-attachment.component.md
@@ -26,12 +26,12 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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)`<any>` | 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 d8e937fcad..5995200c09 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
@@ -53,14 +53,14 @@ Any content in the body of `<adf-form>` 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. |
+| form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying form model 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. |
@@ -78,15 +78,15 @@ Any content in the body of `<adf-form>` will be shown when no form definition is
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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<FormModel>` | Emitted when form values are refreshed due to a data property change. |
-| formError | `EventEmitter<FormFieldModel[]>` | Emitted when the supplied form values have a validation error. |
-| formLoaded | `EventEmitter<FormModel>` | Emitted when the form is loaded or reloaded. |
-| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
+| 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. |
## 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 d826d517cc..8d94a8c1de 100644
--- a/docs/process-services/components/people-list.component.md
+++ b/docs/process-services/components/people-list.component.md
@@ -77,13 +77,13 @@ 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. |
### Events
| 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<UserProcessModel>` | Emitted when the user clicks a row in the people list. |
+| ---- | ---- | ----------- |
+| clickAction | `any` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. |
+| clickRow | `any` | 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 1ac06c8c5a..ddd5267f86 100644
--- a/docs/process-services/components/people-search.component.md
+++ b/docs/process-services/components/people-search.component.md
@@ -32,16 +32,16 @@ special sub-components in the body of the `<adf-people-search>` 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "close" button is clicked. |
-| searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a search is performed with a new keyword. |
-| success | `EventEmitter<UserProcessModel>` | Emitted when a user is selected and the action button is clicked. |
+| ---- | ---- | ----------- |
+| closeSearch | `any` | Emitted when the "close" button is clicked. |
+| searchPeople | `any` | Emitted when a search is performed with a new keyword. |
+| success | `any` | 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 6f05520d2f..dd61cfc886 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
@@ -38,8 +38,8 @@ 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. |
+| ---- | ---- | ------------- | ----------- |
+| people | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | \[] | The array of User objects to display. |
| readOnly | `boolean` | false | Should the data be read-only? |
| taskId | `string` | "" | The numeric ID of the task. |
@@ -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 6bc294953d..a6ff1a88d3 100644
--- a/docs/process-services/components/process-attachment-list.component.md
+++ b/docs/process-services/components/process-attachment-list.component.md
@@ -59,17 +59,17 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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)`<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). |
-| success | `EventEmitter<any>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
+| ---- | ---- | ----------- |
+| attachmentClick | `any` | 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 | `any` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). |
+| success | `any` | 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 <adf-empty-list>) to invite the user to add their attachments:
<!-- {% raw %} -->
diff --git a/docs/process-services/components/process-comments.component.md b/docs/process-services/components/process-comments.component.md
index 099546a9fc..7bb82fdb60 100644
--- a/docs/process-services/components/process-comments.component.md
+++ b/docs/process-services/components/process-comments.component.md
@@ -21,12 +21,12 @@ 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? |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 72e0a2029f..659379e113 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
@@ -33,7 +33,7 @@ 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. |
@@ -42,11 +42,11 @@ Collection of criteria used to filter process instances, which may be customized
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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<UserProcessInstanceFilterRepresentation>` | Emitted when a filter is being selected based on the filterParam input. |
-| success | `EventEmitter<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. |
+| 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. |
+| 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. |
## Details
@@ -78,12 +78,12 @@ You can use inside the filterParam one of the properties defined by [`FilterPara
}
```
-| Name | Type | Description |
-| ----- | ------ | -------------------------------------------------- |
-| id | string | The id of the task filter. |
-| name | string | The name of the task filter, lowercase is checked. |
-| index | number | Zero-based position of the filter in the array. |
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| id | string | The id of the task filter. |
+| name | string | The name of the task filter, lowercase is checked. |
+| index | number | Zero-based position of the filter in the array. |
## 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 272f02a6e9..aa6d0f59d6 100644
--- a/docs/process-services/components/process-instance-details.component.md
+++ b/docs/process-services/components/process-instance-details.component.md
@@ -22,7 +22,7 @@ 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. |
@@ -30,8 +30,8 @@ Displays detailed information about a specified process instance
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| processCancelled | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the current process is cancelled by the user from within the component. |
-| showProcessDiagram | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "show diagram" button is clicked. |
-| taskClick | `EventEmitter<TaskDetailsEvent>` | Emitted when a task is clicked. |
+| ---- | ---- | ----------- |
+| error | `any` | Emitted when an error occurs. |
+| processCancelled | `any` | Emitted when the current process is cancelled by the user from within the component. |
+| showProcessDiagram | `any` | Emitted when the "show diagram" button is clicked. |
+| taskClick | `any` | 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 08bbe8f26d..241394accc 100644
--- a/docs/process-services/components/process-instance-header.component.md
+++ b/docs/process-services/components/process-instance-header.component.md
@@ -24,7 +24,7 @@ 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. |
## Details
@@ -32,7 +32,7 @@ Sub-component of the process details component, which renders some general infor
### 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 3d6485e189..80b30122f3 100644
--- a/docs/process-services/components/process-instance-tasks.component.md
+++ b/docs/process-services/components/process-instance-tasks.component.md
@@ -23,13 +23,13 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 85ac273498..a14a4aacb4 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
@@ -50,13 +50,13 @@ 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. |
+| 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 |
@@ -70,11 +70,11 @@ when the process list is empty:
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while loading the list of process instances from the server. |
-| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | 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<ProcessListModel>` | Emitted when the list of process instances has been loaded successfully from the server. |
+| ---- | ---- | ----------- |
+| error | `any` | Emitted when an error occurs while loading the list of process instances from the server. |
+| rowClick | `any` | Emitted when a row in the process list is clicked. |
+| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
+| success | `any` | 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 04cf625ce2..b0d992f5a7 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
@@ -39,26 +39,26 @@ 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. |
+| 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). |
+| 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). |
### 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)`<void>` | Emitted when the process is canceled. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| processDefinitionSelection | `EventEmitter<ProcessDefinitionRepresentation>` | Emitted when process definition selection changes. |
-| start | `EventEmitter<ProcessInstance>` | Emitted when the process starts. |
+| 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. |
## Details
@@ -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 29d753411a..faad37c266 100644
--- a/docs/process-services/components/start-task.component.md
+++ b/docs/process-services/components/start-task.component.md
@@ -25,14 +25,14 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the cancel button is clicked by the user. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| success | `EventEmitter<any>` | Emitted when the task is successfully created. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 1f837051f3..2871242a26 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
@@ -53,17 +53,17 @@ 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. |
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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)`<any>` | Emitted when an error occurs while fetching the attachments. |
-| success | `EventEmitter<any>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
+| ---- | ---- | ----------- |
+| attachmentClick | `any` | 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 | `any` | Emitted when an error occurs while fetching the attachments. |
+| success | `any` | 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.
<!-- {% raw %} -->
@@ -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 b2add16b91..81ba9d5134 100644
--- a/docs/process-services/components/task-details.component.md
+++ b/docs/process-services/components/task-details.component.md
@@ -22,7 +22,7 @@ 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. |
@@ -41,18 +41,18 @@ Shows the details of the task ID passed in as input.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when a task is assigned. |
| claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task is claimed. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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<FormModel>` | Emitted when the form is loaded or reloaded. |
-| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
-| taskCreated | `EventEmitter<TaskDetailsModel>` | Emitted when a checklist task is created. |
-| taskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
-| unClaimedTask | `EventEmitter<string>` | Emitted when a task is unclaimed. |
+| 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)`<string>` | Emitted when a checklist task is deleted. |
+| unClaimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | 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 7fa59d2dda..14151fb632 100644
--- a/docs/process-services/components/task-filters.component.md
+++ b/docs/process-services/components/task-filters.component.md
@@ -20,7 +20,7 @@ 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. |
@@ -29,11 +29,11 @@ Shows all available filters.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
-| filterSelected | `EventEmitter<FilterRepresentationModel>` | Emitted when a filter is being selected based on the filterParam input. |
-| success | `EventEmitter<any>` | Emitted when the list is loaded. |
+| 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. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list is loaded. |
## Details
@@ -50,8 +50,8 @@ Use the `filterParam` property to restrict the range of filters that are shown:
You can use properties from [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
as the value of `filterParam` as shown in the table below:
-| Name | Type | Description |
-| ----- | ------ | --------------------------------------------------- |
-| id | string | The id of the task filter |
-| name | string | The name of the task filter, lowercase is checked |
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| id | string | The id of the task filter |
+| name | string | The name of the task filter, lowercase is checked |
| index | string | The zero-based position of the filter in the array. |
diff --git a/docs/process-services/components/task-form.component.md b/docs/process-services/components/task-form.component.md
index 3eab3d2ded..eaa5d1b2a2 100644
--- a/docs/process-services/components/task-form.component.md
+++ b/docs/process-services/components/task-form.component.md
@@ -22,7 +22,7 @@ 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. |
@@ -36,22 +36,22 @@ Shows a [`form`](../../../lib/process-services/src/lib/task-list/models/form.mod
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the "Cancel" button is clicked. |
-| completed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the form associated with the task is completed. |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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. |
+| ---- | ---- | ----------- |
+| cancel | `any` | Emitted when the "Cancel" button is clicked. |
+| completed | `any` | Emitted when the form associated with the task is completed. |
+| error | `any` | Emitted when an error occurs. |
+| executeOutcome | `any` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
+| formCompleted | `any` | Emitted when the form is submitted with the `Complete` outcome. |
+| formContentClicked | `any` | 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<FormModel>` | Emitted when the form is loaded or reloaded. |
-| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
-| showAttachForm | `EventEmitter<void>` | Emitted when the form associated with the form task is attached. |
-| taskClaimed | `EventEmitter<string>` | Emitted when the task is claimed. |
-| taskUnclaimed | `EventEmitter<string>` | Emitted when the task is unclaimed (ie, requeued).. |
+| formLoaded | `any` | Emitted when the form is loaded or reloaded. |
+| formSaved | `any` | Emitted when the form is submitted with the `Save` or custom outcomes. |
+| showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the form associated with the form task is attached. |
+| taskClaimed | `any` | Emitted when the task is claimed. |
+| taskUnclaimed | `any` | 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 c6f6070890..0c430b8951 100644
--- a/docs/process-services/components/task-header.component.md
+++ b/docs/process-services/components/task-header.component.md
@@ -24,7 +24,7 @@ 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. |
@@ -32,9 +32,9 @@ Shows all the information related to a task.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is claimed. |
-| unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is unclaimed (ie, requeued). |
+| unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is unclaimed (ie, requeue). |
## Details
@@ -43,7 +43,7 @@ The component populates an internal array of
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 1fd044f641..041468ebb5 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
@@ -52,7 +52,7 @@ 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. |
@@ -64,7 +64,7 @@ when the task list is empty:
| 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. |
+| 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. |
@@ -79,12 +79,12 @@ when the task list is empty:
### Events
| Name | Type | Description |
-| --- | --- | --- |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
-| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task in the list is clicked |
-| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | 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<any>` | Emitted when the task list is loaded |
+| ---- | ---- | ----------- |
+| error | `any` | Emitted when an error occurs. |
+| rowClick | `any` | Emitted when a task in the list is clicked |
+| rowsSelected | `any` | Emitted when rows are selected/unselected |
+| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
+| success | `any` | 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 40feb3e51c..1e120792a5 100644
--- a/docs/process-services/components/task-standalone.component.md
+++ b/docs/process-services/components/task-standalone.component.md
@@ -22,7 +22,7 @@ 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. |
@@ -32,7 +32,7 @@ This component can be used when the task doesn't belong to any processes.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the "Cancel" button is clicked. |
| complete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the form associated with the task is completed. |
-| showAttachForm | `EventEmitter<void>` | Emitted when the form associated with the form task is attached. |
+| showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | 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 8548a6e85b..c10e378d6d 100644
--- a/docs/process-services/directives/claim-task.directive.md
+++ b/docs/process-services/directives/claim-task.directive.md
@@ -20,12 +20,12 @@ Claims a task
### Properties
| 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)`<any>` | Emitted when the task cannot be claimed. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 7d688e88f6..c22115efec 100644
--- a/docs/process-services/directives/process-audit.directive.md
+++ b/docs/process-services/directives/process-audit.directive.md
@@ -29,7 +29,7 @@ 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"). |
@@ -38,6 +38,6 @@ Fetches the Process Audit information in PDF or JSON format.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the decorated element is clicked. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 7631a878e6..0bca1eedac 100644
--- a/docs/process-services/directives/task-audit.directive.md
+++ b/docs/process-services/directives/task-audit.directive.md
@@ -28,7 +28,7 @@ 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". |
@@ -37,6 +37,6 @@ Fetches the Task Audit information in PDF or JSON format.
### Events
| Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the decorated element is clicked. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | 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 5fb7d3dcca..bbac8040d1 100644
--- a/docs/process-services/services/process-filter.service.md
+++ b/docs/process-services/services/process-filter.service.md
@@ -13,37 +13,37 @@ Manage Process Filters, which are pre-configured Process Instance queries.
### 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)`>`<br/>
+- **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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)<br/>
+ - _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)<br/>
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
@@ -76,5 +76,5 @@ 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 1d2b290017..ba9a242b29 100644
--- a/docs/process-services/services/process.service.md
+++ b/docs/process-services/services/process.service.md
@@ -13,63 +13,63 @@ Manages process instances, process variables, and process audit Log.
### Methods
-* **cancelProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
+- **cancelProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
Cancels a process instance.
- * *processInstanceId:* `string` - ID of process to cancel
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - 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)`[]>`<br/>
+ - _processInstanceId:_ `string` - ID of process to cancel
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - 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)`[]>`<br/>
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)`<void>`<br/>
+ - _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)`<void>`<br/>
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)`<void>` - Null response notifying when the operation is complete
-* **fetchProcessAuditJsonById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
+ - _processInstanceId:_ `string` - ID of the target process
+ - _variableName:_ `string` - Name of the variable to delete
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - Null response notifying when the operation is complete
+- **fetchProcessAuditJsonById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Fetches the Process Audit information in a JSON format.
- * *processId:* `string` - ID of the target process
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - JSON data
-* **fetchProcessAuditPdfById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`<br/>
+ - _processId:_ `string` - ID of the target process
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - JSON data
+- **fetchProcessAuditPdfById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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 725de288f8..8de787d549 100644
--- a/docs/process-services/services/task-filter.service.md
+++ b/docs/process-services/services/task-filter.service.md
@@ -13,52 +13,52 @@ Manage Task Filters, which are pre-configured Task Instance queries.
### 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)`>`<br/>
+- **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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - 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)`[]>`<br/>
+ - _appId:_ `number` - (Optional) ID of the target app
+ - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>` - 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)`[]>`<br/>
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)<br/>
+ - _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)<br/>
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)<br/>
+ - _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)<br/>
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)<br/>
+ - _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)<br/>
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)<br/>
+ - _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)<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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
@@ -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 5ce1518848..c95788cc77 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)`>`<br/>
+- **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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _taskId:_ `string` - The task to assign
+ - _requestNode:_ `any` - User 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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - 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)`>`<br/>
+ - _taskId:_ `string` - ID of the target task
+ - _formId:_ `number` - ID of the form to add
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
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)`<any>`<br/>
+ - _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`): `any`<br/>
Gives completed status to a task.
- * *taskId:* `string` - ID of the target task
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - 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)`>`<br/>
+ - _taskId:_ `string` - ID of the target task
+ - **Returns** `any` - 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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
Fetch the Task Audit information in JSON format
- * *taskId:* `string` - ID of the target task
- * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - JSON data
-* **fetchTaskAuditPdfById**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`<br/>
+ - _taskId:_ `string` - ID of the target task
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - JSON data
+- **fetchTaskAuditPdfById**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`[]>`<br/>
+ - _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)`[]>`<br/>
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)`[]>`<br/>
+ - **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)`[]>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`<any>`<br/>
+ - _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)`<any>`<br/>
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)`<any>` - 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)`>`<br/>
+ - _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)`<any>` - 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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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)`>`<br/>
+ - _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)`>`<br/>
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
diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md
index 466eabf8c6..05e6ecb47e 100644
--- a/docs/tutorials/README.md
+++ b/docs/tutorials/README.md
@@ -7,7 +7,7 @@ Github only: true
| Name | Level | Abstract |
| --- | --- | --- |
-| [**Creating your first ADF application**](creating-your-first-adf-application.md) | Basic | This tutorial shows you how to set up your development environment and create an ADF application. |
+| [**Prerequisites and the requirements**](creating-your-first-adf-application.md) | Basic | In this tutorial you are going to learn how to create a very basic (and almost “empty”) ADF-based application that you can start enriching with features, behaviors and customizations. The creation of this basic ADF-based application is possible through a scaffolding tool called [Yeoman]\(https://yeoman.io/ "https://yeoman.io/"), which makes this task very straightforward. |
| [**Creating your Alfresco JavaScript application**](creating-javascript-app-using-alfresco-js-api.md) | Basic | In this tutorial you will learn how to create an application in JavaScript from scratch to interact with Alfresco. |
| [**Adding a new component**](new-component.md) | Basic | In this tutorial, you will learn how to create a component using [Angular CLI](https://cli.angular.io/) within an existing application. |
| [**Adding a new view**](new-view.md) | Beginner | In this tutorial you will learn how to create a new view in your application and how to access it using a defined endpoint. |
diff --git a/docs/versionIndex.md b/docs/versionIndex.md
index 26eff44f6e..9bf1d2fb4a 100644
--- a/docs/versionIndex.md
+++ b/docs/versionIndex.md
@@ -12,33 +12,42 @@ backend services have been tested with each released version of ADF.
## Versions
-* [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.3.0](#v320)
+- [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.3.0
+
+<!--v430 start-->
+
+- [Infinite select scroll directive](core/directives/infinite-select-scroll.directive.md)
+
+<!--v430 end-->
## v4.2.0
<!--v420 start-->
-* [Search datetime range component](content-services/components/search-datetime-range.component.md)
+- [Search datetime range component](content-services/components/search-datetime-range.component.md)
<!--v420 end-->
@@ -46,7 +55,7 @@ backend services have been tested with each released version of ADF.
<!--v410 start-->
-* [Version upload component](content-services/components/version-upload.component.md)
+- [Version upload component](content-services/components/version-upload.component.md)
<!--v410 end-->
@@ -60,16 +69,16 @@ backend services have been tested with each released version of ADF.
<!--v390 start-->
-* [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)
<!--v390 end-->
@@ -85,7 +94,7 @@ backend services have been tested with each released version of ADF.
<!--v370 start-->
-* [Cancel process directive](process-services-cloud/directives/cancel-process.directive.md)
+- [Cancel process directive](process-services-cloud/directives/cancel-process.directive.md)
<!--v370 end-->
@@ -95,7 +104,7 @@ backend services have been tested with each released version of ADF.
<!--v360 start-->
-* [Search text input component](core/components/search-text-input.component.md)
+- [Search text input component](core/components/search-text-input.component.md)
<!--v360 end-->
@@ -105,11 +114,11 @@ backend services have been tested with each released version of ADF.
<!--v350 start-->
-* [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)
<!--v350 end-->
@@ -119,10 +128,10 @@ backend services have been tested with each released version of ADF.
<!--v340 start-->
-* [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)
<!--v340 end-->
@@ -132,9 +141,9 @@ backend services have been tested with each released version of ADF.
<!--v330 start-->
-* [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)
<!--v330 end-->
@@ -144,14 +153,14 @@ backend services have been tested with each released version of ADF.
<!--v320 start-->
-* [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)
<!--v320 end-->
@@ -161,10 +170,10 @@ backend services have been tested with each released version of ADF.
<!--v310 start-->
-* [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)
<!--v310 end-->
@@ -176,38 +185,38 @@ backend services have been tested with each released version of ADF.
<!--v300 start-->
-* [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)
+- [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)
<!--v300 end-->
@@ -230,9 +239,9 @@ backend services have been tested with each released version of ADF.
<!--v260 start-->
-* [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)
<!--v260 end-->
@@ -248,7 +257,7 @@ backend services have been tested with each released version of ADF.
<!--v250 start-->
-* [Header component](core/components/header.component.md)
+- [Header component](core/components/header.component.md)
<!--v250 end-->
@@ -264,23 +273,23 @@ backend services have been tested with each released version of ADF.
<!--v240 start-->
-* [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)
<!--v240 end-->
@@ -296,18 +305,18 @@ backend services have been tested with each released version of ADF.
<!--v230 start-->
-* [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)
<!--v230 end-->
@@ -323,8 +332,8 @@ backend services have been tested with each released version of ADF.
<!--v220 start-->
-* [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)
<!--v220 end-->
@@ -340,11 +349,11 @@ backend services have been tested with each released version of ADF.
<!--v210 start-->
-* [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)
<!--v210 end-->
@@ -360,157 +369,160 @@ backend services have been tested with each released version of ADF.
<!--v200 start-->
-* [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)
+- [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)
+- [Aspect list dialog component](content-services/components/aspect-list-dialog.component.md)
+- [Aspect list component](content-services/components/aspect-list.component.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 type dialog component](content-services/components/content-type-dialog.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)
<!--v200 end-->
diff --git a/lib/core/directives/infinite-select-scroll.directive.ts b/lib/core/directives/infinite-select-scroll.directive.ts
index 254b752c02..f34aa1e349 100644
--- a/lib/core/directives/infinite-select-scroll.directive.ts
+++ b/lib/core/directives/infinite-select-scroll.directive.ts
@@ -26,6 +26,7 @@ import { takeUntil } from 'rxjs/operators';
export class InfiniteSelectScrollDirective implements AfterViewInit, OnDestroy {
static readonly MAX_ITEMS = 50;
+ /** Emitted when scroll reaches the last item. */
@Output() scrollEnd = new EventEmitter<Event>();
private onDestroy$ = new Subject<boolean>();
diff --git a/package-lock.json b/package-lock.json
index 7f1256a647..5762189a48 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -9614,12 +9614,12 @@
}
},
"cross-fetch": {
- "version": "3.0.5",
- "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.0.5.tgz",
- "integrity": "sha512-FFLcLtraisj5eteosnX1gf01qYDCOc4fDy0+euOt8Kn9YBY2NtXL/pCoYPavw24NIQkQqm5ZOLsGD5Zzj0gyew==",
+ "version": "3.0.6",
+ "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.0.6.tgz",
+ "integrity": "sha512-KBPUbqgFjzWlVcURG+Svp9TlhA5uliYtiNx/0r8nv0pdypeQCRJ9IaSIc3q/x3q8t3F75cHuwxVql1HFGHCNJQ==",
"dev": true,
"requires": {
- "node-fetch": "2.6.0"
+ "node-fetch": "2.6.1"
}
},
"cross-spawn": {
@@ -10169,12 +10169,6 @@
"integrity": "sha512-jQVeeRG70QI08vSTwf1jHxp74JoZsr2XSgETae8/xC8ovSnL2WF87GTLO86Sbwdt2lK4Umg4HnnwMO4YF3Ce7w==",
"dev": true
},
- "css-selector-parser": {
- "version": "1.4.1",
- "resolved": "https://registry.npmjs.org/css-selector-parser/-/css-selector-parser-1.4.1.tgz",
- "integrity": "sha512-HYPSb7y/Z7BNDCOrakL4raGO2zltZkbeXyAd6Tg9obzix6QhzxCotdBl6VT0Dv4vZfJGVz3WL/xaEI9Ly3ul0g==",
- "dev": true
- },
"css-selector-tokenizer": {
"version": "0.7.0",
"resolved": "https://registry.npmjs.org/css-selector-tokenizer/-/css-selector-tokenizer-0.7.0.tgz",
@@ -11825,15 +11819,6 @@
"reusify": "^1.0.4"
}
},
- "fault": {
- "version": "1.0.4",
- "resolved": "https://registry.npmjs.org/fault/-/fault-1.0.4.tgz",
- "integrity": "sha512-CJ0HCB5tL5fYTEA7ToAq5+kTwd++Borf1/bifxd9iT70QcXr4MRrO3Llf8Ifs70q+SJcGHFtnIE/Nw6giCtECA==",
- "dev": true,
- "requires": {
- "format": "^0.2.0"
- }
- },
"faye-websocket": {
"version": "0.10.0",
"resolved": "https://registry.npmjs.org/faye-websocket/-/faye-websocket-0.10.0.tgz",
@@ -12369,12 +12354,6 @@
"mime-types": "^2.1.12"
}
},
- "format": {
- "version": "0.2.2",
- "resolved": "https://registry.npmjs.org/format/-/format-0.2.2.tgz",
- "integrity": "sha1-1hcBB+nv3E7TDJ3DkBbflCtctYs=",
- "dev": true
- },
"formidable": {
"version": "1.2.2",
"resolved": "https://registry.npmjs.org/formidable/-/formidable-1.2.2.tgz",
@@ -12828,23 +12807,6 @@
}
}
},
- "github-slugger": {
- "version": "1.3.0",
- "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.3.0.tgz",
- "integrity": "sha512-gwJScWVNhFYSRDvURk/8yhcFBee6aFjye2a7Lhb2bUyRulpIoek9p0I9Kt7PT67d/nUlZbFu8L9RLiA0woQN8Q==",
- "dev": true,
- "requires": {
- "emoji-regex": ">=6.0.0 <=6.1.1"
- },
- "dependencies": {
- "emoji-regex": {
- "version": "6.1.1",
- "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-6.1.1.tgz",
- "integrity": "sha1-xs0OwbBkLio8Z6ETfvxeeW2k+I4=",
- "dev": true
- }
- }
- },
"glob": {
"version": "7.1.6",
"resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz",
@@ -12974,18 +12936,18 @@
"integrity": "sha512-WjKPNJF79dtJAVniUlGGWHYGz2jWxT6VhN/4m1NdkbZ2nOsEF+cI1Edgql5zCRhs/VsQYRvrXctxktVXZUkixw=="
},
"graphql": {
- "version": "15.4.0",
- "resolved": "https://registry.npmjs.org/graphql/-/graphql-15.4.0.tgz",
- "integrity": "sha512-EB3zgGchcabbsU9cFe1j+yxdzKQKAbGUWRb13DsrsMN1yyfmmIq+2+L5MqVWcDCE4V89R5AyUOi7sMOGxdsYtA==",
+ "version": "15.5.0",
+ "resolved": "https://registry.npmjs.org/graphql/-/graphql-15.5.0.tgz",
+ "integrity": "sha512-OmaM7y0kaK31NKG31q4YbD2beNYa6jBBKtMFT6gLYJljHLJr42IqJ8KX08u3Li/0ifzTU5HjmoOOrwa5BRLeDA==",
"dev": true
},
"graphql-request": {
- "version": "3.1.0",
- "resolved": "https://registry.npmjs.org/graphql-request/-/graphql-request-3.1.0.tgz",
- "integrity": "sha512-Flg2Bd4Ek9BDJ5qacZC/iYuiS3LroHxQTmlUnfqjo/6jKwowY25FVtoLTnssMCBrYspRYEYEIfF1GN8J3/o5JQ==",
+ "version": "3.4.0",
+ "resolved": "https://registry.npmjs.org/graphql-request/-/graphql-request-3.4.0.tgz",
+ "integrity": "sha512-acrTzidSlwAj8wBNO7Q/UQHS8T+z5qRGquCQRv9J1InwR01BBWV9ObnoE+JS5nCCEj8wSGS0yrDXVDoRiKZuOg==",
"dev": true,
"requires": {
- "cross-fetch": "^3.0.5",
+ "cross-fetch": "^3.0.6",
"extract-files": "^9.0.0",
"form-data": "^3.0.0"
}
@@ -13033,27 +12995,6 @@
"integrity": "sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==",
"dev": true
},
- "handlebars": {
- "version": "4.7.7",
- "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz",
- "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==",
- "dev": true,
- "requires": {
- "minimist": "^1.2.5",
- "neo-async": "^2.6.0",
- "source-map": "^0.6.1",
- "uglify-js": "^3.1.4",
- "wordwrap": "^1.0.0"
- },
- "dependencies": {
- "source-map": {
- "version": "0.6.1",
- "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
- "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
- "dev": true
- }
- }
- },
"har-schema": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz",
@@ -15093,12 +15034,6 @@
"minimist": "^1.2.5"
}
},
- "jsonc-parser": {
- "version": "3.0.0",
- "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.0.0.tgz",
- "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==",
- "dev": true
- },
"jsonfile": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",
@@ -15718,15 +15653,6 @@
"integrity": "sha1-HADHQ7QzzQpOgHWPe2SldEDZ/wA=",
"dev": true
},
- "linkify-it": {
- "version": "3.0.2",
- "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-3.0.2.tgz",
- "integrity": "sha512-gDBO4aHNZS6coiZCKVhSNh43F9ioIL4JwRjLZPkoLIY4yZFwg264Y5lu2x6rb1Js42Gh6Yqm2f6L2AJcnkzinQ==",
- "dev": true,
- "requires": {
- "uc.micro": "^1.0.1"
- }
- },
"lint-staged": {
"version": "10.5.1",
"resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-10.5.1.tgz",
@@ -16165,12 +16091,6 @@
"resolved": "https://registry.npmjs.org/lodash.defaults/-/lodash.defaults-4.2.0.tgz",
"integrity": "sha1-0JF4cW/+pN3p5ft7N/bwgCJ0WAw="
},
- "lodash.differencewith": {
- "version": "4.5.0",
- "resolved": "https://registry.npmjs.org/lodash.differencewith/-/lodash.differencewith-4.5.0.tgz",
- "integrity": "sha1-uvr7yRi1UVTheRdqALsK76rIVLc=",
- "dev": true
- },
"lodash.endswith": {
"version": "4.2.1",
"resolved": "https://registry.npmjs.org/lodash.endswith/-/lodash.endswith-4.2.1.tgz",
@@ -16629,12 +16549,6 @@
"yallist": "^3.0.2"
}
},
- "lunr": {
- "version": "2.3.9",
- "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
- "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==",
- "dev": true
- },
"macos-release": {
"version": "2.4.1",
"resolved": "https://registry.npmjs.org/macos-release/-/macos-release-2.4.1.tgz",
@@ -16808,88 +16722,6 @@
"object-visit": "^1.0.0"
}
},
- "markdown-it": {
- "version": "12.0.2",
- "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-12.0.2.tgz",
- "integrity": "sha512-4Lkvjbv2kK+moL9TbeV+6/NHx+1Q+R/NIdUlFlkqkkzUcTod4uiyTJRiBidKR9qXSdkNFkgv+AELY8KN9vSgVA==",
- "dev": true,
- "requires": {
- "argparse": "^2.0.1",
- "entities": "~2.0.0",
- "linkify-it": "^3.0.1",
- "mdurl": "^1.0.1",
- "uc.micro": "^1.0.5"
- },
- "dependencies": {
- "argparse": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
- "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
- "dev": true
- }
- }
- },
- "markdownlint": {
- "version": "0.22.0",
- "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.22.0.tgz",
- "integrity": "sha512-J4B+iMc12pOdp/wfYi03W2qfAfEyiZzq3qvQh/8vOMNU8vXYY6Jg440EY7dWTBCqROhb1i4nAn3BTByJ5kdx1w==",
- "dev": true,
- "requires": {
- "markdown-it": "12.0.2"
- }
- },
- "markdownlint-cli": {
- "version": "0.26.0",
- "resolved": "https://registry.npmjs.org/markdownlint-cli/-/markdownlint-cli-0.26.0.tgz",
- "integrity": "sha512-biLfeGNZG9nw0yJbtFBzRlew2/P5w7JSseKwolSox3zejs7dLpGvPgqbC+iqJnqqGWcWLtXaXh8bBEKWmfl10A==",
- "dev": true,
- "requires": {
- "commander": "~6.2.1",
- "deep-extend": "~0.6.0",
- "get-stdin": "~8.0.0",
- "glob": "~7.1.6",
- "ignore": "~5.1.8",
- "js-yaml": "~3.14.1",
- "jsonc-parser": "~3.0.0",
- "lodash.differencewith": "~4.5.0",
- "lodash.flatten": "~4.4.0",
- "markdownlint": "~0.22.0",
- "markdownlint-rule-helpers": "~0.13.0",
- "minimatch": "~3.0.4",
- "minimist": "~1.2.5",
- "rc": "~1.2.8"
- },
- "dependencies": {
- "commander": {
- "version": "6.2.1",
- "resolved": "https://registry.npmjs.org/commander/-/commander-6.2.1.tgz",
- "integrity": "sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA==",
- "dev": true
- },
- "js-yaml": {
- "version": "3.14.1",
- "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
- "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
- "dev": true,
- "requires": {
- "argparse": "^1.0.7",
- "esprima": "^4.0.0"
- }
- }
- }
- },
- "markdownlint-rule-helpers": {
- "version": "0.13.0",
- "resolved": "https://registry.npmjs.org/markdownlint-rule-helpers/-/markdownlint-rule-helpers-0.13.0.tgz",
- "integrity": "sha512-rRY0itbcHG4e+ntz0bbY3AIceSJMKS0TafEMgEtKVHRZ54/JUSy6/4ypCL618RlJvYRej+xMLxX5nkJqIeTZaQ==",
- "dev": true
- },
- "marked": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.0.tgz",
- "integrity": "sha512-NqRSh2+LlN2NInpqTQnS614Y/3NkVMFFU6sJlRFEpxJ/LHuK/qJECH7/fXZjk4VZstPW/Pevjil/VtSONsLc7Q==",
- "dev": true
- },
"mathml-tag-names": {
"version": "2.1.3",
"resolved": "https://registry.npmjs.org/mathml-tag-names/-/mathml-tag-names-2.1.3.tgz",
@@ -16907,27 +16739,6 @@
"safe-buffer": "^5.1.2"
}
},
- "mdast": {
- "version": "3.0.0",
- "resolved": "https://registry.npmjs.org/mdast/-/mdast-3.0.0.tgz",
- "integrity": "sha1-YmvOlgPtQ/tvsFMkWm5KF/RFeqg=",
- "dev": true
- },
- "mdast-comment-marker": {
- "version": "1.1.2",
- "resolved": "https://registry.npmjs.org/mdast-comment-marker/-/mdast-comment-marker-1.1.2.tgz",
- "integrity": "sha512-vTFXtmbbF3rgnTh3Zl3irso4LtvwUq/jaDvT2D1JqTGAwaipcS7RpTxzi6KjoRqI9n2yuAhzLDAC8xVTF3XYVQ==",
- "dev": true
- },
- "mdast-util-compact": {
- "version": "3.0.0",
- "resolved": "https://registry.npmjs.org/mdast-util-compact/-/mdast-util-compact-3.0.0.tgz",
- "integrity": "sha512-6Cua3mYMywg7TXmDtbzVia7aiUINDCs4E9+IR4+uRRV/tzCR/efIiaxaMiNZ5XB0FOi0AVzbvqAhS5UUv7a0Vg==",
- "dev": true,
- "requires": {
- "unist-util-visit": "^2.0.0"
- }
- },
"mdast-util-from-markdown": {
"version": "0.8.1",
"resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-0.8.1.tgz",
@@ -16940,24 +16751,6 @@
"parse-entities": "^2.0.0"
}
},
- "mdast-util-frontmatter": {
- "version": "0.2.0",
- "resolved": "https://registry.npmjs.org/mdast-util-frontmatter/-/mdast-util-frontmatter-0.2.0.tgz",
- "integrity": "sha512-FHKL4w4S5fdt1KjJCwB0178WJ0evnyyQr5kXTM3wrOVpytD0hrkvd+AOOjU9Td8onOejCkmZ+HQRT3CZ3coHHQ==",
- "dev": true,
- "requires": {
- "micromark-extension-frontmatter": "^0.2.0"
- }
- },
- "mdast-util-heading-range": {
- "version": "2.1.5",
- "resolved": "https://registry.npmjs.org/mdast-util-heading-range/-/mdast-util-heading-range-2.1.5.tgz",
- "integrity": "sha512-jXbFD0C+MfRkwsaze+btzG9CmVrxnc5kpcJLtx3SvSlPWnNdGMlDRHKDB9/TIPEq9nRHnkixppT8yvaUJ5agJg==",
- "dev": true,
- "requires": {
- "mdast-util-to-string": "^1.0.0"
- }
- },
"mdast-util-to-markdown": {
"version": "0.5.3",
"resolved": "https://registry.npmjs.org/mdast-util-to-markdown/-/mdast-util-to-markdown-0.5.3.tgz",
@@ -16978,43 +16771,12 @@
"integrity": "sha512-jVU0Nr2B9X3MU4tSK7JP1CMkSvOj7X5l/GboG1tKRw52lLF1x2Ju92Ms9tNetCcbfX3hzlM73zYo2NKkWSfF/A==",
"dev": true
},
- "mdast-util-toc": {
- "version": "5.0.3",
- "resolved": "https://registry.npmjs.org/mdast-util-toc/-/mdast-util-toc-5.0.3.tgz",
- "integrity": "sha512-A3xzcgC1XFHK0+abFmbINOxjwo7Bi0Nsfp3yTgTy5JHo2q2V6YZ5BVJreDWoK3szcLlSMvHqe8WPbjY50wAkow==",
- "dev": true,
- "requires": {
- "@types/mdast": "^3.0.3",
- "@types/unist": "^2.0.3",
- "extend": "^3.0.2",
- "github-slugger": "^1.2.1",
- "mdast-util-to-string": "^1.0.5",
- "unist-util-is": "^4.0.0",
- "unist-util-visit": "^2.0.0"
- }
- },
- "mdast-zone": {
- "version": "4.0.1",
- "resolved": "https://registry.npmjs.org/mdast-zone/-/mdast-zone-4.0.1.tgz",
- "integrity": "sha512-xWb6LpIWlDjaD5bT9/wDtCu/K7Ro/eu19jE2k8WzAzRaW6w9vwUyx+cXLBeTzPVoMyijJVVZxpLAl0bZOx9ikg==",
- "dev": true,
- "requires": {
- "mdast-comment-marker": "^1.0.0",
- "unist-util-visit": "^2.0.0"
- }
- },
"mdn-data": {
"version": "2.0.4",
"resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.4.tgz",
"integrity": "sha512-iV3XNKw06j5Q7mi6h+9vbx23Tv7JkjEVgKHW4pimwyDGWm0OIQntJJ+u1C6mg6mK1EaTv42XQ7w76yuzH7M2cA==",
"dev": true
},
- "mdurl": {
- "version": "1.0.1",
- "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz",
- "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=",
- "dev": true
- },
"media-typer": {
"version": "0.3.0",
"resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz",
@@ -17305,15 +17067,6 @@
"parse-entities": "^2.0.0"
}
},
- "micromark-extension-frontmatter": {
- "version": "0.2.2",
- "resolved": "https://registry.npmjs.org/micromark-extension-frontmatter/-/micromark-extension-frontmatter-0.2.2.tgz",
- "integrity": "sha512-q6nPLFCMTLtfsctAuS0Xh4vaolxSFUWUWR6PZSrXXiRy+SANGllpcqdXFv2z07l0Xz/6Hl40hK0ffNCJPH2n1A==",
- "dev": true,
- "requires": {
- "fault": "^1.0.0"
- }
- },
"micromatch": {
"version": "4.0.2",
"resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz",
@@ -17900,9 +17653,9 @@
"integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ=="
},
"node-fetch": {
- "version": "2.6.0",
- "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.0.tgz",
- "integrity": "sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==",
+ "version": "2.6.1",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz",
+ "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==",
"dev": true
},
"node-fetch-npm": {
@@ -18429,12 +18182,6 @@
"resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-4.5.0.tgz",
"integrity": "sha512-2s47yzUxdexf1OhyRi4Em83iQk0aPvwTddtFz4hnSSw9dCEsLEGf6SwIO8ss/19S9iBb5sJaOuTvTGDeZI00BQ=="
},
- "not": {
- "version": "0.1.0",
- "resolved": "https://registry.npmjs.org/not/-/not-0.1.0.tgz",
- "integrity": "sha1-yWkcF0bFXc++VMvYvU/wQbwrUZ0=",
- "dev": true
- },
"npm-bundled": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/npm-bundled/-/npm-bundled-1.1.1.tgz",
@@ -18750,15 +18497,6 @@
"mimic-fn": "^1.0.0"
}
},
- "onigasm": {
- "version": "2.2.5",
- "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz",
- "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==",
- "dev": true,
- "requires": {
- "lru-cache": "^5.1.1"
- }
- },
"open": {
"version": "7.2.0",
"resolved": "https://registry.npmjs.org/open/-/open-7.2.0.tgz",
@@ -21531,15 +21269,6 @@
"picomatch": "^2.2.1"
}
},
- "rechoir": {
- "version": "0.6.2",
- "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz",
- "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=",
- "dev": true,
- "requires": {
- "resolve": "^1.1.6"
- }
- },
"redent": {
"version": "3.0.0",
"resolved": "https://registry.npmjs.org/redent/-/redent-3.0.0.tgz",
@@ -21661,16 +21390,6 @@
"unified": "^9.1.0"
}
},
- "remark-frontmatter": {
- "version": "3.0.0",
- "resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-3.0.0.tgz",
- "integrity": "sha512-mSuDd3svCHs+2PyO29h7iijIZx4plX0fheacJcAoYAASfgzgVIcXGYSq9GFyYocFLftQs8IOmmkgtOovs6d4oA==",
- "dev": true,
- "requires": {
- "mdast-util-frontmatter": "^0.2.0",
- "micromark-extension-frontmatter": "^0.2.0"
- }
- },
"remark-parse": {
"version": "9.0.0",
"resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-9.0.0.tgz",
@@ -23029,27 +22748,6 @@
"integrity": "sha512-mRz/m/JVscCrkMyPqHc/bczi3OQHkLTqXHEFu0zDhK/qfv3UcOA4SVmRCLmos4bhjr9ekVQubj/R7waKapmiQg==",
"dev": true
},
- "shelljs": {
- "version": "0.8.4",
- "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz",
- "integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==",
- "dev": true,
- "requires": {
- "glob": "^7.0.0",
- "interpret": "^1.0.0",
- "rechoir": "^0.6.2"
- }
- },
- "shiki": {
- "version": "0.9.2",
- "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.2.tgz",
- "integrity": "sha512-BjUCxVbxMnvjs8jC4b+BQ808vwjJ9Q8NtLqPwXShZ307HdXiDFYP968ORSVfaTNNSWYDBYdMnVKJ0fYNsoZUBA==",
- "dev": true,
- "requires": {
- "onigasm": "^2.2.5",
- "vscode-textmate": "^5.2.0"
- }
- },
"sigmund": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/sigmund/-/sigmund-1.0.1.tgz",
@@ -26549,61 +26247,6 @@
"is-typedarray": "^1.0.0"
}
},
- "typedoc": {
- "version": "0.20.27",
- "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.27.tgz",
- "integrity": "sha512-Y61T2wEpBo6x0t0zeMNH6CH0n2Jt8E1IHObcK4fGT9nK9Zq6+Rurf0A9WqVbhRmkGpu1wBsGl+4kSJdIN+AOtg==",
- "dev": true,
- "requires": {
- "colors": "^1.4.0",
- "fs-extra": "^9.1.0",
- "handlebars": "^4.7.6",
- "lodash": "^4.17.20",
- "lunr": "^2.3.9",
- "marked": "^2.0.0",
- "minimatch": "^3.0.0",
- "progress": "^2.0.3",
- "shelljs": "^0.8.4",
- "shiki": "^0.9.2",
- "typedoc-default-themes": "^0.12.7"
- },
- "dependencies": {
- "fs-extra": {
- "version": "9.1.0",
- "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz",
- "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==",
- "dev": true,
- "requires": {
- "at-least-node": "^1.0.0",
- "graceful-fs": "^4.2.0",
- "jsonfile": "^6.0.1",
- "universalify": "^2.0.0"
- }
- },
- "jsonfile": {
- "version": "6.1.0",
- "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
- "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
- "dev": true,
- "requires": {
- "graceful-fs": "^4.1.6",
- "universalify": "^2.0.0"
- }
- },
- "universalify": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz",
- "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==",
- "dev": true
- }
- }
- },
- "typedoc-default-themes": {
- "version": "0.12.7",
- "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.7.tgz",
- "integrity": "sha512-0XAuGEqID+gon1+fhi4LycOEFM+5Mvm2PjwaiVZNAzU7pn3G2DEpsoXnFOPlLDnHY6ZW0BY0nO7ur9fHOFkBLQ==",
- "dev": true
- },
"typescript": {
"version": "3.9.8",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.8.tgz",
@@ -26616,19 +26259,6 @@
"integrity": "sha512-m4hvMLxgGHXG3O3fQVAyyAQpZzDOvwnhOTjYz5Xmr7r/+LpkNy3vJXdVRWgd1TkAb7NGROZuSy96CrlNVjA7KA==",
"dev": true
},
- "uc.micro": {
- "version": "1.0.6",
- "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz",
- "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==",
- "dev": true
- },
- "uglify-js": {
- "version": "3.12.8",
- "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.12.8.tgz",
- "integrity": "sha512-fvBeuXOsvqjecUtF/l1dwsrrf5y2BCUk9AOJGzGcm6tE7vegku5u/YvqjyDaAGr422PLoLnrxg3EnRvTqsdC1w==",
- "dev": true,
- "optional": true
- },
"unicode-canonical-property-names-ecmascript": {
"version": "1.0.4",
"resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-1.0.4.tgz",
@@ -26750,19 +26380,6 @@
"integrity": "sha512-Ofx8uf6haexJwI1gxWMGg6I/dLnF2yE+KibhD3/diOqY2TinLcqHXCV6OI5gFVn3xQqDH+u0M625pfKwIwgBKQ==",
"dev": true
},
- "unist-util-select": {
- "version": "3.0.2",
- "resolved": "https://registry.npmjs.org/unist-util-select/-/unist-util-select-3.0.2.tgz",
- "integrity": "sha512-LuxE3L0joWDkKjzIMWnVYNjZdvTZpLB5HyAOOneokzCZqXbvaKVTnxoJRtU1uE6dgymg+oNKUoveN/ixHD9Ncw==",
- "dev": true,
- "requires": {
- "css-selector-parser": "^1.0.0",
- "not": "^0.1.0",
- "nth-check": "^1.0.0",
- "unist-util-is": "^4.0.0",
- "zwitch": "^1.0.0"
- }
- },
"unist-util-stringify-position": {
"version": "2.0.3",
"resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-2.0.3.tgz",
@@ -26772,27 +26389,6 @@
"@types/unist": "^2.0.2"
}
},
- "unist-util-visit": {
- "version": "2.0.3",
- "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-2.0.3.tgz",
- "integrity": "sha512-iJ4/RczbJMkD0712mGktuGpm/U4By4FfDonL7N/9tATGIF4imikjOuagyMY53tnZq3NP6BcmlrHhEKAfGWjh7Q==",
- "dev": true,
- "requires": {
- "@types/unist": "^2.0.0",
- "unist-util-is": "^4.0.0",
- "unist-util-visit-parents": "^3.0.0"
- }
- },
- "unist-util-visit-parents": {
- "version": "3.1.0",
- "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-3.1.0.tgz",
- "integrity": "sha512-0g4wbluTF93npyPrp/ymd3tCDTMnP0yo2akFD2FIBAYXq/Sga3lwaU1D8OYKbtpioaI6CkDcQ6fsMnmtzt7htw==",
- "dev": true,
- "requires": {
- "@types/unist": "^2.0.0",
- "unist-util-is": "^4.0.0"
- }
- },
"universal-analytics": {
"version": "0.4.23",
"resolved": "https://registry.npmjs.org/universal-analytics/-/universal-analytics-0.4.23.tgz",
@@ -27158,12 +26754,6 @@
"resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.16.0.tgz",
"integrity": "sha512-k8luDIWJWyenLc5ToFQQMaSrqCHiLwyKPHKPQZ5zz21vM+vIVUSvsRpcbiECH4WR88K2XZqc4ScRcZ7nk/jbeA=="
},
- "vscode-textmate": {
- "version": "5.2.0",
- "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz",
- "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==",
- "dev": true
- },
"vscode-uri": {
"version": "3.0.2",
"resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-3.0.2.tgz",
@@ -28782,12 +28372,6 @@
"resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz",
"integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ=="
},
- "wordwrap": {
- "version": "1.0.0",
- "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
- "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=",
- "dev": true
- },
"worker-farm": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/worker-farm/-/worker-farm-1.7.0.tgz",
diff --git a/package.json b/package.json
index c0483fd045..2d5a62d62e 100644
--- a/package.json
+++ b/package.json
@@ -15,7 +15,7 @@
"00s": "",
"build-doc-tools": "tsc -p ./tools/doc/tsconfig.json",
"markdownlint": "markdownlint ./docs",
- "docbuild": "node node_modules/typedoc/bin/typedoc --tsconfig lib/tsconfig.doc.json && node tools/doc/buildYamlSourceInfo.js docs/docs.json && node ./tools/doc/docProcessor.js",
+ "docbuild": "node tools/doc/node_modules/typedoc/bin/typedoc --tsconfig lib/tsconfig.doc.json && node tools/doc/buildYamlSourceInfo.js docs/docs.json && node ./tools/doc/docProcessor.js",
"license-checker": "license-checker --production --failOn 'GPL;GPL-2.0' > licenses.txt",
"review-checker": "node ./tools/doc/reviewChecker.js",
"01": "echo -------------------------------------------- Build Lib -----------------------------------------------",
@@ -96,7 +96,6 @@
"custom-event-polyfill": "^1.0.7",
"minimatch": "^3.0.4",
"minimatch-browser": "1.0.0",
- "moment": "2.29.1",
"moment-es6": "^1.0.0",
"ng2-charts": "2.4.2",
"ngx-monaco-editor": "8.1.1",
@@ -115,13 +114,13 @@
"@angular/compiler-cli": "^10.0.12",
"@nrwl/schematics": "8.12.11",
"@nrwl/workspace": "^11.2.11",
- "@paperist/types-remark": "^0.1.3",
"@types/jasmine": "~2.8.3",
"@types/jasminewd2": "~2.0.2",
"@types/minimatch": "^3.0.3",
"@types/node": "^14.14.26",
"@types/pdfjs-dist": "^2.1.5",
"@types/request": "^2.48.5",
+ "@paperist/types-remark": "0.1.3",
"@types/selenium-webdriver": "^4.0.11",
"ajv-cli": "^3.0.0",
"codelyzer": "^6.0.1",
@@ -130,7 +129,6 @@
"cspell": "^5.3.3",
"css-loader": "^5.1.0",
"dotenv": "^8.2.0",
- "ejs": "^3.1.6",
"github-api": "^3.4.0",
"graphql": "^15.4.0",
"graphql-request": "^3.1.0",
@@ -150,12 +148,6 @@
"license-checker": "^25.0.1",
"lint-staged": "^10.5.1",
"lite-server": "^2.6.1",
- "markdownlint-cli": "^0.26.0",
- "mdast": "^3.0.0",
- "mdast-util-compact": "^3.0.0",
- "mdast-util-heading-range": "^2.1.5",
- "mdast-util-toc": "^5.0.3",
- "mdast-zone": "^4.0.1",
"mini-css-extract-plugin": "^1.3.9",
"nconf": "^0.11.1",
"ng-packagr": "^10.1.2",
@@ -164,8 +156,6 @@
"protractor-retry-angular-cli": "^2.0.2",
"protractor-screenshoter-plugin": "0.10.3",
"protractor-smartrunner": "^2.0.0-beta6",
- "remark": "^13.0.0",
- "remark-frontmatter": "^3.0.0",
"rimraf": "^3.0.2",
"rxjs-tslint-rules": "^4.34.7",
"sass-loader": "10.1.1",
@@ -175,9 +165,7 @@
"ts-node": "^9.0.0",
"tsconfig-paths": "^3.9.0",
"tslint": "6.1.3",
- "typedoc": "^0.20.27",
"typescript": "3.9.8",
- "unist-util-select": "^3.0.2",
"webdriver-manager": "12.1.8",
"webpack-cli": "^3.3.12"
},
diff --git a/tools/doc/doctool.config.json b/tools/doc/doctool.config.json
index 715c576870..1320e30d63 100644
--- a/tools/doc/doctool.config.json
+++ b/tools/doc/doctool.config.json
@@ -227,5 +227,11 @@
"tutorials",
"user-guide",
"versionIndex"
+ ],
+ "ignoreLinkWords" : [
+ "Type",
+ "model",
+ "Node",
+ "User"
]
}
diff --git a/tools/doc/mdNav.js b/tools/doc/mdNav.js
index 04b0e5c6c9..d6bd6baf23 100644
--- a/tools/doc/mdNav.js
+++ b/tools/doc/mdNav.js
@@ -1,5 +1,6 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
+exports.MDNav = void 0;
var MDNav = /** @class */ (function () {
function MDNav(root, pos) {
if (pos === void 0) { pos = 0; }
@@ -161,7 +162,7 @@ var MDNav = /** @class */ (function () {
return this.root.children[this.pos];
}
},
- enumerable: true,
+ enumerable: false,
configurable: true
});
Object.defineProperty(MDNav.prototype, "empty", {
@@ -170,14 +171,14 @@ var MDNav = /** @class */ (function () {
!this.root.children ||
(this.pos >= this.root.children.length);
},
- enumerable: true,
+ enumerable: false,
configurable: true
});
Object.defineProperty(MDNav.prototype, "childNav", {
get: function () {
return new MDNav(this.item);
},
- enumerable: true,
+ enumerable: false,
configurable: true
});
Object.defineProperty(MDNav.prototype, "value", {
@@ -189,7 +190,7 @@ var MDNav = /** @class */ (function () {
return '';
}
},
- enumerable: true,
+ enumerable: false,
configurable: true
});
Object.defineProperty(MDNav.prototype, "textValue", {
@@ -211,7 +212,7 @@ var MDNav = /** @class */ (function () {
return '';
}
},
- enumerable: true,
+ enumerable: false,
configurable: true
});
return MDNav;
diff --git a/tools/doc/mqDefs.js b/tools/doc/mqDefs.js
index 69f1481f0a..71e7bc8bf1 100644
--- a/tools/doc/mqDefs.js
+++ b/tools/doc/mqDefs.js
@@ -5,7 +5,7 @@ var __extends = (this && this.__extends) || (function () {
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
- }
+ };
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
@@ -13,6 +13,7 @@ var __extends = (this && this.__extends) || (function () {
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
+exports.Docset = exports.Text = exports.Link = exports.Paragraph = exports.Heading = exports.Root = exports.Parent = exports.Node = exports.schema = void 0;
var mdToString = require("mdast-util-to-string");
var jsyaml = require("js-yaml");
exports.schema = "\n type Query {\n documents(idFilter: String = \"\"): [Root]\n }\n\n type Root {\n id: ID\n type: String\n folder(depth: Int = 1): String\n metadata(key: String): String\n heading(depth: Int = 0): Heading\n headings(depth: Int = 0): [Heading]\n paragraph: Paragraph\n paragraphs: [Paragraph]\n link: Link\n links: [Link]\n text: Text\n texts: [Text]\n children: [Node]\n }\n\n type Heading {\n depth: Int\n plaintext: String\n paragraph: Paragraph\n paragraphs: [Paragraph]\n link: Link\n links: [Link]\n children: [Node]\n }\n\n type Paragraph {\n plaintext: String\n }\n\n type Link {\n plaintext: String\n title: String\n url: String\n paragraph: Paragraph\n paragraphs: [Paragraph]\n text: Text\n texts: [Text]\n }\n\n type Text {\n value: String\n }\n\n type Node {\n type: String\n children: [Node]\n }\n";
diff --git a/tools/doc/package-lock.json b/tools/doc/package-lock.json
new file mode 100644
index 0000000000..7b38aaaf34
--- /dev/null
+++ b/tools/doc/package-lock.json
@@ -0,0 +1,3105 @@
+{
+ "name": "adf-doc-tools",
+ "version": "4.2.0",
+ "lockfileVersion": 1,
+ "requires": true,
+ "dependencies": {
+ "@alfresco/js-api": {
+ "version": "4.3.0-fc33b5aba2cdfe131d2f061049691b5e5b6fe59b",
+ "resolved": "https://registry.npmjs.org/@alfresco/js-api/-/js-api-4.3.0-fc33b5aba2cdfe131d2f061049691b5e5b6fe59b.tgz",
+ "integrity": "sha512-lp+rlcNE3DfS9Pua6imdtFqmVyNztiJPLvcgv1XKg2yRHhWdzNfvufbAWtPq5i4ZjcIPlCvydDgABDof3YGDMg==",
+ "requires": {
+ "event-emitter": "^0.3.5",
+ "minimatch": "3.0.4",
+ "superagent": "^6.0.0"
+ }
+ },
+ "@paperist/types-remark": {
+ "version": "0.1.3",
+ "resolved": "https://registry.npmjs.org/@paperist/types-remark/-/types-remark-0.1.3.tgz",
+ "integrity": "sha512-liJvMxGB0IinhxcoMYiSVOgk2z5CZ5/gvpNCXzVC9xVGVtON0lLJZro1ixo5qZJg1ir6N0BY99Y1u6jp2ZNYEg==",
+ "dev": true
+ },
+ "@types/minimatch": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.3.tgz",
+ "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA=="
+ },
+ "@types/node": {
+ "version": "14.14.31",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.31.tgz",
+ "integrity": "sha512-vFHy/ezP5qI0rFgJ7aQnjDXwAMrG0KqqIH7tQG5PPv3BWBayOPIQNBjVc/P6hhdZfMx51REc6tfDNXHUio893g==",
+ "dev": true
+ },
+ "ansi-escapes": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-1.4.0.tgz",
+ "integrity": "sha1-06ioOzGapneTZisT52HHkRQiMG4="
+ },
+ "ansi-regex": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz",
+ "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8="
+ },
+ "ansi-styles": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
+ "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
+ "requires": {
+ "color-convert": "^1.9.0"
+ }
+ },
+ "anymatch": {
+ "version": "1.3.2",
+ "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-1.3.2.tgz",
+ "integrity": "sha512-0XNayC8lTHQ2OI8aljNCN3sSx6hsr/1+rlcDAotXJR7C1oZZHCNsfpbKwMjRA3Uqb5tF1Rae2oloTr4xpq+WjA==",
+ "requires": {
+ "micromatch": "^2.1.5",
+ "normalize-path": "^2.0.0"
+ }
+ },
+ "argparse": {
+ "version": "1.0.10",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
+ "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
+ "requires": {
+ "sprintf-js": "~1.0.2"
+ }
+ },
+ "arr-diff": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/arr-diff/-/arr-diff-2.0.0.tgz",
+ "integrity": "sha1-jzuCf5Vai9ZpaX5KQlasPOrjVs8=",
+ "requires": {
+ "arr-flatten": "^1.0.1"
+ }
+ },
+ "arr-flatten": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/arr-flatten/-/arr-flatten-1.1.0.tgz",
+ "integrity": "sha512-L3hKV5R/p5o81R7O02IGnwpDmkp6E982XhtbuwSe3O4qOtMMMtodicASA1Cny2U+aCXcNpml+m4dPsvsJ3jatg=="
+ },
+ "arr-union": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/arr-union/-/arr-union-3.1.0.tgz",
+ "integrity": "sha1-45sJrqne+Gao8gbiiK9jkZuuOcQ="
+ },
+ "array-unique": {
+ "version": "0.2.1",
+ "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.2.1.tgz",
+ "integrity": "sha1-odl8yvy8JiXMcPrc6zalDFiwGlM="
+ },
+ "assign-symbols": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/assign-symbols/-/assign-symbols-1.0.0.tgz",
+ "integrity": "sha1-WWZ/QfrdTyDMvCu5a41Pf3jsA2c="
+ },
+ "async": {
+ "version": "0.9.2",
+ "resolved": "https://registry.npmjs.org/async/-/async-0.9.2.tgz",
+ "integrity": "sha1-rqdNXmHB+JlhO/ZL2mbUx48v0X0="
+ },
+ "async-each": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/async-each/-/async-each-1.0.3.tgz",
+ "integrity": "sha512-z/WhQ5FPySLdvREByI2vZiTWwCnF0moMJ1hK9YQwDTHKh6I7/uSckMetoRGb5UBZPC1z0jlw+n/XCgjeH7y1AQ=="
+ },
+ "asynckit": {
+ "version": "0.4.0",
+ "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
+ "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k="
+ },
+ "atob": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/atob/-/atob-2.1.2.tgz",
+ "integrity": "sha512-Wm6ukoaOGJi/73p/cl2GvLjTI5JM1k/O14isD73YML8StrH/7/lRFgmg8nICZgD3bZZvjwCGxtMOD3wWNAu8cg=="
+ },
+ "attach-ware": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/attach-ware/-/attach-ware-1.1.1.tgz",
+ "integrity": "sha1-KPUTk92LuL2q2XI0JRm/CWIaNaM=",
+ "requires": {
+ "unherit": "^1.0.0"
+ }
+ },
+ "backbone": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/backbone/-/backbone-1.4.0.tgz",
+ "integrity": "sha512-RLmDrRXkVdouTg38jcgHhyQ/2zjg7a8E6sz2zxfz21Hh17xDJYUHBZimVIt5fUyS8vbfpeSmTL3gUjTEvUV3qQ==",
+ "requires": {
+ "underscore": ">=1.8.3"
+ }
+ },
+ "bail": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/bail/-/bail-1.0.5.tgz",
+ "integrity": "sha512-xFbRxM1tahm08yHBP16MMjVUAvDaBMD38zsM9EMAUN61omwLmKlOpB/Zku5QkjZ8TZ4vn53pj+t518cH0S03RQ=="
+ },
+ "balanced-match": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz",
+ "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c="
+ },
+ "base": {
+ "version": "0.11.2",
+ "resolved": "https://registry.npmjs.org/base/-/base-0.11.2.tgz",
+ "integrity": "sha512-5T6P4xPgpp0YDFvSWwEZ4NoE3aM4QBQXDzmVbraCkFj8zHM+mba8SyqB5DbZWyR7mYHo6Y7BdQo3MoA4m0TeQg==",
+ "requires": {
+ "cache-base": "^1.0.1",
+ "class-utils": "^0.3.5",
+ "component-emitter": "^1.2.1",
+ "define-property": "^1.0.0",
+ "isobject": "^3.0.1",
+ "mixin-deep": "^1.2.0",
+ "pascalcase": "^0.1.1"
+ },
+ "dependencies": {
+ "define-property": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz",
+ "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=",
+ "requires": {
+ "is-descriptor": "^1.0.0"
+ }
+ },
+ "is-accessor-descriptor": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz",
+ "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==",
+ "requires": {
+ "kind-of": "^6.0.0"
+ }
+ },
+ "is-data-descriptor": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz",
+ "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==",
+ "requires": {
+ "kind-of": "^6.0.0"
+ }
+ },
+ "is-descriptor": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz",
+ "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==",
+ "requires": {
+ "is-accessor-descriptor": "^1.0.0",
+ "is-data-descriptor": "^1.0.0",
+ "kind-of": "^6.0.2"
+ }
+ },
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ },
+ "kind-of": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
+ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw=="
+ }
+ }
+ },
+ "binary-extensions": {
+ "version": "1.13.1",
+ "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-1.13.1.tgz",
+ "integrity": "sha512-Un7MIEDdUC5gNpcGDV97op1Ywk748MpHcFTHoYs6qnj1Z3j7I53VG3nwZhKzoBZmbdRNnb6WRdFlwl7tSDuZGw=="
+ },
+ "bindings": {
+ "version": "1.5.0",
+ "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.5.0.tgz",
+ "integrity": "sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==",
+ "optional": true,
+ "requires": {
+ "file-uri-to-path": "1.0.0"
+ }
+ },
+ "boolbase": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz",
+ "integrity": "sha1-aN/1++YMUes3cl6p4+0xDcwed24="
+ },
+ "brace-expansion": {
+ "version": "1.1.11",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
+ "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
+ "requires": {
+ "balanced-match": "^1.0.0",
+ "concat-map": "0.0.1"
+ }
+ },
+ "braces": {
+ "version": "1.8.5",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-1.8.5.tgz",
+ "integrity": "sha1-uneWLhLf+WnWt2cR6RS3N4V79qc=",
+ "requires": {
+ "expand-range": "^1.8.1",
+ "preserve": "^0.2.0",
+ "repeat-element": "^1.1.2"
+ }
+ },
+ "buffer-from": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz",
+ "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A=="
+ },
+ "cache-base": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/cache-base/-/cache-base-1.0.1.tgz",
+ "integrity": "sha512-AKcdTnFSWATd5/GCPRxr2ChwIJ85CeyrEyjRHlKxQ56d4XJMGym0uAiKn0xbLOGOl3+yRpOTi484dVCEc5AUzQ==",
+ "requires": {
+ "collection-visit": "^1.0.0",
+ "component-emitter": "^1.2.1",
+ "get-value": "^2.0.6",
+ "has-value": "^1.0.0",
+ "isobject": "^3.0.1",
+ "set-value": "^2.0.0",
+ "to-object-path": "^0.3.0",
+ "union-value": "^1.0.0",
+ "unset-value": "^1.0.0"
+ },
+ "dependencies": {
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ }
+ }
+ },
+ "camelcase": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-1.2.1.tgz",
+ "integrity": "sha1-m7UwTS4LVmmLLHWLCKPqqdqlijk="
+ },
+ "ccount": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/ccount/-/ccount-1.1.0.tgz",
+ "integrity": "sha512-vlNK021QdI7PNeiUh/lKkC/mNHHfV0m/Ad5JoI0TYtlBnJAslM/JIkm/tGC88bkLIwO6OQ5uV6ztS6kVAtCDlg=="
+ },
+ "chalk": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
+ "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==",
+ "requires": {
+ "ansi-styles": "^3.2.1",
+ "escape-string-regexp": "^1.0.5",
+ "supports-color": "^5.3.0"
+ }
+ },
+ "character-entities": {
+ "version": "1.2.4",
+ "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-1.2.4.tgz",
+ "integrity": "sha512-iBMyeEHxfVnIakwOuDXpVkc54HijNgCyQB2w0VfGQThle6NXn50zU6V/u+LDhxHcDUPojn6Kpga3PTAD8W1bQw=="
+ },
+ "character-entities-html4": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-1.1.4.tgz",
+ "integrity": "sha512-HRcDxZuZqMx3/a+qrzxdBKBPUpxWEq9xw2OPZ3a/174ihfrQKVsFhqtthBInFy1zZ9GgZyFXOatNujm8M+El3g=="
+ },
+ "character-entities-legacy": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-1.1.4.tgz",
+ "integrity": "sha512-3Xnr+7ZFS1uxeiUDvV02wQ+QDbc55o97tIV5zHScSPJpcLm/r0DFPcoY3tYRp+VZukxuMeKgXYmsXQHO05zQeA=="
+ },
+ "character-reference-invalid": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-1.1.4.tgz",
+ "integrity": "sha512-mKKUkUbhPpQlCOfIuZkvSEgktjPFIsZKRRbC6KWVEMvlzblj3i3asQv5ODsrwt0N3pHAEvjP8KTQPHkp0+6jOg=="
+ },
+ "charm": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/charm/-/charm-1.0.2.tgz",
+ "integrity": "sha1-it02cVOm2aWBMxBSxAkJkdqZXjU=",
+ "requires": {
+ "inherits": "^2.0.1"
+ }
+ },
+ "chokidar": {
+ "version": "1.7.0",
+ "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-1.7.0.tgz",
+ "integrity": "sha1-eY5ol3gVHIB2tLNg5e3SjNortGg=",
+ "requires": {
+ "anymatch": "^1.3.0",
+ "async-each": "^1.0.0",
+ "fsevents": "^1.0.0",
+ "glob-parent": "^2.0.0",
+ "inherits": "^2.0.1",
+ "is-binary-path": "^1.0.0",
+ "is-glob": "^2.0.0",
+ "path-is-absolute": "^1.0.0",
+ "readdirp": "^2.0.0"
+ }
+ },
+ "class-utils": {
+ "version": "0.3.6",
+ "resolved": "https://registry.npmjs.org/class-utils/-/class-utils-0.3.6.tgz",
+ "integrity": "sha512-qOhPa/Fj7s6TY8H8esGu5QNpMMQxz79h+urzrNYN6mn+9BnxlDGf5QZ+XeCDsxSjPqsSR56XOZOJmpeurnLMeg==",
+ "requires": {
+ "arr-union": "^3.1.0",
+ "define-property": "^0.2.5",
+ "isobject": "^3.0.0",
+ "static-extend": "^0.1.1"
+ },
+ "dependencies": {
+ "define-property": {
+ "version": "0.2.5",
+ "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz",
+ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=",
+ "requires": {
+ "is-descriptor": "^0.1.0"
+ }
+ },
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ }
+ }
+ },
+ "cli-cursor": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-1.0.2.tgz",
+ "integrity": "sha1-ZNo/fValRBLll5S9Ytw1KV6PKYc=",
+ "requires": {
+ "restore-cursor": "^1.0.1"
+ }
+ },
+ "co": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/co/-/co-3.1.0.tgz",
+ "integrity": "sha1-TqVOpaCJOBUxheFSEMaNkJK8G3g="
+ },
+ "code-point-at": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz",
+ "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c="
+ },
+ "collapse-white-space": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/collapse-white-space/-/collapse-white-space-1.0.6.tgz",
+ "integrity": "sha512-jEovNnrhMuqyCcjfEJA56v0Xq8SkIoPKDyaHahwo3POf4qcSXqMYuwNcOTzp74vTsR9Tn08z4MxWqAhcekogkQ=="
+ },
+ "collection-visit": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz",
+ "integrity": "sha1-S8A3PBZLwykbTTaMgpzxqApZ3KA=",
+ "requires": {
+ "map-visit": "^1.0.0",
+ "object-visit": "^1.0.0"
+ }
+ },
+ "color-convert": {
+ "version": "1.9.3",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
+ "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
+ "requires": {
+ "color-name": "1.1.3"
+ }
+ },
+ "color-name": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
+ "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU="
+ },
+ "combined-stream": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
+ "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
+ "requires": {
+ "delayed-stream": "~1.0.0"
+ }
+ },
+ "commander": {
+ "version": "2.9.0",
+ "resolved": "https://registry.npmjs.org/commander/-/commander-2.9.0.tgz",
+ "integrity": "sha1-nJkJQXbhIkDLItbFFGCYQA/g99Q=",
+ "requires": {
+ "graceful-readlink": ">= 1.0.0"
+ }
+ },
+ "component-emitter": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.0.tgz",
+ "integrity": "sha512-Rd3se6QB+sO1TwqZjscQrurpEPIfO0/yYnSin6Q/rD3mOutHvUrCAhJub3r90uNb+SESBuE0QYoB90YdfatsRg=="
+ },
+ "concat-map": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
+ "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s="
+ },
+ "concat-stream": {
+ "version": "1.6.2",
+ "resolved": "https://registry.npmjs.org/concat-stream/-/concat-stream-1.6.2.tgz",
+ "integrity": "sha512-27HBghJxjiZtIk3Ycvn/4kbJk/1uZuJFfuPEns6LaEvpvG1f0hTea8lilrouyo9mVc2GWdcEZ8OLoGmSADlrCw==",
+ "requires": {
+ "buffer-from": "^1.0.0",
+ "inherits": "^2.0.3",
+ "readable-stream": "^2.2.2",
+ "typedarray": "^0.0.6"
+ }
+ },
+ "cookiejar": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/cookiejar/-/cookiejar-2.1.2.tgz",
+ "integrity": "sha512-Mw+adcfzPxcPeI+0WlvRrr/3lGVO0bD75SxX6811cxSh1Wbxx7xZBGK1eVtDf6si8rg2lhnUjsVLMFMfbRIuwA=="
+ },
+ "copy-descriptor": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/copy-descriptor/-/copy-descriptor-0.1.1.tgz",
+ "integrity": "sha1-Z29us8OZl8LuGsOpJP1hJHSPV40="
+ },
+ "core-util-is": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz",
+ "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac="
+ },
+ "cross-fetch": {
+ "version": "3.0.6",
+ "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.0.6.tgz",
+ "integrity": "sha512-KBPUbqgFjzWlVcURG+Svp9TlhA5uliYtiNx/0r8nv0pdypeQCRJ9IaSIc3q/x3q8t3F75cHuwxVql1HFGHCNJQ==",
+ "requires": {
+ "node-fetch": "2.6.1"
+ }
+ },
+ "css-selector-parser": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/css-selector-parser/-/css-selector-parser-1.4.1.tgz",
+ "integrity": "sha512-HYPSb7y/Z7BNDCOrakL4raGO2zltZkbeXyAd6Tg9obzix6QhzxCotdBl6VT0Dv4vZfJGVz3WL/xaEI9Ly3ul0g=="
+ },
+ "d": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/d/-/d-1.0.1.tgz",
+ "integrity": "sha512-m62ShEObQ39CfralilEQRjH6oAMtNCV1xJyEx5LpRYUVN+EviphDgUc/F3hnYbADmkiNs67Y+3ylmlG7Lnu+FA==",
+ "requires": {
+ "es5-ext": "^0.10.50",
+ "type": "^1.0.1"
+ }
+ },
+ "debug": {
+ "version": "3.2.7",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz",
+ "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==",
+ "requires": {
+ "ms": "^2.1.1"
+ }
+ },
+ "decode-uri-component": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz",
+ "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU="
+ },
+ "deep-extend": {
+ "version": "0.5.1",
+ "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.5.1.tgz",
+ "integrity": "sha512-N8vBdOa+DF7zkRrDCsaOXoCs/E2fJfx9B9MrKnnSiHNh4ws7eSys6YQE4KvT1cecKmOASYQBhbKjeuDD9lT81w=="
+ },
+ "define-property": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/define-property/-/define-property-2.0.2.tgz",
+ "integrity": "sha512-jwK2UV4cnPpbcG7+VRARKTZPUWowwXA8bzH5NP6ud0oeAxyYPuGZUAC7hMugpCdz4BeSZl2Dl9k66CHJ/46ZYQ==",
+ "requires": {
+ "is-descriptor": "^1.0.2",
+ "isobject": "^3.0.1"
+ },
+ "dependencies": {
+ "is-accessor-descriptor": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz",
+ "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==",
+ "requires": {
+ "kind-of": "^6.0.0"
+ }
+ },
+ "is-data-descriptor": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz",
+ "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==",
+ "requires": {
+ "kind-of": "^6.0.0"
+ }
+ },
+ "is-descriptor": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz",
+ "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==",
+ "requires": {
+ "is-accessor-descriptor": "^1.0.0",
+ "is-data-descriptor": "^1.0.0",
+ "kind-of": "^6.0.2"
+ }
+ },
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ },
+ "kind-of": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
+ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw=="
+ }
+ }
+ },
+ "delayed-stream": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
+ "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk="
+ },
+ "ejs": {
+ "version": "3.1.6",
+ "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.6.tgz",
+ "integrity": "sha512-9lt9Zse4hPucPkoP7FHDF0LQAlGyF9JVpnClFLFH3aSSbxmyoqINRpp/9wePWJTUl4KOQwRL72Iw3InHPDkoGw==",
+ "requires": {
+ "jake": "^10.6.1"
+ }
+ },
+ "elegant-spinner": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/elegant-spinner/-/elegant-spinner-1.0.1.tgz",
+ "integrity": "sha1-2wQ1IcldfjA/2PNFvtwzSc+wcp4="
+ },
+ "emoji-regex": {
+ "version": "6.1.1",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-6.1.1.tgz",
+ "integrity": "sha1-xs0OwbBkLio8Z6ETfvxeeW2k+I4="
+ },
+ "entities": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz",
+ "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w=="
+ },
+ "es5-ext": {
+ "version": "0.10.53",
+ "resolved": "https://registry.npmjs.org/es5-ext/-/es5-ext-0.10.53.tgz",
+ "integrity": "sha512-Xs2Stw6NiNHWypzRTY1MtaG/uJlwCk8kH81920ma8mvN8Xq1gsfhZvpkImLQArw8AHnv8MT2I45J3c0R8slE+Q==",
+ "requires": {
+ "es6-iterator": "~2.0.3",
+ "es6-symbol": "~3.1.3",
+ "next-tick": "~1.0.0"
+ }
+ },
+ "es6-iterator": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/es6-iterator/-/es6-iterator-2.0.3.tgz",
+ "integrity": "sha1-p96IkUGgWpSwhUQDstCg+/qY87c=",
+ "requires": {
+ "d": "1",
+ "es5-ext": "^0.10.35",
+ "es6-symbol": "^3.1.1"
+ }
+ },
+ "es6-symbol": {
+ "version": "3.1.3",
+ "resolved": "https://registry.npmjs.org/es6-symbol/-/es6-symbol-3.1.3.tgz",
+ "integrity": "sha512-NJ6Yn3FuDinBaBRWl/q5X/s4koRHBrgKAu+yGI6JCBeiu3qrcbJhwT2GeR/EXVfylRk8dpQVJoLEFhK+Mu31NA==",
+ "requires": {
+ "d": "^1.0.1",
+ "ext": "^1.1.2"
+ }
+ },
+ "escape-string-regexp": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
+ "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ="
+ },
+ "esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A=="
+ },
+ "event-emitter": {
+ "version": "0.3.5",
+ "resolved": "https://registry.npmjs.org/event-emitter/-/event-emitter-0.3.5.tgz",
+ "integrity": "sha1-34xp7vFkeSPHFXuc6DhAYQsCzDk=",
+ "requires": {
+ "d": "1",
+ "es5-ext": "~0.10.14"
+ }
+ },
+ "exit-hook": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/exit-hook/-/exit-hook-1.1.1.tgz",
+ "integrity": "sha1-8FyiM7SMBdVP/wd2XfhQfpXAL/g="
+ },
+ "expand-brackets": {
+ "version": "0.1.5",
+ "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-0.1.5.tgz",
+ "integrity": "sha1-3wcoTjQqgHzXM6xa9yQR5YHRF3s=",
+ "requires": {
+ "is-posix-bracket": "^0.1.0"
+ }
+ },
+ "expand-range": {
+ "version": "1.8.2",
+ "resolved": "https://registry.npmjs.org/expand-range/-/expand-range-1.8.2.tgz",
+ "integrity": "sha1-opnv/TNf4nIeuujiV+x5ZE/IUzc=",
+ "requires": {
+ "fill-range": "^2.1.0"
+ }
+ },
+ "ext": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/ext/-/ext-1.4.0.tgz",
+ "integrity": "sha512-Key5NIsUxdqKg3vIsdw9dSuXpPCQ297y6wBjL30edxwPgt2E44WcWBZey/ZvUc6sERLTxKdyCu4gZFmUbk1Q7A==",
+ "requires": {
+ "type": "^2.0.0"
+ },
+ "dependencies": {
+ "type": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/type/-/type-2.3.0.tgz",
+ "integrity": "sha512-rgPIqOdfK/4J9FhiVrZ3cveAjRRo5rsQBAIhnylX874y1DX/kEKSVdLsnuHB6l1KTjHyU01VjiMBHgU2adejyg=="
+ }
+ }
+ },
+ "extend": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz",
+ "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g=="
+ },
+ "extend-shallow": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-3.0.2.tgz",
+ "integrity": "sha1-Jqcarwc7OfshJxcnRhMcJwQCjbg=",
+ "requires": {
+ "assign-symbols": "^1.0.0",
+ "is-extendable": "^1.0.1"
+ },
+ "dependencies": {
+ "is-extendable": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz",
+ "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==",
+ "requires": {
+ "is-plain-object": "^2.0.4"
+ }
+ }
+ }
+ },
+ "extend.js": {
+ "version": "0.0.2",
+ "resolved": "https://registry.npmjs.org/extend.js/-/extend.js-0.0.2.tgz",
+ "integrity": "sha1-D5x6gaHyCLcD6wwxMf5XFqxuzRU="
+ },
+ "extglob": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/extglob/-/extglob-0.3.2.tgz",
+ "integrity": "sha1-Lhj/PS9JqydlzskCPwEdqo2DSaE=",
+ "requires": {
+ "is-extglob": "^1.0.0"
+ }
+ },
+ "extract-files": {
+ "version": "9.0.0",
+ "resolved": "https://registry.npmjs.org/extract-files/-/extract-files-9.0.0.tgz",
+ "integrity": "sha512-CvdFfHkC95B4bBBk36hcEmvdR2awOdhhVUYH6S/zrVj3477zven/fJMYg7121h4T1xHZC+tetUpubpAhxwI7hQ=="
+ },
+ "fast-levenshtein": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-3.0.0.tgz",
+ "integrity": "sha512-hKKNajm46uNmTlhHSyZkmToAc56uZJwYq7yrciZjqOxnlfQwERDQJmHPUp7m1m9wx8vgOe8IaCKZ5Kv2k1DdCQ==",
+ "requires": {
+ "fastest-levenshtein": "^1.0.7"
+ }
+ },
+ "fast-safe-stringify": {
+ "version": "2.0.7",
+ "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.0.7.tgz",
+ "integrity": "sha512-Utm6CdzT+6xsDk2m8S6uL8VHxNwI6Jub+e9NYTcAms28T84pTa25GJQV9j0CY0N1rM8hK4x6grpF2BQf+2qwVA=="
+ },
+ "fastest-levenshtein": {
+ "version": "1.0.12",
+ "resolved": "https://registry.npmjs.org/fastest-levenshtein/-/fastest-levenshtein-1.0.12.tgz",
+ "integrity": "sha512-On2N+BpYJ15xIC974QNVuYGMOlEVt4s0EOI3wwMqOmK1fdDY+FN/zltPV8vosq4ad4c/gJ1KHScUn/6AWIgiow=="
+ },
+ "fault": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/fault/-/fault-1.0.4.tgz",
+ "integrity": "sha512-CJ0HCB5tL5fYTEA7ToAq5+kTwd++Borf1/bifxd9iT70QcXr4MRrO3Llf8Ifs70q+SJcGHFtnIE/Nw6giCtECA==",
+ "requires": {
+ "format": "^0.2.0"
+ }
+ },
+ "file-uri-to-path": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz",
+ "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==",
+ "optional": true
+ },
+ "filelist": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.2.tgz",
+ "integrity": "sha512-z7O0IS8Plc39rTCq6i6iHxk43duYOn8uFJiWSewIq0Bww1RNybVHSCjahmcC87ZqAm4OTvFzlzeGu3XAzG1ctQ==",
+ "requires": {
+ "minimatch": "^3.0.4"
+ }
+ },
+ "filename-regex": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/filename-regex/-/filename-regex-2.0.1.tgz",
+ "integrity": "sha1-wcS5vuPglyXdsQa3XB4wH+LxiyY="
+ },
+ "fill-range": {
+ "version": "2.2.4",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-2.2.4.tgz",
+ "integrity": "sha512-cnrcCbj01+j2gTG921VZPnHbjmdAf8oQV/iGeV2kZxGSyfYjjTyY79ErsK1WJWMpw6DaApEX72binqJE+/d+5Q==",
+ "requires": {
+ "is-number": "^2.1.0",
+ "isobject": "^2.0.0",
+ "randomatic": "^3.0.0",
+ "repeat-element": "^1.1.2",
+ "repeat-string": "^1.5.2"
+ }
+ },
+ "for-in": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/for-in/-/for-in-1.0.2.tgz",
+ "integrity": "sha1-gQaNKVqBQuwKxybG4iAMMPttXoA="
+ },
+ "for-own": {
+ "version": "0.1.5",
+ "resolved": "https://registry.npmjs.org/for-own/-/for-own-0.1.5.tgz",
+ "integrity": "sha1-UmXGgaTylNq78XyVCbZ2OqhFEM4=",
+ "requires": {
+ "for-in": "^1.0.1"
+ }
+ },
+ "form-data": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
+ "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
+ "requires": {
+ "asynckit": "^0.4.0",
+ "combined-stream": "^1.0.8",
+ "mime-types": "^2.1.12"
+ }
+ },
+ "format": {
+ "version": "0.2.2",
+ "resolved": "https://registry.npmjs.org/format/-/format-0.2.2.tgz",
+ "integrity": "sha1-1hcBB+nv3E7TDJ3DkBbflCtctYs="
+ },
+ "formidable": {
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/formidable/-/formidable-1.2.2.tgz",
+ "integrity": "sha512-V8gLm+41I/8kguQ4/o1D3RIHRmhYFG4pnNyonvua+40rqcEmT4+V71yaZ3B457xbbgCsCfjSPi65u/W6vK1U5Q=="
+ },
+ "fragment-cache": {
+ "version": "0.2.1",
+ "resolved": "https://registry.npmjs.org/fragment-cache/-/fragment-cache-0.2.1.tgz",
+ "integrity": "sha1-QpD60n8T6Jvn8zeZxrxaCr//DRk=",
+ "requires": {
+ "map-cache": "^0.2.2"
+ }
+ },
+ "fs-extra": {
+ "version": "8.1.0",
+ "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz",
+ "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==",
+ "requires": {
+ "graceful-fs": "^4.2.0",
+ "jsonfile": "^4.0.0",
+ "universalify": "^0.1.0"
+ }
+ },
+ "fs.realpath": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
+ "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8="
+ },
+ "fsevents": {
+ "version": "1.2.13",
+ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-1.2.13.tgz",
+ "integrity": "sha512-oWb1Z6mkHIskLzEJ/XWX0srkpkTQ7vaopMQkyaEIoq0fmtFVxOthb8cCxeT+p3ynTdkk/RZwbgG4brR5BeWECw==",
+ "optional": true,
+ "requires": {
+ "bindings": "^1.5.0",
+ "nan": "^2.12.1"
+ }
+ },
+ "function-bind": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz",
+ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A=="
+ },
+ "get-stdin": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-5.0.1.tgz",
+ "integrity": "sha1-Ei4WFZHiH/TFJTAwVpPyDmOTo5g="
+ },
+ "get-value": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz",
+ "integrity": "sha1-3BXKHGcjh8p2vTesCjlbogQqLCg="
+ },
+ "github-slugger": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.3.0.tgz",
+ "integrity": "sha512-gwJScWVNhFYSRDvURk/8yhcFBee6aFjye2a7Lhb2bUyRulpIoek9p0I9Kt7PT67d/nUlZbFu8L9RLiA0woQN8Q==",
+ "requires": {
+ "emoji-regex": ">=6.0.0 <=6.1.1"
+ }
+ },
+ "glob": {
+ "version": "7.1.6",
+ "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz",
+ "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==",
+ "requires": {
+ "fs.realpath": "^1.0.0",
+ "inflight": "^1.0.4",
+ "inherits": "2",
+ "minimatch": "^3.0.4",
+ "once": "^1.3.0",
+ "path-is-absolute": "^1.0.0"
+ }
+ },
+ "glob-base": {
+ "version": "0.3.0",
+ "resolved": "https://registry.npmjs.org/glob-base/-/glob-base-0.3.0.tgz",
+ "integrity": "sha1-27Fk9iIbHAscz4Kuoyi0l98Oo8Q=",
+ "requires": {
+ "glob-parent": "^2.0.0",
+ "is-glob": "^2.0.0"
+ }
+ },
+ "glob-parent": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-2.0.0.tgz",
+ "integrity": "sha1-gTg9ctsFT8zPUzbaqQLxgvbtuyg=",
+ "requires": {
+ "is-glob": "^2.0.0"
+ }
+ },
+ "graceful-fs": {
+ "version": "4.2.6",
+ "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.6.tgz",
+ "integrity": "sha512-nTnJ528pbqxYanhpDYsi4Rd8MAeaBA67+RZ10CM1m3bTAVFEDcd5AuA4a6W5YkGZ1iNXHzZz8T6TBKLeBuNriQ=="
+ },
+ "graceful-readlink": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/graceful-readlink/-/graceful-readlink-1.0.1.tgz",
+ "integrity": "sha1-TK+tdrxi8C+gObL5Tpo906ORpyU="
+ },
+ "graphql": {
+ "version": "15.5.0",
+ "resolved": "https://registry.npmjs.org/graphql/-/graphql-15.5.0.tgz",
+ "integrity": "sha512-OmaM7y0kaK31NKG31q4YbD2beNYa6jBBKtMFT6gLYJljHLJr42IqJ8KX08u3Li/0ifzTU5HjmoOOrwa5BRLeDA=="
+ },
+ "graphql-request": {
+ "version": "3.4.0",
+ "resolved": "https://registry.npmjs.org/graphql-request/-/graphql-request-3.4.0.tgz",
+ "integrity": "sha512-acrTzidSlwAj8wBNO7Q/UQHS8T+z5qRGquCQRv9J1InwR01BBWV9ObnoE+JS5nCCEj8wSGS0yrDXVDoRiKZuOg==",
+ "requires": {
+ "cross-fetch": "^3.0.6",
+ "extract-files": "^9.0.0",
+ "form-data": "^3.0.0"
+ }
+ },
+ "handlebars": {
+ "version": "4.7.7",
+ "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz",
+ "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==",
+ "requires": {
+ "minimist": "^1.2.5",
+ "neo-async": "^2.6.0",
+ "source-map": "^0.6.1",
+ "uglify-js": "^3.1.4",
+ "wordwrap": "^1.0.0"
+ }
+ },
+ "has": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz",
+ "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==",
+ "requires": {
+ "function-bind": "^1.1.1"
+ }
+ },
+ "has-ansi": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/has-ansi/-/has-ansi-2.0.0.tgz",
+ "integrity": "sha1-NPUEnOHs3ysGSa8+8k5F7TVBbZE=",
+ "requires": {
+ "ansi-regex": "^2.0.0"
+ }
+ },
+ "has-flag": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
+ "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0="
+ },
+ "has-value": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/has-value/-/has-value-1.0.0.tgz",
+ "integrity": "sha1-GLKB2lhbHFxR3vJMkw7SmgvmsXc=",
+ "requires": {
+ "get-value": "^2.0.6",
+ "has-values": "^1.0.0",
+ "isobject": "^3.0.0"
+ },
+ "dependencies": {
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ }
+ }
+ },
+ "has-values": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/has-values/-/has-values-1.0.0.tgz",
+ "integrity": "sha1-lbC2P+whRmGab+V/51Yo1aOe/k8=",
+ "requires": {
+ "is-number": "^3.0.0",
+ "kind-of": "^4.0.0"
+ },
+ "dependencies": {
+ "is-number": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-3.0.0.tgz",
+ "integrity": "sha1-JP1iAaR4LPUFYcgQJ2r8fRLXEZU=",
+ "requires": {
+ "kind-of": "^3.0.2"
+ },
+ "dependencies": {
+ "kind-of": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz",
+ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=",
+ "requires": {
+ "is-buffer": "^1.1.5"
+ }
+ }
+ }
+ },
+ "kind-of": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-4.0.0.tgz",
+ "integrity": "sha1-IIE989cSkosgc3hpGkUGb65y3Vc=",
+ "requires": {
+ "is-buffer": "^1.1.5"
+ }
+ }
+ }
+ },
+ "he": {
+ "version": "0.5.0",
+ "resolved": "https://registry.npmjs.org/he/-/he-0.5.0.tgz",
+ "integrity": "sha1-LAX/rvkLaOhg8/0rVO9YCYknfuI="
+ },
+ "highlight.js": {
+ "version": "9.18.5",
+ "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-9.18.5.tgz",
+ "integrity": "sha512-a5bFyofd/BHCX52/8i8uJkjr9DYwXIPnM/plwI6W7ezItLGqzt7X2G2nXuYSfsIJdkwwj/g9DG1LkcGJI/dDoA=="
+ },
+ "inflight": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
+ "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=",
+ "requires": {
+ "once": "^1.3.0",
+ "wrappy": "1"
+ }
+ },
+ "inherits": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
+ },
+ "ini": {
+ "version": "1.3.8",
+ "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz",
+ "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew=="
+ },
+ "interpret": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz",
+ "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA=="
+ },
+ "irregular-plurals": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/irregular-plurals/-/irregular-plurals-1.4.0.tgz",
+ "integrity": "sha1-LKmwM2UREYVUEvFr5dd8YqRYp2Y="
+ },
+ "is-accessor-descriptor": {
+ "version": "0.1.6",
+ "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-0.1.6.tgz",
+ "integrity": "sha1-qeEss66Nh2cn7u84Q/igiXtcmNY=",
+ "requires": {
+ "kind-of": "^3.0.2"
+ }
+ },
+ "is-alphabetical": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-1.0.4.tgz",
+ "integrity": "sha512-DwzsA04LQ10FHTZuL0/grVDk4rFoVH1pjAToYwBrHSxcrBIGQuXrQMtD5U1b0U2XVgKZCTLLP8u2Qxqhy3l2Vg=="
+ },
+ "is-alphanumeric": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-alphanumeric/-/is-alphanumeric-1.0.0.tgz",
+ "integrity": "sha1-Spzvcdr0wAHB2B1j0UDPU/1oifQ="
+ },
+ "is-alphanumerical": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-1.0.4.tgz",
+ "integrity": "sha512-UzoZUr+XfVz3t3v4KyGEniVL9BDRoQtY7tOyrRybkVNjDFWyo1yhXNGrrBTQxp3ib9BLAWs7k2YKBQsFRkZG9A==",
+ "requires": {
+ "is-alphabetical": "^1.0.0",
+ "is-decimal": "^1.0.0"
+ }
+ },
+ "is-binary-path": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-1.0.1.tgz",
+ "integrity": "sha1-dfFmQrSA8YenEcgUFh/TpKdlWJg=",
+ "requires": {
+ "binary-extensions": "^1.0.0"
+ }
+ },
+ "is-buffer": {
+ "version": "1.1.6",
+ "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz",
+ "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w=="
+ },
+ "is-core-module": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.2.0.tgz",
+ "integrity": "sha512-XRAfAdyyY5F5cOXn7hYQDqh2Xmii+DEfIcQGxK/uNwMHhIkPWO0g8msXcbzLe+MpGoR951MlqM/2iIlU4vKDdQ==",
+ "requires": {
+ "has": "^1.0.3"
+ }
+ },
+ "is-data-descriptor": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-0.1.4.tgz",
+ "integrity": "sha1-C17mSDiOLIYCgueT8YVv7D8wG1Y=",
+ "requires": {
+ "kind-of": "^3.0.2"
+ }
+ },
+ "is-decimal": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-1.0.4.tgz",
+ "integrity": "sha512-RGdriMmQQvZ2aqaQq3awNA6dCGtKpiDFcOzrTWrDAT2MiWrKQVPmxLGHl7Y2nNu6led0kEyoX0enY0qXYsv9zw=="
+ },
+ "is-descriptor": {
+ "version": "0.1.6",
+ "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.6.tgz",
+ "integrity": "sha512-avDYr0SB3DwO9zsMov0gKCESFYqCnE4hq/4z3TdUlukEy5t9C0YRq7HLrsN52NAcqXKaepeCD0n+B0arnVG3Hg==",
+ "requires": {
+ "is-accessor-descriptor": "^0.1.6",
+ "is-data-descriptor": "^0.1.4",
+ "kind-of": "^5.0.0"
+ },
+ "dependencies": {
+ "kind-of": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-5.1.0.tgz",
+ "integrity": "sha512-NGEErnH6F2vUuXDh+OlbcKW7/wOcfdRHaZ7VWtqCztfHri/++YKmP51OdWeGPuqCOba6kk2OTe5d02VmTB80Pw=="
+ }
+ }
+ },
+ "is-dotfile": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/is-dotfile/-/is-dotfile-1.0.3.tgz",
+ "integrity": "sha1-pqLzL/0t+wT1yiXs0Pa4PPeYoeE="
+ },
+ "is-equal-shallow": {
+ "version": "0.1.3",
+ "resolved": "https://registry.npmjs.org/is-equal-shallow/-/is-equal-shallow-0.1.3.tgz",
+ "integrity": "sha1-IjgJj8Ih3gvPpdnqxMRdY4qhxTQ=",
+ "requires": {
+ "is-primitive": "^2.0.0"
+ }
+ },
+ "is-extendable": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz",
+ "integrity": "sha1-YrEQ4omkcUGOPsNqYX1HLjAd/Ik="
+ },
+ "is-extglob": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-1.0.0.tgz",
+ "integrity": "sha1-rEaBd8SUNAWgkvyPKXYMb/xiBsA="
+ },
+ "is-fullwidth-code-point": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz",
+ "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=",
+ "requires": {
+ "number-is-nan": "^1.0.0"
+ }
+ },
+ "is-glob": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-2.0.1.tgz",
+ "integrity": "sha1-0Jb5JqPe1WAPP9/ZEZjLCIjC2GM=",
+ "requires": {
+ "is-extglob": "^1.0.0"
+ }
+ },
+ "is-hexadecimal": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-1.0.4.tgz",
+ "integrity": "sha512-gyPJuv83bHMpocVYoqof5VDiZveEoGoFL8m3BXNb2VW8Xs+rz9kqO8LOQ5DH6EsuvilT1ApazU0pyl+ytbPtlw=="
+ },
+ "is-number": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-2.1.0.tgz",
+ "integrity": "sha1-Afy7s5NGOlSPL0ZszhbezknbkI8=",
+ "requires": {
+ "kind-of": "^3.0.2"
+ }
+ },
+ "is-plain-obj": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz",
+ "integrity": "sha1-caUMhCnfync8kqOQpKA7OfzVHT4="
+ },
+ "is-plain-object": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz",
+ "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==",
+ "requires": {
+ "isobject": "^3.0.1"
+ },
+ "dependencies": {
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ }
+ }
+ },
+ "is-posix-bracket": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/is-posix-bracket/-/is-posix-bracket-0.1.1.tgz",
+ "integrity": "sha1-MzTceXdDaOkvAW5vvAqI9c1ua8Q="
+ },
+ "is-primitive": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/is-primitive/-/is-primitive-2.0.0.tgz",
+ "integrity": "sha1-IHurkWOEmcB7Kt8kCkGochADRXU="
+ },
+ "is-whitespace-character": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/is-whitespace-character/-/is-whitespace-character-1.0.4.tgz",
+ "integrity": "sha512-SDweEzfIZM0SJV0EUga669UTKlmL0Pq8Lno0QDQsPnvECB3IM2aP0gdx5TrU0A01MAPfViaZiI2V1QMZLaKK5w=="
+ },
+ "is-windows": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz",
+ "integrity": "sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA=="
+ },
+ "is-word-character": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/is-word-character/-/is-word-character-1.0.4.tgz",
+ "integrity": "sha512-5SMO8RVennx3nZrqtKwCGyyetPE9VDba5ugvKLaD4KopPG5kR4mQ7tNt/r7feL5yt5h3lpuBbIUmCOG2eSzXHA=="
+ },
+ "isarray": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz",
+ "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE="
+ },
+ "isobject": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-2.1.0.tgz",
+ "integrity": "sha1-8GVWEJaj8dou9GJy+BXIQNh+DIk=",
+ "requires": {
+ "isarray": "1.0.0"
+ }
+ },
+ "jake": {
+ "version": "10.8.2",
+ "resolved": "https://registry.npmjs.org/jake/-/jake-10.8.2.tgz",
+ "integrity": "sha512-eLpKyrfG3mzvGE2Du8VoPbeSkRry093+tyNjdYaBbJS9v17knImYGNXQCUV0gLxQtF82m3E8iRb/wdSQZLoq7A==",
+ "requires": {
+ "async": "0.9.x",
+ "chalk": "^2.4.2",
+ "filelist": "^1.0.1",
+ "minimatch": "^3.0.4"
+ }
+ },
+ "jquery": {
+ "version": "3.5.1",
+ "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.5.1.tgz",
+ "integrity": "sha512-XwIBPqcMn57FxfT+Go5pzySnm4KWkT1Tv7gjrpT1srtf8Weynl6R273VJ5GjkRb51IzMp5nbaPjJXMWeju2MKg=="
+ },
+ "js-yaml": {
+ "version": "3.14.1",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
+ "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
+ "requires": {
+ "argparse": "^1.0.7",
+ "esprima": "^4.0.0"
+ }
+ },
+ "jsonfile": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",
+ "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=",
+ "requires": {
+ "graceful-fs": "^4.1.6"
+ }
+ },
+ "kind-of": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz",
+ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=",
+ "requires": {
+ "is-buffer": "^1.1.5"
+ }
+ },
+ "linkify-it": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.2.0.tgz",
+ "integrity": "sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw==",
+ "requires": {
+ "uc.micro": "^1.0.1"
+ }
+ },
+ "lodash": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+ },
+ "lodash.differencewith": {
+ "version": "4.5.0",
+ "resolved": "https://registry.npmjs.org/lodash.differencewith/-/lodash.differencewith-4.5.0.tgz",
+ "integrity": "sha1-uvr7yRi1UVTheRdqALsK76rIVLc="
+ },
+ "lodash.flatten": {
+ "version": "4.4.0",
+ "resolved": "https://registry.npmjs.org/lodash.flatten/-/lodash.flatten-4.4.0.tgz",
+ "integrity": "sha1-8xwiIlqWMtK7+OSt2+8kCqdlph8="
+ },
+ "log-symbols": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-1.0.2.tgz",
+ "integrity": "sha1-N2/3tY6jCGoPCfrMdGF+ylAeGhg=",
+ "requires": {
+ "chalk": "^1.0.0"
+ },
+ "dependencies": {
+ "ansi-styles": {
+ "version": "2.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz",
+ "integrity": "sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4="
+ },
+ "chalk": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz",
+ "integrity": "sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg=",
+ "requires": {
+ "ansi-styles": "^2.2.1",
+ "escape-string-regexp": "^1.0.2",
+ "has-ansi": "^2.0.0",
+ "strip-ansi": "^3.0.0",
+ "supports-color": "^2.0.0"
+ }
+ },
+ "supports-color": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz",
+ "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc="
+ }
+ }
+ },
+ "log-update": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/log-update/-/log-update-1.0.2.tgz",
+ "integrity": "sha1-GZKfZMQJPS0ucHWh2tivWcKWuNE=",
+ "requires": {
+ "ansi-escapes": "^1.0.0",
+ "cli-cursor": "^1.0.2"
+ }
+ },
+ "longest-streak": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-2.0.4.tgz",
+ "integrity": "sha512-vM6rUVCVUJJt33bnmHiZEvr7wPT78ztX7rojL+LW51bHtLh6HTjx84LA5W4+oa6aKEJA7jJu5LR6vQRBpA5DVg=="
+ },
+ "lru-cache": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
+ "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==",
+ "requires": {
+ "yallist": "^4.0.0"
+ }
+ },
+ "lunr": {
+ "version": "2.3.9",
+ "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
+ "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow=="
+ },
+ "map-cache": {
+ "version": "0.2.2",
+ "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz",
+ "integrity": "sha1-wyq9C9ZSXZsFFkW7TyasXcmKDb8="
+ },
+ "map-visit": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/map-visit/-/map-visit-1.0.0.tgz",
+ "integrity": "sha1-7Nyo8TFE5mDxtb1B8S80edmN+48=",
+ "requires": {
+ "object-visit": "^1.0.0"
+ }
+ },
+ "markdown-escapes": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/markdown-escapes/-/markdown-escapes-1.0.4.tgz",
+ "integrity": "sha512-8z4efJYk43E0upd0NbVXwgSTQs6cT3T06etieCMEg7dRbzCbxUCK/GHlX8mhHRDcp+OLlHkPKsvqQTCvsRl2cg=="
+ },
+ "markdown-it": {
+ "version": "8.4.2",
+ "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-8.4.2.tgz",
+ "integrity": "sha512-GcRz3AWTqSUphY3vsUqQSFMbgR38a4Lh3GWlHRh/7MRwz8mcu9n2IO7HOh+bXHrR9kOPDl5RNCaEsrneb+xhHQ==",
+ "requires": {
+ "argparse": "^1.0.7",
+ "entities": "~1.1.1",
+ "linkify-it": "^2.0.0",
+ "mdurl": "^1.0.1",
+ "uc.micro": "^1.0.5"
+ }
+ },
+ "markdown-table": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-1.1.3.tgz",
+ "integrity": "sha512-1RUZVgQlpJSPWYbFSpmudq5nHY1doEIv89gBtF0s4gW1GF2XorxcA/70M5vq7rLv0a6mhOUccRsqkwhwLCIQ2Q=="
+ },
+ "markdownlint": {
+ "version": "0.14.2",
+ "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.14.2.tgz",
+ "integrity": "sha512-Lzw5u46jcIQW0RX8nfz6mOjg3VwoTi7KTubk+G7LgJMybV98h3tyVaMpsNRm3UomBosNOUKVe3XOjJs6WS6DdQ==",
+ "requires": {
+ "markdown-it": "8.4.2"
+ }
+ },
+ "markdownlint-cli": {
+ "version": "0.16.0",
+ "resolved": "https://registry.npmjs.org/markdownlint-cli/-/markdownlint-cli-0.16.0.tgz",
+ "integrity": "sha512-BmtWhDvbsnbgYirYOiSOxP8THhkCjp28+xVfTyj3D1JsOlj0Txf3IA9wlT5GHCYaR6QfDlWq4pz/rh+bfOw2Vg==",
+ "requires": {
+ "commander": "~2.9.0",
+ "deep-extend": "~0.5.1",
+ "get-stdin": "~5.0.1",
+ "glob": "~7.1.2",
+ "js-yaml": "^3.13.1",
+ "lodash.differencewith": "~4.5.0",
+ "lodash.flatten": "~4.4.0",
+ "markdownlint": "~0.14.1",
+ "minimatch": "~3.0.4",
+ "rc": "~1.2.7"
+ }
+ },
+ "marked": {
+ "version": "0.8.2",
+ "resolved": "https://registry.npmjs.org/marked/-/marked-0.8.2.tgz",
+ "integrity": "sha512-EGwzEeCcLniFX51DhTpmTom+dSA/MG/OBUDjnWtHbEnjAH180VzUeAw+oE4+Zv+CoYBWyRlYOTR0N8SO9R1PVw=="
+ },
+ "math-random": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/math-random/-/math-random-1.0.4.tgz",
+ "integrity": "sha512-rUxjysqif/BZQH2yhd5Aaq7vXMSx9NdEsQcyA07uEzIvxgI7zIr33gGsh+RU0/XjmQpCW7RsVof1vlkvQVCK5A=="
+ },
+ "mdast": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/mdast/-/mdast-2.1.0.tgz",
+ "integrity": "sha1-fArAsx0hT/AOhmDQzVNopCSuH1c=",
+ "requires": {
+ "camelcase": "^1.0.0",
+ "ccount": "^1.0.0",
+ "chalk": "^1.0.0",
+ "charm": "^1.0.0",
+ "chokidar": "^1.0.5",
+ "collapse-white-space": "^1.0.0",
+ "commander": "^2.0.0",
+ "concat-stream": "^1.0.0",
+ "debug": "^2.0.0",
+ "elegant-spinner": "^1.0.0",
+ "extend.js": "0.0.2",
+ "he": "^0.5.0",
+ "log-update": "^1.0.1",
+ "longest-streak": "^1.0.0",
+ "markdown-table": "^0.4.0",
+ "minimatch": "^2.0.0",
+ "npm-prefix": "^1.0.1",
+ "repeat-string": "^1.5.0",
+ "text-table": "^0.2.0",
+ "to-vfile": "^1.0.0",
+ "trim": "^0.0.1",
+ "trim-trailing-lines": "^1.0.0",
+ "unified": "^2.0.0",
+ "user-home": "^2.0.0",
+ "vfile": "^1.1.0",
+ "vfile-reporter": "^1.3.0",
+ "ware": "^1.3.0"
+ },
+ "dependencies": {
+ "ansi-styles": {
+ "version": "2.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz",
+ "integrity": "sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4="
+ },
+ "chalk": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz",
+ "integrity": "sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg=",
+ "requires": {
+ "ansi-styles": "^2.2.1",
+ "escape-string-regexp": "^1.0.2",
+ "has-ansi": "^2.0.0",
+ "strip-ansi": "^3.0.0",
+ "supports-color": "^2.0.0"
+ }
+ },
+ "debug": {
+ "version": "2.6.9",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
+ "requires": {
+ "ms": "2.0.0"
+ }
+ },
+ "longest-streak": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-1.0.0.tgz",
+ "integrity": "sha1-0GWXxNTDG1LMsfXY+P5xSOr9aWU="
+ },
+ "markdown-table": {
+ "version": "0.4.0",
+ "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-0.4.0.tgz",
+ "integrity": "sha1-iQwsGzv+g/sA5BKbjkz+ZFJw+dE="
+ },
+ "minimatch": {
+ "version": "2.0.10",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-2.0.10.tgz",
+ "integrity": "sha1-jQh8OcazjAAbl/ynzm0OHoCvusc=",
+ "requires": {
+ "brace-expansion": "^1.0.0"
+ }
+ },
+ "ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
+ },
+ "supports-color": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz",
+ "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc="
+ },
+ "unified": {
+ "version": "2.1.4",
+ "resolved": "https://registry.npmjs.org/unified/-/unified-2.1.4.tgz",
+ "integrity": "sha1-FLxs1A2Y//91tAVQa62HPsu6w7o=",
+ "requires": {
+ "attach-ware": "^1.0.0",
+ "bail": "^1.0.0",
+ "extend": "^3.0.0",
+ "unherit": "^1.0.4",
+ "vfile": "^1.0.0",
+ "ware": "^1.3.0"
+ }
+ },
+ "vfile": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/vfile/-/vfile-1.4.0.tgz",
+ "integrity": "sha1-wP1vpIT43r23cfaMMe112I2pf+c="
+ }
+ }
+ },
+ "mdast-comment-marker": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/mdast-comment-marker/-/mdast-comment-marker-1.1.2.tgz",
+ "integrity": "sha512-vTFXtmbbF3rgnTh3Zl3irso4LtvwUq/jaDvT2D1JqTGAwaipcS7RpTxzi6KjoRqI9n2yuAhzLDAC8xVTF3XYVQ=="
+ },
+ "mdast-util-compact": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/mdast-util-compact/-/mdast-util-compact-1.0.3.tgz",
+ "integrity": "sha512-nRiU5GpNy62rZppDKbLwhhtw5DXoFMqw9UNZFmlPsNaQCZ//WLjGKUwWMdJrUH+Se7UvtO2gXtAMe0g/N+eI5w==",
+ "requires": {
+ "unist-util-visit": "^1.1.0"
+ }
+ },
+ "mdast-util-heading-range": {
+ "version": "2.1.3",
+ "resolved": "https://registry.npmjs.org/mdast-util-heading-range/-/mdast-util-heading-range-2.1.3.tgz",
+ "integrity": "sha512-ypaAuI6mWC37CQt3YsngWR/+y2LK3xx1+7SfgrG/URyVDgMu+i91O2ulyhNOzAXqB7kf9hGZY3twNK5eaEKX6A==",
+ "requires": {
+ "mdast-util-to-string": "^1.0.0"
+ }
+ },
+ "mdast-util-to-string": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-1.1.0.tgz",
+ "integrity": "sha512-jVU0Nr2B9X3MU4tSK7JP1CMkSvOj7X5l/GboG1tKRw52lLF1x2Ju92Ms9tNetCcbfX3hzlM73zYo2NKkWSfF/A=="
+ },
+ "mdast-util-toc": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/mdast-util-toc/-/mdast-util-toc-2.1.0.tgz",
+ "integrity": "sha512-ove/QQWSrYOrf9G3xn2MTAjy7PKCtCmm261wpQwecoPAsUtkihkMVczxFqil7VihxgSz4ID9c8bBTsyXR30gQg==",
+ "requires": {
+ "github-slugger": "^1.1.1",
+ "mdast-util-to-string": "^1.0.2",
+ "unist-util-visit": "^1.1.0"
+ }
+ },
+ "mdast-zone": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/mdast-zone/-/mdast-zone-3.0.4.tgz",
+ "integrity": "sha512-pqUjjNLTqqDV19wwEw6s67dVtcnhokHW18Qtrj5WA0ABiRzfDfnEk7rgbAUjEG0ZzYUPboECgilewlXPSTP8aQ==",
+ "requires": {
+ "mdast-comment-marker": "^1.0.1",
+ "unist-util-visit": "^1.0.0"
+ }
+ },
+ "mdurl": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz",
+ "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4="
+ },
+ "methods": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz",
+ "integrity": "sha1-VSmk1nZUE07cxSZmVoNbD4Ua/O4="
+ },
+ "micromatch": {
+ "version": "2.3.11",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-2.3.11.tgz",
+ "integrity": "sha1-hmd8l9FyCzY0MdBNDRUpO9OMFWU=",
+ "requires": {
+ "arr-diff": "^2.0.0",
+ "array-unique": "^0.2.1",
+ "braces": "^1.8.2",
+ "expand-brackets": "^0.1.4",
+ "extglob": "^0.3.1",
+ "filename-regex": "^2.0.0",
+ "is-extglob": "^1.0.0",
+ "is-glob": "^2.0.1",
+ "kind-of": "^3.0.2",
+ "normalize-path": "^2.0.1",
+ "object.omit": "^2.0.0",
+ "parse-glob": "^3.0.4",
+ "regex-cache": "^0.4.2"
+ }
+ },
+ "mime": {
+ "version": "2.5.2",
+ "resolved": "https://registry.npmjs.org/mime/-/mime-2.5.2.tgz",
+ "integrity": "sha512-tqkh47FzKeCPD2PUiPB6pkbMzsCasjxAfC62/Wap5qrUWcb+sFasXUC5I3gYM5iBM8v/Qpn4UK0x+j0iHyFPDg=="
+ },
+ "mime-db": {
+ "version": "1.46.0",
+ "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.46.0.tgz",
+ "integrity": "sha512-svXaP8UQRZ5K7or+ZmfNhg2xX3yKDMUzqadsSqi4NCH/KomcH75MAMYAGVlvXn4+b/xOPhS3I2uHKRUzvjY7BQ=="
+ },
+ "mime-types": {
+ "version": "2.1.29",
+ "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.29.tgz",
+ "integrity": "sha512-Y/jMt/S5sR9OaqteJtslsFZKWOIIqMACsJSiHghlCAyhf7jfVYjKBmLiX8OgpWeW+fjJ2b+Az69aPFPkUOY6xQ==",
+ "requires": {
+ "mime-db": "1.46.0"
+ }
+ },
+ "minimatch": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
+ "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+ "requires": {
+ "brace-expansion": "^1.1.7"
+ }
+ },
+ "minimist": {
+ "version": "1.2.5",
+ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
+ "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+ },
+ "mixin-deep": {
+ "version": "1.3.2",
+ "resolved": "https://registry.npmjs.org/mixin-deep/-/mixin-deep-1.3.2.tgz",
+ "integrity": "sha512-WRoDn//mXBiJ1H40rqa3vH0toePwSsGb45iInWlTySa+Uu4k3tYUSxa2v1KqAiLtvlrSzaExqS1gtk96A9zvEA==",
+ "requires": {
+ "for-in": "^1.0.2",
+ "is-extendable": "^1.0.1"
+ },
+ "dependencies": {
+ "is-extendable": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz",
+ "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==",
+ "requires": {
+ "is-plain-object": "^2.0.4"
+ }
+ }
+ }
+ },
+ "moment": {
+ "version": "2.29.1",
+ "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.1.tgz",
+ "integrity": "sha512-kHmoybcPV8Sqy59DwNDY3Jefr64lK/by/da0ViFcuA4DH0vQg5Q6Ze5VimxkfQNSC+Mls/Kx53s7TjP1RhFEDQ=="
+ },
+ "ms": {
+ "version": "2.1.3",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
+ "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="
+ },
+ "nan": {
+ "version": "2.14.2",
+ "resolved": "https://registry.npmjs.org/nan/-/nan-2.14.2.tgz",
+ "integrity": "sha512-M2ufzIiINKCuDfBSAUr1vWQ+vuVcA9kqx8JJUsbQi6yf1uGRyb7HfpdfUr5qLXf3B/t8dPvcjhKMmlfnP47EzQ==",
+ "optional": true
+ },
+ "nanomatch": {
+ "version": "1.2.13",
+ "resolved": "https://registry.npmjs.org/nanomatch/-/nanomatch-1.2.13.tgz",
+ "integrity": "sha512-fpoe2T0RbHwBTBUOftAfBPaDEi06ufaUai0mE6Yn1kacc3SnTErfb/h+X94VXzI64rKFHYImXSvdwGGCmwOqCA==",
+ "requires": {
+ "arr-diff": "^4.0.0",
+ "array-unique": "^0.3.2",
+ "define-property": "^2.0.2",
+ "extend-shallow": "^3.0.2",
+ "fragment-cache": "^0.2.1",
+ "is-windows": "^1.0.2",
+ "kind-of": "^6.0.2",
+ "object.pick": "^1.3.0",
+ "regex-not": "^1.0.0",
+ "snapdragon": "^0.8.1",
+ "to-regex": "^3.0.1"
+ },
+ "dependencies": {
+ "arr-diff": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/arr-diff/-/arr-diff-4.0.0.tgz",
+ "integrity": "sha1-1kYQdP6/7HHn4VI1dhoyml3HxSA="
+ },
+ "array-unique": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz",
+ "integrity": "sha1-qJS3XUvE9s1nnvMkSp/Y9Gri1Cg="
+ },
+ "kind-of": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
+ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw=="
+ }
+ }
+ },
+ "neo-async": {
+ "version": "2.6.2",
+ "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz",
+ "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw=="
+ },
+ "next-tick": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/next-tick/-/next-tick-1.0.0.tgz",
+ "integrity": "sha1-yobR/ogoFpsBICCOPchCS524NCw="
+ },
+ "node-fetch": {
+ "version": "2.6.1",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz",
+ "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw=="
+ },
+ "normalize-path": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz",
+ "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=",
+ "requires": {
+ "remove-trailing-separator": "^1.0.1"
+ }
+ },
+ "not": {
+ "version": "0.1.0",
+ "resolved": "https://registry.npmjs.org/not/-/not-0.1.0.tgz",
+ "integrity": "sha1-yWkcF0bFXc++VMvYvU/wQbwrUZ0="
+ },
+ "npm-prefix": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/npm-prefix/-/npm-prefix-1.2.0.tgz",
+ "integrity": "sha1-5hlFX3B0ulTMZtbQ033Z8b5ry8A=",
+ "requires": {
+ "rc": "^1.1.0",
+ "shellsubstitute": "^1.1.0",
+ "untildify": "^2.1.0"
+ }
+ },
+ "nth-check": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-1.0.2.tgz",
+ "integrity": "sha512-WeBOdju8SnzPN5vTUJYxYUxLeXpCaVP5i5e0LF8fg7WORF2Wd7wFX/pk0tYZk7s8T+J7VLy0Da6J1+wCT0AtHg==",
+ "requires": {
+ "boolbase": "~1.0.0"
+ }
+ },
+ "number-is-nan": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz",
+ "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0="
+ },
+ "object-copy": {
+ "version": "0.1.0",
+ "resolved": "https://registry.npmjs.org/object-copy/-/object-copy-0.1.0.tgz",
+ "integrity": "sha1-fn2Fi3gb18mRpBupde04EnVOmYw=",
+ "requires": {
+ "copy-descriptor": "^0.1.0",
+ "define-property": "^0.2.5",
+ "kind-of": "^3.0.3"
+ },
+ "dependencies": {
+ "define-property": {
+ "version": "0.2.5",
+ "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz",
+ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=",
+ "requires": {
+ "is-descriptor": "^0.1.0"
+ }
+ }
+ }
+ },
+ "object-visit": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/object-visit/-/object-visit-1.0.1.tgz",
+ "integrity": "sha1-95xEk68MU3e1n+OdOV5BBC3QRbs=",
+ "requires": {
+ "isobject": "^3.0.0"
+ },
+ "dependencies": {
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ }
+ }
+ },
+ "object.omit": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/object.omit/-/object.omit-2.0.1.tgz",
+ "integrity": "sha1-Gpx0SCnznbuFjHbKNXmuKlTr0fo=",
+ "requires": {
+ "for-own": "^0.1.4",
+ "is-extendable": "^0.1.1"
+ }
+ },
+ "object.pick": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/object.pick/-/object.pick-1.3.0.tgz",
+ "integrity": "sha1-h6EKxMFpS9Lhy/U1kaZhQftd10c=",
+ "requires": {
+ "isobject": "^3.0.1"
+ },
+ "dependencies": {
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ }
+ }
+ },
+ "once": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
+ "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=",
+ "requires": {
+ "wrappy": "1"
+ }
+ },
+ "onetime": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/onetime/-/onetime-1.1.0.tgz",
+ "integrity": "sha1-ofeDj4MUxRbwXs78vEzP4EtO14k="
+ },
+ "os-homedir": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/os-homedir/-/os-homedir-1.0.2.tgz",
+ "integrity": "sha1-/7xJiDNuDoM94MFox+8VISGqf7M="
+ },
+ "parse-entities": {
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-1.2.2.tgz",
+ "integrity": "sha512-NzfpbxW/NPrzZ/yYSoQxyqUZMZXIdCfE0OIN4ESsnptHJECoUk3FZktxNuzQf4tjt5UEopnxpYJbvYuxIFDdsg==",
+ "requires": {
+ "character-entities": "^1.0.0",
+ "character-entities-legacy": "^1.0.0",
+ "character-reference-invalid": "^1.0.0",
+ "is-alphanumerical": "^1.0.0",
+ "is-decimal": "^1.0.0",
+ "is-hexadecimal": "^1.0.0"
+ }
+ },
+ "parse-glob": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/parse-glob/-/parse-glob-3.0.4.tgz",
+ "integrity": "sha1-ssN2z7EfNVE7rdFz7wu246OIORw=",
+ "requires": {
+ "glob-base": "^0.3.0",
+ "is-dotfile": "^1.0.0",
+ "is-extglob": "^1.0.0",
+ "is-glob": "^2.0.0"
+ }
+ },
+ "pascalcase": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/pascalcase/-/pascalcase-0.1.1.tgz",
+ "integrity": "sha1-s2PlXoAGym/iF4TS2yK9FdeRfxQ="
+ },
+ "path-is-absolute": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
+ "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18="
+ },
+ "path-parse": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz",
+ "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw=="
+ },
+ "plur": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/plur/-/plur-2.1.2.tgz",
+ "integrity": "sha1-dIJFLBoPUI4+NE6uwxLJHCncZVo=",
+ "requires": {
+ "irregular-plurals": "^1.0.0"
+ }
+ },
+ "posix-character-classes": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/posix-character-classes/-/posix-character-classes-0.1.1.tgz",
+ "integrity": "sha1-AerA/jta9xoqbAL+q7jB/vfgDqs="
+ },
+ "preserve": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/preserve/-/preserve-0.2.0.tgz",
+ "integrity": "sha1-gV7R9uvGWSb4ZbMQwHE7yzMVzks="
+ },
+ "process-nextick-args": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz",
+ "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag=="
+ },
+ "progress": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz",
+ "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA=="
+ },
+ "qs": {
+ "version": "6.9.6",
+ "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.6.tgz",
+ "integrity": "sha512-TIRk4aqYLNoJUbd+g2lEdz5kLWIuTMRagAXxl78Q0RiVjAOugHmeKNGdd3cwo/ktpf9aL9epCfFqWDEKysUlLQ=="
+ },
+ "randomatic": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/randomatic/-/randomatic-3.1.1.tgz",
+ "integrity": "sha512-TuDE5KxZ0J461RVjrJZCJc+J+zCkTb1MbH9AQUq68sMhOMcy9jLcb3BrZKgp9q9Ncltdg4QVqWrH02W2EFFVYw==",
+ "requires": {
+ "is-number": "^4.0.0",
+ "kind-of": "^6.0.0",
+ "math-random": "^1.0.1"
+ },
+ "dependencies": {
+ "is-number": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-4.0.0.tgz",
+ "integrity": "sha512-rSklcAIlf1OmFdyAqbnWTLVelsQ58uvZ66S/ZyawjWqIviTWCjg2PzVGw8WUA+nNuPTqb4wgA+NszrJ+08LlgQ=="
+ },
+ "kind-of": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
+ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw=="
+ }
+ }
+ },
+ "rc": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz",
+ "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==",
+ "requires": {
+ "deep-extend": "^0.6.0",
+ "ini": "~1.3.0",
+ "minimist": "^1.2.0",
+ "strip-json-comments": "~2.0.1"
+ },
+ "dependencies": {
+ "deep-extend": {
+ "version": "0.6.0",
+ "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz",
+ "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA=="
+ }
+ }
+ },
+ "readable-stream": {
+ "version": "2.3.7",
+ "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz",
+ "integrity": "sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw==",
+ "requires": {
+ "core-util-is": "~1.0.0",
+ "inherits": "~2.0.3",
+ "isarray": "~1.0.0",
+ "process-nextick-args": "~2.0.0",
+ "safe-buffer": "~5.1.1",
+ "string_decoder": "~1.1.1",
+ "util-deprecate": "~1.0.1"
+ }
+ },
+ "readdirp": {
+ "version": "2.2.1",
+ "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-2.2.1.tgz",
+ "integrity": "sha512-1JU/8q+VgFZyxwrJ+SVIOsh+KywWGpds3NTqikiKpDMZWScmAYyKIgqkO+ARvNWJfXeXR1zxz7aHF4u4CyH6vQ==",
+ "requires": {
+ "graceful-fs": "^4.1.11",
+ "micromatch": "^3.1.10",
+ "readable-stream": "^2.0.2"
+ },
+ "dependencies": {
+ "arr-diff": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/arr-diff/-/arr-diff-4.0.0.tgz",
+ "integrity": "sha1-1kYQdP6/7HHn4VI1dhoyml3HxSA="
+ },
+ "array-unique": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz",
+ "integrity": "sha1-qJS3XUvE9s1nnvMkSp/Y9Gri1Cg="
+ },
+ "braces": {
+ "version": "2.3.2",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-2.3.2.tgz",
+ "integrity": "sha512-aNdbnj9P8PjdXU4ybaWLK2IF3jc/EoDYbC7AazW6to3TRsfXxscC9UXOB5iDiEQrkyIbWp2SLQda4+QAa7nc3w==",
+ "requires": {
+ "arr-flatten": "^1.1.0",
+ "array-unique": "^0.3.2",
+ "extend-shallow": "^2.0.1",
+ "fill-range": "^4.0.0",
+ "isobject": "^3.0.1",
+ "repeat-element": "^1.1.2",
+ "snapdragon": "^0.8.1",
+ "snapdragon-node": "^2.0.1",
+ "split-string": "^3.0.2",
+ "to-regex": "^3.0.1"
+ },
+ "dependencies": {
+ "extend-shallow": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz",
+ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=",
+ "requires": {
+ "is-extendable": "^0.1.0"
+ }
+ }
+ }
+ },
+ "debug": {
+ "version": "2.6.9",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
+ "requires": {
+ "ms": "2.0.0"
+ }
+ },
+ "expand-brackets": {
+ "version": "2.1.4",
+ "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-2.1.4.tgz",
+ "integrity": "sha1-t3c14xXOMPa27/D4OwQVGiJEliI=",
+ "requires": {
+ "debug": "^2.3.3",
+ "define-property": "^0.2.5",
+ "extend-shallow": "^2.0.1",
+ "posix-character-classes": "^0.1.0",
+ "regex-not": "^1.0.0",
+ "snapdragon": "^0.8.1",
+ "to-regex": "^3.0.1"
+ },
+ "dependencies": {
+ "define-property": {
+ "version": "0.2.5",
+ "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz",
+ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=",
+ "requires": {
+ "is-descriptor": "^0.1.0"
+ }
+ },
+ "extend-shallow": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz",
+ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=",
+ "requires": {
+ "is-extendable": "^0.1.0"
+ }
+ },
+ "is-accessor-descriptor": {
+ "version": "0.1.6",
+ "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-0.1.6.tgz",
+ "integrity": "sha1-qeEss66Nh2cn7u84Q/igiXtcmNY=",
+ "requires": {
+ "kind-of": "^3.0.2"
+ },
+ "dependencies": {
+ "kind-of": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz",
+ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=",
+ "requires": {
+ "is-buffer": "^1.1.5"
+ }
+ }
+ }
+ },
+ "is-data-descriptor": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-0.1.4.tgz",
+ "integrity": "sha1-C17mSDiOLIYCgueT8YVv7D8wG1Y=",
+ "requires": {
+ "kind-of": "^3.0.2"
+ },
+ "dependencies": {
+ "kind-of": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz",
+ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=",
+ "requires": {
+ "is-buffer": "^1.1.5"
+ }
+ }
+ }
+ },
+ "is-descriptor": {
+ "version": "0.1.6",
+ "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.6.tgz",
+ "integrity": "sha512-avDYr0SB3DwO9zsMov0gKCESFYqCnE4hq/4z3TdUlukEy5t9C0YRq7HLrsN52NAcqXKaepeCD0n+B0arnVG3Hg==",
+ "requires": {
+ "is-accessor-descriptor": "^0.1.6",
+ "is-data-descriptor": "^0.1.4",
+ "kind-of": "^5.0.0"
+ }
+ },
+ "kind-of": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-5.1.0.tgz",
+ "integrity": "sha512-NGEErnH6F2vUuXDh+OlbcKW7/wOcfdRHaZ7VWtqCztfHri/++YKmP51OdWeGPuqCOba6kk2OTe5d02VmTB80Pw=="
+ }
+ }
+ },
+ "extglob": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/extglob/-/extglob-2.0.4.tgz",
+ "integrity": "sha512-Nmb6QXkELsuBr24CJSkilo6UHHgbekK5UiZgfE6UHD3Eb27YC6oD+bhcT+tJ6cl8dmsgdQxnWlcry8ksBIBLpw==",
+ "requires": {
+ "array-unique": "^0.3.2",
+ "define-property": "^1.0.0",
+ "expand-brackets": "^2.1.4",
+ "extend-shallow": "^2.0.1",
+ "fragment-cache": "^0.2.1",
+ "regex-not": "^1.0.0",
+ "snapdragon": "^0.8.1",
+ "to-regex": "^3.0.1"
+ },
+ "dependencies": {
+ "define-property": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz",
+ "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=",
+ "requires": {
+ "is-descriptor": "^1.0.0"
+ }
+ },
+ "extend-shallow": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz",
+ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=",
+ "requires": {
+ "is-extendable": "^0.1.0"
+ }
+ }
+ }
+ },
+ "fill-range": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-4.0.0.tgz",
+ "integrity": "sha1-1USBHUKPmOsGpj3EAtJAPDKMOPc=",
+ "requires": {
+ "extend-shallow": "^2.0.1",
+ "is-number": "^3.0.0",
+ "repeat-string": "^1.6.1",
+ "to-regex-range": "^2.1.0"
+ },
+ "dependencies": {
+ "extend-shallow": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz",
+ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=",
+ "requires": {
+ "is-extendable": "^0.1.0"
+ }
+ }
+ }
+ },
+ "is-accessor-descriptor": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz",
+ "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==",
+ "requires": {
+ "kind-of": "^6.0.0"
+ }
+ },
+ "is-data-descriptor": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz",
+ "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==",
+ "requires": {
+ "kind-of": "^6.0.0"
+ }
+ },
+ "is-descriptor": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz",
+ "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==",
+ "requires": {
+ "is-accessor-descriptor": "^1.0.0",
+ "is-data-descriptor": "^1.0.0",
+ "kind-of": "^6.0.2"
+ }
+ },
+ "is-number": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-3.0.0.tgz",
+ "integrity": "sha1-JP1iAaR4LPUFYcgQJ2r8fRLXEZU=",
+ "requires": {
+ "kind-of": "^3.0.2"
+ },
+ "dependencies": {
+ "kind-of": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz",
+ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=",
+ "requires": {
+ "is-buffer": "^1.1.5"
+ }
+ }
+ }
+ },
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ },
+ "kind-of": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
+ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw=="
+ },
+ "micromatch": {
+ "version": "3.1.10",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-3.1.10.tgz",
+ "integrity": "sha512-MWikgl9n9M3w+bpsY3He8L+w9eF9338xRl8IAO5viDizwSzziFEyUzo2xrrloB64ADbTf8uA8vRqqttDTOmccg==",
+ "requires": {
+ "arr-diff": "^4.0.0",
+ "array-unique": "^0.3.2",
+ "braces": "^2.3.1",
+ "define-property": "^2.0.2",
+ "extend-shallow": "^3.0.2",
+ "extglob": "^2.0.4",
+ "fragment-cache": "^0.2.1",
+ "kind-of": "^6.0.2",
+ "nanomatch": "^1.2.9",
+ "object.pick": "^1.3.0",
+ "regex-not": "^1.0.0",
+ "snapdragon": "^0.8.1",
+ "to-regex": "^3.0.2"
+ }
+ },
+ "ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
+ }
+ }
+ },
+ "rechoir": {
+ "version": "0.6.2",
+ "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz",
+ "integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=",
+ "requires": {
+ "resolve": "^1.1.6"
+ }
+ },
+ "regex-cache": {
+ "version": "0.4.4",
+ "resolved": "https://registry.npmjs.org/regex-cache/-/regex-cache-0.4.4.tgz",
+ "integrity": "sha512-nVIZwtCjkC9YgvWkpM55B5rBhBYRZhAaJbgcFYXXsHnbZ9UZI9nnVWYZpBlCqv9ho2eZryPnWrZGsOdPwVWXWQ==",
+ "requires": {
+ "is-equal-shallow": "^0.1.3"
+ }
+ },
+ "regex-not": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/regex-not/-/regex-not-1.0.2.tgz",
+ "integrity": "sha512-J6SDjUgDxQj5NusnOtdFxDwN/+HWykR8GELwctJ7mdqhcyy1xEc4SRFHUXvxTp661YaVKAjfRLZ9cCqS6tn32A==",
+ "requires": {
+ "extend-shallow": "^3.0.2",
+ "safe-regex": "^1.1.0"
+ }
+ },
+ "remark": {
+ "version": "9.0.0",
+ "resolved": "https://registry.npmjs.org/remark/-/remark-9.0.0.tgz",
+ "integrity": "sha512-amw8rGdD5lHbMEakiEsllmkdBP+/KpjW/PRK6NSGPZKCQowh0BT4IWXDAkRMyG3SB9dKPXWMviFjNusXzXNn3A==",
+ "requires": {
+ "remark-parse": "^5.0.0",
+ "remark-stringify": "^5.0.0",
+ "unified": "^6.0.0"
+ }
+ },
+ "remark-frontmatter": {
+ "version": "1.3.3",
+ "resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-1.3.3.tgz",
+ "integrity": "sha512-fM5eZPBvu2pVNoq3ZPW22q+5Ativ1oLozq2qYt9I2oNyxiUd/tDl0iLLntEVAegpZIslPWg1brhcP1VsaSVUag==",
+ "requires": {
+ "fault": "^1.0.1",
+ "xtend": "^4.0.1"
+ }
+ },
+ "remark-parse": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-5.0.0.tgz",
+ "integrity": "sha512-b3iXszZLH1TLoyUzrATcTQUZrwNl1rE70rVdSruJFlDaJ9z5aMkhrG43Pp68OgfHndL/ADz6V69Zow8cTQu+JA==",
+ "requires": {
+ "collapse-white-space": "^1.0.2",
+ "is-alphabetical": "^1.0.0",
+ "is-decimal": "^1.0.0",
+ "is-whitespace-character": "^1.0.0",
+ "is-word-character": "^1.0.0",
+ "markdown-escapes": "^1.0.0",
+ "parse-entities": "^1.1.0",
+ "repeat-string": "^1.5.4",
+ "state-toggle": "^1.0.0",
+ "trim": "0.0.1",
+ "trim-trailing-lines": "^1.0.0",
+ "unherit": "^1.0.4",
+ "unist-util-remove-position": "^1.0.0",
+ "vfile-location": "^2.0.0",
+ "xtend": "^4.0.1"
+ }
+ },
+ "remark-stringify": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-5.0.0.tgz",
+ "integrity": "sha512-Ws5MdA69ftqQ/yhRF9XhVV29mhxbfGhbz0Rx5bQH+oJcNhhSM6nCu1EpLod+DjrFGrU0BMPs+czVmJZU7xiS7w==",
+ "requires": {
+ "ccount": "^1.0.0",
+ "is-alphanumeric": "^1.0.0",
+ "is-decimal": "^1.0.0",
+ "is-whitespace-character": "^1.0.0",
+ "longest-streak": "^2.0.1",
+ "markdown-escapes": "^1.0.0",
+ "markdown-table": "^1.1.0",
+ "mdast-util-compact": "^1.0.0",
+ "parse-entities": "^1.0.2",
+ "repeat-string": "^1.5.4",
+ "state-toggle": "^1.0.0",
+ "stringify-entities": "^1.0.1",
+ "unherit": "^1.0.4",
+ "xtend": "^4.0.1"
+ }
+ },
+ "remove-trailing-separator": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/remove-trailing-separator/-/remove-trailing-separator-1.1.0.tgz",
+ "integrity": "sha1-wkvOKig62tW8P1jg1IJJuSN52O8="
+ },
+ "repeat-element": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/repeat-element/-/repeat-element-1.1.3.tgz",
+ "integrity": "sha512-ahGq0ZnV5m5XtZLMb+vP76kcAM5nkLqk0lpqAuojSKGgQtn4eRi4ZZGm2olo2zKFH+sMsWaqOCW1dqAnOru72g=="
+ },
+ "repeat-string": {
+ "version": "1.6.1",
+ "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz",
+ "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc="
+ },
+ "replace-ext": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/replace-ext/-/replace-ext-1.0.0.tgz",
+ "integrity": "sha1-3mMSg3P8v3w8z6TeWkgMRaZ5WOs="
+ },
+ "resolve": {
+ "version": "1.20.0",
+ "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.20.0.tgz",
+ "integrity": "sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==",
+ "requires": {
+ "is-core-module": "^2.2.0",
+ "path-parse": "^1.0.6"
+ }
+ },
+ "resolve-url": {
+ "version": "0.2.1",
+ "resolved": "https://registry.npmjs.org/resolve-url/-/resolve-url-0.2.1.tgz",
+ "integrity": "sha1-LGN/53yJOv0qZj/iGqkIAGjiBSo="
+ },
+ "restore-cursor": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-1.0.1.tgz",
+ "integrity": "sha1-NGYfRohjJ/7SmRR5FSJS35LapUE=",
+ "requires": {
+ "exit-hook": "^1.0.0",
+ "onetime": "^1.0.0"
+ }
+ },
+ "ret": {
+ "version": "0.1.15",
+ "resolved": "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz",
+ "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg=="
+ },
+ "rxjs": {
+ "version": "6.6.6",
+ "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-6.6.6.tgz",
+ "integrity": "sha512-/oTwee4N4iWzAMAL9xdGKjkEHmIwupR3oXbQjCKywF1BeFohswF3vZdogbmEF6pZkOsXTzWkrZszrWpQTByYVg==",
+ "requires": {
+ "tslib": "^1.9.0"
+ }
+ },
+ "safe-buffer": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
+ "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g=="
+ },
+ "safe-regex": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/safe-regex/-/safe-regex-1.1.0.tgz",
+ "integrity": "sha1-QKNmnzsHfR6UPURinhV91IAjvy4=",
+ "requires": {
+ "ret": "~0.1.10"
+ }
+ },
+ "semver": {
+ "version": "7.3.4",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.4.tgz",
+ "integrity": "sha512-tCfb2WLjqFAtXn4KEdxIhalnRtoKFN7nAwj0B3ZXCbQloV2tq5eDbcTmT68JJD3nRJq24/XgxtQKFIpQdtvmVw==",
+ "requires": {
+ "lru-cache": "^6.0.0"
+ }
+ },
+ "set-value": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.1.tgz",
+ "integrity": "sha512-JxHc1weCN68wRY0fhCoXpyK55m/XPHafOmK4UWD7m2CI14GMcFypt4w/0+NV5f/ZMby2F6S2wwA7fgynh9gWSw==",
+ "requires": {
+ "extend-shallow": "^2.0.1",
+ "is-extendable": "^0.1.1",
+ "is-plain-object": "^2.0.3",
+ "split-string": "^3.0.1"
+ },
+ "dependencies": {
+ "extend-shallow": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz",
+ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=",
+ "requires": {
+ "is-extendable": "^0.1.0"
+ }
+ }
+ }
+ },
+ "shelljs": {
+ "version": "0.8.4",
+ "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz",
+ "integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==",
+ "requires": {
+ "glob": "^7.0.0",
+ "interpret": "^1.0.0",
+ "rechoir": "^0.6.2"
+ }
+ },
+ "shellsubstitute": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/shellsubstitute/-/shellsubstitute-1.2.0.tgz",
+ "integrity": "sha1-5PcCpQxRiw9v6YRRiQ1wWvKba3A="
+ },
+ "snapdragon": {
+ "version": "0.8.2",
+ "resolved": "https://registry.npmjs.org/snapdragon/-/snapdragon-0.8.2.tgz",
+ "integrity": "sha512-FtyOnWN/wCHTVXOMwvSv26d+ko5vWlIDD6zoUJ7LW8vh+ZBC8QdljveRP+crNrtBwioEUWy/4dMtbBjA4ioNlg==",
+ "requires": {
+ "base": "^0.11.1",
+ "debug": "^2.2.0",
+ "define-property": "^0.2.5",
+ "extend-shallow": "^2.0.1",
+ "map-cache": "^0.2.2",
+ "source-map": "^0.5.6",
+ "source-map-resolve": "^0.5.0",
+ "use": "^3.1.0"
+ },
+ "dependencies": {
+ "debug": {
+ "version": "2.6.9",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
+ "requires": {
+ "ms": "2.0.0"
+ }
+ },
+ "define-property": {
+ "version": "0.2.5",
+ "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz",
+ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=",
+ "requires": {
+ "is-descriptor": "^0.1.0"
+ }
+ },
+ "extend-shallow": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz",
+ "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=",
+ "requires": {
+ "is-extendable": "^0.1.0"
+ }
+ },
+ "ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
+ },
+ "source-map": {
+ "version": "0.5.7",
+ "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz",
+ "integrity": "sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w="
+ }
+ }
+ },
+ "snapdragon-node": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/snapdragon-node/-/snapdragon-node-2.1.1.tgz",
+ "integrity": "sha512-O27l4xaMYt/RSQ5TR3vpWCAB5Kb/czIcqUFOM/C4fYcLnbZUc1PkjTAMjof2pBWaSTwOUd6qUHcFGVGj7aIwnw==",
+ "requires": {
+ "define-property": "^1.0.0",
+ "isobject": "^3.0.0",
+ "snapdragon-util": "^3.0.1"
+ },
+ "dependencies": {
+ "define-property": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz",
+ "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=",
+ "requires": {
+ "is-descriptor": "^1.0.0"
+ }
+ },
+ "is-accessor-descriptor": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz",
+ "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==",
+ "requires": {
+ "kind-of": "^6.0.0"
+ }
+ },
+ "is-data-descriptor": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz",
+ "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==",
+ "requires": {
+ "kind-of": "^6.0.0"
+ }
+ },
+ "is-descriptor": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz",
+ "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==",
+ "requires": {
+ "is-accessor-descriptor": "^1.0.0",
+ "is-data-descriptor": "^1.0.0",
+ "kind-of": "^6.0.2"
+ }
+ },
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ },
+ "kind-of": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
+ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw=="
+ }
+ }
+ },
+ "snapdragon-util": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/snapdragon-util/-/snapdragon-util-3.0.1.tgz",
+ "integrity": "sha512-mbKkMdQKsjX4BAL4bRYTj21edOf8cN7XHdYUJEe+Zn99hVEYcMvKPct1IqNe7+AZPirn8BCDOQBHQZknqmKlZQ==",
+ "requires": {
+ "kind-of": "^3.2.0"
+ }
+ },
+ "source-map": {
+ "version": "0.6.1",
+ "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+ "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g=="
+ },
+ "source-map-resolve": {
+ "version": "0.5.3",
+ "resolved": "https://registry.npmjs.org/source-map-resolve/-/source-map-resolve-0.5.3.tgz",
+ "integrity": "sha512-Htz+RnsXWk5+P2slx5Jh3Q66vhQj1Cllm0zvnaY98+NFx+Dv2CF/f5O/t8x+KaNdrdIAsruNzoh/KpialbqAnw==",
+ "requires": {
+ "atob": "^2.1.2",
+ "decode-uri-component": "^0.2.0",
+ "resolve-url": "^0.2.1",
+ "source-map-url": "^0.4.0",
+ "urix": "^0.1.0"
+ }
+ },
+ "source-map-url": {
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/source-map-url/-/source-map-url-0.4.1.tgz",
+ "integrity": "sha512-cPiFOTLUKvJFIg4SKVScy4ilPPW6rFgMgfuZJPNoDuMs3nC1HbMUycBoJw77xFIp6z1UJQJOfx6C9GMH80DiTw=="
+ },
+ "split-string": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/split-string/-/split-string-3.1.0.tgz",
+ "integrity": "sha512-NzNVhJDYpwceVVii8/Hu6DKfD2G+NrQHlS/V/qgv763EYudVwEcMQNxd2lh+0VrUByXN/oJkl5grOhYWvQUYiw==",
+ "requires": {
+ "extend-shallow": "^3.0.0"
+ }
+ },
+ "sprintf-js": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
+ "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw="
+ },
+ "state-toggle": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/state-toggle/-/state-toggle-1.0.3.tgz",
+ "integrity": "sha512-d/5Z4/2iiCnHw6Xzghyhb+GcmF89bxwgXG60wjIiZaxnymbyOmI8Hk4VqHXiVVp6u2ysaskFfXg3ekCj4WNftQ=="
+ },
+ "static-extend": {
+ "version": "0.1.2",
+ "resolved": "https://registry.npmjs.org/static-extend/-/static-extend-0.1.2.tgz",
+ "integrity": "sha1-YICcOcv/VTNyJv1eC1IPNB8ftcY=",
+ "requires": {
+ "define-property": "^0.2.5",
+ "object-copy": "^0.1.0"
+ },
+ "dependencies": {
+ "define-property": {
+ "version": "0.2.5",
+ "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz",
+ "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=",
+ "requires": {
+ "is-descriptor": "^0.1.0"
+ }
+ }
+ }
+ },
+ "string-width": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz",
+ "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=",
+ "requires": {
+ "code-point-at": "^1.0.0",
+ "is-fullwidth-code-point": "^1.0.0",
+ "strip-ansi": "^3.0.0"
+ }
+ },
+ "string_decoder": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz",
+ "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==",
+ "requires": {
+ "safe-buffer": "~5.1.0"
+ }
+ },
+ "stringify-entities": {
+ "version": "1.3.2",
+ "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-1.3.2.tgz",
+ "integrity": "sha512-nrBAQClJAPN2p+uGCVJRPIPakKeKWZ9GtBCmormE7pWOSlHat7+x5A8gx85M7HM5Dt0BP3pP5RhVW77WdbJJ3A==",
+ "requires": {
+ "character-entities-html4": "^1.0.0",
+ "character-entities-legacy": "^1.0.0",
+ "is-alphanumerical": "^1.0.0",
+ "is-hexadecimal": "^1.0.0"
+ }
+ },
+ "strip-ansi": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz",
+ "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=",
+ "requires": {
+ "ansi-regex": "^2.0.0"
+ }
+ },
+ "strip-json-comments": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz",
+ "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo="
+ },
+ "superagent": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/superagent/-/superagent-6.1.0.tgz",
+ "integrity": "sha512-OUDHEssirmplo3F+1HWKUrUjvnQuA+nZI6i/JJBdXb5eq9IyEQwPyPpqND+SSsxf6TygpBEkUjISVRN4/VOpeg==",
+ "requires": {
+ "component-emitter": "^1.3.0",
+ "cookiejar": "^2.1.2",
+ "debug": "^4.1.1",
+ "fast-safe-stringify": "^2.0.7",
+ "form-data": "^3.0.0",
+ "formidable": "^1.2.2",
+ "methods": "^1.1.2",
+ "mime": "^2.4.6",
+ "qs": "^6.9.4",
+ "readable-stream": "^3.6.0",
+ "semver": "^7.3.2"
+ },
+ "dependencies": {
+ "debug": {
+ "version": "4.3.1",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz",
+ "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==",
+ "requires": {
+ "ms": "2.1.2"
+ }
+ },
+ "ms": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
+ "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
+ },
+ "readable-stream": {
+ "version": "3.6.0",
+ "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz",
+ "integrity": "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==",
+ "requires": {
+ "inherits": "^2.0.3",
+ "string_decoder": "^1.1.1",
+ "util-deprecate": "^1.0.1"
+ }
+ }
+ }
+ },
+ "supports-color": {
+ "version": "5.5.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
+ "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
+ "requires": {
+ "has-flag": "^3.0.0"
+ }
+ },
+ "text-table": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz",
+ "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ="
+ },
+ "to-object-path": {
+ "version": "0.3.0",
+ "resolved": "https://registry.npmjs.org/to-object-path/-/to-object-path-0.3.0.tgz",
+ "integrity": "sha1-KXWIt7Dn4KwI4E5nL4XB9JmeF68=",
+ "requires": {
+ "kind-of": "^3.0.2"
+ }
+ },
+ "to-regex": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/to-regex/-/to-regex-3.0.2.tgz",
+ "integrity": "sha512-FWtleNAtZ/Ki2qtqej2CXTOayOH9bHDQF+Q48VpWyDXjbYxA4Yz8iDB31zXOBUlOHHKidDbqGVrTUvQMPmBGBw==",
+ "requires": {
+ "define-property": "^2.0.2",
+ "extend-shallow": "^3.0.2",
+ "regex-not": "^1.0.2",
+ "safe-regex": "^1.1.0"
+ }
+ },
+ "to-regex-range": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-2.1.1.tgz",
+ "integrity": "sha1-fIDBe53+vlmeJzZ+DU3VWQFB2zg=",
+ "requires": {
+ "is-number": "^3.0.0",
+ "repeat-string": "^1.6.1"
+ },
+ "dependencies": {
+ "is-number": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-3.0.0.tgz",
+ "integrity": "sha1-JP1iAaR4LPUFYcgQJ2r8fRLXEZU=",
+ "requires": {
+ "kind-of": "^3.0.2"
+ }
+ }
+ }
+ },
+ "to-vfile": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/to-vfile/-/to-vfile-1.0.0.tgz",
+ "integrity": "sha1-iN7+zUOtsu9ZhiXw49WffzQpQbo=",
+ "requires": {
+ "vfile": "^1.0.0"
+ },
+ "dependencies": {
+ "vfile": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/vfile/-/vfile-1.4.0.tgz",
+ "integrity": "sha1-wP1vpIT43r23cfaMMe112I2pf+c="
+ }
+ }
+ },
+ "trim": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/trim/-/trim-0.0.1.tgz",
+ "integrity": "sha1-WFhUf2spB1fulczMZm+1AITEYN0="
+ },
+ "trim-trailing-lines": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/trim-trailing-lines/-/trim-trailing-lines-1.1.4.tgz",
+ "integrity": "sha512-rjUWSqnfTNrjbB9NQWfPMH/xRK1deHeGsHoVfpxJ++XeYXE0d6B1En37AHfw3jtfTU7dzMzZL2jjpe8Qb5gLIQ=="
+ },
+ "trough": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/trough/-/trough-1.0.5.tgz",
+ "integrity": "sha512-rvuRbTarPXmMb79SmzEp8aqXNKcK+y0XaB298IXueQ8I2PsrATcPBCSPyK/dDNa2iWOhKlfNnOjdAOTBU/nkFA=="
+ },
+ "tslib": {
+ "version": "1.14.1",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz",
+ "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg=="
+ },
+ "type": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/type/-/type-1.2.0.tgz",
+ "integrity": "sha512-+5nt5AAniqsCnu2cEQQdpzCAh33kVx8n0VoFidKpB1dVVLAN/F+bgVOqOJqOnEnrhp222clB5p3vUlD+1QAnfg=="
+ },
+ "typedarray": {
+ "version": "0.0.6",
+ "resolved": "https://registry.npmjs.org/typedarray/-/typedarray-0.0.6.tgz",
+ "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c="
+ },
+ "typedoc": {
+ "version": "0.15.8",
+ "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.15.8.tgz",
+ "integrity": "sha512-a0zypcvfIFsS7Gqpf2MkC1+jNND3K1Om38pbDdy/gYWX01NuJZhC5+O0HkIp0oRIZOo7PWrA5+fC24zkANY28Q==",
+ "requires": {
+ "@types/minimatch": "3.0.3",
+ "fs-extra": "^8.1.0",
+ "handlebars": "^4.7.0",
+ "highlight.js": "^9.17.1",
+ "lodash": "^4.17.15",
+ "marked": "^0.8.0",
+ "minimatch": "^3.0.0",
+ "progress": "^2.0.3",
+ "shelljs": "^0.8.3",
+ "typedoc-default-themes": "^0.6.3",
+ "typescript": "3.7.x"
+ },
+ "dependencies": {
+ "typescript": {
+ "version": "3.7.7",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.7.tgz",
+ "integrity": "sha512-MmQdgo/XenfZPvVLtKZOq9jQQvzaUAUpcKW8Z43x9B2fOm4S5g//tPtMweZUIP+SoBqrVPEIm+dJeQ9dfO0QdA=="
+ }
+ }
+ },
+ "typedoc-default-themes": {
+ "version": "0.6.3",
+ "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.6.3.tgz",
+ "integrity": "sha512-rouf0TcIA4M2nOQFfC7Zp4NEwoYiEX4vX/ZtudJWU9IHA29MPC+PPgSXYLPESkUo7FuB//GxigO3mk9Qe1xp3Q==",
+ "requires": {
+ "backbone": "^1.4.0",
+ "jquery": "^3.4.1",
+ "lunr": "^2.3.8",
+ "underscore": "^1.9.1"
+ }
+ },
+ "typescript": {
+ "version": "3.9.8",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.8.tgz",
+ "integrity": "sha512-nDbnFkUZZjkQ92qwKX+C+jtk4OGfU8H9toSEs3uAsl8cxLjG2sqQm6leF/pLWvm9FAEJ6KHkYMAbHYaY2ITeVg=="
+ },
+ "uc.micro": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz",
+ "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA=="
+ },
+ "uglify-js": {
+ "version": "3.13.0",
+ "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.13.0.tgz",
+ "integrity": "sha512-TWYSWa9T2pPN4DIJYbU9oAjQx+5qdV5RUDxwARg8fmJZrD/V27Zj0JngW5xg1DFz42G0uDYl2XhzF6alSzD62w==",
+ "optional": true
+ },
+ "underscore": {
+ "version": "1.12.0",
+ "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.0.tgz",
+ "integrity": "sha512-21rQzss/XPMjolTiIezSu3JAjgagXKROtNrYFEOWK109qY1Uv2tVjPTZ1ci2HgvQDA16gHYSthQIJfB+XId/rQ=="
+ },
+ "unherit": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/unherit/-/unherit-1.1.3.tgz",
+ "integrity": "sha512-Ft16BJcnapDKp0+J/rqFC3Rrk6Y/Ng4nzsC028k2jdDII/rdZ7Wd3pPT/6+vIIxRagwRc9K0IUX0Ra4fKvw+WQ==",
+ "requires": {
+ "inherits": "^2.0.0",
+ "xtend": "^4.0.0"
+ }
+ },
+ "unified": {
+ "version": "6.2.0",
+ "resolved": "https://registry.npmjs.org/unified/-/unified-6.2.0.tgz",
+ "integrity": "sha512-1k+KPhlVtqmG99RaTbAv/usu85fcSRu3wY8X+vnsEhIxNP5VbVIDiXnLqyKIG+UMdyTg0ZX9EI6k2AfjJkHPtA==",
+ "requires": {
+ "bail": "^1.0.0",
+ "extend": "^3.0.0",
+ "is-plain-obj": "^1.1.0",
+ "trough": "^1.0.0",
+ "vfile": "^2.0.0",
+ "x-is-string": "^0.1.0"
+ }
+ },
+ "union-value": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.1.tgz",
+ "integrity": "sha512-tJfXmxMeWYnczCVs7XAEvIV7ieppALdyepWMkHkwciRpZraG/xwT+s2JN8+pr1+8jCRf80FFzvr+MpQeeoF4Xg==",
+ "requires": {
+ "arr-union": "^3.1.0",
+ "get-value": "^2.0.6",
+ "is-extendable": "^0.1.1",
+ "set-value": "^2.0.1"
+ }
+ },
+ "unist-util-is": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-3.0.0.tgz",
+ "integrity": "sha512-sVZZX3+kspVNmLWBPAB6r+7D9ZgAFPNWm66f7YNb420RlQSbn+n8rG8dGZSkrER7ZIXGQYNm5pqC3v3HopH24A=="
+ },
+ "unist-util-remove-position": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/unist-util-remove-position/-/unist-util-remove-position-1.1.4.tgz",
+ "integrity": "sha512-tLqd653ArxJIPnKII6LMZwH+mb5q+n/GtXQZo6S6csPRs5zB0u79Yw8ouR3wTw8wxvdJFhpP6Y7jorWdCgLO0A==",
+ "requires": {
+ "unist-util-visit": "^1.1.0"
+ }
+ },
+ "unist-util-select": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/unist-util-select/-/unist-util-select-2.0.0.tgz",
+ "integrity": "sha512-fRQqhrpgRIwdaeeZwbgDO84VyiyQP6cOcbzCao4saXuMuP3fLiWkssEI+o71OC2mASWqa9JEEYiGOV8EqpStPw==",
+ "requires": {
+ "css-selector-parser": "^1.1.0",
+ "debug": "^3.1.0",
+ "not": "^0.1.0",
+ "nth-check": "^1.0.1",
+ "unist-util-is": "^2.1.2",
+ "zwitch": "^1.0.3"
+ },
+ "dependencies": {
+ "unist-util-is": {
+ "version": "2.1.3",
+ "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-2.1.3.tgz",
+ "integrity": "sha512-4WbQX2iwfr/+PfM4U3zd2VNXY+dWtZsN1fLnWEi2QQXA4qyDYAZcDMfXUX0Cu6XZUHHAO9q4nyxxLT4Awk1qUA=="
+ }
+ }
+ },
+ "unist-util-stringify-position": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-1.1.2.tgz",
+ "integrity": "sha512-pNCVrk64LZv1kElr0N1wPiHEUoXNVFERp+mlTg/s9R5Lwg87f9bM/3sQB99w+N9D/qnM9ar3+AKDBwo/gm/iQQ=="
+ },
+ "unist-util-visit": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-1.4.1.tgz",
+ "integrity": "sha512-AvGNk7Bb//EmJZyhtRUnNMEpId/AZ5Ph/KUpTI09WHQuDZHKovQ1oEv3mfmKpWKtoMzyMC4GLBm1Zy5k12fjIw==",
+ "requires": {
+ "unist-util-visit-parents": "^2.0.0"
+ }
+ },
+ "unist-util-visit-parents": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-2.1.2.tgz",
+ "integrity": "sha512-DyN5vD4NE3aSeB+PXYNKxzGsfocxp6asDc2XXE3b0ekO2BaRUpBicbbUygfSvYfUz1IkmjFR1YF7dPklraMZ2g==",
+ "requires": {
+ "unist-util-is": "^3.0.0"
+ }
+ },
+ "universalify": {
+ "version": "0.1.2",
+ "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",
+ "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg=="
+ },
+ "unset-value": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/unset-value/-/unset-value-1.0.0.tgz",
+ "integrity": "sha1-g3aHP30jNRef+x5vw6jtDfyKtVk=",
+ "requires": {
+ "has-value": "^0.3.1",
+ "isobject": "^3.0.0"
+ },
+ "dependencies": {
+ "has-value": {
+ "version": "0.3.1",
+ "resolved": "https://registry.npmjs.org/has-value/-/has-value-0.3.1.tgz",
+ "integrity": "sha1-ex9YutpiyoJ+wKIHgCVlSEWZXh8=",
+ "requires": {
+ "get-value": "^2.0.3",
+ "has-values": "^0.1.4",
+ "isobject": "^2.0.0"
+ },
+ "dependencies": {
+ "isobject": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-2.1.0.tgz",
+ "integrity": "sha1-8GVWEJaj8dou9GJy+BXIQNh+DIk=",
+ "requires": {
+ "isarray": "1.0.0"
+ }
+ }
+ }
+ },
+ "has-values": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/has-values/-/has-values-0.1.4.tgz",
+ "integrity": "sha1-bWHeldkd/Km5oCCJrThL/49it3E="
+ },
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ }
+ }
+ },
+ "untildify": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/untildify/-/untildify-2.1.0.tgz",
+ "integrity": "sha1-F+soB5h/dpUunASF/DEdBqgmouA=",
+ "requires": {
+ "os-homedir": "^1.0.0"
+ }
+ },
+ "urix": {
+ "version": "0.1.0",
+ "resolved": "https://registry.npmjs.org/urix/-/urix-0.1.0.tgz",
+ "integrity": "sha1-2pN/emLiH+wf0Y1Js1wpNQZ6bHI="
+ },
+ "use": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/use/-/use-3.1.1.tgz",
+ "integrity": "sha512-cwESVXlO3url9YWlFW/TA9cshCEhtu7IKJ/p5soJ/gGpj7vbvFrAY/eIioQ6Dw23KjZhYgiIo8HOs1nQ2vr/oQ=="
+ },
+ "user-home": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/user-home/-/user-home-2.0.0.tgz",
+ "integrity": "sha1-nHC/2Babwdy/SGBODwS4tJzenp8=",
+ "requires": {
+ "os-homedir": "^1.0.0"
+ }
+ },
+ "util-deprecate": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
+ "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8="
+ },
+ "vfile": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/vfile/-/vfile-2.3.0.tgz",
+ "integrity": "sha512-ASt4mBUHcTpMKD/l5Q+WJXNtshlWxOogYyGYYrg4lt/vuRjC1EFQtlAofL5VmtVNIZJzWYFJjzGWZ0Gw8pzW1w==",
+ "requires": {
+ "is-buffer": "^1.1.4",
+ "replace-ext": "1.0.0",
+ "unist-util-stringify-position": "^1.0.0",
+ "vfile-message": "^1.0.0"
+ }
+ },
+ "vfile-location": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/vfile-location/-/vfile-location-2.0.6.tgz",
+ "integrity": "sha512-sSFdyCP3G6Ka0CEmN83A2YCMKIieHx0EDaj5IDP4g1pa5ZJ4FJDvpO0WODLxo4LUX4oe52gmSCK7Jw4SBghqxA=="
+ },
+ "vfile-message": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-1.1.1.tgz",
+ "integrity": "sha512-1WmsopSGhWt5laNir+633LszXvZ+Z/lxveBf6yhGsqnQIhlhzooZae7zV6YVM1Sdkw68dtAW3ow0pOdPANugvA==",
+ "requires": {
+ "unist-util-stringify-position": "^1.1.1"
+ }
+ },
+ "vfile-reporter": {
+ "version": "1.5.0",
+ "resolved": "https://registry.npmjs.org/vfile-reporter/-/vfile-reporter-1.5.0.tgz",
+ "integrity": "sha1-IacAm/5V4k34/0Mqpb9vbvp05Bg=",
+ "requires": {
+ "chalk": "^1.1.0",
+ "log-symbols": "^1.0.2",
+ "plur": "^2.0.0",
+ "repeat-string": "^1.5.0",
+ "string-width": "^1.0.0",
+ "text-table": "^0.2.0",
+ "vfile-sort": "^1.0.0"
+ },
+ "dependencies": {
+ "ansi-styles": {
+ "version": "2.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz",
+ "integrity": "sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4="
+ },
+ "chalk": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz",
+ "integrity": "sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg=",
+ "requires": {
+ "ansi-styles": "^2.2.1",
+ "escape-string-regexp": "^1.0.2",
+ "has-ansi": "^2.0.0",
+ "strip-ansi": "^3.0.0",
+ "supports-color": "^2.0.0"
+ }
+ },
+ "supports-color": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz",
+ "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc="
+ }
+ }
+ },
+ "vfile-sort": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/vfile-sort/-/vfile-sort-1.0.0.tgz",
+ "integrity": "sha1-F+5JG6Q+iVG7IpE/z/MqfcTSNNQ="
+ },
+ "ware": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/ware/-/ware-1.3.0.tgz",
+ "integrity": "sha1-0bFPOdLiy0q4xAmPdW/ksWTkc9Q=",
+ "requires": {
+ "wrap-fn": "^0.1.0"
+ }
+ },
+ "wordwrap": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
+ "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus="
+ },
+ "wrap-fn": {
+ "version": "0.1.5",
+ "resolved": "https://registry.npmjs.org/wrap-fn/-/wrap-fn-0.1.5.tgz",
+ "integrity": "sha1-8htuQQFv9KfjFyDbxjoJAWvfmEU=",
+ "requires": {
+ "co": "3.1.0"
+ }
+ },
+ "wrappy": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
+ "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8="
+ },
+ "x-is-string": {
+ "version": "0.1.0",
+ "resolved": "https://registry.npmjs.org/x-is-string/-/x-is-string-0.1.0.tgz",
+ "integrity": "sha1-R0tQhlrzpJqcRlfwWs0UVFj3fYI="
+ },
+ "xtend": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz",
+ "integrity": "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ=="
+ },
+ "yallist": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
+ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
+ },
+ "zwitch": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-1.0.5.tgz",
+ "integrity": "sha512-V50KMwwzqJV0NpZIZFwfOD5/lyny3WlSzRiXgA0G7VUnRlqttta1L6UQIHzd6EuBY/cHGfwTIck7w1yH6Q5zUw=="
+ }
+ }
+}
diff --git a/tools/doc/package.json b/tools/doc/package.json
new file mode 100644
index 0000000000..d0483f4d09
--- /dev/null
+++ b/tools/doc/package.json
@@ -0,0 +1,36 @@
+{
+ "name": "adf-doc-tools",
+ "description": "ADF doc tools",
+ "version": "4.2.0",
+ "author": "Alfresco Software, Ltd.",
+ "scripts": {},
+ "dependencies": {
+ "@alfresco/js-api": "^4.3.0-3244",
+ "ejs": "^3.1.6",
+ "fast-levenshtein": "^3.0.0",
+ "graphql": "^15.4.0",
+ "graphql-request": "^3.1.0",
+ "js-yaml": "3.14.1",
+ "markdownlint-cli": "^0.16.0",
+ "mdast": "2.1.0",
+ "mdast-util-compact": "1.0.3",
+ "mdast-util-heading-range": "2.1.3",
+ "mdast-util-toc": "2.1.0",
+ "mdast-zone": "3.0.4",
+ "moment": "2.29.1",
+ "remark": "^9.0.0",
+ "remark-frontmatter": "^1.2.0",
+ "rxjs": "^6.6.3",
+ "typedoc": "^0.15.0",
+ "typescript": "3.9.8",
+ "unist-util-select": "2.0.0"
+ },
+ "devDependencies": {
+ "@paperist/types-remark": "0.1.3",
+ "@types/node": "^14.14.26"
+ },
+ "license": "Apache-2.0",
+ "engines": {
+ "node": ">=6.0.0"
+ }
+}
diff --git a/tools/doc/reviewChecker.js b/tools/doc/reviewChecker.js
index 7cb5f54dab..fa8ddb9e6a 100644
--- a/tools/doc/reviewChecker.js
+++ b/tools/doc/reviewChecker.js
@@ -24,7 +24,6 @@ var docsFolderPath = path.resolve('docs');
var libFolders = ['core', 'content-services', 'extensions', 'insights', 'process-services', 'process-services-cloud'];
libsearch(srcData, path.resolve(libFolder));
var authToken = process.env.graphAuthToken;
-
var client = new graphql_request_1.GraphQLClient('https://api.github.com/graphql', {
headers: {
Authorization: 'Bearer ' + authToken
diff --git a/tools/doc/sourceInfoClasses.js b/tools/doc/sourceInfoClasses.js
index 3d50b81348..9d425a91d5 100644
--- a/tools/doc/sourceInfoClasses.js
+++ b/tools/doc/sourceInfoClasses.js
@@ -1,5 +1,6 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentInfo = exports.MethodSigInfo = exports.ParamInfo = exports.PropInfo = void 0;
var skipMethodNames = [
'ngOnChanges',
'ngOnDestroy',
@@ -53,7 +54,7 @@ var PropInfo = /** @class */ (function () {
get: function () {
return this.errorMessages;
},
- enumerable: true,
+ enumerable: false,
configurable: true
});
return PropInfo;
@@ -130,7 +131,7 @@ var MethodSigInfo = /** @class */ (function () {
get: function () {
return this.errorMessages;
},
- enumerable: true,
+ enumerable: false,
configurable: true
});
return MethodSigInfo;
@@ -193,7 +194,7 @@ var ComponentInfo = /** @class */ (function () {
});
return combinedErrors;
},
- enumerable: true,
+ enumerable: false,
configurable: true
});
return ComponentInfo;
diff --git a/tools/doc/stoplist.js b/tools/doc/stoplist.js
index 7ccbb7c146..1a117dc6ea 100644
--- a/tools/doc/stoplist.js
+++ b/tools/doc/stoplist.js
@@ -1,5 +1,6 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
+exports.Stoplist = void 0;
var fs = require("fs");
/* "Stoplist" of regular expressions to match against strings. */
var Stoplist = /** @class */ (function () {
diff --git a/tools/doc/tools/fileChecker.js b/tools/doc/tools/fileChecker.js
index d3b97ba1b3..c1d850f9bf 100644
--- a/tools/doc/tools/fileChecker.js
+++ b/tools/doc/tools/fileChecker.js
@@ -1,6 +1,7 @@
"use strict";
// tslint:disable: no-console
Object.defineProperty(exports, "__esModule", { value: true });
+exports.processDocs = void 0;
var path = require("path");
var fs = require("fs");
var unist_util_select_1 = require("unist-util-select");
diff --git a/tools/doc/tools/gqIndex.js b/tools/doc/tools/gqIndex.js
index 0cc8e9fc3a..4fc8dac7a5 100644
--- a/tools/doc/tools/gqIndex.js
+++ b/tools/doc/tools/gqIndex.js
@@ -1,6 +1,7 @@
"use strict";
// tslint:disable: no-console
Object.defineProperty(exports, "__esModule", { value: true });
+exports.processDocs = void 0;
var fs = require("fs");
var path = require("path");
var ejs = require("ejs");
diff --git a/tools/doc/tools/linkFixer.js b/tools/doc/tools/linkFixer.js
index 868e7b9bb4..bd1050e73e 100644
--- a/tools/doc/tools/linkFixer.js
+++ b/tools/doc/tools/linkFixer.js
@@ -1,6 +1,7 @@
"use strict";
// tslint:disable: no-console
Object.defineProperty(exports, "__esModule", { value: true });
+exports.processDocs = void 0;
var path = require("path");
var fs = require("fs");
var unist_util_select_1 = require("unist-util-select");
diff --git a/tools/doc/tools/sourceLinker.js b/tools/doc/tools/sourceLinker.js
index 2352c846f3..d709755018 100644
--- a/tools/doc/tools/sourceLinker.js
+++ b/tools/doc/tools/sourceLinker.js
@@ -1,5 +1,6 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
+exports.processDocs = void 0;
var path = require("path");
var unist_util_select_1 = require("unist-util-select");
var ngHelpers = require("../ngHelpers");
diff --git a/tools/doc/tools/tsInfo.js b/tools/doc/tools/tsInfo.js
index a3bc7e2a6c..67dacd8897 100644
--- a/tools/doc/tools/tsInfo.js
+++ b/tools/doc/tools/tsInfo.js
@@ -1,6 +1,7 @@
"use strict";
// tslint:disable: no-console
Object.defineProperty(exports, "__esModule", { value: true });
+exports.processDocs = void 0;
var fs = require("fs");
var path = require("path");
var replaceSection = require("mdast-util-heading-range");
diff --git a/tools/doc/tools/tutorialIndex.js b/tools/doc/tools/tutorialIndex.js
index 9b5caa0a5c..2879963fb0 100644
--- a/tools/doc/tools/tutorialIndex.js
+++ b/tools/doc/tools/tutorialIndex.js
@@ -1,5 +1,6 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
+exports.processDocs = void 0;
var fs = require("fs");
var path = require("path");
var replaceSection = require("mdast-util-heading-range");
diff --git a/tools/doc/tools/typeLinker.js b/tools/doc/tools/typeLinker.js
index 39bdd8f315..8bdcc73cf9 100644
--- a/tools/doc/tools/typeLinker.js
+++ b/tools/doc/tools/typeLinker.js
@@ -1,5 +1,13 @@
"use strict";
+var __spreadArrays = (this && this.__spreadArrays) || function () {
+ for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
+ for (var r = Array(s), k = 0, i = 0; i < il; i++)
+ for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
+ r[k] = a[j];
+ return r;
+};
Object.defineProperty(exports, "__esModule", { value: true });
+exports.processDocs = void 0;
var path = require("path");
var unist = require("../unistHelpers");
var ngHelpers = require("../ngHelpers");
@@ -10,6 +18,7 @@ var includedNodeTypes = [
];
var externalNameLinks;
var linkOverrides;
+var ignoreLinkWords;
function processDocs(mdCache, aggData) {
initPhase(aggData, mdCache);
var pathnames = Object.keys(mdCache);
@@ -20,6 +29,7 @@ function processDocs(mdCache, aggData) {
exports.processDocs = processDocs;
function initPhase(aggData, mdCache) {
externalNameLinks = aggData.config.externalNameLinks;
+ ignoreLinkWords = aggData.config.ignoreLinkWords;
linkOverrides = {};
aggData.config.linkOverrides.forEach(function (override) {
linkOverrides[override.toLowerCase()] = 1;
@@ -49,9 +59,11 @@ function updateFile(tree, pathname, aggData) {
if (node.type === 'link') {
if (node.children[0] && ((node.children[0].type === 'inlineCode') ||
(node.children[0].type === 'text'))) {
- var link = resolveTypeLink(aggData, pathname, node.children[0].value);
- if (link) {
- convertNodeToTypeLink(node, node.children[0].value, link);
+ if (!ignoreLinkWords.includes(node.children[0].value)) {
+ var link = resolveTypeLink(aggData, pathname, node.children[0].value);
+ if (link) {
+ convertNodeToTypeLink(node, node.children[0].value, link);
+ }
}
}
}
@@ -60,7 +72,7 @@ function updateFile(tree, pathname, aggData) {
var _a;
if ((child.type === 'text') || (child.type === 'inlineCode')) {
var newNodes = handleLinksInBodyText(aggData, pathname, child.value, child.type === 'inlineCode');
- (_a = node.children).splice.apply(_a, [index, 1].concat(newNodes));
+ (_a = node.children).splice.apply(_a, __spreadArrays([index, 1], newNodes));
}
else {
traverseMDTree(child);
@@ -211,40 +223,42 @@ function handleLinksInBodyText(aggData, docFilePath, text, wrapInlineCode) {
.replace(/'s$/, '')
.replace(/^[;:,\."']+/g, '')
.replace(/[;:,\."']+$/g, '');
- var link = resolveTypeLink(aggData, docFilePath, word);
- var matchStart = void 0;
- if (!link) {
- var match = matcher.nextWord(word.toLowerCase(), scanner.index);
- if (match && match[0]) {
- link = resolveTypeLink(aggData, docFilePath, match[0].value);
- matchStart = match[0].startPos;
- }
- }
- else {
- matchStart = scanner.index;
- }
- if (link) {
- var linkText = text.substring(matchStart, scanner.nextSeparator);
- var linkTitle = void 0;
- if (wrapInlineCode) {
- linkTitle = unist.makeInlineCode(linkText);
+ if (!ignoreLinkWords.includes(word)) {
+ var link = resolveTypeLink(aggData, docFilePath, word);
+ var matchStart = void 0;
+ if (!link) {
+ var match = matcher.nextWord(word.toLowerCase(), scanner.index);
+ if (match && match[0]) {
+ link = resolveTypeLink(aggData, docFilePath, match[0].value);
+ matchStart = match[0].startPos;
+ }
}
else {
- linkTitle = unist.makeText(linkText);
+ matchStart = scanner.index;
}
- var linkNode = unist.makeLink(linkTitle, link);
- var prevText = text.substring(currTextStart, matchStart);
- if (prevText) {
+ if (link) {
+ var linkText = text.substring(matchStart, scanner.nextSeparator);
+ var linkTitle = void 0;
if (wrapInlineCode) {
- result.push(unist.makeInlineCode(prevText));
+ linkTitle = unist.makeInlineCode(linkText);
}
else {
- result.push(unist.makeText(prevText));
+ linkTitle = unist.makeText(linkText);
}
+ var linkNode = unist.makeLink(linkTitle, link);
+ var prevText = text.substring(currTextStart, matchStart);
+ if (prevText) {
+ if (wrapInlineCode) {
+ result.push(unist.makeInlineCode(prevText));
+ }
+ else {
+ result.push(unist.makeText(prevText));
+ }
+ }
+ result.push(linkNode);
+ currTextStart = scanner.nextSeparator;
+ matcher.reset();
}
- result.push(linkNode);
- currTextStart = scanner.nextSeparator;
- matcher.reset();
}
}
var remainingText = text.substring(currTextStart, text.length);
diff --git a/tools/doc/tools/typeLinker.ts b/tools/doc/tools/typeLinker.ts
index 69a1183cae..1a3a0d5a6e 100644
--- a/tools/doc/tools/typeLinker.ts
+++ b/tools/doc/tools/typeLinker.ts
@@ -10,6 +10,7 @@ const includedNodeTypes = [
let externalNameLinks;
let linkOverrides;
+let ignoreLinkWords: any[];
export function processDocs(mdCache, aggData) {
initPhase(aggData, mdCache);
@@ -23,6 +24,7 @@ export function processDocs(mdCache, aggData) {
function initPhase(aggData, mdCache) {
externalNameLinks = aggData.config.externalNameLinks;
+ ignoreLinkWords = aggData.config.ignoreLinkWords;
linkOverrides = {};
aggData.config.linkOverrides.forEach(override => {
@@ -63,17 +65,22 @@ function updateFile(tree, pathname, aggData) {
(node.children[0].type === 'inlineCode') ||
(node.children[0].type === 'text')
)) {
- const link = resolveTypeLink(aggData, pathname, node.children[0].value);
- if (link) {
- convertNodeToTypeLink(node, node.children[0].value, link);
+ if (!ignoreLinkWords.includes(node.children[0].value)) {
+ const link = resolveTypeLink(aggData, pathname, node.children[0].value);
+
+ if (link) {
+ convertNodeToTypeLink(node, node.children[0].value, link);
+ }
}
}
} else if ((node.children) && (node.type !== 'heading')) {
node.children.forEach((child, index) => {
if ((child.type === 'text') || (child.type === 'inlineCode')) {
+
const newNodes = handleLinksInBodyText(aggData, pathname, child.value, child.type === 'inlineCode');
node.children.splice(index, 1, ...newNodes);
+
} else {
traverseMDTree(child);
}
@@ -95,11 +102,13 @@ class SplitNameNode {
}
class SplitNameMatchElement {
- constructor(public node: SplitNameNode, public textPos: number) {}
+ constructor(public node: SplitNameNode, public textPos: number) {
+ }
}
class SplitNameMatchResult {
- constructor(public value: string, public startPos: number) {}
+ constructor(public value: string, public startPos: number) {
+ }
}
class SplitNameMatcher {
@@ -235,49 +244,54 @@ function handleLinksInBodyText(aggData, docFilePath: string, text: string, wrapI
const matcher = new SplitNameMatcher(aggData.nameLookup.root);
for (const scanner = new WordScanner(text); !scanner.finished(); scanner.next()) {
+
+
const word = scanner.current
- .replace(/'s$/, '')
- .replace(/^[;:,\."']+/g, '')
- .replace(/[;:,\."']+$/g, '');
+ .replace(/'s$/, '')
+ .replace(/^[;:,\."']+/g, '')
+ .replace(/[;:,\."']+$/g, '');
- let link = resolveTypeLink(aggData, docFilePath, word);
- let matchStart;
+ if (!ignoreLinkWords.includes(word)) {
- if (!link) {
- const match = matcher.nextWord(word.toLowerCase(), scanner.index);
+ let link = resolveTypeLink(aggData, docFilePath, word);
+ let matchStart;
- if (match && match[0]) {
- link = resolveTypeLink(aggData, docFilePath, match[0].value);
- matchStart = match[0].startPos;
- }
- } else {
- matchStart = scanner.index;
- }
+ if (!link) {
+ const match = matcher.nextWord(word.toLowerCase(), scanner.index);
- if (link) {
- const linkText = text.substring(matchStart, scanner.nextSeparator);
- let linkTitle;
-
- if (wrapInlineCode) {
- linkTitle = unist.makeInlineCode(linkText);
- } else {
- linkTitle = unist.makeText(linkText);
- }
-
- const linkNode = unist.makeLink(linkTitle, link);
- const prevText = text.substring(currTextStart, matchStart);
-
- if (prevText) {
- if (wrapInlineCode) {
- result.push(unist.makeInlineCode(prevText));
- } else {
- result.push(unist.makeText(prevText));
+ if (match && match[0]) {
+ link = resolveTypeLink(aggData, docFilePath, match[0].value);
+ matchStart = match[0].startPos;
}
+ } else {
+ matchStart = scanner.index;
}
- result.push(linkNode);
- currTextStart = scanner.nextSeparator;
- matcher.reset();
+ if (link) {
+ const linkText = text.substring(matchStart, scanner.nextSeparator);
+ let linkTitle;
+
+ if (wrapInlineCode) {
+ linkTitle = unist.makeInlineCode(linkText);
+ } else {
+ linkTitle = unist.makeText(linkText);
+ }
+
+ const linkNode = unist.makeLink(linkTitle, link);
+ const prevText = text.substring(currTextStart, matchStart);
+
+ if (prevText) {
+ if (wrapInlineCode) {
+ result.push(unist.makeInlineCode(prevText));
+ } else {
+ result.push(unist.makeText(prevText));
+ }
+ }
+
+ result.push(linkNode);
+ currTextStart = scanner.nextSeparator;
+ matcher.reset();
+ }
}
}
diff --git a/tools/doc/tsconfig.json b/tools/doc/tsconfig.json
index 6d84eb23c3..3b9662b9a1 100644
--- a/tools/doc/tsconfig.json
+++ b/tools/doc/tsconfig.json
@@ -2,11 +2,12 @@
"compilerOptions": {
"outDir": ".",
"baseUrl": ".",
+ "module": "commonjs",
"moduleResolution": "node",
"noUnusedLocals": true,
"target": "es5",
"types": ["node", "@paperist/types-remark"],
- "typeRoots": ["node_modules/@types"],
+ "typeRoots": ["./node_modules/@types"],
"lib": ["es2018", "dom"]
},
"files": [