From e03f3a1a6b7b4c68c8c0ceb7b524290d1487a505 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Tue, 7 Aug 2018 16:00:58 +0100 Subject: [PATCH] [ADF-3323] Fixed broken links in doc files (#3662) * [ADF-3323] Fixed URL path to Typescript source files * [ADF-3323] Fixed and checked broken links caused by previous bug --- docs/README.md | 20 +++--- docs/content-services/breadcrumb.component.md | 2 +- .../content-action.component.md | 2 +- .../custom-resources.service.md | 44 ++++++------ .../document-list.component.md | 20 +++--- .../content-services/document-list.service.md | 8 +-- .../dropdown-breadcrumb.component.md | 2 +- .../search-filter.component.md | 2 +- .../search-query-builder.service.md | 18 +++++ docs/content-services/search.component.md | 2 +- .../upload-button.component.md | 4 +- .../upload-drag-area.component.md | 4 +- .../upload-version-button.component.md | 4 +- docs/content-services/webscript.component.md | 4 +- docs/core/README.md | 30 ++++---- docs/core/accordion-group.component.md | 6 +- docs/core/alfresco-api.service.md | 2 +- docs/core/app-config.service.md | 13 ++-- docs/core/apps-process.service.md | 4 +- docs/core/authentication.service.md | 56 +++++++++------ docs/core/card-item-types.service.md | 26 +++---- docs/core/card-view.component.md | 11 ++- docs/core/comment-content.service.md | 4 +- docs/core/comment-list.component.md | 4 +- docs/core/comment-process.service.md | 8 +-- docs/core/comments.component.md | 4 +- docs/core/content.service.md | 26 +++---- docs/core/context-menu.directive.md | 6 +- docs/core/cookie.service.md | 10 +-- docs/core/data-column.component.md | 11 +-- docs/core/datatable.component.md | 35 ++++------ docs/core/deleted-nodes-api.service.md | 2 +- docs/core/ecm-user.service.md | 4 +- docs/core/empty-content.component.md | 2 +- docs/core/favorites-api.service.md | 8 +-- docs/core/form-field.component.md | 44 ++++++------ docs/core/form-field.model.md | 6 +- docs/core/form-list.component.md | 4 +- docs/core/form-rendering.service.md | 44 ++++++------ docs/core/form.component.md | 19 ++--- docs/core/form.service.md | 66 ++++++++--------- docs/core/highlight-transform.service.md | 4 +- docs/core/highlight.directive.md | 8 +-- docs/core/host-settings.component.md | 8 +-- docs/core/infinite-pagination.component.md | 10 +-- docs/core/info-drawer-tab.component.md | 4 +- docs/core/info-drawer.component.md | 6 +- docs/core/log.service.md | 22 +++--- docs/core/login.component.md | 25 +++---- docs/core/node-delete.directive.md | 6 +- docs/core/node-favorite.directive.md | 6 +- docs/core/node-permission.directive.md | 12 ++-- docs/core/node-restore.directive.md | 8 +-- docs/core/nodes-api.service.md | 32 ++++----- docs/core/notification.service.md | 11 ++- docs/core/pagination.component.md | 21 +++--- docs/core/people-content.service.md | 2 +- docs/core/people-process.service.md | 8 +-- docs/core/process-content.service.md | 28 ++++---- docs/core/search-configuration.service.md | 2 +- docs/core/shared-links-api.service.md | 4 +- docs/core/sidebar-action-menu.component.md | 2 +- docs/core/sidenav-layout.component.md | 10 +-- docs/core/sites.service.md | 8 +-- docs/core/sorting-picker.component.md | 8 +-- docs/core/start-form.component.md | 16 ++--- docs/core/storage.service.md | 10 +-- docs/core/text-mask.component.md | 4 +- docs/core/thumbnail.service.md | 4 +- docs/core/toolbar.component.md | 7 +- docs/core/translation.service.md | 16 ++--- docs/core/upload.directive.md | 8 +-- docs/core/upload.service.md | 28 ++++---- docs/core/user-info.component.md | 6 +- docs/core/user-preferences.service.md | 18 +++-- docs/core/viewer.component.md | 35 ++++------ .../insights/analytics-generator.component.md | 7 +- .../analytics-report-list.component.md | 11 +-- docs/insights/analytics.component.md | 9 +-- docs/insights/diagram.component.md | 26 +++---- docs/insights/widget.component.md | 9 ++- docs/process-services/README.md | 1 + docs/process-services/apps-list.component.md | 8 +-- .../process-services/attach-form.component.md | 10 +-- docs/process-services/checklist.component.md | 6 +- .../create-process-attachment.component.md | 4 +- .../create-task-attachment.component.md | 4 +- .../process-services/people-list.component.md | 6 +- .../people-search.component.md | 6 +- docs/process-services/people.component.md | 8 +-- .../process-attachment-list.component.md | 8 +-- .../process-audit.directive.md | 6 +- .../process-comments.component.md | 4 +- .../process-filter.service.md | 16 ++--- .../process-filters.component.md | 13 ++-- .../process-instance-details.component.md | 6 +- .../process-instance-header.component.md | 4 +- .../process-instance-tasks.component.md | 4 +- .../process-list.component.md | 22 +++--- docs/process-services/process.service.md | 26 +++---- .../start-process.component.md | 5 -- docs/process-services/start-task.component.md | 4 +- .../task-attachment-list.component.md | 8 +-- docs/process-services/task-audit.directive.md | 6 +- .../task-details.component.md | 18 ++--- docs/process-services/task-filter.service.md | 22 +++--- .../task-filters.component.md | 18 +++-- .../process-services/task-header.component.md | 6 +- docs/process-services/task-list.component.md | 23 +++--- .../task-standalone.component.md | 10 +-- docs/process-services/tasklist.service.md | 54 +++++++------- docs/tutorials/README.md | 6 +- docs/tutorials/content-metadata-component.md | 6 +- .../creating-the-app-using-yeoman.md | 5 +- docs/tutorials/customising-login.md | 3 +- docs/tutorials/new-component.md | 16 ++--- docs/tutorials/using-components.md | 32 ++++----- docs/tutorials/working-with-data-table.md | 33 +++++---- .../working-with-nodes-api-service.md | 52 +++++++++----- docs/user-guide/extensibility.md | 70 +++++++++++-------- docs/user-guide/internationalization.md | 11 +-- docs/user-guide/stencils.md | 36 +++++++--- tools/doc/tools/toc.js | 2 +- tools/doc/tools/typeLinker.js | 4 +- tools/doc/tools/typeLinker.ts | 2 +- 125 files changed, 845 insertions(+), 829 deletions(-) diff --git a/docs/README.md b/docs/README.md index bdf4e85ddc..c8b97a254e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -58,7 +58,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [About component](core/about.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component allow you to have a general overview of the version of ADF installed and the status of the Content service and Process service. | [Source](../lib/core/about/about.component.ts) | -| [Buttons menu component](core/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/buttons-menu/buttons-menu.component.ts) | +| [Buttons menu component](core/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/buttons-menu/buttons-menu.component.ts) | | [Card view component](core/card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) | | [Accordion group component](core/accordion-group.component.md) | Adds a collapsible panel to an accordion menu. | [Source](../lib/core/collapsable/accordion-group.component.ts) | | [Accordion component](core/accordion.component.md) | Creates a collapsible accordion menu. | [Source](../lib/core/collapsable/accordion.component.ts) | @@ -78,8 +78,8 @@ for more information about installing and using the source code. | [Infinite pagination component](core/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | | [Pagination component](core/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | | [Host settings component](core/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) | -| [Sidebar action menu component](core/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/sidenav-layout/components/sidebar-action/sidebar-action-menu.component.ts) | -| [Sidenav layout component](core/sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../lib/core/sidenav-layout/components/sidenav-layout/sidenav-layout.component.ts) | +| [Sidebar action menu component](core/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/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/sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../lib/core/sorting-picker/sorting-picker.component.ts) | | [Empty content component](core/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../lib/core/templates/empty-content/empty-content.component.ts) | | [Error content component](core/error-content.component.md) | Displays info about a specific error. | [Source](../lib/core/templates/error-content/error-content.component.ts) | @@ -122,7 +122,7 @@ for more information about installing and using the source code. | [Node name tooltip pipe](core/node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) | | [Text highlight pipe](core/text-highlight.pipe.md) | Adds highlighting to words or sections of text that match a search string. | [Source](../lib/core/pipes/text-highlight.pipe.ts) | | [Time ago pipe](core/time-ago.pipe.md) | Converts a recent past date into a number of days ago. | [Source](../lib/core/pipes/time-ago.pipe.ts) | -| [User initial pipe](core/user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | +| [User initial pipe](core/user-initial.pipe.md) | Takes the name fields of a `UserProcessModel` object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | ## Services @@ -133,7 +133,7 @@ for more information about installing and using the source code. | [Activiti alfresco service](core/activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) | | [Form rendering service](core/form-rendering.service.md) | Maps an APS form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | | [Form service](core/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | -| [Node service](core/node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../lib/core/form/services/node.service.ts) | +| [Node service](core/node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../lib/core/form/services/node.service.ts) | | [Process content service](core/process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../lib/core/form/services/process-content.service.ts) | | [Alfresco api service](core/alfresco-api.service.md) | Provides access to an initialized **AlfrescoJSApi** instance. | [Source](../lib/core/services/alfresco-api.service.ts) | | [Apps process service](core/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) | @@ -153,7 +153,7 @@ for more information about installing and using the source code. | [Nodes api service](core/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) | | [Notification service](core/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/services/notification.service.ts) | | [Page title service](core/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | -| [People content service](core/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | +| [People content service](core/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | | [People process service](core/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) | | [Renditions service](core/renditions.service.md) ![Deprecated](docassets/images/DeprecatedIcon.png) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) | | [Search configuration service](core/search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | @@ -219,7 +219,7 @@ for more information about installing and using the source code. | [Search slider component](content-services/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-slider/search-slider.component.ts) | | [Search sorting picker component](content-services/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts) | | [Search text component](content-services/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-text/search-text.component.ts) | -| [Search component](content-services/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.component.ts) | +| [Search component](content-services/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.component.ts) | | [Sites dropdown component](content-services/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/site-dropdown/sites-dropdown.component.ts) | | [Like component](content-services/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/social/like.component.ts) | | [Rating component](content-services/rating.component.md) | Allows a user to add ratings to an item. | [Source](../lib/content-services/social/rating.component.ts) | @@ -333,9 +333,9 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Process filter service](process-services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/process-list/services/process-filter.service.ts) | -| [Process service](process-services/process.service.md) | Manages Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) | -| [Task filter service](process-services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) | +| [Process filter service](process-services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/process-list/services/process-filter.service.ts) | +| [Process service](process-services/process.service.md) | Manages Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) | +| [Task filter service](process-services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) | | [Tasklist service](process-services/tasklist.service.md) | Manages Task Instances. | [Source](../lib/process-services/task-list/services/tasklist.service.ts) | diff --git a/docs/content-services/breadcrumb.component.md b/docs/content-services/breadcrumb.component.md index 9cc913c400..a292c495f7 100644 --- a/docs/content-services/breadcrumb.component.md +++ b/docs/content-services/breadcrumb.component.md @@ -36,7 +36,7 @@ Indicates the current position within a navigation hierarchy. | Name | Type | Description | | ---- | ---- | ----------- | -| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks on a breadcrumb. | +| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElementEntity`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/content-action.component.md b/docs/content-services/content-action.component.md index f65290bd67..79067631f9 100644 --- a/docs/content-services/content-action.component.md +++ b/docs/content-services/content-action.component.md @@ -120,7 +120,7 @@ will trigger the same action.) You can also add your own handler by implementing `execute` event. Note that you can use _both_ a built-in handler and your own `execute` -function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](lib/content-services/document-list/models/document-library.model.ts) as its +function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](../../lib/content-services/document-list/models/document-library.model.ts) as its parameter (see the [Document Library model](document-library.model.md) page for more information) which contains full details of the item that the action is operating on. For example, with `handler="delete"` you could use `execute` to show a message with the name, diff --git a/docs/content-services/custom-resources.service.md b/docs/content-services/custom-resources.service.md index 13c62ffa9d..2ef69224be 100644 --- a/docs/content-services/custom-resources.service.md +++ b/docs/content-services/custom-resources.service.md @@ -12,47 +12,47 @@ Manages Document List information that is specific to a user. ### Methods -- **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the contents of one of the well-known aliases in the form of node ID strings. - _nodeId:_ `string` - ID of the target folder node - - _pagination:_ [`PaginationModel`](lib/core/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of node IDs -- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>`
+- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets files recently accessed by a user. - _personId:_ `string` - ID of the user - - _pagination:_ [`PaginationModel`](lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>` - List of nodes for the recently used files + - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of nodes for the recently used files - **isCustomSource**(folderId: `string`): `boolean`
Is the folder ID one of the well-known aliases? - _folderId:_ `string` - Folder ID name to check - **Returns** `boolean` - True if the ID is a well-known name, false otherwise -- **loadFavorites**(pagination: [`PaginationModel`](lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>`
+- **loadFavorites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets favorite files for the current user. - - _pagination:_ [`PaginationModel`](lib/core/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - _includeFields:_ `string[]` - List of data field names to include in the results - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>` - List of favorite files -- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](lib/core/models/pagination.model.ts), includeFields: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of favorite files +- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts), includeFields: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets a folder's contents. - _nodeId:_ `string` - ID of the target folder node - - _pagination:_ [`PaginationModel`](lib/core/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - _includeFields:_ `string[]` - List of data field names to include in the results - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>` - List of items contained in the folder -- **loadMemberSites**(pagination: [`PaginationModel`](lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of items contained in the folder +- **loadMemberSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets sites that the current user is a member of. - - _pagination:_ [`PaginationModel`](lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>` - List of sites -- **loadSharedLinks**(pagination: [`PaginationModel`](lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>`
+ - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of sites +- **loadSharedLinks**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets shared links for the current user. - - _pagination:_ [`PaginationModel`](lib/core/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - _includeFields:_ `string[]` - List of data field names to include in the results - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>` - List of shared links -- **loadSites**(pagination: [`PaginationModel`](lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of shared links +- **loadSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets all sites in the respository. - - _pagination:_ [`PaginationModel`](lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>` - List of sites -- **loadTrashcan**(pagination: [`PaginationModel`](lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`
+ - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of sites +- **loadTrashcan**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`
Gets all items currently in the trash. - - _pagination:_ [`PaginationModel`](lib/core/models/pagination.model.ts) - Specifies how to paginate the results + - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - _includeFields:_ `string[]` - List of data field names to include in the results - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>` - List of deleted items diff --git a/docs/content-services/document-list.component.md b/docs/content-services/document-list.component.md index 786b0e0e78..d6f15c0002 100644 --- a/docs/content-services/document-list.component.md +++ b/docs/content-services/document-list.component.md @@ -33,8 +33,8 @@ Displays the documents from a repository. - [Advanced usage and customization](#advanced-usage-and-customization) - [Custom row filter](#custom-row-filter) - [Custom image resolver](#custom-image-resolver) - - [Custom 'empty folder' template](#custom-'empty-folder'-template) - - [Custom 'permission denied' template](#custom-'permission-denied'-template) + - [Custom 'empty folder' template](#custom-empty-folder-template) + - [Custom 'permission denied' template](#custom-permission-denied-template) - [See also](#see-also) ## Basic Usage @@ -71,8 +71,8 @@ Displays the documents from a repository. | multiselect | `boolean` | false | Toggles multiselect mode | | navigate | `boolean` | true | Toggles navigation to folder content or file preview | | navigationMode | `string` | | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | -| node | [`NodePaging`](lib/content-services/document-list/models/document-library.model.ts) | null | The Document list will show all the nodes contained in the [NodePaging](lib/content-services/document-list/models/document-library.model.ts) entity | -| permissionsStyle | [`PermissionStyleModel`](lib/content-services/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the [Permission Style model](lib/content-services/document-list/models/permissions-style.model.ts) page for further details and examples. | +| node | [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) | null | The Document list will show all the nodes contained in the [NodePaging](../../lib/content-services/document-list/models/document-library.model.ts) entity | +| permissionsStyle | [`PermissionStyleModel`](../../lib/content-services/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../lib/content-services/document-list/models/permissions-style.model.ts) page for further details and examples. | | rowFilter | `any \| null` | null | Custom row filter | | rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. | | rowStyleClass | `string` | | The CSS class to apply to every row | @@ -88,11 +88,11 @@ Displays the documents from a repository. | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the API fails to get the Document List data | -| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes | -| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node | -| nodeDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node | -| preview | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the [Viewer component](../core/viewer.component.md). | -| ready | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the Document List has loaded all items and is ready for use | +| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes | +| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node | +| nodeDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node | +| preview | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the [Viewer component](../core/viewer.component.md). | +| ready | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the Document List has loaded all items and is ready for use | ## Details @@ -653,7 +653,7 @@ The following example switches navigation to single clicks: You can create a custom row filter function that returns `true` if the row should be displayed or `false` if it should be hidden. -A typical row filter implementation receives a [`ShareDataRow`](lib/content-services/document-list/data/share-data-row.model.ts) object as a parameter: +A typical row filter implementation receives a [`ShareDataRow`](../../lib/content-services/document-list/data/share-data-row.model.ts) object as a parameter: ```ts myFilter(row: ShareDataRow): boolean { diff --git a/docs/content-services/document-list.service.md b/docs/content-services/document-list.service.md index 0ddb9c6a1c..a28314365a 100644 --- a/docs/content-services/document-list.service.md +++ b/docs/content-services/document-list.service.md @@ -33,12 +33,12 @@ Implements node operations used by the [Document List component](../content-serv Get thumbnail URL for the given document node. - _node:_ [`MinimalNodeEntity`](../content-services/document-library.model.md) - Node to get URL for. - **Returns** `string` - Thumbnail URL string -- **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>`
+- **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets the folder node with the specified relative name path below the root node. - _folder:_ `string` - Path to folder. - _opts:_ `any` - (Optional) Options. - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>` - Details of the folder + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - Details of the folder - **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
(**Deprecated:** 2.3.0 Gets a folder node via its node ID.) - _nodeId:_ `string` - ID of the folder node @@ -53,10 +53,10 @@ Implements node operations used by the [Document List component](../content-serv - _nodeId:_ `string` - ID of the target node - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder -- **hasPermission**(node: `any`, permission: [`PermissionsEnum`](lib/core/models/permissions.enum.ts)`|string`): `boolean`
+- **hasPermission**(node: `any`, permission: [`PermissionsEnum`](../../lib/core/models/permissions.enum.ts)`|string`): `boolean`
(**Deprecated:** 2.3.0 use the one in the content service Checks if a node has the specified permission.) - _node:_ `any` - Target node - - _permission:_ [`PermissionsEnum`](lib/core/models/permissions.enum.ts)`|string` - Permission level to query + - _permission:_ [`PermissionsEnum`](../../lib/core/models/permissions.enum.ts)`|string` - Permission level to query - **Returns** `boolean` - True if the node has the permission, false otherwise - **moveNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Moves a node to destination node. diff --git a/docs/content-services/dropdown-breadcrumb.component.md b/docs/content-services/dropdown-breadcrumb.component.md index e24c4d5787..a12a132bcb 100644 --- a/docs/content-services/dropdown-breadcrumb.component.md +++ b/docs/content-services/dropdown-breadcrumb.component.md @@ -36,7 +36,7 @@ Indicates the current position within a navigation hierarchy using a dropdown me | Name | Type | Description | | ---- | ---- | ----------- | -| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks on a breadcrumb. | +| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElementEntity`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/search-filter.component.md b/docs/content-services/search-filter.component.md index 4a1bbe47ec..0251cb713d 100644 --- a/docs/content-services/search-filter.component.md +++ b/docs/content-services/search-filter.component.md @@ -175,7 +175,7 @@ for further details. ### Categories and widgets -The Search [Settings component](demo-shell/src/app/components/settings/settings.component.ts) and Query Builder require a `categories` section in the +The Search [Settings component](../../demo-shell/src/app/components/settings/settings.component.ts) and Query Builder require a `categories` section in the configuration. Categories are used to configure the UI widgets that let the user edit the search query diff --git a/docs/content-services/search-query-builder.service.md b/docs/content-services/search-query-builder.service.md index 33bbc3c66d..ece68abfe4 100644 --- a/docs/content-services/search-query-builder.service.md +++ b/docs/content-services/search-query-builder.service.md @@ -16,6 +16,15 @@ Stores information from all the custom search and faceted search widgets, compil - _query:_ `string` - +- **addUserFacetBucket**(field: `FacetField`, bucket: `FacetFieldBucket`)
+ + - _field:_ `FacetField` - + - _bucket:_ `FacetFieldBucket` - + +- **addUserFacetQuery**(query: `FacetQuery`)
+ + - _query:_ `FacetQuery` - + - **buildQuery**(): `QueryBody`
- **Returns** `QueryBody` - @@ -44,6 +53,15 @@ Stores information from all the custom search and faceted search widgets, compil - _query:_ `string` - +- **removeUserFacetBucket**(field: `FacetField`, bucket: `FacetFieldBucket`)
+ + - _field:_ `FacetField` - + - _bucket:_ `FacetFieldBucket` - + +- **removeUserFacetQuery**(query: `FacetQuery`)
+ + - _query:_ `FacetQuery` - + - **resetToDefaults**()
- **update**()
diff --git a/docs/content-services/search.component.md b/docs/content-services/search.component.md index 0cde6bfb86..1f745c5490 100644 --- a/docs/content-services/search.component.md +++ b/docs/content-services/search.component.md @@ -46,7 +46,7 @@ Searches items for supplied search terms. | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when search results have fully loaded. | +| resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when search results have fully loaded. | ## Details diff --git a/docs/content-services/upload-button.component.md b/docs/content-services/upload-button.component.md index bc9ad8e52c..d9b100c23f 100644 --- a/docs/content-services/upload-button.component.md +++ b/docs/content-services/upload-button.component.md @@ -45,10 +45,10 @@ Activates a file upload. | Name | Type | Description | | ---- | ---- | ----------- | -| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](lib/content-services/upload/components/upload-files.event.ts)`>` | | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | | | createFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a folder is created. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](lib/content-services/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../lib/content-services/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. | ## Details diff --git a/docs/content-services/upload-drag-area.component.md b/docs/content-services/upload-drag-area.component.md index c3645b9e67..664f378753 100644 --- a/docs/content-services/upload-drag-area.component.md +++ b/docs/content-services/upload-drag-area.component.md @@ -48,7 +48,7 @@ export class AppComponent { | Name | Type | Description | | ---- | ---- | ----------- | -| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](lib/content-services/upload/components/upload-files.event.ts)`>` | Raised after files or folders dropped and before the upload process starts. | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | Raised after files or folders dropped and before the upload process starts. | | createFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a folder is created. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the file is uploaded successfully. | @@ -57,7 +57,7 @@ export class AppComponent { You can intercept the upload process by utilizing the `beginUpload` event. -The event has a type of [`UploadFilesEvent`](lib/content-services/upload/components/upload-files.event.ts) and provides the following APIs: +The event has a type of [`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts) and provides the following APIs: - **files**: get access to the [`FileInfo`](../../lib/core/utils/file-utils.ts) objects that are prepared for the upload - **pauseUpload**: pause the upload and perform additional tasks, like showing the confirmation dialog diff --git a/docs/content-services/upload-version-button.component.md b/docs/content-services/upload-version-button.component.md index 431df2ad86..50cbf55f6e 100644 --- a/docs/content-services/upload-version-button.component.md +++ b/docs/content-services/upload-version-button.component.md @@ -48,10 +48,10 @@ 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/upload/components/upload-files.event.ts)`>` | | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | | | createFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a folder is created. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](lib/content-services/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../lib/content-services/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. | ## Details diff --git a/docs/content-services/webscript.component.md b/docs/content-services/webscript.component.md index ac9e7ada43..d2c5317db2 100644 --- a/docs/content-services/webscript.component.md +++ b/docs/content-services/webscript.component.md @@ -34,7 +34,7 @@ Provides access to Webscript features. Another example: -**[app.component](demo-shell/src/app/app.component.ts).html** +**[app.component](../../demo-shell/src/app/app.component.ts).html** ```html ``` -**[app.component](demo-shell/src/app/app.component.ts).ts** +**[app.component](../../demo-shell/src/app/app.component.ts).ts** ```ts export class AppComponent { diff --git a/docs/core/README.md b/docs/core/README.md index 4940b7e835..8a5a37f9ab 100644 --- a/docs/core/README.md +++ b/docs/core/README.md @@ -11,8 +11,8 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [About component](about.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | This component allow you to have a general overview of the version of ADF installed and the status of the Content service and Process service. | [Source](../../lib/core/about/about.component.ts) | -| [Buttons menu component](buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../../lib/core/buttons-menu/buttons-menu.component.ts) | +| [About component](about.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | This component allow you to have a general overview of the version of ADF installed and the status of the [Content service](../core/content.service.md) and [Process service](../process-services/process.service.md). | [Source](../../lib/core/about/about.component.ts) | +| [Buttons menu component](buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../../lib/core/buttons-menu/buttons-menu.component.ts) | | [Card view component](card-view.component.md) | Displays a configurable property list renderer. | [Source](../../lib/core/card-view/components/card-view/card-view.component.ts) | | [Accordion group component](accordion-group.component.md) | Adds a collapsible panel to an accordion menu. | [Source](../../lib/core/collapsable/accordion-group.component.ts) | | [Accordion component](accordion.component.md) | Creates a collapsible accordion menu. | [Source](../../lib/core/collapsable/accordion.component.ts) | @@ -22,8 +22,8 @@ for more information about installing and using the source code. | [Datatable component](datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../../lib/core/datatable/components/datatable/datatable.component.ts) | | [Form field component](form-field.component.md) | A form field in an APS form. | [Source](../../lib/core/form/components/form-field/form-field.component.ts) | | [Form list component](form-list.component.md) | Shows APS forms as a list. | [Source](../../lib/core/form/components/form-list.component.ts) | -| [Form component](form.component.md) | Shows a Form from APS | [Source](../../lib/core/form/components/form.component.ts) | -| [Start form component](start-form.component.md) | Displays the Start Form for a process. | [Source](../../lib/core/form/components/start-form.component.ts) | +| [Form component](form.component.md) | Shows a [`Form`](../../lib/process-services/task-list/models/form.model.ts) from APS | [Source](../../lib/core/form/components/form.component.ts) | +| [Start form component](start-form.component.md) | Displays the Start [`Form`](../../lib/process-services/task-list/models/form.model.ts) for a process. | [Source](../../lib/core/form/components/start-form.component.ts) | | [Text mask component](text-mask.component.md) | Implements text field input masks. | [Source](../../lib/core/form/components/widgets/text/text-mask.component.ts) | | [Info drawer layout component](info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../../lib/core/info-drawer/info-drawer-layout.component.ts) | | [Info drawer component](info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../../lib/core/info-drawer/info-drawer.component.ts) | @@ -32,13 +32,13 @@ for more information about installing and using the source code. | [Infinite pagination component](infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../../lib/core/pagination/infinite-pagination.component.ts) | | [Pagination component](pagination.component.md) | Adds pagination to the component it is used with. | [Source](../../lib/core/pagination/pagination.component.ts) | | [Host settings component](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) | -| [Sidebar action menu component](sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../../lib/core/sidenav-layout/components/sidebar-action/sidebar-action-menu.component.ts) | -| [Sidenav layout component](sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../../lib/core/sidenav-layout/components/sidenav-layout/sidenav-layout.component.ts) | +| [Sidebar action menu component](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](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](sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../../lib/core/sorting-picker/sorting-picker.component.ts) | | [Empty content component](empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../../lib/core/templates/empty-content/empty-content.component.ts) | | [Error content component](error-content.component.md) | Displays info about a specific error. | [Source](../../lib/core/templates/error-content/error-content.component.ts) | | [Toolbar divider component](toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../../lib/core/toolbar/toolbar-divider.component.ts) | -| [Toolbar title component](toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../../lib/core/toolbar/toolbar-title.component.ts) | +| [Toolbar title component](toolbar-title.component.md) | Supplies custom HTML to be included in a [Toolbar component](../core/toolbar.component.md) title. | [Source](../../lib/core/toolbar/toolbar-title.component.ts) | | [Toolbar component](toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../../lib/core/toolbar/toolbar.component.ts) | | [User info component](user-info.component.md) | Shows user information. | [Source](../../lib/core/userinfo/components/user-info.component.ts) | | [Viewer component](viewer.component.md) | Displays content from an ACS repository. | [Source](../../lib/core/viewer/components/viewer.component.ts) | @@ -60,7 +60,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Form field model](form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../../lib/core/form/components/widgets/core/form-field.model.ts) | +| [Form field model](form-field.model.md) | Contains the value and metadata for a field of a [`Form`](../../lib/process-services/task-list/models/form.model.ts) component. | [Source](../../lib/core/form/components/widgets/core/form-field.model.ts) | | [Comment process model](comment-process.model.md) | Represents a comment added to a Process Services task or process instance. | [Source](../../lib/core/models/comment-process.model.ts) | | [Product version model](product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../../lib/core/models/product-version.model.ts) | | [User process model](user-process.model.md) | Represents a Process Services user. | [Source](../../lib/core/models/user-process.model.ts) | @@ -76,18 +76,18 @@ for more information about installing and using the source code. | [Node name tooltip pipe](node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../../lib/core/pipes/node-name-tooltip.pipe.ts) | | [Text highlight pipe](text-highlight.pipe.md) | Adds highlighting to words or sections of text that match a search string. | [Source](../../lib/core/pipes/text-highlight.pipe.ts) | | [Time ago pipe](time-ago.pipe.md) | Converts a recent past date into a number of days ago. | [Source](../../lib/core/pipes/time-ago.pipe.ts) | -| [User initial pipe](user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../../lib/core/pipes/user-initial.pipe.ts) | +| [User initial pipe](user-initial.pipe.md) | Takes the name fields of a [`UserProcessModel`](../core/user-process.model.md) object and extracts and formats the initials. | [Source](../../lib/core/pipes/user-initial.pipe.ts) | ## Services | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Card item types service](card-item-types.service.md) | Maps type names to field component types for the Card View component. | [Source](../../lib/core/card-view/services/card-item-types.service.ts) | -| [Card view update service](card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | [Source](../../lib/core/card-view/services/card-view-update.service.ts) | +| [Card item types service](card-item-types.service.md) | Maps type names to field component types for the [Card View component](../core/card-view.component.md). | [Source](../../lib/core/card-view/services/card-item-types.service.ts) | +| [Card view update service](card-view-update.service.md) | Reports edits and clicks within fields of a [Card View component](../core/card-view.component.md). | [Source](../../lib/core/card-view/services/card-view-update.service.ts) | | [Activiti alfresco service](activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../../lib/core/form/services/activiti-alfresco.service.ts) | -| [Form rendering service](form-rendering.service.md) | Maps an APS form field type string onto the corresponding form widget component type. | [Source](../../lib/core/form/services/form-rendering.service.ts) | +| [Form rendering service](form-rendering.service.md) | Maps an APS form field type string onto the corresponding form [widget component](../insights/widget.component.md) type. | [Source](../../lib/core/form/services/form-rendering.service.ts) | | [Form service](form.service.md) | Implements Process Services form methods | [Source](../../lib/core/form/services/form.service.ts) | -| [Node service](node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../../lib/core/form/services/node.service.ts) | +| [Node service](node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../../lib/core/form/services/node.service.ts) | | [Process content service](process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../../lib/core/form/services/process-content.service.ts) | | [Alfresco api service](alfresco-api.service.md) | Provides access to an initialized **AlfrescoJSApi** instance. | [Source](../../lib/core/services/alfresco-api.service.ts) | | [Apps process service](apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../../lib/core/services/apps-process.service.ts) | @@ -107,7 +107,7 @@ for more information about installing and using the source code. | [Nodes api service](nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../../lib/core/services/nodes-api.service.ts) | | [Notification service](notification.service.md) | Shows a notification message with optional feedback. | [Source](../../lib/core/services/notification.service.ts) | | [Page title service](page-title.service.md) | Sets the page title. | [Source](../../lib/core/services/page-title.service.ts) | -| [People content service](people-content.service.md) | Gets information about a Content Services user. | [Source](../../lib/core/services/people-content.service.ts) | +| [People content service](people-content.service.md) | Gets information about a Content Services user. | [Source](../../lib/core/services/people-content.service.ts) | | [People process service](people-process.service.md) | Gets information about Process Services users. | [Source](../../lib/core/services/people-process.service.ts) | | [Renditions service](renditions.service.md) ![Deprecated](../docassets/images/DeprecatedIcon.png) | Manages prearranged conversions of content to different formats. | [Source](../../lib/core/services/renditions.service.ts) | | [Search configuration service](search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../../lib/core/services/search-configuration.service.ts) | @@ -134,5 +134,5 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Data Table Adapter interface](datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../../lib/core/datatable/data/datatable-adapter.ts) | -| [Form Field Validator interface](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) | +| [Form Field Validator interface](form-field-validator.interface.md) | Defines how the input fields of [`Form`](../../lib/process-services/task-list/models/form.model.ts) and Task Details components are validated. | [Source](../../lib/core/form/components/widgets/core/form-field-validator.ts) | | [Search Configuration interface](search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../../lib/core/services/search-configuration.service.ts) | diff --git a/docs/core/accordion-group.component.md b/docs/core/accordion-group.component.md index 8565f9de52..101df471da 100644 --- a/docs/core/accordion-group.component.md +++ b/docs/core/accordion-group.component.md @@ -40,18 +40,16 @@ export class MyComponent implements OnInit { ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | hasAccordionIcon | `boolean` | true | Should the (expanded) accordion icon be shown? | | heading | `string` | | Title heading for the group. | | headingIcon | `string` | | The material design icon. | | headingIconTooltip | `string` | | Tooltip message to be shown for headingIcon | -| isOpen | | | Is this group currently open? | -| isSelected | | | Is this group currently selected? | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | headingClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the heading is clicked. | ## Details diff --git a/docs/core/alfresco-api.service.md b/docs/core/alfresco-api.service.md index 169b552548..4c01652b8d 100644 --- a/docs/core/alfresco-api.service.md +++ b/docs/core/alfresco-api.service.md @@ -46,7 +46,7 @@ export class MyComponent implements OnInit { | Name | Type | Description | | ---- | ---- | ----------- | -| nodeUpdated | `Subject` | Emitted when a node updates. | +| nodeUpdated | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when a node updates. | ## Details diff --git a/docs/core/app-config.service.md b/docs/core/app-config.service.md index 5d504de5ec..ad83ddf173 100644 --- a/docs/core/app-config.service.md +++ b/docs/core/app-config.service.md @@ -11,11 +11,10 @@ Supports app configuration settings, stored server side. ### Methods -- **get**(key: `string` = `null`, defaultValue?: `T` = `null`): `T`
+- **get**(key: `string`, defaultValue?: )
Gets the value of a named property. - _key:_ `string` - Name of the property - - _defaultValue:_ `T` - (Optional) Value to return if the key is not found - - **Returns** `T` - Value of the property + - _defaultValue:_ - (Optional) Value to return if the key is not found - **getLocationHostname**(): `string`
Gets the location.hostname property. - **Returns** `string` - Value of the property @@ -26,10 +25,10 @@ Supports app configuration settings, stored server side. - **getLocationProtocol**(): `string`
Gets the location.protocol value. - **Returns** `string` - -- **load**(): `Promise`
+- **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
Loads the config file. - - **Returns** `Promise` - Notification when loading is complete -- **select**(property: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - Notification when loading is complete +- **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Requests notification of a property value when it is loaded. - _property:_ `string` - The desired property value - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Property value, when loaded @@ -83,7 +82,7 @@ export class AppModule { } Below is a simple example of using the [`AppConfigService`](../core/app-config.service.md) in practice. -**app.component.ts** +**[app.component](../../demo-shell/src/app/app.component.ts).ts** ```ts import { AppConfigService } from '@alfresco/adf-core'; diff --git a/docs/core/apps-process.service.md b/docs/core/apps-process.service.md index efabc5e515..cab6212d62 100644 --- a/docs/core/apps-process.service.md +++ b/docs/core/apps-process.service.md @@ -12,14 +12,14 @@ Gets details of the Process Services apps that are deployed for the user. ### Methods -- **getApplicationDetailsById**(appId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`
+- **getApplicationDetailsById**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`
Gets the details for a specific app ID number. - _appId:_ `number` - ID of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>` - Details of the app - **getDeployedApplications**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`[]>`
Gets a list of deployed apps for this user. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`[]>` - The list of deployed apps -- **getDeployedApplicationsByName**(name: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`
+- **getDeployedApplicationsByName**(name: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`
Gets a list of deployed apps for this user, where the app name is `name`. - _name:_ `string` - Name of the app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>` - The list of deployed apps diff --git a/docs/core/authentication.service.md b/docs/core/authentication.service.md index 1d2edd0984..1c1a1c7806 100644 --- a/docs/core/authentication.service.md +++ b/docs/core/authentication.service.md @@ -12,63 +12,75 @@ Provides authentication to ACS and APS. ### Methods +- **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - + - **getBpmUsername**(): `string`
Gets the BPM username - **Returns** `string` - The BPM username - **getEcmUsername**(): `string`
Gets the ECM username. - **Returns** `string` - The ECM username -- **getRedirect**(provider: `string` = `null`): `any[]`
+- **getRedirect**(provider: `string`): `string`
Gets the URL to redirect to after login. - _provider:_ `string` - Service provider. Can be "ECM", "BPM" or "ALL". - - **Returns** `any[]` - The redirect URL -- **getTicketBpm**(): `string | null`
+ - **Returns** `string` - The redirect URL +- **getTicketBpm**(): `string|null`
Gets the BPM ticket stored in the Storage. - - **Returns** `string | null` - The ticket or `null` if none was found -- **getTicketEcm**(): `string | null`
+ - **Returns** `string|null` - The ticket or `null` if none was found +- **getTicketEcm**(): `string|null`
Gets the ECM ticket stored in the Storage. - - **Returns** `string | null` - The ticket or `null` if none was found -- **getTicketEcmBase64**(): `string | null`
+ - **Returns** `string|null` - The ticket or `null` if none was found +- **getTicketEcmBase64**(): `string|null`
Gets the BPM ticket from the Storage in Base 64 format. - - **Returns** `string | null` - The ticket or `null` if none was found -- **handleError**(error: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** `string|null` - The ticket or `null` if none was found +- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Prints an error message in the console browser - _error:_ `any` - Error message - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object representing the error message +- **isALLProvider**(): `boolean`
+ + - **Returns** `boolean` - + +- **isBPMProvider**(): `boolean`
+ + - **Returns** `boolean` - + - **isBpmLoggedIn**(): `boolean`
Checks if the user is logged in on a BPM provider. - **Returns** `boolean` - True if logged in, false otherwise +- **isECMProvider**(): `boolean`
+ + - **Returns** `boolean` - + - **isEcmLoggedIn**(): `boolean`
Checks if the user is logged in on an ECM provider. - **Returns** `boolean` - True if logged in, false otherwise - **isLoggedIn**(): `boolean`
Checks if the user logged in. - **Returns** `boolean` - True if logged in, false otherwise +- **isOauth**(): `boolean`
+ + - **Returns** `boolean` - + - **isRememberMeSet**(): `boolean`
Checks whether the "remember me" cookie was set or not. - **Returns** `boolean` - True if set, false otherwise -- **login**(username: `string` = `null`, password: `string` = `null`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Logs the user in. - _username:_ `string` - Username for the login - _password:_ `string` - Password for the login - _rememberMe:_ `boolean` - Stores the user's login details if true - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket - **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Logs the user out. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Response event called when logout is complete -- **removeTicket**()
- Removes the login ticket from Storage. -- **saveTicketAuth**()
- Saves the AUTH ticket in the Storage. -- **saveTicketBpm**()
- Saves the BPM ticket in the Storage. -- **saveTicketEcm**()
- Saves the ECM ticket in the Storage. -- **saveTickets**()
- Saves the ECM and BPM ticket in the Storage. -- **setRedirect**(url: [`RedirectionModel`](../../lib/core/models/redirection.model.ts) = `null`)
+- **setRedirect**(url: [`RedirectionModel`](../../lib/core/models/redirection.model.ts))
Sets the URL to redirect to after login. - _url:_ [`RedirectionModel`](../../lib/core/models/redirection.model.ts) - URL to redirect to +- **ssoImplicitLogin**()
+ Logs the user in with SSO ## Details diff --git a/docs/core/card-item-types.service.md b/docs/core/card-item-types.service.md index 739e5ec314..63b71b8787 100644 --- a/docs/core/card-item-types.service.md +++ b/docs/core/card-item-types.service.md @@ -12,20 +12,20 @@ Maps type names to field component types for the [Card View component](../core/c ### Methods -- **getComponentTypeResolver**(type: `string` = `null`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../lib/core/services/dynamic-component-mapper.service.ts)
+- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): `DynamicComponentResolveFunction`
Gets the currently active ComponentTypeResolver function for a field type. - _type:_ `string` - The type whose resolver you want - _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped - - **Returns** [`DynamicComponentResolveFunction`](../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function -- **resolveComponentType**(model: [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts) = `null`, defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`
+ - **Returns** `DynamicComponentResolveFunction` - Resolver function +- **resolveComponentType**(model: `DynamicComponentModel`, defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__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/task-list/models/form.model.ts) field model for the field to render + - _model:_ `DynamicComponentModel` - [Form](../../lib/process-services/task-list/models/form.model.ts) field model for the field to render - _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped. - **Returns** `Type<__type>` - Component type -- **setComponentTypeResolver**(type: `string` = `null`, resolver: [`DynamicComponentResolveFunction`](../../lib/core/services/dynamic-component-mapper.service.ts) = `null`, override: `boolean` = `true`)
+- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)
Sets or optionally replaces a ComponentTypeResolver function 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` - The new resolver function - _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true ## Details @@ -39,13 +39,13 @@ The default mapping is shown below: | Type string | Component | | ----------- | --------- | -| 'text' | CardViewTextItemComponent | -| 'int' | CardViewTextItemComponent | -| 'float' | CardViewTextItemComponent | -| 'date' | CardViewDateItemComponent | -| 'datetime' | CardViewDateItemComponent | -| 'bool' | CardViewBoolItemComponent | -| 'map' | CardViewMapItemComponent | +| 'text' | [`CardViewTextItemComponent`](../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) | +| 'int' | [`CardViewTextItemComponent`](../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) | +| 'float' | [`CardViewTextItemComponent`](../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) | +| 'date' | [`CardViewDateItemComponent`](../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | +| 'datetime' | [`CardViewDateItemComponent`](../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) | +| 'bool' | [`CardViewBoolItemComponent`](../../lib/core/card-view/components/card-view-boolitem/card-view-boolitem.component.ts) | +| 'map' | [`CardViewMapItemComponent`](../../lib/core/card-view/components/card-view-mapitem/card-view-mapitem.component.ts) | ### Adding new type mappings diff --git a/docs/core/card-view.component.md b/docs/core/card-view.component.md index 006522e8a0..192efbf15b 100644 --- a/docs/core/card-view.component.md +++ b/docs/core/card-view.component.md @@ -94,10 +94,10 @@ Defining properties from Typescript: ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. | | editable | `boolean` | | Toggles whether or not the items can be edited. | -| properties | [`CardViewItem`](../../lib/core/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. | +| properties | `CardViewItem[]` | | (**required**) Items to show in the card view. | ## Details @@ -110,7 +110,7 @@ You define the property list, the [`CardViewComponent`](../core/card-view.compon - [**CardViewBoolItemModel**](#card-bool-item) - _for bool items (checkbox)_ - [**CardViewIntItemModel**](#card-int-item) - _for integer items_ - [**CardViewFloatItemModel**](#card-float-item) - _for float items_ -- [**CardViewKeyValuePairsItemModel**](#card-key-values-pairs-item) - _for key-value-pairs items_ +- [**CardViewKeyValuePairsItemModel**](#card-key-value-pairs-item) - _for key-value-pairs items_ - [**CardViewSelectItemModel**](#card-select-item) - _for select items_ Each of these types implements the [Card View Item interface](card-view-item.interface.md): @@ -315,7 +315,6 @@ const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options); | editable | boolean | false | Toggles whether the item is editable | | value\* | `[{ name: '', value: '' }, ...]` | | The original data value for the item | - #### Card Select Item [`CardViewSelectItemModel`](../../lib/core/card-view/models/card-view-selectitem.model.ts) is a property type for select properties. @@ -330,9 +329,7 @@ const selectItemProperty = new CardViewSelectItemModel(options); | key\* | string | | Identifying key (important when editing the item) | | editable | boolean | false | Toggles whether the item is editable | | value | string | | The original data value for the item | -| options$\* | Observable | | The original data value for the item | - - +| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)<CardViewSelectItemOption\[]> | | The original data value for the item | ## See also diff --git a/docs/core/comment-content.service.md b/docs/core/comment-content.service.md index df05cb9191..415d1214ad 100644 --- a/docs/core/comment-content.service.md +++ b/docs/core/comment-content.service.md @@ -12,12 +12,12 @@ Adds and retrieves comments for nodes in Content Services. ### Methods -- **addNodeComment**(nodeId: `string` = `null`, message: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>`
+- **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>`
Adds a comment to a node. - _nodeId:_ `string` - ID of the target node - _message:_ `string` - Text for the comment - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>` - Details of the comment added -- **getNodeComments**(nodeId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>`
+- **getNodeComments**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>`
Gets all comments that have been added to a node. - _nodeId:_ `string` - ID of the target node - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>` - Details for each comment diff --git a/docs/core/comment-list.component.md b/docs/core/comment-list.component.md index c64fddf4d0..d725068bb2 100644 --- a/docs/core/comment-list.component.md +++ b/docs/core/comment-list.component.md @@ -62,11 +62,11 @@ In the component template use the [comment list component](../core/comment-list. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | comments | [`CommentModel`](../../lib/core/models/comment.model.ts)`[]` | | The comments data used to populate the list. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>` | Emitted when the user clicks on one of the comment rows. | diff --git a/docs/core/comment-process.service.md b/docs/core/comment-process.service.md index 34fde0c45e..694ea58890 100644 --- a/docs/core/comment-process.service.md +++ b/docs/core/comment-process.service.md @@ -12,21 +12,21 @@ Adds and retrieves comments for task and process instances in Process Services. ### Methods -- **addProcessInstanceComment**(processInstanceId: `string` = `null`, message: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>`
+- **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>`
Adds a comment to a process instance. - _processInstanceId:_ `string` - ID of the target process instance - _message:_ `string` - Text for the comment - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>` - Details of the comment added -- **addTaskComment**(taskId: `string` = `null`, message: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>`
+- **addTaskComment**(taskId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>`
Adds a comment to a task. - _taskId:_ `string` - ID of the target task - _message:_ `string` - Text for the comment - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>` - Details about the comment -- **getProcessInstanceComments**(processInstanceId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>`
+- **getProcessInstanceComments**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>`
Gets all comments that have been added to a process instance. - _processInstanceId:_ `string` - ID of the target process instance - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>` - Details for each comment -- **getTaskComments**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>`
+- **getTaskComments**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>`
Gets all comments that have been added to a task. - _taskId:_ `string` - ID of the target task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>` - Details for each comment diff --git a/docs/core/comments.component.md b/docs/core/comments.component.md index 102fd14615..197a91797e 100644 --- a/docs/core/comments.component.md +++ b/docs/core/comments.component.md @@ -32,7 +32,7 @@ Displays comments from users involved in a specified task or content and allows ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | nodeId | `string` | | The numeric ID of the node. | | readOnly | `boolean` | false | Are the comments read only? | | taskId | `string` | | The numeric ID of the task. | @@ -40,5 +40,5 @@ Displays comments from users involved in a specified task or content and allows ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while displaying/adding a comment. | diff --git a/docs/core/content.service.md b/docs/core/content.service.md index 47ab85c6cd..8a061a0d21 100644 --- a/docs/core/content.service.md +++ b/docs/core/content.service.md @@ -12,57 +12,57 @@ Accesses app-generated data objects via URLs and file downloads. ### Methods -- **createFolder**(relativePath: `string` = `null`, name: `string` = `null`, parentId?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FolderCreatedEvent`](../../lib/core/events/folder-created.event.ts)`>`
+- **createFolder**(relativePath: `string`, name: `string`, parentId?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Creates a folder. - _relativePath:_ `string` - Location to create the folder - _name:_ `string` - Folder name - _parentId:_ `string` - (Optional) Node ID of parent folder - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FolderCreatedEvent`](../../lib/core/events/folder-created.event.ts)`>` - Information about the new folder -- **createTrustedUrl**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) = `null`): `string`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Information about the new folder +- **createTrustedUrl**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)): `string`
Creates a trusted object URL from the [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob). WARNING: calling this method with untrusted user data exposes your application to XSS security risks! - _blob:_ [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) - Data to wrap into object URL - **Returns** `string` - URL string -- **downloadBlob**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) = `null`, fileName: `string` = `null`)
+- **downloadBlob**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob), fileName: `string`)
Invokes content download for a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) with a file name. - _blob:_ [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) - Content to download. - _fileName:_ `string` - Name of the resulting file. -- **downloadData**(data: `any` = `null`, fileName: `string` = `null`)
+- **downloadData**(data: `any`, fileName: `string`)
Invokes content download for a data array with a file name. - _data:_ `any` - Data to download. - _fileName:_ `string` - Name of the resulting file. -- **downloadJSON**(json: `any` = `null`, fileName: `string` = `null`)
+- **downloadJSON**(json: `any`, fileName: `string`)
Invokes content download for a JSON object with a file name. - _json:_ `any` - JSON object to download. - _fileName:_ `string` - Name of the resulting file. -- **getContentUrl**(node: `any` = `null`, attachment?: `boolean` = `null`, ticket?: `string` = `null`): `string`
+- **getContentUrl**(node: `any`, attachment?: `boolean`, ticket?: `string`): `string`
Gets a content URL for the given node. - _node:_ `any` - Node to get URL for. - _attachment:_ `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download - _ticket:_ `string` - (Optional) Custom ticket to use for authentication - **Returns** `string` - URL string -- **getDocumentThumbnailUrl**(node: `any` = `null`, attachment?: `boolean` = `null`, ticket?: `string` = `null`): `string`
+- **getDocumentThumbnailUrl**(node: `any`, attachment?: `boolean`, ticket?: `string`): `string`
Gets a thumbnail URL for the given document node. - _node:_ `any` - Node to get URL for. - _attachment:_ `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download - _ticket:_ `string` - (Optional) Custom ticket to use for authentication - **Returns** `string` - URL string -- **getNode**(nodeId: `string` = `null`, opts?: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
+- **getNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Gets a Node via its node ID. - _nodeId:_ `string` - ID of the target node - _opts:_ `any` - (Optional) Options supported by JSAPI - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder -- **getNodeContent**(nodeId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getNodeContent**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets content for the given node. - _nodeId:_ `string` - ID of the target node - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Content data -- **hasAllowableOperations**(node: `any` = `null`): `boolean`
+- **hasAllowableOperations**(node: `any`): `boolean`
Checks if the node has the properties allowableOperations - _node:_ `any` - Node to check allowableOperations - **Returns** `boolean` - True if the node has the property, false otherwise -- **hasPermission**(node: `Node` = `null`, permission: [`PermissionsEnum`](../../lib/core/models/permissions.enum.ts)` | string` = `null`): `boolean`
+- **hasPermission**(node: `Node`, permission: [`PermissionsEnum`](../../lib/core/models/permissions.enum.ts)`|string`): `boolean`
Checks if the user has permissions on that node - _node:_ `Node` - Node to check allowableOperations - - _permission:_ [`PermissionsEnum`](../../lib/core/models/permissions.enum.ts)` | string` - Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions + - _permission:_ [`PermissionsEnum`](../../lib/core/models/permissions.enum.ts)`|string` - Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions - **Returns** `boolean` - True if the user has the required permissions, false otherwise ## Details diff --git a/docs/core/context-menu.directive.md b/docs/core/context-menu.directive.md index 4df63fef93..6559d64361 100644 --- a/docs/core/context-menu.directive.md +++ b/docs/core/context-menu.directive.md @@ -47,9 +47,9 @@ export class MyComponent implements OnInit { ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| context-menu-enabled | `boolean` | false | Is the menu enabled? | -| context-menu | `any[]` | | Items for the menu. | +| ---- | ---- | ------------- | ----------- | +| enabled | `boolean` | false | Is the menu enabled? | +| links | `any[]` | | Items for the menu. | ## Details diff --git a/docs/core/cookie.service.md b/docs/core/cookie.service.md index dacf9e34b0..2ad9511047 100644 --- a/docs/core/cookie.service.md +++ b/docs/core/cookie.service.md @@ -14,19 +14,19 @@ Stores key-value data items as browser cookies. - **clear**()
-- **getItem**(key: `string` = `null`): `string | null`
+- **getItem**(key: `string`): `string|null`
Retrieves a cookie by its key. - _key:_ `string` - Key to identify the cookie - - **Returns** `string | null` - The cookie data or null if it is not found + - **Returns** `string|null` - The cookie data or null if it is not found - **isEnabled**(): `boolean`
Checks if cookies are enabled. - **Returns** `boolean` - True if enabled, false otherwise -- **setItem**(key: `string` = `null`, data: `string` = `null`, expiration: `Date | null` = `null`, path: `string | null` = `null`)
+- **setItem**(key: `string`, data: `string`, expiration: `Date|null`, path: `string|null`)
Sets a cookie. - _key:_ `string` - Key to identify the cookie - _data:_ `string` - Data value to set for the cookie - - _expiration:_ `Date | null` - Expiration date of the data - - _path:_ `string | null` - "Pathname" to store the cookie + - _expiration:_ `Date|null` - Expiration date of the data + - _path:_ `string|null` - "Pathname" to store the cookie ## Details diff --git a/docs/core/data-column.component.md b/docs/core/data-column.component.md index 7b29b96e1a..ecdba3bd38 100644 --- a/docs/core/data-column.component.md +++ b/docs/core/data-column.component.md @@ -10,19 +10,14 @@ Defines column properties for DataTable, Tasklist, Document List and other compo ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - - [Details](#details) - - [Conditional visibility](#conditional-visibility) - [Automatic column header translation](#automatic-column-header-translation) - [Custom tooltips](#custom-tooltips) - [Column Template](#column-template) - [Styling Techniques](#styling-techniques) - - [See also](#see-also) ## Basic Usage @@ -44,13 +39,13 @@ Defines column properties for DataTable, Tasklist, Document List and other compo ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| class | `string` | | Additional CSS class to be applied to column (header and cells). | +| ---- | ---- | ------------- | ----------- | +| cssClass | `string` | | Additional CSS class to be applied to column (header and cells). | | format | `string` | | Value format (if supported by the parent component), for example format of the date. | | formatTooltip | `Function` | | Custom tooltip formatter function. | | key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. | | sortable | `boolean` | true | Toggles ability to sort by this column, for example by clicking the column header. | -| sr-title | `string` | | Title to be used for screen readers. | +| srTitle | `string` | | Title to be used for screen readers. | | title | `string` | "" | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. | | type | `string` | "text" | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize' and 'location'. | diff --git a/docs/core/datatable.component.md b/docs/core/datatable.component.md index d11baa5037..89ddd04bdd 100644 --- a/docs/core/datatable.component.md +++ b/docs/core/datatable.component.md @@ -15,16 +15,11 @@ See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/ ## Contents - [Basic usage](#basic-usage) - - [Setting the rows and column schema](#setting-the-rows-and-column-schema) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Details](#details) - - [Supplying data for the table](#supplying-data-for-the-table) - [Customizing columns](#customizing-columns) - [DataTable DOM Events](#datatable-dom-events) @@ -32,12 +27,11 @@ See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/ - [Custom Empty content template](#custom-empty-content-template) - [Loading content template](#loading-content-template) - [Using events](#using-events) - - [See also](#see-also) ## Basic usage -**app.component.html** +**[app.component](../../demo-shell/src/app/app.component.ts).html** ```html ``` -**app.component.ts** +**[app.component](../../demo-shell/src/app/app.component.ts).ts** ```ts import { ObjectDataTableAdapter } from '@alfresco/adf-core'; @@ -84,7 +78,7 @@ export class DataTableDemo { ### Setting the rows and column schema -You can set rows and columns to the [ObjectDataTableAdapter](../../lib/core/datatable/data/object-datatable-adapter.ts) like shown below: +You can set rows and columns to the [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) like shown below: ```ts import { ObjectDataTableAdapter } from '@alfresco/adf-core'; @@ -161,7 +155,7 @@ export class DataTableDemo { ``` -You can also set rows to the [ObjectDataTableAdapter](../../lib/core/datatable/data/object-datatable-adapter.ts) and set columns as an input like shown below : +You can also set rows to the [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) and set columns as an input like shown below : ```ts import { ObjectDataTableAdapter } from '@alfresco/adf-core'; @@ -256,34 +250,35 @@ export class DataTableDemo { ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | actions | `boolean` | false | Toggles the data actions column. | | actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | | allowDropFiles | `boolean` | false | Toggles file drop support for rows (see [Upload directive](upload.directive.md) for further details). | -| columns | `any[]` | \[] | The columns that the datatable will show. | +| columns | `any[]` | \[] | The columns that the datatable will show. | | contextMenu | `boolean` | false | Toggles custom context menu for the component. | -| data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | | Data source for the table | -| display | `string` | [`DisplayMode`](../../lib/core/datatable/components/datatable/datatable.component.ts).List | Selects the display mode of the table. Can be "list" or "gallery". | +| data | `DataTableAdapter` | | Data source for the table | +| display | `string` | DisplayMode.List | Selects the display mode of the table. Can be "list" or "gallery". | | fallbackThumbnail | `string` | | Fallback image for rows where the thumbnail is missing. | | loading | `boolean` | false | Flag that indicates if the datatable is in loading state and needs to show the loading template (see the docs to learn how to configure a loading template). | | multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row. | | noPermission | `boolean` | false | Flag that indicates if the datatable should show the "no permission" template. | +| rowMenuCacheEnabled | `boolean` | true | | | rowStyle | `string` | | The inline style to apply to every row. See [NgStyle](https://angular.io/docs/ts/latest/api/common/index/NgStyle-directive.html) docs for more details and usage examples. | | rowStyleClass | `string` | "" | The CSS class to apply to every row. | -| rows | `any[]` | \[] | The rows that the datatable will show. | +| rows | `any[]` | \[] | The rows that the datatable will show. | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | | showHeader | `boolean` | true | Toggles the header. | -| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : [`created`, `desc`], [`created`, `asc`], [`due`, `desc`], [`due`, `asc`] | +| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : [`created`, `desc`], [`created`, `asc`], [`due`, `desc`], [`due`, `asc`] | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../lib/core/datatable/components/datatable/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | -| rowDblClick | `EventEmitter` | Emitted when the user double-clicks a row. | -| showRowActionsMenu | `EventEmitter` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | `EventEmitter` | Emitted before the context menu is displayed for a row. | +| 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/datatable/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/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | ## Details diff --git a/docs/core/deleted-nodes-api.service.md b/docs/core/deleted-nodes-api.service.md index 1b5b6edce1..a9b4f16a00 100644 --- a/docs/core/deleted-nodes-api.service.md +++ b/docs/core/deleted-nodes-api.service.md @@ -12,7 +12,7 @@ Gets a list of Content Services nodes currently in the trash. ### Methods -- **getDeletedNodes**(options?: `Object` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
+- **getDeletedNodes**(options?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets a list of nodes in the trash. - _options:_ `Object` - (Optional) Options for JSAPI call - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of nodes in the trash diff --git a/docs/core/ecm-user.service.md b/docs/core/ecm-user.service.md index 812ee19c17..233815b81a 100644 --- a/docs/core/ecm-user.service.md +++ b/docs/core/ecm-user.service.md @@ -15,11 +15,11 @@ Gets information about a Content Services user. - **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../core/ecm-user.model.md)`>`
Gets information about the user who is currently logged-in. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../core/ecm-user.model.md)`>` - User information as for getUserInfo -- **getUserInfo**(userName: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../core/ecm-user.model.md)`>`
+- **getUserInfo**(userName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../core/ecm-user.model.md)`>`
Gets information about a user identified by their username. - _userName:_ `string` - Target username - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../core/ecm-user.model.md)`>` - User information -- **getUserProfileImage**(avatarId: `string` = `null`): `string`
+- **getUserProfileImage**(avatarId: `string`): `string`
Returns a profile image as a URL. - _avatarId:_ `string` - Target avatar - **Returns** `string` - Image URL diff --git a/docs/core/empty-content.component.md b/docs/core/empty-content.component.md index 67dd7d87bb..eef8d8561f 100644 --- a/docs/core/empty-content.component.md +++ b/docs/core/empty-content.component.md @@ -31,7 +31,7 @@ Provides a generic "Empty Content" placeholder for components. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | icon | `string` | "cake" | Material Icon to use | | subtitle | `string` | "" | String or Resource Key for the title | | title | `string` | "" | String or Resource Key for the subtitle | diff --git a/docs/core/favorites-api.service.md b/docs/core/favorites-api.service.md index b3f269fab9..dda7002344 100644 --- a/docs/core/favorites-api.service.md +++ b/docs/core/favorites-api.service.md @@ -12,12 +12,12 @@ Gets a list of items a user has marked as their favorites. ### Methods -- **getFavorites**(personId: `string` = `null`, options?: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
+- **getFavorites**(personId: `string`, options?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets the favorites for a user. - _personId:_ `string` - ID of the user - _options:_ `any` - (Optional) Options supported by JSAPI - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of favorites -- **remapFavoriteEntries**(entries: `any[]` = `null`): `any[]`
+- **remapFavoriteEntries**(entries: `any[]`): `any[]`
- _entries:_ `any[]` - - **Returns** `any[]` - @@ -27,9 +27,9 @@ Gets a list of items a user has marked as their favorites. - _data:_ `any` - - **Returns** [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) - -- **remapEntry**(\_\_namedParameters: `object` = `null`): `any`
+- **remapEntry**(\_\_namedParameters: `Function`): `any`
- - _\_\_namedParameters:_ `object` - + - _\_\_namedParameters:_ `Function` - - **Returns** `any` - ## Details diff --git a/docs/core/form-field.component.md b/docs/core/form-field.component.md index f4e46ced6c..0c7380c00a 100644 --- a/docs/core/form-field.component.md +++ b/docs/core/form-field.component.md @@ -25,8 +25,8 @@ based on the field type or the metadata information. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| field | [`FormFieldModel`](../core/form-field.model.md) | null | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the [`FormFieldModel`](../core/form-field.model.md) definitions. | +| ---- | ---- | ------------- | ----------- | +| field | [`FormFieldModel`](../core/form-field.model.md) | null | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the [`FormFieldModel`](../core/form-field.model.md) definitions. | ## Details @@ -37,24 +37,24 @@ uses `` components to render the form fields. Forms defined in APS have the following default mappings for the form fields: -| APS Form Designer Widget | Field Type | Component Type | -| ------------------------ | ---------- | -------------- | -| Text | text | TextWidgetComponent | -| Multi-line text | multi-line-text | MultilineTextWidgetComponentComponent | -| Number | integer | NumberWidgetComponent | -| Checkbox | boolean | CheckboxWidgetComponent | -| Date | date | DateWidgetComponent | -| Dropdown | dropdown | DropdownWidgetComponent | -| Typeahead | typeahead | TypeaheadWidgetComponent | -| Amount | amount | AmountWidgetComponent | -| Radio buttons | radio-buttons | RadioButtonsWidgetComponent | -| People | people | PeopleWidgetComponent | -| Group of people | functional-group | FunctionalGroupWidgetComponent | -| Dynamic table | dynamic-table | DynamicTableWidgetComponent | -| Hyperlink | hyperlink | HyperlinkWidgetComponent | -| Header | group | ContainerWidgetComponent | -| Attach File | upload | AttachWidgetComponent or UploadWidgetComponent (based on metadata) | +| APS [`Form`](../../lib/process-services/task-list/models/form.model.ts) Designer Widget | Field Type | Component Type | +| --------------------------------------------------------------------------------------- | ---------- | -------------- | +| Text | text | [`TextWidgetComponent`](../../lib/core/form/components/widgets/text/text.widget.ts) | +| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) | +| Number | integer | [`NumberWidgetComponent`](../../lib/core/form/components/widgets/number/number.widget.ts) | +| Checkbox | boolean | [`CheckboxWidgetComponent`](../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) | +| Date | date | [`DateWidgetComponent`](../../lib/core/form/components/widgets/date/date.widget.ts) | +| Dropdown | dropdown | [`DropdownWidgetComponent`](../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) | +| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) | +| Amount | amount | [`AmountWidgetComponent`](../../lib/core/form/components/widgets/amount/amount.widget.ts) | +| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) | +| People | people | [`PeopleWidgetComponent`](../../lib/core/form/components/widgets/people/people.widget.ts) | +| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) | +| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) | +| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) | +| Header | group | [`ContainerWidgetComponent`](../../lib/core/form/components/widgets/container/container.widget.ts) | +| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) | | Display value | readonly | DisplayValueWidgetComponent | -| Display text | readonly-text | DisplayTextWidgetComponentComponent | -| N/A | container | ContainerWidgetComponent (layout component) | -| N/A | N/A | UnknownWidgetComponent | +| Display text | readonly-text | [`DisplayTextWidgetComponentComponent`](../../lib/core/form/components/widgets/display-text/display-text.widget.ts) | +| N/A | container | [`ContainerWidgetComponent`](../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) | +| N/A | N/A | [`UnknownWidgetComponent`](../../lib/core/form/components/widgets/unknown/unknown.widget.ts) | diff --git a/docs/core/form-field.model.md b/docs/core/form-field.model.md index fdc98bd592..1838604abe 100644 --- a/docs/core/form-field.model.md +++ b/docs/core/form-field.model.md @@ -41,13 +41,13 @@ Contains the value and metadata for a field of a [`Form`](../../lib/process-serv | 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 | 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/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\[] | \[] | Fields contained within a container field | -| columns | ContainerColumnModel\[] | \[] | Column definitions for a container field | +| fields | [`FormFieldModel`](../core/form-field.model.md)\[] | \[] | Fields contained within a container field | +| columns | [`ContainerColumnModel`](../../lib/core/form/components/widgets/core/container-column.model.ts)\[] | \[] | Column definitions for a container field | | emptyOption | FormFieldOption | | Dropdown menu item to use when no option is chosen | | validationSummary | string | | Error/information message added during field validation (see [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) interface) | diff --git a/docs/core/form-list.component.md b/docs/core/form-list.component.md index 3c0afdb980..79c9d56526 100644 --- a/docs/core/form-list.component.md +++ b/docs/core/form-list.component.md @@ -20,5 +20,5 @@ Shows APS forms as a list. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| forms | `any[]` | \[] | The array that contains the information to show inside the list. | +| ---- | ---- | ------------- | ----------- | +| forms | `any[]` | \[] | The array that contains the information to show inside the list. | diff --git a/docs/core/form-rendering.service.md b/docs/core/form-rendering.service.md index 09e564367b..04ae77e32a 100644 --- a/docs/core/form-rendering.service.md +++ b/docs/core/form-rendering.service.md @@ -12,20 +12,20 @@ Maps an APS form field type string onto the corresponding form [widget component ### Methods -- **getComponentTypeResolver**(type: `string` = `null`, defaultValue: `Type<__type>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../lib/core/services/dynamic-component-mapper.service.ts)
+- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<__type>` = `this.defaultValue`): `DynamicComponentResolveFunction`
Gets the currently active ComponentTypeResolver function for a field type. - _type:_ `string` - The type whose resolver you want - _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped - - **Returns** [`DynamicComponentResolveFunction`](../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function -- **resolveComponentType**(model: [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts) = `null`, defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`
+ - **Returns** `DynamicComponentResolveFunction` - Resolver function +- **resolveComponentType**(model: `DynamicComponentModel`, defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__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/task-list/models/form.model.ts) field model for the field to render + - _model:_ `DynamicComponentModel` - [Form](../../lib/process-services/task-list/models/form.model.ts) field model for the field to render - _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped. - **Returns** `Type<__type>` - Component type -- **setComponentTypeResolver**(type: `string` = `null`, resolver: [`DynamicComponentResolveFunction`](../../lib/core/services/dynamic-component-mapper.service.ts) = `null`, override: `boolean` = `true`)
+- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)
Sets or optionally replaces a ComponentTypeResolver function 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` - The new resolver function - _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true ## Details @@ -63,23 +63,23 @@ The [`Form`](../../lib/process-services/task-list/models/form.model.ts) Renderin | Stencil name | Field type string | Component type | | ------------ | ----------------- | -------------- | -| Amount | "amount" | AmountWidgetComponent | -| Attach | "upload" | AttachWidgetComponent or UploadWidgetComponent (based on metadata) | -| Checkbox | "boolean" | CheckboxWidgetComponent | -| Date | "date" | DateWidgetComponent | -| Display text | "readonly-text" | DisplayTextWidgetComponentComponent | +| Amount | "amount" | [`AmountWidgetComponent`](../../lib/core/form/components/widgets/amount/amount.widget.ts) | +| Attach | "upload" | AttachWidgetComponent or [`UploadWidgetComponent`](../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) | +| Checkbox | "boolean" | [`CheckboxWidgetComponent`](../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) | +| Date | "date" | [`DateWidgetComponent`](../../lib/core/form/components/widgets/date/date.widget.ts) | +| Display text | "readonly-text" | [`DisplayTextWidgetComponentComponent`](../../lib/core/form/components/widgets/display-text/display-text.widget.ts) | | Display value | "readonly" | DisplayValueWidgetComponent | -| Dropdown | "dropdown" | DropdownWidgetComponent | -| Dynamic table | "dynamic-table" | DynamicTableWidgetComponent | -| Group of people | "functional-group" | FunctionalGroupWidgetComponent | -| Header | "group" | ContainerWidgetComponent | -| Hyperlink | "hyperlink" | HyperlinkWidgetComponent | -| Multi-line text | "multi-line-text" | MultilineTextWidgetComponentComponent | -| Number | "integer" | NumberWidgetComponent | -| People | "people" | PeopleWidgetComponent | -| Radio buttons | "radio-buttons" | RadioButtonsWidgetComponent | -| Text | "text" | TextWidgetComponent | -| Typeahead | "typeahead" | TypeaheadWidgetComponent | +| Dropdown | "dropdown" | [`DropdownWidgetComponent`](../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) | +| Dynamic table | "dynamic-table" | [`DynamicTableWidgetComponent`](../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) | +| Group of people | "functional-group" | [`FunctionalGroupWidgetComponent`](../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) | +| Header | "group" | [`ContainerWidgetComponent`](../../lib/core/form/components/widgets/container/container.widget.ts) | +| Hyperlink | "hyperlink" | [`HyperlinkWidgetComponent`](../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) | +| Multi-line text | "multi-line-text" | [`MultilineTextWidgetComponentComponent`](../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) | +| Number | "integer" | [`NumberWidgetComponent`](../../lib/core/form/components/widgets/number/number.widget.ts) | +| People | "people" | [`PeopleWidgetComponent`](../../lib/core/form/components/widgets/people/people.widget.ts) | +| Radio buttons | "radio-buttons" | [`RadioButtonsWidgetComponent`](../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) | +| Text | "text" | [`TextWidgetComponent`](../../lib/core/form/components/widgets/text/text.widget.ts) | +| Typeahead | "typeahead" | [`TypeaheadWidgetComponent`](../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) | You can add new items to the mapping or replace existing items in order to customize the way fields are rendered. diff --git a/docs/core/form.component.md b/docs/core/form.component.md index da40a41d59..7b55853f13 100644 --- a/docs/core/form.component.md +++ b/docs/core/form.component.md @@ -13,20 +13,15 @@ Shows a [`Form`](../../lib/process-services/task-list/models/form.model.ts) from ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Details](#details) - - [Displaying a form](#displaying-a-form) - [Custom empty form template](#custom-empty-form-template) - [Controlling outcome execution behaviour](#controlling-outcome-execution-behaviour) - [Field Validators](#field-validators) - [Common scenarios](#common-scenarios) - - [See also](#see-also) ## Basic Usage @@ -42,11 +37,11 @@ Shows a [`Form`](../../lib/process-services/task-list/models/form.model.ts) from ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| data | [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. | +| ---- | ---- | ------------- | ----------- | +| data | `FormValues` | | 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. | | disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | -| fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. | +| fieldValidators | `FormFieldValidator[]` | \[] | Contains a list of form field validator instances. | | form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. | | formId | `string` | | The id of the form definition to load and display with custom values. | | formName | `string` | | Name of the form definition to load and display with custom values. | @@ -66,14 +61,14 @@ Shows a [`Form`](../../lib/process-services/task-list/models/form.model.ts) from ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | 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. | -| formLoaded | `EventEmitter` | Emitted when the form is loaded or reloaded. | -| formSaved | `EventEmitter` | Emitted when the form is submitted with the `Save` or custom outcomes. | -| onError | `EventEmitter` | Emitted when any error occurs. | +| 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. | +| onError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | ## Details diff --git a/docs/core/form.service.md b/docs/core/form.service.md index 9471dabe4f..e6227a7626 100644 --- a/docs/core/form.service.md +++ b/docs/core/form.service.md @@ -38,96 +38,96 @@ class MyComponent { | Name | Args Type | Description | | ---- | --------- | ----------- | -| formLoaded | FormEvent | Raised when form has been loaded or reloaded | -| formFieldValueChanged | FormFieldEvent | Raised when input values change | -| taskCompleted | FormEvent | Raised when a task is completed successfully | -| taskCompletedError | FormErrorEvent | Raised when a task is completed unsuccessfully | -| taskSaved | FormEvent | Raised when a task is saved successfully | -| taskSavedError | FormErrorEvent | Raised when a task is saved unsuccessfully | -| executeOutcome | FormOutcomeEvent | Raised when a form outcome is executed | +| formLoaded | [`FormEvent`](../../lib/core/form/events/form.event.ts) | Raised when form has been loaded or reloaded | +| formFieldValueChanged | [`FormFieldEvent`](../../lib/core/form/events/form-field.event.ts) | Raised when input values change | +| taskCompleted | [`FormEvent`](../../lib/core/form/events/form.event.ts) | Raised when a task is completed successfully | +| taskCompletedError | [`FormErrorEvent`](../../lib/core/form/events/form-error.event.ts) | Raised when a task is completed unsuccessfully | +| taskSaved | [`FormEvent`](../../lib/core/form/events/form.event.ts) | Raised when a task is saved successfully | +| taskSavedError | [`FormErrorEvent`](../../lib/core/form/events/form-error.event.ts) | Raised when a task is saved unsuccessfully | +| executeOutcome | [`FormOutcomeEvent`](../../lib/core/form/components/widgets/core/form-outcome-event.model.ts) | Raised when a form outcome is executed | | formEvents | Event | You can subscribe to this event to listen : ( click, blur, change, focus, focusin, focusout, input, invalid, select) of any elements in the form , see doc below | -| validateForm | ValidateFormEvent | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. | -| validateFormField | ValidateFormFieldEvent | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. | +| validateForm | [`ValidateFormEvent`](../../lib/core/form/events/validate-form.event.ts) | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. | +| validateFormField | [`ValidateFormFieldEvent`](../../lib/core/form/events/validate-form-field.event.ts) | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. | ### Methods -- `parseForm(json: any, data?: `[`FormValues,`](../../lib/core/form/components/widgets/core/form-values.ts)` readOnly: boolean = false): `[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) +- `parseForm(json: any, data?:`[`FormValues,`](../../lib/core/form/components/widgets/core/form-values.ts)`readOnly: boolean = false):`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) Parses JSON data to create a corresponding [`Form`](../../lib/process-services/task-list/models/form.model.ts) model. - `json` - JSON to create the form - `data` - (Optional) Values for the form fields - `readOnly` - Should the form fields be read-only? -- `createFormFromANode(formName: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `createFormFromANode(formName: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Create a [`Form`](../../lib/process-services/task-list/models/form.model.ts) with a field for each metadata property. - `formName` - Name of the new form -- `createForm(formName: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `createForm(formName: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Create a [`Form`](../../lib/process-services/task-list/models/form.model.ts). - `formName` - Name of the new form -- `saveForm(formId: string, formModel: FormDefinitionModel): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `saveForm(formId: string, formModel: FormDefinitionModel):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Saves a form. - `formId` - ID of the form to save - `formModel` - Model data for the form -- `addFieldsToAForm(formId: string, formModel: FormDefinitionModel): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `addFieldsToAForm(formId: string, formModel: FormDefinitionModel):`[`Observable`](http://reactivex.io/documentation/observable.html)`` - `formId` - ID of the form - `formModel` - [`Form`](../../lib/process-services/task-list/models/form.model.ts) definition -- `searchFrom(name: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `searchFrom(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Search for a form by name. - `name` - The form name to search for -- `getForms(): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getForms():`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets all the forms. -- `getProcessDefinitions(): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getProcessDefinitions():`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get Process Definitions -- `getProcessVarablesById(processInstanceId: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getProcessVarablesById(processInstanceId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get instance variables for a process. - `processInstanceId` - ID of the target process -- `getTasks(): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getTasks():`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets all the tasks. -- `getTask(taskId: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getTask(taskId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets a task. - `taskId` - Task Id -- `saveTaskForm(taskId: string, formValues: FormValues): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `saveTaskForm(taskId: string, formValues: FormValues):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Save Task [`Form`](../../lib/process-services/task-list/models/form.model.ts). - `taskId` - Task Id - `formValues` - [`Form`](../../lib/process-services/task-list/models/form.model.ts) Values -- `completeTaskForm(taskId: string, formValues: `[`FormValues,`](../../lib/core/form/components/widgets/core/form-values.ts)` outcome?: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `completeTaskForm(taskId: string, formValues:`[`FormValues,`](../../lib/core/form/components/widgets/core/form-values.ts)`outcome?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Complete Task [`Form`](../../lib/process-services/task-list/models/form.model.ts) - `taskId` - Task Id - `formValues` - [`Form`](../../lib/process-services/task-list/models/form.model.ts) Values - `outcome` - (Optional) [`Form`](../../lib/process-services/task-list/models/form.model.ts) Outcome -- `getTaskForm(taskId: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getTaskForm(taskId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get [`Form`](../../lib/process-services/task-list/models/form.model.ts) related to a taskId - `taskId` - Task Id -- `getFormDefinitionById(formId: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getFormDefinitionById(formId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get [`Form`](../../lib/process-services/task-list/models/form.model.ts) Definition - `formId` - [`Form`](../../lib/process-services/task-list/models/form.model.ts) Id -- `getFormDefinitionByName(name: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getFormDefinitionByName(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Returns form definition with a given name. - `name` - The form name -- `getStartFormInstance(processId: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getStartFormInstance(processId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get start form instance for a given processId - `processId` - Process definition ID -- `getProcessIntance(processId: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getProcessIntance(processId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets a process instance. - `processId` - ID of the process to get -- `getStartFormDefinition(processId: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getStartFormDefinition(processId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Get start form definition for a given process - `processId` - Process definition ID -- `getRestFieldValues(taskId: string, field: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getRestFieldValues(taskId: string, field: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets values of fields populated by a REST backend. - `taskId` - Task identifier - `field` - Field identifier -- `getRestFieldValuesByProcessId(processDefinitionId: string, field: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getRestFieldValuesByProcessId(processDefinitionId: string, field: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets values of fields populated by a REST backend using a process ID. - `processDefinitionId` - Process identifier - `field` - Field identifier -- `getRestFieldValuesColumnByProcessId(processDefinitionId: string, field: string, column?: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getRestFieldValuesColumnByProcessId(processDefinitionId: string, field: string, column?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets column values of fields populated by a REST backend using a process ID. - `processDefinitionId` - Process identifier - `field` - Field identifier - `column` - (Optional) Column identifier -- `getRestFieldValuesColumn(taskId: string, field: string, column?: string): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `getRestFieldValuesColumn(taskId: string, field: string, column?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Gets column values of fields populated by a REST backend. - `taskId` - Task identifier - `field` - Field identifier @@ -152,6 +152,6 @@ class MyComponent { - `toJsonArray(res: any): any` Creates a JSON array representation of form data. - `res` - Object representing form data -- `handleError(error: any): `[`Observable`](http://reactivex.io/documentation/observable.html)`` +- `handleError(error: any):`[`Observable`](http://reactivex.io/documentation/observable.html)`` Reports an error message. - `error` - Data object with optional \`message\` and \`status\` fields for the error diff --git a/docs/core/highlight-transform.service.md b/docs/core/highlight-transform.service.md index 73dde5642d..6bf0af0e48 100644 --- a/docs/core/highlight-transform.service.md +++ b/docs/core/highlight-transform.service.md @@ -11,12 +11,12 @@ Adds HTML to a string to highlight chosen sections. ### Methods -- **highlight**(text: `string` = `null`, search: `string` = `null`, wrapperClass: `string` = `"highlight"`): [`HightlightTransformResult`](../../lib/core/services/highlight-transform.service.ts)
+- **highlight**(text: `string`, search: `string`, wrapperClass: `string` = `"highlight"`): `HightlightTransformResult`
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** [`HightlightTransformResult`](../../lib/core/services/highlight-transform.service.ts) - New text along with boolean value to indicate whether anything was highlighted + - **Returns** `HightlightTransformResult` - New text along with boolean value to indicate whether anything was highlighted ## Details diff --git a/docs/core/highlight.directive.md b/docs/core/highlight.directive.md index 546e221f48..2714c470c8 100644 --- a/docs/core/highlight.directive.md +++ b/docs/core/highlight.directive.md @@ -25,10 +25,10 @@ Adds highlighting to selected sections of an HTML element's content. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| adf-highlight-class | `string` | "adf-highlight" | CSS class used to apply highlighting. | -| adf-highlight | `string` | "" | Text to highlight. | -| adf-highlight-selector | `string` | "" | Class selector for highlightable elements. | +| ---- | ---- | ------------- | ----------- | +| classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. | +| search | `string` | "" | Text to highlight. | +| selector | `string` | "" | Class selector for highlightable elements. | ## Details diff --git a/docs/core/host-settings.component.md b/docs/core/host-settings.component.md index 8fdd9e146d..d8a01dcbc7 100644 --- a/docs/core/host-settings.component.md +++ b/docs/core/host-settings.component.md @@ -32,15 +32,15 @@ Validates the URLs for ACS and APS and saves them in the user's local storage ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| providers | `string[]` | ['BPM', 'ECM', 'ALL'] | Tells the component which provider option are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO . | +| ---- | ---- | ------------- | ----------- | +| providers | `string[]` | | Tells the component which provider option are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO . | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | bpmHostChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | (**Deprecated:** in 2.4.0) Emitted when the bpm host URL is changed. | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | | ecmHostChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | (**Deprecated:** in 2.4.0) Emitted when the ecm host URL is changed. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the URL is invalid. | -| success | `EventEmitter` | | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | diff --git a/docs/core/infinite-pagination.component.md b/docs/core/infinite-pagination.component.md index f1e9a4d992..18e645e30e 100644 --- a/docs/core/infinite-pagination.component.md +++ b/docs/core/infinite-pagination.component.md @@ -36,16 +36,16 @@ Adds "infinite" pagination to the component it is used with. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| loading | `boolean` | false | Is a new page loading? | -| pageSize | `number` | [`InfinitePaginationComponent`](../core/infinite-pagination.component.md).DEFAULT_PAGE_SIZE | Number of items that are added with each "load more" event. | -| pagination | [`PaginationModel`](../../lib/core/models/pagination.model.ts) | | (**Deprecated:** 2.3.0 [Pagination](../../lib/content-services/document-list/models/document-library.model.ts) object.) | +| ---- | ---- | ------------- | ----------- | +| isLoading | `boolean` | false | Is a new page loading? | +| pageSize | `number` | | Number of items that are added with each "load more" event. | +| pagination | [`PaginationModel`](../../lib/core/models/pagination.model.ts) | | (**Deprecated:** 2.3.0 [Pagination](../../lib/content-services/document-list/models/document-library.model.ts) object.) | | target | `PaginatedComponent` | | Component that provides custom pagination support. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the "Load More" button is clicked. | ## Details diff --git a/docs/core/info-drawer-tab.component.md b/docs/core/info-drawer-tab.component.md index 35498dedb8..73c253e258 100644 --- a/docs/core/info-drawer-tab.component.md +++ b/docs/core/info-drawer-tab.component.md @@ -51,8 +51,8 @@ Render tab with icon instead of labels: | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| label | `string` | '' | Tab label. | -| icon | `string` | null | The material design icon. | +| icon | `string` | null | Icon to render for the tab. | +| label | `string` | "Main tab" | The title of the tab. | ## Details diff --git a/docs/core/info-drawer.component.md b/docs/core/info-drawer.component.md index 10035b5ccc..eafeb6ad3b 100644 --- a/docs/core/info-drawer.component.md +++ b/docs/core/info-drawer.component.md @@ -35,14 +35,14 @@ Displays a sidebar-style information panel with tabs. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | selectedIndex | `number` | 0 | The selected index tab. | -| title | `string \| null` | null | The title of the info drawer. | +| title | `string \| null` | null | The title of the info drawer. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | currentTab | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the currently active tab changes. | ## Details diff --git a/docs/core/log.service.md b/docs/core/log.service.md index fc9a5be1e3..2b7fc36d94 100644 --- a/docs/core/log.service.md +++ b/docs/core/log.service.md @@ -10,7 +10,7 @@ Provides log functionality. ## Basic Usage -**app.component.ts** +**[app.component](../../demo-shell/src/app/app.component.ts).ts** ```ts import { LogService } from '@alfresco/adf-core'; @@ -50,46 +50,46 @@ export class AppComponent { ### Methods -- **assert**(test?: `boolean` = `null`, message?: `string` = `null`, optionalParams: `any[]` = `null`)
+- **assert**(test?: `boolean`, message?: `string`, optionalParams: `any[]`)
Logs a message if a boolean test fails. - _test:_ `boolean` - (Optional) Test value (typically a boolean expression) - _message:_ `string` - (Optional) Message to show if test is false - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **debug**(message?: `any` = `null`, optionalParams: `any[]` = `null`)
+- **debug**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "DEBUG" level. - _message:_ `any` - (Optional) Message to log - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **error**(message?: `any` = `null`, optionalParams: `any[]` = `null`)
+- **error**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "ERROR" level. - _message:_ `any` - (Optional) Message to log - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **getLogLevel**(level: `string` = `null`): [`LogLevelsEnum`](../../lib/core/models/log-levels.model.ts)
+- **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../lib/core/models/log-levels.model.ts)
Converts a log level name string into its numeric equivalent. - _level:_ `string` - Level name - **Returns** [`LogLevelsEnum`](../../lib/core/models/log-levels.model.ts) - Numeric log level -- **group**(groupTitle?: `string` = `null`, optionalParams: `any[]` = `null`)
+- **group**(groupTitle?: `string`, optionalParams: `any[]`)
Starts an indented group of log messages. - _groupTitle:_ `string` - (Optional) Title shown at the start of the group - _optionalParams:_ `any[]` - Interpolation values for the title in "printf" format - **groupEnd**()
Ends a indented group of log messages. -- **info**(message?: `any` = `null`, optionalParams: `any[]` = `null`)
+- **info**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "INFO" level. - _message:_ `any` - (Optional) Message to log - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **log**(message?: `any` = `null`, optionalParams: `any[]` = `null`)
+- **log**(message?: `any`, optionalParams: `any[]`)
Logs a message at any level from "TRACE" upwards. - _message:_ `any` - (Optional) Message to log - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **messageBus**(text: `string` = `null`, logLevel: `string` = `null`)
+- **messageBus**(text: `string`, logLevel: `string`)
Triggers notification callback for log messages. - _text:_ `string` - Message text - _logLevel:_ `string` - Log level for the message -- **trace**(message?: `any` = `null`, optionalParams: `any[]` = `null`)
+- **trace**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "TRACE" level. - _message:_ `any` - (Optional) Message to log - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format -- **warn**(message?: `any` = `null`, optionalParams: `any[]` = `null`)
+- **warn**(message?: `any`, optionalParams: `any[]`)
Logs a message at the "WARN" level. - _message:_ `any` - (Optional) Message to log - _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format diff --git a/docs/core/login.component.md b/docs/core/login.component.md index 10deb3208f..fc41b76dd5 100644 --- a/docs/core/login.component.md +++ b/docs/core/login.component.md @@ -13,14 +13,10 @@ Authenticates to Alfresco Content Services and or Alfresco Process Services. ## Contents - [Basic usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Details](#details) - - [Handling events](#handling-events) - [Changing content](#changing-content) - [Custom logo and background](#custom-logo-and-background) @@ -29,7 +25,6 @@ Authenticates to Alfresco Content Services and or Alfresco Process Services. - [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour) - [SSO login](#sso-login) - [Implicit Flow](#implicit-flow) - - [See Also](#see-also) ## Basic usage @@ -45,32 +40,32 @@ Authenticates to Alfresco Content Services and or Alfresco Process Services. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| backgroundImageUrl | `string` | "./assets/images/background.svg" | Path to a custom background image. | -| copyrightText | `string` | "© 2016 Alfresco Software, Inc. All Rights Reserved." | The copyright text below the login box. | +| ---- | ---- | ------------- | ----------- | +| backgroundImageUrl | `string` | | Path to a custom background image. | +| copyrightText | `string` | | The copyright text below the login box. | | disableCsrf | `boolean` | | Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services. | | fieldsValidation | `any` | | Custom validation rules for the login form. | -| logoImageUrl | `string` | "./assets/images/alfresco-logo.svg" | Path to a custom logo image. | +| logoImageUrl | `string` | | Path to a custom logo image. | | needHelpLink | `string` | "" | Sets the URL of the NEED HELP link in the footer. | -| providers | `string` | | **Deprecated:** 3.0.0 | +| providers | `string` | | (**Deprecated:** 3.0.0 Possible valid values are ECM, BPM or ALL. deprecated in 3.0.0 use the providers property in the the app.config.json) | | registerLink | `string` | "" | Sets the URL of the REGISTER link in the footer. | | showLoginActions | `boolean` | true | Should the extra actions (`Need Help`, `Register`, etc) be shown? | | showRememberMe | `boolean` | true | Should the `Remember me` checkbox be shown? When selected, this option will remember the logged-in user after the browser is closed to avoid logging in repeatedly. | -| successRoute | `string` | null | Route to redirect to on successful login. | +| successRoute | `string` | null | Route to redirect to on successful login. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. | | executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. | -| success | `EventEmitter` | Emitted when the login is successful. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. | ## Details ### Handling events -**app.component.html** +**[app.component](../../demo-shell/src/app/app.component.ts).html** ```html ``` -**app.component.ts** +**[app.component](../../demo-shell/src/app/app.component.ts).ts** ```ts export class AppComponent { diff --git a/docs/core/node-delete.directive.md b/docs/core/node-delete.directive.md index ed39e8fdbf..fb0e8bda87 100644 --- a/docs/core/node-delete.directive.md +++ b/docs/core/node-delete.directive.md @@ -28,14 +28,14 @@ Deletes multiple files and folders. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash | -| adf-delete | `MinimalNodeEntity[] \| DeletedNodeEntity[]` | | Array of nodes to delete. | +| selection | [`MinimalNodeEntity`](../content-services/document-library.model.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | delete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the nodes have been deleted. | ## Details diff --git a/docs/core/node-favorite.directive.md b/docs/core/node-favorite.directive.md index 186d5e009f..ffe1d579d1 100644 --- a/docs/core/node-favorite.directive.md +++ b/docs/core/node-favorite.directive.md @@ -41,13 +41,13 @@ export class MyComponent { ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| adf-node-favorite | `MinimalNodeEntity[]` | \[] | Array of nodes to toggle as favorites. | +| ---- | ---- | ------------- | ----------- | +| selection | [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` | \[] | Array of nodes to toggle as favorites. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting has fail. | | toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the favorite setting is complete. | diff --git a/docs/core/node-permission.directive.md b/docs/core/node-permission.directive.md index 7f13cf2c79..a6883a57b3 100644 --- a/docs/core/node-permission.directive.md +++ b/docs/core/node-permission.directive.md @@ -11,13 +11,9 @@ Selectively disables an HTML element or Angular component ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - - [Details](#details) - - [HTML element example](#html-element-example) - [Angular component example](#angular-component-example) - [Implementing the NodePermissionSubject interface](#implementing-the-nodepermissionsubject-interface) @@ -44,14 +40,14 @@ Selectively disables an HTML element or Angular component ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| adf-nodes | `MinimalNodeEntity[]` | \[] | Nodes to check permission for. | -| adf-node-permission | `string` | null | Node permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). | +| ---- | ---- | ------------- | ----------- | +| nodes | [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` | \[] | Nodes to check permission for. | +| permission | `string` | null | Node permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). | ## Details The [Node Permission directive](../core/node-permission.directive.md) lets you disable an HTML element or Angular component -by taking a collection of `MinimalNodeEntity` instances and checking their permissions. +by taking a collection of [`MinimalNodeEntity`](../content-services/document-library.model.md) instances and checking their permissions. The decorated element will be disabled if: diff --git a/docs/core/node-restore.directive.md b/docs/core/node-restore.directive.md index 15757af376..a118e4fa65 100644 --- a/docs/core/node-restore.directive.md +++ b/docs/core/node-restore.directive.md @@ -49,14 +49,14 @@ Restores deleted nodes to their original location. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| location | `string` | "" | (**Deprecated:** 2.4.0 Path to restored node.) | -| adf-restore | `DeletedNodeEntry[]` | | Array of deleted nodes to restore. | +| ---- | ---- | ------------- | ----------- | +| location | `string` | "" | (**Deprecated:** 2.4.0 Path to restored node.) | +| selection | `DeletedNodeEntry[]` | | Array of deleted nodes to restore. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | restore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RestoreMessageModel`](../../lib/core/directives/node-restore.directive.ts)`>` | Emitted when restoration is complete. | ## Details diff --git a/docs/core/nodes-api.service.md b/docs/core/nodes-api.service.md index 9e50c4fd51..386761f584 100644 --- a/docs/core/nodes-api.service.md +++ b/docs/core/nodes-api.service.md @@ -11,63 +11,59 @@ Accesses and manipulates ACS document nodes using their node IDs. ## Contents - [Class members](#class-members) - - [Methods](#methods) - - [Details](#details) - - [Getting node information](#getting-node-information) - [Getting folder node contents](#getting-folder-node-contents) - [Creating and updating nodes](#creating-and-updating-nodes) - [Deleting and restoring nodes](#deleting-and-restoring-nodes) - - [See also](#see-also) ## Class members ### Methods -- **createFolder**(parentNodeId: `string` = `null`, nodeBody: `any` = `null`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **createFolder**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
Creates a new folder node inside a parent folder. - _parentNodeId:_ `string` - ID of the parent folder node - _nodeBody:_ `any` - Data for the new folder - _options:_ `any` - Optional parameters supported by JSAPI - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of the new folder -- **createNode**(parentNodeId: `string` = `null`, nodeBody: `any` = `null`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Details of the new folder +- **createNode**(parentNodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
Creates a new document node inside a folder. - _parentNodeId:_ `string` - ID of the parent folder node - _nodeBody:_ `any` - Data for the new node - _options:_ `any` - Optional parameters supported by JSAPI - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of the new node -- **deleteNode**(nodeId: `string` = `null`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Details of the new node +- **deleteNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Moves a node to the trashcan. - _nodeId:_ `string` - ID of the target node - _options:_ `any` - Optional parameters supported by JSAPI - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty result that notifies when the deletion is complete -- **getNode**(nodeId: `string` = `null`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getNode**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
Gets the stored information about a node. - _nodeId:_ `string` - ID of the target node - _options:_ `any` - Optional parameters supported by JSAPI - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Node information -- **getNodeChildren**(nodeId: `string` = `null`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node information +- **getNodeChildren**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets the items contained in a folder node. - _nodeId:_ `string` - ID of the target node - _options:_ `any` - Optional parameters supported by JSAPI - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of child items from the folder -- **handleError**(error: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Reports an error. - _error:_ `any` - Object representing the error - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Error information -- **restoreNode**(nodeId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
Restores a node previously moved to the trashcan. - _nodeId:_ `string` - ID of the node to restore - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of the restored node -- **updateNode**(nodeId: `string` = `null`, nodeBody: `any` = `null`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Details of the restored node +- **updateNode**(nodeId: `string`, nodeBody: `any`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
Updates the information about a node. - _nodeId:_ `string` - ID of the target node - _nodeBody:_ `any` - New data for the node - _options:_ `any` - Optional parameters supported by JSAPI - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Updated node information + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Updated node information ## Details @@ -124,7 +120,7 @@ of a [Document List component](../content-services/document-list.component.md) o [Document List row](../content-services/document-list.component.md#underlying-node-object). In these cases, you might pass the `id` or `parentId` as a [route parameter](https://angular.io/guide/router) to a page describing the node in full detail. The component receiving the node ID can -use the [Nodes Api service](../core/nodes-api.service.md) to "decode" the ID string into a MinimalNodeEntryEntity: +use the [Nodes Api service](../core/nodes-api.service.md) to "decode" the ID string into a [`MinimalNodeEntryEntity`](../content-services/document-library.model.md): ```ts import { ActivatedRoute, Router } from '@angular/router'; diff --git a/docs/core/notification.service.md b/docs/core/notification.service.md index a9ebb8a0b7..c2d0a701c4 100644 --- a/docs/core/notification.service.md +++ b/docs/core/notification.service.md @@ -14,17 +14,16 @@ Shows a notification message with optional feedback. ### Methods -- **openSnackMessage**(message: `string` = `null`, config?: `number` | [`MatSnackBarConfig`](https://v5.material.angular.io/components/snack-bar/api#MatSnackBarConfig) = `null`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+- **openSnackMessage**(message: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../core/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`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` - (Optional) Time before notification disappears after being shown or [`MatSnackBarConfig`](https://v5.material.angular.io/components/snack-bar/api#MatSnackBarConfig) object to fully customize SnackBar - - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar -
-- **openSnackMessageAction**(message: `string` = `null`, action: `string` = `null`, config?: `number` | [`MatSnackBarConfig`](https://v5.material.angular.io/components/snack-bar/api#MatSnackBarConfig) = `null`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)``
+ - _config:_ `number|MatSnackBarConfig` - Time before notification disappears after being shown or MatSnackBarConfig object + - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar +- **openSnackMessageAction**(message: `string`, action: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../core/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`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` - (Optional) Time before notification disappears after being shown or [`MatSnackBarConfig`](https://v5.material.angular.io/components/snack-bar/api#MatSnackBarConfig) object to fully customize SnackBar + - _config:_ `number|MatSnackBarConfig` - Time before notification disappears after being shown or MatSnackBarConfig object - **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`` - Information/control object for the SnackBar ## Details diff --git a/docs/core/pagination.component.md b/docs/core/pagination.component.md index f41bb36862..f0ce74792b 100644 --- a/docs/core/pagination.component.md +++ b/docs/core/pagination.component.md @@ -13,17 +13,12 @@ Adds pagination to the component it is used with. ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Details](#details) - - [Integrating with the Document List component](#integrating-with-the-document-list-component) - [Custom pagination](#custom-pagination) - - [See also](#see-also) ## Basic Usage @@ -45,20 +40,20 @@ Adds pagination to the component it is used with. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| pagination | [`PaginationModel`](../../lib/core/models/pagination.model.ts) | [`PaginationComponent`](../core/pagination.component.md).DEFAULT_PAGINATION | [`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) object. | -| supportedPageSizes | `number[]` | [5, 25, 50, 100] | An array of page sizes. | +| ---- | ---- | ------------- | ----------- | +| pagination | [`PaginationModel`](../../lib/core/models/pagination.model.ts) | | [Pagination](../../lib/content-services/document-list/models/document-library.model.ts) object. | +| supportedPageSizes | `number[]` | | An array of page sizes. | | target | `PaginatedComponent` | | Component that provides custom pagination support. | ### 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` | Emitted when the page size changes. | -| nextPage | `EventEmitter` | Emitted when the next page is requested. | -| prevPage | `EventEmitter` | Emitted when the previous page is requested. | +| 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. | ## Details @@ -70,7 +65,7 @@ and then subscribe to one of the page change events. This will return updated pa can pass to a subsequent API call. Each event corresponds to a particular action from the user. For the `change` event, a -[PaginationQueryParams](https://github.com/Alfresco/alfresco-ng2-components/blob/development/ng2-components/ng2-alfresco-core/src/components/pagination/pagination-query-params.interface.ts) object is returned. This contains the query +PaginationQueryParams object is returned. This contains the query parameters supported by the REST API, `skipCount` and `maxItems`. For all events other than `change`, a new [`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) object is returned as in the following example. The diff --git a/docs/core/people-content.service.md b/docs/core/people-content.service.md index 82137bdb2e..b7a601e4a9 100644 --- a/docs/core/people-content.service.md +++ b/docs/core/people-content.service.md @@ -15,7 +15,7 @@ Gets information about a Content Services user. - **getCurrentPerson**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets information about the user who is currently logged in. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - User information -- **getPerson**(personId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getPerson**(personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets information about a user identified by their username. - _personId:_ `string` - ID of the target user - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - User information diff --git a/docs/core/people-process.service.md b/docs/core/people-process.service.md index 3193290b09..8e56769e7f 100644 --- a/docs/core/people-process.service.md +++ b/docs/core/people-process.service.md @@ -12,21 +12,21 @@ Gets information about Process Services users. ### Methods -- **getUserImage**(user: [`UserProcessModel`](../core/user-process.model.md) = `null`): `string`
+- **getUserImage**(user: [`UserProcessModel`](../core/user-process.model.md)): `string`
Gets the profile picture URL for the specified user. - _user:_ [`UserProcessModel`](../core/user-process.model.md) - The target user - **Returns** `string` - Profile picture URL -- **getWorkflowUsers**(taskId?: `string` = `null`, searchWord?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>`
+- **getWorkflowUsers**(taskId?: `string`, searchWord?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>`
Gets information about users across all tasks. - _taskId:_ `string` - (Optional) ID of the task - _searchWord:_ `string` - (Optional) Filter text to search for - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>` - Array of user information objects -- **involveUserWithTask**(taskId: `string` = `null`, idToInvolve: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>`
+- **involveUserWithTask**(taskId: `string`, idToInvolve: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>`
Sets a user to be involved with a task. - _taskId:_ `string` - ID of the target task - _idToInvolve:_ `string` - ID of the user to involve - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>` - Empty response when the update completes -- **removeInvolvedUser**(taskId: `string` = `null`, idToRemove: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>`
+- **removeInvolvedUser**(taskId: `string`, idToRemove: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>`
Removes a user who is currently involved with a task. - _taskId:_ `string` - ID of the target task - _idToRemove:_ `string` - ID of the user to remove diff --git a/docs/core/process-content.service.md b/docs/core/process-content.service.md index 8ca37cb8c5..eee9e4fd1a 100644 --- a/docs/core/process-content.service.md +++ b/docs/core/process-content.service.md @@ -11,63 +11,63 @@ Manipulates content related to a Process Instance or Task Instance in APS. ### Methods -- **createProcessRelatedContent**(processInstanceId: `string` = `null`, content: `any` = `null`, opts?: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **createProcessRelatedContent**(processInstanceId: `string`, content: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Associates an uploaded file with a process instance. - _processInstanceId:_ `string` - ID of the target process instance - _content:_ `any` - File to associate - _opts:_ `any` - (Optional) Options supported by JSAPI - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of created content -- **createTaskRelatedContent**(taskId: `string` = `null`, file: `any` = `null`, opts?: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **createTaskRelatedContent**(taskId: `string`, file: `any`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Associates an uploaded file with a task instance. - _taskId:_ `string` - ID of the target task - _file:_ `any` - File to associate - _opts:_ `any` - (Optional) Options supported by JSAPI - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Details of created content -- **createTemporaryRawRelatedContent**(file: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`
+- **createTemporaryRawRelatedContent**(file: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`
Create temporary related content from an uploaded file. - _file:_ `any` - File to use for content - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>` - The created content data -- **deleteRelatedContent**(contentId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **deleteRelatedContent**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes related content. - _contentId:_ `number` - Identifier of the content to delete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response that notifies when the deletion is complete -- **getContentPreview**(contentId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+- **getContentPreview**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Gets the preview for a related content file. - _contentId:_ `number` - ID of the related content - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary data of the content preview -- **getContentThumbnail**(contentId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+- **getContentThumbnail**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Gets the thumbnail for a related content file. - _contentId:_ `number` - ID of the related content - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary data of the thumbnail image -- **getFileContent**(contentId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`
+- **getFileContent**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>`
Gets the metadata for a related content item. - _contentId:_ `number` - ID of the content item - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RelatedContentRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md)`>` - Metadata for the content -- **getFileRawContent**(contentId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+- **getFileRawContent**(contentId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Gets raw binary content data for a related content file. - _contentId:_ `number` - ID of the related content - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary data of the related content -- **getFileRawContentUrl**(contentId: `number` = `null`): `string`
+- **getFileRawContentUrl**(contentId: `number`): `string`
Gets a URL for direct access to a related content file. - _contentId:_ `number` - ID of the related content - **Returns** `string` - URL to access the content -- **getProcessRelatedContent**(processId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getProcessRelatedContent**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets related content items for a process instance. - _processId:_ `string` - ID of the target process - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Metadata for the content -- **getTaskRelatedContent**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **getTaskRelatedContent**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets related content items for a task instance. - _taskId:_ `string` - ID of the target task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Metadata for the content -- **handleError**(error: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Reports an error message. - _error:_ `any` - Data object with optional `message` and `status` fields for the error - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Callback when an error occurs -- **toJson**(res: `any` = `null`): `any`
+- **toJson**(res: `any`): `any`
Creates a JSON representation of data. - _res:_ `any` - Object representing data - **Returns** `any` - JSON object -- **toJsonArray**(res: `any` = `null`): `any`
+- **toJsonArray**(res: `any`): `any`
Creates a JSON array representation of data. - _res:_ `any` - Object representing data - **Returns** `any` - JSON array object diff --git a/docs/core/search-configuration.service.md b/docs/core/search-configuration.service.md index 715e638145..0bd93482bc 100644 --- a/docs/core/search-configuration.service.md +++ b/docs/core/search-configuration.service.md @@ -11,7 +11,7 @@ Provides fine control of parameters to a search. ### Methods -- **generateQueryBody**(searchTerm: `string` = `null`, maxResults: `number` = `null`, skipCount: `number` = `null`): `QueryBody`
+- **generateQueryBody**(searchTerm: `string`, maxResults: `number`, skipCount: `number`): `QueryBody`
- _searchTerm:_ `string` - - _maxResults:_ `number` - diff --git a/docs/core/shared-links-api.service.md b/docs/core/shared-links-api.service.md index b99ef4b7ae..e080ecffc8 100644 --- a/docs/core/shared-links-api.service.md +++ b/docs/core/shared-links-api.service.md @@ -12,12 +12,12 @@ Finds shared links to Content Services items. ### Methods -- **createSharedLinks**(nodeId: `string` = `null`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **createSharedLinks**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Creates a shared link available to the current user. - _nodeId:_ `string` - ID of the node to link to - _options:_ `any` - Options supported by JSAPI - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - The shared link just created -- **deleteSharedLink**(sharedId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **deleteSharedLink**(sharedId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a shared link. - _sharedId:_ `string` - ID of the link to delete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete diff --git a/docs/core/sidebar-action-menu.component.md b/docs/core/sidebar-action-menu.component.md index 5e3d3c2b48..9d142319bb 100644 --- a/docs/core/sidebar-action-menu.component.md +++ b/docs/core/sidebar-action-menu.component.md @@ -32,7 +32,7 @@ Displays a sidebar-action menu information panel. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | expanded | `boolean` | | Toggle the sidebar action menu on expand. | | title | `string` | | The title of the sidebar action. | | width | `number` | 272 | Width in pixels for sidebar action menu options | diff --git a/docs/core/sidenav-layout.component.md b/docs/core/sidenav-layout.component.md index 248ff8ca6c..e5a0a6c6b2 100644 --- a/docs/core/sidenav-layout.component.md +++ b/docs/core/sidenav-layout.component.md @@ -13,14 +13,10 @@ Displays the standard three-region ADF application layout. ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Details](#details) - - [Template context](#template-context) - [menuOpenState$](#menuopenstate) - [Preserving the menu state](#preserving-the-menu-state) @@ -65,7 +61,7 @@ Displays the standard three-region ADF application layout. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? | | hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region | | sidenavMax | `number` | | Maximum size of the navigation region | @@ -75,7 +71,7 @@ Displays the standard three-region ADF application layout. ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes | ## Details @@ -120,7 +116,7 @@ Beside the template context's **isMenuMinimized** variable, another way to liste | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | -| menuOpenState$ | Observable<boolean> | true | Another way to listen to menu open/closed state | +| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)<boolean> | true | Another way to listen to menu open/closed state | Every time the menu state is changed, the following values are emitted: diff --git a/docs/core/sites.service.md b/docs/core/sites.service.md index c52d07f2d8..5c3685aa77 100644 --- a/docs/core/sites.service.md +++ b/docs/core/sites.service.md @@ -12,7 +12,7 @@ Accesses and manipulates sites from a Content Services repository. ### Methods -- **deleteSite**(siteId: `string` = `null`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **deleteSite**(siteId: `string`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a site. - _siteId:_ `string` - Site to delete - _permanentFlag:_ `boolean` - True: deletion is permanent; False: site is moved to the trash @@ -20,16 +20,16 @@ Accesses and manipulates sites from a Content Services repository. - **getEcmCurrentLoggedUserName**(): `string`
Gets the username of the user currently logged into ACS. - **Returns** `string` - Username string -- **getSite**(siteId: `string` = `null`, opts?: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`
+- **getSite**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`
Gets the details for a site. - _siteId:_ `string` - ID of the target site - _opts:_ `any` - (Optional) Options supported by JSAPI - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` - Information about the site -- **getSiteContent**(siteId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`
+- **getSiteContent**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`
Gets a site's content. - _siteId:_ `string` - ID of the target site - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` - Site content -- **getSiteMembers**(siteId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`
+- **getSiteMembers**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>`
Gets a list of all a site's members. - _siteId:_ `string` - ID of the target site - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` - Site members diff --git a/docs/core/sorting-picker.component.md b/docs/core/sorting-picker.component.md index 5602a515a9..dd9b866303 100644 --- a/docs/core/sorting-picker.component.md +++ b/docs/core/sorting-picker.component.md @@ -26,16 +26,16 @@ Selects from a set of predefined sorting definitions and directions. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | ascending | `boolean` | true | Current sorting direction | -| options | `Array` | \[] | Available sorting options | +| options | `Array` | \[] | Available sorting options | | selected | `string` | | Currently selected option key | ### Events | Name | Type | Description | -| -- | -- | -- | -| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time sorting key or direction gets changed. | +| ---- | ---- | ----------- | +| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Raised each time sorting key or direction gets changed. | ## Details diff --git a/docs/core/start-form.component.md b/docs/core/start-form.component.md index 252b08b687..81922a47dd 100644 --- a/docs/core/start-form.component.md +++ b/docs/core/start-form.component.md @@ -24,11 +24,11 @@ Displays the Start [`Form`](../../lib/process-services/task-list/models/form.mod ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| data | [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. | +| ---- | ---- | ------------- | ----------- | +| data | `FormValues` | | 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. | | disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | -| fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. | +| fieldValidators | `FormFieldValidator[]` | \[] | Contains a list of form field validator instances. | | form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. | | formId | `string` | | The id of the form definition to load and display with custom values. | | formName | `string` | | Name of the form definition to load and display with custom values. | @@ -52,15 +52,15 @@ Displays the Start [`Form`](../../lib/process-services/task-list/models/form.mod ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | 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. | -| formLoaded | `EventEmitter` | Emitted when the form is loaded or reloaded. | -| formSaved | `EventEmitter` | Emitted when the form is submitted with the `Save` or custom outcomes. | -| onError | `EventEmitter` | Emitted when any error occurs. | -| outcomeClick | `EventEmitter` | Emitted when the user clicks one of the outcome buttons that completes the form. | +| 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. | +| onError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| 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/storage.service.md b/docs/core/storage.service.md index 842259ca3b..55d2fd303e 100644 --- a/docs/core/storage.service.md +++ b/docs/core/storage.service.md @@ -13,18 +13,18 @@ Stores items in the form of key-value pairs. - **clear**()
Removes all currently stored items. -- **getItem**(key: `string` = `null`): `string | null`
+- **getItem**(key: `string`): `string|null`
Gets an item. - _key:_ `string` - Key to identify the item - - **Returns** `string | null` - The item (if any) retrieved by the key -- **hasItem**(key: `string` = `null`): `boolean`
+ - **Returns** `string|null` - The item (if any) retrieved by the key +- **hasItem**(key: `string`): `boolean`
Is any item currently stored under `key`? - _key:_ `string` - Key identifying item to check - **Returns** `boolean` - True if key retrieves an item, false otherwise -- **removeItem**(key: `string` = `null`)
+- **removeItem**(key: `string`)
Removes a single item. - _key:_ `string` - Key to identify the item -- **setItem**(key: `string` = `null`, data: `string` = `null`)
+- **setItem**(key: `string`, data: `string`)
Stores an item - _key:_ `string` - Key to identify the item - _data:_ `string` - Data to store diff --git a/docs/core/text-mask.component.md b/docs/core/text-mask.component.md index 5844bc44cd..994aa015c5 100644 --- a/docs/core/text-mask.component.md +++ b/docs/core/text-mask.component.md @@ -19,8 +19,8 @@ Implements text field input masks. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| textMask | `object` | | Object defining mask and "reversed" status. | +| ---- | ---- | ------------- | ----------- | +| inputMask | `Function` | | Object defining mask and "reversed" status. | ## Details diff --git a/docs/core/thumbnail.service.md b/docs/core/thumbnail.service.md index e14230558e..2a03aa27ef 100644 --- a/docs/core/thumbnail.service.md +++ b/docs/core/thumbnail.service.md @@ -15,11 +15,11 @@ Retrieves an SVG thumbnail image to represent a document type. - **getDefaultMimeTypeIcon**(): `string`
Gets a "miscellaneous" thumbnail URL for types with no other icon defined. - **Returns** `string` - URL string -- **getDocumentThumbnailUrl**(node: `any` = `null`): `string`
+- **getDocumentThumbnailUrl**(node: `any`): `string`
Gets a thumbnail URL for the given document node. - _node:_ `any` - Node to get URL for. - **Returns** `string` - URL string -- **getMimeTypeIcon**(mimeType: `string` = `null`): `string`
+- **getMimeTypeIcon**(mimeType: `string`): `string`
Gets a thumbnail URL for a MIME type. - _mimeType:_ `string` - MIME type for the thumbnail - **Returns** `string` - URL string diff --git a/docs/core/toolbar.component.md b/docs/core/toolbar.component.md index b40ed6ba22..42148cf1aa 100644 --- a/docs/core/toolbar.component.md +++ b/docs/core/toolbar.component.md @@ -13,19 +13,14 @@ Simple container for headers, titles, actions and breadcrumbs. ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - - [Details](#details) - - [Custom title](#custom-title) - [Divider](#divider) - [Spacer](#spacer) - [Dropdown menu](#dropdown-menu) - [Custom color](#custom-color) - - [See also](#see-also) ## Basic Usage @@ -46,7 +41,7 @@ Simple container for headers, titles, actions and breadcrumbs. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | color | `string` | | Toolbar color. Can be changed to empty value (default), `primary`, `accent` or `warn`. | | title | `string` | "" | Toolbar title. | diff --git a/docs/core/translation.service.md b/docs/core/translation.service.md index 7d0aa515f1..de25628d00 100644 --- a/docs/core/translation.service.md +++ b/docs/core/translation.service.md @@ -16,20 +16,20 @@ Supports localisation. Adds a new folder of translation source files. - _name:_ `string` - Name for the translation provider - _path:_ `string` - Path to the folder -- **get**(key: `string | Array` = `null`, interpolateParams?: `Object` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **get**(key: `string|Array`, interpolateParams?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the translation for the supplied key. - - _key:_ `string | Array` - Key to translate + - _key:_ `string|Array` - Key to translate - _interpolateParams:_ `Object` - (Optional) String(s) to be interpolated into the main message - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Translated text -- **instant**(key: `string | Array` = `null`, interpolateParams?: `Object` = `null`): `string | any`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Translated text +- **instant**(key: `string|Array`, interpolateParams?: `Object`): `string|any`
Directly returns the translation for the supplied key. - - _key:_ `string | Array` - Key to translate + - _key:_ `string|Array` - Key to translate - _interpolateParams:_ `Object` - (Optional) String(s) to be interpolated into the main message - - **Returns** `string | any` - Translated text -- **onTranslationChanged**(lang: `string` = `null`)
+ - **Returns** `string|any` - Translated text +- **onTranslationChanged**(lang: `string`)
Triggers a notification callback when the translation language changes. - _lang:_ `string` - The new language code -- **use**(lang: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **use**(lang: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Sets the target language for translations. - _lang:_ `string` - Code name for the language - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Translations available for the language diff --git a/docs/core/upload.directive.md b/docs/core/upload.directive.md index d82f70ffad..251851a090 100644 --- a/docs/core/upload.directive.md +++ b/docs/core/upload.directive.md @@ -21,12 +21,12 @@ Uploads content in response to file drag and drop. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | accept | `string` | | (Click mode only) MIME type filter for files to accept. | -| adf-upload-data | `any` | | Data to upload. | +| data | `any` | | Data to upload. | | directory | `boolean` | | (Click mode only) Toggles uploading of directories. | -| adf-upload | `boolean` | true | Enables/disables uploading. | -| mode | `string[]` | ['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. | +| enabled | `boolean` | true | Enables/disables uploading. | +| mode | `string[]` | ['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. | | multiple | `boolean` | | Toggles multiple file uploads. | ## Details diff --git a/docs/core/upload.service.md b/docs/core/upload.service.md index 9fbbdf6927..24edcd7627 100644 --- a/docs/core/upload.service.md +++ b/docs/core/upload.service.md @@ -12,11 +12,11 @@ Provides access to various APIs related to file upload features. ### Methods -- **addToQueue**(files: [`FileModel`](../../lib/core/models/file.model.ts)`[]` = `null`): [`FileModel`](../../lib/core/models/file.model.ts)`[]`
+- **addToQueue**(files: [`FileModel`](../../lib/core/models/file.model.ts)`[]`): [`FileModel`](../../lib/core/models/file.model.ts)`[]`
Adds files to the uploading queue to be uploaded - _files:_ [`FileModel`](../../lib/core/models/file.model.ts)`[]` - One or more separate parameters or an array of files to queue - **Returns** [`FileModel`](../../lib/core/models/file.model.ts)`[]` - Array of files that were not blocked from upload by the ignore list -- **cancelUpload**(files: [`FileModel`](../../lib/core/models/file.model.ts)`[]` = `null`)
+- **cancelUpload**(files: [`FileModel`](../../lib/core/models/file.model.ts)`[]`)
Cancels uploading of files. - _files:_ [`FileModel`](../../lib/core/models/file.model.ts)`[]` - One or more separate parameters or an array of files specifying uploads to cancel - **clearQueue**()
@@ -24,14 +24,14 @@ Provides access to various APIs related to file upload features. - **getQueue**(): [`FileModel`](../../lib/core/models/file.model.ts)`[]`
Gets the file Queue - **Returns** [`FileModel`](../../lib/core/models/file.model.ts)`[]` - Array of files that form the queue -- **getUploadPromise**(file: [`FileModel`](../../lib/core/models/file.model.ts) = `null`): `any`
+- **getUploadPromise**(file: [`FileModel`](../../lib/core/models/file.model.ts)): `any`
Gets an upload promise for a file. - _file:_ [`FileModel`](../../lib/core/models/file.model.ts) - The target file - - **Returns** `any` - Promise that is resolved if the upload is successful or error otherwise + - **Returns** `any` - [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises) that is resolved if the upload is successful or error otherwise - **isUploading**(): `boolean`
Checks whether the service is uploading a file. - **Returns** `boolean` - True if a file is uploading, false otherwise -- **uploadFilesInTheQueue**(emitter?: [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` = `null`)
+- **uploadFilesInTheQueue**(emitter?: [`EventEmitter`](https://angular.io/api/core/EventEmitter)``)
Finds all the files in the queue that are not yet uploaded and uploads them into the directory folder. - _emitter:_ [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` - (Optional) (Deprecated) Emitter to invoke on file status change @@ -39,15 +39,15 @@ Provides access to various APIs related to file upload features. | Name | Type | Description | | ---- | ---- | ----------- | -| queueChanged | FileModel\[] | Emitted when the file queue changes. | -| fileUpload | FileUploadEvent | Emitted when a File model changes its state. | -| fileUploadStarting | FileUploadEvent | Emitted when an upload starts. | -| fileUploadCancelled | FileUploadEvent | Emitted when an upload gets cancelled by the user. | -| fileUploadProgress | FileUploadEvent | Emitted during the file upload process and contains the current progress for a particular File model. | -| fileUploadAborted | FileUploadEvent | Emitted when a file upload gets aborted by the server. | -| fileUploadError | FileUploadEvent | Emitted when an error occurs during a file upload. | -| fileUploadComplete | FileUploadCompleteEvent | Emitted when a file upload is complete. | -| fileUploadDelete | FileUploadDeleteEvent | Emitted when an uploaded file is removed from server. | +| queueChanged | [`FileModel`](../../lib/core/models/file.model.ts)\[] | Emitted when the file queue changes. | +| fileUpload | [`FileUploadEvent`](../../lib/core/events/file.event.ts) | Emitted when a [File model](../../lib/core/models/file.model.ts) changes its state. | +| fileUploadStarting | [`FileUploadEvent`](../../lib/core/events/file.event.ts) | Emitted when an upload starts. | +| fileUploadCancelled | [`FileUploadEvent`](../../lib/core/events/file.event.ts) | Emitted when an upload gets cancelled by the user. | +| fileUploadProgress | [`FileUploadEvent`](../../lib/core/events/file.event.ts) | Emitted during the file upload process and contains the current progress for a particular [File model](../../lib/core/models/file.model.ts). | +| fileUploadAborted | [`FileUploadEvent`](../../lib/core/events/file.event.ts) | Emitted when a file upload gets aborted by the server. | +| fileUploadError | [`FileUploadEvent`](../../lib/core/events/file.event.ts) | Emitted when an error occurs during a file upload. | +| fileUploadComplete | [`FileUploadCompleteEvent`](../../lib/core/events/file.event.ts) | Emitted when a file upload is complete. | +| fileUploadDelete | [`FileUploadDeleteEvent`](../../lib/core/events/file.event.ts) | Emitted when an uploaded file is removed from server. | | fileDeleted | string | This can be invoked when a file is deleted from an external source to upload the file dialog status. | ## Details diff --git a/docs/core/user-info.component.md b/docs/core/user-info.component.md index 67c680e28e..7319a5dd2a 100644 --- a/docs/core/user-info.component.md +++ b/docs/core/user-info.component.md @@ -18,9 +18,9 @@ Shows user information. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| bpmBackgroundImage | `string` | "./assets/images/bpm-background.png" | Custom path for the background banner image for APS users. | -| ecmBackgroundImage | `string` | "./assets/images/ecm-background.png" | Custom path for the background banner image for ACS users. | +| ---- | ---- | ------------- | ----------- | +| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. | +| ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. | | menuPositionX | `string` | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | | menuPositionY | `string` | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | | namePosition | `string` | "right" | When the username is shown, this defines its position relative to the user info button. Can be `right` or `left`. | diff --git a/docs/core/user-preferences.service.md b/docs/core/user-preferences.service.md index 0bd3beae86..562d9ffa59 100644 --- a/docs/core/user-preferences.service.md +++ b/docs/core/user-preferences.service.md @@ -12,7 +12,7 @@ Stores preferences for components. ### Methods -- **get**(property: `string` = `null`, defaultValue?: `string` = `null`): `string`
+- **get**(property: `string`, defaultValue?: `string`): `string`
Gets a preference property. - _property:_ `string` - Name of the property - _defaultValue:_ `string` - (Optional) Default to return if the property is not found @@ -23,22 +23,26 @@ Stores preferences for components. - **getDefaultPageSizes**(): `number[]`
Gets an array containing the available page sizes. - **Returns** `number[]` - Array of page size values -- **getPropertyKey**(property: `string` = `null`): `string`
+- **getPropertyKey**(property: `string`): `string`
Gets the full property key with prefix. - _property:_ `string` - The property name - - **Returns** `string` - [Property](../../lib/content-services/content-metadata/interfaces/property.interface.ts) key + - **Returns** `string` - Property key - **getStoragePrefix**(): `string`
Gets the active storage prefix for preferences. - **Returns** `string` - Storage prefix -- **select**(property: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **hasItem**(property: `string`): `boolean`
+ Check if an item is present in the storage + - _property:_ `string` - Name of the property + - **Returns** `boolean` - +- **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Sets up a callback to notify when a property has changed. - _property:_ `string` - The property to watch - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Notification callback -- **set**(property: `string` = `null`, value: `any` = `null`)
+- **set**(property: `string`, value: `any`)
Sets a preference property. - _property:_ `string` - Name of the property - _value:_ `any` - New value for the property -- **setStoragePrefix**(value: `string` = `null`)
+- **setStoragePrefix**(value: `string`)
Sets the active storage prefix for preferences. - _value:_ `string` - Name of the prefix @@ -90,7 +94,7 @@ The service also provides quick access to a set of the "known" properties used a | ---- | ---- | ----------- | | authType | `string` | Authorization type (can be "ECM", "BPM" or "ALL"). | | disableCSRF | `boolean` | Prevents the CSRF Token from being submitted if true. Only valid for Process Services. | -| paginationSize | `number` | Pagination size. | +| paginationSize | `number` | [`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) size. | | locale | `string` | Current locale setting. | ## User Preference onChange Stream diff --git a/docs/core/viewer.component.md b/docs/core/viewer.component.md index 653118f724..cb571ccafd 100644 --- a/docs/core/viewer.component.md +++ b/docs/core/viewer.component.md @@ -13,16 +13,11 @@ See it live: [Viewer Quickstart](https://embed.plnkr.co/iTuG1lFIXfsP95l6bDW6/) ## Contents - [Basic usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Keyboard shortcuts](#keyboard-shortcuts) - - [Details](#details) - - [Integrating with the Document List component](#integrating-with-the-document-list-component) - [Custom file parameters](#custom-file-parameters) - [Supported file formats](#supported-file-formats) @@ -35,7 +30,6 @@ See it live: [Viewer Quickstart](https://embed.plnkr.co/iTuG1lFIXfsP95l6bDW6/) - [Custom "Open With" menu](#custom-open-with-menu) - [Custom "More actions" menu](#custom-more-actions-menu) - [Extending the Viewer](#extending-the-viewer) - - [See also](#see-also) ## Basic usage @@ -77,7 +71,7 @@ URL with `urlFile`. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | allowDownload | `boolean` | true | Toggles downloading. | | allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. | | allowGoBack | `boolean` | true | Allows `back` navigation | @@ -86,39 +80,38 @@ URL with `urlFile`. | allowShare | `boolean` | false | Toggles sharing. | | allowSidebar | `boolean` | false | Toggles the sidebar. | | allowThumbnails | `boolean` | true | Toggles PDF thumbnails. | -| blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File | +| blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File | | canNavigateBefore | `boolean` | true | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. | | canNavigateNext | `boolean` | true | Toggles the next (">") button. Requires `allowNavigate` to be enabled. | | displayName | `string` | | Specifies the name of the file when it is not available from the URL. | -| downloadUrl | `string` | null | URL to download. | +| downloadUrl | `string` | null | URL to download. | | fileName | `string` | | Content filename. | -| maxRetries | `number` | 5 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. | +| maxRetries | `number` | 10 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. | | mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). | -| nodeId | `string` | null | Node Id of the file to load. | +| nodeId | `string` | null | Node Id of the file to load. | | overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. | -| sharedLinkId | `string` | null | Shared link id (to display shared file). | +| sharedLinkId | `string` | null | Shared link id (to display shared file). | | showSidebar | `boolean` | false | Toggles sidebar visibility. Requires `allowSidebar` to be set to `true`. | | showToolbar | `boolean` | true | Hide or show the toolbar | | showViewer | `boolean` | true | Hide or show the viewer | | sidebarPosition | `string` | "right" | The position of the sidebar. Can be `left` or `right`. | -| sidebarTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the sidebar. The template context contains the loaded node data. | -| thumbnailsTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the pdf thumbnails. | +| sidebarTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the sidebar. The template context contains the loaded node data. | +| thumbnailsTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the pdf thumbnails. | | urlFile | `string` | "" | If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from. | -| urlFileViewer | `string` | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. | -| fileNodeId | | | Node Id of the file to load. | +| urlFileViewer | `string` | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | download | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Download' button. | | 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. | | navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Before' ("<") button. | -| navigateNext | `EventEmitter` | Emitted when user clicks 'Navigate Next' (">") button. | -| print | `EventEmitter>` | Emitted when user clicks the 'Print' button. | -| share | `EventEmitter>` | Emitted when user clicks the 'Share' button. | -| showViewerChange | `EventEmitter` | Emitted when the viewer is shown or hidden. | +| 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. | +| share | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Share' button. | +| showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the viewer is shown or hidden. | ## Keyboard shortcuts diff --git a/docs/insights/analytics-generator.component.md b/docs/insights/analytics-generator.component.md index 655bff8bd8..441e6ddceb 100644 --- a/docs/insights/analytics-generator.component.md +++ b/docs/insights/analytics-generator.component.md @@ -2,6 +2,7 @@ Added: v2.0.0 Status: Active --- + # Analytics Generator Component Generates and shows charts @@ -22,11 +23,11 @@ Generates and shows charts | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | reportId | `number` | | | -| reportParamQuery | `ReportQuery` | `undefined` | | +| reportParamQuery | [`ReportQuery`](../../lib/insights/diagram/models/report/reportQuery.model.ts) | undefined | | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| success | `EventEmitter<{}>` | | -| error | `EventEmitter<{}>` | | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | diff --git a/docs/insights/analytics-report-list.component.md b/docs/insights/analytics-report-list.component.md index 9f01f9d3c2..11764152c6 100644 --- a/docs/insights/analytics-report-list.component.md +++ b/docs/insights/analytics-report-list.component.md @@ -2,6 +2,7 @@ Added: v2.0.0 Status: Active --- + # Activiti Analytics List Component Shows a list of all available reports @@ -20,14 +21,14 @@ Shows a list of all available reports | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| layoutType | `string` | `AnalyticsReportListComponent.LAYOUT_LIST` | | | appId | `number` | | | -| selectFirst | `boolean` | `false` | | +| layoutType | `string` | | | +| selectFirst | `boolean` | false | | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| reportClick | `EventEmitter` | | -| success | `EventEmitter<{}>` | | -| error | `EventEmitter<{}>` | | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | +| reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../lib/insights/diagram/models/report/reportParameters.model.ts)`>` | | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | diff --git a/docs/insights/analytics.component.md b/docs/insights/analytics.component.md index 2a07229ebc..932cf031e9 100644 --- a/docs/insights/analytics.component.md +++ b/docs/insights/analytics.component.md @@ -2,6 +2,7 @@ Added: v2.0.0 Status: Active --- + # Activiti Analytics Component Shows the charts related to the reportId passed as input @@ -24,13 +25,13 @@ Shows the charts related to the reportId passed as input | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appId | `number` | | | +| hideParameters | `boolean` | false | | | reportId | `number` | | | -| hideParameters | `boolean` | `false` | | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| editReport | `EventEmitter<{}>` | | -| reportSaved | `EventEmitter<{}>` | | -| reportDeleted | `EventEmitter<{}>` | | +| editReport | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | +| reportDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | +| reportSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | diff --git a/docs/insights/diagram.component.md b/docs/insights/diagram.component.md index c683e1f08b..1e9e986f4d 100644 --- a/docs/insights/diagram.component.md +++ b/docs/insights/diagram.component.md @@ -2,6 +2,7 @@ Added: v2.0.0 Status: Active --- + # Diagram Component Displays process diagrams. @@ -28,18 +29,19 @@ The below component shows the diagram of a running process instance with the act ### Properties -| Name | Type | Description | -| --- | --- | -- | -| metricPercentages | any | The array that contains the percentage of time for each element | -| processInstanceId | any | | -| metricColor | any | The array that contains the color for each element | -| metricType | any | The string that specifies the metric type | -| width | number | | -| height | number | | +| Name | Type | Default value | Description | +| ---- | ---- | ------------- | ----------- | +| height | `number` | 500 | | +| metricColor | `any` | | | +| metricPercentages | `any` | | | +| metricType | `string` | "" | | +| processDefinitionId | `any` | | | +| processInstanceId | `any` | | | +| width | `number` | 1000 | | ### Events -| Name | Description | -| --- | --- | -| success | Raised when the diagrams elements are loaded | -| error | Raised when an error occurs during loading | \ No newline at end of file +| Name | Type | Description | +| ---- | ---- | ----------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | diff --git a/docs/insights/widget.component.md b/docs/insights/widget.component.md index 7ed5467de7..f4caad76f1 100644 --- a/docs/insights/widget.component.md +++ b/docs/insights/widget.component.md @@ -28,15 +28,14 @@ export class CustomEditorComponent extends WidgetComponent {} ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| field | [`FormFieldModel`](../core/form-field.model.md) | | Data to be displayed in the field | -| readOnly | `boolean` | false | Does the widget show a read-only value? (ie, can't be edited) | +| ---- | ---- | ------------- | ----------- | +| field | `any` | | Data to be displayed in the field | ### Events | Name | Type | Description | -| -- | -- | -- | -| fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../core/form-field.model.md)`>` | (**Deprecated:** Used only to trigger visibility engine; components should do that internally if needed) | +| ---- | ---- | ----------- | +| fieldChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | ( | ## Details diff --git a/docs/process-services/README.md b/docs/process-services/README.md index 5cd0bf82a7..484c106066 100644 --- a/docs/process-services/README.md +++ b/docs/process-services/README.md @@ -26,6 +26,7 @@ for more information about installing and using the source code. | [Process instance tasks component](process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../../lib/process-services/process-list/components/process-instance-tasks.component.ts) | | [Process list component](process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../../lib/process-services/process-list/components/process-list.component.ts) | | [Start process component](start-process.component.md) | Starts a process. | [Source](../../lib/process-services/process-list/components/start-process.component.ts) | +| [Attach form component](attach-form.component.md) | This component can be used when there is no form attached to a task and we want to add one. | [Source](../../lib/process-services/task-list/components/attach-form.component.ts) | | [Checklist component](checklist.component.md) | Shows the checklist task functionality. | [Source](../../lib/process-services/task-list/components/checklist.component.ts) | | [Start task component](start-task.component.md) | Creates/Starts new task for the specified app | [Source](../../lib/process-services/task-list/components/start-task.component.ts) | | [Task details component](task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../../lib/process-services/task-list/components/task-details.component.ts) | diff --git a/docs/process-services/apps-list.component.md b/docs/process-services/apps-list.component.md index 2be1146e13..7d33ddf0d4 100644 --- a/docs/process-services/apps-list.component.md +++ b/docs/process-services/apps-list.component.md @@ -34,16 +34,16 @@ You can also show a custom template if there are no apps present: ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | filtersAppId | `any[]` | | Provides a way to filter the apps to show. | -| layoutType | `string` | [`AppsListComponent`](../process-services/apps-list.component.md).LAYOUT_GRID | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | +| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` | Emitted when an app entry is clicked. | -| error | `EventEmitter` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | ## Details diff --git a/docs/process-services/attach-form.component.md b/docs/process-services/attach-form.component.md index de48397e36..5ab0e1853c 100644 --- a/docs/process-services/attach-form.component.md +++ b/docs/process-services/attach-form.component.md @@ -20,12 +20,14 @@ This component can be used when there is no form attached to a task and we want ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| taskId | `string` | | Id of the task. | +| ---- | ---- | ------------- | ----------- | +| formKey | `any` | | | +| taskId | `any` | | Id of the task. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | cancelAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | -| completeAttachForm | [`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)`` | | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | diff --git a/docs/process-services/checklist.component.md b/docs/process-services/checklist.component.md index db4a2a9bf0..ef4593a17d 100644 --- a/docs/process-services/checklist.component.md +++ b/docs/process-services/checklist.component.md @@ -22,7 +22,7 @@ Shows the checklist task functionality. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | assignee | `string` | | (required) The assignee id that the subtasks are assigned to. | | readOnly | `boolean` | false | Toggle readonly state of the form. All form widgets will render as readonly if enabled. | | taskId | `string` | | (required) The id of the parent task to which subtasks are attached. | @@ -30,7 +30,7 @@ Shows the checklist task functionality. ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | checklistTaskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` | Emitted when a new checklist task is created. | | checklistTaskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a checklitst task is deleted. | -| error | `EventEmitter` | Emitted when an error occurs. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/create-process-attachment.component.md b/docs/process-services/create-process-attachment.component.md index 0989091b9b..c3b68bd994 100644 --- a/docs/process-services/create-process-attachment.component.md +++ b/docs/process-services/create-process-attachment.component.md @@ -24,12 +24,12 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | processInstanceId | `string` | | (required) The ID of the process instance to display. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is successfully created or uploaded from within the component. | diff --git a/docs/process-services/create-task-attachment.component.md b/docs/process-services/create-task-attachment.component.md index f849d6887a..bb346ef5bf 100644 --- a/docs/process-services/create-task-attachment.component.md +++ b/docs/process-services/create-task-attachment.component.md @@ -24,12 +24,12 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | taskId | `string` | | (required) The numeric ID of the task to display. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an attachment is created or uploaded successfully from within the component. | diff --git a/docs/process-services/people-list.component.md b/docs/process-services/people-list.component.md index 6f22a54e56..fa6324e6c7 100644 --- a/docs/process-services/people-list.component.md +++ b/docs/process-services/people-list.component.md @@ -77,13 +77,13 @@ Note that the [people list component](../process-services/people-list.component. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | actions | `boolean` | false | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. | | users | [`UserProcessModel`](../core/user-process.model.md)`[]` | | The array of user data used to populate the people list. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | clickAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserEventModel`](../../lib/process-services/task-list/models/user-event.model.ts)`>` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. | -| clickRow | `EventEmitter` | Emitted when the user clicks a row in the people list. | +| clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../core/user-process.model.md)`>` | Emitted when the user clicks a row in the people list. | diff --git a/docs/process-services/people-search.component.md b/docs/process-services/people-search.component.md index bced56f42d..dc2e5b0e36 100644 --- a/docs/process-services/people-search.component.md +++ b/docs/process-services/people-search.component.md @@ -18,16 +18,16 @@ Searches users/people. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | results | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../core/user-process.model.md)`[]>` | | Parameters for displaying the list. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "close" button is clicked. | | searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a search is performed with a new keyword. | -| success | `EventEmitter` | Emitted when a user is selected and the action button is clicked. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../core/user-process.model.md)`>` | Emitted when a user is selected and the action button is clicked. | ## Details diff --git a/docs/process-services/people.component.md b/docs/process-services/people.component.md index 957acd0826..6028d15a37 100644 --- a/docs/process-services/people.component.md +++ b/docs/process-services/people.component.md @@ -12,13 +12,9 @@ Displays users involved with a specified task ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - - [Details](#details) - - [How to customize the people component behavior](#how-to-customize-the-people-component-behavior) - [Involve People single click and close search](#involve-people-single-click-and-close-search) - [Involve People single click without close search](#involve-people-single-click-without-close-search) @@ -40,8 +36,8 @@ Displays users involved with a specified task ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| people | [`UserProcessModel`](../core/user-process.model.md)`[]` | \[] | The array of User objects to display. | +| ---- | ---- | ------------- | ----------- | +| people | [`UserProcessModel`](../core/user-process.model.md)`[]` | \[] | The array of User objects to display. | | readOnly | `boolean` | false | Should the data be read-only? | | taskId | `string` | "" | The numeric ID of the task. | diff --git a/docs/process-services/process-attachment-list.component.md b/docs/process-services/process-attachment-list.component.md index de7b6d4c9b..76599a0bb3 100644 --- a/docs/process-services/process-attachment-list.component.md +++ b/docs/process-services/process-attachment-list.component.md @@ -41,17 +41,17 @@ export class MyCustomProcessAttachmentComponent { ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | disabled | `boolean` | false | Disable/Enable read-only mode for attachment list. | | processInstanceId | `string` | | (**required**) The ID of the process instance to display. | ### Events | Name | Type | Description | -| -- | -- | -- | -| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. | +| ---- | ---- | ----------- | +| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | -| success | `EventEmitter` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/process-audit.directive.md b/docs/process-services/process-audit.directive.md index 51ede51907..77938b21dd 100644 --- a/docs/process-services/process-audit.directive.md +++ b/docs/process-services/process-audit.directive.md @@ -27,15 +27,15 @@ Fetches the Process Audit information the PDF or JSON format. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | download | `boolean` | true | Enables downloading of the audit file on clicking. | | fileName | `string` | "Audit" | Name of the file to download (for PDF downloads). | | format | `string` | "pdf" | Format for the audit information (can be "pdf" or "json"). | -| process-id | `string` | | ID of the process. | +| processId | `string` | | ID of the process. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the decorated element is clicked. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/process-comments.component.md b/docs/process-services/process-comments.component.md index 231b763a0b..b7fc37b0bf 100644 --- a/docs/process-services/process-comments.component.md +++ b/docs/process-services/process-comments.component.md @@ -20,12 +20,12 @@ Displays comments associated with a particular process instance and allows the u ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | processInstanceId | `string` | | (**required**) The numeric ID of the process instance to display comments for. | | readOnly | `boolean` | true | Should the comments be read-only? | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/process-filter.service.md b/docs/process-services/process-filter.service.md index ab52e3f6fb..c7946926f5 100644 --- a/docs/process-services/process-filter.service.md +++ b/docs/process-services/process-filter.service.md @@ -12,33 +12,33 @@ Manage Process Filters, which are pre-configured Process Instance queries. ### Methods -- **addProcessFilter**(filter: [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`
+- **addProcessFilter**(filter: [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`
Adds a filter. - _filter:_ [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - The filter to add - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>` - The filter just added -- **callApiProcessFilters**(appId?: `number` = `null`): `Promise`
+- **callApiProcessFilters**(appId?: `number`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
Calls `getUserProcessInstanceFilters` from the Alfresco JS API. - _appId:_ `number` - (Optional) ID of the target app - - **Returns** `Promise` - List of filter details -- **createDefaultFilters**(appId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`
+ - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - List of filter details +- **createDefaultFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`
Creates and returns the default filters for an app. - _appId:_ `number` - ID of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>` - Default filters just created -- **getProcessFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`
+- **getProcessFilterById**(filterId: `number`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`
Retrieves the process filter by ID. - _filterId:_ `number` - ID of the filter - _appId:_ `number` - (Optional) ID of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>` - Details of the filter -- **getProcessFilterByName**(filterName: `string` = `null`, appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`
+- **getProcessFilterByName**(filterName: `string`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>`
Retrieves the process filter by name. - _filterName:_ `string` - Name of the filter - _appId:_ `number` - (Optional) ID of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`>` - Details of the filter -- **getProcessFilters**(appId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`
+- **getProcessFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>`
Gets all filters defined for a Process App. - _appId:_ `number` - ID of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)`[]>` - Array of filter details -- **getRunningFilterInstance**(appId: `number` = `null`): [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)
+- **getRunningFilterInstance**(appId: `number`): [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)
Creates and returns a filter that matches "running" process instances. - _appId:_ `number` - ID of the target app - **Returns** [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - Filter just created diff --git a/docs/process-services/process-filters.component.md b/docs/process-services/process-filters.component.md index 14b2b83a14..6c61341173 100644 --- a/docs/process-services/process-filters.component.md +++ b/docs/process-services/process-filters.component.md @@ -10,18 +10,13 @@ Collection of criteria used to filter process instances, which may be customized ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Details](#details) - - [How filter the activiti process filters](#how-filter-the-activiti-process-filters) - [FilterParamsModel](#filterparamsmodel) - [How to create an accordion menu with the processes filter](#how-to-create-an-accordion-menu-with-the-processes-filter) - - [See also](#see-also) ## Basic Usage @@ -37,7 +32,7 @@ Collection of criteria used to filter process instances, which may be customized ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | appId | `number` | | Display filters available to the current user for the application with the specified ID. | | appName | `string` | | Display filters available to the current user for the application with the specified name. | | filterParam | [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. | @@ -46,10 +41,10 @@ Collection of criteria used to filter process instances, which may be customized ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`>` | Emitted when the user selects a filter from the list. | -| success | `EventEmitter` | Emitted when the list of filters has been successfully loaded from the server. | +| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects a filter from the list. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list of filters has been successfully loaded from the server. | ## Details diff --git a/docs/process-services/process-instance-details.component.md b/docs/process-services/process-instance-details.component.md index 3eb0c160f4..e8cb5dbbb5 100644 --- a/docs/process-services/process-instance-details.component.md +++ b/docs/process-services/process-instance-details.component.md @@ -20,7 +20,7 @@ Displays detailed information on a specified process instance ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | processInstanceId | `string` | | (required) The numeric ID of the process instance to display. | | showRefreshButton | `boolean` | true | Toggles whether to show or hide the refresh button. | | showTitle | `boolean` | true | Toggles whether to show or hide the title. | @@ -28,8 +28,8 @@ Displays detailed information on a specified process instance ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | processCancelled | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the current process is cancelled by the user from within the component. | | showProcessDiagram | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "show diagram" button is clicked. | -| taskClick | `EventEmitter` | Emitted when a task is clicked. | +| taskClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsEvent`](../../lib/process-services/task-list/models/task-details.event.ts)`>` | Emitted when a task is clicked. | diff --git a/docs/process-services/process-instance-header.component.md b/docs/process-services/process-instance-header.component.md index bf6bf6ce8d..3fee21cdc3 100644 --- a/docs/process-services/process-instance-header.component.md +++ b/docs/process-services/process-instance-header.component.md @@ -23,7 +23,7 @@ Sub-component of the process details component, which renders some general infor ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | processInstance | [`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts) | | (**required**) Full details of the process instance to display information about. | ## Details @@ -44,4 +44,4 @@ The configuration looks like the following sample: } ``` -Only the items in the `properties` array will be displayed. \ No newline at end of file +Only the items in the `properties` array will be displayed. diff --git a/docs/process-services/process-instance-tasks.component.md b/docs/process-services/process-instance-tasks.component.md index 9f9e49c208..0be85ec716 100644 --- a/docs/process-services/process-instance-tasks.component.md +++ b/docs/process-services/process-instance-tasks.component.md @@ -21,13 +21,13 @@ Lists both the active and completed tasks associated with a particular process i ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | processInstanceDetails | [`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts) | | (**required**) The ID of the process instance to display tasks for. | | showRefreshButton | `boolean` | true | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | taskClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsEvent`](../../lib/process-services/task-list/models/task-details.event.ts)`>` | Emitted when a task is clicked. | diff --git a/docs/process-services/process-list.component.md b/docs/process-services/process-list.component.md index 79cf8935de..a2913414e2 100644 --- a/docs/process-services/process-list.component.md +++ b/docs/process-services/process-list.component.md @@ -11,23 +11,18 @@ Renders a list containing all the process instances matched by the parameters sp ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Details](#details) - - [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) - [Pagination strategy](#pagination-strategy) - [Show custom template when processList is empty](#show-custom-template-when-processlist-is-empty) - - [See also](#see-also) ## Basic Usage -**app.component.html** +**[app.component](../../demo-shell/src/app/app.component.ts).html** ```html ` | 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. | -| success | `EventEmitter` | Emitted when the list of process instances has been loaded successfully from the server. | +| 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/process.service.md b/docs/process-services/process.service.md index dd65a3439d..525f909f0f 100644 --- a/docs/process-services/process.service.md +++ b/docs/process-services/process.service.md @@ -12,56 +12,56 @@ Manages Process Instances, Process Variables, and Process Audit Log. ### Methods -- **cancelProcess**(processInstanceId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **cancelProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Cancels a process instance. - _processInstanceId:_ `string` - ID of process to cancel - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **createOrUpdateProcessInstanceVariables**(processInstanceId: `string` = `null`, variables: [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
+- **createOrUpdateProcessInstanceVariables**(processInstanceId: `string`, variables: [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
Creates or updates variables for a process instance. - _processInstanceId:_ `string` - ID of the target process - _variables:_ [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` - Variables to update - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info -- **deleteProcessInstanceVariable**(processInstanceId: `string` = `null`, variableName: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **deleteProcessInstanceVariable**(processInstanceId: `string`, variableName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a variable for a process instance. - _processInstanceId:_ `string` - ID of the target process - _variableName:_ `string` - Name of the variable to delete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **fetchProcessAuditJsonById**(processId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **fetchProcessAuditJsonById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Fetches the Process Audit information in a JSON format. - _processId:_ `string` - ID of the target process - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - JSON data -- **fetchProcessAuditPdfById**(processId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+- **fetchProcessAuditPdfById**(processId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Fetches the Process Audit information as a PDF. - _processId:_ `string` - ID of the target process - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data -- **getProcess**(processInstanceId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`
+- **getProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`
Gets Process Instance metadata. - _processInstanceId:_ `string` - ID of the target process - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` - Metadata for the instance -- **getProcessDefinitions**(appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>`
+- **getProcessDefinitions**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>`
Gets process definitions associated with an app. - _appId:_ `number` - (Optional) ID of a target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>` - Array of process definitions -- **getProcessInstanceVariables**(processInstanceId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
+- **getProcessInstanceVariables**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
Gets the variables for a process instance. - _processInstanceId:_ `string` - ID of the target process - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info -- **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) = `null`, processDefinitionKey?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>`
+- **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets process instances for a filter and optionally a process definition. - _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - Filter for instances - _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>` - List of process instances -- **getProcessTasks**(processInstanceId: `string` = `null`, state?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of process instances +- **getProcessTasks**(processInstanceId: `string`, state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>`
Gets task instances for a process instance. - _processInstanceId:_ `string` - ID of the process instance - _state:_ `string` - (Optional) Task state filter (can be "active" or "completed") - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>` - Array of task instance details -- **startProcess**(processDefinitionId: `string` = `null`, name: `string` = `null`, outcome?: `string` = `null`, startFormValues?: [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) = `null`, variables?: [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`
+- **startProcess**(processDefinitionId: `string`, name: `string`, outcome?: `string`, startFormValues?: `FormValues`, variables?: [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`
Starts a process based on a process definition, name, form values or variables. - _processDefinitionId:_ `string` - Process definition ID - _name:_ `string` - Process name - _outcome:_ `string` - (Optional) Process outcome - - _startFormValues:_ [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form + - _startFormValues:_ `FormValues` - (Optional) Values for the start form - _variables:_ [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` - (Optional) Array of process instance variables - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` - Details of the process instance just started diff --git a/docs/process-services/start-process.component.md b/docs/process-services/start-process.component.md index b6a9e37643..8840f6bcb8 100644 --- a/docs/process-services/start-process.component.md +++ b/docs/process-services/start-process.component.md @@ -13,19 +13,14 @@ Starts a process. ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Details](#details) - - [Starting a process with a default name and pre-selected process definition name](#starting-a-process-with-a-default-name-and-pre-selected-process-definition-name) - [Starting a process not included in an app](#starting-a-process-not-included-in-an-app) - [Custom data example](#custom-data-example) - [Attaching a File to the start form of the process](#attaching-a-file-to-the-start-form-of-the-process) - - [See also](#see-also) ## Basic Usage diff --git a/docs/process-services/start-task.component.md b/docs/process-services/start-task.component.md index 88c9d5bc20..f37b154000 100644 --- a/docs/process-services/start-task.component.md +++ b/docs/process-services/start-task.component.md @@ -22,13 +22,13 @@ Creates/Starts new task for the specified app ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | appId | `number` | | (required) The id of the app. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked by the user. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is successfully created. | diff --git a/docs/process-services/task-attachment-list.component.md b/docs/process-services/task-attachment-list.component.md index b1821017df..1072b0a10a 100644 --- a/docs/process-services/task-attachment-list.component.md +++ b/docs/process-services/task-attachment-list.component.md @@ -24,17 +24,17 @@ Displays attached documents on a specified task. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | disabled | `boolean` | false | Disable/Enable read only mode for attachement list. | | taskId | `string` | | (**required**) The ID of the task to display. | ### Events | Name | Type | Description | -| -- | -- | -- | -| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. | +| ---- | ---- | ----------- | +| attachmentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while fetching the attachments. | -| success | `EventEmitter` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | ## Details diff --git a/docs/process-services/task-audit.directive.md b/docs/process-services/task-audit.directive.md index e97d549cae..f6b60bedde 100644 --- a/docs/process-services/task-audit.directive.md +++ b/docs/process-services/task-audit.directive.md @@ -26,15 +26,15 @@ Fetches the Task Audit information in PDF or JSON format. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | download | `boolean` | true | Enables downloading of the audit when the decorated element is clicked. | | fileName | `string` | "Audit" | Name of the downloaded file (for PDF downloads). | | format | `string` | "pdf" | Format of the audit information. Can be "pdf" or "json". | -| task-id | `string` | | (**required**) The id of the task. | +| taskId | `string` | | (**required**) The id of the task. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the decorated element is clicked. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | diff --git a/docs/process-services/task-details.component.md b/docs/process-services/task-details.component.md index 72fd58c8a3..4b9c1e6849 100644 --- a/docs/process-services/task-details.component.md +++ b/docs/process-services/task-details.component.md @@ -21,16 +21,16 @@ Shows the details of the task ID passed in as input. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | debugMode | `boolean` | false | Toggles debug mode. | -| fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. | +| fieldValidators | `FormFieldValidator[]` | \[] | Field validators for use with the form. | | readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. | | showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. | | showComments | `boolean` | true | Toggles `Comments` feature for the Header component. | | showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. | | showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. | | showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. | -| showFormTitle | `boolean` | true | Toggles rendering of the form title. | +| showFormTitle | `boolean` | false | Toggles rendering of the form title. | | showHeader | `boolean` | true | Toggles task details Header component. | | showHeaderContent | `boolean` | true | Toggles collapsed/expanded state of the Header component. | | showInvolvePeople | `boolean` | true | Toggles `Involve People` feature for the Header component. | @@ -40,18 +40,18 @@ Shows the details of the task ID passed in as input. ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is assigned. | | claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task is claimed. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | | formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | | formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | -| formLoaded | `EventEmitter` | Emitted when the form is loaded or reloaded. | -| formSaved | `EventEmitter` | Emitted when the form is submitted with the `Save` or custom outcomes. | -| taskCreated | `EventEmitter` | Emitted when a checklist task is created. | -| taskDeleted | `EventEmitter` | Emitted when a checklist task is deleted. | -| unClaimedTask | `EventEmitter` | Emitted when a task is unclaimed. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| taskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` | 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. | ## Details diff --git a/docs/process-services/task-filter.service.md b/docs/process-services/task-filter.service.md index da876451b2..9e2e02abf3 100644 --- a/docs/process-services/task-filter.service.md +++ b/docs/process-services/task-filter.service.md @@ -12,45 +12,45 @@ Manage Task Filters, which are pre-configured Task Instance queries. ### Methods -- **addFilter**(filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
+- **addFilter**(filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
Adds a new task filter - _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The new filter to add - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` - Details of task filter just added -- **callApiTaskFilters**(appId?: `number` = `null`): `Promise`
+- **callApiTaskFilters**(appId?: `number`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
Calls `getUserTaskFilters` from the Alfresco JS API. - _appId:_ `number` - (Optional) ID of the target app - - **Returns** `Promise` - List of task filters -- **createDefaultFilters**(appId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>`
+ - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - List of task filters +- **createDefaultFilters**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>`
Creates and returns the default filters for a process app. - _appId:_ `number` - ID of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>` - Array of default filters just created -- **getCompletedTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)
+- **getCompletedTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)
Creates and returns a filter for "Completed" task instances. - _appId:_ `number` - ID of the target app - **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter -- **getInvolvedTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)
+- **getInvolvedTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)
Creates and returns a filter for "Involved" task instances. - _appId:_ `number` - ID of the target app - **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter -- **getMyTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)
+- **getMyTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)
Creates and returns a filter for "My Tasks" task instances. - _appId:_ `number` - ID of the target app - **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter -- **getQueuedTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)
+- **getQueuedTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)
Creates and returns a filter for "Queued Tasks" task instances. - _appId:_ `number` - ID of the target app - **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter -- **getTaskFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
+- **getTaskFilterById**(filterId: `number`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
Gets a task filter by ID. - _filterId:_ `number` - ID of the filter - _appId:_ `number` - (Optional) ID of the app for the filter - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` - Details of task filter -- **getTaskFilterByName**(taskName: `string` = `null`, appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
+- **getTaskFilterByName**(taskName: `string`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
Gets a task filter by name. - _taskName:_ `string` - Name of the filter - _appId:_ `number` - (Optional) ID of the app for the filter - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` - Details of task filter -- **getTaskListFilters**(appId?: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>`
+- **getTaskListFilters**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>`
Gets all task filters for a process app. - _appId:_ `number` - (Optional) Optional ID for a specific app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]>` - Array of task filter details diff --git a/docs/process-services/task-filters.component.md b/docs/process-services/task-filters.component.md index d89e387c90..67bb4ba9fd 100644 --- a/docs/process-services/task-filters.component.md +++ b/docs/process-services/task-filters.component.md @@ -8,6 +8,17 @@ Last reviewed: 2018-06-07 Shows all available filters. +## Contents + +- [Basic Usage](#basic-usage) +- [Class members](#class-members) + - [Properties](#properties) + - [Events](#events) +- [Details](#details) + - [Filtering APS task filters](#filtering-aps-task-filters) + - [How to create an accordion menu with the task filter](#how-to-create-an-accordion-menu-with-the-task-filter) +- [See also](#see-also) + ## Basic Usage ```html @@ -19,7 +30,7 @@ Shows all available filters. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | appId | `number` | | Display filters available to the current user for the application with the specified ID. | | appName | `string` | | Display filters available to the current user for the application with the specified name. | | filterParam | [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. | @@ -28,10 +39,10 @@ Shows all available filters. ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | | filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` | Emitted when a filter in the list is clicked. | -| success | `EventEmitter` | Emitted when the list is loaded. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | ## Details @@ -48,7 +59,6 @@ Use the `filterParam` property to restrict the range of filters that are shown: You can use properties from [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) as the value of `filterParam` as shown in the table below: - | Name | Type | Description | | ---- | ---- | ----------- | | id | string | The id of the task filter | diff --git a/docs/process-services/task-header.component.md b/docs/process-services/task-header.component.md index 4fb2d6e1fd..b01237e32c 100644 --- a/docs/process-services/task-header.component.md +++ b/docs/process-services/task-header.component.md @@ -23,14 +23,14 @@ Shows all the information related to a task. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | -| formName | `string` | null | The name of the form. | +| ---- | ---- | ------------- | ----------- | +| formName | `string` | null | The name of the form. | | taskDetails | [`TaskDetailsModel`](../process-services/task-details.model.md) | | (required) Details related to the task. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | | unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued). | diff --git a/docs/process-services/task-list.component.md b/docs/process-services/task-list.component.md index 83f9c43d80..4840f276df 100644 --- a/docs/process-services/task-list.component.md +++ b/docs/process-services/task-list.component.md @@ -11,21 +11,16 @@ Renders a list containing all the tasks matched by the parameters specified. ## Contents - [Basic Usage](#basic-usage) - - [Class members](#class-members) - - [Properties](#properties) - [Events](#events) - - [Details](#details) - - [Setting the column schema](#setting-the-column-schema) - [Setting Sorting Order for the list](#setting-sorting-order-for-the-list) - [Pagination strategy](#pagination-strategy) - [DataTableAdapter example](#datatableadapter-example) - [DataColumn Features](#datacolumn-features) - [Show custom template when tasklist is empty](#show-custom-template-when-tasklist-is-empty) - - [See also](#see-also) ## Basic Usage @@ -43,34 +38,34 @@ Renders a list containing all the tasks matched by the parameters specified. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | appId | `number` | | The id of the app. | | assignment | `string` | | The assignment of the process. Possible values are: "assignee" (the current user is the assignee), candidate (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value(the current user is involved). | -| data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | | (**Deprecated:** 2.4.0) Data source object that represents the number and the type of the columns that you want to show. | +| data | `DataTableAdapter` | | (**Deprecated:** 2.4.0) Data source object that represents the number and the type of the columns that you want to show. | +| includeProcessInstance | `boolean` | | Toggles inclusion of Process Instances | | landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. | | multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | | name | `string` | | Name of the tasklist. | | page | `number` | 0 | The page number of the tasks to fetch. | -| start | `number` | 0 | Another approach to specify which page you want load. | -| processDefinitionKey | `string` | | (**Deprecated:** 2.4.0) The Definition Key of the process. | | processDefinitionId | `string` | | The Definition Id of the process. | +| processDefinitionKey | `string` | | (**Deprecated:** 2.4.0) The Definition Key of the process. | | processInstanceId | `string` | | The Instance Id of the process. | -| taskId | `string` | | The taskId you want to be fetched. | | selectFirstRow | `boolean` | true | Toggles default selection of the first row | -| includeProcessInstance | `boolean` | false | Include the process instance info | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| size | `number` | [`PaginationComponent`](../core/pagination.component.md).DEFAULT_PAGINATION.maxItems | The number of tasks to fetch. Default value: 25. | +| size | `number` | | The number of tasks to fetch. Default value: 25. | | sort | `string` | | Define the sort order of the tasks. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | +| start | `number` | 0 | Starting point of the | | state | `string` | | Current state of the process. Possible values are: `completed`, `active`. | +| taskId | `string` | | The id of a task | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | -| success | `EventEmitter` | Emitted when the task list is loaded | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | ## Details diff --git a/docs/process-services/task-standalone.component.md b/docs/process-services/task-standalone.component.md index 93b0223f7a..4dded8fcc3 100644 --- a/docs/process-services/task-standalone.component.md +++ b/docs/process-services/task-standalone.component.md @@ -20,17 +20,17 @@ This component can be used when there is no form attached to a task. ### Properties | Name | Type | Default value | Description | -| -- | -- | -- | -- | +| ---- | ---- | ------------- | ----------- | | hasCompletePermission | `boolean` | true | Toggles rendering of the `Complete` button. | | hideCancelButton | `boolean` | true | Toggles rendering of the `Cancel` button. | | isCompleted | `boolean` | false | If true then Task completed message is shown and `Complete` and `Cancel` buttons are hidden. | -| taskName | `string` | | Name of the task. | -| taskId | `number` | | Id of the task. | +| taskId | `any` | | Id of the task. | +| taskName | `any` | | Name of the task. | ### Events | Name | Type | Description | -| -- | -- | -- | +| ---- | ---- | ----------- | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Cancel" button is clicked. | | complete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the task is completed. | -| showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "Show Form" button is clicked. | +| showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | diff --git a/docs/process-services/tasklist.service.md b/docs/process-services/tasklist.service.md index 7bfb6eac2d..e07046d5ab 100644 --- a/docs/process-services/tasklist.service.md +++ b/docs/process-services/tasklist.service.md @@ -12,64 +12,68 @@ Manages Task Instances. ### Methods -- **addTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+- **addTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Adds a subtask (ie, a checklist task) to a parent task. - _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - The task to add - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - The subtask that was added -- **assignTask**(taskId: `string` = `null`, requestNode: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+- **assignTask**(taskId: `string`, requestNode: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Assigns a task to a user or group. - _taskId:_ `string` - The task to assign - _requestNode:_ `any` - User or group to assign the task to - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Details of the assigned task -- **assignTaskByUserId**(taskId: `string` = `null`, userId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+- **assignTaskByUserId**(taskId: `string`, userId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Assigns a task to a user. - _taskId:_ `string` - ID of the task to assign - _userId:_ `number` - ID of the user to assign the task to - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Details of the assigned task -- **attachFormToATask**(taskId: `string` = `null`, formId: `number` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **attachFormToATask**(taskId: `string`, formId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Attaches a form to a task. - _taskId:_ `string` - ID of the target task - _formId:_ `number` - ID of the form to add - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **claimTask**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+- **claimTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Claims a task for the current user. - _taskId:_ `string` - ID of the task to claim - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Details of the claimed task -- **completeTask**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **completeTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gives completed status to a task. - _taskId:_ `string` - ID of the target task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **createNewTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+- **createNewTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Creates a new standalone task. - _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - Details of the new task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Details of the newly created task -- **deleteTask**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+- **deleteForm**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+ Deletes a form from a task. + - _taskId:_ `string` - Task id related to form + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Null response notifying when the operation is complete +- **deleteTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Deletes a subtask (ie, a checklist task) from a parent task. - _taskId:_ `string` - The task to delete - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Null response notifying when the operation is complete -- **fetchTaskAuditJsonById**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **fetchTaskAuditJsonById**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Fetch the Task Audit information in JSON format - _taskId:_ `string` - ID of the target task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - JSON data -- **fetchTaskAuditPdfById**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
+- **fetchTaskAuditPdfById**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>`
Fetches the Task Audit information in PDF format. - _taskId:_ `string` - ID of the target task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data -- **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`, state?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`
+- **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets all tasks matching a query and state value. - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks. - _state:_ `string` - (Optional) Task state. Can be "open" or "completed". - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>` - List of tasks -- **findAllTasksWithoutState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of tasks +- **findAllTasksWithoutState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets all tasks matching the supplied query but ignoring the task state. - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>` - List of tasks -- **findTasksByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`, state?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of tasks +- **findTasksByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts), state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets tasks matching a query and state value. - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks - _state:_ `string` - (Optional) Task state. Can be "open" or "completed". - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>` - List of tasks -- **getFilterForTaskById**(taskId: `string` = `null`, filterList: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of tasks +- **getFilterForTaskById**(taskId: `string`, filterList: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
Gets all the filters in the list that belong to a task. - _taskId:_ `string` - ID of the target task - _filterList:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`[]` - List of filters to search through @@ -77,32 +81,32 @@ Manages Task Instances. - **getFormList**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Form`](../../lib/process-services/task-list/models/form.model.ts)`[]>`
Gets all available reusable forms. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Form`](../../lib/process-services/task-list/models/form.model.ts)`[]>` - Array of form details -- **getTaskChecklist**(id: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>`
+- **getTaskChecklist**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>`
Gets the checklist for a task. - _id:_ `string` - ID of the target task - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`[]>` - Array of checklist task details -- **getTaskDetails**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+- **getTaskDetails**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Gets details for a task. - _taskId:_ `string` - ID of the target task. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Task details -- **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>`
+- **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets all the tasks matching the supplied query. - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts)`>` - List of tasks -- **getTotalTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of tasks +- **getTotalTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the total number of the tasks found by a query. - _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Number of tasks -- **isTaskRelatedToFilter**(taskId: `string` = `null`, filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
+- **isTaskRelatedToFilter**(taskId: `string`, filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>`
Checks if a taskId is filtered with the given filter. - _taskId:_ `string` - ID of the target task - _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The filter you want to check - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)`>` - The filter if it is related or null otherwise -- **unclaimTask**(taskId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+- **unclaimTask**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Unclaims a task for the current user. - _taskId:_ `string` - ID of the task to unclaim - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>` - Null response notifying when the operation is complete -- **updateTask**(taskId: `any` = `null`, updated: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
+- **updateTask**(taskId: `any`, updated: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../process-services/task-details.model.md)`>`
Updates the details (name, description, due date) for a task. - _taskId:_ `any` - ID of the task to update - _updated:_ `any` - Data to update the task (as a `TaskUpdateRepresentation` instance). diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md index 6676601d0e..2b8985496e 100644 --- a/docs/tutorials/README.md +++ b/docs/tutorials/README.md @@ -19,10 +19,10 @@ The tutorials are graded as follows: | [**Creating your Alfresco JavaScript application**](creating-javascript-app-using-alfresco-js-api.md) | Basic | In this tutorial you will learn how to create an application in JavaScript from scratch to interact with Alfresco. This is a "getting started" task that should enable you to start developing your own JavaScript application on top of Alfresco Content Services or Alfresco Process Services. | | [**Adding a new component**](new-component.md) | Basic | By definition, a _component_ controls a patch of screen called a _view_. For example, individual components define and control menus, tabs, forms, buttons and every simple or complex portion ofan application's layout. In this tutorial, you will learn how to create a component using [Angular CLI](https://cli.angular.io/) within an existing application. | | [**Adding a new view**](new-view.md) | Beginner | Every application developed in Angular is a single page application where the concepts of _view_ and _routing_ play a key role in the user experience. Being a single page application, the navigation between the different layouts (called _views_) is enabled through the _routing_. In this tutorial you will learn how to create a new view in your application and how to access it using a defined endpoint. | -| [**Using components**](using-components.md) | Beginner | There are three different ways to use, extend and configure an ADF component: configuration properties, event listeners, and content projection / HTML extensions. In this tutorial you will see a practical example of each approach using the Login component. | +| [**Using components**](using-components.md) | Beginner | There are three different ways to use, extend and configure an ADF component: configuration properties, event listeners, and content projection / HTML extensions. In this tutorial you will see a practical example of each approach using the [Login component](../core/login.component.md). | | [**Basic theming**](basic-theming.md) | Beginner | As detailed in the [user guide page about theming](../user-guide/theming.md), you can easily customize the [Cascading Style Sheets](https://en.wikipedia.org/wiki/Cascading_Style_Sheets) used by an ADF application. In this tutorial you will see how to modify the CSS, using a step-by-step approach. The focus of this tutorial is [ADF apps built using Yeoman](./creating-the-app-using-yeoman.md), but you can use the same principles to customize the themes in any ADF application. | | [**Customizing the Login component**](customising-login.md) | Intermediate | In this tutorial you will learn how to customize the [`Login` component](https://alfresco.github.io/adf-component-catalog/components/LoginComponent.html) following the [technical documentation](https://alfresco.github.io/adf-component-catalog/components/LoginComponent.html). The task will be very simple. See the documentation for further details about customizing this component, along with examples. | | [**Working with a Data Table**](working-with-data-table.md) | Intermediate | In this tutorial you will learn how to populate a [`DataTable` component](https://alfresco.github.io/adf-component-catalog/components/DataTableComponent.html) with custom data from a generic back-end service or third party API. As an example we are going to use data from one of the available services on Alfresco Content Services. However, the procedure is much the same if want to use an Alfresco Process Services endpoint or a third party API. | -| [**Working with the Nodes API Service**](working-with-nodes-api-service.md) | | In this tutorial you will learn how to use the [`NodesApiService`](https://github.com/Alfresco/alfresco-ng2-components/blob/master/lib/core/services/nodes-api.service.ts). We have developed some practical examples to show you how to interact with an instance of Alfresco Content Services without using the REST endpoints directly. With this approach the `NodesApiService` is used as an abstraction layer, defined by one of the services in the ADF Core library. | +| [**Working with the Nodes API Service**](working-with-nodes-api-service.md) | | In this tutorial you will learn how to use the [`NodesApiService`](../core/nodes-api.service.md). We have developed some practical examples to show you how to interact with an instance of Alfresco Content Services without using the REST endpoints directly. With this approach the [`NodesApiService`](../core/nodes-api.service.md) is used as an abstraction layer, defined by one of the services in the ADF Core library. | | [**Working with Nodes using the JS API**](working-with-nodes-js-api.md) | | In this tutorial you will learn how to use the [`AlfrescoCoreRestApi`](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-core-rest-api). We have developed some practical examples to show you how to interact with an instance of Alfresco Content Services without using the REST endpoints directly. With this approach the `AlfrescoCoreRestApi` is used as an abstraction layer, defining one of the core services of the [`alfresco-api-js`](https://github.com/Alfresco/alfresco-js-api) library. | -| [**Content metadata component**](content-metadata-component.md) | Advanced | In this tutorial you will learn how to work with the [`ContentMetadataComponent`](https://alfresco.github.io/adf-component-catalog/components/ContentMetadataComponent.html). This component is used to render the standard and custom metadata of generic content item (called a _node_) stored in Alfresco Content Services. With the usual approach "learning by doing", you will see here some practical examples you might find useful in your own applicatioin. As a starting point, we will use and customize the [Alfresco Content App](https://github.com/Alfresco/alfresco-content-app). | +| [**Content metadata component**](content-metadata-component.md) | Advanced | In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/content-metadata.component.md). This component is used to render the standard and custom metadata of generic content item (called a _node_) stored in Alfresco Content Services. With the usual approach "learning by doing", you will see here some practical examples you might find useful in your own applicatioin. As a starting point, we will use and customize the [Alfresco Content App](https://github.com/Alfresco/alfresco-content-app). | diff --git a/docs/tutorials/content-metadata-component.md b/docs/tutorials/content-metadata-component.md index 5a97ca7e89..967107de68 100644 --- a/docs/tutorials/content-metadata-component.md +++ b/docs/tutorials/content-metadata-component.md @@ -4,11 +4,11 @@ Level: Advanced # Content metadata component -In this tutorial you will learn how to work with the [`ContentMetadataComponent`](https://alfresco.github.io/adf-component-catalog/components/ContentMetadataComponent.html). This component is used to render the standard and custom metadata of generic content item (called a *node*) stored in Alfresco Content Services. With the usual approach "learning by doing", you will see here some practical examples you might find useful in your own applicatioin. As a starting point, we will use and customize the [Alfresco Content App](https://github.com/Alfresco/alfresco-content-app). +In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/content-metadata.component.md). This component is used to render the standard and custom metadata of generic content item (called a _node_) stored in Alfresco Content Services. With the usual approach "learning by doing", you will see here some practical examples you might find useful in your own applicatioin. As a starting point, we will use and customize the [Alfresco Content App](https://github.com/Alfresco/alfresco-content-app). ## About the `ContentMetadataComponent` -As described in the [`ContentMetadataComponent`](https://alfresco.github.io/adf-component-catalog/components/ContentMetadataComponent.html) documentation, the `adf-content-metadata-card` tag has some useful attributes, included the `preset` attribute, which is used to point to a collection of aspects/properties to render. +As described in the [`ContentMetadataComponent`](../content-services/content-metadata.component.md) documentation, the `adf-content-metadata-card` tag has some useful attributes, included the `preset` attribute, which is used to point to a collection of aspects/properties to render. Below, you can see the `preset` value requesting to render all the available aspects/properties: @@ -86,7 +86,7 @@ To add a new `preset` configuration, edit the `src/app.config.json` file and loc ### Using the `my-preset` configuration -Now that the `my-preset` configuration is defined, let's use it in a view of the ADF application. As an example, let's edit the files view, stored in the `src/app/files` folder. Specifically, let's change the `files.component.html` file as follows: +Now that the `my-preset` configuration is defined, let's use it in a view of the ADF application. As an example, let's edit the files view, stored in the `src/app/files` folder. Specifically, let's change the [`files.component`](../../demo-shell/src/app/components/files/files.component.ts)`.html` file as follows: ```html @@ -41,4 +41,3 @@ As mentioned earlier, this is a very basic example and the `Login` component can much more extensively than this. For a complete and detailed description, full of examples, check the [technical documentation about the component](https://alfresco.github.io/adf-component-catalog/components/LoginComponent.html). This describes every customization available for the `Login` component. - diff --git a/docs/tutorials/new-component.md b/docs/tutorials/new-component.md index 7a1f5bb375..a747c9bd4b 100644 --- a/docs/tutorials/new-component.md +++ b/docs/tutorials/new-component.md @@ -4,7 +4,7 @@ Level: Basic # Adding a new component -By definition, a *component* controls a patch of screen called a *view*. For example, individual components define and control menus, tabs, forms, buttons and every simple or complex portion ofan application's layout. In this tutorial, you will learn how to create a component using [Angular CLI](https://cli.angular.io/) within an existing application. +By definition, a _component_ controls a patch of screen called a _view_. For example, individual components define and control menus, tabs, forms, buttons and every simple or complex portion ofan application's layout. In this tutorial, you will learn how to create a component using [Angular CLI](https://cli.angular.io/) within an existing application. ## Creating a component @@ -25,7 +25,7 @@ Once the component is created, you can use the element anywhere within the HTML file of another component to render the content of `my-first-component`. As an example, add `` at the top of the -`app.component.html` file in the `src` folder, and run the application again. In the browser you will +[`app.component`](../../demo-shell/src/app/app.component.ts)`.html` file in the `src` folder, and run the application again. In the browser you will shortly see the text "my-first-component works!", as a placeholder to show where the component is rendered in the layout. @@ -35,12 +35,12 @@ By default the new component is created in the `src/app` path and everything is same name as the component itself. Here, you should find a folder named `my-first-component` has been added to `src/app`, with the following contents: - - `my-first-component.component.scss` containing the CSS used by the component, initially empty. - - `my-first-component.component.html` containing the HTML used to render the component. This file is -created with a very basic placeholder message that displays the name of the component within a `p` tag. - - `my-first-component.component.spec.ts` containing the unit tests for the component. - - `my-first-component.component.ts` containing the `MyFirstComponentComponent` class that implements the -business logic in typescript. +- `my-first-component.component.scss` containing the CSS used by the component, initially empty. +- `my-first-component.component.html` containing the HTML used to render the component. This file is + created with a very basic placeholder message that displays the name of the component within a `p` tag. +- `my-first-component.component.spec.ts` containing the unit tests for the component. +- `my-first-component.component.ts` containing the `MyFirstComponentComponent` class that implements the + business logic in typescript. You must declare or import the component in one or more modules in order to use it. In this example the `app.module.ts` file stored in `src/app` contains the following code: diff --git a/docs/tutorials/using-components.md b/docs/tutorials/using-components.md index 5792f78010..281de29d8d 100644 --- a/docs/tutorials/using-components.md +++ b/docs/tutorials/using-components.md @@ -4,22 +4,22 @@ Level: Beginner # Using components -There are three different ways to use, extend and configure an ADF component: configuration properties, event listeners, and content projection / HTML extensions. In this tutorial you will see a practical example of each approach using the Login component. +There are three different ways to use, extend and configure an ADF component: configuration properties, event listeners, and content projection / HTML extensions. In this tutorial you will see a practical example of each approach using the [Login component](../core/login.component.md). The ADF documentation is always a good starting point when you plan to use a component. In general, there are three different ways to use, extend and configure an ADF component: -1. Configuration properties. -2. Event listeners. -3. Content projection / HTML extensions. +1. Configuration properties. +2. Event listeners. +3. Content projection / HTML extensions. ## Configuration properties Angular components can easily be configured via properties in the HTML template. In this example we will -work with the "Remember me" checkbox and "Need Help?" and "Register" links in the footer of the Login component. +work with the "Remember me" checkbox and "Need Help?" and "Register" links in the footer of the [Login component](../core/login.component.md). To prepare for the task, make sure you have your ADF application up and running by executing `npm start` -in a terminal from the root folder of the project. Access the login page using your browser and edit the `login.component.html` file stored in the `src/app/.../login` folder. The content of the `login.component.html` file should look like the following: +in a terminal from the root folder of the project. Access the login page using your browser and edit the [`login.component`](../core/login.component.md)`.html` file stored in the `src/app/.../login` folder. The content of the [`login.component`](../core/login.component.md)`.html` file should look like the following: ```html ` component (the position is not relevant). +Back in the [`login.component`](../core/login.component.md)`.html` file, add `(success)="mySuccessMethod($event)"` to the `` component (the position is not relevant). ```html ` component supports two targets: `login-header` and `login-footer`. Let's add a simple "Hello World" message in the -footer. Edit the template `login.component.html` and add a new tag *inside* the `` tag: +footer. Edit the template [`login.component`](../core/login.component.md)`.html` and add a new tag _inside_ the `` tag: ```html ``` -Make sure that you place the `` tag *inside* the `` tag. Inside the +Make sure that you place the `` tag _inside_ the `` tag. Inside the `` or `` tags you can put anything you want, as long as you wrap it inside an `` tag. You can also add custom or 3rd party components. diff --git a/docs/tutorials/working-with-data-table.md b/docs/tutorials/working-with-data-table.md index d0bd502cd4..534d094e1c 100644 --- a/docs/tutorials/working-with-data-table.md +++ b/docs/tutorials/working-with-data-table.md @@ -21,7 +21,7 @@ is well documented [here](https://alfresco.github.io/alfresco-content-app/#/), a However, if you prefer to create a brand new ADF application from scratch then you should still be able to follow the tutorial without difficulty. -For this tutorial, the endpoint used to populate the Data Table component is the +For this tutorial, the endpoint used to populate the [Data Table component](../../lib/core/datatable/components/datatable/datatable.component.ts) is the [`/people` service](https://api-explorer.alfresco.com/api-explorer/#!/people/listPeople) which lists all users available in an Alfresco Content Services instance. The `/people` service is suitable for the purpose of this tutorial because it is available by default in the Alfresco Content Services REST API. @@ -101,7 +101,7 @@ the `src/app/mydatatable/mydatatable.component.ts` file and add the following im import { ObjectDataTableAdapter } from '@alfresco/adf-core'; ``` -A DataTable needs an instance of `ObjectDataTableAdapter` to be configured as the data source. Add +A DataTable needs an instance of [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) to be configured as the data source. Add the source code below to the `mydatatable` component, just before the constructor: ```ts @@ -174,7 +174,7 @@ context menus, actions and keyboard navigation. As a simple example, we'll add a `click` event to display an alert when a row is clicked. Open `src/app/mydatatable/mydatatable.component.html` and add the following: - + ```html ``` -This component depends on `FormRenderingService` service to map `FormFieldModel` to UI component +This component depends on [`FormRenderingService`](../core/form-rendering.service.md) service to map [`FormFieldModel`](../core/form-field.model.md) to UI component based on field type or metadata information. ### Component type resolvers -`FormRenderingService` maps field types to corresponding instances exposing `ComponentTypeResolver` interface: +[`FormRenderingService`](../core/form-rendering.service.md) maps field types to corresponding instances exposing `ComponentTypeResolver` interface: ```ts export interface ComponentTypeResolver { @@ -31,7 +43,7 @@ export interface ComponentTypeResolver { } ``` -Typically a `ComponentTypeResolver` is a function that takes `FormFieldModel` and returns corresponding component type. +Typically a `ComponentTypeResolver` is a function that takes [`FormFieldModel`](../core/form-field.model.md) and returns corresponding component type. It can be either a predefined component type or a dynamically evaluated based on field properties and metadata. #### Static component mapping @@ -51,7 +63,7 @@ formRenderingService.setComponentTypeResolver('text', () => CustomWidgetComponen #### Dynamic component mapping -Alternatively your resolver may return different component types based on `FormFieldModel` state and condition: +Alternatively your resolver may return different component types based on [`FormFieldModel`](../core/form-field.model.md) state and condition: ```ts let customResolver: ComponentTypeResolver = (field: FormFieldModel): Type<{}> => { @@ -67,25 +79,25 @@ formRenderingService.setComponentTypeResolver('text', customResolver, true); | Stencil Name | Field Type | Component Type | | ------------ | ---------- | -------------- | -| Text | text | TextWidgetComponent | -| Number | integer | NumberWidgetComponent | -| Multi-line text | multi-line-text | MultilineTextWidgetComponentComponent | -| Checkbox | boolean | CheckboxWidgetComponent | -| Dropdown | dropdown | DropdownWidgetComponent | -| Date | date | DateWidgetComponent | -| Amount | amount | AmountWidgetComponent | -| Radio buttons | radio-buttons | RadioButtonsWidgetComponent | -| Hyperlink | hyperlink | HyperlinkWidgetComponent | +| Text | text | [`TextWidgetComponent`](../../lib/core/form/components/widgets/text/text.widget.ts) | +| Number | integer | [`NumberWidgetComponent`](../../lib/core/form/components/widgets/number/number.widget.ts) | +| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) | +| Checkbox | boolean | [`CheckboxWidgetComponent`](../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) | +| Dropdown | dropdown | [`DropdownWidgetComponent`](../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) | +| Date | date | [`DateWidgetComponent`](../../lib/core/form/components/widgets/date/date.widget.ts) | +| Amount | amount | [`AmountWidgetComponent`](../../lib/core/form/components/widgets/amount/amount.widget.ts) | +| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) | +| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) | | Display value | readonly | DisplayValueWidgetComponent | -| Display text | readonly-text | DisplayTextWidgetComponentComponent | -| Typeahead | typeahead | TypeaheadWidgetComponent | -| People | people | PeopleWidgetComponent | -| Group of people | functional-group | FunctionalGroupWidgetComponent | -| Dynamic table | dynamic-table | DynamicTableWidgetComponent | -| N/A | container | ContainerWidgetComponent (layout component) | -| Header | group | ContainerWidgetComponent | -| Attach | upload | AttachWidgetComponent or UploadWidgetComponent (based on metadata) | -| N/A | N/A | UnknownWidgetComponent | +| Display text | readonly-text | [`DisplayTextWidgetComponentComponent`](../../lib/core/form/components/widgets/display-text/display-text.widget.ts) | +| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) | +| People | people | [`PeopleWidgetComponent`](../../lib/core/form/components/widgets/people/people.widget.ts) | +| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) | +| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) | +| N/A | container | [`ContainerWidgetComponent`](../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) | +| Header | group | [`ContainerWidgetComponent`](../../lib/core/form/components/widgets/container/container.widget.ts) | +| Attach | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) | +| N/A | N/A | [`UnknownWidgetComponent`](../../lib/core/form/components/widgets/unknown/unknown.widget.ts) | ## Replacing default form widgets with custom components @@ -96,7 +108,7 @@ First let's create a simple APS form with `Text` widgets: ![default text widget](../docassets/images/text-default-widget.png) -Every custom widget must inherit `WidgetComponent` class in order to function properly: +Every custom widget must inherit [`WidgetComponent`](../insights/widget.component.md) class in order to function properly: ```ts import { Component } from '@angular/core'; @@ -143,7 +155,7 @@ don't forget to import it into your main application one: export class AppModule {} ``` -Now you can import `FormRenderingService` in any of your Views and override default mapping similar to the following: +Now you can import [`FormRenderingService`](../core/form-rendering.service.md) in any of your Views and override default mapping similar to the following: ```ts import { Component } from '@angular/core'; @@ -175,7 +187,7 @@ First let's create a basic stencil and call it `Custom Stencil 01`: _Note the `internal identifier` value as it will become a `field type` value when corresponding form is rendered._ -Next put some simple html layout for `Form runtime template` and `Form editor template` fields: +Next put some simple html layout for [`Form`](../../lib/process-services/task-list/models/form.model.ts)`runtime template` and [`Form`](../../lib/process-services/task-list/models/form.model.ts)`editor template` fields: ```html
Custom activiti stencil
@@ -237,7 +249,7 @@ And import into your Application Module export class AppModule {} ``` -Now you can import `FormRenderingService` in any of your Views and provide new mapping: +Now you can import [`FormRenderingService`](../core/form-rendering.service.md) in any of your Views and provide new mapping: ```ts import { Component } from '@angular/core'; diff --git a/docs/user-guide/internationalization.md b/docs/user-guide/internationalization.md index cab65865ff..6f3c48c5f4 100644 --- a/docs/user-guide/internationalization.md +++ b/docs/user-guide/internationalization.md @@ -1,6 +1,7 @@ --- Added: v2.2.0 --- + # Internationalization in ADF Internationalization (abbreviated to i18n) is the process of providing UI messages @@ -67,7 +68,7 @@ below: ``` The hierarchical structure is referred to in the UI using the familiar "dot" -notation (so `FORM.START_FORM.TITLE` would be the key for the "Start Form" +notation (so `FORM.START_FORM.TITLE` would be the key for the "Start [Form"](../../lib/process-services/task-list/models/form.model.ts) string here). This is useful for grouping related messages and providing singular and plural versions, among other things. @@ -136,11 +137,11 @@ should check you are using the key correctly. ## Using the translate pipe -Using `TranslationService.get` is straightforward but it is often more +Using [`TranslationService`](../core/translation.service.md)`.get` is straightforward but it is often more convenient to add translation keys directly into your page's HTML. Use the `translate` pipe to convert a key in the page directly to the corresponding text. For example, the following will display the -"Start Form" text as above but without any code or variables in the +"Start [Form"](../../lib/process-services/task-list/models/form.model.ts) text as above but without any code or variables in the component's `.ts` file: @@ -203,7 +204,7 @@ messages whose content can change at runtime. For example, in the built-in The sections in curly braces are _interpolation variables_ that you supply at runtime. You can specify them by passing an extra parameter to -`TranslationService.get`; this is an object whose properties have the same +[`TranslationService`](../core/translation.service.md)`.get`; this is an object whose properties have the same names as the interpolation variables in the string: ```ts @@ -236,7 +237,7 @@ Note that when the user selects an item from the menu, it simply changes the "lo preference (which you can get via the [User Preferences service](../core/user-preferences.service.md)). The `translate` pipe reacts automatically to this and changes the page text immediately to the new language. However, text added via a variable set using -`TranslationService.get`, as in the example above, will not be updated like this; +[`TranslationService`](../core/translation.service.md)`.get`, as in the example above, will not be updated like this; you will need to get a new translation and set the variable's value again explicitly from the code. diff --git a/docs/user-guide/stencils.md b/docs/user-guide/stencils.md index 60e9d044f2..8574df7608 100644 --- a/docs/user-guide/stencils.md +++ b/docs/user-guide/stencils.md @@ -1,6 +1,19 @@ # Form Stencils -Form component provides basic support for custom stencils created with Activiti stencil editor. +[`Form`](../../lib/process-services/task-list/models/form.model.ts) component provides basic support for custom stencils created with Activiti stencil editor. + +## Contents + +- [Installing](#installing) +- [Creating new stencil](#creating-new-stencil) +- [Form runtime template](#form-runtime-template) +- [Form editor template](#form-editor-template) +- [Custom component controller](#custom-component-controller) + - [JavaScript code](#javascript-code) + - [TypeScript code](#typescript-code) + - [Mapping template with component class](#mapping-template-with-component-class) + - [Final result](#final-result) +- [Runtime result](#runtime-result) ## Installing @@ -18,16 +31,17 @@ Where `` should be replaced with a valid url pointing to your ```html ``` -- `/app/rest/script-files/controllers` - provides all stencil controllers stored within Activiti -- `runtime.ng1.js` - provides a compatibility layer for controllers created with AngularJS (aka Angular 1x) - (this is to avoid runtime errors when loading AngularJS code into `` component) +- `/app/rest/script-files/controllers` + provides all stencil controllers stored within Activiti -- `runtime.adf.js` - provides API for stencil management and registration, - i.e. mapping html templates with corresponding controller classes +- `runtime.ng1.js` + provides a compatibility layer for controllers created with AngularJS (aka Angular 1x) + (this is to avoid runtime errors when loading AngularJS code into `` component) + +- `runtime.adf.js` + provides API for stencil management and registration, + i.e. mapping html templates with corresponding controller classes ## Creating new stencil @@ -53,7 +67,7 @@ This should be a valid Angular component template that you want to render in ` @@ -145,4 +159,4 @@ Angular Component Created by: Denys ``` -ADF Form component will automatically assemble and compile a valid Angular component on the fly. \ No newline at end of file +ADF [`Form`](../../lib/process-services/task-list/models/form.model.ts) component will automatically assemble and compile a valid Angular component on the fly. diff --git a/tools/doc/tools/toc.js b/tools/doc/tools/toc.js index bea5794720..38d80d56cd 100644 --- a/tools/doc/tools/toc.js +++ b/tools/doc/tools/toc.js @@ -127,7 +127,7 @@ function makeToc(tree) { context.headings.push({ "level": heading.item.depth - 2, "title": heading.textValue, - "anchor": "#" + heading.textValue.toLowerCase().replace(/ /g, "-").replace(/[\.,]/g ,"") + "anchor": "#" + heading.textValue.toLowerCase().replace(/ /g, "-").replace(/[\.,'"`$]/g ,"") }) }); diff --git a/tools/doc/tools/typeLinker.js b/tools/doc/tools/typeLinker.js index b5cb996321..4fa6a0bfb7 100644 --- a/tools/doc/tools/typeLinker.js +++ b/tools/doc/tools/typeLinker.js @@ -1,5 +1,5 @@ "use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); +exports.__esModule = true; var path = require("path"); var fs = require("fs"); /* @@ -321,7 +321,7 @@ function resolveTypeLink(aggData, text) { var kebabName = ngHelpers.kebabifyClassName(possTypeName); var possDocFile = aggData.docFiles[kebabName]; //let url = "../../lib/" + ref.sources[0].fileName; - var url = classInfo.sourcePath; //"../../lib/" + classInfo.items[0].source.path; + var url = "../../" + classInfo.sourcePath; //"../../lib/" + classInfo.items[0].source.path; if (possDocFile) { url = "../" + possDocFile; } diff --git a/tools/doc/tools/typeLinker.ts b/tools/doc/tools/typeLinker.ts index b46d1d07ab..18ef36cd69 100644 --- a/tools/doc/tools/typeLinker.ts +++ b/tools/doc/tools/typeLinker.ts @@ -386,7 +386,7 @@ function resolveTypeLink(aggData, text): string { let possDocFile = aggData.docFiles[kebabName]; //let url = "../../lib/" + ref.sources[0].fileName; - let url = classInfo.sourcePath; //"../../lib/" + classInfo.items[0].source.path; + let url = "../../" + classInfo.sourcePath; //"../../lib/" + classInfo.items[0].source.path; if (possDocFile) { url = "../" + possDocFile;