From 00dfd7c5d9532b6bbd2690d830b13dff827dae09 Mon Sep 17 00:00:00 2001 From: Eugenio Romano Date: Mon, 2 Jan 2023 15:00:01 +0100 Subject: [PATCH] Update doc (#8085) --- docs/README.md | 257 +++++++++--------- .../breaking-change-2.6.0-3.0.0.md | 10 +- .../components/document-list.component.md | 4 +- .../components/upload-button.component.md | 2 +- .../components/upload-drag-area.component.md | 4 +- .../upload-version-button.component.md | 2 +- .../components/version-manager.component.md | 2 +- .../components/version-upload.component.md | 4 +- .../directives/auto-focus.directive.md | 2 - .../version-compatibility.directive.md | 2 +- ...base-card-view-content-update.interface.md | 3 +- .../models/image-resolver.model.md | 8 +- .../services/audit.service.md | 12 +- .../card-view-content-update.service.md | 9 +- .../services/custom-resources.service.md | 32 +-- .../services/document-list.service.md | 4 +- .../services/node-comments.service.md | 16 +- .../services/sites.service.md | 2 +- .../services/task-comments.service.md | 18 +- .../components/about-github-link.component.md | 3 +- docs/core/components/about.component.md | 2 +- .../core/components/buttons-menu.component.md | 2 +- docs/core/components/card-view.component.md | 32 +-- .../core/components/comment-list.component.md | 6 +- docs/core/components/comments.component.md | 2 +- docs/core/components/data-column.component.md | 14 +- docs/core/components/datatable.component.md | 30 +- .../components/empty-content.component.md | 2 +- docs/core/components/empty-list.component.md | 2 +- .../components/error-content.component.md | 2 +- docs/core/components/form-field.component.md | 38 +-- docs/core/components/form-list.component.md | 2 +- docs/core/components/header.component.md | 2 +- .../components/host-settings.component.md | 2 +- docs/core/components/icon.component.md | 2 +- .../infinite-pagination.component.md | 6 +- .../info-drawer-layout.component.md | 2 +- .../components/info-drawer-tab.component.md | 2 +- docs/core/components/info-drawer.component.md | 2 +- docs/core/components/json-cell.component.md | 8 +- .../components/language-menu.component.md | 3 +- .../login-dialog-panel.component.md | 4 +- .../core/components/login-dialog.component.md | 6 +- docs/core/components/login.component.md | 8 +- .../notification-history.component.md | 2 +- docs/core/components/pagination.component.md | 18 +- docs/core/components/rich-text-editor.md | 14 +- .../components/search-text-input.component.md | 2 +- .../sidebar-action-menu.component.md | 2 +- .../components/sidenav-layout.component.md | 2 +- .../components/snackbar-content.component.md | 19 +- .../components/sorting-picker.component.md | 2 +- docs/core/components/start-form.component.md | 18 +- docs/core/components/text-mask.component.md | 2 +- .../components/toolbar-divider.component.md | 2 +- .../components/toolbar-title.component.md | 2 +- docs/core/components/toolbar.component.md | 2 +- docs/core/components/user-info.component.md | 2 +- docs/core/components/viewer.component.md | 6 +- docs/core/directives/clipboard.directive.md | 2 +- .../core/directives/context-menu.directive.md | 2 +- docs/core/directives/highlight.directive.md | 2 +- .../infinite-select-scroll.directive.md | 2 +- docs/core/directives/logout.directive.md | 2 +- .../directives/node-download.directive.md | 2 +- docs/core/directives/upload.directive.md | 2 +- .../interfaces/card-view-item.interface.md | 6 +- .../interfaces/datatable-adapter.interface.md | 30 +- .../form-field-validator.interface.md | 24 +- .../search-configuration.interface.md | 2 +- docs/core/models/bpm-user.model.md | 2 +- docs/core/models/ecm-user.model.md | 2 +- docs/core/models/form-field.model.md | 18 +- docs/core/models/product-version.model.md | 2 +- docs/core/models/user-process.model.md | 2 +- docs/core/pipes/app-config.pipe.md | 2 +- docs/core/pipes/decimal-number.pipe.md | 6 +- docs/core/pipes/file-size.pipe.md | 2 +- docs/core/pipes/format-space.pipe.md | 2 +- docs/core/pipes/full-name.pipe.md | 2 +- docs/core/pipes/localized-date.pipe.md | 2 +- docs/core/pipes/mime-type-icon.pipe.md | 2 +- docs/core/pipes/multi-value.pipe.md | 4 +- docs/core/pipes/node-name-tooltip.pipe.md | 2 +- docs/core/pipes/text-highlight.pipe.md | 2 +- docs/core/pipes/time-ago.pipe.md | 2 +- docs/core/pipes/user-initial.pipe.md | 2 +- .../services/activiti-alfresco.service.md | 2 +- docs/core/services/alfresco-api.service.md | 2 +- docs/core/services/app-config.service.md | 6 +- docs/core/services/apps-process.service.md | 2 +- docs/core/services/auth-guard-bpm.service.md | 2 +- docs/core/services/auth-guard-ecm.service.md | 2 +- .../services/auth-guard-sso-role.service.md | 7 +- docs/core/services/auth-guard.service.md | 2 +- docs/core/services/authentication.service.md | 9 +- docs/core/services/bpm-user.service.md | 2 +- docs/core/services/card-item-types.service.md | 34 +-- docs/core/services/clipboard.service.md | 2 +- docs/core/services/comment-content.service.md | 10 +- docs/core/services/comment-process.service.md | 18 +- docs/core/services/content.service.md | 12 +- docs/core/services/cookie.service.md | 2 +- .../services/deleted-nodes-api.service.md | 2 +- docs/core/services/discovery-api.service.md | 10 +- docs/core/services/download-zip.service.md | 2 +- docs/core/services/ecm-user.service.md | 2 +- docs/core/services/favorites-api.service.md | 2 +- docs/core/services/form-rendering.service.md | 50 ++-- docs/core/services/form.service.md | 24 +- .../services/highlight-transform.service.md | 8 +- docs/core/services/identity-group.service.md | 85 +----- docs/core/services/identity-role.service.md | 2 +- docs/core/services/identity-user.service.md | 138 +--------- docs/core/services/jwt-helper.service.md | 2 +- docs/core/services/log.service.md | 6 +- docs/core/services/login-dialog.service.md | 2 +- docs/core/services/nodes-api.service.md | 6 +- docs/core/services/notification.service.md | 26 +- docs/core/services/page-title.service.md | 2 +- docs/core/services/people-content.service.md | 12 +- docs/core/services/people-process.service.md | 10 +- docs/core/services/process-content.service.md | 2 +- docs/core/services/renditions.service.md | 2 +- .../services/search-configuration.service.md | 2 +- docs/core/services/search.service.md | 8 +- .../core/services/shared-links-api.service.md | 2 +- docs/core/services/storage.service.md | 2 +- docs/core/services/thumbnail.service.md | 2 +- docs/core/services/translation.service.md | 2 +- docs/core/services/upload.service.md | 40 +-- docs/core/services/user-access.service.md | 2 +- .../core/services/user-preferences.service.md | 2 +- docs/core/widgets/content.widget.md | 2 +- .../components/form-cloud.component.md | 16 +- .../components/group-cloud.component.md | 12 +- .../components/people-cloud.component.md | 14 +- .../process-list-cloud.component.md | 6 +- .../start-process-cloud.component.md | 2 +- .../components/task-form-cloud.component.md | 8 +- .../components/task-list-cloud.component.md | 12 +- .../pipes/group-initial.pipe.md | 2 +- .../services/form-cloud.service.md | 16 +- .../services/process-filter-cloud.service.md | 9 +- .../services/process-list-cloud.service.md | 5 + .../services/start-process-cloud.service.md | 2 +- .../services/task-cloud.service.md | 6 +- .../components/form.component.md | 20 +- .../components/process-list.component.md | 4 +- .../components/start-process.component.md | 2 +- .../components/task-comments.component.md | 2 +- .../components/task-details.component.md | 12 +- .../components/task-form.component.md | 12 +- .../components/task-list.component.md | 6 +- .../services/process.service.md | 16 +- docs/upgrade-guide/upgrade26-30.md | 8 +- docs/upgrade-guide/upgrade50-60.md | 96 +++---- docs/versionIndex.md | 21 +- 158 files changed, 758 insertions(+), 928 deletions(-) diff --git a/docs/README.md b/docs/README.md index e523377016..5fb88557c7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -82,65 +82,61 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [About Application Modules Component](core/components/about-application.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which ADF libraries and plugins an application is using. | [Source](../lib/core/about/about-application-modules/about-application-modules.component.ts) | -| [About GitHub Link Component](core/components/about-github-link.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application. | [Source](../lib/core/about/about-github-link/about-github-link.component.ts) | -| [About Product Version Component](core/components/about-product-version.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application. | [Source](../lib/core/about/about-product-version/about-product-version.component.ts) | -| [Buttons Menu Component](core/components/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/buttons-menu/buttons-menu.component.ts) | -| [Card View component](core/components/card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) | -| [Comment list component](core/components/comment-list.component.md) | Shows a list of comments. | [Source](../lib/core/comments/comment-list.component.ts) | -| [Comments Component](core/components/comments.component.md) | Displays comments from users involved in a specified task or content and allows an involved user to add a comment to a task or a content. | [Source](../lib/core/comments/comments.component.ts) | -| [Data Column Component](core/components/data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) | -| [DataTable component](core/components/datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) | -| [Empty Content Component](core/components/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../lib/core/templates/empty-content/empty-content.component.ts) | -| [Empty list component](core/components/empty-list.component.md) | Displays a message indicating that a list is empty. | [Source](../lib/core/datatable/components/empty-list/empty-list.component.ts) | -| [Error Content Component](core/components/error-content.component.md) | Displays info about a specific error. | [Source](../lib/core/templates/error-content/error-content.component.ts) | -| [Form field component](core/components/form-field.component.md) | Represents a UI field in a form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) | -| [Form List Component](core/components/form-list.component.md) | Shows forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | -| [Header component](core/components/header.component.md) | Reusable header for Alfresco applications. | [Source](../lib/core/layout/components/header/header.component.ts) | -| [Host settings component](core/components/host-settings.component.md) ![Internal](docassets/images/InternalIcon.png) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | -| [Icon Component](core/components/icon.component.md) | Provides a universal way of rendering registered and named icons. | [Source](../lib/core/icon/icon.component.ts) | -| [Infinite Pagination component](core/components/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | -| [Info drawer layout component](core/components/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | -| [Info Drawer Tab component](core/components/info-drawer-tab.component.md) | Renders tabs in a Info drawer component. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | -| [Info Drawer component](core/components/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | -| [Json Cell component](core/components/json-cell.component.md) | Shows a JSON-formatted value inside a datatable component. | [Source](../lib/core/datatable/components/json-cell/json-cell.component.ts) | -| [Language Menu component](core/components/language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) | -| [Login Dialog Panel component](core/components/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/login/components/login-dialog-panel.component.ts) | -| [Login Dialog component](core/components/login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../lib/core/login/components/login-dialog.component.ts) | -| [Login component](core/components/login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | +| [About Application Modules Component](core/components/about-application.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which ADF libraries and plugins an application is using. | [Source](../lib/core/src/lib/about/about-application-modules/about-application-modules.component.ts) | +| [About GitHub Link Component](core/components/about-github-link.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application. | [Source](../lib/core/src/lib/about/about-github-link/about-github-link.component.ts) | +| [About Product Version Component](core/components/about-product-version.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application. | [Source](../lib/core/src/lib/about/about-product-version/about-product-version.component.ts) | +| [About Component](core/components/about.component.md) | Presentational component to display About information as a set of collapsible panels. | [Source](<>) | +| [Buttons Menu Component](core/components/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/src/lib/buttons-menu/buttons-menu.component.ts) | +| [Card View component](core/components/card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/src/lib/card-view/components/card-view/card-view.component.ts) | +| [Comment list component](core/components/comment-list.component.md) | Shows a list of comments. | [Source](../lib/core/src/lib/comments/comment-list.component.ts) | +| [Comments Component](core/components/comments.component.md) | Displays comments from users involved in a specified environment and allows an involved user to add a comment to a environment. | [Source](../lib/core/src/lib/comments/comments.component.ts) | +| [Data Column Component](core/components/data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/src/lib/data-column/data-column.component.ts) | +| [DataTable component](core/components/datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/src/lib/datatable/components/datatable/datatable.component.ts) | +| [Empty Content Component](core/components/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../lib/core/src/lib/templates/empty-content/empty-content.component.ts) | +| [Empty list component](core/components/empty-list.component.md) | Displays a message indicating that a list is empty. | [Source](../lib/core/src/lib/datatable/components/empty-list/empty-list.component.ts) | +| [Error Content Component](core/components/error-content.component.md) | Displays info about a specific error. | [Source](../lib/core/src/lib/templates/error-content/error-content.component.ts) | +| [Form field component](core/components/form-field.component.md) | Represents a UI field in a form. | [Source](../lib/core/src/lib/form/components/form-field/form-field.component.ts) | +| [Form List Component](core/components/form-list.component.md) | Shows forms as a list. | [Source](../lib/process-services/src/lib/form/form-list/form-list.component.ts) | +| [Header component](core/components/header.component.md) | Reusable header for Alfresco applications. | [Source](../lib/core/src/lib/layout/components/header/header.component.ts) | +| [Host settings component](core/components/host-settings.component.md) ![Internal](docassets/images/InternalIcon.png) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/src/lib/settings/host-settings.component.ts) | +| [Icon Component](core/components/icon.component.md) | Provides a universal way of rendering registered and named icons. | [Source](../lib/core/src/lib/icon/icon.component.ts) | +| [Infinite Pagination component](core/components/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/src/lib/pagination/infinite-pagination.component.ts) | +| [Info drawer layout component](core/components/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/src/lib/info-drawer/info-drawer-layout.component.ts) | +| [Info Drawer Tab component](core/components/info-drawer-tab.component.md) | Renders tabs in a Info drawer component. | [Source](../lib/core/src/lib/info-drawer/info-drawer.component.ts) | +| [Info Drawer component](core/components/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/src/lib/info-drawer/info-drawer.component.ts) | +| [Json Cell component](core/components/json-cell.component.md) | Shows a JSON-formatted value inside a datatable component. | [Source](../lib/core/src/lib/datatable/components/json-cell/json-cell.component.ts) | +| [Language Menu component](core/components/language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../lib/core/src/lib/language-menu/language-menu.component.ts) | +| [Login Dialog Panel component](core/components/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/src/lib/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/src/lib/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/src/lib/login/components/login.component.ts) | | [Notification History component](core/components/notification-history.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component is in the current status just an experimental component. | | -| The main purpose of the Notification history component is list all the notification received in the current session. They will disappear from the list after the refresh. | [Source](../lib/core/notifications/components/notification-history.component.ts) | | -| [Pagination Component](core/components/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | -| [Rich Text Editor Component](core/components/rich-text-editor.md) | Displays a rich text editor that allows users to add formatted text | [Source](lib/core/src/lib/rich-text-editor/rich-text-editor.component.ts) | -| [Search Text Input Component](core/components/search-text-input.component.md) | Displays a input text that supports autocompletion | [Source](../lib/core/search-text/search-text-input.component.ts) | -| [Sidebar action menu component](core/components/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) | -| [Sidenav Layout component](core/components/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) | -| [Sorting Picker Component](core/components/sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../lib/core/sorting-picker/sorting-picker.component.ts) | -| [Snackbar Content Component](core/components/snackbar-content.component.md) | Custom content for Snackbar which allows use icon as action.| [Source](../lib/core/src/lib/snackbar-content/snackbar-content.component.ts) | +| 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/src/lib/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/src/lib/pagination/pagination.component.ts) | +| [Rich Text Editor component](core/components/rich-text-editor.md) | Wrap Editor.js element to show a Rich Text editor allows to add formatted text. | [Source](../lib/core/src/lib/rich-text-editor/rich-text-editor.component.ts) | +| [Search Text Input Component](core/components/search-text-input.component.md) | Displays a input text that supports autocompletion | [Source](../lib/core/src/lib/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/src/lib/layout/components/sidebar-action/sidebar-action-menu.component.ts) | +| [Sidenav Layout component](core/components/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/src/lib/layout/components/sidenav-layout/sidenav-layout.component.ts) | +| [Snackbar Content Component](core/components/snackbar-content.component.md) | Custom content for Snackbar which allows use icon as action. | [Source](../lib/core/src/lib/snackbar-content/snackbar-content.component.ts) | +| [Sorting Picker Component](core/components/sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../lib/core/src/lib/sorting-picker/sorting-picker.component.ts) | | [Start Form component](core/components/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/process-services/src/lib/form/start-form.component.ts) | -| [Text Mask directive](core/components/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) | -| [Toolbar Divider Component](core/components/toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) | -| [Toolbar Title Component](core/components/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | -| [Toolbar Component](core/components/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) | -| [User Info component](core/components/user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) | -| [Viewer component](core/components/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) | +| [Text Mask directive](core/components/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/src/lib/form/components/widgets/text/text-mask.component.ts) | +| [Toolbar Divider Component](core/components/toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/src/lib/toolbar/toolbar-divider.component.ts) | +| [Toolbar Title Component](core/components/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/src/lib/toolbar/toolbar-title.component.ts) | +| [Toolbar Component](core/components/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/src/lib/toolbar/toolbar.component.ts) | +| [User Info component](core/components/user-info.component.md) | Shows user information. | [Source](../lib/core/src/lib/userinfo/components/user-info.component.ts) | +| [Viewer component](core/components/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/src/lib/viewer/components/viewer.component.ts) | ### Directives | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Check Allowable Operation directive](core/directives/check-allowable-operation.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../lib/core/directives/check-allowable-operation.directive.ts) | -| [Clipboard directive](core/directives/clipboard.directive.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.directive.ts) | -| [Context Menu directive](core/directives/context-menu.directive.md) ![Deprecated](docassets/images/DeprecatedIcon.png) | 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) | -| [Node Favorite directive](core/directives/node-favorite.directive.md) | Selectively toggles nodes as favorites. | [Source](../lib/core/directives/node-favorite.directive.ts) | -| [Node Restore directive](core/directives/node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/core/directives/node-restore.directive.ts) | -| [Upload Directive](core/directives/upload.directive.md) | Uploads content in response to file drag and drop. | [Source](../lib/core/directives/upload.directive.ts) | -| [Version Compatibility Directive](core/directives/version-compatibility.directive.md) | Enables/disables components based on ACS version in use. | [Source](../lib/core/directives/version-compatibility.directive.ts) | +| [Clipboard directive](core/directives/clipboard.directive.md) | Copies text to the clipboard. | [Source](../lib/core/src/lib/clipboard/clipboard.directive.ts) | +| [Context Menu directive](core/directives/context-menu.directive.md) ![Deprecated](docassets/images/DeprecatedIcon.png) | Adds a context menu to a component. | [Source](../lib/core/src/lib/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/src/lib/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/src/lib/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/src/lib/directives/logout.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/src/lib/directives/node-download.directive.ts) | +| [Upload Directive](core/directives/upload.directive.md) | Uploads content in response to file drag and drop. | [Source](../lib/core/src/lib/directives/upload.directive.ts) | ### Dialogs @@ -152,97 +148,99 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Card View Item interface](core/interfaces/card-view-item.interface.md) | Defines the implementation of an item in a Card View component. | [Source](../lib/core/card-view/interfaces/card-view-item.interface.ts) | -| [DataTableAdapter interface](core/interfaces/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | -| [FormFieldValidator interface](core/interfaces/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | -| [Search Configuration interface](core/interfaces/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/interface/search-configuration.interface.ts) | +| [Base Card View Update Interface](core/interfaces/base-card-view-update.interface.md) | Specifies required properties and methods for Card View Update service. | [Source](../lib/core/src/lib/card-view/interfaces/base-card-view-update.interface.ts) | +| [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/src/lib/card-view/interfaces/card-view-item.interface.ts) | +| [Click Notification Interface](core/interfaces/click-notification.interface.md) | | [Source](../lib/core/src/lib/card-view/interfaces/click-notification.interface.ts) | +| [DataTableAdapter interface](core/interfaces/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/src/lib/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/src/lib/form/components/widgets/core/form-field-validator.ts) | +| [Search Configuration interface](core/interfaces/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/src/lib/interface/search-configuration.interface.ts) | +| [Update Notification Interface](core/interfaces/update-notification.interface.md) | | [Source](../lib/core/src/lib/card-view/interfaces/update-notification.interface.ts) | ### Models | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Bpm User model](core/models/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/models/bpm-user.model.ts) | -| [Ecm User model](core/models/ecm-user.model.md) | Contains information about a Content Services user. | [Source](../lib/core/models/ecm-user.model.ts) | -| [Form Field model](core/models/form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | -| [Product Version model](core/models/product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) | -| [User Process model](core/models/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) | +| [Bpm User model](core/models/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/src/lib/models/bpm-user.model.ts) | +| [Ecm User model](core/models/ecm-user.model.md) | Contains information about a Content Services user. | [Source](../lib/core/src/lib/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/src/lib/form/components/widgets/core/form-field.model.ts) | +| [Product Version model](core/models/product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/src/lib/models/product-version.model.ts) | +| [User Process model](core/models/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/src/lib/models/user-process.model.ts) | ### Pipes | Name | Description | Source link | | ---- | ----------- | ----------- | -| [App Config Pipe](core/pipes/app-config.pipe.md) | Retrieves values from the application configuration file directly. | [Source](../lib/core/app-config/app-config.pipe.ts) | -| [Decimal Number Pipe](core/pipes/decimal-number.pipe.md) | Transforms a number to have a certain amount of digits in its integer part and also in its decimal part. | [Source](../lib/core/pipes/decimal-number.pipe.ts) | -| [File Size pipe](core/pipes/file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../lib/core/pipes/file-size.pipe.ts) | -| [Format Space pipe](core/pipes/format-space.pipe.md) | Replaces all the white space in a string with a supplied character. | [Source](../lib/core/pipes/format-space.pipe.ts) | -| [Full name pipe](core/pipes/full-name.pipe.md) | Joins the first and last name properties from a UserProcessModel object into a single string. | [Source](../lib/core/pipes/full-name.pipe.ts) | -| [Localized Date pipe](core/pipes/localized-date.pipe.md) | Converts a date to a given format and locale. | [Source](../lib/core/pipes/localized-date.pipe.ts) | -| [Mime Type Icon pipe](core/pipes/mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../lib/core/pipes/mime-type-icon.pipe.ts) | -| [Multi Value Pipe](core/pipes/multi-value.pipe.md) | Takes an array of strings and turns it into one string where items are separated by a separator. The default separator applied to the list is the comma , however, you can set your own separator in the params of the pipe. | [Source](../lib/core/pipes/multi-value.pipe.ts) | -| [Node Name Tooltip pipe](core/pipes/node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) | -| [Text Highlight pipe](core/pipes/text-highlight.pipe.md) | Adds highlighting to words or sections of text that match a search string. | [Source](../lib/core/pipes/text-highlight.pipe.ts) | -| [Time Ago pipe](core/pipes/time-ago.pipe.md) | Converts a recent past date into a number of days ago. | [Source](../lib/core/pipes/time-ago.pipe.ts) | -| [User Initial pipe](core/pipes/user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | +| [App Config Pipe](core/pipes/app-config.pipe.md) | Retrieves values from the application configuration file directly. | [Source](../lib/core/src/lib/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/src/lib/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/src/lib/pipes/file-size.pipe.ts) | +| [Format Space pipe](core/pipes/format-space.pipe.md) | Replaces all the white space in a string with a supplied character. | [Source](../lib/core/src/lib/pipes/format-space.pipe.ts) | +| [Full name pipe](core/pipes/full-name.pipe.md) | Joins the first and last name properties from a UserProcessModel object into a single string. | [Source](../lib/core/src/lib/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/src/lib/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/src/lib/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/src/lib/pipes/multi-value.pipe.ts) | +| [Node Name Tooltip pipe](core/pipes/node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/content-services/src/lib/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/src/lib/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/src/lib/pipes/time-ago.pipe.ts) | +| [User Initial pipe](core/pipes/user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../lib/core/src/lib/pipes/user-initial.pipe.ts) | ### Services | Name | Description | Source link | | ---- | ----------- | ----------- | -| [APS Alfresco Content Service](core/services/activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) | -| [Alfresco Api Service](core/services/alfresco-api.service.md) | Provides access to an initialized AlfrescoJSApi instance. | [Source](../lib/core/services/alfresco-api.service.ts) | -| [App Config service](core/services/app-config.service.md) | Supports app configuration settings, stored server side. | [Source](../lib/core/app-config/app-config.service.ts) | -| [Apps Process service](core/services/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) | -| [Auth Guard Bpm service](core/services/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) | -| [Auth Guard Ecm service](core/services/auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) | -| [Auth Guard SSO Role service](core/services/auth-guard-sso-role.service.md) | Checks the user roles of a user. | [Source](../lib/core/services/auth-guard-sso-role.service.ts) | -| [Auth Guard service](core/services/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) | -| [Authentication Service](core/services/authentication.service.md) | Provides authentication to ACS and APS. | [Source](../lib/core/services/authentication.service.ts) | -| [Bpm User service](core/services/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/services/bpm-user.service.ts) | -| [Card Item Type service](core/services/card-item-types.service.md) | Maps type names to field component types for the Card View component. | [Source](../lib/core/card-view/services/card-item-types.service.ts) | -| [Card View Update service](core/services/card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | [Source](../lib/core/card-view/services/card-view-update.service.ts) | -| [Clipboard service](core/services/clipboard.service.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.service.ts) | -| [Comment Content service](core/services/comment-content.service.md) | Adds and retrieves comments for nodes in Content Services. | [Source](../lib/core/services/comment-content.service.ts) | -| [Comment Process service](core/services/comment-process.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../lib/core/services/comment-process.service.ts) | -| [Content service](core/services/content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/services/content.service.ts) | -| [Cookie service](core/services/cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/services/cookie.service.ts) | -| [Deleted Nodes Api service](core/services/deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/services/deleted-nodes-api.service.ts) | -| [Discovery Api service](core/services/discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/services/discovery-api.service.ts) | -| [Download zip service](core/services/download-zip.service.md) | Creates and manages downloads. | [Source](../lib/core/services/download-zip.service.ts) | -| [Ecm User service](core/services/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/ecm-user.service.ts) | -| [Favorites Api service](core/services/favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/services/favorites-api.service.ts) | +| [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/process-services/src/lib/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/src/lib/services/alfresco-api.service.ts) | +| [App Config service](core/services/app-config.service.md) | Supports app configuration settings, stored server side. | [Source](../lib/core/src/lib/app-config/app-config.service.ts) | +| [Apps Process service](core/services/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/src/lib/services/apps-process.service.ts) | +| [Auth Guard Bpm service](core/services/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/src/lib/services/auth-guard-bpm.service.ts) | +| [Auth Guard Ecm service](core/services/auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/src/lib/services/auth-guard-ecm.service.ts) | +| [Auth Guard SSO Role service](core/services/auth-guard-sso-role.service.md) | Checks the user roles of a user. | [Source](../lib/core/src/lib/services/auth-guard-sso-role.service.ts) | +| [Auth Guard service](core/services/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/src/lib/services/auth-guard.service.ts) | +| [Authentication Service](core/services/authentication.service.md) | Provides authentication to ACS and APS. | [Source](../lib/core/src/lib/services/authentication.service.ts) | +| [Bpm User service](core/services/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/src/lib/services/bpm-user.service.ts) | +| [Card Item Type service](core/services/card-item-types.service.md) | Maps type names to field component types for the Card View component. | [Source](../lib/core/src/lib/card-view/services/card-item-types.service.ts) | +| [Card View Update service](core/services/card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | | +| Implements BaseCardViewUpdate. | [Source](../lib/core/src/lib/card-view/services/card-view-update.service.ts) | | +| [Clipboard service](core/services/clipboard.service.md) | Copies text to the clipboard. | [Source](../lib/core/src/lib/clipboard/clipboard.service.ts) | +| [Comment Content service](core/services/comment-content.service.md) | Adds and retrieves comments for nodes in Content Services. | [Source](../lib/core/src/lib/services/comment-content.service.ts) | +| [Comment Process service](core/services/comment-process.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../lib/core/src/lib/services/comment-process.service.ts) | +| [Content service](core/services/content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/src/lib/services/content.service.ts) | +| [Cookie service](core/services/cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/src/lib/services/cookie.service.ts) | +| [Deleted Nodes Api service](core/services/deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/src/lib/services/deleted-nodes-api.service.ts) | +| [Discovery Api service](core/services/discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/src/lib/services/discovery-api.service.ts) | +| [Download zip service](core/services/download-zip.service.md) | Creates and manages downloads. | [Source](../lib/core/src/lib/services/download-zip.service.ts) | +| [Ecm User service](core/services/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/src/lib/services/ecm-user.service.ts) | +| [Favorites Api service](core/services/favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/src/lib/services/favorites-api.service.ts) | | [Form Rendering service](core/services/form-rendering.service.md) | Maps a form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | -| [Form service](core/services/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | -| [Highlight Transform service](core/services/highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/services/highlight-transform.service.ts) | -| [Identity Group service](core/services/identity-group.service.md) | Performs CRUD operations on identity groups. | [Source](../lib/core/services/identity-group.service.ts) | -| [Identity role service](core/services/identity-role.service.md) | Provides APIs for working with the Roles in Identity Services. | [Source](../lib/core/services/identity-role.service.ts) | -| [Identity user service](core/services/identity-user.service.md) | Gets OAuth2 personal details and roles for users and performs CRUD operations on identity users. | [Source](../lib/core/services/identity-user.service.ts) | -| [JWT helper service](core/services/jwt-helper.service.md) | Decodes a JSON Web Token (JWT) to a JavaScript object. | [Source](../lib/core/services/jwt-helper.service.ts) | -| [Log Service](core/services/log.service.md) | Provides log functionality. | [Source](../lib/core/services/log.service.ts) | -| [Login Dialog service](core/services/login-dialog.service.md) | Manages login dialogs. | [Source](../lib/core/services/login-dialog.service.ts) | -| [Node Service](core/services/node.service.md) | use Nodes Api service instead of this. | [Source](../lib/core/form/services/node.service.ts) | -| [Nodes Api service](core/services/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) | -| [Notification Service](core/services/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/notifications/services/notification.service.ts) | -| [Page Title service](core/services/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | -| [People Content service](core/services/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | -| [People Process service](core/services/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) | -| [Process Content Service](core/services/process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../lib/core/form/services/process-content.service.ts) | -| [Renditions service](core/services/renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) | -| [Search Configuration service](core/services/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | -| [Search service](core/services/search.service.md) | Accesses the Content Services Search API. | [Source](../lib/core/services/search.service.ts) | -| [Shared Links Api service](core/services/shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../lib/core/services/shared-links-api.service.ts) | -| [Sites service](core/services/sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../lib/core/services/sites.service.ts) | -| [Storage service](core/services/storage.service.md) | Stores items in the form of key-value pairs. | [Source](../lib/core/services/storage.service.ts) | -| [Thumbnail service](core/services/thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../lib/core/services/thumbnail.service.ts) | -| [Translation service](core/services/translation.service.md) | Supports localisation. | [Source](../lib/core/services/translation.service.ts) | -| [Upload Service](core/services/upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/services/upload.service.ts) | -| [User access service](core/services/user-access.service.md) | Checks the global and application access of a user | [Source](../lib/core/services/user-access.service.ts) | -| [User Preferences Service](core/services/user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../lib/core/services/user-preferences.service.ts) | +| [Form service](core/services/form.service.md) | Implements Process Services form methods | [Source](../lib/core/src/lib/form/services/form.service.ts) | +| [Highlight Transform service](core/services/highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/src/lib/services/highlight-transform.service.ts) | +| [Identity Group service](core/services/identity-group.service.md) | Performs CRUD operations on identity groups. | [Source](../lib/core/src/lib/services/identity-group.service.ts) | +| [Identity role service](core/services/identity-role.service.md) | Provides APIs for working with the Roles in Identity Services. | [Source](../lib/core/src/lib/services/identity-role.service.ts) | +| [Identity user service](core/services/identity-user.service.md) | Gets OAuth2 personal details and roles for users and performs CRUD operations on identity users. | [Source](../lib/core/src/lib/services/identity-user.service.ts) | +| [JWT helper service](core/services/jwt-helper.service.md) | Decodes a JSON Web Token (JWT) to a JavaScript object. | [Source](../lib/core/src/lib/services/jwt-helper.service.ts) | +| [Log Service](core/services/log.service.md) | Provides log functionality. | [Source](../lib/core/src/lib/services/log.service.ts) | +| [Login Dialog service](core/services/login-dialog.service.md) | Manages login dialogs. | [Source](../lib/core/src/lib/services/login-dialog.service.ts) | +| [Nodes Api service](core/services/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/src/lib/services/nodes-api.service.ts) | +| [Notification Service](core/services/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/src/lib/notifications/services/notification.service.ts) | +| [Page Title service](core/services/page-title.service.md) | Sets the page title. | [Source](../lib/core/src/lib/services/page-title.service.ts) | +| [People Content service](core/services/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/src/lib/services/people-content.service.ts) | +| [People Process service](core/services/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/src/lib/services/people-process.service.ts) | +| [Process Content Service](core/services/process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../lib/process-services/src/lib/form/services/process-content.service.ts) | +| [Renditions service](core/services/renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/src/lib/services/renditions.service.ts) | +| [Search Configuration service](core/services/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/src/lib/services/search-configuration.service.ts) | +| [Search service](core/services/search.service.md) | Accesses the Content Services Search API. | [Source](../lib/core/src/lib/services/search.service.ts) | +| [Shared Links Api service](core/services/shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../lib/core/src/lib/services/shared-links-api.service.ts) | +| [Storage service](core/services/storage.service.md) | Stores items in the form of key-value pairs. | [Source](../lib/core/src/lib/services/storage.service.ts) | +| [Thumbnail service](core/services/thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../lib/core/src/lib/services/thumbnail.service.ts) | +| [Translation service](core/services/translation.service.md) | Supports localisation. | [Source](../lib/core/src/lib/services/translation.service.ts) | +| [Upload Service](core/services/upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/src/lib/services/upload.service.ts) | +| [User access service](core/services/user-access.service.md) | Checks the global and application access of a user | [Source](../lib/core/src/lib/services/user-access.service.ts) | +| [User Preferences Service](core/services/user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../lib/core/src/lib/services/user-preferences.service.ts) | ### 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) | +| [APS Content Component](core/widgets/content.widget.md) | Shows the content preview. | [Source](../lib/process-services/src/lib/form/widgets/document/content.widget.ts) | @@ -277,6 +275,7 @@ for more information about installing and using the source code. | [Dropdown Breadcrumb Component](content-services/components/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts) | | [File Uploading Dialog Component](content-services/components/file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/src/lib/upload/components/file-uploading-dialog.component.ts) | | [Like component](content-services/components/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/src/lib/social/like.component.ts) | +| [Node Comments Component](content-services/components/node-comments.component.md) | Displays comments from users involved in a specified content and allows an involved user to add a comment to a content. | [Source](../lib/content-services/src/lib/node-comments/node-comments.component.ts) | | [Permission List Component](content-services/components/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/src/lib/permission-manager/components/permission-list/permission-list.component.ts) | | [Rating component](content-services/components/rating.component.md) | Allows a user to add and remove rating to an item. | [Source](../lib/content-services/src/lib/social/rating.component.ts) | | [Search check list component](content-services/components/search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-check-list/search-check-list.component.ts) | @@ -311,14 +310,20 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | +| [Auto Focus directive](content-services/directives/auto-focus.directive.md) | Automatically focuses HTML element after content is initialized. | [Source](../lib/content-services/src/lib/directives/auto-focus.directive.ts) | +| [Check Allowable Operation directive](content-services/directives/check-allowable-operation.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../lib/content-services/src/lib/directives/check-allowable-operation.directive.ts) | | [Node Public File Share Directive](content-services/directives/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/src/lib/content-node-share/content-node-share.directive.ts) | | [File Draggable directive](content-services/directives/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a div. | [Source](../lib/content-services/src/lib/upload/directives/file-draggable.directive.ts) | | [Folder Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/src/lib/folder-directive/folder-create.directive.ts) | | [Folder Edit directive](content-services/directives/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/src/lib/folder-directive/folder-edit.directive.ts) | | [Inherit Permission directive](content-services/directives/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/inherited-button.directive.ts) | | [Node Counter directive](content-services/directives/node-counter.directive.md) | Appends a counter to an element. | [Source](../lib/content-services/src/lib/directives/node-counter.directive.ts) | +| [Node Delete directive](content-services/directives/node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/content-services/src/lib/directives/node-delete.directive.ts) | +| [Node Favorite directive](content-services/directives/node-favorite.directive.md) | Selectively toggles nodes as favorites. | [Source](../lib/content-services/src/lib/directives/node-favorite.directive.ts) | | [Node Lock directive](content-services/directives/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/src/lib/directives/node-lock.directive.ts) | +| [Node Restore directive](content-services/directives/node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/content-services/src/lib/directives/node-restore.directive.ts) | | [Toggle Icon directive](content-services/directives/toggle-icon.directive.md) | Toggle icon on mouse or keyboard event for a selectable element. | [Source](../lib/content-services/src/lib/upload/directives/toggle-icon.directive.ts) | +| [Version Compatibility Directive](content-services/directives/version-compatibility.directive.md) | Enables/disables components based on ACS version in use. | [Source](../lib/content-services/src/lib/version-compatibility/version-compatibility.directive.ts) | ### Dialogs @@ -331,6 +336,8 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | +| [Base Card View Content Update interface](content-services/interfaces/base-card-view-content-update.interface.md) | Specifies required properties and methods for Card View Content Update service. | | +| Extends from BaseCardViewUpdate. | [Source](../lib/content-services/src/lib/interfaces/base-card-view-content-update.interface.ts) | | | [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/models/search-widget.interface.ts) | ### Models @@ -352,18 +359,23 @@ for more information about installing and using the source code. | 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) | +| [Card View Content Update Service](content-services/services/card-view-content-update.service.md) | Manages Card View properties in the content services environment. | | +| Implements BaseCardViewContentUpdate. | [Source](../lib/content-services/src/lib/services/card-view-content-update.service.ts) | | | [Content Node Dialog service](content-services/services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts) | | [Custom Resources service](content-services/services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/src/lib/document-list/services/custom-resources.service.ts) | | [Document Actions service](content-services/services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-actions.service.ts) | | [Document List service](content-services/services/document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-list.service.ts) | | [Folder Actions service](content-services/services/folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/folder-actions.service.ts) | | [New Version Uploader service](content-services/services/new-version-uploader.dialog.service.md) | Display a dialog that allows to upload new file version or to manage the current node versions. | [Source](../lib/content-services/src/lib/new-version-uploader/new-version-uploader.service.ts) | +| [Node Comments Service](content-services/services/node-comments.service.md) | Adds and retrieves comments for nodes in Content Services. | [Source](../lib/content-services/src/lib/node-comments/services/node-comments.service.ts) | | [Node permission dialog service](content-services/services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts) | | [Node Permission service](content-services/services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission.service.ts) | | [Rating service](content-services/services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/src/lib/social/services/rating.service.ts) | | [Search filter service](content-services/services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/src/lib/search/services/search-filter.service.ts) | | [Search Query Builder service](content-services/services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/src/lib/search/services/search-query-builder.service.ts) | +| [Sites service](content-services/services/sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](<>) | | [Tag service](content-services/services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/src/lib/tag/services/tag.service.ts) | +| [Task Comments service](content-services/services/task-comments.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../lib/process-services/src/lib/task-comments/services/task-comments.service.ts) | @@ -403,6 +415,7 @@ for more information about installing and using the source code. | [Start Process component](process-services/components/start-process.component.md) | Starts a process. | [Source](../lib/process-services/src/lib/process-list/components/start-process.component.ts) | | [Start Task Component](process-services/components/start-task.component.md) | Creates/Starts a new task for the specified app. | [Source](../lib/process-services/src/lib/task-list/components/start-task.component.ts) | | [Task Attachment List Component](process-services/components/task-attachment-list.component.md) | Displays documents attached to a specified task. | [Source](../lib/process-services/src/lib/attachment/task-attachment-list.component.ts) | +| [Task Comments Component](process-services/components/task-comments.component.md) | Displays comments from users involved in a specified task and allows an involved user to add a comment to a task. | [Source](../lib/process-services/src/lib/task-comments/task-comments.component.ts) | | [Task Details component](process-services/components/task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../lib/process-services/src/lib/task-list/components/task-details.component.ts) | | [Task Filters component](process-services/components/task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/src/lib/task-list/components/task-filters.component.ts) | | [Task Form component](process-services/components/task-form.component.md) | Shows a form for a task. | [Source](../lib/process-services/src/lib/task-list/components/task-form/task-form.component.ts) | diff --git a/docs/breaking-changes/breaking-change-2.6.0-3.0.0.md b/docs/breaking-changes/breaking-change-2.6.0-3.0.0.md index 2e5faa0510..0a6538c370 100644 --- a/docs/breaking-changes/breaking-change-2.6.0-3.0.0.md +++ b/docs/breaking-changes/breaking-change-2.6.0-3.0.0.md @@ -25,7 +25,7 @@ This document lists all the deprecated ADF v2.x components that were removed for classes without the **adf-** prefix, you will now need to update them. For example, `.card-view` is now `.adf-card-view`. -- [PR ADF-1443](https://github.com/Alfresco/alfresco-ng2-components/pull/4028): [`DownloadZipDialogComponent`](lib/core/src/lib/dialogs/download-zip/download-zip.dialog.ts) +- [PR ADF-1443](https://github.com/Alfresco/alfresco-ng2-components/pull/4028): [`DownloadZipDialogComponent`](../../lib/core/src/lib/dialogs/download-zip/download-zip.dialog.ts) and [`NodeDownloadDirective`](../core/directives/node-download.directive.md) have been moved from the Content Services module to the Core module. This modification has enabled us to remove some code duplication between the two modules. @@ -48,10 +48,10 @@ This document lists all the deprecated ADF v2.x components that were removed for (you can now have two sidebars on the left and right at the same time). - `analytics-report-list` is now `adf-analytics-report-list`. - `analytics-report-parameters` is now `adf-analytics-report-parameters`. - - `CommentProcessModel` was moved into the Core library with the name [`CommentModel`](lib/core/src/lib/models/comment.model.ts) in v2.3.0. Now you - can only import it from [`CoreModule`](lib/core/src/lib/core.module.ts). - - [`CommentsModule`](lib/core/src/lib/comments/comments.module.ts), [`CommentListComponent`](../core/components/comment-list.component.md), and [`CommentsComponent`](../core/components/comments.component.md) are no longer exported from - [`ProcessModule`](../../lib/process-services/src/lib/process.module.ts) but now from [`CoreModule`](lib/core/src/lib/core.module.ts). The old usage was deprecated in v2.3.0. + - `CommentProcessModel` was moved into the Core library with the name [`CommentModel`](../../lib/core/src/lib/models/comment.model.ts) in v2.3.0. Now you + can only import it from [`CoreModule`](../../lib/core/src/lib/core.module.ts). + - [`CommentsModule`](../../lib/core/src/lib/comments/comments.module.ts), [`CommentListComponent`](../core/components/comment-list.component.md), and [`CommentsComponent`](../core/components/comments.component.md) are no longer exported from + [`ProcessModule`](../../lib/process-services/src/lib/process.module.ts) but now from [`CoreModule`](../../lib/core/src/lib/core.module.ts). The old usage was deprecated in v2.3.0. - ``: The `parentId` input has been renamed as `rootFolderId`. The old name was deprecated in v2.4.0. - The `createFolder` event of the [`UploadBase`](../../lib/content-services/src/lib/upload/components/base-upload/upload-base.ts) class (emitted when a folder was diff --git a/docs/content-services/components/document-list.component.md b/docs/content-services/components/document-list.component.md index f050dd468b..c634c97481 100644 --- a/docs/content-services/components/document-list.component.md +++ b/docs/content-services/components/document-list.component.md @@ -57,7 +57,7 @@ Displays the documents from a repository. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| additionalSorting | [`DataSorting`](lib/core/src/lib/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. | +| additionalSorting | [`DataSorting`](../../../lib/core/src/lib/datatable/data/data-sorting.model.ts) | | Defines default sorting. The format is an array of strings `[key direction, otherKey otherDirection]` i.e. `['name desc', 'nodeType asc']` or `['name asc']`. Set this value if you want a base rule to be added to the sorting apart from the one driven by the header. | | allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list or into another file to trigger updating it's version. When false, the dropped file will be added to the current folder (ie, the one containing all the items shown in the list). See the [Upload directive](../../core/directives/upload.directive.md) for further details about how the file drop is handled. | | contentActions | `boolean` | false | Toggles content actions for each row | | contentActionsPosition | `string` | "right" | Position of the content actions dropdown menu. Can be set to "left" or "right". | @@ -82,7 +82,7 @@ Displays the documents from a repository. | 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 | `ShowHeaderMode` | | 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. | +| sorting | `string[] \| `[`DataSorting`](../../../lib/core/src/lib/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 | diff --git a/docs/content-services/components/upload-button.component.md b/docs/content-services/components/upload-button.component.md index a2bd94a061..0f36dcec0e 100644 --- a/docs/content-services/components/upload-button.component.md +++ b/docs/content-services/components/upload-button.component.md @@ -48,7 +48,7 @@ Activates a file upload. | 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)`<`[`FileUploadErrorEvent`](../../../lib/core/events/file.event.ts)`>` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadErrorEvent`](../../../lib/core/src/lib/events/file.event.ts)`>` | Emitted when an error occurs. | | permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | | updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | diff --git a/docs/content-services/components/upload-drag-area.component.md b/docs/content-services/components/upload-drag-area.component.md index 202f62728c..f5c9da9f2f 100644 --- a/docs/content-services/components/upload-drag-area.component.md +++ b/docs/content-services/components/upload-drag-area.component.md @@ -75,7 +75,7 @@ as the drag/drop target: | 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)`<`[`FileUploadErrorEvent`](../../../lib/core/events/file.event.ts)`>` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadErrorEvent`](../../../lib/core/src/lib/events/file.event.ts)`>` | Emitted when an error occurs. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | | updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | @@ -87,7 +87,7 @@ 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/src/lib/utils/file-utils.ts) objects that are prepared for the upload +- **files**: accesses the [`FileInfo`](../../../lib/core/src/lib/common/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 diff --git a/docs/content-services/components/upload-version-button.component.md b/docs/content-services/components/upload-version-button.component.md index 8b33bcd5bb..bfebe46325 100644 --- a/docs/content-services/components/upload-version-button.component.md +++ b/docs/content-services/components/upload-version-button.component.md @@ -51,7 +51,7 @@ to enrich the features and decrease the restrictions currently applied to node v | 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)`<`[`FileUploadErrorEvent`](../../../lib/core/events/file.event.ts)`>` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadErrorEvent`](../../../lib/core/src/lib/events/file.event.ts)`>` | Emitted when an error occurs. | | permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | | updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`>` | Emitted when dropping a file over another file to update the version. | diff --git a/docs/content-services/components/version-manager.component.md b/docs/content-services/components/version-manager.component.md index 6cb0fb2c3c..a7ccf1af50 100644 --- a/docs/content-services/components/version-manager.component.md +++ b/docs/content-services/components/version-manager.component.md @@ -40,7 +40,7 @@ Displays the version history of a node with the ability to upload a new version. | Name | Type | Description | | ---- | ---- | ----------- | | uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an cancelling during upload. | -| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadErrorEvent`](../../../lib/core/events/file.event.ts)`>` | Emitted when an error occurs during upload. | +| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadErrorEvent`](../../../lib/core/src/lib/events/file.event.ts)`>` | Emitted when an error occurs during upload. | | uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file is uploaded successfully. | | viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when viewing a version. | diff --git a/docs/content-services/components/version-upload.component.md b/docs/content-services/components/version-upload.component.md index af9bbac023..a6ad98352f 100644 --- a/docs/content-services/components/version-upload.component.md +++ b/docs/content-services/components/version-upload.component.md @@ -33,9 +33,9 @@ Displays the new version's minor/major changes and the optional comment of a nod | ---- | ---- | ----------- | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an cancelling during upload. | | commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the comment is changed. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadErrorEvent`](../../../lib/core/events/file.event.ts)`>` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadErrorEvent`](../../../lib/core/src/lib/events/file.event.ts)`>` | Emitted when an error occurs. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | -| uploadStarted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadEvent`](../../../lib/core/events/file.event.ts)`>` | Emitted when the upload starts | +| uploadStarted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts)`>` | Emitted when the upload starts | | versionChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the version is changed. | ## Details diff --git a/docs/content-services/directives/auto-focus.directive.md b/docs/content-services/directives/auto-focus.directive.md index 88a5999152..f1c6442111 100644 --- a/docs/content-services/directives/auto-focus.directive.md +++ b/docs/content-services/directives/auto-focus.directive.md @@ -16,5 +16,3 @@ Automatically focuses HTML element after content is initialized. ``` ## Class members - -### Properties diff --git a/docs/content-services/directives/version-compatibility.directive.md b/docs/content-services/directives/version-compatibility.directive.md index 64b0be377c..c3473f0f91 100644 --- a/docs/content-services/directives/version-compatibility.directive.md +++ b/docs/content-services/directives/version-compatibility.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2022-07-12 --- -# [Version Compatibility Directive](lib/content-services/src/lib/version-compatibility/version-compatibility.directive.ts "Defined in version-compatibility.directive.ts") +# [Version Compatibility Directive](../../../lib/content-services/src/lib/version-compatibility/version-compatibility.directive.ts "Defined in version-compatibility.directive.ts") Enables/disables components based on ACS version in use. diff --git a/docs/content-services/interfaces/base-card-view-content-update.interface.md b/docs/content-services/interfaces/base-card-view-content-update.interface.md index 92cb12ad65..243589eb05 100644 --- a/docs/content-services/interfaces/base-card-view-content-update.interface.md +++ b/docs/content-services/interfaces/base-card-view-content-update.interface.md @@ -28,7 +28,7 @@ export interface BaseCardViewContentUpdate { | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | itemUpdated$ | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`UpdateNotification`](../../../lib/core/src/lib/card-view/interfaces/update-notification.interface.ts)`>` | | The current updated item. | -| updatedAspect$ | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`(@alfresco/js-api) | | [Subject](http://reactivex.io/documentation/subject.html) holding the current node | +| updatedAspect$ | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`(@alfresco/js-api) | | [`Subject`](http://reactivex.io/documentation/subject.html) holding the current node | ### Methods @@ -40,6 +40,7 @@ export interface BaseCardViewContentUpdate { - **updateElement**(notification: [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts))
Update updateItem$ observable. + - notification:\_ [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) - The notification. - **updateNodeAspect**(node: [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md))
diff --git a/docs/content-services/models/image-resolver.model.md b/docs/content-services/models/image-resolver.model.md index 55258f8d57..53b0f3309c 100644 --- a/docs/content-services/models/image-resolver.model.md +++ b/docs/content-services/models/image-resolver.model.md @@ -11,9 +11,9 @@ Defines the Image Resolver function used by the [Document List Component](../com ## Definitions -- `type` **[`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts)** = (row: [`DataRow`](lib/core/src/lib/datatable/data/data-row.model.ts), column: [`DataColumn`](lib/core/src/lib/datatable/data/data-column.model.ts)) => `string` - - _row:_ [`DataRow`](lib/core/src/lib/datatable/data/data-row.model.ts) - Data that defines the row - - _column:_ [`DataColumn`](lib/core/src/lib/datatable/data/data-column.model.ts) - Data that defines the column +- `type` **[`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts)** = (row: [`DataRow`](../../../lib/core/src/lib/datatable/data/data-row.model.ts), column: [`DataColumn`](../../../lib/core/src/lib/datatable/data/data-column.model.ts)) => `string` + - _row:_ [`DataRow`](../../../lib/core/src/lib/datatable/data/data-row.model.ts) - Data that defines the row + - _column:_ [`DataColumn`](../../../lib/core/src/lib/datatable/data/data-column.model.ts) - Data that defines the column - **Returns** File path for the image ## Details @@ -26,7 +26,7 @@ to manage the way folder/file icons and thumbnails are resolved (ie, which image **Note:** Image resolvers are executed only for columns of the `image` type. -A typical image resolver implementation receives [`DataRow`](lib/core/src/lib/datatable/data/data-row.model.ts) and [`DataColumn`](lib/core/src/lib/datatable/data/data-column.model.ts) objects as parameters: +A typical image resolver implementation receives [`DataRow`](../../../lib/core/src/lib/datatable/data/data-row.model.ts) and [`DataColumn`](../../../lib/core/src/lib/datatable/data/data-column.model.ts) objects as parameters: ```ts myImageResolver(row: DataRow, col: DataColumn): string { diff --git a/docs/content-services/services/audit.service.md b/docs/content-services/services/audit.service.md index dfa9a0610b..e6f3a26683 100644 --- a/docs/content-services/services/audit.service.md +++ b/docs/content-services/services/audit.service.md @@ -26,31 +26,31 @@ Manages Audit apps and entries. - **getAuditApp**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Get audit application info. - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional) Options. + - _opts:_ `any` - (Optional)Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **getAuditApps**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
List audit applications. - - _opts:_ `any` - (Optional) Options. + - _opts:_ `any` - (Optional)Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **getAuditEntries**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
List audit entries for an audit application. - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional) Options. + - _opts:_ `any` - (Optional)Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **getAuditEntriesForNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
List audit entries for a node. - _nodeId:_ `string` - The identifier of a node. - - _opts:_ `any` - (Optional) Options. + - _opts:_ `any` - (Optional)Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **getAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Get audit entry. - _auditApplicationId:_ `string` - The identifier of an audit application. - _auditEntryId:_ `string` - The identifier of an audit entry. - - _opts:_ `any` - (Optional) Options. + - _opts:_ `any` - (Optional)Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **updateAuditApp**(auditApplicationId: `string`, auditAppBodyUpdate: `boolean`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Update audit application info. - _auditApplicationId:_ `string` - The identifier of an audit application. - _auditAppBodyUpdate:_ `boolean` - The audit application to update. - - _opts:_ `any` - (Optional) Options. + - _opts:_ `any` - (Optional)Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - diff --git a/docs/content-services/services/card-view-content-update.service.md b/docs/content-services/services/card-view-content-update.service.md index 6fdd97574b..b01aa82442 100644 --- a/docs/content-services/services/card-view-content-update.service.md +++ b/docs/content-services/services/card-view-content-update.service.md @@ -16,16 +16,15 @@ Implements [`BaseCardViewContentUpdate`](../../../lib/content-services/src/lib/i - **update**(property: [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts), newValue: `any`)
- - _property:_ [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) - - _newValue:_ `any` + - _property:_ [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) - + - _newValue:_ `any` - - **updateElement**(notification: [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts))
Updates the cardview items property - - _notification:_ [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) - + - _notification:_ [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) - - **updateNodeAspect**(node: [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md))
Update node aspect observable. - - _node:_ [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) + - _node:_ [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) - ## Properties diff --git a/docs/content-services/services/custom-resources.service.md b/docs/content-services/services/custom-resources.service.md index 1900a1f56a..b50894cac2 100644 --- a/docs/content-services/services/custom-resources.service.md +++ b/docs/content-services/services/custom-resources.service.md @@ -13,20 +13,20 @@ Manages Document List information that is specific to a user. ### Methods -- **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the contents of one of the well-known aliases in the form of node ID strings. - _nodeId:_ `string` - ID of the target folder node - - _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of node IDs - **getIdFromEntry**(node: `any`, nodeId: `string`): `string`
Chooses the correct ID for a node entry. - _node:_ `any` - Node object - _nodeId:_ `string` - ID of the node object - **Returns** `string` - ID value -- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](lib/core/src/lib/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)`>`
+- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets files recently accessed by a user. - _personId:_ `string` - ID of the user - - _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../../lib/core/src/lib/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`
@@ -41,38 +41,38 @@ Manages Document List information that is specific to a user. 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/src/lib/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)`>`
+- **loadFavorites**(pagination: [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets favorite files for the current user. - - _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../../lib/core/src/lib/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/src/lib/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): `any`
+- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): `any`
Gets a folder's contents. - _nodeId:_ `string` - ID of the target folder node - - _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../../lib/core/src/lib/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/src/lib/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)`>`
+- **loadMemberSites**(pagination: [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`
Gets sites that the current user is a member of. - - _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../../lib/core/src/lib/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/src/lib/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)`>`
+- **loadSharedLinks**(pagination: [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>`
Gets shared links for the current user. - - _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../../lib/core/src/lib/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/src/lib/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)`>`
+- **loadSites**(pagination: [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets all sites in the repository. - - _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../../lib/core/src/lib/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/src/lib/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)`>`
+- **loadTrashcan**(pagination: [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`
Gets all items currently in the trash. - - _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../../lib/core/src/lib/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 diff --git a/docs/content-services/services/document-list.service.md b/docs/content-services/services/document-list.service.md index e6c039f718..27b7d12fb6 100644 --- a/docs/content-services/services/document-list.service.md +++ b/docs/content-services/services/document-list.service.md @@ -43,10 +43,10 @@ Implements node operations used by the [Document List component](../components/d - _nodeId:_ `any` - - **Returns** `boolean` - -- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](lib/core/src/lib/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)`>`
+- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts), includeFields: `string[]`, where?: `string`, orderBy?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`
Load a folder by Node Id. - _nodeId:_ `string` - ID of the folder node - - _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - + - _pagination:_ [`PaginationModel`](../../../lib/core/src/lib/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 diff --git a/docs/content-services/services/node-comments.service.md b/docs/content-services/services/node-comments.service.md index 84eb734bd1..839cf57531 100644 --- a/docs/content-services/services/node-comments.service.md +++ b/docs/content-services/services/node-comments.service.md @@ -13,16 +13,16 @@ Adds and retrieves comments for nodes in Content Services. ### Methods -- **add**(id: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>`
+- **add**(id: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>`
Adds a comment to a task. - - _id:_ `string` - ID of the target task - - _message:_ `string` - Text for the comment - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>` - Details about the comment -- **get**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>`
+ - _id:_ `string` - ID of the target task + - _message:_ `string` - Text for the comment + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>` - Details about the comment +- **get**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>`
Gets all comments that have been added to a task. - - _id:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>` - Details for each comment + - _id:_ `string` - ID of the target task + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>` - Details for each comment ## See also -- [Node comments component](../../../lib/content-services/src/lib/node-comments/node-comments.component.ts) +- [Node comments component](../../../lib/content-services/src/lib/node-comments/node-comments.component.ts) diff --git a/docs/content-services/services/sites.service.md b/docs/content-services/services/sites.service.md index d8d74e8fe0..c309e4743f 100644 --- a/docs/content-services/services/sites.service.md +++ b/docs/content-services/services/sites.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# Sites service +# [Sites service](../../../lib/content-services/src/lib/services/sites.service.ts "Defined in sites.service.ts") Accesses and manipulates sites from a Content Services repository. diff --git a/docs/content-services/services/task-comments.service.md b/docs/content-services/services/task-comments.service.md index 8b99c024a3..3eef9afd58 100644 --- a/docs/content-services/services/task-comments.service.md +++ b/docs/content-services/services/task-comments.service.md @@ -13,16 +13,16 @@ Adds and retrieves comments for task and process instances in Process Services. ### Methods -- **get**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
+- **add**(id: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>`
+ Adds a comment to a task. + - _id:_ `string` - ID of the target task + - _message:_ `string` - Text for the comment + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>` - Details about the comment +- **get**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>`
Gets all comments that have been added to a task. - - _id:_ `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 -- **add**(id: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
- Adds a comment to a process instance. - - _id:_ `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 of the comment added + - _id:_ `string` - ID of the target task + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>` - Details for each comment ## See also -- [Task comments component](../../../lib/process-services/src/lib/task-comments/task-comments.component.ts) +- [Task comments component](../../../lib/process-services/src/lib/task-comments/task-comments.component.ts) diff --git a/docs/core/components/about-github-link.component.md b/docs/core/components/about-github-link.component.md index 7faee7750b..e02d47b8de 100644 --- a/docs/core/components/about-github-link.component.md +++ b/docs/core/components/about-github-link.component.md @@ -5,7 +5,7 @@ Status: Experimental Last reviewed: 2019-09-09 --- -# [About GitHub Link Component](lib/core/src/lib/about/about-github-link/about-github-link.component.ts "Defined in about-github-link.component.ts") +# [About GitHub Link Component](../../../lib/core/src/lib/about/about-github-link/about-github-link.component.ts "Defined in about-github-link.component.ts") Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application. @@ -24,7 +24,6 @@ With custom input values: [url]=yourUrl" [version]="yourVersion"> - ``` ### Properties diff --git a/docs/core/components/about.component.md b/docs/core/components/about.component.md index 1d88d67ace..b14bb44a8c 100644 --- a/docs/core/components/about.component.md +++ b/docs/core/components/about.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2022-11-11 --- -# About Component +# [About Component](../../../lib/core/src/lib/about/about.component.ts "Defined in about.component.ts") Presentational component to display About information as a set of collapsible panels. diff --git a/docs/core/components/buttons-menu.component.md b/docs/core/components/buttons-menu.component.md index a26eda99d4..b8c881bd12 100644 --- a/docs/core/components/buttons-menu.component.md +++ b/docs/core/components/buttons-menu.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Buttons Menu Component](lib/core/src/lib/buttons-menu/buttons-menu.component.ts "Defined in buttons-menu.component.ts") +# [Buttons Menu Component](../../../lib/core/src/lib/buttons-menu/buttons-menu.component.ts "Defined in buttons-menu.component.ts") Displays buttons on a responsive menu. diff --git a/docs/core/components/card-view.component.md b/docs/core/components/card-view.component.md index 7c7365b2c9..12947eaaf9 100644 --- a/docs/core/components/card-view.component.md +++ b/docs/core/components/card-view.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-05-09 --- -# [Card View component](lib/core/src/lib/card-view/components/card-view/card-view.component.ts "Defined in card-view.component.ts") +# [Card View component](../../../lib/core/src/lib/card-view/components/card-view/card-view.component.ts "Defined in card-view.component.ts") Displays a configurable property list renderer. @@ -114,7 +114,7 @@ Defining properties from Typescript: | displayNoneOption | `boolean` | true | Toggles whether or not to display none option. | | editable | `boolean` | | Toggles whether or not the items can be edited. | | multiValueSeparator | `string` | DEFAULT_SEPARATOR | String separator between multi-value property items. | -| properties | [`CardViewItem`](lib/core/src/lib/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. | +| properties | [`CardViewItem`](../../../lib/core/src/lib/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. | | useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. | ## Details @@ -171,12 +171,12 @@ clicked item. The `properties` array contains instances of models that represent the layout of the Card View. The ordering of the models in the array matches the ordering of items in the view. Each of the -models extends the abstract [`CardViewBaseItemModel`](lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) class to add functionality for +models extends the abstract [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) class to add functionality for specific data types, as described below. #### Card Text Item -[`CardViewTextItemModel`](lib/core/src/lib/card-view/models/card-view-textitem.model.ts) is a property type for text properties. +[`CardViewTextItemModel`](../../../lib/core/src/lib/card-view/models/card-view-textitem.model.ts) is a property type for text properties. ```ts const textItemProperty = new CardViewTextItemModel(options); @@ -197,7 +197,7 @@ const textItemProperty = new CardViewTextItemModel(options); | 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/src/lib/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display | +| pipes | [`CardViewTextItemPipeProperty`](../../../lib/core/src/lib/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 @@ -221,7 +221,7 @@ new CardViewTextItemModel({ #### Card Map Item -[`CardViewMapItemModel`](lib/core/src/lib/card-view/models/card-view-mapitem.model.ts) is a property type for map properties. +[`CardViewMapItemModel`](../../../lib/core/src/lib/card-view/models/card-view-mapitem.model.ts) is a property type for map properties. ```ts const mapItemProperty = new CardViewMapItemModel(options); @@ -238,7 +238,7 @@ const mapItemProperty = new CardViewMapItemModel(options); #### Card Date Item -[`CardViewDateItemModel`](lib/core/src/lib/card-view/models/card-view-dateitem.model.ts) is a property type for date properties. +[`CardViewDateItemModel`](../../../lib/core/src/lib/card-view/models/card-view-dateitem.model.ts) is a property type for date properties. ```ts const dateItemProperty = new CardViewDateItemModel(options); @@ -257,7 +257,7 @@ const dateItemProperty = new CardViewDateItemModel(options); #### Card Datetime Item -[`CardViewDatetimeItemModel`](lib/core/src/lib/card-view/models/card-view-datetimeitem.model.ts) is a property type for datetime properties. +[`CardViewDatetimeItemModel`](../../../lib/core/src/lib/card-view/models/card-view-datetimeitem.model.ts) is a property type for datetime properties. ```ts const datetimeItemProperty = new CardViewDatetimeItemModel(options); @@ -275,7 +275,7 @@ const datetimeItemProperty = new CardViewDatetimeItemModel(options); #### Card Bool Item -[`CardViewBoolItemModel`](lib/core/src/lib/card-view/models/card-view-boolitem.model.ts) is a property type for boolean properties. +[`CardViewBoolItemModel`](../../../lib/core/src/lib/card-view/models/card-view-boolitem.model.ts) is a property type for boolean properties. ```ts const boolItemProperty = new CardViewBoolItemModel(options); @@ -292,7 +292,7 @@ const boolItemProperty = new CardViewBoolItemModel(options); #### Card Int Item -[`CardViewIntItemModel`](lib/core/src/lib/card-view/models/card-view-intitem.model.ts) is a property type for integer properties. +[`CardViewIntItemModel`](../../../lib/core/src/lib/card-view/models/card-view-intitem.model.ts) is a property type for integer properties. ```ts const intItemProperty = new CardViewIntItemModel(options); @@ -309,7 +309,7 @@ const intItemProperty = new CardViewIntItemModel(options); #### Card Float Item -[`CardViewFloatItemModel`](lib/core/src/lib/card-view/models/card-view-floatitem.model.ts) is a property type for float properties. +[`CardViewFloatItemModel`](../../../lib/core/src/lib/card-view/models/card-view-floatitem.model.ts) is a property type for float properties. ```ts const floatItemProperty = new CardViewFloatItemModel(options); @@ -326,7 +326,7 @@ const floatItemProperty = new CardViewFloatItemModel(options); #### Card Key Value Pairs Item -[`CardViewKeyValuePairsItemModel`](lib/core/src/lib/card-view/models/card-view-keyvaluepairs.model.ts) is a property type for key-value properties. +[`CardViewKeyValuePairsItemModel`](../../../lib/core/src/lib/card-view/models/card-view-keyvaluepairs.model.ts) is a property type for key-value properties. ```ts const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options); @@ -341,7 +341,7 @@ const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options); #### Card Select Item -[`CardViewSelectItemModel`](lib/core/src/lib/card-view/models/card-view-selectitem.model.ts) is a property type for select properties. +[`CardViewSelectItemModel`](../../../lib/core/src/lib/card-view/models/card-view-selectitem.model.ts) is a property type for select properties. ```ts const selectItemProperty = new CardViewSelectItemModel(options); @@ -353,11 +353,11 @@ const selectItemProperty = new CardViewSelectItemModel(options); | key\* | string | | Identifying key (important when editing the item) | | editable | boolean | false | Toggles whether the item is editable | | value | string | | The original data value for the item | -| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewSelectItemOption`](../../../lib/core/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item | +| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewSelectItemOption`](../../../lib/core/src/lib/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item | #### Card Array Item -[`CardViewArrayItemModel`](lib/core/src/lib/card-view/models/card-view-arrayitem.model.ts) is a property type for array properties. +[`CardViewArrayItemModel`](../../../lib/core/src/lib/card-view/models/card-view-arrayitem.model.ts) is a property type for array properties. ```ts const arrayItemProperty = new CardViewArrayItemModel(items); @@ -368,7 +368,7 @@ const arrayItemProperty = new CardViewArrayItemModel(items); | label\* | string | | Item label | | key\* | string | | Identifying key (important when editing the item) | | editable | boolean | false | Toggles whether the item is editable | -| value | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item | +| value | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewArrayItem`](../../../lib/core/src/lib/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item | ## See also diff --git a/docs/core/components/comment-list.component.md b/docs/core/components/comment-list.component.md index 9684135c09..52383c6d5c 100644 --- a/docs/core/components/comment-list.component.md +++ b/docs/core/components/comment-list.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# [Comment list component](lib/core/src/lib/comments/comment-list.component.ts "Defined in comment-list.component.ts") +# [Comment list component](../../../lib/core/src/lib/comments/comment-list.component.ts "Defined in comment-list.component.ts") Shows a list of comments. @@ -65,10 +65,10 @@ In the component template use the [comment list component](comment-list.componen | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| comments | [`CommentModel`](lib/core/src/lib/models/comment.model.ts)`[]` | | The comments data used to populate the list. | +| comments | [`CommentModel`](../../../lib/core/src/lib/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. | +| clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`CommentModel`](../../../lib/core/src/lib/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 b076dd08ab..87f023fab5 100644 --- a/docs/core/components/comments.component.md +++ b/docs/core/components/comments.component.md @@ -25,7 +25,7 @@ Displays comments from users involved in a specified environment and allows an i | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| id | `string` | | The numeric ID of the entity. | +| id | `string` | | The numeric ID of the task. | | readOnly | `boolean` | false | Are the comments read only? | ### Events diff --git a/docs/core/components/data-column.component.md b/docs/core/components/data-column.component.md index c97949a5c5..ef17bc0b50 100644 --- a/docs/core/components/data-column.component.md +++ b/docs/core/components/data-column.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-04-12 --- -# [Data Column Component](lib/core/src/lib/data-column/data-column.component.ts "Defined in data-column.component.ts") +# [Data Column Component](../../../lib/core/src/lib/data-column/data-column.component.ts "Defined in data-column.component.ts") Defines column properties for DataTable, Tasklist, Document List and other components. @@ -78,7 +78,7 @@ You can use `ngIf` directives to provide conditional visibility support for the ### Automatic column header translation You can use i18n resource keys with the -[`DataColumn`](lib/core/src/lib/datatable/data/data-column.model.ts) `title` property. +[`DataColumn`](../../../lib/core/src/lib/datatable/data/data-column.model.ts) `title` property. The component will automatically check the appropriate i18n resources and fetch the corresponding value. ```html @@ -131,9 +131,9 @@ Every cell in the DataTable component is bound to the dynamic data context conta | Name | Type | Description | | ---- | ---- | ----------- | -| data | [`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts) | Data adapter instance. | -| row | [`DataRow`](lib/core/src/lib/datatable/data/data-row.model.ts) | Current data row instance. | -| col | [`DataColumn`](lib/core/src/lib/datatable/data/data-column.model.ts) | Current data column instance. | +| data | [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) | Data adapter instance. | +| row | [`DataRow`](../../../lib/core/src/lib/datatable/data/data-row.model.ts) | Current data row instance. | +| col | [`DataColumn`](../../../lib/core/src/lib/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: @@ -146,7 +146,7 @@ In order to wire HTML templates with the data context you will need to define a The name format is `let-VARIABLE_NAME="$implicit"` where `VARIABLE_NAME` is the name of the variable you want to bind the template data context to. -You can also get a cell value from the underlying [`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts): +You can also get a cell value from the underlying [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts): ```ts context.data.getValue(entry.row, entry.col); @@ -363,7 +363,7 @@ HTML `` element example: ``` -You can use generic type for [`DataColumn`](lib/core/src/lib/datatable/data/data-column.model.ts) in order to get intellisense working e.g. +You can use generic type for [`DataColumn`](../../../lib/core/src/lib/datatable/data/data-column.model.ts) in order to get intellisense working e.g. ```ts const dataColumn: DataColumn<{ shouldPerformActionIfDisplayed: boolean }> = { diff --git a/docs/core/components/datatable.component.md b/docs/core/components/datatable.component.md index 03bc5bbd24..1bd4ad01c8 100644 --- a/docs/core/components/datatable.component.md +++ b/docs/core/components/datatable.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-04-12 --- -# [DataTable component](lib/core/src/lib/datatable/components/datatable/datatable.component.ts "Defined in datatable.component.ts") +# [DataTable component](../../../lib/core/src/lib/datatable/components/datatable/datatable.component.ts "Defined in datatable.component.ts") Displays data as a table with customizable columns and presentation. @@ -80,7 +80,7 @@ export class DataTableDemo { ### Setting the rows and column schema -You can set rows and columns in the [`ObjectDataTableAdapter`](lib/core/src/lib/datatable/data/object-datatable-adapter.ts) as shown below: +You can set rows and columns in the [`ObjectDataTableAdapter`](../../../lib/core/src/lib/datatable/data/object-datatable-adapter.ts) as shown below: ```ts import { ObjectDataTableAdapter } from '@alfresco/adf-core'; @@ -157,7 +157,7 @@ export class DataTableDemo { ``` -You can also set rows in the [`ObjectDataTableAdapter`](lib/core/src/lib/datatable/data/object-datatable-adapter.ts) and set columns as an input as shown below : +You can also set rows in the [`ObjectDataTableAdapter`](../../../lib/core/src/lib/datatable/data/object-datatable-adapter.ts) and set columns as an input as shown below : ```ts import { ObjectDataTableAdapter } from '@alfresco/adf-core'; @@ -371,7 +371,7 @@ Learm more about styling your datatable: [Customizing the component's styles](#c | allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use [facet widget](../../../lib/content-services/src/lib/search/models/facet-widget.interface.ts) search for filtering. | | columns | `any[]` | \[] | The columns that the datatable will show. | | contextMenu | `boolean` | false | Toggles custom context menu for the component. | -| data | [`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts) | | Data source for the table | +| data | [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) | | Data source for the table | | display | `string` | DisplayMode.List | Selects the display mode of the table. Can be "list" or "gallery". | | fallbackThumbnail | `string` | | Fallback image for rows where the thumbnail is missing. | | loading | `boolean` | false | Flag that indicates if the datatable is in loading state and needs to show the loading template (see the docs to learn how to configure a loading template). | @@ -393,22 +393,22 @@ Learm more about styling your datatable: [Customizing the component's styles](#c | Name | Type | Description | | ---- | ---- | ----------- | -| columnOrderChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts)`<>[]>` | Emitted after dragging and dropping column header. | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | -| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | -| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| columnOrderChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataColumn`](../../../lib/core/src/lib/datatable/data/data-column.model.ts)`<>[]>` | Emitted after dragging and dropping column header. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/src/lib/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/src/lib/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | +| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/src/lib/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/src/lib/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/src/lib/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | ## Details ### Supplying data for the table The column layout and row data are supplied to the table using an object that implements the -[`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts) interface. This interface hides the internal details of the class that provides +[`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) interface. This interface hides the internal details of the class that provides the data, which gives a lot of flexibility in how the data can be stored and accessed. The DataTable -library includes a standard adapter class called [`ObjectDataTableAdapter`](lib/core/src/lib/datatable/data/object-datatable-adapter.ts) that is useful in many -common cases. See the [`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts) for full details about the interface and the [`ObjectDataTableAdapter`](lib/core/src/lib/datatable/data/object-datatable-adapter.ts) class. +library includes a standard adapter class called [`ObjectDataTableAdapter`](../../../lib/core/src/lib/datatable/data/object-datatable-adapter.ts) that is useful in many +common cases. See the [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) for full details about the interface and the [`ObjectDataTableAdapter`](../../../lib/core/src/lib/datatable/data/object-datatable-adapter.ts) class. ### Customizing columns @@ -433,14 +433,16 @@ These events bubble up the component tree and can be handled by any parent compo | cell-dragover | Raised when dragging data over the cell. | | cell-drop | Raised when data is dropped on the column cell. | -#### Sorting-changed +#### Sorting-changed sorting-changed event contains + ```ts direction: "asc" key: "timestamp" sortingKey: "" ``` + #### Drop Events All custom DOM events related to `drop` handling expose the following interface: diff --git a/docs/core/components/empty-content.component.md b/docs/core/components/empty-content.component.md index c31b358376..6005540de7 100644 --- a/docs/core/components/empty-content.component.md +++ b/docs/core/components/empty-content.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-02-01 --- -# [Empty Content Component](lib/core/src/lib/templates/empty-content/empty-content.component.ts "Defined in empty-content.component.ts") +# [Empty Content Component](../../../lib/core/src/lib/templates/empty-content/empty-content.component.ts "Defined in empty-content.component.ts") Provides a generic "Empty Content" placeholder for components. diff --git a/docs/core/components/empty-list.component.md b/docs/core/components/empty-list.component.md index ca3e04b620..fa42611a88 100644 --- a/docs/core/components/empty-list.component.md +++ b/docs/core/components/empty-list.component.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [Empty list component](lib/core/src/lib/datatable/components/empty-list/empty-list.component.ts "Defined in empty-list.component.ts") +# [Empty list component](../../../lib/core/src/lib/datatable/components/empty-list/empty-list.component.ts "Defined in empty-list.component.ts") Displays a message indicating that a list is empty. diff --git a/docs/core/components/error-content.component.md b/docs/core/components/error-content.component.md index b236be6e2e..b330d4b0f8 100644 --- a/docs/core/components/error-content.component.md +++ b/docs/core/components/error-content.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-09-13 --- -# [Error Content Component](lib/core/src/lib/templates/error-content/error-content.component.ts "Defined in error-content.component.ts") +# [Error Content Component](../../../lib/core/src/lib/templates/error-content/error-content.component.ts "Defined in error-content.component.ts") Displays info about a specific error. diff --git a/docs/core/components/form-field.component.md b/docs/core/components/form-field.component.md index 04e7209cc9..2aafc19461 100644 --- a/docs/core/components/form-field.component.md +++ b/docs/core/components/form-field.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Form field component](lib/core/src/lib/form/components/form-field/form-field.component.ts "Defined in form-field.component.ts") +# [Form field component](../../../lib/core/src/lib/form/components/form-field/form-field.component.ts "Defined in form-field.component.ts") Represents a UI field in a form. @@ -40,23 +40,23 @@ 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/src/lib/form/components/widgets/text/text.widget.ts) | -| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](lib/core/src/lib/form/components/widgets/multiline-text/multiline-text.widget.ts) | -| Number | integer | [`NumberWidgetComponent`](lib/core/src/lib/form/components/widgets/number/number.widget.ts) | -| Checkbox | boolean | [`CheckboxWidgetComponent`](lib/core/src/lib/form/components/widgets/checkbox/checkbox.widget.ts) | -| Date | date | [`DateWidgetComponent`](lib/core/src/lib/form/components/widgets/date/date.widget.ts) | -| Dropdown | dropdown | [`DropdownWidgetComponent`](lib/process-services/src/lib/form/widgets/dropdown/dropdown.widget.ts) | -| Typeahead | typeahead | [`TypeaheadWidgetComponent`](lib/process-services/src/lib/form/widgets/typeahead/typeahead.widget.ts) | -| Amount | amount | [`AmountWidgetComponent`](lib/core/src/lib/form/components/widgets/amount/amount.widget.ts) | -| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](lib/process-services/src/lib/form/widgets/radio-buttons/radio-buttons.widget.ts) | -| People | people | [`PeopleWidgetComponent`](lib/process-services/src/lib/form/widgets/people/people.widget.ts) | -| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](lib/process-services/src/lib/form/widgets/functional-group/functional-group.widget.ts) | -| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](lib/process-services/src/lib/form/widgets/dynamic-table/dynamic-table.widget.ts) | -| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](lib/core/src/lib/form/components/widgets/hyperlink/hyperlink.widget.ts) | +| Text | text | [`TextWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/text/text.widget.ts) | +| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../../lib/core/src/lib/form/components/widgets/multiline-text/multiline-text.widget.ts) | +| Number | integer | [`NumberWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/number/number.widget.ts) | +| Checkbox | boolean | [`CheckboxWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/checkbox/checkbox.widget.ts) | +| Date | date | [`DateWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/date/date.widget.ts) | +| Dropdown | dropdown | [`DropdownWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/dropdown/dropdown.widget.ts) | +| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/typeahead/typeahead.widget.ts) | +| Amount | amount | [`AmountWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/amount/amount.widget.ts) | +| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/radio-buttons/radio-buttons.widget.ts) | +| People | people | [`PeopleWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/people/people.widget.ts) | +| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/functional-group/functional-group.widget.ts) | +| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/dynamic-table/dynamic-table.widget.ts) | +| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/hyperlink/hyperlink.widget.ts) | | Header | group | [`ContainerWidgetComponent`](lib/core/src/lib/form/components/widgets/container/container.widget.ts) | -| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](lib/process-services/src/lib/form/widgets/upload/upload.widget.ts) (based on metadata) | -| Display value | readonly | [`TextWidgetComponent`](lib/core/src/lib/form/components/widgets/text/text.widget.ts) | -| Display text | readonly-text | [`DisplayTextWidgetComponent`](lib/core/src/lib/form/components/widgets/display-text/display-text.widget.ts) | -| Display Rich text | display-rich-text | [`DisplayRichTextWidgetComponent`](lib/core/src/lib/form/components/widgets/display-rich-text/display-rich-text.widget.ts) | +| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/upload/upload.widget.ts) (based on metadata) | +| Display value | readonly | [`TextWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/text/text.widget.ts) | +| Display text | readonly-text | [`DisplayTextWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/display-text/display-text.widget.ts) | +| Display Rich text | display-rich-text | [`DisplayRichTextWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/display-rich-text/display-rich-text.widget.ts) | | N/A | container | [`ContainerWidgetComponent`](lib/core/src/lib/form/components/widgets/container/container.widget.ts) (layout component) | -| N/A | N/A | [`UnknownWidgetComponent`](lib/core/src/lib/form/components/widgets/unknown/unknown.widget.ts) | +| N/A | N/A | [`UnknownWidgetComponent`](../../../lib/core/src/lib/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 9da4b955f7..a5cb117e4e 100644 --- a/docs/core/components/form-list.component.md +++ b/docs/core/components/form-list.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Form List Component](lib/process-services/src/lib/form/form-list/form-list.component.ts "Defined in form-list.component.ts") +# [Form List Component](../../../lib/process-services/src/lib/form/form-list/form-list.component.ts "Defined in form-list.component.ts") Shows forms as a list. diff --git a/docs/core/components/header.component.md b/docs/core/components/header.component.md index 19036c3041..90e4ace1ab 100644 --- a/docs/core/components/header.component.md +++ b/docs/core/components/header.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Header component](lib/core/src/lib/layout/components/header/header.component.ts "Defined in header.component.ts") +# [Header component](../../../lib/core/src/lib/layout/components/header/header.component.ts "Defined in header.component.ts") Reusable header for Alfresco applications. diff --git a/docs/core/components/host-settings.component.md b/docs/core/components/host-settings.component.md index e30cdcebfc..419823ae1e 100644 --- a/docs/core/components/host-settings.component.md +++ b/docs/core/components/host-settings.component.md @@ -5,7 +5,7 @@ Status: Internal Last reviewed: 2019-01-16 --- -# [Host settings component](lib/core/src/lib/settings/host-settings.component.ts "Defined in host-settings.component.ts") +# [Host settings component](../../../lib/core/src/lib/settings/host-settings.component.ts "Defined in host-settings.component.ts") Validates the URLs for ACS and APS and saves them in the user's local storage diff --git a/docs/core/components/icon.component.md b/docs/core/components/icon.component.md index 12ec04f5cc..3338e21a47 100644 --- a/docs/core/components/icon.component.md +++ b/docs/core/components/icon.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-02-08 --- -# [Icon Component](lib/core/src/lib/icon/icon.component.ts "Defined in icon.component.ts") +# [Icon Component](../../../lib/core/src/lib/icon/icon.component.ts "Defined in icon.component.ts") Provides a universal way of rendering registered and named icons. diff --git a/docs/core/components/infinite-pagination.component.md b/docs/core/components/infinite-pagination.component.md index 68a8997732..843757b853 100644 --- a/docs/core/components/infinite-pagination.component.md +++ b/docs/core/components/infinite-pagination.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-03-20 --- -# [Infinite Pagination component](lib/core/src/lib/pagination/infinite-pagination.component.ts "Defined in infinite-pagination.component.ts") +# [Infinite Pagination component](../../../lib/core/src/lib/pagination/infinite-pagination.component.ts "Defined in infinite-pagination.component.ts") Adds "infinite" pagination to the component it is used with. @@ -40,13 +40,13 @@ Adds "infinite" pagination to the component it is used with. | ---- | ---- | ------------- | ----------- | | 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/src/lib/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | +| target | [`PaginatedComponent`](../../../lib/core/src/lib/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | ### 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. | +| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RequestPaginationModel`](../../../lib/core/src/lib/models/request-pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. | ## Details diff --git a/docs/core/components/info-drawer-layout.component.md b/docs/core/components/info-drawer-layout.component.md index 09fe361340..c6ed24c66a 100644 --- a/docs/core/components/info-drawer-layout.component.md +++ b/docs/core/components/info-drawer-layout.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Info drawer layout component](lib/core/src/lib/info-drawer/info-drawer-layout.component.ts "Defined in info-drawer-layout.component.ts") +# [Info drawer layout component](../../../lib/core/src/lib/info-drawer/info-drawer-layout.component.ts "Defined in info-drawer-layout.component.ts") Displays a sidebar-style information panel. diff --git a/docs/core/components/info-drawer-tab.component.md b/docs/core/components/info-drawer-tab.component.md index e504f0e03d..a0a70ef170 100644 --- a/docs/core/components/info-drawer-tab.component.md +++ b/docs/core/components/info-drawer-tab.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Info Drawer Tab component](lib/core/src/lib/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts") +# [Info Drawer Tab component](../../../lib/core/src/lib/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts") Renders tabs in a [Info drawer component](info-drawer.component.md). diff --git a/docs/core/components/info-drawer.component.md b/docs/core/components/info-drawer.component.md index fa363daea0..decc046658 100644 --- a/docs/core/components/info-drawer.component.md +++ b/docs/core/components/info-drawer.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Info Drawer component](lib/core/src/lib/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts") +# [Info Drawer component](../../../lib/core/src/lib/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts") Displays a sidebar-style information panel with tabs. diff --git a/docs/core/components/json-cell.component.md b/docs/core/components/json-cell.component.md index b2e8ed80d6..2cea5c6d88 100644 --- a/docs/core/components/json-cell.component.md +++ b/docs/core/components/json-cell.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-04-12 --- -# [Json Cell Component](lib/core/src/lib/datatable/components/json-cell/json-cell.component.ts "Defined in json-cell.component.ts") +# [Json Cell Component](../../../lib/core/src/lib/datatable/components/json-cell/json-cell.component.ts "Defined in json-cell.component.ts") Shows a JSON-formatted value inside a datatable component. @@ -43,12 +43,12 @@ You can specify the cell inside the `app.config.json` file: | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| column | [`DataColumn`](lib/core/src/lib/datatable/data/data-column.model.ts) | | Data that defines the column. | +| column | [`DataColumn`](../../../lib/core/src/lib/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/src/lib/datatable/data/datatable-adapter.ts) | | Data table adapter instance. | +| data | [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) | | Data table adapter instance. | | editable | `boolean` | false | Editable JSON. | | resolverFn | `Function` | null | Custom resolver function which is used to parse dynamic column objects | -| row | [`DataRow`](lib/core/src/lib/datatable/data/data-row.model.ts) | | Data that defines the row. | +| row | [`DataRow`](../../../lib/core/src/lib/datatable/data/data-row.model.ts) | | Data that defines the row. | | tooltip | `string` | | Text for the cell's tooltip. | ## Details diff --git a/docs/core/components/language-menu.component.md b/docs/core/components/language-menu.component.md index e8fcd68c32..4e3cbeed9b 100644 --- a/docs/core/components/language-menu.component.md +++ b/docs/core/components/language-menu.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-09 --- -# [Language Menu component](lib/core/src/lib/language-menu/language-menu.component.ts "Defined in language-menu.component.ts") +# [Language Menu component](../../../lib/core/src/lib/language-menu/language-menu.component.ts "Defined in language-menu.component.ts") Displays all the languages that are present in "app.config.json" and the default (EN). @@ -53,7 +53,6 @@ The component fetches the list of available languages from `app.config.json`: For languages that need RTL orientation, `direction` property must be declared. Default is `ltr`. - ```json { "key": "...", diff --git a/docs/core/components/login-dialog-panel.component.md b/docs/core/components/login-dialog-panel.component.md index 6ace771a44..2f2790043a 100644 --- a/docs/core/components/login-dialog-panel.component.md +++ b/docs/core/components/login-dialog-panel.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-10-02 --- -# [Login Dialog Panel component](lib/core/src/lib/login/components/login-dialog-panel.component.ts "Defined in login-dialog-panel.component.ts") +# [Login Dialog Panel component](../../../lib/core/src/lib/login/components/login-dialog-panel.component.ts "Defined in login-dialog-panel.component.ts") Shows and manages a login dialog. @@ -15,7 +15,7 @@ Shows and manages a login dialog. | 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 | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/src/lib/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. | ## Details diff --git a/docs/core/components/login-dialog.component.md b/docs/core/components/login-dialog.component.md index 978ce7ae0a..98126589d8 100644 --- a/docs/core/components/login-dialog.component.md +++ b/docs/core/components/login-dialog.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-10-02 --- -# [Login Dialog component](lib/core/src/lib/login/components/login-dialog.component.ts "Defined in login-dialog.component.ts") +# [Login Dialog component](../../../lib/core/src/lib/login/components/login-dialog.component.ts "Defined in login-dialog.component.ts") Allows a user to perform a login via a dialog. @@ -18,7 +18,7 @@ The [Login Dialog component](login-dialog.component.md) allows you to perform a Unlike most components, the [Login Dialog Component](login-dialog.component.md) is typically shown in a dialog box rather than the main page and you are responsible for opening the dialog yourself. You can use the [Angular Material Dialog](https://material.angular.io/components/dialog/overview) for this, -as shown in the usage example. ADF provides the [`LoginDialogComponentData`](lib/core/src/lib/login/components/login-dialog-component-data.interface.ts) interface +as shown in the usage example. ADF provides the [`LoginDialogComponentData`](../../../lib/core/src/lib/login/components/login-dialog-component-data.interface.ts) interface to work with the Dialog's [data option](https://material.angular.io/components/dialog/overview#sharing-data-with-the-dialog-component-): @@ -81,7 +81,7 @@ openLoginDialog() { } ``` -All the results will be streamed to the logged [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present in the [`LoginDialogComponentData`](lib/core/src/lib/login/components/login-dialog-component-data.interface.ts) object passed to the dialog. +All the results will be streamed to the logged [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present in the [`LoginDialogComponentData`](../../../lib/core/src/lib/login/components/login-dialog-component-data.interface.ts) object passed to the dialog. When the dialog action is selected by clicking, the `data.logged` stream will be completed. ## See also diff --git a/docs/core/components/login.component.md b/docs/core/components/login.component.md index 4396a74d77..5306073d3c 100644 --- a/docs/core/components/login.component.md +++ b/docs/core/components/login.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-03-20 --- -# [Login component](lib/core/src/lib/login/components/login.component.ts "Defined in login.component.ts") +# [Login component](../../../lib/core/src/lib/login/components/login.component.ts "Defined in login.component.ts") Authenticates to Alfresco Content Services and Alfresco Process Services. @@ -92,9 +92,9 @@ with custom input fields handled by your application or parent component: | Name | Type | Description | | ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. | -| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../../lib/core/src/lib/login/models/login-error.event.ts)`>` | Emitted when the login fails. | +| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/src/lib/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/src/lib/login/models/login-success.event.ts)`>` | Emitted when the login is successful. | ## Details diff --git a/docs/core/components/notification-history.component.md b/docs/core/components/notification-history.component.md index 7969d97b2e..5a4f4a694c 100644 --- a/docs/core/components/notification-history.component.md +++ b/docs/core/components/notification-history.component.md @@ -5,7 +5,7 @@ Status: Experimental Last reviewed: 2019-06-05 --- -# [Notification History component](lib/core/src/lib/notifications/components/notification-history.component.ts "Defined in notification-history.component.ts") +# [Notification History component](../../../lib/core/src/lib/notifications/components/notification-history.component.ts "Defined in notification-history.component.ts") This component is in the current status just an experimental component. The main purpose of the [Notification history component](../../core/components/notification-history.component.md) is list all the notification received in the current session. They will disappear from the list after the refresh. diff --git a/docs/core/components/pagination.component.md b/docs/core/components/pagination.component.md index 7dc54f0b64..0d2dfad87a 100644 --- a/docs/core/components/pagination.component.md +++ b/docs/core/components/pagination.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Pagination Component](lib/core/src/lib/pagination/pagination.component.ts "Defined in pagination.component.ts") +# [Pagination Component](../../../lib/core/src/lib/pagination/pagination.component.ts "Defined in pagination.component.ts") Adds pagination to the component it is used with. @@ -43,18 +43,18 @@ Adds pagination to the component it is used with. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | supportedPageSizes | `number[]` | | An array of page sizes. | -| target | [`PaginatedComponent`](lib/core/src/lib/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | -| pagination | [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) | | Pagination object. | +| target | [`PaginatedComponent`](../../../lib/core/src/lib/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | +| pagination | [`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts) | | Pagination object. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. | -| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. | -| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page size changes. | -| nextPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the next page is requested. | -| prevPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the previous page is requested. | +| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. | +| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts)`>` | Emitted when the page number changes. | +| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts)`>` | Emitted when the page size changes. | +| nextPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts)`>` | Emitted when the next page is requested. | +| prevPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/src/lib/models/pagination.model.ts)`>` | Emitted when the previous page is requested. | ## Details @@ -84,7 +84,7 @@ new object contains updated properties that you can use to fetch the next page o ### Custom pagination The component also makes it easy to integrate your own implementation of pagination. -You can supply any component that implements the [`PaginatedComponent`](lib/core/src/lib/pagination/paginated-component.interface.ts) interface as the value of the +You can supply any component that implements the [`PaginatedComponent`](../../../lib/core/src/lib/pagination/paginated-component.interface.ts) interface as the value of the `target` property. ```js diff --git a/docs/core/components/rich-text-editor.md b/docs/core/components/rich-text-editor.md index df7ca99dae..36c87d030b 100644 --- a/docs/core/components/rich-text-editor.md +++ b/docs/core/components/rich-text-editor.md @@ -9,12 +9,6 @@ Last reviewed: 2020-07-20 Wrap [Editor.js](https://editorjs.io/) element to show a Rich Text editor allows to add formatted text. -## Contents - -- [Basic usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - ## Basic usage **app.component.html** @@ -72,7 +66,7 @@ export class RichTextEditorDemo { ### Properties -| Name | Type | Default value | Description | -| -------- | ------------ | ------------- | -------------------------------------------------------------------------------------------- | -| data | `OutputData` | null | EditorJs data format (follow the [official documentation](https://editorjs.io/saving-data) ) | -| readOnly | `boolean` | false | If true users won't have the ability to change the document content | +| Name | Type | Default value | Description | +| ---- | ---- | ------------- | ----------- | +| data | `OutputData` | null | EditorJs data format (follow the [official documentation](https://editorjs.io/saving-data) ) | +| readOnly | `boolean` | false | If true users won't have the ability to change the document content | diff --git a/docs/core/components/search-text-input.component.md b/docs/core/components/search-text-input.component.md index baf7f92b29..a9d40b00b4 100644 --- a/docs/core/components/search-text-input.component.md +++ b/docs/core/components/search-text-input.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-11-06 --- -# [Search Text Input Component](lib/core/src/lib/search-text/search-text-input.component.ts "Defined in search-text-input.component.ts") +# [Search Text Input Component](../../../lib/core/src/lib/search-text/search-text-input.component.ts "Defined in search-text-input.component.ts") Displays a input text that supports autocompletion diff --git a/docs/core/components/sidebar-action-menu.component.md b/docs/core/components/sidebar-action-menu.component.md index 53e8d17713..e9a7dee139 100644 --- a/docs/core/components/sidebar-action-menu.component.md +++ b/docs/core/components/sidebar-action-menu.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Sidebar action menu component](lib/core/src/lib/layout/components/sidebar-action/sidebar-action-menu.component.ts "Defined in sidebar-action-menu.component.ts") +# [Sidebar action menu component](../../../lib/core/src/lib/layout/components/sidebar-action/sidebar-action-menu.component.ts "Defined in sidebar-action-menu.component.ts") Displays a sidebar-action menu information panel. diff --git a/docs/core/components/sidenav-layout.component.md b/docs/core/components/sidenav-layout.component.md index e28fb697a7..7df9ebecbe 100644 --- a/docs/core/components/sidenav-layout.component.md +++ b/docs/core/components/sidenav-layout.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Sidenav Layout component](lib/core/src/lib/layout/components/sidenav-layout/sidenav-layout.component.ts "Defined in sidenav-layout.component.ts") +# [Sidenav Layout component](../../../lib/core/src/lib/layout/components/sidenav-layout/sidenav-layout.component.ts "Defined in sidenav-layout.component.ts") Displays the standard three-region ADF application layout. diff --git a/docs/core/components/snackbar-content.component.md b/docs/core/components/snackbar-content.component.md index a50ed0ecea..684846a918 100644 --- a/docs/core/components/snackbar-content.component.md +++ b/docs/core/components/snackbar-content.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2022-11-08 --- -# [Snackbar Content Component](lib/core/src/lib/snackbar-content/snackbar-content.component.ts "Defined in snackbar-content.component.ts") +# [Snackbar Content Component](../../../lib/core/src/lib/snackbar-content/snackbar-content.component.ts "Defined in snackbar-content.component.ts") Custom content for Snackbar which allows use icon as action. @@ -23,23 +23,6 @@ snackBar.openFromComponent(SnackbarContentComponent, { ## Class members -### Properties - -| Name | Type | Default value | Description | -|------|----------------|---------------|------------------------------------------------------------------| -| data | `SnackbarData` | false | Object which is injected into snackbar's content with it's data. | - -### Snackbar Data - -| Name | Type | Default value | Description | -|-------------|-----------|---------------|-------------------------------------------------------------------------| -| actionLabel | `string` | false | Displayed action as a text. | -| actionIcon | `string` | false | Displayed action as an material icon. | -| actionIconAriaLabel | `string` | false | Sets aria-label attribute for button with icon action. | -| message | `string` | false | Visible snackbar's message for user. | -| showAction | `boolean` | false | True if action should be visible, false in other case. | -| callActionOnIconClick | `boolean` | false | True if clicking on icon should to trigger action, false in other case. | - ## Details Snackbar allows using action as string by default which causes that there is no possibility to use mat-icon inside snackbar's content. diff --git a/docs/core/components/sorting-picker.component.md b/docs/core/components/sorting-picker.component.md index 8e40fa5a5d..42cec2aedb 100644 --- a/docs/core/components/sorting-picker.component.md +++ b/docs/core/components/sorting-picker.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Sorting Picker Component](lib/core/src/lib/sorting-picker/sorting-picker.component.ts "Defined in sorting-picker.component.ts") +# [Sorting Picker Component](../../../lib/core/src/lib/sorting-picker/sorting-picker.component.ts "Defined in sorting-picker.component.ts") Selects from a set of predefined sorting definitions and directions. diff --git a/docs/core/components/start-form.component.md b/docs/core/components/start-form.component.md index 796a2a43f4..f833b66df3 100644 --- a/docs/core/components/start-form.component.md +++ b/docs/core/components/start-form.component.md @@ -26,13 +26,13 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| data | [`FormValues`](lib/core/src/lib/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. | +| data | [`FormValues`](../../../lib/core/src/lib/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/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | | Contains a list of form field validator instances. | -| form | [`FormModel`](lib/core/src/lib/form/components/widgets/core/form.model.ts) | | Underlying form model instance. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | | Contains a list of form field validator instances. | +| form | [`FormModel`](../../../lib/core/src/lib/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. | @@ -56,13 +56,13 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when a field of the form is clicked. | -| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/src/lib/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/src/lib/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/src/lib/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/src/lib/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. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/src/lib/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/src/lib/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | | outcomeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks one of the outcome buttons that completes the form. | ## Details diff --git a/docs/core/components/text-mask.component.md b/docs/core/components/text-mask.component.md index 6530f6362e..d81e3c1148 100644 --- a/docs/core/components/text-mask.component.md +++ b/docs/core/components/text-mask.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Text Mask directive](lib/core/src/lib/form/components/widgets/text/text-mask.component.ts "Defined in text-mask.component.ts") +# [Text Mask directive](../../../lib/core/src/lib/form/components/widgets/text/text-mask.component.ts "Defined in text-mask.component.ts") Implements text field input masks. diff --git a/docs/core/components/toolbar-divider.component.md b/docs/core/components/toolbar-divider.component.md index 29b29caef1..623183598a 100644 --- a/docs/core/components/toolbar-divider.component.md +++ b/docs/core/components/toolbar-divider.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Toolbar Divider Component](lib/core/src/lib/toolbar/toolbar-divider.component.ts "Defined in toolbar-divider.component.ts") +# [Toolbar Divider Component](../../../lib/core/src/lib/toolbar/toolbar-divider.component.ts "Defined in toolbar-divider.component.ts") Divides groups of elements in a Toolbar with a visual separator. diff --git a/docs/core/components/toolbar-title.component.md b/docs/core/components/toolbar-title.component.md index 2c380b19e9..11b894ec08 100644 --- a/docs/core/components/toolbar-title.component.md +++ b/docs/core/components/toolbar-title.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Toolbar Title Component](lib/core/src/lib/toolbar/toolbar-title.component.ts "Defined in toolbar-title.component.ts") +# [Toolbar Title Component](../../../lib/core/src/lib/toolbar/toolbar-title.component.ts "Defined in toolbar-title.component.ts") Supplies custom HTML to be included in a [Toolbar component](toolbar.component.md) title. diff --git a/docs/core/components/toolbar.component.md b/docs/core/components/toolbar.component.md index 440a5e6fb4..9d5bf4e8f0 100644 --- a/docs/core/components/toolbar.component.md +++ b/docs/core/components/toolbar.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Toolbar Component](lib/core/src/lib/toolbar/toolbar.component.ts "Defined in toolbar.component.ts") +# [Toolbar Component](../../../lib/core/src/lib/toolbar/toolbar.component.ts "Defined in toolbar.component.ts") Simple container for headers, titles, actions and breadcrumbs. diff --git a/docs/core/components/user-info.component.md b/docs/core/components/user-info.component.md index 53ae615458..16298e53c2 100644 --- a/docs/core/components/user-info.component.md +++ b/docs/core/components/user-info.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# [User Info component](lib/core/src/lib/userinfo/components/user-info.component.ts "Defined in user-info.component.ts") +# [User Info component](../../../lib/core/src/lib/userinfo/components/user-info.component.ts "Defined in user-info.component.ts") Shows user information. diff --git a/docs/core/components/viewer.component.md b/docs/core/components/viewer.component.md index 392a6acbea..bab4a3834a 100644 --- a/docs/core/components/viewer.component.md +++ b/docs/core/components/viewer.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-03-25 --- -# [Viewer component](lib/core/src/lib/viewer/components/viewer.component.ts "Defined in viewer.component.ts") +# [Viewer component](../../../lib/core/src/lib/viewer/components/viewer.component.ts "Defined in viewer.component.ts") Displays content from an ACS repository. @@ -110,11 +110,11 @@ See the [Custom layout](#custom-layout) section for full details of all availabl | Name | Type | Description | | ---- | ---- | ----------- | | extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the filename extension changes. | -| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Back' button. | +| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/src/lib/events/base.event.ts)`>` | Emitted when user clicks the 'Back' button. | | invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the shared link used is not valid. | | navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Before' ("<") button. | | navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Next' (">") button. | -| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Print' button. | +| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/src/lib/events/base.event.ts)`>` | Emitted when user clicks the 'Print' button. | | showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the viewer is shown or hidden. | ## Keyboard shortcuts diff --git a/docs/core/directives/clipboard.directive.md b/docs/core/directives/clipboard.directive.md index cda6948a43..b364880ebc 100644 --- a/docs/core/directives/clipboard.directive.md +++ b/docs/core/directives/clipboard.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-04-12 --- -# [Clipboard directive](lib/core/src/lib/clipboard/clipboard.directive.ts "Defined in clipboard.directive.ts") +# [Clipboard directive](../../../lib/core/src/lib/clipboard/clipboard.directive.ts "Defined in clipboard.directive.ts") Copies text to the clipboard. diff --git a/docs/core/directives/context-menu.directive.md b/docs/core/directives/context-menu.directive.md index ae033057da..05158f2aaf 100644 --- a/docs/core/directives/context-menu.directive.md +++ b/docs/core/directives/context-menu.directive.md @@ -5,7 +5,7 @@ Status: Deprecated Last reviewed: 2018-11-20 --- -# [Context Menu directive](lib/core/src/lib/context-menu/context-menu.directive.ts "Defined in context-menu.directive.ts") +# [Context Menu directive](../../../lib/core/src/lib/context-menu/context-menu.directive.ts "Defined in context-menu.directive.ts") Adds a context menu to a component. diff --git a/docs/core/directives/highlight.directive.md b/docs/core/directives/highlight.directive.md index 3ba48547f1..c30327aa71 100644 --- a/docs/core/directives/highlight.directive.md +++ b/docs/core/directives/highlight.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Highlight directive](lib/core/src/lib/directives/highlight.directive.ts "Defined in highlight.directive.ts") +# [Highlight directive](../../../lib/core/src/lib/directives/highlight.directive.ts "Defined in highlight.directive.ts") Adds highlighting to selected sections of an HTML element's content. diff --git a/docs/core/directives/infinite-select-scroll.directive.md b/docs/core/directives/infinite-select-scroll.directive.md index bbd287bda3..4117c89a97 100644 --- a/docs/core/directives/infinite-select-scroll.directive.md +++ b/docs/core/directives/infinite-select-scroll.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2020-01-14 --- -# [Infinite Select Scroll](lib/core/src/lib/directives/infinite-select-scroll.directive.ts "Defined in infinite-select-scroll.directive.ts") +# [Infinite Select Scroll](../../../lib/core/src/lib/directives/infinite-select-scroll.directive.ts "Defined in infinite-select-scroll.directive.ts") Load more options to select component if API returns more items diff --git a/docs/core/directives/logout.directive.md b/docs/core/directives/logout.directive.md index 9ec767159a..645beb8c33 100644 --- a/docs/core/directives/logout.directive.md +++ b/docs/core/directives/logout.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-03-20 --- -# [Logout directive](lib/core/src/lib/directives/logout.directive.ts "Defined in logout.directive.ts") +# [Logout directive](../../../lib/core/src/lib/directives/logout.directive.ts "Defined in logout.directive.ts") Logs the user out when the decorated element is clicked. diff --git a/docs/core/directives/node-download.directive.md b/docs/core/directives/node-download.directive.md index 3fc453b68e..bd2e3d2758 100644 --- a/docs/core/directives/node-download.directive.md +++ b/docs/core/directives/node-download.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Node Download directive](lib/core/src/lib/directives/node-download.directive.ts "Defined in node-download.directive.ts") +# [Node Download directive](../../../lib/core/src/lib/directives/node-download.directive.ts "Defined in node-download.directive.ts") Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. diff --git a/docs/core/directives/upload.directive.md b/docs/core/directives/upload.directive.md index 43e5097b4f..fbacb6470f 100644 --- a/docs/core/directives/upload.directive.md +++ b/docs/core/directives/upload.directive.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Upload Directive](lib/core/src/lib/directives/upload.directive.ts "Defined in upload.directive.ts") +# [Upload Directive](../../../lib/core/src/lib/directives/upload.directive.ts "Defined in upload.directive.ts") Uploads content in response to file drag and drop. diff --git a/docs/core/interfaces/card-view-item.interface.md b/docs/core/interfaces/card-view-item.interface.md index 295b3875ec..b29f5a2fb1 100644 --- a/docs/core/interfaces/card-view-item.interface.md +++ b/docs/core/interfaces/card-view-item.interface.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-05-08 --- -# [Card View Item interface](lib/core/src/lib/card-view/interfaces/card-view-item.interface.ts "Defined in card-view-item.interface.ts") +# [Card View Item interface](../../../lib/core/src/lib/card-view/interfaces/card-view-item.interface.ts "Defined in card-view-item.interface.ts") Defines the implementation of an item in a [Card View component](../components/card-view.component.md). @@ -50,8 +50,8 @@ Picard's birthday (47457.1): 1. Define the model for the custom type. - Your model must extend the [`CardViewBaseItemModel`](lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) class and implement the [`CardViewItem`](lib/core/src/lib/card-view/interfaces/card-view-item.interface.ts) - and [`DynamicComponentModel`](lib/core/src/lib/services/dynamic-component-mapper.service.ts) interfaces. See the + Your model must extend the [`CardViewBaseItemModel`](../../../lib/core/src/lib/card-view/models/card-view-baseitem.model.ts) class and implement the [`CardViewItem`](../../../lib/core/src/lib/card-view/interfaces/card-view-item.interface.ts) + and [`DynamicComponentModel`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts) interfaces. See the [Card View Text Item model source](https://github.com/Alfresco/alfresco-ng2-components/blob/develop/lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) for an example of how to do this. diff --git a/docs/core/interfaces/datatable-adapter.interface.md b/docs/core/interfaces/datatable-adapter.interface.md index 4f90862cb3..c5f36acd2b 100644 --- a/docs/core/interfaces/datatable-adapter.interface.md +++ b/docs/core/interfaces/datatable-adapter.interface.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [DataTableAdapter interface](lib/core/src/lib/datatable/data/datatable-adapter.ts "Defined in datatable-adapter.ts") +# [DataTableAdapter interface](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts "Defined in datatable-adapter.ts") Defines how table data is supplied to [DataTable](../components/datatable.component.md) and [Tasklist](../../process-services/components/task-list.component.md) components. @@ -12,28 +12,28 @@ Defines how table data is supplied to [DataTable](../components/datatable.compon | Name | Type | Description | | ---- | ---- | ----------- | -| selectedRow | [`DataRow`](lib/core/src/lib/datatable/data/data-row.model.ts) | The data for the currently selected row. | +| selectedRow | [`DataRow`](../../../lib/core/src/lib/datatable/data/data-row.model.ts) | The data for the currently selected row. | ## Events | Name | Type | Description | | ---- | ---- | ----------- | -| rowsChanged | [`Subject>`](lib/core/src/lib/datatable/data/data-row.model.ts) | Raised when data adapter gets new rows. | +| rowsChanged | [`Subject>`](../../../lib/core/src/lib/datatable/data/data-row.model.ts) | Raised when data adapter gets new rows. | ## Methods -[`getRows(): Array;`](lib/core/src/lib/datatable/data/data-row.model.ts)
-[`setRows(rows: Array): void;`](lib/core/src/lib/datatable/data/data-row.model.ts)
+[`getRows(): Array;`](../../../lib/core/src/lib/datatable/data/data-row.model.ts)
+[`setRows(rows: Array): void;`](../../../lib/core/src/lib/datatable/data/data-row.model.ts)
Get/set the values for display in the table using an array of rows. -[`getColumns(): Array;`](lib/core/src/lib/datatable/data/data-column.model.ts)
-[`setColumns(columns: Array): void;`](lib/core/src/lib/datatable/data/data-column.model.ts)
+[`getColumns(): Array;`](../../../lib/core/src/lib/datatable/data/data-column.model.ts)
+[`setColumns(columns: Array): void;`](../../../lib/core/src/lib/datatable/data/data-column.model.ts)
Get/set an array of column specifications. `getValue(row:`[`DataRow,`](lib/core/src/lib/datatable/data/data-row.model.ts)`col: DataColumn): any;`
Get the data value from a specific table cell. -`getSorting():`[`DataSorting`](lib/core/src/lib/datatable/data/data-sorting.model.ts)`;`
+`getSorting():`[`DataSorting`](../../../lib/core/src/lib/datatable/data/data-sorting.model.ts)`;`
`setSorting(sorting: DataSorting): void;`
Get/set the sorting key and direction (ascending or descending). @@ -42,22 +42,22 @@ Sort the table with a specified key and direction (ascending or descending). ## Details -You can implement [`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts) in your own class to display your data with the [DataTable](../components/datatable.component.md) +You can implement [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) in your own class to display your data with the [DataTable](../components/datatable.component.md) and [Tasklist](../../process-services/components/task-list.component.md) components. -This interface (along with other interfaces for column and row data) hides the details of your class from the caller, so you can store your data internally however you like. The DataTable library implements the interface in the [`ObjectDataTableAdapter`](lib/core/src/lib/datatable/data/object-datatable-adapter.ts) class which is the standard adapter for the Datatable component. +This interface (along with other interfaces for column and row data) hides the details of your class from the caller, so you can store your data internally however you like. The DataTable library implements the interface in the [`ObjectDataTableAdapter`](../../../lib/core/src/lib/datatable/data/object-datatable-adapter.ts) class which is the standard adapter for the Datatable component. -The basic idea of [`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts) is that the caller can request your class to return an array of column +The basic idea of [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) is that the caller can request your class to return an array of column definition objects. Each of these objects specifies the unique key, name, type and other properties of a single column. The caller can also request the data values for the table as an array of row objects. The caller accesses the data from a row using a `getValue` method that returns the data from a specified column. This column is identified by the unique key that was set during the column definition. -The data-hiding works the other way around when the caller needs to set data in the [`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts) class - the internal +The data-hiding works the other way around when the caller needs to set data in the [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) class - the internal details of the caller's storage are hidden by the column and row interfaces. When the `setColumns` and `setRows` methods are called on the adapter, it can simply query the column/row objects it receives and then store the data in its own format. ### Columns and rows -Columns are defined by the [`DataColumn`](lib/core/src/lib/datatable/data/data-column.model.ts) interface: +Columns are defined by the [`DataColumn`](../../../lib/core/src/lib/datatable/data/data-column.model.ts) interface: ```ts interface DataColumn { @@ -76,7 +76,7 @@ interface DataColumn { An array of these objects is passed to your object when the `setColumns` method is called. The `key` property is used to identify columns and so each column's key should be unique. The `type` string can have a value of 'text', 'image' or 'date'. -An array of [`DataRow`](lib/core/src/lib/datatable/data/data-row.model.ts) objects is passed to your object when the `setRows` method is called: +An array of [`DataRow`](../../../lib/core/src/lib/datatable/data/data-row.model.ts) objects is passed to your object when the `setRows` method is called: ```ts interface DataRow { @@ -93,7 +93,7 @@ Each row contains a set of values. An item in the set is retrieved by passing it ### ObjectDataTableAdapter The DataTable library provides a implementation of [DataTableAdapter,](lib/core/src/lib/datatable/data/datatable-adapter.ts) called -[`ObjectDataTableAdapter`](lib/core/src/lib/datatable/data/object-datatable-adapter.ts). This is a simple adapter that binds to object arrays and turns object fields into columns: +[`ObjectDataTableAdapter`](../../../lib/core/src/lib/datatable/data/object-datatable-adapter.ts). This is a simple adapter that binds to object arrays and turns object fields into columns: ```ts let data = new ObjectDataTableAdapter( diff --git a/docs/core/interfaces/form-field-validator.interface.md b/docs/core/interfaces/form-field-validator.interface.md index 932de6c245..1a3699fba5 100644 --- a/docs/core/interfaces/form-field-validator.interface.md +++ b/docs/core/interfaces/form-field-validator.interface.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [FormFieldValidator interface](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts "Defined in form-field-validator.ts") +# [FormFieldValidator interface](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts "Defined in form-field-validator.ts") Defines how the input fields of [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) and Task Details components are validated. @@ -62,16 +62,16 @@ Several validator classes are predefined for you to use: | Validator name | Checks that: | | -------------- | ------------ | -| [`RequiredFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field is not left blank | -| [`NumberFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field contains numeric data | -| [`MinLengthFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field text has at least a minimum number of characters | -| [`MaxLengthFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field text has no more than a maximum number of characters | -| [`MinValueFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Numeric field's value is greater than a lower limit | -| [`MaxValueFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Numeric field's vaue is less than an upper limit | -| [`RegExFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field text matches a regular expression | -| [`DateFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field contains a date in the correct format | -| [`MinDateFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Date within a field occurs after a certain starting point | -| [`MaxDateFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Date within a field occurs before a certain end point | +| [`RequiredFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field is not left blank | +| [`NumberFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field contains numeric data | +| [`MinLengthFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field text has at least a minimum number of characters | +| [`MaxLengthFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field text has no more than a maximum number of characters | +| [`MinValueFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Numeric field's value is greater than a lower limit | +| [`MaxValueFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Numeric field's vaue is less than an upper limit | +| [`RegExFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field text matches a regular expression | +| [`DateFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Field contains a date in the correct format | +| [`MinDateFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Date within a field occurs after a certain starting point | +| [`MaxDateFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) | Date within a field occurs before a certain end point | The `FORM_FIELD_VALIDATORS` array contains an instance of each of these classes. You can assign this to the `fieldValidators` property of a [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) or [Task Details component](../../process-services/components/task-details.component.md) to enable standard validation. @@ -83,7 +83,7 @@ the form (currency values adding up to a given total, say). The `type` property of [`FormFieldModel`](../../core/models/form-field.model.md) is often used in the `isSupported` function, since validation methods typically apply only to specific types of data. -The [`FormFieldTypes`](lib/core/src/lib/form/components/widgets/core/form-field-types.ts) +The [`FormFieldTypes`](../../../lib/core/src/lib/form/components/widgets/core/form-field-types.ts) class defines convenient constants for the type strings. The validator in the example diff --git a/docs/core/interfaces/search-configuration.interface.md b/docs/core/interfaces/search-configuration.interface.md index 9d388f8737..97b10c19aa 100644 --- a/docs/core/interfaces/search-configuration.interface.md +++ b/docs/core/interfaces/search-configuration.interface.md @@ -4,7 +4,7 @@ Added: v2.1.0 Status: Active --- -# [Search Configuration interface](lib/core/src/lib/interface/search-configuration.interface.ts "Defined in search-configuration.interface.ts") +# [Search Configuration interface](../../../lib/core/src/lib/interface/search-configuration.interface.ts "Defined in search-configuration.interface.ts") Provides fine control of parameters to a search. diff --git a/docs/core/models/bpm-user.model.md b/docs/core/models/bpm-user.model.md index 9c9fb45924..bc9b8c70db 100644 --- a/docs/core/models/bpm-user.model.md +++ b/docs/core/models/bpm-user.model.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [Bpm User model](lib/core/src/lib/models/bpm-user.model.ts "Defined in bpm-user.model.ts") +# [Bpm User model](../../../lib/core/src/lib/models/bpm-user.model.ts "Defined in bpm-user.model.ts") Contains information about a Process Services user. diff --git a/docs/core/models/ecm-user.model.md b/docs/core/models/ecm-user.model.md index c647a6042c..23782e6689 100644 --- a/docs/core/models/ecm-user.model.md +++ b/docs/core/models/ecm-user.model.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [Ecm User model](lib/core/src/lib/models/ecm-user.model.ts "Defined in ecm-user.model.ts") +# [Ecm User model](../../../lib/core/src/lib/models/ecm-user.model.ts "Defined in ecm-user.model.ts") Contains information about a Content Services user. diff --git a/docs/core/models/form-field.model.md b/docs/core/models/form-field.model.md index a849fb312b..ffee2a75ce 100644 --- a/docs/core/models/form-field.model.md +++ b/docs/core/models/form-field.model.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-03-20 --- -# [Form Field model](lib/core/src/lib/form/components/widgets/core/form-field.model.ts "Defined in form-field.model.ts") +# [Form Field model](../../../lib/core/src/lib/form/components/widgets/core/form-field.model.ts "Defined in form-field.model.ts") Contains the value and metadata for a field of a [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) component. @@ -30,7 +30,7 @@ Contains the value and metadata for a field of a [`Form`](../../../lib/process-s | minValue | string | | Minimum allowed value (eg, for number or date) | | maxValue | string | | Minimum allowed value (eg, for number or date) | | regexPattern | string | | Regular expression that text data should match | -| options | [`FormFieldOption`](lib/core/src/lib/form/components/widgets/core/form-field-option.ts)\[] | \[] | Option items for a dropdown menu | +| options | [`FormFieldOption`](../../../lib/core/src/lib/form/components/widgets/core/form-field-option.ts)\[] | \[] | Option items for a dropdown menu | | restUrl | string | | URL for a REST call to populate a dropdown menu | | restResponsePath | string | | Path within REST response JSON to the array of dropdown data | | restIdProperty | string | | JSON property name to use for the `id` property of a dropdown item | @@ -38,19 +38,19 @@ Contains the value and metadata for a field of a [`Form`](../../../lib/process-s | hasEmptyValue | boolean | | Is the field's value empty? (eg, dropdown with no item selected) | | className | string | | CSS class name for the field | | optionType | string | | | -| params | [`FormFieldMetadata`](lib/core/src/lib/form/components/widgets/core/form-field-metadata.ts) | {} | | +| params | [`FormFieldMetadata`](../../../lib/core/src/lib/form/components/widgets/core/form-field-metadata.ts) | {} | | | hyperlinkUrl | string | | URL for Hyperlink widgets | | displayText | string | | Displayed text for Hyperlink widgets | | isVisible | boolean | true | Is the field shown on the form? | -| visibilityCondition | [`WidgetVisibilityModel`](lib/core/src/lib/form/models/widget-visibility.model.ts) | null | Defines a expression that determines whether the field is visible or not, based on its logical relation to values in other fields | +| visibilityCondition | [`WidgetVisibilityModel`](../../../lib/core/src/lib/form/models/widget-visibility.model.ts) | null | Defines a expression that determines whether the field is visible or not, based on its logical relation to values in other fields | | enableFractions | boolean | false | Are numeric values allowed to contain a decimal point? | | currency | string | null | Currency symbol for Amount widgets | | dateDisplayFormat | string | | Date/time display format template | | numberOfColumns | number | 1 | Number of columns defined by a container field | | fields | [`FormFieldModel`](../../core/models/form-field.model.md)\[] | \[] | Fields contained within a container field | -| columns | [`ContainerColumnModel`](lib/core/src/lib/form/components/widgets/core/container-column.model.ts)\[] | \[] | Column definitions for a container field | -| emptyOption | [`FormFieldOption`](lib/core/src/lib/form/components/widgets/core/form-field-option.ts) | | Dropdown menu item to use when no option is chosen | -| validationSummary | string | | Error/information message added during field validation (see [`FormFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) interface) | +| columns | [`ContainerColumnModel`](../../../lib/core/src/lib/form/components/widgets/core/container-column.model.ts)\[] | \[] | Column definitions for a container field | +| emptyOption | [`FormFieldOption`](../../../lib/core/src/lib/form/components/widgets/core/form-field-option.ts) | | Dropdown menu item to use when no option is chosen | +| validationSummary | string | | Error/information message added during field validation (see [`FormFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) interface) | ## Details @@ -73,7 +73,7 @@ check to a field. A number of [`FormFieldModel`](../../core/models/form-field.mo example, `minValue` and `maxValue` are used to check that a numeric value falls within an allowed range and `regexPattern` defines a regular expression that a text field should match. Also, the `validationSummary` is used to send a message back from the validator -for the user to read. See the [`FormFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) page for more information about implementing validators. +for the user to read. See the [`FormFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) page for more information about implementing validators. ### REST properties @@ -97,6 +97,6 @@ contains full details about how the REST calls work, along with a worked example ## See also - [Extensibility](../../user-guide/extensibility.md) -- [`FormFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) +- [`FormFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) - [Form rendering service](../services/form-rendering.service.md) - [Form component](../components/form.component.md) diff --git a/docs/core/models/product-version.model.md b/docs/core/models/product-version.model.md index 608a33ea2c..3d342871fe 100644 --- a/docs/core/models/product-version.model.md +++ b/docs/core/models/product-version.model.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [Product Version model](lib/core/src/lib/models/product-version.model.ts "Defined in product-version.model.ts") +# [Product Version model](../../../lib/core/src/lib/models/product-version.model.ts "Defined in product-version.model.ts") Contains version and license information classes for Alfresco products. diff --git a/docs/core/models/user-process.model.md b/docs/core/models/user-process.model.md index 212700df39..2fffa56a8d 100644 --- a/docs/core/models/user-process.model.md +++ b/docs/core/models/user-process.model.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [User Process model](lib/core/src/lib/models/user-process.model.ts "Defined in user-process.model.ts") +# [User Process model](../../../lib/core/src/lib/models/user-process.model.ts "Defined in user-process.model.ts") Represents a Process Services user. diff --git a/docs/core/pipes/app-config.pipe.md b/docs/core/pipes/app-config.pipe.md index e9b0793df8..2bb3638dd9 100644 --- a/docs/core/pipes/app-config.pipe.md +++ b/docs/core/pipes/app-config.pipe.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-05-24 --- -# [App Config Pipe](lib/core/src/lib/app-config/app-config.pipe.ts "Defined in app-config.pipe.ts") +# [App Config Pipe](../../../lib/core/src/lib/app-config/app-config.pipe.ts "Defined in app-config.pipe.ts") Retrieves values from the application configuration file directly. diff --git a/docs/core/pipes/decimal-number.pipe.md b/docs/core/pipes/decimal-number.pipe.md index 6780e2844d..643ec3aa19 100644 --- a/docs/core/pipes/decimal-number.pipe.md +++ b/docs/core/pipes/decimal-number.pipe.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-08-05 --- -# [Decimal Number Pipe](lib/core/src/lib/pipes/decimal-number.pipe.ts "Defined in decimal-number.pipe.ts") +# [Decimal Number Pipe](../../../lib/core/src/lib/pipes/decimal-number.pipe.ts "Defined in decimal-number.pipe.ts") Transforms a number to have a certain amount of digits in its integer part and also in its decimal part. @@ -15,7 +15,7 @@ Transforms a number to have a certain amount of digits in its integer part and a | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| digitsInfo | [`DecimalNumberModel`](lib/core/src/lib/models/decimal-number.model.ts) | | A format to apply to the date value. [Date Pipe Formats.](https://angular.io/api/common/DatePipe#custom-format-options) | +| digitsInfo | [`DecimalNumberModel`](../../../lib/core/src/lib/models/decimal-number.model.ts) | | A format to apply to the date value. [Date Pipe Formats.](https://angular.io/api/common/DatePipe#custom-format-options) | | locale | string | 'en-US' | A locale id for the locale format rules to use. | ## Details @@ -30,7 +30,7 @@ This pipe transforms a given number so it follows the set configuration for the } ``` -You can also overwrite this config by passing a [`DecimalNumberModel`](lib/core/src/lib/models/decimal-number.model.ts) as an argument for this pipe. +You can also overwrite this config by passing a [`DecimalNumberModel`](../../../lib/core/src/lib/models/decimal-number.model.ts) as an argument for this pipe. The number can be also localized so it applies commas and dots in the right place depending on the locale id in use. diff --git a/docs/core/pipes/file-size.pipe.md b/docs/core/pipes/file-size.pipe.md index 8125a9fbf5..b417ec1045 100644 --- a/docs/core/pipes/file-size.pipe.md +++ b/docs/core/pipes/file-size.pipe.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# [File Size pipe](lib/core/src/lib/pipes/file-size.pipe.ts "Defined in file-size.pipe.ts") +# [File Size pipe](../../../lib/core/src/lib/pipes/file-size.pipe.ts "Defined in file-size.pipe.ts") Converts a number of bytes to the equivalent in KB, MB, etc. diff --git a/docs/core/pipes/format-space.pipe.md b/docs/core/pipes/format-space.pipe.md index 4d4b6b8a24..ec326a0943 100644 --- a/docs/core/pipes/format-space.pipe.md +++ b/docs/core/pipes/format-space.pipe.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-27 --- -# [Format Space pipe](lib/core/src/lib/pipes/format-space.pipe.ts "Defined in format-space.pipe.ts") +# [Format Space pipe](../../../lib/core/src/lib/pipes/format-space.pipe.ts "Defined in format-space.pipe.ts") Replaces all the white space in a string with a supplied character. diff --git a/docs/core/pipes/full-name.pipe.md b/docs/core/pipes/full-name.pipe.md index 289da5bab6..4e793c477b 100644 --- a/docs/core/pipes/full-name.pipe.md +++ b/docs/core/pipes/full-name.pipe.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-12 --- -# [Full name pipe](lib/core/src/lib/pipes/full-name.pipe.ts "Defined in full-name.pipe.ts") +# [Full name pipe](../../../lib/core/src/lib/pipes/full-name.pipe.ts "Defined in full-name.pipe.ts") Joins the first and last name properties from a [`UserProcessModel`](../../core/models/user-process.model.md) object into a single string. diff --git a/docs/core/pipes/localized-date.pipe.md b/docs/core/pipes/localized-date.pipe.md index 0e5014a4a1..143f852e6a 100644 --- a/docs/core/pipes/localized-date.pipe.md +++ b/docs/core/pipes/localized-date.pipe.md @@ -4,7 +4,7 @@ Added: v3.3.0 Status: Active --- -# [Localized Date pipe](lib/core/src/lib/pipes/localized-date.pipe.ts "Defined in localized-date.pipe.ts") +# [Localized Date pipe](../../../lib/core/src/lib/pipes/localized-date.pipe.ts "Defined in localized-date.pipe.ts") Converts a date to a given format and locale. diff --git a/docs/core/pipes/mime-type-icon.pipe.md b/docs/core/pipes/mime-type-icon.pipe.md index 68b5d0584c..146c2af181 100644 --- a/docs/core/pipes/mime-type-icon.pipe.md +++ b/docs/core/pipes/mime-type-icon.pipe.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [Mime Type Icon pipe](lib/core/src/lib/pipes/mime-type-icon.pipe.ts "Defined in mime-type-icon.pipe.ts") +# [Mime Type Icon pipe](../../../lib/core/src/lib/pipes/mime-type-icon.pipe.ts "Defined in mime-type-icon.pipe.ts") Retrieves an icon to represent a MIME type. diff --git a/docs/core/pipes/multi-value.pipe.md b/docs/core/pipes/multi-value.pipe.md index 6e5916568f..5da79c221e 100644 --- a/docs/core/pipes/multi-value.pipe.md +++ b/docs/core/pipes/multi-value.pipe.md @@ -4,9 +4,9 @@ Added: v3.2.0 Status: Active --- -# [Multi Value Pipe](lib/core/src/lib/pipes/multi-value.pipe.ts "Defined in multi-value.pipe.ts") +# [Multi Value Pipe](../../../lib/core/src/lib/pipes/multi-value.pipe.ts "Defined in multi-value.pipe.ts") -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. +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. ## Basic Usage diff --git a/docs/core/pipes/node-name-tooltip.pipe.md b/docs/core/pipes/node-name-tooltip.pipe.md index 648b102f97..94677efd19 100644 --- a/docs/core/pipes/node-name-tooltip.pipe.md +++ b/docs/core/pipes/node-name-tooltip.pipe.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [Node Name Tooltip pipe](lib/content-services/src/lib/pipes/node-name-tooltip.pipe.ts "Defined in node-name-tooltip.pipe.ts") +# [Node Name Tooltip pipe](../../../lib/content-services/src/lib/pipes/node-name-tooltip.pipe.ts "Defined in node-name-tooltip.pipe.ts") Formats the tooltip for a [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md). diff --git a/docs/core/pipes/text-highlight.pipe.md b/docs/core/pipes/text-highlight.pipe.md index 07f30afa0d..0f12f77409 100644 --- a/docs/core/pipes/text-highlight.pipe.md +++ b/docs/core/pipes/text-highlight.pipe.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [Text Highlight pipe](lib/core/src/lib/pipes/text-highlight.pipe.ts "Defined in text-highlight.pipe.ts") +# [Text Highlight pipe](../../../lib/core/src/lib/pipes/text-highlight.pipe.ts "Defined in text-highlight.pipe.ts") Adds highlighting to words or sections of text that match a search string. diff --git a/docs/core/pipes/time-ago.pipe.md b/docs/core/pipes/time-ago.pipe.md index 4455fef828..2d8328339f 100644 --- a/docs/core/pipes/time-ago.pipe.md +++ b/docs/core/pipes/time-ago.pipe.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# [Time Ago pipe](lib/core/src/lib/pipes/time-ago.pipe.ts "Defined in time-ago.pipe.ts") +# [Time Ago pipe](../../../lib/core/src/lib/pipes/time-ago.pipe.ts "Defined in time-ago.pipe.ts") Converts a recent past date into a number of days ago. diff --git a/docs/core/pipes/user-initial.pipe.md b/docs/core/pipes/user-initial.pipe.md index e5cee287dd..2488d97722 100644 --- a/docs/core/pipes/user-initial.pipe.md +++ b/docs/core/pipes/user-initial.pipe.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-12 --- -# [User Initial pipe](lib/core/src/lib/pipes/user-initial.pipe.ts "Defined in user-initial.pipe.ts") +# [User Initial pipe](../../../lib/core/src/lib/pipes/user-initial.pipe.ts "Defined in user-initial.pipe.ts") Takes the name fields of a [`UserProcessModel`](../../core/models/user-process.model.md) object and extracts and formats the initials. diff --git a/docs/core/services/activiti-alfresco.service.md b/docs/core/services/activiti-alfresco.service.md index 572ba2b6e6..c1211cdaef 100644 --- a/docs/core/services/activiti-alfresco.service.md +++ b/docs/core/services/activiti-alfresco.service.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [APS Alfresco Content Service](lib/process-services/src/lib/form/services/activiti-alfresco.service.ts "Defined in activiti-alfresco.service.ts") +# [APS Alfresco Content Service](../../../lib/process-services/src/lib/form/services/activiti-alfresco.service.ts "Defined in activiti-alfresco.service.ts") Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). diff --git a/docs/core/services/alfresco-api.service.md b/docs/core/services/alfresco-api.service.md index 0247818add..f93d7bd0c0 100644 --- a/docs/core/services/alfresco-api.service.md +++ b/docs/core/services/alfresco-api.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-17 --- -# [Alfresco Api Service](lib/core/src/lib/services/alfresco-api.service.ts "Defined in alfresco-api.service.ts") +# [Alfresco Api Service](../../../lib/core/src/lib/services/alfresco-api.service.ts "Defined in alfresco-api.service.ts") Provides access to an initialized **AlfrescoJSApi** instance. diff --git a/docs/core/services/app-config.service.md b/docs/core/services/app-config.service.md index 517e560b02..160d2fbcaa 100644 --- a/docs/core/services/app-config.service.md +++ b/docs/core/services/app-config.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-09-13 --- -# [App Config service](lib/core/src/lib/app-config/app-config.service.ts "Defined in app-config.service.ts") +# [App Config service](../../../lib/core/src/lib/app-config/app-config.service.ts "Defined in app-config.service.ts") Supports app configuration settings, stored server side. @@ -30,10 +30,10 @@ Supports app configuration settings, stored server side. - **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
Loads the config file. - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - Notification when loading is complete -- **loadWellKnown**(hostIdp: `string`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`OpenidConfiguration`](../../../lib/core/services/openid-configuration.interface.ts)`>`
+- **loadWellKnown**(hostIdp: `string`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`OpenidConfiguration`](../../../lib/core/src/lib/services/openid-configuration.interface.ts)`>`
Call the discovery API to fetch configuration - _hostIdp:_ `string` - - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`OpenidConfiguration`](../../../lib/core/services/openid-configuration.interface.ts)`>` - Discovery configuration + - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`OpenidConfiguration`](../../../lib/core/src/lib/services/openid-configuration.interface.ts)`>` - Discovery configuration - **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Requests notification of a property value when it is loaded. - _property:_ `string` - The desired property value diff --git a/docs/core/services/apps-process.service.md b/docs/core/services/apps-process.service.md index d87abd5e56..cf06f0abf7 100644 --- a/docs/core/services/apps-process.service.md +++ b/docs/core/services/apps-process.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-16 --- -# [Apps Process service](lib/core/src/lib/services/apps-process.service.ts "Defined in apps-process.service.ts") +# [Apps Process service](../../../lib/core/src/lib/services/apps-process.service.ts "Defined in apps-process.service.ts") Gets details of the Process Services apps that are deployed for the user. diff --git a/docs/core/services/auth-guard-bpm.service.md b/docs/core/services/auth-guard-bpm.service.md index c58df30ddd..bc883978f3 100644 --- a/docs/core/services/auth-guard-bpm.service.md +++ b/docs/core/services/auth-guard-bpm.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# [Auth Guard Bpm service](lib/core/src/lib/services/auth-guard-bpm.service.ts "Defined in auth-guard-bpm.service.ts") +# [Auth Guard Bpm service](../../../lib/core/src/lib/auth/guard/auth-guard-bpm.service.ts "Defined in auth-guard-bpm.service.ts") Adds authentication with Process Services to a route within the app. diff --git a/docs/core/services/auth-guard-ecm.service.md b/docs/core/services/auth-guard-ecm.service.md index 91d672d38b..3dbbc2362a 100644 --- a/docs/core/services/auth-guard-ecm.service.md +++ b/docs/core/services/auth-guard-ecm.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# [Auth Guard Ecm service](lib/core/src/lib/services/auth-guard-ecm.service.ts "Defined in auth-guard-ecm.service.ts") +# [Auth Guard Ecm service](../../../lib/core/src/lib/auth/guard/auth-guard-ecm.service.ts "Defined in auth-guard-ecm.service.ts") Adds authentication with Content Services to a route within the app. diff --git a/docs/core/services/auth-guard-sso-role.service.md b/docs/core/services/auth-guard-sso-role.service.md index f704d44d6c..4a480d942c 100644 --- a/docs/core/services/auth-guard-sso-role.service.md +++ b/docs/core/services/auth-guard-sso-role.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-03-19 --- -# [Auth Guard SSO role service](lib/core/src/lib/services/auth-guard-sso-role.service.ts "Defined in auth-guard-sso-role.service.ts") +# [Auth Guard SSO role service](../../../lib/core/src/lib/auth/guard/auth-guard-sso-role.service.ts "Defined in auth-guard-sso-role.service.ts") Checks the user roles of a user. @@ -16,7 +16,8 @@ The [Auth Guard SSO role service](../../core/services/auth-guard-sso-role.servic to check the user has the right realms/client roles permission. This is typically used with the `canActivate` guard check in the route definition. The Auth Guard SSO is resposible to check if the JWT contains Realm roles (realm_access) or Client roles (resource_access) based on the route configuration. -*Realms role Example* +_Realms role Example_ + ```ts const appRoutes: Routes = [ ... @@ -33,8 +34,8 @@ const appRoutes: Routes = [ If the user now clicks on a link or button that follows this route, they will be not able to access this content if they do not have the Realms roles. Additionally, the user will not be able to access the resource when they have a role that is part of the excludedRoles array.
**Notes**: An additional role ALFRESCO_ADMINISTRATORS can be used in the roles array, which will result in checking whether the logged in user has Content Admin capabilities or not, as this role is not part of the JWT token it will call a Content API to determine it. - Client role Example + ```ts const appRoutes: Routes = [ ... diff --git a/docs/core/services/auth-guard.service.md b/docs/core/services/auth-guard.service.md index 87c595c474..f2aef9f193 100644 --- a/docs/core/services/auth-guard.service.md +++ b/docs/core/services/auth-guard.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# [Auth Guard service](lib/core/src/lib/services/auth-guard.service.ts "Defined in auth-guard.service.ts") +# [Auth Guard service](../../../lib/core/src/lib/auth/guard/auth-guard.service.ts "Defined in auth-guard.service.ts") Adds authentication to a route within the app. diff --git a/docs/core/services/authentication.service.md b/docs/core/services/authentication.service.md index 7d45f88a1c..59e8ee1cd4 100644 --- a/docs/core/services/authentication.service.md +++ b/docs/core/services/authentication.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-03-19 --- -# [Authentication Service](lib/core/src/lib/services/authentication.service.ts "Defined in authentication.service.ts") +# [Authentication Service](../../../lib/core/src/lib/auth/services/authentication.service.ts "Defined in authentication.service.ts") Provides authentication to ACS and APS. @@ -20,9 +20,6 @@ Provides authentication to ACS and APS. - **getBearerExcludedUrls**(): `string[]`
Gets the set of URLs that the token bearer is excluded from. - **Returns** `string[]` - Array of URL strings -- **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>`
- 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`
Gets the BPM username - **Returns** `string` - The BPM username @@ -93,9 +90,9 @@ Provides authentication to ACS and APS. - **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Logs the user out. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Response event called when logout is complete -- **setRedirect**(url: [`RedirectionModel`](lib/core/src/lib/models/redirection.model.ts))
+- **setRedirect**(url: [`RedirectionModel`](../../../lib/core/src/lib/auth/models/redirection.model.ts))
Sets the URL to redirect to after login. - - _url:_ [`RedirectionModel`](lib/core/src/lib/models/redirection.model.ts) - URL to redirect to + - _url:_ [`RedirectionModel`](../../../lib/core/src/lib/auth/models/redirection.model.ts) - URL to redirect to - **ssoImplicitLogin**()
Logs the user in with SSO diff --git a/docs/core/services/bpm-user.service.md b/docs/core/services/bpm-user.service.md index 7d2ff947c4..eecd15d319 100644 --- a/docs/core/services/bpm-user.service.md +++ b/docs/core/services/bpm-user.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# [Bpm User service](lib/core/src/lib/services/bpm-user.service.ts "Defined in bpm-user.service.ts") +# [Bpm User service](../../../lib/core/src/lib/services/bpm-user.service.ts "Defined in bpm-user.service.ts") Gets information about the current Process Services user. diff --git a/docs/core/services/card-item-types.service.md b/docs/core/services/card-item-types.service.md index 54fe4a8312..bc3cbb4d7e 100644 --- a/docs/core/services/card-item-types.service.md +++ b/docs/core/services/card-item-types.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Card Item Type service](lib/core/src/lib/card-view/services/card-item-types.service.ts "Defined in card-item-types.service.ts") +# [Card Item Type service](../../../lib/core/src/lib/card-view/services/card-item-types.service.ts "Defined in card-item-types.service.ts") Maps type names to field component types for the [Card View component](../components/card-view.component.md). @@ -13,44 +13,44 @@ Maps type names to field component types for the [Card View component](../compon ### Methods -- **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](lib/core/src/lib/services/dynamic-component-mapper.service.ts)
- Gets the currently active [DynamicComponentResolveFunction](lib/core/src/lib/services/dynamic-component-mapper.service.ts) for a field type. +- **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts)
+ Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want - _defaultValue:_ `Type` - Default type returned for types that are not yet mapped - - **Returns** [`DynamicComponentResolveFunction`](lib/core/src/lib/services/dynamic-component-mapper.service.ts) - Resolver function + - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts) - Resolver function - **register**(components: `Function`, override: `boolean` = `false`)
Register multiple components - _components:_ `Function` - - _override:_ `boolean` - -- **resolveComponentType**(model: [`DynamicComponentModel`](lib/core/src/lib/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
+- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
Finds the component type that is needed to render a form field. - - _model:_ [`DynamicComponentModel`](lib/core/src/lib/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 + - _model:_ [`DynamicComponentModel`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render - _defaultValue:_ `Type` - Default type returned for field types that are not yet mapped. - **Returns** `Type` - Component type -- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](lib/core/src/lib/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
- Sets or optionally replaces a [DynamicComponentResolveFunction](lib/core/src/lib/services/dynamic-component-mapper.service.ts) for a field type. +- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
+ Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want to set - - _resolver:_ [`DynamicComponentResolveFunction`](lib/core/src/lib/services/dynamic-component-mapper.service.ts) - The new resolver function + - _resolver:_ [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/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 The [Card View component](../components/card-view.component.md) uses this service to find the component type that is required to display a particular field type (text, date, etc). The service -maps a type name string to a corresponding [`DynamicComponentResolveFunction`](lib/core/src/lib/services/dynamic-component-mapper.service.ts) that takes a +maps a type name string to a corresponding [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts) that takes a model object as a parameter and returns the component type needed to display that model. The default mapping is shown below: | Type string | Component | | ----------- | --------- | -| 'text' | [`CardViewTextItemComponent`](lib/core/src/lib/card-view/components/card-view-textitem/card-view-textitem.component.ts) | -| 'int' | [`CardViewTextItemComponent`](lib/core/src/lib/card-view/components/card-view-textitem/card-view-textitem.component.ts) | -| 'float' | [`CardViewTextItemComponent`](lib/core/src/lib/card-view/components/card-view-textitem/card-view-textitem.component.ts) | -| 'date' | [`CardViewDateItemComponent`](lib/core/src/lib/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | -| 'datetime' | [`CardViewDateItemComponent`](lib/core/src/lib/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | -| 'bool' | [`CardViewBoolItemComponent`](lib/core/src/lib/card-view/components/card-view-boolitem/card-view-boolitem.component.ts) | -| 'map' | [`CardViewMapItemComponent`](lib/core/src/lib/card-view/components/card-view-mapitem/card-view-mapitem.component.ts) | +| 'text' | [`CardViewTextItemComponent`](../../../lib/core/src/lib/card-view/components/card-view-textitem/card-view-textitem.component.ts) | +| 'int' | [`CardViewTextItemComponent`](../../../lib/core/src/lib/card-view/components/card-view-textitem/card-view-textitem.component.ts) | +| 'float' | [`CardViewTextItemComponent`](../../../lib/core/src/lib/card-view/components/card-view-textitem/card-view-textitem.component.ts) | +| 'date' | [`CardViewDateItemComponent`](../../../lib/core/src/lib/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | +| 'datetime' | [`CardViewDateItemComponent`](../../../lib/core/src/lib/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | +| 'bool' | [`CardViewBoolItemComponent`](../../../lib/core/src/lib/card-view/components/card-view-boolitem/card-view-boolitem.component.ts) | +| 'map' | [`CardViewMapItemComponent`](../../../lib/core/src/lib/card-view/components/card-view-mapitem/card-view-mapitem.component.ts) | ### Adding new type mappings diff --git a/docs/core/services/clipboard.service.md b/docs/core/services/clipboard.service.md index fb3a2dba92..75f2b2d4cf 100644 --- a/docs/core/services/clipboard.service.md +++ b/docs/core/services/clipboard.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-04-12 --- -# [Clipboard service](lib/core/src/lib/clipboard/clipboard.service.ts "Defined in clipboard.service.ts") +# [Clipboard service](../../../lib/core/src/lib/clipboard/clipboard.service.ts "Defined in clipboard.service.ts") Copies text to the clipboard. diff --git a/docs/core/services/comment-content.service.md b/docs/core/services/comment-content.service.md index c533618013..dd026b939a 100644 --- a/docs/core/services/comment-content.service.md +++ b/docs/core/services/comment-content.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-04-12 --- -# [Comment Content service](lib/core/src/lib/services/comment-content.service.ts "Defined in comment-content.service.ts") +# [Comment Content service](../../../lib/core/src/lib/services/comment-content.service.ts "Defined in comment-content.service.ts") Adds and retrieves comments for nodes in Content Services. @@ -13,15 +13,15 @@ Adds and retrieves comments for nodes in Content Services. ### Methods -- **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
+- **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>`
Adds a comment to a node. - _nodeId:_ `string` - ID of the target node - _message:_ `string` - Text for the comment - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added -- **getNodeComments**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>` - Details of the comment added +- **getNodeComments**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>`
Gets all comments that have been added to a node. - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>` - Details for each comment ## Details diff --git a/docs/core/services/comment-process.service.md b/docs/core/services/comment-process.service.md index 502415b73c..1793fd0838 100644 --- a/docs/core/services/comment-process.service.md +++ b/docs/core/services/comment-process.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# [Comment Process service](lib/core/src/lib/services/comment-process.service.ts "Defined in comment-process.service.ts") +# [Comment Process service](../../../lib/core/src/lib/services/comment-process.service.ts "Defined in comment-process.service.ts") Adds and retrieves comments for task and process instances in Process Services. @@ -13,24 +13,24 @@ Adds and retrieves comments for task and process instances in Process Services. ### Methods -- **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
+- **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>`
Adds a comment to a process instance. - _processInstanceId:_ `string` - ID of the target process instance - _message:_ `string` - Text for the comment - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added -- **addTaskComment**(taskId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>` - Details of the comment added +- **addTaskComment**(taskId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>`
Adds a comment to a task. - _taskId:_ `string` - ID of the target task - _message:_ `string` - Text for the comment - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details about the comment -- **getProcessInstanceComments**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`>` - Details about the comment +- **getProcessInstanceComments**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>`
Gets all comments that have been added to a process instance. - _processInstanceId:_ `string` - ID of the target process instance - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment -- **getTaskComments**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>` - Details for each comment +- **getTaskComments**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/models/comment.model.ts)`[]>`
Gets all comments that have been added to a task. - _taskId:_ `string` - ID of the target task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/src/lib/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 a7e42dc82c..9e28fc77f9 100644 --- a/docs/core/services/content.service.md +++ b/docs/core/services/content.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-03-13 --- -# [Content service](lib/core/src/lib/services/content.service.ts "Defined in content.service.ts") +# [Content service](../../../lib/core/src/lib/services/content.service.ts "Defined in content.service.ts") Accesses app-generated data objects via URLs and file downloads. @@ -18,7 +18,7 @@ Accesses app-generated data objects via URLs and file downloads. - _blob:_ [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) - Data to wrap into object URL - **Returns** `string` - URL string - **downloadBlob**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob), fileName: `string`)
- (**Deprecated:** in 3.2.0, use [DownloadService](lib/core/src/lib/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.) + (**Deprecated:** in 3.2.0, use [DownloadService](../../../lib/core/src/lib/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. - **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`
@@ -42,15 +42,15 @@ Accesses app-generated data objects via URLs and file downloads. Gets content for the given node. - _nodeId:_ `string` - ID of the target node - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Content data -- **hasAllowableOperations**(node: `Node`, allowableOperation: [`AllowableOperationsEnum`](lib/core/src/lib/models/allowable-operations.enum.ts)`|string`): `boolean`
+- **hasAllowableOperations**(node: `Node`, allowableOperation: [`AllowableOperationsEnum`](../../../lib/core/src/lib/models/allowable-operations.enum.ts)`|string`): `boolean`
Checks if the user has permissions on that node - _node:_ `Node` - Node to check allowableOperations - - _allowableOperation:_ [`AllowableOperationsEnum`](lib/core/src/lib/models/allowable-operations.enum.ts)`|string` - Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions + - _allowableOperation:_ [`AllowableOperationsEnum`](../../../lib/core/src/lib/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/src/lib/models/permissions.enum.ts)`|string`, userId?: `string`): `boolean`
+- **hasPermissions**(node: `Node`, permission: [`PermissionsEnum`](../../../lib/core/src/lib/models/permissions.enum.ts)`|string`, userId?: `string`): `boolean`
Checks if the user has permission on that node - _node:_ `Node` - Node to check permissions - - _permission:_ [`PermissionsEnum`](lib/core/src/lib/models/permissions.enum.ts)`|string` - Required permission type + - _permission:_ [`PermissionsEnum`](../../../lib/core/src/lib/models/permissions.enum.ts)`|string` - Required permission type - _userId:_ `string` - (Optional) Optional current user id will be taken by default - **Returns** `boolean` - True if the user has the required permissions, false otherwise diff --git a/docs/core/services/cookie.service.md b/docs/core/services/cookie.service.md index 8f2d3fe714..fdc7c6eaaa 100644 --- a/docs/core/services/cookie.service.md +++ b/docs/core/services/cookie.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# [Cookie service](lib/core/src/lib/services/cookie.service.ts "Defined in cookie.service.ts") +# [Cookie service](../../../lib/core/src/lib/common/services/cookie.service.ts "Defined in cookie.service.ts") Stores key-value data items as browser cookies. diff --git a/docs/core/services/deleted-nodes-api.service.md b/docs/core/services/deleted-nodes-api.service.md index 6e009dc94d..fc0040899e 100644 --- a/docs/core/services/deleted-nodes-api.service.md +++ b/docs/core/services/deleted-nodes-api.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-04-05 --- -# [Deleted Nodes Api service](lib/core/src/lib/services/deleted-nodes-api.service.ts "Defined in deleted-nodes-api.service.ts") +# [Deleted Nodes Api service](../../../lib/core/src/lib/services/deleted-nodes-api.service.ts "Defined in deleted-nodes-api.service.ts") Gets a list of Content Services nodes currently in the trash. diff --git a/docs/core/services/discovery-api.service.md b/docs/core/services/discovery-api.service.md index 2af461fec8..299df2bf42 100644 --- a/docs/core/services/discovery-api.service.md +++ b/docs/core/services/discovery-api.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# [Discovery Api service](lib/core/src/lib/services/discovery-api.service.ts "Defined in discovery-api.service.ts") +# [Discovery Api service](../../../lib/core/src/lib/services/discovery-api.service.ts "Defined in discovery-api.service.ts") Gets version and license information for Process Services and Content Services. @@ -17,12 +17,12 @@ Gets version and license information for Process Services and Content Services. - **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)`>`
+- **getBpmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/src/lib/models/product-version.model.ts)`>`
Gets product information for Process Services. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details -- **getEcmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/src/lib/models/product-version.model.ts)`>` - ProductVersionModel containing product details +- **getEcmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RepositoryInfo`](../../../lib/core/src/lib/about/about-repository-info/repository-info.interface.ts)`>`
Gets product information for Content Services. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - ProductVersionModel containing product details + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RepositoryInfo`](../../../lib/core/src/lib/about/about-repository-info/repository-info.interface.ts)`>` - ProductVersionModel containing product details ## Details diff --git a/docs/core/services/download-zip.service.md b/docs/core/services/download-zip.service.md index 251fc6c4a8..7657a49afc 100644 --- a/docs/core/services/download-zip.service.md +++ b/docs/core/services/download-zip.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-08 --- -# [Download zip service](lib/core/src/lib/services/download-zip.service.ts "Defined in download-zip.service.ts") +# [Download zip service](../../../lib/core/src/lib/services/download-zip.service.ts "Defined in download-zip.service.ts") Creates and manages downloads. diff --git a/docs/core/services/ecm-user.service.md b/docs/core/services/ecm-user.service.md index 3927e61bfe..a4366cab52 100644 --- a/docs/core/services/ecm-user.service.md +++ b/docs/core/services/ecm-user.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# [Ecm User service](lib/core/src/lib/services/ecm-user.service.ts "Defined in ecm-user.service.ts") +# [Ecm User service](../../../lib/core/src/lib/services/ecm-user.service.ts "Defined in ecm-user.service.ts") Gets information about a Content Services user. diff --git a/docs/core/services/favorites-api.service.md b/docs/core/services/favorites-api.service.md index cf62c7adca..f955268201 100644 --- a/docs/core/services/favorites-api.service.md +++ b/docs/core/services/favorites-api.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-05-04 --- -# [Favorites Api service](lib/core/src/lib/services/favorites-api.service.ts "Defined in favorites-api.service.ts") +# [Favorites Api service](../../../lib/core/src/lib/services/favorites-api.service.ts "Defined in favorites-api.service.ts") Gets a list of items a user has marked as their favorites. diff --git a/docs/core/services/form-rendering.service.md b/docs/core/services/form-rendering.service.md index 6c04536197..b415b334e6 100644 --- a/docs/core/services/form-rendering.service.md +++ b/docs/core/services/form-rendering.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-20 --- -# [Form Rendering service](../../../lib/core/form/services/form-rendering.service.ts "Defined in form-rendering.service.ts") +# [Form Rendering service](../../../lib/core/src/lib/form/services/form-rendering.service.ts "Defined in form-rendering.service.ts") Maps a form field type string onto the corresponding form [widget component](../../insights/components/widget.component.md) type. @@ -13,24 +13,24 @@ Maps a form field type string onto the corresponding form [widget component](../ ### Methods -- **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)
- Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. +- **getComponentTypeResolver**(type: `string`, defaultValue: `Type` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts)
+ Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts) for a field type. - _type:_ `string` - The type whose resolver you want - _defaultValue:_ `Type` - Default type returned for types that are not yet mapped - - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function + - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts) - Resolver function - **register**(components: `Function`, override: `boolean` = `false`)
Register multiple components - _components:_ `Function` - - _override:_ `boolean` - -- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
+- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts), defaultValue: `Type` = `this.defaultValue`): `Type`
Finds the component type that is needed to render a form field. - - _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render + - _model:_ [`DynamicComponentModel`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render - _defaultValue:_ `Type` - Default type returned for field types that are not yet mapped. - **Returns** `Type` - Component type -- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
- Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. +- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)
+ Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/src/lib/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 + - _resolver:_ [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/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 @@ -38,7 +38,7 @@ Maps a form field type string onto the corresponding form [widget component](../ The [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Field component uses this service to choose which [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to use to render an instance of a form field. The [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Field model stores the field type name as a string (see the table below). The [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Rendering service maintains a mapping between each type name and -a corresponding [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts). The function takes a [`FormFieldModel`](../../core/models/form-field.model.md) object as its argument and +a corresponding [`DynamicComponentResolveFunction`](../../../lib/core/src/lib/services/dynamic-component-mapper.service.ts). The function takes a [`FormFieldModel`](../../core/models/form-field.model.md) object as its argument and uses the data from the object to determine which [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) should be used to render the field. In some cases, the field type string alone is enough to determine the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) type and so the function @@ -68,24 +68,24 @@ The [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.t | 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) | +| Amount | "amount" | [`AmountWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/amount/amount.widget.ts) | +| Attach | "upload" | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/upload/upload.widget.ts) (based on metadata) | +| Checkbox | "boolean" | [`CheckboxWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/checkbox/checkbox.widget.ts) | +| Date | "date" | [`DateWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/date/date.widget.ts) | | Display text | "readonly-text" | [`DisplayTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) | -| Display Rich text | "display-rich-text" | [`DisplayRichTextWidgetComponent`](lib/core/src/lib/form/components/widgets/display-rich-text/display-rich-text.widget.ts) | +| Display Rich text | "display-rich-text" | [`DisplayRichTextWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/display-rich-text/display-rich-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) | +| Dropdown | "dropdown" | [`DropdownWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/dropdown/dropdown.widget.ts) | +| Dynamic table | "dynamic-table" | [`DynamicTableWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/dynamic-table/dynamic-table.widget.ts) | +| Group of people | "functional-group" | [`FunctionalGroupWidgetComponent`](../../../lib/process-services/src/lib/form/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) | +| Hyperlink | "hyperlink" | [`HyperlinkWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/hyperlink/hyperlink.widget.ts) | +| Multi-line text | "multi-line-text" | [`MultilineTextWidgetComponentComponent`](../../../lib/core/src/lib/form/components/widgets/multiline-text/multiline-text.widget.ts) | +| Number | "integer" | [`NumberWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/number/number.widget.ts) | +| People | "people" | [`PeopleWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/people/people.widget.ts) | +| Radio buttons | "radio-buttons" | [`RadioButtonsWidgetComponent`](../../../lib/process-services/src/lib/form/widgets/radio-buttons/radio-buttons.widget.ts) | +| Text | "text" | [`TextWidgetComponent`](../../../lib/core/src/lib/form/components/widgets/text/text.widget.ts) | +| Typeahead | "typeahead" | [`TypeaheadWidgetComponent`](../../../lib/process-services/src/lib/form/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. diff --git a/docs/core/services/form.service.md b/docs/core/services/form.service.md index 1bcf280fac..ece7e71fc5 100644 --- a/docs/core/services/form.service.md +++ b/docs/core/services/form.service.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [Form service](lib/core/src/lib/form/services/form.service.ts "Defined in form.service.ts") +# [Form service](../../../lib/core/src/lib/form/services/form.service.ts "Defined in form.service.ts") Implements Process Services form methods @@ -39,20 +39,20 @@ class MyComponent { | Name | Args Type | Description | | ---- | --------- | ----------- | -| formLoaded | [`FormEvent`](lib/core/src/lib/form/events/form.event.ts) | Raised when form has been loaded or reloaded | -| formFieldValueChanged | [`FormFieldEvent`](lib/core/src/lib/form/events/form-field.event.ts) | Raised when input values change | -| taskCompleted | [`FormEvent`](lib/core/src/lib/form/events/form.event.ts) | Raised when a task is completed successfully | -| taskCompletedError | [`FormErrorEvent`](lib/core/src/lib/form/events/form-error.event.ts) | Raised when a task is completed unsuccessfully | -| taskSaved | [`FormEvent`](lib/core/src/lib/form/events/form.event.ts) | Raised when a task is saved successfully | -| taskSavedError | [`FormErrorEvent`](lib/core/src/lib/form/events/form-error.event.ts) | Raised when a task is saved unsuccessfully | -| executeOutcome | [`FormOutcomeEvent`](lib/core/src/lib/form/components/widgets/core/form-outcome-event.model.ts) | Raised when a form outcome is executed | +| formLoaded | [`FormEvent`](../../../lib/core/src/lib/form/events/form.event.ts) | Raised when form has been loaded or reloaded | +| formFieldValueChanged | [`FormFieldEvent`](../../../lib/core/src/lib/form/events/form-field.event.ts) | Raised when input values change | +| taskCompleted | [`FormEvent`](../../../lib/core/src/lib/form/events/form.event.ts) | Raised when a task is completed successfully | +| taskCompletedError | [`FormErrorEvent`](../../../lib/core/src/lib/form/events/form-error.event.ts) | Raised when a task is completed unsuccessfully | +| taskSaved | [`FormEvent`](../../../lib/core/src/lib/form/events/form.event.ts) | Raised when a task is saved successfully | +| taskSavedError | [`FormErrorEvent`](../../../lib/core/src/lib/form/events/form-error.event.ts) | Raised when a task is saved unsuccessfully | +| executeOutcome | [`FormOutcomeEvent`](../../../lib/core/src/lib/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/src/lib/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/src/lib/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. | +| validateForm | [`ValidateFormEvent`](../../../lib/core/src/lib/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/src/lib/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/src/lib/form/components/widgets/core/form-values.ts)`readOnly: boolean = false):`[`FormModel`](lib/core/src/lib/form/components/widgets/core/form.model.ts) +- `parseForm(json: any, data?:`[`FormValues,`](lib/core/src/lib/form/components/widgets/core/form-values.ts)`readOnly: boolean = false):`[`FormModel`](../../../lib/core/src/lib/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 @@ -179,7 +179,7 @@ class MyComponent { - `filter` - Filter to select specific users - `groupId` - (Optional) Group ID for the search -- [`getWorkflowGroups(filter: string, groupId?: string): Observable`](lib/core/src/lib/form/components/widgets/core/group.model.ts) +- [`getWorkflowGroups(filter: string, groupId?: string): Observable`](../../../lib/core/src/lib/form/components/widgets/core/group.model.ts) Gets a list of groups in a workflow. - `filter` - Filter to select specific groups diff --git a/docs/core/services/highlight-transform.service.md b/docs/core/services/highlight-transform.service.md index 9cd454a8cd..1e3e1e8f4a 100644 --- a/docs/core/services/highlight-transform.service.md +++ b/docs/core/services/highlight-transform.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# [Highlight Transform service](lib/core/src/lib/services/highlight-transform.service.ts "Defined in highlight-transform.service.ts") +# [Highlight Transform service](../../../lib/core/src/lib/services/highlight-transform.service.ts "Defined in highlight-transform.service.ts") Adds HTML to a string to highlight chosen sections. @@ -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/src/lib/services/highlight-transform.service.ts)
+- **highlight**(text: `string`, search: `string`, wrapperClass: `string` = `"adf-highlight"`): [`HighlightTransformResult`](../../../lib/core/src/lib/services/highlight-transform.service.ts)
Searches for `search` string(s) within `text` and highlights all occurrences. - _text:_ `string` - Text to search within - _search:_ `string` - Text pattern to search for - _wrapperClass:_ `string` - CSS class used to provide highlighting style - - **Returns** [`HighlightTransformResult`](lib/core/src/lib/services/highlight-transform.service.ts) - New text along with boolean value to indicate whether anything was highlighted + - **Returns** [`HighlightTransformResult`](../../../lib/core/src/lib/services/highlight-transform.service.ts) - New text along with boolean value to indicate whether anything was highlighted ## Details @@ -33,7 +33,7 @@ highlight any of those words individually. The <span> element includes a `class` attribute which defaults to "highlight" but you can pass any class name you like using the `wrapperClass` parameter. -The resulting text with HTML highlighting is returned within a [`HighlightTransformResult`](lib/core/src/lib/services/highlight-transform.service.ts) +The resulting text with HTML highlighting is returned within a [`HighlightTransformResult`](../../../lib/core/src/lib/services/highlight-transform.service.ts) object: ```ts diff --git a/docs/core/services/identity-group.service.md b/docs/core/services/identity-group.service.md index 5e83956a38..3d955de0a1 100644 --- a/docs/core/services/identity-group.service.md +++ b/docs/core/services/identity-group.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-07-13 --- -# [Identity Group service](lib/core/src/lib/services/identity-group.service.ts "Defined in identity-group.service.ts") +# [Identity Group service](../../../lib/process-services-cloud/src/lib/group/services/identity-group.service.ts "Defined in identity-group.service.ts") Performs CRUD operations on identity groups. @@ -13,84 +13,11 @@ Performs CRUD operations on identity groups. ### Methods -- **assignRoles**(groupId: `string`, roles: [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Assigns roles to the group - - _groupId:_ `string` - The ID of the group - - _roles:_ [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]` - Array of roles to assign - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - -- **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Check if a group has any of the client app roles in the supplied list. - - _groupId:_ `string` - Id of the target group - - _clientId:_ `string` - Id of the client - - _roleNames:_ `string[]` - Array of role names to check - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise -- **checkGroupHasClientApp**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Checks if a group has a client app. - - _groupId:_ `string` - Id of the target group - - _clientId:_ `string` - Id of the client - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has the client app, false otherwise -- **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Check that a group has one or more roles from the supplied list. - - _groupId:_ `string` - Id of the target group - - _roleNames:_ `string[]` - Array of role names - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the group has one or more of the roles, false otherwise -- **createGroup**(newGroup: [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Creates new group. - - _newGroup:_ [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts) - Object of containing the new group details. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group created. -- **deleteGroup**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Deletes Group. - - _groupId:_ `string` - Id of the group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group deleted. -- **findGroupsByName**(searchParams: [`IdentityGroupSearchParam`](lib/core/src/lib/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`
- Finds groups filtered by name. - - _searchParams:_ [`IdentityGroupSearchParam`](lib/core/src/lib/models/identity-group.model.ts) - Object containing the name filter string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - List of group information -- **getAssignedRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
- Gets assigned roles - - _groupId:_ `string` - Id of the group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles -- **getAvailableRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
- 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)``
- Gets the client Id using the app name. - - _applicationName:_ `string` - Name of the app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - client Id string -- **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
- 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)`[]>`
- 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)`[]>`
- 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)`[]>`
- 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)`>`
- 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/src/lib/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupQueryResponse`](../../../lib/core/models/identity-group.model.ts)`>`
- Queries groups. - - _requestQuery:_ [`IdentityGroupQueryCloudRequestModel`](lib/core/src/lib/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/src/lib/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Removes roles from the group - - _groupId:_ `string` - The ID of the group - - _roles:_ [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]` - Array of roles to remove - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - -- **updateGroup**(groupId: `string`, updatedGroup: [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Updates group details. - - _groupId:_ `string` - Id of the targeted group. - - _updatedGroup:_ [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts) - Object of containing the group details - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group updated. +- **search**(name: `string`, filters?: [`IdentityGroupFilterInterface`](../../../lib/process-services-cloud/src/lib/group/services/identity-group-filter.interface.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/process-services-cloud/src/lib/group/models/identity-group.model.ts)`[]>`
+ + - _name:_ `string` - + - _filters:_ [`IdentityGroupFilterInterface`](../../../lib/process-services-cloud/src/lib/group/services/identity-group-filter.interface.ts) - (Optional) + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/process-services-cloud/src/lib/group/models/identity-group.model.ts)`[]>` - ## See also diff --git a/docs/core/services/identity-role.service.md b/docs/core/services/identity-role.service.md index f719378058..3b21f1ac35 100644 --- a/docs/core/services/identity-role.service.md +++ b/docs/core/services/identity-role.service.md @@ -5,6 +5,6 @@ Status: Active Last reviewed: 2019-09-24 --- -# [Identity role service](lib/core/src/lib/services/identity-role.service.ts "Defined in identity-role.service.ts") +# [Identity role service](../../../lib/core/src/lib/auth/services/identity-role.service.ts "Defined in identity-role.service.ts") Provides APIs for working with the Roles in Identity Services. diff --git a/docs/core/services/identity-user.service.md b/docs/core/services/identity-user.service.md index d5a403c446..83f20e4369 100644 --- a/docs/core/services/identity-user.service.md +++ b/docs/core/services/identity-user.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-07-12 --- -# [Identity user service](lib/core/src/lib/services/identity-user.service.ts "Defined in identity-user.service.ts") +# [Identity user service](../../../lib/process-services-cloud/src/lib/people/services/identity-user.service.ts "Defined in identity-user.service.ts") Gets OAuth2 personal details and roles for users and performs CRUD operations on identity users. @@ -13,136 +13,14 @@ Gets OAuth2 personal details and roles for users and performs CRUD operations on ### Methods -- **assignRoles**(userId: `string`, roles: [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Assigns roles to the user. - - _userId:_ `string` - Id of the user. - - _roles:_ [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]` - Array of roles. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the role assigned. -- **changePassword**(userId: `string`, newPassword: [`IdentityUserPasswordModel`](lib/core/src/lib/services/identity-user.service.interface.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Changes user password. - - _userId:_ `string` - Id of the user. - - _newPassword:_ [`IdentityUserPasswordModel`](lib/core/src/lib/services/identity-user.service.interface.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the password changed. -- **checkUserHasAnyApplicationRole**(userId: `string`, applicationName: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Checks if a user has any application role. - - _userId:_ `string` - ID of the target user - - _applicationName:_ `string` - Name of the application - - _roleNames:_ `string[]` - List of role names to check for - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has one or more of the roles, false otherwise -- **checkUserHasAnyClientAppRole**(userId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Checks whether a user has any of the client app roles. - - _userId:_ `string` - ID of the target user - - _clientId:_ `string` - ID of the client app - - _roleNames:_ `string[]` - List of role names to check for - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has one or more of the roles, false otherwise -- **checkUserHasApplicationAccess**(userId: `string`, applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Checks if a user has access to an application. - - _userId:_ `string` - ID of the user - - _applicationName:_ `string` - Name of the application - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has access, false otherwise -- **checkUserHasClientApp**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Checks whether user has access to a client app. - - _userId:_ `string` - ID of the target user - - _clientId:_ `string` - ID of the client app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has access, false otherwise -- **checkUserHasRole**(userId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Checks if a user has one of the roles from a list. - - _userId:_ `string` - ID of the target user - - _roleNames:_ `string[]` - Array of roles to check for - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - True if the user has one of the roles, false otherwise -- **createUser**(newUser: [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Creates new user. - - _newUser:_ [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts) - Object containing the new user details. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user created. -- **deleteUser**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Deletes User. - - _userId:_ `string` - Id of the user. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user deleted. -- **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
- 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)``
- Find users based on id input. - - _id:_ `string` - Search query string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - users object -- **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
- 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)`[]>`
- 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)`[]>`
- 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)`[]>`
- 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)``
- Gets the client ID for an application. - - _applicationName:_ `string` - Name of the application - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Client ID string -- **getClientRoles**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Get client roles of a user for a particular client. - - _userId:_ `string` - ID of the target user - - _clientId:_ `string` - ID of the client app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of client roles -- **getCurrentUserInfo**(): [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts)
+- **getCurrentUserInfo**(): [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)
Gets the name and other basic details of the current user. - - **Returns** [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts) - The user's details -- **getEffectiveRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
- Gets effective roles. - - _userId:_ `string` - Id of the user. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of composite roles information objects -- **getInvolvedGroups**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`
- 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)``
- Gets users total count. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Number of users count. -- **getUserRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
- 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)`[]>`
- 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)`[]>`
- 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)`[]>`
- 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/src/lib/services/identity-user.service.interface.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Joins group. - - _joinGroupRequest:_ [`IdentityJoinGroupRequestModel`](lib/core/src/lib/services/identity-user.service.interface.ts) - Details of join group request (IdentityJoinGroupRequestModel). - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user joined the group. -- **leaveGroup**(userId: `any`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Leaves group. - - _userId:_ `any` - Id of the user. - - _groupId:_ `string` - Id of the group. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user left the group. -- **queryUsers**(requestQuery: [`IdentityUserQueryCloudRequestModel`](lib/core/src/lib/services/identity-user.service.interface.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserQueryResponse`](../../../lib/core/services/identity-user.service.interface.ts)`>`
- Gets details for all users. - - _requestQuery:_ [`IdentityUserQueryCloudRequestModel`](lib/core/src/lib/services/identity-user.service.interface.ts) - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserQueryResponse`](../../../lib/core/services/identity-user.service.interface.ts)`>` - Array of user information objects. -- **removeRoles**(userId: `string`, removedRoles: [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Removes assigned roles. - - _userId:_ `string` - Id of the user. - - _removedRoles:_ [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the role removed. -- **updateUser**(userId: `string`, updatedUser: [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Updates user details. - - _userId:_ `string` - Id of the user. - - _updatedUser:_ [`IdentityUserModel`](lib/core/src/lib/models/identity-user.model.ts) - Object containing the user details. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user updated. + - **Returns** [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts) - The user's details +- **search**(name: `string`, filters?: [`IdentityUserFilterInterface`](../../../lib/process-services-cloud/src/lib/people/services/identity-user-filter.interface.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)`[]>`
+ Search users based on name input and filters. + - _name:_ `string` - Search query string + - _filters:_ [`IdentityUserFilterInterface`](../../../lib/process-services-cloud/src/lib/people/services/identity-user-filter.interface.ts) - (Optional) + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)`[]>` - List of users ## See also diff --git a/docs/core/services/jwt-helper.service.md b/docs/core/services/jwt-helper.service.md index 3d83561ea8..2af37c91a7 100644 --- a/docs/core/services/jwt-helper.service.md +++ b/docs/core/services/jwt-helper.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-09 --- -# [JWT helper service](lib/core/src/lib/services/jwt-helper.service.ts "Defined in jwt-helper.service.ts") +# [JWT helper service](../../../lib/core/src/lib/auth/services/jwt-helper.service.ts "Defined in jwt-helper.service.ts") Decodes a JSON Web Token (JWT) to a JavaScript object. diff --git a/docs/core/services/log.service.md b/docs/core/services/log.service.md index e1d71bc431..87cfb53aec 100644 --- a/docs/core/services/log.service.md +++ b/docs/core/services/log.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Log Service](lib/core/src/lib/services/log.service.ts "Defined in log.service.ts") +# [Log Service](../../../lib/core/src/lib/common/services/log.service.ts "Defined in log.service.ts") Provides log functionality. @@ -64,10 +64,10 @@ export class AppComponent { 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/src/lib/models/log-levels.model.ts)
+- **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../../lib/core/src/lib/common/models/log-levels.model.ts)
Converts a log level name string into its numeric equivalent. - _level:_ `string` - Level name - - **Returns** [`LogLevelsEnum`](lib/core/src/lib/models/log-levels.model.ts) - Numeric log level + - **Returns** [`LogLevelsEnum`](../../../lib/core/src/lib/common/models/log-levels.model.ts) - Numeric log level - **group**(groupTitle?: `string`, optionalParams: `any[]`)
Starts an indented group of log messages. - _groupTitle:_ `string` - (Optional) Title shown at the start of the group diff --git a/docs/core/services/login-dialog.service.md b/docs/core/services/login-dialog.service.md index 7a06bd3c90..9a41dda9ad 100644 --- a/docs/core/services/login-dialog.service.md +++ b/docs/core/services/login-dialog.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-02-08 --- -# [Login Dialog service](lib/core/src/lib/services/login-dialog.service.ts "Defined in login-dialog.service.ts") +# [Login Dialog service](../../../lib/core/src/lib/services/login-dialog.service.ts "Defined in login-dialog.service.ts") Manages login dialogs. diff --git a/docs/core/services/nodes-api.service.md b/docs/core/services/nodes-api.service.md index dbc05e3996..568f058437 100644 --- a/docs/core/services/nodes-api.service.md +++ b/docs/core/services/nodes-api.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-16 --- -# [Nodes Api service](lib/core/src/lib/services/nodes-api.service.ts "Defined in nodes-api.service.ts") +# [Nodes Api service](../../../lib/core/src/lib/services/nodes-api.service.ts "Defined in nodes-api.service.ts") Accesses and manipulates ACS document nodes using their node IDs. @@ -66,10 +66,10 @@ Accesses and manipulates ACS document nodes using their node IDs. - _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)`>`
+- **getNodeMetadata**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/src/lib/models/node-metadata.model.ts)`>`
Get the metadata and the nodeType for a nodeId cleaned by the prefix. - _nodeId:_ `string` - ID of the target node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/models/node-metadata.model.ts)`>` - Node metadata + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/src/lib/models/node-metadata.model.ts)`>` - Node metadata - **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`
Restores a node previously moved to the trashcan. - _nodeId:_ `string` - ID of the node to restore diff --git a/docs/core/services/notification.service.md b/docs/core/services/notification.service.md index 27779c9b93..98ae83c1ca 100644 --- a/docs/core/services/notification.service.md +++ b/docs/core/services/notification.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Notification Service](lib/core/src/lib/notifications/services/notification.service.ts "Defined in notification.service.ts") +# [Notification Service](../../../lib/core/src/lib/notifications/services/notification.service.ts "Defined in notification.service.ts") Shows a notification message with optional feedback. @@ -17,42 +17,42 @@ Shows a notification message with optional feedback. - **dismissSnackMessageAction**()
dismiss the notification snackbar -- **openSnackMessage**(message: `string`, config?: `number|MatSnackBarConfig`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+- **openSnackMessage**(message: `string`, config?: `number|MatSnackBarConfig>`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Opens a SnackBar notification to show a message. - _message:_ `string` - The message (or resource key) to show. - - _config:_ `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object + - _config:_ `number|MatSnackBarConfig>` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar -- **openSnackMessageAction**(message: `string`, action: `string`, config?: `number|MatSnackBarConfig`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+- **openSnackMessageAction**(message: `string`, action: `string`, config?: `number|MatSnackBarConfig>`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Opens a SnackBar notification with a message and a response button. - _message:_ `string` - The message (or resource key) to show. - _action:_ `string` - Caption for the response button - - _config:_ `number|MatSnackBarConfig` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object + - _config:_ `number|MatSnackBarConfig>` - (Optional) Time before notification disappears after being shown or MatSnackBarConfig object - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar -- **pushToNotificationHistory**(notification: [`NotificationModel`](lib/core/src/lib/notifications/models/notification.model.ts))
+- **pushToNotificationHistory**(notification: [`NotificationModel`](../../../lib/core/src/lib/notifications/models/notification.model.ts))
Push new notification to Notification History - - _notification:_ [`NotificationModel`](lib/core/src/lib/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)``
+ - _notification:_ [`NotificationModel`](../../../lib/core/src/lib/notifications/models/notification.model.ts) - Notification model to be pushed. +- **showError**(message: `string`, action?: `string`, interpolateArgs?: `any`, showAction: `boolean` = `true`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Rase error message - _message:_ `string` - Text message or translation key for the message. - _action:_ `string` - (Optional) Action name - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - - _showError:_ `boolean` - (Optional) True if action should be visible, false if not. Default: true. + - _showAction:_ `boolean` - True if action should be visible, false if not. Default: true. - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - -- **showInfo**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+- **showInfo**(message: `string`, action?: `string`, interpolateArgs?: `any`, showAction: `boolean` = `true`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Rase info message - _message:_ `string` - Text message or translation key for the message. - _action:_ `string` - (Optional) Action name - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - - _showError:_ `boolean` - (Optional) True if action should be visible, false if not. Default: true. + - _showAction:_ `boolean` - True if action should be visible, false if not. Default: true. - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - -- **showWarning**(message: `string`, action?: `string`, interpolateArgs?: `any`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+- **showWarning**(message: `string`, action?: `string`, interpolateArgs?: `any`, showAction: `boolean` = `true`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
Rase warning message - _message:_ `string` - Text message or translation key for the message. - _action:_ `string` - (Optional) Action name - _interpolateArgs:_ `any` - (Optional) The interpolation parameters to add for the translation - - _showError:_ `boolean` - (Optional) True if action should be visible, false if not. Default: true. + - _showAction:_ `boolean` - True if action should be visible, false if not. Default: true. - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - ## Details diff --git a/docs/core/services/page-title.service.md b/docs/core/services/page-title.service.md index 7d756b3947..a2267411f4 100644 --- a/docs/core/services/page-title.service.md +++ b/docs/core/services/page-title.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-19 --- -# [Page Title service](lib/core/src/lib/services/page-title.service.ts "Defined in page-title.service.ts") +# [Page Title service](../../../lib/core/src/lib/services/page-title.service.ts "Defined in page-title.service.ts") Sets the page title. diff --git a/docs/core/services/people-content.service.md b/docs/core/services/people-content.service.md index 37c2770f86..f0909dc337 100644 --- a/docs/core/services/people-content.service.md +++ b/docs/core/services/people-content.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-04-06 --- -# [People Content service](lib/core/src/lib/services/people-content.service.ts "Defined in people-content.service.ts") +# [People Content service](../../../lib/core/src/lib/services/people-content.service.ts "Defined in people-content.service.ts") Gets information about a Content Services user. @@ -18,6 +18,10 @@ Gets information about a Content Services user. - _newPerson:_ [`PersonBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/model/personBodyCreate.ts) - Object containing the new person details. - _opts:_ `any` - (Optional) Optional parameters - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - Created new person +- **getCurrentPerson**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
+ + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - + - **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
Gets information about the current user alias -me- - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - User information @@ -32,10 +36,10 @@ Gets information about a Content Services user. - **isCurrentUserAdmin**(): `boolean`
Used to know if the current user has the admin capability - **Returns** `boolean` - true or false -- **listPeople**(requestQuery?: [`PeopleContentQueryRequestModel`](lib/core/src/lib/services/people-content.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`PeopleContentQueryResponse`](../../../lib/core/services/people-content.service.ts)`>`
+- **listPeople**(requestQuery?: [`PeopleContentQueryRequestModel`](../../../lib/core/src/lib/services/people-content.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`PeopleContentQueryResponse`](../../../lib/core/src/lib/services/people-content.service.ts)`>`
Gets a list of people. - - _requestQuery:_ [`PeopleContentQueryRequestModel`](lib/core/src/lib/services/people-content.service.ts) - (Optional) maxItems and skipCount parameters supported by JS-API - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`PeopleContentQueryResponse`](../../../lib/core/services/people-content.service.ts)`>` - Response containing pagination and list of entries + - _requestQuery:_ [`PeopleContentQueryRequestModel`](../../../lib/core/src/lib/services/people-content.service.ts) - (Optional) maxItems and skipCount parameters supported by JS-API + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`PeopleContentQueryResponse`](../../../lib/core/src/lib/services/people-content.service.ts)`>` - Response containing pagination and list of entries - **resetLocalCurrentUser**()
Reset the local current user object - **updatePerson**(personId: `string`, details: `PersonBodyUpdate`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`
diff --git a/docs/core/services/people-process.service.md b/docs/core/services/people-process.service.md index c16d54c4f3..a2b9fc7145 100644 --- a/docs/core/services/people-process.service.md +++ b/docs/core/services/people-process.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-04-05 --- -# [People Process service](lib/core/src/lib/services/people-process.service.ts "Defined in people-process.service.ts") +# [People Process service](../../../lib/core/src/lib/services/people-process.service.ts "Defined in people-process.service.ts") Gets information about Process Services users. @@ -17,10 +17,16 @@ Gets information about Process Services users. 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)`[]>`
+- **getWorkflowGroups**(filter: `string`, groupId?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupModel`](../../../lib/core/src/lib/form/components/widgets/core/group.model.ts)`[]>`
+ Gets a list of groups in a workflow. + - _filter:_ `string` - Filter to select specific groups + - _groupId:_ `string` - (Optional) Group ID for the search + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupModel`](../../../lib/core/src/lib/form/components/widgets/core/group.model.ts)`[]>` - Array of groups +- **getWorkflowUsers**(taskId?: `string`, searchWord?: `string`, groupId?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>`
Gets information about users across all tasks. - _taskId:_ `string` - (Optional) ID of the task - _searchWord:_ `string` - (Optional) Filter text to search for + - _groupId:_ `string` - (Optional) - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` - Array of user information objects - **involveUserWithTask**(taskId: `string`, idToInvolve: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>`
Sets a user to be involved with a task. diff --git a/docs/core/services/process-content.service.md b/docs/core/services/process-content.service.md index 06c358b72a..b3e821ac62 100644 --- a/docs/core/services/process-content.service.md +++ b/docs/core/services/process-content.service.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [Process Content Service](lib/process-services/src/lib/form/services/process-content.service.ts "Defined in process-content.service.ts") +# [Process Content Service](../../../lib/process-services/src/lib/form/services/process-content.service.ts "Defined in process-content.service.ts") Manipulates content related to a Process Instance or Task Instance in APS. diff --git a/docs/core/services/renditions.service.md b/docs/core/services/renditions.service.md index 580f9d85c9..733f8579cc 100644 --- a/docs/core/services/renditions.service.md +++ b/docs/core/services/renditions.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-23 --- -# [Renditions service](lib/core/src/lib/services/renditions.service.ts "Defined in renditions.service.ts") +# [Renditions service](../../../lib/core/src/lib/services/renditions.service.ts "Defined in renditions.service.ts") Manages prearranged conversions of content to different formats. diff --git a/docs/core/services/search-configuration.service.md b/docs/core/services/search-configuration.service.md index c23c478911..18f81e52a6 100644 --- a/docs/core/services/search-configuration.service.md +++ b/docs/core/services/search-configuration.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-09-13 --- -# [Search Configuration service](lib/core/src/lib/services/search-configuration.service.ts "Defined in search-configuration.service.ts") +# [Search Configuration service](../../../lib/core/src/lib/services/search-configuration.service.ts "Defined in search-configuration.service.ts") Provides fine control of parameters to a search. diff --git a/docs/core/services/search.service.md b/docs/core/services/search.service.md index 55ab854a60..db9ddca2dc 100644 --- a/docs/core/services/search.service.md +++ b/docs/core/services/search.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-12-03 --- -# [Search service](lib/core/src/lib/services/search.service.ts "Defined in search.service.ts") +# [Search service](../../../lib/core/src/lib/services/search.service.ts "Defined in search.service.ts") Accesses the Content Services Search API. @@ -13,10 +13,10 @@ Accesses the Content Services Search API. ### Methods -- **getNodeQueryResults**(term: `string`, options?: [`SearchOptions`](lib/core/src/lib/services/search.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
+- **getNodeQueryResults**(term: `string`, options?: [`SearchOptions`](../../../lib/core/src/lib/services/search.service.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`
Gets a list of nodes that match the given search criteria. - _term:_ `string` - Term to search for - - _options:_ [`SearchOptions`](lib/core/src/lib/services/search.service.ts) - (Optional) Options for delivery of the search results + - _options:_ [`SearchOptions`](../../../lib/core/src/lib/services/search.service.ts) - (Optional) Options for delivery of the search results - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes resulting from the search - **search**(searchTerm: `string`, maxResults: `number`, skipCount: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`
Performs a search. @@ -36,7 +36,7 @@ See the in the Alfresco JS-API for the format of the query and returned data. The [Search Configuration service](../services/search-configuration.service.md) has a method to generate the QueryBody object used by `searchByQueryBody`. The properties of the -[`SearchOptions`](lib/core/src/lib/services/search.service.ts) +[`SearchOptions`](../../../lib/core/src/lib/services/search.service.ts) interface are documented in source file comments. ## See also diff --git a/docs/core/services/shared-links-api.service.md b/docs/core/services/shared-links-api.service.md index 7005ceba5d..f7a41b79b4 100644 --- a/docs/core/services/shared-links-api.service.md +++ b/docs/core/services/shared-links-api.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-08 --- -# [Shared Links Api service](lib/core/src/lib/services/shared-links-api.service.ts "Defined in shared-links-api.service.ts") +# [Shared Links Api service](../../../lib/core/src/lib/services/shared-links-api.service.ts "Defined in shared-links-api.service.ts") Finds shared links to Content Services items. diff --git a/docs/core/services/storage.service.md b/docs/core/services/storage.service.md index b71a35fcb3..ca9c1c340f 100644 --- a/docs/core/services/storage.service.md +++ b/docs/core/services/storage.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-14 --- -# [Storage service](lib/core/src/lib/services/storage.service.ts "Defined in storage.service.ts") +# [Storage service](../../../lib/core/src/lib/common/services/storage.service.ts "Defined in storage.service.ts") Stores items in the form of key-value pairs. diff --git a/docs/core/services/thumbnail.service.md b/docs/core/services/thumbnail.service.md index 28783a6b60..2e2918962a 100644 --- a/docs/core/services/thumbnail.service.md +++ b/docs/core/services/thumbnail.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-03-20 --- -# [Thumbnail service](lib/core/src/lib/services/thumbnail.service.ts "Defined in thumbnail.service.ts") +# [Thumbnail service](../../../lib/core/src/lib/services/thumbnail.service.ts "Defined in thumbnail.service.ts") Retrieves an SVG thumbnail image to represent a document type. diff --git a/docs/core/services/translation.service.md b/docs/core/services/translation.service.md index 3a69ce771f..cd70142ab1 100644 --- a/docs/core/services/translation.service.md +++ b/docs/core/services/translation.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-02-08 --- -# [Translation service](lib/core/src/lib/services/translation.service.ts "Defined in translation.service.ts") +# [Translation service](../../../lib/core/src/lib/services/translation.service.ts "Defined in translation.service.ts") Supports localisation. diff --git a/docs/core/services/upload.service.md b/docs/core/services/upload.service.md index f9dfdc5ac6..3885cf1029 100644 --- a/docs/core/services/upload.service.md +++ b/docs/core/services/upload.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-16 --- -# [Upload Service](lib/core/src/lib/services/upload.service.ts "Defined in upload.service.ts") +# [Upload Service](../../../lib/core/src/lib/services/upload.service.ts "Defined in upload.service.ts") Provides access to various APIs related to file upload features. @@ -13,26 +13,26 @@ Provides access to various APIs related to file upload features. ### Methods -- **addToQueue**(files: [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]`): [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]`
+- **addToQueue**(files: [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]`): [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]`
Adds files to the uploading queue to be uploaded - - _files:_ [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]` - One or more separate parameters or an array of files to queue - - **Returns** [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]` - Array of files that were not blocked from upload by the ignore list -- **cancelUpload**(files: [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]`)
+ - _files:_ [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]` - One or more separate parameters or an array of files to queue + - **Returns** [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]` - Array of files that were not blocked from upload by the ignore list +- **cancelUpload**(files: [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]`)
Cancels uploading of files. If the file is smaller than 1 MB the file will be uploaded and then the node deleted to prevent having files that were aborted but still uploaded. - - _files:_ [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]` - One or more separate parameters or an array of files specifying uploads to cancel + - _files:_ [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]` - One or more separate parameters or an array of files specifying uploads to cancel - **clearCache**()
- **clearQueue**()
Clears the upload queue -- **getQueue**(): [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]`
+- **getQueue**(): [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]`
Gets the file Queue - - **Returns** [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]` - Array of files that form the queue + - **Returns** [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]` - Array of files that form the queue - **getThreadsCount**(): `number`
Returns the number of concurrent threads for uploading. - **Returns** `number` - Number of concurrent threads (default 1) -- **getUploadPromise**(file: [`FileModel`](lib/core/src/lib/models/file.model.ts)): `any`
+- **getUploadPromise**(file: [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)): `any`
Gets an upload promise for a file. - - _file:_ [`FileModel`](lib/core/src/lib/models/file.model.ts) - The target file + - _file:_ [`FileModel`](../../../lib/core/src/lib/models/file.model.ts) - The target file - **Returns** `any` - [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises) that is resolved if the upload is successful or error otherwise - **isUploading**(): `boolean`
Checks whether the service still has files uploading or awaiting upload. @@ -46,15 +46,15 @@ Provides access to various APIs related to file upload features. | Name | Type | Description | | ---- | ---- | ----------- | -| queueChanged | [`FileModel`](lib/core/src/lib/models/file.model.ts)\[] | Emitted when the file queue changes. | -| fileUpload | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when a [File model](lib/core/src/lib/models/file.model.ts) changes its state. | -| fileUploadStarting | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when an upload starts. | -| fileUploadCancelled | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when an upload gets cancelled by the user. | -| fileUploadProgress | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted during the file upload process and contains the current progress for a particular [File model](lib/core/src/lib/models/file.model.ts). | -| fileUploadAborted | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when a file upload gets aborted by the server. | -| fileUploadError | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when an error occurs during a file upload. | -| fileUploadComplete | [`FileUploadCompleteEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when a file upload is complete. | -| fileUploadDelete | [`FileUploadDeleteEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when an uploaded file is removed from server. | +| queueChanged | [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)\[] | Emitted when the file queue changes. | +| fileUpload | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when a [File model](lib/core/src/lib/models/file.model.ts) changes its state. | +| fileUploadStarting | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when an upload starts. | +| fileUploadCancelled | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when an upload gets cancelled by the user. | +| fileUploadProgress | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted during the file upload process and contains the current progress for a particular [File model](lib/core/src/lib/models/file.model.ts). | +| fileUploadAborted | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when a file upload gets aborted by the server. | +| fileUploadError | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when an error occurs during a file upload. | +| fileUploadComplete | [`FileUploadCompleteEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when a file upload is complete. | +| fileUploadDelete | [`FileUploadDeleteEvent`](../../../lib/core/src/lib/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 @@ -120,7 +120,7 @@ In this way all the files present in the .git folder won't be uploaded. ### Toggling Versioning Support -It is also possible to provide the `versioningEnabled` value as part of the [`FileUploadOptions`](lib/core/src/lib/models/file.model.ts) when using [upload service](../../core/services/upload.service.md) from the code. +It is also possible to provide the `versioningEnabled` value as part of the [`FileUploadOptions`](../../../lib/core/src/lib/models/file.model.ts) when using [upload service](../../core/services/upload.service.md) from the code. > Note: When creating a new node using multipart/form-data by default versioning is enabled and set to MAJOR Version. > Since Alfresco 6.2.3 versioningEnabled flag was introduced offering better control over the new node Versioning. diff --git a/docs/core/services/user-access.service.md b/docs/core/services/user-access.service.md index 3830ee210c..4b0ae5d791 100644 --- a/docs/core/services/user-access.service.md +++ b/docs/core/services/user-access.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2022-06-05 --- -# [User access service](lib/core/src/lib/services/user-access.service.ts "Defined in user-access.service.ts") +# [User access service](../../../lib/core/src/lib/services/user-access.service.ts "Defined in user-access.service.ts") Checks the global and application access of a user diff --git a/docs/core/services/user-preferences.service.md b/docs/core/services/user-preferences.service.md index 5161f0d5c0..1d8b5b5acb 100644 --- a/docs/core/services/user-preferences.service.md +++ b/docs/core/services/user-preferences.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-16 --- -# [User Preferences Service](lib/core/src/lib/services/user-preferences.service.ts "Defined in user-preferences.service.ts") +# [User Preferences Service](../../../lib/core/src/lib/common/services/user-preferences.service.ts "Defined in user-preferences.service.ts") Stores preferences for the app and for individual components. diff --git a/docs/core/widgets/content.widget.md b/docs/core/widgets/content.widget.md index 845c77da2a..f979057e1e 100644 --- a/docs/core/widgets/content.widget.md +++ b/docs/core/widgets/content.widget.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [APS Content Component](lib/process-services/src/lib/form/widgets/document/content.widget.ts "Defined in content.widget.ts") +# [APS Content Component](../../../lib/process-services/src/lib/form/widgets/document/content.widget.ts "Defined in content.widget.ts") Shows the content preview. diff --git a/docs/process-services-cloud/components/form-cloud.component.md b/docs/process-services-cloud/components/form-cloud.component.md index e6f0d65774..fd9cb17cf1 100644 --- a/docs/process-services-cloud/components/form-cloud.component.md +++ b/docs/process-services-cloud/components/form-cloud.component.md @@ -82,8 +82,8 @@ The template defined inside `empty-form` will be shown when no form definition i | 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/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | | [FormFieldValidator](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) allow to override the form field validators provided. | -| form | [`FormModel`](lib/core/src/lib/form/components/widgets/core/form.model.ts) | | Underlying form model instance. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | | [FormFieldValidator](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts) allow to override the form field validators provided. | +| form | [`FormModel`](../../../lib/core/src/lib/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. | @@ -101,13 +101,13 @@ The template defined inside `empty-form` will be shown when no form definition i | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | -| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/src/lib/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/src/lib/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/src/lib/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | +| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/src/lib/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. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/src/lib/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/src/lib/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | ## Details diff --git a/docs/process-services-cloud/components/group-cloud.component.md b/docs/process-services-cloud/components/group-cloud.component.md index cfaca348d0..892fb8dc72 100644 --- a/docs/process-services-cloud/components/group-cloud.component.md +++ b/docs/process-services-cloud/components/group-cloud.component.md @@ -38,13 +38,13 @@ Searches Groups. | 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 | +| groupChipsCtrl | `FormControl` | | FormControl to list of group | | mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | Group selection mode (single/multiple). | -| preSelectGroups | [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts)`[]` | \[] | Array of groups to be pre-selected. This pre-selects all groups in multi selection mode and only the first group of the array in single selection mode. | +| preSelectGroups | [`IdentityGroupModel`](../../../lib/process-services-cloud/src/lib/group/models/identity-group.model.ts)`[]` | \[] | Array of groups to be pre-selected. This pre-selects all groups in multi selection mode and only the first group of the array in single selection mode. | | readOnly | `boolean` | false | Show the info in readonly mode | | required | `boolean` | false | Mark this field as required | | roles | `string[]` | \[] | Role names of the groups to be listed. | -| searchGroupsControl | `FormControl` | | FormControl to search the group | +| 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. | @@ -52,9 +52,9 @@ Searches Groups. | Name | Type | Description | | ---- | ---- | ----------- | -| changedGroups | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` | Emitted when a group selection change. | -| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is removed. | -| selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is selected. | +| changedGroups | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/process-services-cloud/src/lib/group/models/identity-group.model.ts)`[]>` | Emitted when a group selection change. | +| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/process-services-cloud/src/lib/group/models/identity-group.model.ts)`>` | Emitted when a group is removed. | +| selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/process-services-cloud/src/lib/group/models/identity-group.model.ts)`>` | Emitted when a group is selected. | | warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | ## Details diff --git a/docs/process-services-cloud/components/people-cloud.component.md b/docs/process-services-cloud/components/people-cloud.component.md index 6139324ba2..3deabad3c0 100644 --- a/docs/process-services-cloud/components/people-cloud.component.md +++ b/docs/process-services-cloud/components/people-cloud.component.md @@ -26,25 +26,25 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu | 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/src/lib/models/identity-user.model.ts)`[]` | \[] | Array of users to be excluded. Mandatory properties are: id, email, username | +| excludedUsers | [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)`[]` | \[] | Array of users to be excluded. Mandatory properties are: id, email, username | | groupsRestriction | `string[]` | \[] | Array of groups to restrict user searches. Mandatory property is group name | | mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | User selection mode (single/multiple). | -| preSelectUsers | [`IdentityUserModel`](lib/core/src/lib/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 | +| preSelectUsers | [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/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 | | required | `boolean` | false | Mark this field as required | | roles | `string[]` | | Role names of the users to be listed. | -| searchUserCtrl | `FormControl` | | FormControl to search the user | +| searchUserCtrl | `FormControl` | | FormControl to search the user | | title | `string` | | Placeholder translation key | -| userChipsCtrl | `FormControl` | | FormControl to list of users | +| userChipsCtrl | `UntypedFormControl` | | FormControl to list of users | | validate | `boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. | -| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. | -| selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a user is selected. | +| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. | +| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. | +| selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts)`>` | Emitted when a user is selected. | | warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | ## Details 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 8e8e8e7339..19bff63cd0 100644 --- a/docs/process-services-cloud/components/process-list-cloud.component.md +++ b/docs/process-services-cloud/components/process-list-cloud.component.md @@ -84,11 +84,11 @@ when the process list is empty: | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/src/lib/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected. | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/src/lib/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/src/lib/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details 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 756df6d784..cd2052622b 100644 --- a/docs/process-services-cloud/components/start-process-cloud.component.md +++ b/docs/process-services-cloud/components/start-process-cloud.component.md @@ -51,7 +51,7 @@ Starts a process. | ---- | ---- | ----------- | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the starting process is cancelled | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/src/lib/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | | processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`>` | Emitted when process definition selection changes. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the process is successfully started. | 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 34ef3a5535..723e69b7cd 100644 --- a/docs/process-services-cloud/components/task-form-cloud.component.md +++ b/docs/process-services-cloud/components/task-form-cloud.component.md @@ -50,9 +50,11 @@ Save and Complete buttons get disabled when at least one of the form's inputs ar | ---- | ---- | ----------- | | cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is saved. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/src/lib/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/src/lib/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/src/lib/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/src/lib/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is saved. | +| onTaskLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` | | | taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | | taskCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | | taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed. | 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 2aa2d8c780..3afd2f18e7 100644 --- a/docs/process-services-cloud/components/task-list-cloud.component.md +++ b/docs/process-services-cloud/components/task-list-cloud.component.md @@ -91,11 +91,11 @@ when the task list is empty: | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/src/lib/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/src/lib/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/src/lib/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | ## Details @@ -215,8 +215,8 @@ The Tasklist also supports pagination as shown in the example below: ### DataTableAdapter example -See the [`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts) page for full details of the interface and its standard -implementation, [`ObjectDataTableAdapter`](lib/core/src/lib/datatable/data/object-datatable-adapter.ts). Below is an example of how you can set up the adapter for a +See the [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) page for full details of the interface and its standard +implementation, [`ObjectDataTableAdapter`](../../../lib/core/src/lib/datatable/data/object-datatable-adapter.ts). Below is an example of how you can set up the adapter for a typical tasklist. ```json @@ -230,7 +230,7 @@ typical tasklist. ### DataColumn Features -You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the [`DataColumn`](lib/core/src/lib/datatable/data/data-column.model.ts) page for more information about these features. +You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the [`DataColumn`](../../../lib/core/src/lib/datatable/data/data-column.model.ts) page for more information about these features. #### showRowContextMenu event diff --git a/docs/process-services-cloud/pipes/group-initial.pipe.md b/docs/process-services-cloud/pipes/group-initial.pipe.md index 3165f6b79f..1616b489e3 100644 --- a/docs/process-services-cloud/pipes/group-initial.pipe.md +++ b/docs/process-services-cloud/pipes/group-initial.pipe.md @@ -23,7 +23,7 @@ Extracts the initial character from a group name. ## Details -This pipe takes a [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts) +This pipe takes a [`IdentityGroupModel`](../../../lib/process-services-cloud/src/lib/group/models/identity-group.model.ts) object as its parameter and extracts the initial character from the `name` property. The initial is a handy way to identify the group in lists and other situations where there is limited screen space available. diff --git a/docs/process-services-cloud/services/form-cloud.service.md b/docs/process-services-cloud/services/form-cloud.service.md index 3dc7b83e01..3e7777659b 100644 --- a/docs/process-services-cloud/services/form-cloud.service.md +++ b/docs/process-services-cloud/services/form-cloud.service.md @@ -26,13 +26,13 @@ class MyComponent { ### Methods -- **completeTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](lib/core/src/lib/form/components/widgets/core/form-values.ts), outcome: `string`, version: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+- **completeTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/src/lib/form/components/widgets/core/form-values.ts), outcome: `string`, version: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Completes a task form. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the target task - _processInstanceId:_ `string` - ID of processInstance - _formId:_ `string` - ID of the form to complete - - _formValues:_ [`FormValues`](lib/core/src/lib/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object + - _formValues:_ [`FormValues`](../../../lib/core/src/lib/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 @@ -54,12 +54,12 @@ class MyComponent { - _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 -- **getRestWidgetData**(formName: `string`, widgetId: `string`, body: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormFieldOption`](../../../lib/core/form/components/widgets/core/form-field-option.ts)`[]>`
+- **getRestWidgetData**(formName: `string`, widgetId: `string`, body: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormFieldOption`](../../../lib/core/src/lib/form/components/widgets/core/form-field-option.ts)`[]>`
- _formName:_ `string` - - _widgetId:_ `string` - - _body:_ `any` - - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormFieldOption`](../../../lib/core/form/components/widgets/core/form-field-option.ts)`[]>` - + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormFieldOption`](../../../lib/core/src/lib/form/components/widgets/core/form-field-option.ts)`[]>` - - **getTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Gets details of a task @@ -77,19 +77,19 @@ class MyComponent { - _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/src/lib/form/components/widgets/core/form.model.ts)
+- **parseForm**(json: `any`, data?: [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]`, readOnly: `boolean` = `false`): [`FormModel`](../../../lib/core/src/lib/form/components/widgets/core/form.model.ts)
Parses JSON data to create a corresponding form. - _json:_ `any` - JSON data to create the form - _data:_ [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` - (Optional) Values for the form's fields - _readOnly:_ `boolean` - Toggles whether or not the form should be read-only - - **Returns** [`FormModel`](lib/core/src/lib/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/src/lib/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)`>`
+ - **Returns** [`FormModel`](../../../lib/core/src/lib/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/src/lib/form/components/widgets/core/form-values.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Saves a task form. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the target task - _processInstanceId:_ `string` - ID of processInstance - _formId:_ `string` - ID of the form to save - - _values:_ [`FormValues`](lib/core/src/lib/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object + - _values:_ [`FormValues`](../../../lib/core/src/lib/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 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 8577b273a2..5220ed3dfc 100644 --- a/docs/process-services-cloud/services/process-filter-cloud.service.md +++ b/docs/process-services-cloud/services/process-filter-cloud.service.md @@ -39,6 +39,11 @@ Manage Process Filters, which are pre-configured Process Instance queries. - _obj:_ `any` - - **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - +- **resetProcessFilterToDefaults**(appName: `string`, filter: [`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)`[]>`
+ Reset the process filters to the default configuration if it exists and stores it. If there is no default configuration for the process cloud filter with the provided filter name, then it changes nothing but stores the current values of the filter + - _appName:_ `string` - Name of the target app + - _filter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The process filter to be restored to defaults + - **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 - **updateFilter**(updatedFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`
Update process instance filter - _updatedFilter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - @@ -47,8 +52,8 @@ Manage Process Filters, which are pre-configured Process Instance queries. - _value:_ `any` - - _filterProperties:_ `string[]` - - - _appName:_ `string` - (Optional) - - _id:_ `string` - (Optional) + - _appName:_ `string` - (Optional) + - _id:_ `string` - (Optional) - **Returns** `any` - ## Inject Preference service 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 fa1f02abd0..d3f27ba494 100644 --- a/docs/process-services-cloud/services/process-list-cloud.service.md +++ b/docs/process-services-cloud/services/process-list-cloud.service.md @@ -13,6 +13,11 @@ Searches processes. ### Methods +- **getAdminProcessByRequest**(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)``
+ Finds a process using an object with optional query properties in admin app. + - _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)`` - Process information - **getBasePath**(appName: `string`): `string`
- _appName:_ `string` - 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 19b247e234..8bfb1fcef6 100644 --- a/docs/process-services-cloud/services/start-process-cloud.service.md +++ b/docs/process-services-cloud/services/start-process-cloud.service.md @@ -31,7 +31,7 @@ Gets process definitions and starts processes. - **getProcessDefinitions**(appName: `string`, queryParams?: `Function`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`
Gets the process definitions associated with an app. - _appName:_ `string` - Name of the target app - - _queryParams:_ `Function` - (Optional) + - _queryParams:_ `Function` - (Optional) - **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 - **getStartEventFormStaticValuesMapping**(appName: `string`, processDefinitionId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>`
Gets the static values mapped to the start form of a process definition. diff --git a/docs/process-services-cloud/services/task-cloud.service.md b/docs/process-services-cloud/services/task-cloud.service.md index 853fa96cc4..4f750b66da 100644 --- a/docs/process-services-cloud/services/task-cloud.service.md +++ b/docs/process-services-cloud/services/task-cloud.service.md @@ -76,11 +76,11 @@ Manages task cloud. - _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/src/lib/card-view/models/card-view-arrayitem.model.ts)`[]`, candidateGroups: [`CardViewArrayItem`](lib/core/src/lib/card-view/models/card-view-arrayitem.model.ts)`[]`): `boolean`
+- **isAssigneePropertyClickable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts), candidateUsers: [`CardViewArrayItem`](../../../lib/core/src/lib/card-view/models/card-view-arrayitem.model.ts)`[]`, candidateGroups: [`CardViewArrayItem`](../../../lib/core/src/lib/card-view/models/card-view-arrayitem.model.ts)`[]`): `boolean`
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - - - _candidateUsers:_ [`CardViewArrayItem`](lib/core/src/lib/card-view/models/card-view-arrayitem.model.ts)`[]` - - - _candidateGroups:_ [`CardViewArrayItem`](lib/core/src/lib/card-view/models/card-view-arrayitem.model.ts)`[]` - + - _candidateUsers:_ [`CardViewArrayItem`](../../../lib/core/src/lib/card-view/models/card-view-arrayitem.model.ts)`[]` - + - _candidateGroups:_ [`CardViewArrayItem`](../../../lib/core/src/lib/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`
diff --git a/docs/process-services/components/form.component.md b/docs/process-services/components/form.component.md index 4c30554fe3..8b4b6f6209 100644 --- a/docs/process-services/components/form.component.md +++ b/docs/process-services/components/form.component.md @@ -54,13 +54,13 @@ Any content in the body of `` will be shown when no form definition is | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| data | [`FormValues`](lib/core/src/lib/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. | +| data | [`FormValues`](../../../lib/core/src/lib/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/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | | Contains a list of form field validator instances. | -| form | [`FormModel`](lib/core/src/lib/form/components/widgets/core/form.model.ts) | | Underlying form model instance. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | | Contains a list of form field validator instances. | +| form | [`FormModel`](../../../lib/core/src/lib/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. | @@ -80,17 +80,17 @@ Any content in the body of `` will be shown when no form definition is | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | -| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/src/lib/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/src/lib/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/src/lib/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | +| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/src/lib/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. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/src/lib/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/src/lib/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | ## Details -All `formXXX` events receive a [`FormModel`](lib/core/src/lib/form/components/widgets/core/form.model.ts) instance as their argument: +All `formXXX` events receive a [`FormModel`](../../../lib/core/src/lib/form/components/widgets/core/form.model.ts) instance as their argument: **MyView.component.html** diff --git a/docs/process-services/components/process-list.component.md b/docs/process-services/components/process-list.component.md index 155d63d538..16df20b837 100644 --- a/docs/process-services/components/process-list.component.md +++ b/docs/process-services/components/process-list.component.md @@ -52,7 +52,7 @@ when the process list is empty: | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appId | `number` | | The id of the app. | -| data | [`DataTableAdapter`](lib/core/src/lib/datatable/data/datatable-adapter.ts) | | Data source to define the datatable. | +| data | [`DataTableAdapter`](../../../lib/core/src/lib/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. | @@ -73,7 +73,7 @@ when the process list is empty: | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/src/lib/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details diff --git a/docs/process-services/components/start-process.component.md b/docs/process-services/components/start-process.component.md index b64269f22b..b39489df47 100644 --- a/docs/process-services/components/start-process.component.md +++ b/docs/process-services/components/start-process.component.md @@ -47,7 +47,7 @@ Starts a process. | 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/src/lib/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. | +| values | [`FormValues`](../../../lib/core/src/lib/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. | | variables | [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/RestVariable.md). | ### Events diff --git a/docs/process-services/components/task-comments.component.md b/docs/process-services/components/task-comments.component.md index 06e45f6422..c9d651c44d 100644 --- a/docs/process-services/components/task-comments.component.md +++ b/docs/process-services/components/task-comments.component.md @@ -25,5 +25,5 @@ Displays comments from users involved in a specified task and allows an involved | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| taskId | `string` | | The numeric ID of the task. | | readOnly | `boolean` | | Are the comments read only? | +| taskId | `string` | | The numeric ID of the task. | diff --git a/docs/process-services/components/task-details.component.md b/docs/process-services/components/task-details.component.md index a3321c75d2..d84603ad71 100644 --- a/docs/process-services/components/task-details.component.md +++ b/docs/process-services/components/task-details.component.md @@ -24,7 +24,7 @@ Shows the details of the task ID passed in as input. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | debugMode | `boolean` | false | Toggles debug mode. | -| fieldValidators | [`FormFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | | readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | | showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. | | showComments | `boolean` | true | Toggles `Comments` feature for the Header component. | @@ -45,11 +45,11 @@ Shows the details of the task ID passed in as input. | assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is assigned. | | claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is claimed. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | -| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/src/lib/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/src/lib/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/src/lib/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/src/lib/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/src/lib/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | | taskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` | Emitted when a checklist task is created. | | taskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklist task is deleted. | | unClaimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is unclaimed. | diff --git a/docs/process-services/components/task-form.component.md b/docs/process-services/components/task-form.component.md index a374b32b56..987d85fac3 100644 --- a/docs/process-services/components/task-form.component.md +++ b/docs/process-services/components/task-form.component.md @@ -23,7 +23,7 @@ Shows a [`form`](../../../lib/process-services/src/lib/task-list/models/form.mod | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| fieldValidators | [`FormFieldValidator`](lib/core/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | +| fieldValidators | [`FormFieldValidator`](../../../lib/core/src/lib/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | | readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | | showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | | showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | @@ -40,12 +40,12 @@ Shows a [`form`](../../../lib/process-services/src/lib/task-list/models/form.mod | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | | completed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | -| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | -| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | +| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/src/lib/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/src/lib/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/src/lib/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | | formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | -| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | -| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/src/lib/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/src/lib/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | | showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | | taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | | taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued).. | diff --git a/docs/process-services/components/task-list.component.md b/docs/process-services/components/task-list.component.md index c6e6b261c3..74abe5cf51 100644 --- a/docs/process-services/components/task-list.component.md +++ b/docs/process-services/components/task-list.component.md @@ -55,7 +55,7 @@ when the task list is empty: | ---- | ---- | ------------- | ----------- | | 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/src/lib/datatable/data/datatable-adapter.ts) | | Data source object that represents the number and the type of the columns that you want to show. | +| data | [`DataTableAdapter`](../../../lib/core/src/lib/datatable/data/datatable-adapter.ts) | | Data source object that represents the number and the type of the columns that you want to show. | | dueAfter | `string` | | Filter the tasks. Display only tasks with `created_date` after `dueAfter`. | | dueBefore | `string` | | Filter the tasks. Display only tasks with `created_date` before `dueBefore`. | | includeProcessInstance | `boolean` | | Toggles inclusion of Process Instances | @@ -83,7 +83,7 @@ when the task list is empty: | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/src/lib/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | ## Details @@ -215,7 +215,7 @@ The Tasklist also supports pagination as shown in the example below: ### DataTableAdapter example See the [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) page for full details of the interface and its standard -implementation, [`ObjectDataTableAdapter`](lib/core/src/lib/datatable/data/object-datatable-adapter.ts). Below is an example of how you can set up the adapter for a +implementation, [`ObjectDataTableAdapter`](../../../lib/core/src/lib/datatable/data/object-datatable-adapter.ts). Below is an example of how you can set up the adapter for a typical tasklist: ```json diff --git a/docs/process-services/services/process.service.md b/docs/process-services/services/process.service.md index 3c1fff2bee..692fa66adb 100644 --- a/docs/process-services/services/process.service.md +++ b/docs/process-services/services/process.service.md @@ -62,14 +62,26 @@ Manages process instances, process variables, and process audit Log. - _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/src/lib/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)`>`
+- **getStartFormDefinition**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Gets the start form definition for a given process. + - _processId:_ `string` - Process definition ID + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Form definition +- **getStartFormInstance**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Gets the start form instance for a given process. + - _processId:_ `string` - Process definition ID + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Form definition +- **startProcess**(processDefinitionId: `string`, name: `string`, outcome?: `string`, startFormValues?: [`FormValues`](../../../lib/core/src/lib/form/components/widgets/core/form-values.ts), variables?: [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>`
Starts a process based on a process definition, name, form values or variables. - _processDefinitionId:_ `string` - Process definition ID - _name:_ `string` - Process name - _outcome:_ `string` - (Optional) Process outcome - - _startFormValues:_ [`FormValues`](lib/core/src/lib/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form + - _startFormValues:_ [`FormValues`](../../../lib/core/src/lib/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 +- **toJson**(res: `any`): `any`
+ Creates a JSON representation of form data. + - _res:_ `any` - Object representing form data + - **Returns** `any` - JSON data ## Details diff --git a/docs/upgrade-guide/upgrade26-30.md b/docs/upgrade-guide/upgrade26-30.md index 9a8f797760..86a44e46e4 100644 --- a/docs/upgrade-guide/upgrade26-30.md +++ b/docs/upgrade-guide/upgrade26-30.md @@ -259,13 +259,13 @@ The following classes have been moved from their original libraries to the Core library. You should modify your code to import these classes from `@alfresco/adf-core`. -- [`DownloadZipDialogComponent`](lib/core/src/lib/dialogs/download-zip/download-zip.dialog.ts) (formerly Content Services) +- [`DownloadZipDialogComponent`](../../lib/core/src/lib/dialogs/download-zip/download-zip.dialog.ts) (formerly Content Services) - [`NodeDownloadDirective`](../core/directives/node-download.directive.md) (formerly Content Services) -- [`CommentsModule`](lib/core/src/lib/comments/comments.module.ts) (formerly Process Services) +- [`CommentsModule`](../../lib/core/src/lib/comments/comments.module.ts) (formerly Process Services) - [`CommentListComponent`](../core/components/comment-list.component.md) (formerly Process Services) - [`CommentsComponent`](../core/components/comments.component.md) (formerly Process Services) -Also, `CommentProcessModel` was moved from Process Services to Core and renamed as [`CommentModel`](lib/core/src/lib/models/comment.model.ts). You should update both the name of the class and the import line in your code. +Also, `CommentProcessModel` was moved from Process Services to Core and renamed as [`CommentModel`](../../lib/core/src/lib/models/comment.model.ts). You should update both the name of the class and the import line in your code. ## Renamed items @@ -275,7 +275,7 @@ you should replace them with the new ones. ### Classes -`CommentProcessModel` was moved from Process Services to Core and renamed as [`CommentModel`](lib/core/src/lib/models/comment.model.ts) +`CommentProcessModel` was moved from Process Services to Core and renamed as [`CommentModel`](../../lib/core/src/lib/models/comment.model.ts) ### Properties and methods diff --git a/docs/upgrade-guide/upgrade50-60.md b/docs/upgrade-guide/upgrade50-60.md index aac979ba6c..5508371320 100644 --- a/docs/upgrade-guide/upgrade50-60.md +++ b/docs/upgrade-guide/upgrade50-60.md @@ -23,6 +23,15 @@ project. - [Library updates](#library-updates) - [Breaking changes](#breaking-changes) +- [Deprecated items](#deprecated-items) + - [PaginationModel](#paginationmodel) +- [Relocated classes](#relocated-classes) + - [NodeNameTooltipPipe](#nodenametooltippipe) + - [nodeUpdated Subject](#nodeupdated-subject) +- [Renamed items](#renamed-items) + - [New Classes or Services](#new-classes-or-services) + - [Properties and methods](#properties-and-methods) + - [Component selectors](#component-selectors) ## Library updates @@ -58,15 +67,14 @@ For more information about the changes and links to the associated pull requests. [TODO ADD HERE the PRs ] -CheckAllowableOperationDirective: Moved from ADF Core to ADF content services -LibraryFavoriteDirective: Moved from ADF Core to ADF content services -LibraryMembershipDirective: Moved from ADF Core to ADF content services -NodeDeleteDirective: Moved from ADF Core to ADF content services -NodeFavoriteDirective: Moved from ADF Core to ADF content services -NodeRestoreDirective: Moved from ADF Core to ADF content services +[`CheckAllowableOperationDirective`](../content-services/directives/check-allowable-operation.directive.md): Moved from ADF Core to ADF content services +[LibraryFavoriteDirective](../../lib/content-services/src/lib/directives/library-favorite.directive.ts): Moved from ADF Core to ADF content services +[LibraryMembershipDirective](../../lib/content-services/src/lib/directives/library-membership.directive.ts): Moved from ADF Core to ADF content services +[NodeDeleteDirective](../content-services/directives/node-delete.directive.md): Moved from ADF Core to ADF content services +[NodeFavoriteDirective](../content-services/directives/node-favorite.directive.md): Moved from ADF Core to ADF content services +[NodeRestoreDirective](../content-services/directives/node-restore.directive.md): Moved from ADF Core to ADF content services [TODO ADD HERE the PRs ] - Each section needs to contains: Title Description @@ -75,15 +83,16 @@ How to fix it: ## Deprecated items ### PaginationModel -``Pagination`` model from ```@alfresco/js-api``` has been now deprecated in favour of internal implementated model ```PaginationModel``` evrywhere + +`Pagination` model from `@alfresco/js-api` has been now deprecated in favour of internal implementated model [`PaginationModel`](../../lib/core/src/lib/models/pagination.model.ts) evrywhere ## Relocated classes | Class | Before | After | -| --- | -- | --- | -| `VersionCompatibilityService` | `@alfresco/adf-core` | `@alfresco/adf-content-services` | -| `VersionCompatibilityDirective` | `@alfresco/adf-core` | `@alfresco/adf-content-services` | -| `SitesService` | `@alfresco/adf-core` | `@alfresco/adf-content-services` | +| ----- | ------ | ----- | +| [`VersionCompatibilityService`](../../lib/content-services/src/lib/version-compatibility/version-compatibility.service.ts) | `@alfresco/adf-core` | `@alfresco/adf-content-services` | +| [`VersionCompatibilityDirective`](../content-services/directives/version-compatibility.directive.md) | `@alfresco/adf-core` | `@alfresco/adf-content-services` | +| [`SitesService`](../content-services/services/sites.service.md) | `@alfresco/adf-core` | `@alfresco/adf-content-services` | Following classes have been relocated: @@ -91,62 +100,53 @@ The following directives have been moved from the Core library to the Content Se library. You should modify your code to import these classes from `@alfresco/adf-content-services`. -- [`CheckAllowableOperationDirective`](lib/content-services/src/lib/directives/check-allowable-operation.directive.ts) -- [`LibraryFavoriteDirective`](lib/content-services/src/lib/directives/library-favorite.directive.ts) -- [`LibraryMembershipDirective`](lib/content-services/src/lib/directives/library-membership.directive.ts) -- [`NodeDeleteDirective`](lib/content-services/src/lib/directives/node-delete.directive.ts) -- [`NodeFavoriteDirective`](lib/content-services/src/lib/directives/node-favorite.directive.ts) -- [`NodeRestoreDirective`](lib/content-services/src/lib/directives/node-restore.directive.ts) - +- [`CheckAllowableOperationDirective`](../content-services/directives/check-allowable-operation.directive.md) +- [`LibraryFavoriteDirective`](../../lib/content-services/src/lib/directives/library-favorite.directive.ts) +- [`LibraryMembershipDirective`](../../lib/content-services/src/lib/directives/library-membership.directive.ts) +- [`NodeDeleteDirective`](../content-services/directives/node-delete.directive.md) +- [`NodeFavoriteDirective`](../content-services/directives/node-favorite.directive.md) +- [`NodeRestoreDirective`](../content-services/directives/node-restore.directive.md) ### NodeNameTooltipPipe -NodeNameTooltipPipe has been moved in the ```@alfresco/adf-content-services``` in ```ContentPipeModule``` +[NodeNameTooltipPipe](../core/pipes/node-name-tooltip.pipe.md) has been moved in the `@alfresco/adf-content-services` in `ContentPipeModule` v6.0.0 and before: -``` -@NgModule({ - imports: [ - ```` - PipeModule - ```` - ]}) -``` + @NgModule({ + imports: [ + ```` + PipeModule + ```` + ]}) v6.0.0 and after: -``` -@NgModule({ - imports: [ - ```` - ContentPipeModule - ```` - ]}) -``` + @NgModule({ + imports: [ + ```` + ContentPipeModule + ```` + ]}) + ### nodeUpdated Subject -The nodeUpdated Subject has been moved from AlfrescoApiService to NodesApiService + +The nodeUpdated [Subject](http://reactivex.io/documentation/subject.html) has been moved from [AlfrescoApiService](../core/services/alfresco-api.service.md) to [NodesApiService](../core/services/nodes-api.service.md) v6.0.0 and before: -``` - this.alfrescoApiService.nodeUpdated.pipe ..... -``` + + this.alfrescoApiService.nodeUpdated.pipe ..... v6.0.0 and after: -``` - this.nodesApiService.nodeUpdated.pipe ..... -``` + this.nodesApiService.nodeUpdated.pipe ..... ## Renamed items - ### New Classes or Services - ### Properties and methods -- ``: The `taskId` input has now been renamed as `id` + +- ``: The `taskId` input has now been renamed as `id` ### Component selectors - - diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 815034fd6d..ea07fb2d09 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -41,11 +41,16 @@ backend services have been tested with each released version of ADF. - [v2.0.0](#v200) ## v5.1.0 + -- [Snackbar Content](core/components/snackbar-content.component.md) +- [Auto focus directive](content-services/directives/auto-focus.directive.md) +- [Node comments component](content-services/components/node-comments.component.md) +- [Snackbar content component](core/components/snackbar-content.component.md) +- [Task comments component](process-services/components/task-comments.component.md) + ## v4.7.0 @@ -120,7 +125,7 @@ backend services have been tested with each released version of ADF. - [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) +- [Version compatibility directive](content-services/directives/version-compatibility.directive.md) @@ -159,6 +164,7 @@ backend services have been tested with each released version of ADF. - [About application component](core/components/about-application.component.md) - [About github link component](core/components/about-github-link.component.md) - [About product version component](core/components/about-product-version.component.md) +- [About component](core/components/about.component.md) - [Edit json dialog](core/dialogs/edit-json.dialog.md) - [Identity role service](core/services/identity-role.service.md) @@ -432,7 +438,7 @@ backend services have been tested with each released version of ADF. - [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) +- [Check allowable operation directive](content-services/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) @@ -485,12 +491,11 @@ backend services have been tested with each released version of ADF. - [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 delete directive](content-services/directives/node-delete.directive.md) +- [Node favorite directive](content-services/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) +- [Node restore directive](content-services/directives/node-restore.directive.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) @@ -524,7 +529,7 @@ backend services have been tested with each released version of ADF. - [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) +- [Sites service](content-services/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)