diff --git a/docs/README.md b/docs/README.md index 4b138a384f..8259aa123a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -142,7 +142,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Edit JSON Dialog](core/dialogs/edit-json.dialog.md) | Allows a user to preview or edit a JSON content in a dialog. | [Source](../../../../) | +| [Edit JSON Dialog](core/dialogs/edit-json.dialog.md) | Allows a user to preview or edit a JSON content in a dialog. | [Source](../lib/testing/src/lib/core/dialog/edit-json-dialog.ts) | ### Interfaces @@ -256,97 +256,97 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Add Permission Dialog Component](content-services/components/add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission-dialog.component.ts) | -| [Add Permission Panel Component](content-services/components/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts) | -| [Add Permission Component](content-services/components/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts) | -| [Breadcrumb Component](content-services/components/breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) | -| [Content Action component](content-services/components/content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) | -| [Content Metadata Card component](content-services/components/content-metadata-card.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) | -| [Content Node Selector Panel component](content-services/components/content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) | -| [Content Node Selector component](content-services/components/content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) | -| [Document List component](content-services/components/document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/document-list/components/document-list.component.ts) | -| [Dropdown Breadcrumb Component](content-services/components/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) | -| [File Uploading Dialog Component](content-services/components/file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/upload/components/file-uploading-dialog.component.ts) | -| [Like component](content-services/components/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/social/like.component.ts) | -| [Permission List Component](content-services/components/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/permission-manager/components/permission-list/permission-list.component.ts) | -| [Rating component](content-services/components/rating.component.md) | Allows a user to add and remove rating to an item. | [Source](../lib/content-services/social/rating.component.ts) | -| [Search check list component](content-services/components/search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-check-list/search-check-list.component.ts) | -| [Search Chip List Component](content-services/components/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts) | -| [Search control component](content-services/components/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.component.ts) | -| [Search date range component](content-services/components/search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-date-range/search-date-range.component.ts) | -| [Search Filter component](content-services/components/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/search/components/search-filter/search-filter.component.ts) | -| [Search number range component](content-services/components/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-number-range/search-number-range.component.ts) | -| [Search radio component](content-services/components/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-radio/search-radio.component.ts) | -| [Search slider component](content-services/components/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-slider/search-slider.component.ts) | -| [Search Sorting Picker Component](content-services/components/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts) | -| [Search text component](content-services/components/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/search/components/search-text/search-text.component.ts) | -| [Search component](content-services/components/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.component.ts) | -| [Sites Dropdown component](content-services/components/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/site-dropdown/sites-dropdown.component.ts) | -| [Tag Node Actions List component](content-services/components/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/tag/tag-actions.component.ts) | -| [Tag List component](content-services/components/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/tag/tag-list.component.ts) | -| [Tag Node List component](content-services/components/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/tag/tag-node-list.component.ts) | -| [Tree View component](content-services/components/tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../lib/content-services/tree-view/components/tree-view.component.ts) | -| [Upload Button Component](content-services/components/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/upload/components/upload-button.component.ts) | -| [Upload Drag Area Component](content-services/components/upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../lib/content-services/upload/components/upload-drag-area.component.ts) | -| [Upload Version Button Component (Workaround)](content-services/components/upload-version-button.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../lib/content-services/upload/components/upload-version-button.component.ts) | -| [Version List component](content-services/components/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/version-manager/version-list.component.ts) | -| [Version Manager Component](content-services/components/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/version-manager/version-manager.component.ts) | -| [Webscript component](content-services/components/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/webscript/webscript.component.ts) | +| [Add Permission Dialog Component](content-services/components/add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-dialog.component.ts) | +| [Add Permission Panel Component](content-services/components/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-panel.component.ts) | +| [Add Permission Component](content-services/components/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission.component.ts) | +| [Breadcrumb Component](content-services/components/breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/src/lib/breadcrumb/breadcrumb.component.ts) | +| [Content Action component](content-services/components/content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/src/lib/document-list/components/content-action/content-action.component.ts) | +| [Content Metadata Card component](content-services/components/content-metadata-card.component.md) | Displays and edits metadata related to a node. | [Source](../lib/content-services/src/lib/content-metadata/components/content-metadata-card/content-metadata-card.component.ts) | +| [Content Node Selector Panel component](content-services/components/content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector-panel.component.ts) | +| [Content Node Selector component](content-services/components/content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-selector.component.ts) | +| [Document List component](content-services/components/document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/src/lib/document-list/components/document-list.component.ts) | +| [Dropdown Breadcrumb Component](content-services/components/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts) | +| [File Uploading Dialog Component](content-services/components/file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/src/lib/upload/components/file-uploading-dialog.component.ts) | +| [Like component](content-services/components/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/src/lib/social/like.component.ts) | +| [Permission List Component](content-services/components/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/src/lib/permission-manager/components/permission-list/permission-list.component.ts) | +| [Rating component](content-services/components/rating.component.md) | Allows a user to add and remove rating to an item. | [Source](../lib/content-services/src/lib/social/rating.component.ts) | +| [Search check list component](content-services/components/search-check-list.component.md) | Implements a checklist widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-check-list/search-check-list.component.ts) | +| [Search Chip List Component](content-services/components/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/src/lib/search/components/search-chip-list/search-chip-list.component.ts) | +| [Search control component](content-services/components/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/src/lib/search/components/search-control.component.ts) | +| [Search date range component](content-services/components/search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-date-range/search-date-range.component.ts) | +| [Search Filter component](content-services/components/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts) | +| [Search number range component](content-services/components/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-number-range/search-number-range.component.ts) | +| [Search radio component](content-services/components/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-radio/search-radio.component.ts) | +| [Search slider component](content-services/components/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-slider/search-slider.component.ts) | +| [Search Sorting Picker Component](content-services/components/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/src/lib/search/components/search-sorting-picker/search-sorting-picker.component.ts) | +| [Search text component](content-services/components/search-text.component.md) | Implements a text input widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-text/search-text.component.ts) | +| [Search component](content-services/components/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/src/lib/search/components/search.component.ts) | +| [Sites Dropdown component](content-services/components/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/src/lib/site-dropdown/sites-dropdown.component.ts) | +| [Tag Node Actions List component](content-services/components/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/src/lib/tag/tag-actions.component.ts) | +| [Tag List component](content-services/components/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/src/lib/tag/tag-list.component.ts) | +| [Tag Node List component](content-services/components/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/src/lib/tag/tag-node-list.component.ts) | +| [Tree View component](content-services/components/tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../lib/content-services/src/lib/tree-view/components/tree-view.component.ts) | +| [Upload Button Component](content-services/components/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/src/lib/upload/components/upload-button.component.ts) | +| [Upload Drag Area Component](content-services/components/upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../lib/content-services/src/lib/upload/components/upload-drag-area.component.ts) | +| [Upload Version Button Component (Workaround)](content-services/components/upload-version-button.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../lib/content-services/src/lib/upload/components/upload-version-button.component.ts) | +| [Version List component](content-services/components/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/src/lib/version-manager/version-list.component.ts) | +| [Version Manager Component](content-services/components/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/src/lib/version-manager/version-manager.component.ts) | +| [Webscript component](content-services/components/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/src/lib/webscript/webscript.component.ts) | ### Directives | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Node Public File Share Directive](content-services/directives/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/content-node-share/content-node-share.directive.ts) | -| [File Draggable directive](content-services/directives/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a div. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) | -| [Folder Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) | -| [Folder Edit directive](content-services/directives/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) | -| [Inherit Permission directive](content-services/directives/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/permission-manager/components/inherited-button.directive.ts) | -| [Node Lock directive](content-services/directives/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/directives/node-lock.directive.ts) | -| [Toggle Icon directive](content-services/directives/toggle-icon.directive.md) | Toggle icon on mouse or keyboard event for a selectable element. | [Source](../lib/content-services/upload/directives/toggle-icon.directive.ts) | +| [Node Public File Share Directive](content-services/directives/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/src/lib/content-node-share/content-node-share.directive.ts) | +| [File Draggable directive](content-services/directives/file-draggable.directive.md) | Provides drag-and-drop features for an element such as a div. | [Source](../lib/content-services/src/lib/upload/directives/file-draggable.directive.ts) | +| [Folder Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/src/lib/folder-directive/folder-create.directive.ts) | +| [Folder Edit directive](content-services/directives/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/src/lib/folder-directive/folder-edit.directive.ts) | +| [Inherit Permission directive](content-services/directives/inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/inherited-button.directive.ts) | +| [Node Lock directive](content-services/directives/node-lock.directive.md) | Locks or unlocks a node. | [Source](../lib/content-services/src/lib/directives/node-lock.directive.ts) | +| [Toggle Icon directive](content-services/directives/toggle-icon.directive.md) | Toggle icon on mouse or keyboard event for a selectable element. | [Source](../lib/content-services/src/lib/upload/directives/toggle-icon.directive.ts) | ### Dialogs | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Confirm dialog component](content-services/dialogs/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/dialogs/confirm.dialog.ts) | -| [Library dialog component](content-services/dialogs/library.dialog.md) | Creates a new Content Services document library/site. | [Source](../lib/content-services/dialogs/library/library.dialog.ts) | +| [Confirm dialog component](content-services/dialogs/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/src/lib/dialogs/confirm.dialog.ts) | +| [Library dialog component](content-services/dialogs/library.dialog.md) | Creates a new Content Services document library/site. | [Source](../lib/content-services/src/lib/dialogs/library/library.dialog.ts) | ### Interfaces | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Search widget interface](content-services/interfaces/search-widget.interface.md) | Specifies required properties for Search filter component widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) | +| [Search widget interface](content-services/interfaces/search-widget.interface.md) | Specifies required properties for Search filter component widgets. | [Source](../lib/content-services/src/lib/search/search-widget.interface.ts) | ### Models | Name | Description | Source link | | ---- | ----------- | ----------- | | [Image Resolver Model](content-services/models/image-resolver.model.md) | Defines the Image Resolver function used by the Document List Component. | [Source](../lib/content-services/document-list/data/image-resolver.model.ts) | -| [Permission Style model](content-services/models/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/document-list/models/permissions-style.model.ts) | +| [Permission Style model](content-services/models/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) | | [Row Filter Model](content-services/models/row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../lib/content-services/document-list/data/row-filter.model.ts) | ### Pipes | Name | Description | Source link | | ---- | ----------- | ----------- | -| [File upload error pipe](content-services/pipes/file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../lib/content-services/upload/pipes/file-upload-error.pipe.ts) | +| [File upload error pipe](content-services/pipes/file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../lib/content-services/src/lib/upload/pipes/file-upload-error.pipe.ts) | ### Services | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Content Node Dialog service](content-services/services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/content-node-selector/content-node-dialog.service.ts) | -| [Custom Resources service](content-services/services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/document-list/services/custom-resources.service.ts) | -| [Document Actions service](content-services/services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/document-actions.service.ts) | -| [Document List service](content-services/services/document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/document-list/services/document-list.service.ts) | -| [Folder Actions service](content-services/services/folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) | -| [Node permission dialog service](content-services/services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/permission-manager/services/node-permission-dialog.service.ts) | -| [Node Permission service](content-services/services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/permission-manager/services/node-permission.service.ts) | -| [Rating service](content-services/services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/social/services/rating.service.ts) | -| [Search filter service](content-services/services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/search/components/search-filter/search-filter.service.ts) | -| [Search Query Builder service](content-services/services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/search/search-query-builder.service.ts) | -| [Tag service](content-services/services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/tag/services/tag.service.ts) | +| [Content Node Dialog service](content-services/services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts) | +| [Custom Resources service](content-services/services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/src/lib/document-list/services/custom-resources.service.ts) | +| [Document Actions service](content-services/services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-actions.service.ts) | +| [Document List service](content-services/services/document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/document-list.service.ts) | +| [Folder Actions service](content-services/services/folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/src/lib/document-list/services/folder-actions.service.ts) | +| [Node permission dialog service](content-services/services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts) | +| [Node Permission service](content-services/services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/src/lib/permission-manager/services/node-permission.service.ts) | +| [Rating service](content-services/services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/src/lib/social/services/rating.service.ts) | +| [Search filter service](content-services/services/search-filter.service.md) | Registers widgets for use with the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.service.ts) | +| [Search Query Builder service](content-services/services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/src/lib/search/search-query-builder.service.ts) | +| [Tag service](content-services/services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/src/lib/tag/services/tag.service.ts) | @@ -381,7 +381,7 @@ for more information about installing and using the source code. | [Process Instance Details Header component](process-services/components/process-instance-header.component.md) | Sub-component of the process details component, which renders some general information about the selected process. | [Source](../lib/process-services/src/lib/process-list/components/process-instance-header.component.ts) | | [Process Instance Tasks component](process-services/components/process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../lib/process-services/src/lib/process-list/components/process-instance-tasks.component.ts) | | [Process Instance List](process-services/components/process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/src/lib/process-list/components/process-list.component.ts) | -| [Select App Component](process-services/components/select-apps-dialog.component.md) | Shows all available apps and returns the selected app. | [Source](../lib/process-services/src/lib/app-list/select-apps-dialog-component.ts) | +| [Select App Component](process-services/components/select-apps-dialog.component.md) | Shows all available apps and returns the selected app. | [Source](../lib/process-services/src/lib/app-list/select-apps-dialog.component.ts) | | [Start Process component](process-services/components/start-process.component.md) | Starts a process. | [Source](../lib/process-services/src/lib/process-list/components/start-process.component.ts) | | [Start Task Component](process-services/components/start-task.component.md) | Creates/Starts a new task for the specified app. | [Source](../lib/process-services/src/lib/task-list/components/start-task.component.ts) | | [Task Attachment List Component](process-services/components/task-attachment-list.component.md) | Displays documents attached to a specified task. | [Source](../lib/process-services/src/lib/attachment/task-attachment-list.component.ts) | @@ -431,14 +431,14 @@ for more information about installing and using the source code. | [Form cloud component](process-services-cloud/components/form-cloud.component.md) | Shows a form from Process Services. | [Source](../lib/process-services-cloud/src/lib/form/components/form-cloud.component.ts) | | [Form Definition Selector Cloud](process-services-cloud/components/form-definition-selector-cloud.component.md) | Allows one form to be selected from a dropdown list. For forms to be displayed in this component they will need to be compatible with standAlone tasks. | [Source](../lib/process-services-cloud/src/lib/form/components/form-definition-selector-cloud.component.ts) | | [Group Cloud component](process-services-cloud/components/group-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) | -| [People Cloud Component](process-services-cloud/components/people-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Allows one or more users to be selected (with auto-suggestion) based on the input parameters. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) | +| [People Cloud Component](process-services-cloud/components/people-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Allows one or more users to be selected (with auto-suggestion) based on the input parameters. | [Source](../lib/process-services-cloud/src/lib/people/components/people-cloud.component.ts) | | [Process Filters Cloud Component](process-services-cloud/components/process-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) | | [Process Header Cloud Component](process-services-cloud/components/process-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a process instance. | [Source](../lib/process-services-cloud/src/lib/process/process-header/components/process-header-cloud.component.ts) | | [Process Instance List Cloud component](process-services-cloud/components/process-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) | | [Start Process Cloud Component](process-services-cloud/components/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | | [Start Task Cloud Component](process-services-cloud/components/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | | [Task Filters Cloud component](process-services-cloud/components/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | -| [Form cloud component](process-services-cloud/components/task-form-cloud.component.md) | Shows a form for a task. | [Source](../lib/process-services-cloud/src/lib/task/task-form/components/task-form-cloud.component.ts) | +| [Form cloud component](process-services-cloud/components/task-form-cloud.component.md) | Shows a form for a task. | [Source](../lib/testing/src/lib/process-services-cloud/pages/task-form-cloud-component.page.ts) | | [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | | [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | @@ -446,6 +446,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | +| [Cancel Process Directive](process-services-cloud/directives/cancel-process.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Cancels a process | [Source](../lib/process-services-cloud/src/lib/process/directives/cancel-process.directive.ts) | | [Claim Task Directive](process-services-cloud/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task.directive.ts) | | [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) | | [Unclaim Task Directive](process-services-cloud/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task.directive.ts) | @@ -461,11 +462,11 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Apps Process Cloud Service](process-services-cloud/services/apps-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets details of deployed apps for the current user. | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | -| [Form cloud service](process-services-cloud/services/form-cloud.service.md) | Implements Process Services form methods | [Source](../lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts) | +| [Form cloud service](process-services-cloud/services/form-cloud.service.md) | Implements Process Services form methods | [Source](../lib/testing/src/lib/form-cloud/actions/form-cloud.service.ts) | | [Group Cloud Service](process-services-cloud/services/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | | [Local Preference Cloud Service](process-services-cloud/services/local-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages Local Storage preferences. | [Source](../lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts) | +| [Process Cloud Service](process-services-cloud/services/process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud process instances. | [Source](../lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts) | | [Process Filter Cloud Service](process-services-cloud/services/process-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) | -| [Process Header Cloud Service](process-services-cloud/services/process-header-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud process instances. | [Source](../lib/process-services-cloud/src/lib/process/process-header/services/process-header-cloud.service.ts) | | [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | | [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | | [Start Task Cloud Service](process-services-cloud/services/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/services/start-task-cloud.service.ts) | diff --git a/docs/content-services/components/content-node-selector-panel.component.md b/docs/content-services/components/content-node-selector-panel.component.md index d794a66993..fd39deaf7b 100644 --- a/docs/content-services/components/content-node-selector-panel.component.md +++ b/docs/content-services/components/content-node-selector-panel.component.md @@ -40,6 +40,8 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own | where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. | | excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | | rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom row filter function. See the [Row Filter Model](row-filter.model.md) page for more information. | +| showDropdownSiteList | `boolean` | | Toggle sites list dropdown rendering | +| showSearch | `boolean` | | Toggle search input rendering | ### Events diff --git a/docs/core/components/data-column.component.md b/docs/core/components/data-column.component.md index cc5b10977f..d9a8a031e5 100644 --- a/docs/core/components/data-column.component.md +++ b/docs/core/components/data-column.component.md @@ -46,6 +46,7 @@ Defines column properties for DataTable, Tasklist, Document List and other compo | copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of cell contents. | | cssClass | `string` | | Additional CSS class to be applied to column (header and cells). | | editable | `boolean` | false | Toggles the editing support of the column data. | +| focus | `boolean` | true | Enable or disable cell focus | | format | `string` | | Value format (if supported by the parent component), for example format of the date. | | formatTooltip | `Function` | | Custom tooltip formatter function. | | key | `string` | | Data source key. Can be either a column/property key like `title` or a property path like `createdBy.name`. | @@ -53,7 +54,6 @@ Defines column properties for DataTable, Tasklist, Document List and other compo | srTitle | `string` | | Title to be used for screen readers. | | title | `string` | "" | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. | | type | `string` | "text" | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize', 'location', and 'json'. | -| focus | `boolean` | "true" | Toggles keyboard focus for a column. This should be use for custom template columns that contain actions elements | ## Details diff --git a/docs/core/components/login.component.md b/docs/core/components/login.component.md index 7c02720d04..5625781a51 100644 --- a/docs/core/components/login.component.md +++ b/docs/core/components/login.component.md @@ -346,16 +346,14 @@ To enable public accessible urls, that don't need authentication, these must be } ``` - ### Kerberos The configuration for Kerberos authentication will allow users to access Alfresco products by entering their credentials only once when first logging into their Windows environment. -**You don't need to use the login component in order to enable Kerberos SSO in ADF**. +**You don't need to use the [login component](../../core/components/login.component.md) in order to enable Kerberos SSO in ADF**. See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app. - ## See Also - [Logout directive](../directives/logout.directive.md) diff --git a/docs/core/dialogs/edit-json.dialog.md b/docs/core/dialogs/edit-json.dialog.md index f4d61ca234..4ee2ccfb84 100644 --- a/docs/core/dialogs/edit-json.dialog.md +++ b/docs/core/dialogs/edit-json.dialog.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-09-17 --- -# [Edit JSON Dialog](../../../ "Defined in ") +# [Edit JSON Dialog](../../../lib/testing/src/lib/core/dialog/edit-json-dialog.ts "Defined in edit-json-dialog.ts") Allows a user to preview or edit a JSON content in a dialog. diff --git a/docs/core/directives/logout.directive.md b/docs/core/directives/logout.directive.md index 4a40c1d52b..f3e39f96e3 100644 --- a/docs/core/directives/logout.directive.md +++ b/docs/core/directives/logout.directive.md @@ -24,12 +24,11 @@ Logs the user out when the decorated element is clicked. | enableRedirect | `boolean` | true | Enable redirecting after logout | | redirectUri | `string` | "/login" | URI to redirect to after logging out. | - ## Kerberos The configuration for Kerberos authentication will allow users to access Alfresco products by entering their credentials only once when logging into their Windows environment. -**You don't need to use the logout directive when Kerberos SSO is enabled in ADF**. +**You don't need to use the [logout directive](../../core/directives/logout.directive.md) when Kerberos SSO is enabled in ADF**. See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app. diff --git a/docs/core/interfaces/card-view-item.interface.md b/docs/core/interfaces/card-view-item.interface.md index 595f59a053..fa8c56dc2d 100644 --- a/docs/core/interfaces/card-view-item.interface.md +++ b/docs/core/interfaces/card-view-item.interface.md @@ -125,7 +125,7 @@ Picard's birthday (47457.1): export class MyModule {} ``` -4. Bind your custom component to the custom model type so that Angular's dynamic component +4. Bind your custom component to the [custom model](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/api/customModel.api.ts) type so that Angular's dynamic component loader can find it. ```ts diff --git a/docs/core/services/authentication.service.md b/docs/core/services/authentication.service.md index 1507d875b2..d19845bff3 100644 --- a/docs/core/services/authentication.service.md +++ b/docs/core/services/authentication.service.md @@ -69,6 +69,10 @@ Provides authentication to ACS and APS. - **isOauth**(): `boolean`
Does the provider support OAuth? - **Returns** `boolean` - True if supported, false otherwise +- **isPublicUrl**(): `boolean`
+ + - **Returns** `boolean` - + - **isRememberMeSet**(): `boolean`
Checks whether the "remember me" cookie was set or not. - **Returns** `boolean` - True if set, false otherwise diff --git a/docs/core/services/identity-group.service.md b/docs/core/services/identity-group.service.md index 63c5007012..ab11db168c 100644 --- a/docs/core/services/identity-group.service.md +++ b/docs/core/services/identity-group.service.md @@ -37,10 +37,10 @@ Performs CRUD operations on identity groups. Deletes Group. - _groupId:_ `string` - Id of the group. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the group deleted. -- **findGroupsByName**(searchParams: [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **findGroupsByName**(searchParams: [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`
Finds groups filtered by name. - _searchParams:_ [`IdentityGroupSearchParam`](../../../lib/core/models/identity-group.model.ts) - Object containing the name filter string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of group information + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - List of group information - **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the client Id using the app name. - _applicationName:_ `string` - Name of the app diff --git a/docs/core/services/identity-user.service.md b/docs/core/services/identity-user.service.md index 9f97b94935..6b1a741df7 100644 --- a/docs/core/services/identity-user.service.md +++ b/docs/core/services/identity-user.service.md @@ -58,22 +58,22 @@ Gets OAuth2 personal details and roles for users and performs CRUD operations on Deletes User. - _userId:_ `string` - Id of the user. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the user deleted. -- **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
Find users based on email input. - _email:_ `string` - Search query string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of users + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users - **findUserById**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Find users based on id input. - _id:_ `string` - Search query string - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - users object -- **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
Find users based on username input. - _username:_ `string` - Search query string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of users -- **findUsersByName**(search: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users +- **findUsersByName**(search: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>`
Find users based on search input. - _search:_ `string` - Search query string - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of users + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` - List of users - **getAssignedRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`
Gets assigned roles. - _userId:_ `string` - Id of the user. diff --git a/docs/core/services/jwt-helper.service.md b/docs/core/services/jwt-helper.service.md index 39b91ecb80..140a1f3c26 100644 --- a/docs/core/services/jwt-helper.service.md +++ b/docs/core/services/jwt-helper.service.md @@ -32,8 +32,8 @@ Decodes a JSON Web Token (JWT) to a JavaScript object. - _key:_ `string` - Key name of the field to retrieve - **getValueFromToken**(accessToken: `string`, key: `string`)
Gets a named value from the user access token. - - _accessToken:_ `string` - - - _key:_ `string` - + - _accessToken:_ `string` - your SSO access token where the value is encode + - _key:_ `string` - Key name of the field to retrieve - **hasClientRole**(clientName: `string`, role: `string`): `boolean`
Checks for client role. - _clientName:_ `string` - Targeted client name diff --git a/docs/core/services/page-title.service.md b/docs/core/services/page-title.service.md index 849bd1ee31..428e9bfbb3 100644 --- a/docs/core/services/page-title.service.md +++ b/docs/core/services/page-title.service.md @@ -24,7 +24,7 @@ be concatenated with the `value` parameter when `setTitle` is called, giving a result of the form "PageName - AppName" (see [App Config service](app-config.service.md) for more information). If `value` is not supplied then just the app name is used; this will default to -"Alfresco ADF Application" when no app name set in the config file. +"Alfresco ADF [Application"](../../../lib/testing/src/lib/core/structure/application.ts) when no app name set in the config file. ## See also diff --git a/docs/core/services/storage.service.md b/docs/core/services/storage.service.md index a612536567..bd8a7f3e0c 100644 --- a/docs/core/services/storage.service.md +++ b/docs/core/services/storage.service.md @@ -62,9 +62,10 @@ In order to achieve this, you will only need to set your app identifier under th This identifier must be unique to the app to guarantee that it has its own storage. ### SSO storagePrefix related scenario + The storagePrefix can allow you to login with multiple user in the same browser only if: - - Or You don't use the implicit flow - - Or You use implicit flow you use different AIMS instances for any app + \- Or You don't use the implicit flow + \- Or You use implicit flow you use different AIMS instances for any app ## See also diff --git a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md index c2366fc328..75e8f53f5b 100644 --- a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md @@ -44,9 +44,10 @@ Shows/edits process filter details. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | actions | `string[]` | | List of sort actions. | -| appName | `string` | | The name of the application. | +| appName | `string` | "" | The name of the application. | | filterProperties | `string[]` | | List of process filter properties to display | | id | `string` | | Id of the process instance filter. | +| role | `string` | "" | roles to filter the apps | | showFilterActions | `boolean` | true | Toggles editing of process filter actions. | | showTitle | `boolean` | true | Toggles editing of the process filter title. | | sortProperties | `string[]` | | List of sort properties to display. | diff --git a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md index 2458057613..6a64143363 100644 --- a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md @@ -44,9 +44,10 @@ Edits task filter details. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | actions | `string[]` | | List of task filter actions. | -| appName | `string` | | (required) Name of the app. | +| appName | `string` | "" | (required) Name of the app. | | filterProperties | `string[]` | | List of task filter properties to display. | | id | `string` | | (required) ID of the task filter. | +| role | `string` | "" | user role. | | showFilterActions | `boolean` | true | Toggles the filter actions. | | showTitle | `boolean` | true | Toggles the title. | | sortProperties | `string[]` | | List of sort properties to display. | diff --git a/docs/process-services-cloud/components/form-cloud.component.md b/docs/process-services-cloud/components/form-cloud.component.md index caf0bdcd10..79bbd525e0 100644 --- a/docs/process-services-cloud/components/form-cloud.component.md +++ b/docs/process-services-cloud/components/form-cloud.component.md @@ -76,7 +76,7 @@ The template defined inside `empty-form` will be shown when no form definition i | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | App id to fetch corresponding form and values. | +| appName | `string` | "" | App name to fetch corresponding form and values. | | appVersion | `number` | | The application version to use when fetching data | | data | [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` | | Custom form values map to be used with the rendered form. | | disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. | diff --git a/docs/process-services-cloud/components/form-definition-selector-cloud.component.md b/docs/process-services-cloud/components/form-definition-selector-cloud.component.md index f561e98683..aa8fbf1573 100644 --- a/docs/process-services-cloud/components/form-definition-selector-cloud.component.md +++ b/docs/process-services-cloud/components/form-definition-selector-cloud.component.md @@ -23,7 +23,7 @@ Allows one form to be selected from a dropdown list. For forms to be displayed i | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. | +| appName | `string` | "" | Name of the application. If specified, this shows the users who have access to the app. | ### Events diff --git a/docs/process-services-cloud/components/group-cloud.component.md b/docs/process-services-cloud/components/group-cloud.component.md index 9131edfba8..5a41b93a5b 100644 --- a/docs/process-services-cloud/components/group-cloud.component.md +++ b/docs/process-services-cloud/components/group-cloud.component.md @@ -9,6 +9,17 @@ Last reviewed: 2019-03-20 Searches Groups. +## Contents + +- [Basic Usage](#basic-usage) +- [Class members](#class-members) + - [Properties](#properties) + - [Events](#events) +- [Details](#details) + - [Selection Mode](#selection-mode) + - [Pre-selection](#pre-selection) + - [Read-only](#read-only) + ## Basic Usage ```html @@ -27,19 +38,22 @@ Searches Groups. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appName | `string` | | Name of the application. If specified this shows the groups who have access to the app. | -| readOnly | `boolean` | false | readOnly mode (true/false). | -| mode | `string` | | User selection mode (single/multiple). | +| mode | `string` | | Group selection mode (single/multiple). | | preSelectGroups | [`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]` | \[] | Array of groups to be pre-selected. This pre-selects all groups in multi selection mode and only the first group of the array in single selection mode. | +| readOnly | `boolean` | false | Show the info in readonly mode | | roles | `string[]` | \[] | Role names of the groups to be listed. | -| searchGroupsControl | `FormControl` | new FormControl() | FormControl to search the group | +| searchGroupsControl | `FormControl` | | FormControl to search the group | | title | `string` | | Title of the field | +| validate | `Boolean` | false | This flag enables the validation on the preSelectGroups passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | +| changedGroups | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` | Emitted when a group selection change. | | removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is removed. | | selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is selected. | +| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | ## Details diff --git a/docs/process-services-cloud/components/people-cloud.component.md b/docs/process-services-cloud/components/people-cloud.component.md index 3a3a1272e7..6443ab6dc7 100644 --- a/docs/process-services-cloud/components/people-cloud.component.md +++ b/docs/process-services-cloud/components/people-cloud.component.md @@ -5,7 +5,7 @@ Status: Experimental Last reviewed: 2019-03-20 --- -# [People Cloud Component](../../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts "Defined in people-cloud.component.ts") +# [People Cloud Component](../../../lib/process-services-cloud/src/lib/people/components/people-cloud.component.ts "Defined in people-cloud.component.ts") Allows one or more users to be selected (with auto-suggestion) based on the input parameters. @@ -25,11 +25,11 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. | -| readOnly | `boolean` | false | readOnly mode (true/false). | | mode | `string` | | User selection mode (single/multiple). | -| preSelectUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | +| preSelectUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | +| readOnly | `boolean` | false | Show the info in readonly mode | | roles | `string[]` | | Role names of the users to be listed. | -| searchUserCtrl | `FormControl` | new FormControl() | FormControl to search the user | +| searchUserCtrl | `FormControl` | | FormControl to search the user | | title | `string` | | Placeholder translation key | | validate | `Boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. | @@ -37,6 +37,7 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu | Name | Type | Description | | ---- | ---- | ----------- | +| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. | | removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. | | selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a user is selected. | | warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an warning occurs. | @@ -66,6 +67,7 @@ const preSelectUsers = [ { "id": "3", "username": "username3", "firstName": "user 3", "readonly": true } ]; ``` + ```html ` | Emitted when the starting process is cancelled | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. | +| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the process is successfully started. | ## Details diff --git a/docs/process-services-cloud/components/start-task-cloud.component.md b/docs/process-services-cloud/components/start-task-cloud.component.md index 45510ce08e..ba2c013821 100644 --- a/docs/process-services-cloud/components/start-task-cloud.component.md +++ b/docs/process-services-cloud/components/start-task-cloud.component.md @@ -25,7 +25,7 @@ Creates/starts a new task for the specified app. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | (required) Name of the app. | +| appName | `string` | "" | (required) Name of the app. | | maxNameLength | `number` | | Maximum length of the task name. | | name | `string` | "" | Name of the task. | diff --git a/docs/process-services-cloud/components/task-filters-cloud.component.md b/docs/process-services-cloud/components/task-filters-cloud.component.md index 942fe26d88..99bcefb9a4 100644 --- a/docs/process-services-cloud/components/task-filters-cloud.component.md +++ b/docs/process-services-cloud/components/task-filters-cloud.component.md @@ -21,7 +21,7 @@ Shows all available filters. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | Display filters available to the current user for the application with the specified name. | +| appName | `string` | "" | Display filters available to the current user for the application with the specified name. | | filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. | | showIcons | `boolean` | false | Toggles display of the filter's icons. | diff --git a/docs/process-services-cloud/components/task-header-cloud.component.md b/docs/process-services-cloud/components/task-header-cloud.component.md index 904baf2c86..6fb0f0b02b 100644 --- a/docs/process-services-cloud/components/task-header-cloud.component.md +++ b/docs/process-services-cloud/components/task-header-cloud.component.md @@ -26,7 +26,7 @@ Shows all the information related to a task. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | (Required) The name of the application. | +| appName | `string` | "" | (Required) The name of the application. | | taskId | `string` | | (Required) The id of the task. | ### Events diff --git a/docs/process-services-cloud/directives/claim-task.directive.md b/docs/process-services-cloud/directives/claim-task.directive.md index 8244aabffa..c1a8dba857 100644 --- a/docs/process-services-cloud/directives/claim-task.directive.md +++ b/docs/process-services-cloud/directives/claim-task.directive.md @@ -21,7 +21,7 @@ Claims a task | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | (Required) The name of the application. | +| appName | `string` | "" | (Required) The name of the application. | | taskId | `string` | | (Required) The id of the task. | ### Events diff --git a/docs/process-services-cloud/directives/complete-task.directive.md b/docs/process-services-cloud/directives/complete-task.directive.md index b88abcb934..bc7587b2a7 100644 --- a/docs/process-services-cloud/directives/complete-task.directive.md +++ b/docs/process-services-cloud/directives/complete-task.directive.md @@ -21,7 +21,7 @@ Completes a task. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | (Required) The name of the application. | +| appName | `string` | "" | (Required) The name of the application. | | taskId | `string` | | (Required) The id of the task. | ### Events diff --git a/docs/process-services-cloud/directives/unclaim-task.directive.md b/docs/process-services-cloud/directives/unclaim-task.directive.md index 6c01fa04fb..75d0c576f6 100644 --- a/docs/process-services-cloud/directives/unclaim-task.directive.md +++ b/docs/process-services-cloud/directives/unclaim-task.directive.md @@ -21,7 +21,7 @@ Unclaims a task | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | (Required) The name of the application. | +| appName | `string` | "" | (Required) The name of the application. | | taskId | `string` | | (Required) The id of the task. | ### Events diff --git a/docs/process-services-cloud/services/apps-process-cloud.service.md b/docs/process-services-cloud/services/apps-process-cloud.service.md index 60686f7f81..e6755d0439 100644 --- a/docs/process-services-cloud/services/apps-process-cloud.service.md +++ b/docs/process-services-cloud/services/apps-process-cloud.service.md @@ -13,9 +13,10 @@ Gets details of deployed apps for the current user. ### Methods -- **getDeployedApplicationsByStatus**(status: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>`
+- **getDeployedApplicationsByStatus**(status: `string`, role?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>`
Gets a list of deployed apps for this user by status. - _status:_ `string` - Required status value + - _role:_ `string` - (Optional) to filter the apps - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>` - The list of deployed apps - **hasDeployedApps**(): `boolean`
diff --git a/docs/process-services-cloud/services/process-cloud.service.md b/docs/process-services-cloud/services/process-cloud.service.md index 5a6a3addab..7b66c942d0 100644 --- a/docs/process-services-cloud/services/process-cloud.service.md +++ b/docs/process-services-cloud/services/process-cloud.service.md @@ -13,10 +13,15 @@ Manages cloud process instances. ### Methods +- **cancelProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+ Cancels a process. + - _appName:_ `string` - Name of the app + - _processInstanceId:_ `string` - Id of the process to cancel + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Operation Information - **getBasePath**(appName: `string`): `string`
- - _appName:_ `string` - - - **Returns** `string` - + - _appName:_ `string` - + - **Returns** `string` - - **getProcessInstanceById**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Gets details of a process instance. @@ -24,12 +29,6 @@ Manages cloud process instances. - _processInstanceId:_ `string` - ID of the process instance whose details you want - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Process instance details -- **cancelProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
- Cancels a process instance. - - _appName:_ `string` - Name of the app - - _processInstanceId:_ `string` - ID of the process instance whose details you want - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Process instance details - ## Details The methods work in much the same way as the equivalent methods in the diff --git a/docs/process-services/components/select-apps-dialog.component.md b/docs/process-services/components/select-apps-dialog.component.md index 6c59c463a8..138d2699b7 100644 --- a/docs/process-services/components/select-apps-dialog.component.md +++ b/docs/process-services/components/select-apps-dialog.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-14 --- -# [Select App Component](../../../lib/process-services/src/lib/app-list/select-apps-dialog-component.ts "Defined in select-apps-dialog-component.ts") +# [Select App Component](../../../lib/process-services/src/lib/app-list/select-apps-dialog.component.ts "Defined in select-apps-dialog.component.ts") Shows all available apps and returns the selected app. diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 7afaf50ebe..136133883c 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -12,6 +12,7 @@ backend services have been tested with each released version of ADF. ## Versions +- [v3.7.0](#v370) - [v3.6.0](#v360) - [v3.5.0](#v350) - [v3.4.0](#v340) @@ -30,6 +31,16 @@ backend services have been tested with each released version of ADF. ## v3.6.0 +**Release:** 2020-02-03
+ + + +No new components has been added in this release + + + +## v3.6.0 + **Release:** 2019-25-11
@@ -134,10 +145,10 @@ backend services have been tested with each released version of ADF. - [Jwt helper service](core/services/jwt-helper.service.md) - [Library dialog](content-services/dialogs/library.dialog.md) - [People cloud component](process-services-cloud/components/people-cloud.component.md) +- [Process cloud service](process-services-cloud/services/process-cloud.service.md) - [Process filter cloud service](process-services-cloud/services/process-filter-cloud.service.md) - [Process filters cloud component](process-services-cloud/components/process-filters-cloud.component.md) - [Process header cloud component](process-services-cloud/components/process-header-cloud.component.md) -- [Process header cloud service](process-services-cloud/services/process-header-cloud.service.md) - [Process list cloud component](process-services-cloud/components/process-list-cloud.component.md) - [Process list cloud service](process-services-cloud/services/process-list-cloud.service.md) - [Start process cloud component](process-services-cloud/components/start-process-cloud.component.md) diff --git a/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts b/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts index 0001c6e61d..146d634855 100644 --- a/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts @@ -38,6 +38,7 @@ export class AppsProcessCloudService { /** * Gets a list of deployed apps for this user by status. * @param status Required status value + * @param role to filter the apps * @returns The list of deployed apps */ getDeployedApplicationsByStatus(status: string, role?: string): Observable { diff --git a/lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts b/lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts index 24ed6f9bc5..60e46c4a4b 100644 --- a/lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts @@ -54,6 +54,7 @@ export class EditProcessFilterCloudComponent implements OnInit, OnChanges, OnDes @Input() appName: string = ''; + /** roles to filter the apps */ @Input() role: string = ''; @@ -295,10 +296,6 @@ export class EditProcessFilterCloudComponent implements OnInit, OnChanges, OnDes return this.getPropertyController(property).errors && this.getPropertyController(property).errors.invalid; } - /** - * Return true if both filters are same - * @param editedQuery, @param currentQuery - */ compareFilters(editedQuery: ProcessFilterCloudModel, currentQuery: ProcessFilterCloudModel): boolean { return JSON.stringify(editedQuery).toLowerCase() === JSON.stringify(currentQuery).toLowerCase(); }