inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release Note for 4.2 - Initial draft. (#6390)

Browse Source 
* Release Note for 4.2 - Initial draft.

* update dep

* documentation

* fix

* remove script

* lint

Co-authored-by: Eugenio Romano <eugenio.romano@alfresco.com>
Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
This commit is contained in:
Francesco Corti
2020-12-07 21:03:41 +00:00
committed by GitHub
co-authored by Eugenio Romano Eugenio Romano
parent 27167b3420
commit 5a4cc4edda
214 changed files with 5178 additions and 4950 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+60 -56
View File
@@ -13,11 +13,11 @@ its main source file. Note that ADF is developed continuously, so the source fil
Components are sometimes marked with an icon to show their status. No icon indicates Components are sometimes marked with an icon to show their status. No icon indicates
that the component is complete and suitable for normal use. The other status levels are: that the component is complete and suitable for normal use. The other status levels are:
- **Deprecated** ![](docassets/images/DeprecatedIcon.png) - The component is still available * **Deprecated** ![](docassets/images/DeprecatedIcon.png) - The component is still available
but is now obsolete and will probably be removed in a future version of ADF. but is now obsolete and will probably be removed in a future version of ADF.
- **Experimental** ![](docassets/images/ExperimentalIcon.png) - The component is available for * **Experimental** ![](docassets/images/ExperimentalIcon.png) - The component is available for
experimentation but not fully complete and tested for production code. experimentation but not fully complete and tested for production code.
- **Internal** ![](docassets/images/InternalIcon.png) - The component is available for * **Internal** ![](docassets/images/InternalIcon.png) - The component is available for
internal test use but not meant to be used in production internal test use but not meant to be used in production
There is also a set of ADF tutorials that describe how to accomplish tasks step-by-step. There is also a set of ADF tutorials that describe how to accomplish tasks step-by-step.
@@ -25,45 +25,45 @@ See the [Tutorials index](tutorials/README.md) for the full list.
A few other pages of information are also available: A few other pages of information are also available:
- The [Version Index](versionIndex.md) has a list of components ordered by * The [Version Index](versionIndex.md) has a list of components ordered by
the ADF version where they were introduced. the ADF version where they were introduced.
- The [Release notes](release-notes/README.md) section has details of all * The [Release notes](release-notes/README.md) section has details of all
the features introduced and bugs fixed with each release. the features introduced and bugs fixed with each release.
- The [Version compatibility](compatibility.md) page shows which versions * The [Version compatibility](compatibility.md) page shows which versions
of Alfresco's backend servies (ACS and APS) are compatible with each released of Alfresco's backend servies (ACS and APS) are compatible with each released
version of ADF. version of ADF.
- The [Roadmap](roadmap.md) * The [Roadmap](roadmap.md)
contains a preview of features we hope to release in future versions of ADF. contains a preview of features we hope to release in future versions of ADF.
- The [License info](license-info/README.md) section lists the third-party libraries used by ADF along with links to their Open Source licenses. * The [License info](license-info/README.md) section lists the third-party libraries used by ADF along with links to their Open Source licenses.
- The [Vulnerability](vulnerability/README.md) section lists the third-party * The [Vulnerability](vulnerability/README.md) section lists the third-party
libraries known vulnerability. libraries known vulnerability.
libraries used by ADF along with links to their Open Source licenses. libraries used by ADF along with links to their Open Source licenses.
- The [Breaking changes](breaking-changes/breaking-change-2.6.0-3.0.0.md) section lists * The [Breaking changes](breaking-changes/breaking-change-2.6.0-3.0.0.md) section lists
all breaking changes between major versions, such as removal of deprecated items. all breaking changes between major versions, such as removal of deprecated items.
- The [Upgrade guide](upgrade-guide/README.md) explains how to upgrade your project from an earlier version of ADF to the current version. * The [Upgrade guide](upgrade-guide/README.md) explains how to upgrade your project from an earlier version of ADF to the current version.
## Contents ## Contents
- [User Guide](#user-guide) * [User Guide](#user-guide)
- [Core API](#core-api) * [Core API](#core-api)
- [Content Services API](#content-services-api) * [Content Services API](#content-services-api)
- [Process Services API](#process-services-api) * [Process Services API](#process-services-api)
- [Process Services Cloud API](#process-services-cloud-api) * [Process Services Cloud API](#process-services-cloud-api)
- [Extensions API](#extensions-api) * [Extensions API](#extensions-api)
- [Insights API](#insights-api) * [Insights API](#insights-api)
## User guide ## User guide
<!--guide start--> <!--guide start-->
- [Angular Material Design](user-guide/angular-material-design.md) * [Angular Material Design](user-guide/angular-material-design.md)
- [Form Extensibility and Customisation](user-guide/extensibility.md) * [Form Extensibility and Customisation](user-guide/extensibility.md)
- [Internationalization in ADF](user-guide/internationalization.md) * [Internationalization in ADF](user-guide/internationalization.md)
- [Localization in ADF](user-guide/localization.md) * [Localization in ADF](user-guide/localization.md)
- [Theming](user-guide/theming.md) * [Theming](user-guide/theming.md)
- [Transclusion](user-guide/transclusion.md) * [Transclusion](user-guide/transclusion.md)
- [Typography](user-guide/typography.md) * [Typography](user-guide/typography.md)
- [Walkthrough - adding indicators to highlight information about a node](user-guide/metadata-indicators.md) * [Walkthrough - adding indicators to highlight information about a node](user-guide/metadata-indicators.md)
<!--guide end--> <!--guide end-->
@@ -81,7 +81,7 @@ for more information about installing and using the source code.
### Components ### Components
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | --- | --- | --|
| [About Application Modules Component](core/components/about-application.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which ADF libraries and plugins an application is using. | [Source](../lib/core/about/about-application-modules/about-application-modules.component.ts) | | [About Application Modules Component](core/components/about-application.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which ADF libraries and plugins an application is using. | [Source](../lib/core/about/about-application-modules/about-application-modules.component.ts) |
| [About GitHub Link Component](core/components/about-github-link.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application. | [Source](../lib/core/about/about-github-link/about-github-link.component.ts) | | [About GitHub Link Component](core/components/about-github-link.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application. | [Source](../lib/core/about/about-github-link/about-github-link.component.ts) |
| [About Product Version Component](core/components/about-product-version.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application. | [Source](../lib/core/about/about-product-version/about-product-version.component.ts) | | [About Product Version Component](core/components/about-product-version.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application. | [Source](../lib/core/about/about-product-version/about-product-version.component.ts) |
@@ -108,8 +108,8 @@ for more information about installing and using the source code.
| [Login Dialog Panel component](core/components/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/login/components/login-dialog-panel.component.ts) | | [Login Dialog Panel component](core/components/login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../lib/core/login/components/login-dialog-panel.component.ts) |
| [Login Dialog component](core/components/login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../lib/core/login/components/login-dialog.component.ts) | | [Login Dialog component](core/components/login-dialog.component.md) | Allows a user to perform a login via a dialog. | [Source](../lib/core/login/components/login-dialog.component.ts) |
| [Login component](core/components/login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | | [Login component](core/components/login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) |
| [Notification History component](core/components/notification-history.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component is in the current status just an experimental component. | | | [Notification History component](core/components/notification-history.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component is in the current status just an experimental component.
| The main purpose of the Notification history component is list all the notification received in the current session. They will disappear from the list after the refresh. | [Source](../lib/core/notifications/components/notification-history.component.ts) | | The main purpose of the Notification history component is list all the notification received in the current session. They will disappear from the list after the refresh. | [Source](../lib/core/notifications/components/notification-history.component.ts) |
| [Pagination Component](core/components/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | | [Pagination Component](core/components/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) |
| [Search Text Input Component](core/components/search-text-input.component.md) | Displays a input text that supports autocompletion | [Source](../lib/core/search-text/search-text-input.component.ts) | | [Search Text Input Component](core/components/search-text-input.component.md) | Displays a input text that supports autocompletion | [Source](../lib/core/search-text/search-text-input.component.ts) |
| [Sidebar action menu component](core/components/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) | | [Sidebar action menu component](core/components/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) |
@@ -126,7 +126,7 @@ for more information about installing and using the source code.
### Directives ### Directives
| Name | Description | Source link | | Name | Description | Source link |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | --- | --- | --|
| [Check Allowable Operation directive](core/directives/check-allowable-operation.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../lib/core/directives/check-allowable-operation.directive.ts) | | [Check Allowable Operation directive](core/directives/check-allowable-operation.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../lib/core/directives/check-allowable-operation.directive.ts) |
| [Clipboard directive](core/directives/clipboard.directive.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.directive.ts) | | [Clipboard directive](core/directives/clipboard.directive.md) | Copies text to the clipboard. | [Source](../lib/core/clipboard/clipboard.directive.ts) |
| [Context Menu directive](core/directives/context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) | | [Context Menu directive](core/directives/context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) |
@@ -142,13 +142,13 @@ for more information about installing and using the source code.
### Dialogs ### Dialogs
| Name | Description | Source link | | Name | Description | Source link |
| ---------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------- | | --- | --- | --|
| [Edit JSON Dialog](core/dialogs/edit-json.dialog.md) | Allows a user to preview or edit a JSON content in a dialog. | [Source](../lib/testing/src/lib/core/dialog/edit-json-dialog.ts) | | [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 ### Interfaces
| Name | Description | Source link | | Name | Description | Source link |
| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | --- | --- | --|
| [Card View Item interface](core/interfaces/card-view-item.interface.md) | Defines the implementation of an item in a Card View component. | [Source](../lib/core/card-view/interfaces/card-view-item.interface.ts) | | [Card View Item interface](core/interfaces/card-view-item.interface.md) | Defines the implementation of an item in a Card View component. | [Source](../lib/core/card-view/interfaces/card-view-item.interface.ts) |
| [DataTableAdapter interface](core/interfaces/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | | [DataTableAdapter interface](core/interfaces/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) |
| [FormFieldValidator interface](core/interfaces/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | | [FormFieldValidator interface](core/interfaces/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) |
@@ -157,7 +157,7 @@ for more information about installing and using the source code.
### Models ### Models
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------- | | --- | --- | --|
| [Bpm User model](core/models/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/models/bpm-user.model.ts) | | [Bpm User model](core/models/bpm-user.model.md) | Contains information about a Process Services user. | [Source](../lib/core/models/bpm-user.model.ts) |
| [Ecm User model](core/models/ecm-user.model.md) | Contains information about a Content Services user. | [Source](../lib/core/models/ecm-user.model.ts) | | [Ecm User model](core/models/ecm-user.model.md) | Contains information about a Content Services user. | [Source](../lib/core/models/ecm-user.model.ts) |
| [Form Field model](core/models/form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | | [Form Field model](core/models/form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) |
@@ -167,7 +167,7 @@ for more information about installing and using the source code.
### Pipes ### Pipes
| Name | Description | Source link | | Name | Description | Source link |
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------- | | --- | --- | --|
| [App Config Pipe](core/pipes/app-config.pipe.md) | Retrieves values from the application configuration file directly. | [Source](../lib/core/app-config/app-config.pipe.ts) | | [App Config Pipe](core/pipes/app-config.pipe.md) | Retrieves values from the application configuration file directly. | [Source](../lib/core/app-config/app-config.pipe.ts) |
| [Decimal Number Pipe](core/pipes/decimal-number.pipe.md) | Transforms a number to have a certain amount of digits in its integer part and also in its decimal part. | [Source](../lib/core/pipes/decimal-number.pipe.ts) | | [Decimal Number Pipe](core/pipes/decimal-number.pipe.md) | Transforms a number to have a certain amount of digits in its integer part and also in its decimal part. | [Source](../lib/core/pipes/decimal-number.pipe.ts) |
| [File Size pipe](core/pipes/file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../lib/core/pipes/file-size.pipe.ts) | | [File Size pipe](core/pipes/file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../lib/core/pipes/file-size.pipe.ts) |
@@ -184,7 +184,7 @@ for more information about installing and using the source code.
### Services ### Services
| Name | Description | Source link | | Name | Description | Source link |
| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | --- | --- | --|
| [APS Alfresco Content Service](core/services/activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) | | [APS Alfresco Content Service](core/services/activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) |
| [Alfresco Api Service](core/services/alfresco-api.service.md) | Provides access to an initialized AlfrescoJSApi instance. | [Source](../lib/core/services/alfresco-api.service.ts) | | [Alfresco Api Service](core/services/alfresco-api.service.md) | Provides access to an initialized AlfrescoJSApi instance. | [Source](../lib/core/services/alfresco-api.service.ts) |
| [App Config service](core/services/app-config.service.md) | Supports app configuration settings, stored server side. | [Source](../lib/core/app-config/app-config.service.ts) | | [App Config service](core/services/app-config.service.md) | Supports app configuration settings, stored server side. | [Source](../lib/core/app-config/app-config.service.ts) |
@@ -237,7 +237,7 @@ for more information about installing and using the source code.
### Widgets ### Widgets
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------------- | -------------------------- | ----------------------------------------------------------------------- | | --- | --- | --|
| [APS Content Component](core/widgets/content.widget.md) | Shows the content preview. | [Source](../lib/core/form/components/widgets/content/content.widget.ts) | | [APS Content Component](core/widgets/content.widget.md) | Shows the content preview. | [Source](../lib/core/form/components/widgets/content/content.widget.ts) |
<!--core end--> <!--core end-->
@@ -256,7 +256,7 @@ for more information about installing and using the source code.
### Components ### Components
| Name | Description | Source link | | Name | Description | Source link |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | --- | --- | --|
| [Add Permission Dialog Component](content-services/components/add-permission-dialog.component.md) | Displays a dialog to search for people or groups to add to the current node permissions. | [Source](../lib/content-services/src/lib/permission-manager/components/add-permission/add-permission-dialog.component.ts) | | [Add Permission 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 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) | | [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) |
@@ -274,7 +274,8 @@ for more information about installing and using the source code.
| [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 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 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 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 date range component](content-services/components/search-date-range.component.md) | Implements a search widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-date-range/search-date-range.component.ts) |
| [Search datetime range component](content-services/components/search-datetime-range.component.md) | Implements a search widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-datetime-range/search-datetime-range.component.ts) |
| [Search Filter component](content-services/components/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts) | | [Search 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 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 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) |
@@ -293,12 +294,13 @@ for more information about installing and using the source code.
| [Version Comparison Component](content-services/components/version-comparison.component.md) | Displays the side by side comparison between the current target node (type, name, icon) and the new file that should update it's version. | [Source](../lib/content-services/src/lib/version-manager/version-comparison.component.ts) | | [Version Comparison Component](content-services/components/version-comparison.component.md) | Displays the side by side comparison between the current target node (type, name, icon) and the new file that should update it's version. | [Source](../lib/content-services/src/lib/version-manager/version-comparison.component.ts) |
| [Version List component](content-services/components/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/src/lib/version-manager/version-list.component.ts) | | [Version List component](content-services/components/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a Version Manager component. | [Source](../lib/content-services/src/lib/version-manager/version-list.component.ts) |
| [Version Manager Component](content-services/components/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/src/lib/version-manager/version-manager.component.ts) | | [Version Manager Component](content-services/components/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/src/lib/version-manager/version-manager.component.ts) |
| [Version Upload component](content-services/components/version-upload.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the new version's minor/major changes and the optional comment of a node in a Version Manager component. | [Source](../lib/content-services/src/lib/version-manager/version-upload.component.ts) |
| [Webscript component](content-services/components/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/src/lib/webscript/webscript.component.ts) | | [Webscript component](content-services/components/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/src/lib/webscript/webscript.component.ts) |
### Directives ### Directives
| Name | Description | Source link | | Name | Description | Source link |
| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | --- | --- | --|
| [Node Public File Share Directive](content-services/directives/content-node-share.directive.md) | Creates and manages public shared links for files. | [Source](../lib/content-services/src/lib/content-node-share/content-node-share.directive.ts) | | [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) | | [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 Create directive](content-services/directives/folder-create.directive.md) | Creates folders. | [Source](../lib/content-services/src/lib/folder-directive/folder-create.directive.ts) |
@@ -310,20 +312,20 @@ for more information about installing and using the source code.
### Dialogs ### Dialogs
| Name | Description | Source link | | Name | Description | Source link |
| ---------------------------------------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------- | | --- | --- | --|
| [Confirm dialog component](content-services/dialogs/confirm.dialog.md) | Requests a yes/no choice from the user. | [Source](../lib/content-services/src/lib/dialogs/confirm.dialog.ts) | | [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) | | [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 ### Interfaces
| Name | Description | Source link | | Name | Description | Source link |
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------- | | --- | --- | --|
| [Search widget interface](content-services/interfaces/search-widget.interface.md) | Specifies required properties for Search filter component widgets. | [Source](../lib/content-services/src/lib/search/search-widget.interface.ts) | | [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 ### Models
| Name | Description | Source link | | 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) | | [Image Resolver Model](content-services/models/image-resolver.model.md) | Defines the Image Resolver function used by the Document List Component. | [Source](../lib/content-services/document-list/data/image-resolver.model.ts) |
| [Permission Style model](content-services/models/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) | | [Permission Style model](content-services/models/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) |
| [Row Filter Model](content-services/models/row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../lib/content-services/document-list/data/row-filter.model.ts) | | [Row Filter Model](content-services/models/row-filter.model.md) | Defines the Row Filter function used by the Document List Component. | [Source](../lib/content-services/document-list/data/row-filter.model.ts) |
@@ -331,13 +333,13 @@ for more information about installing and using the source code.
### Pipes ### Pipes
| Name | Description | Source link | | Name | Description | Source link |
| -------------------------------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | | --- | --- | --|
| [File upload error pipe](content-services/pipes/file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../lib/content-services/src/lib/upload/pipes/file-upload-error.pipe.ts) | | [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 ### Services
| Name | Description | Source link | | Name | Description | Source link |
| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | --- | --- | --|
| [Audit Service](content-services/services/audit.service.md) | Manages Audit apps and entries. | [Source](../lib/content-services/src/lib/audit/audit.service.ts) | | [Audit Service](content-services/services/audit.service.md) | Manages Audit apps and entries. | [Source](../lib/content-services/src/lib/audit/audit.service.ts) |
| [Content Node Dialog service](content-services/services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts) | | [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) | | [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) |
@@ -367,7 +369,7 @@ for more information about installing and using the source code.
### Components ### Components
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- | | --- | --- | --|
| [Apps List Component](process-services/components/apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/src/lib/app-list/apps-list.component.ts) | | [Apps List Component](process-services/components/apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/src/lib/app-list/apps-list.component.ts) |
| [Attach Form component](process-services/components/attach-form.component.md) | This component can be used when there is no form attached to a task and you want to add one. | [Source](../lib/process-services/src/lib/task-list/components/attach-form.component.ts) | | [Attach Form component](process-services/components/attach-form.component.md) | This component can be used when there is no form attached to a task and you want to add one. | [Source](../lib/process-services/src/lib/task-list/components/attach-form.component.ts) |
| [Checklist Component](process-services/components/checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/src/lib/task-list/components/checklist.component.ts) | | [Checklist Component](process-services/components/checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/src/lib/task-list/components/checklist.component.ts) |
@@ -399,7 +401,7 @@ for more information about installing and using the source code.
### Directives ### Directives
| Name | Description | Source link | | Name | Description | Source link |
| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | | --- | --- | --|
| [Claim Task Directive](process-services/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/claim-task.directive.ts) | | [Claim Task Directive](process-services/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/claim-task.directive.ts) |
| [Process Audit Directive](process-services/directives/process-audit.directive.md) | Fetches the Process Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/process-list/components/process-audit.directive.ts) | | [Process Audit Directive](process-services/directives/process-audit.directive.md) | Fetches the Process Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/process-list/components/process-audit.directive.ts) |
| [Task Audit Directive](process-services/directives/task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/task-list/components/task-audit.directive.ts) | | [Task Audit Directive](process-services/directives/task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/task-list/components/task-audit.directive.ts) |
@@ -408,13 +410,13 @@ for more information about installing and using the source code.
### Pipes ### Pipes
| Name | Description | Source link | | Name | Description | Source link |
| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | --- | --- | --|
| [Process name pipe](process-services/pipes/process-name.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services/src/lib/pipes/process-name.pipe.ts) | | [Process name pipe](process-services/pipes/process-name.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services/src/lib/pipes/process-name.pipe.ts) |
### Services ### Services
| Name | Description | Source link | | Name | Description | Source link |
| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | --- | --- | --|
| [Process Filter Service](process-services/services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/src/lib/process-list/services/process-filter.service.ts) | | [Process Filter Service](process-services/services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/src/lib/process-list/services/process-filter.service.ts) |
| [Process Service](process-services/services/process.service.md) | Manages process instances, process variables, and process audit Log. | [Source](../lib/process-services/src/lib/process-list/services/process.service.ts) | | [Process Service](process-services/services/process.service.md) | Manages process instances, process variables, and process audit Log. | [Source](../lib/process-services/src/lib/process-list/services/process.service.ts) |
| [Task Filter Service](process-services/services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/src/lib/task-list/services/task-filter.service.ts) | | [Task Filter Service](process-services/services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/src/lib/task-list/services/task-filter.service.ts) |
@@ -436,7 +438,7 @@ for more information about installing and using the source code.
### Components ### Components
| Name | Description | Source link | | Name | Description | Source link |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --|
| [App List Cloud Component](process-services-cloud/components/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) | | [App List Cloud Component](process-services-cloud/components/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) |
| [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows/edits process filter details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) | | [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows/edits process filter details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) |
| [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits task filter details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter-cloud.component.ts) | | [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits task filter details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter-cloud.component.ts) |
@@ -444,7 +446,9 @@ 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 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) | | [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) | | [Group Cloud component](process-services-cloud/components/group-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) |
| [People Cloud Component](process-services-cloud/components/people-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Allows one or more users to be selected (with auto-suggestion) based on the input parameters. | [Source](../lib/process-services-cloud/src/lib/people/components/people-cloud.component.ts) | | [](process-services-cloud/components/people-cloud.component.md) | Title: People Cloud Component
Added: v3.0.0
Status: Experimental | [Source]() |
| [Process Filters Cloud Component](process-services-cloud/components/process-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) | | [Process 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 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) | | [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) |
@@ -458,7 +462,7 @@ for more information about installing and using the source code.
### Directives ### Directives
| Name | Description | Source link | | 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) | | [Cancel Process Directive](process-services-cloud/directives/cancel-process.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Cancels a process | [Source](../lib/process-services-cloud/src/lib/process/directives/cancel-process.directive.ts) |
| [Claim Task Cloud Directive](process-services-cloud/directives/claim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task-cloud.directive.ts) | | [Claim Task Cloud Directive](process-services-cloud/directives/claim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task-cloud.directive.ts) |
| [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) | | [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) |
@@ -467,14 +471,14 @@ for more information about installing and using the source code.
### Pipes ### Pipes
| Name | Description | Source link | | Name | Description | Source link |
| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | --- | --- | --|
| [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | | [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) |
| [Process name cloud pipe](process-services-cloud/pipes/process-name-cloud.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services-cloud/src/lib/pipes/process-name-cloud.pipe.ts) | | [Process name cloud pipe](process-services-cloud/pipes/process-name-cloud.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services-cloud/src/lib/pipes/process-name-cloud.pipe.ts) |
### Services ### Services
| Name | Description | Source link | | 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) | | [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/process-services-cloud/src/lib/form/services/form-cloud.service.ts) |
| [Group Cloud Service](process-services-cloud/services/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | | [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) |
@@ -505,14 +509,14 @@ for more information about installing and using the source code.
### Components ### Components
| Name | Description | Source link | | Name | Description | Source link |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------------------------------------- | | --- | --- | --|
| [Dynamic Component](extensions/components/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | | [Dynamic Component](extensions/components/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) |
| [Preview Extension Component](extensions/components/preview-extension.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Supports dynamically-loaded viewer preview extensions. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) | | [Preview Extension Component](extensions/components/preview-extension.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Supports dynamically-loaded viewer preview extensions. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) |
### Services ### Services
| Name | Description | Source link | | Name | Description | Source link |
| -------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------- | | --- | --- | --|
| [Extension Service](extensions/services/extension.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages and runs basic extension functionality. | [Source](../lib/extensions/src/lib/services/extension.service.ts) | | [Extension Service](extensions/services/extension.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages and runs basic extension functionality. | [Source](../lib/extensions/src/lib/services/extension.service.ts) |
<!--extensions end--> <!--extensions end-->
@@ -531,7 +535,7 @@ for more information about installing and using the source code.
### Components ### Components
| Name | Description | Source link | | Name | Description | Source link |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | --- | --- | --|
| [Analytics Generator Component](insights/components/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/src/lib/analytics-process/components/analytics-generator.component.ts) | | [Analytics Generator Component](insights/components/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/src/lib/analytics-process/components/analytics-generator.component.ts) |
| [APS Analytics List Component](insights/components/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts) | | [APS Analytics List Component](insights/components/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts) |
| [APS Analytics Component](insights/components/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/src/lib/analytics-process/components/analytics.component.ts) | | [APS Analytics Component](insights/components/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/src/lib/analytics-process/components/analytics.component.ts) |
docs/abn-tree.yml
+4
View File
@@ -60,6 +60,7 @@
- release-notes: - release-notes:
title: 'Release notes' title: 'Release notes'
children: children:
- RelNote420.md: 'Release notes v4.2.0'
- RelNote410.md: 'Release notes v4.1.0' - RelNote410.md: 'Release notes v4.1.0'
- RelNote400.md: 'Release notes v4.0.0' - RelNote400.md: 'Release notes v4.0.0'
- RelNote390.md: 'Release notes v3.9.0' - RelNote390.md: 'Release notes v3.9.0'
@@ -87,6 +88,7 @@
- upgrade-guide: - upgrade-guide:
title: 'Upgrade Guide' title: 'Upgrade Guide'
children: children:
- upgrade40-41.md: 'From 4.1.0 to 4.2.0'
- upgrade40-41.md: 'From 4.0.0 to 4.1.0' - upgrade40-41.md: 'From 4.0.0 to 4.1.0'
- upgrade39-40.md: 'From 3.9.0 to 4.0.0' - upgrade39-40.md: 'From 3.9.0 to 4.0.0'
- upgrade37-38.md: 'From 3.7.0 to 3.8.0' - upgrade37-38.md: 'From 3.7.0 to 3.8.0'
@@ -97,6 +99,7 @@
- vulnerability: - vulnerability:
title: 'Vulnerability' title: 'Vulnerability'
children: children:
- audit-info-4.1.0.md: 'Audit for 4.2.0'
- audit-info-4.1.0.md: 'Audit for 4.1.0' - audit-info-4.1.0.md: 'Audit for 4.1.0'
- audit-info-4.0.0.md: 'Audit for 4.0.0' - audit-info-4.0.0.md: 'Audit for 4.0.0'
- audit-info-3.9.0.md: 'Audit for 3.9.0' - audit-info-3.9.0.md: 'Audit for 3.9.0'
@@ -109,6 +112,7 @@
- license-info: - license-info:
title: 'License info' title: 'License info'
children: children:
- license-info-4.1.0.md: 'License info for 4.2.0'
- license-info-4.1.0.md: 'License info for 4.1.0' - license-info-4.1.0.md: 'License info for 4.1.0'
- license-info-4.0.0.md: 'License info for 4.0.0' - license-info-4.0.0.md: 'License info for 4.0.0'
- license-info-3.9.0.md: 'License info for 3.9.0' - license-info-3.9.0.md: 'License info for 3.9.0'
docs/compatibility.md
+1
View File
@@ -21,6 +21,7 @@ You can find further information about released versions of ADF in the
| ADF version | Content Services | Process Services | | ADF version | Content Services | Process Services |
| --- | --- | --- | | --- | --- | --- |
| [4.2.0](versionIndex.md#v410) |v6.2.2 (AGS 3.3.1)|v7.1.0 M11 (latest CI pipeline build), v1.11.1|
| [4.1.0](versionIndex.md#v410) |v6.2.2 (AGS 3.3.1)|v7.1.0 M10 (latest CI pipeline build), v1.11.1| | [4.1.0](versionIndex.md#v410) |v6.2.2 (AGS 3.3.1)|v7.1.0 M10 (latest CI pipeline build), v1.11.1|
| [4.0.0](versionIndex.md#v400) |v6.2.2 (AGS 3.3.1)|v7.1.0 M9 (latest CI pipeline build), v1.11.1| | [4.0.0](versionIndex.md#v400) |v6.2.2 (AGS 3.3.1)|v7.1.0 M9 (latest CI pipeline build), v1.11.1|
| [3.9.0](versionIndex.md#v390) |v6.2.2 (AGS 3.3.1)|v7.1.0 M8 (latest CI pipeline build), v1.11.1| | [3.9.0](versionIndex.md#v390) |v6.2.2 (AGS 3.3.1)|v7.1.0 M8 (latest CI pipeline build), v1.11.1|
docs/content-services/components/add-permission-panel.component.md
+3 -3
View File
@@ -26,7 +26,7 @@ Searches for people or groups to add to the current node permissions.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------ | ----------------------------------------------------------------- | ------------------------------------------------ | | --- | --- | --- |
| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission list item is selected. | | select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission list item is selected. |
## Details ## Details
@@ -41,5 +41,5 @@ permissions to the node once the selection has been made.
## See also ## See also
- [Add permission dialog component](add-permission-dialog.component.md) * [Add permission dialog component](add-permission-dialog.component.md)
- [Add permission component](add-permission.component.md) * [Add permission component](add-permission.component.md)
docs/content-services/components/add-permission.component.md
+4 -4
View File
@@ -26,13 +26,13 @@ Searches for people or groups to add to the current node permissions.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------ | -------- | ------------- | ---------------------- | | --- | --- | --- | --- |
| nodeId | `string` | | ID of the target node. | | nodeId | `string` | | ID of the target node. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the update. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the update. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated successfully. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated successfully. |
@@ -44,5 +44,5 @@ use the [Add permission dialog component](add-permission-dialog.component.md) to
## See also ## See also
- [Add permission panel component](add-permission-panel.component.md) * [Add permission panel component](add-permission-panel.component.md)
- [Add permission dialog component](add-permission-dialog.component.md) * [Add permission dialog component](add-permission-dialog.component.md)
docs/content-services/components/breadcrumb.component.md
+4 -4
View File
@@ -24,7 +24,7 @@ Indicates the current position within a navigation hierarchy.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | --- | --- | --- | --- |
| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | | folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. |
| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | | maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. |
| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | | root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
@@ -35,7 +35,7 @@ Indicates the current position within a navigation hierarchy.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | --- | --- | --- |
| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | | navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. |
## Details ## Details
@@ -96,5 +96,5 @@ Below, the breadcrumb is shown before and after the transform function is applie
## See also ## See also
- [Document list component](document-list.component.md) * [Document list component](document-list.component.md)
- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) * [Dropdown breadcrumb component](dropdown-breadcrumb.component.md)
docs/content-services/components/content-action.component.md
+30 -30
View File
@@ -13,17 +13,17 @@ Adds options to a Document List actions menu for a particular content type.
## Contents ## Contents
- [Basic Usage](#basic-usage) * [Basic Usage](#basic-usage)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Details](#details) * [Details](#details)
- [Examples](#examples) * [Examples](#examples)
- [Conditional visibility](#conditional-visibility) * [Conditional visibility](#conditional-visibility)
- [Conditional disabled state](#conditional-disabled-state) * [Conditional disabled state](#conditional-disabled-state)
- [Customizing built-in actions](#customizing-built-in-actions) * [Customizing built-in actions](#customizing-built-in-actions)
- [Error, Permission and Success callbacks](#error-permission-and-success-callbacks) * [Error, Permission and Success callbacks](#error-permission-and-success-callbacks)
- [See also](#see-also) * [See also](#see-also)
## Basic Usage ## Basic Usage
@@ -83,7 +83,7 @@ export class MyView {
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------------------- | --------------------- | ------------- | -------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? | | disableWithNoPermission | `boolean` | | Should this action be disabled in the menu if the user doesn't have permission for it? |
| disabled | `boolean \| Function` | false | Is the menu item disabled? | | disabled | `boolean \| Function` | false | Is the menu item disabled? |
| handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". | | handler | `string` | | System actions. Can be "delete", "download", "copy" or "move". |
@@ -96,11 +96,11 @@ export class MyView {
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| --------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the action. Applies to copy and move actions. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during the action. Applies to copy and move actions. |
| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user selects the action from the menu. | | execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user selects the action from the menu. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission error occurs | | permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a permission error occurs |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | | success | `EventEmitter<any>` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. |
## Details ## Details
@@ -109,18 +109,18 @@ The document actions are rendered on a dropdown menu for each items of content.
A number of built-in actions are defined to handle common use cases: A number of built-in actions are defined to handle common use cases:
- **Download** (document) * **Download** (document)
- **lock** (document) * **lock** (document)
- **Copy** (document, folder) * **Copy** (document, folder)
- **Move** (document, folder) * **Move** (document, folder)
- **Delete** (document, folder) * **Delete** (document, folder)
You can use one of the built-in handlers by assigning its name to the `handler` property. You can use one of the built-in handlers by assigning its name to the `handler` property.
(The names are case-insensitive, so `handler="download"` and `handler="DOWNLOAD"` (The names are case-insensitive, so `handler="download"` and `handler="DOWNLOAD"`
will trigger the same action.) You can also add your own handler by implementing the will trigger the same action.) You can also add your own handler by implementing the
`execute` event. `execute` event.
Note that you can use _both_ a built-in handler and your own `execute` Note that you can use *both* a built-in handler and your own `execute`
function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](../../../lib/content-services/src/lib/document-list/models/document-library.model.ts) as its function in the same action. The `execute` function is passed a [`NodeMinimalEntry`](../../../lib/content-services/src/lib/document-list/models/document-library.model.ts) as its
parameter. For parameter. For
example, with `handler="delete"` you could use `execute` to show a message with the name, example, with `handler="delete"` you could use `execute` to show a message with the name,
@@ -322,8 +322,8 @@ allow the item being copied/moved to be the destination if it is itself a folder
The `<content-action>` component allows you to control visibility with the help of the `visible` property and supports the following scenarios: The `<content-action>` component allows you to control visibility with the help of the `visible` property and supports the following scenarios:
- direct value of `boolean` type * direct value of `boolean` type
- binding to a property of the `Function` type that evaluates condition and returns `boolean` value * binding to a property of the `Function` type that evaluates condition and returns `boolean` value
#### Using direct boolean value #### Using direct boolean value
@@ -379,8 +379,8 @@ funcName = (parameters): boolean => {
As with the `visible` property, you can control the `disabled` state with the following options: As with the `visible` property, you can control the `disabled` state with the following options:
- direct value of `boolean` type * direct value of `boolean` type
- binding to a property of the `Function` type that evaluates a condition and returns a `boolean` value * binding to a property of the `Function` type that evaluates a condition and returns a `boolean` value
#### Using direct value of boolean type #### Using direct value of boolean type
@@ -442,14 +442,14 @@ for details and examples.
You can define error, permission and success callbacks in much the same way as for the delete permission handling. You can define error, permission and success callbacks in much the same way as for the delete permission handling.
- The error handler callback gets the error object that was raised * The error handler callback gets the error object that was raised
- The success callback's only parameter is the translatable success message string (which could be shown in a snackbar, for example) * The success callback's only parameter is the translatable success message string (which could be shown in a snackbar, for example)
- The `permissionEvent` callback is the same as described above for the delete action * The `permissionEvent` callback is the same as described above for the delete action
![Copy/move document action](../../docassets/images/document-action-copymove.png) ![Copy/move document action](../../docassets/images/document-action-copymove.png)
## See also ## See also
- [Document list component](document-list.component.md) * [Document list component](document-list.component.md)
- [Document actions service](../services/document-actions.service.md) * [Document actions service](../services/document-actions.service.md)
- [Folder actions service](../services/folder-actions.service.md) * [Folder actions service](../services/folder-actions.service.md)
docs/content-services/components/content-metadata-card.component.md
+15 -15
View File
@@ -13,19 +13,19 @@ Displays and edits metadata related to a node.
## Contents ## Contents
- [Basic Usage](#basic-usage) * [Basic Usage](#basic-usage)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Details](#details) * [Details](#details)
- [Application config presets](#application-config-presets) * [Application config presets](#application-config-presets)
- [Layout oriented config](#layout-oriented-config) * [Layout oriented config](#layout-oriented-config)
- [Displaying all properties](#displaying-all-properties) * [Displaying all properties](#displaying-all-properties)
- [Making aspects and properties read only](#making-aspects-and-properties-read-only) * [Making aspects and properties read only](#making-aspects-and-properties-read-only)
- [What happens when there is a whitelisted aspect in the config but the given node doesn't relate to that aspect](#what-happens-when-there-is-a-whitelisted-aspect-in-the-config-but-the-given-node-doesnt-relate-to-that-aspect) * [What happens when there is a whitelisted aspect in the config but the given node doesn't relate to that aspect](#what-happens-when-there-is-a-whitelisted-aspect-in-the-config-but-the-given-node-doesnt-relate-to-that-aspect)
- [Multi value card properties](#multi-value-card-properties) * [Multi value card properties](#multi-value-card-properties)
- [Use chips for multi value properties](#use-chips-for-multi-value-properties) * [Use chips for multi value properties](#use-chips-for-multi-value-properties)
- [Copy to Clipboard on click](#copy-to-clipboard-on-click) * [Copy to Clipboard on click](#copy-to-clipboard-on-click)
- [Search select options (ACS 7+)](#search-select-options-acs-7) * [Search select options (ACS 7+)](#search-select-options-acs-7)
## Basic Usage ## Basic Usage
@@ -43,7 +43,7 @@ Displays and edits metadata related to a node.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------------------ | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| displayAspect | `string` | null | (optional) This flag displays desired aspect when open for the first time fields. | | displayAspect | `string` | null | (optional) This flag displays desired aspect when open for the first time fields. |
| displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. | | displayEmpty | `boolean` | false | (optional) This flag displays/hides empty metadata fields. |
| multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. | | multi | `boolean` | false | (optional) This flag allows the component to display more than one accordion at a time. |
@@ -151,7 +151,7 @@ can be "cherry picked" and grouped into an accordion drawer, along with a transl
#### Basic elements #### Basic elements
The following config will produce one accordion group named "TRANSLATABLE_TITLE_FOR_GROUP_1", The following config will produce one accordion group named "TRANSLATABLE_TITLE_FOR_GROUP\_1",
with all the properties from `custom:aspect` followed by the two properties (`exif:pixelXDimension` with all the properties from `custom:aspect` followed by the two properties (`exif:pixelXDimension`
and `exif:pixelYDimension`) from the `exif:exif` aspect and then one property (`custom:myPropertyName`) from `custom:type`: and `exif:pixelYDimension`) from the `exif:exif` aspect and then one property (`custom:myPropertyName`) from `custom:type`:
docs/content-services/components/content-node-selector-panel.component.md
+12 -11
View File
@@ -29,9 +29,9 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | --- | --- | --- | --- |
| breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | | breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
| currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. | | currentFolderId | `string` | null | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. |
| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | | dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). | | dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). |
| imageResolver | [`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. | | imageResolver | [`ImageResolver`](../../../lib/content-services/src/lib/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Image Resolver Model](image-resolver.model.md) page for more information. |
@@ -39,7 +39,7 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
| pageSize | `number` | | Number of items shown per page in the list. | | pageSize | `number` | | Number of items shown per page in the list. |
| restrictRootToCurrentFolderId | `boolean` | false | If true will restrict the search and breadcrumbs to the currentFolderId | | restrictRootToCurrentFolderId | `boolean` | false | If true will restrict the search and breadcrumbs to the currentFolderId |
| selectionMode | `"single" \| "multiple"` | "single" | Define the selection mode for document list. The allowed values are single or multiple | | selectionMode | `"single" \| "multiple"` | "single" | Define the selection mode for document list. The allowed values are single or multiple |
| where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. | | where | `string` | | Custom *where* filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. |
| excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | | 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. | | 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 | | showDropdownSiteList | `boolean` | | Toggle sites list dropdown rendering |
@@ -49,16 +49,17 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | | --- | --- | --- |
| currentFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when current folder loaded. |
| folderLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when folder loaded. |
| navigationChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the navigation changes. | | navigationChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the navigation changes. |
| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` | Emitted when the user has chosen an item. | | select | `EventEmitter<Node[]>` | Emitted when the user has chosen an item. |
| showingSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when search is running. | | showingSearch | `EventEmitter<boolean>` | Emitted when search is running. |
| siteChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the select site changes. | | siteChange | `EventEmitter<string>` | Emitted when the select site changes. |
| currentFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` | Emitted when current folder loaded. |
## Details ## Details
This component opens a _content node selector_ in its own dialog window. This behaves a lot like the This component opens a *content node selector* in its own dialog window. This behaves a lot like the
standard file open/save dialogs used by applications to choose files. Full details are given in the standard file open/save dialogs used by applications to choose files. Full details are given in the
[Content Node Selector component](content-node-selector.component.md) page (this is similar but does [Content Node Selector component](content-node-selector.component.md) page (this is similar but does
not manage the dialog window for you). Also, the not manage the dialog window for you). Also, the
@@ -74,5 +75,5 @@ example of how to use this function.
## See also ## See also
- [Content Node Selector component](content-node-selector.component.md) * [Content Node Selector component](content-node-selector.component.md)
- [Content Node Dialog service](../services/content-node-dialog.service.md) * [Content Node Dialog service](../services/content-node-dialog.service.md)
docs/content-services/components/document-list.component.md
+106 -106
View File
@@ -13,32 +13,32 @@ Displays the documents from a repository.
## Contents ## Contents
- [Basic Usage](#basic-usage) * [Basic Usage](#basic-usage)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Details](#details) * [Details](#details)
- [DOM Events](#dom-events) * [DOM Events](#dom-events)
- [Conditional visibility](#conditional-visibility) * [Conditional visibility](#conditional-visibility)
- [Card view](#card-view) * [Card view](#card-view)
- [Pagination strategy](#pagination-strategy) * [Pagination strategy](#pagination-strategy)
- [Data Sources](#data-sources) * [Data Sources](#data-sources)
- [Setting default folder](#setting-default-folder) * [Setting default folder](#setting-default-folder)
- [Calling DocumentList api directly](#calling-documentlist-api-directly) * [Calling DocumentList api directly](#calling-documentlist-api-directly)
- [Underlying node object](#underlying-node-object) * [Underlying node object](#underlying-node-object)
- [Custom columns](#custom-columns) * [Custom columns](#custom-columns)
- [Column templates](#column-templates) * [Column templates](#column-templates)
- [Date Column](#date-column) * [Date Column](#date-column)
- [Location Column](#location-column) * [Location Column](#location-column)
- [Actions](#actions) * [Actions](#actions)
- [Navigation mode](#navigation-mode) * [Navigation mode](#navigation-mode)
- [Header filters](#header-filters) * [Header filters](#header-filters)
- [Advanced usage and customization](#advanced-usage-and-customization) * [Advanced usage and customization](#advanced-usage-and-customization)
- [Image Resolver and Row Filter functions](#image-resolver-and-row-filter-functions) * [Image Resolver and Row Filter functions](#image-resolver-and-row-filter-functions)
- [Custom 'empty folder' template](#custom-empty-folder-template) * [Custom 'empty folder' template](#custom-empty-folder-template)
- [Custom 'permission denied' template](#custom-permission-denied-template) * [Custom 'permission denied' template](#custom-permission-denied-template)
- [Custom 'loading' template](#custom-loading-template) * [Custom 'loading' template](#custom-loading-template)
- [See also](#see-also) * [See also](#see-also)
## Basic Usage ## Basic Usage
@@ -56,7 +56,7 @@ Displays the documents from a repository.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| additionalSorting | [`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | | Defines default sorting. The format is an array of strings `[key direction, otherKey otherDirection]` i.e. `['name desc', 'nodeType asc']` or `['name asc']`. Set this value if you want a base rule to be added to the sorting apart from the one driven by the header. | | additionalSorting | [`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | | Defines default sorting. The format is an array of strings `[key direction, otherKey otherDirection]` i.e. `['name desc', 'nodeType asc']` or `['name asc']`. Set this value if you want a base rule to be added to the sorting apart from the one driven by the header. |
| allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list or into another file to trigger updating it's version. When false, the dropped file will be added to the current folder (ie, the one containing all the items shown in the list). See the [Upload directive](../../core/directives/upload.directive.md) for further details about how the file drop is handled. | | allowDropFiles | `boolean` | false | When true, this enables you to drop files directly into subfolders shown as items in the list or into another file to trigger updating it's version. When false, the dropped file will be added to the current folder (ie, the one containing all the items shown in the list). See the [Upload directive](../../core/directives/upload.directive.md) for further details about how the file drop is handled. |
| contentActions | `boolean` | false | Toggles content actions for each row | | contentActions | `boolean` | false | Toggles content actions for each row |
@@ -74,33 +74,33 @@ Displays the documents from a repository.
| maxItems | `number` | | Default value is stored in the user preference settings. Use this only if you are not using pagination. | | maxItems | `number` | | Default value is stored in the user preference settings. Use this only if you are not using pagination. |
| multiselect | `boolean` | false | Toggles multiselect mode | | multiselect | `boolean` | false | Toggles multiselect mode |
| navigate | `boolean` | true | Toggles navigation to folder content or file preview | | navigate | `boolean` | true | Toggles navigation to folder content or file preview |
| navigationMode | `string` | | [User](../../../lib/core/pipes/user-initial.pipe.ts) interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | | navigationMode | `string` | | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" |
| node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) | null | The Document list will show all the nodes contained in the [NodePaging](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) entity | | node | [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) | null | The Document list will show all the nodes contained in the [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md) entity |
| permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) page for further details and examples. | | permissionsStyle | [`PermissionStyleModel`](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../../lib/content-services/src/lib/document-list/models/permissions-style.model.ts) page for further details and examples. |
| preselectNodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to be pre-selected. All nodes in the array are pre-selected in multi selection mode, but only the first node is pre-selected in single selection mode. | | preselectNodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to be pre-selected. All nodes in the array are pre-selected in multi selection mode, but only the first node is pre-selected in single selection mode. |
| rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. | | 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 | | rowStyleClass | `string` | | The CSS class to apply to every row |
| selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | | selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| showHeader | `string` | ShowHeaderMode.Data | Toggles the header | | showHeader | `string` | ShowHeaderMode.Data | Toggles the header |
| sorting | `string[] \| `[`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. | | sorting | ` string[] \| `[`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts) | \['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. |
| sortingMode | `string` | "server" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. | | sortingMode | `string` | "server" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option *does not* request the server to sort the data before delivering it. |
| stickyHeader | `boolean` | false | Toggles the sticky header mode. | | stickyHeader | `boolean` | false | Toggles the sticky header mode. |
| thumbnails | `boolean` | false | Show document thumbnails rather than icons | | thumbnails | `boolean` | false | Show document thumbnails rather than icons |
| where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. | | where | `string` | | Filters the Node list using the *where* condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. |
| rowFilter | [`RowFilter`](../../../lib/content-services/src/lib/document-list/data/row-filter.model.ts) | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](row-filter.model.md) page for more information. | | rowFilter | `RowFilter` | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](row-filter.model.md) page for more information. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the API fails to get the Document List data | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the API fails to get the Document List data |
| filterSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterSearch`](../../../lib/content-services/src/lib/search/filter-search.interface.ts)`[]>` | Emitted when a filter value is selected | | filterSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterSearch`](../../../lib/content-services/src/lib/search/filter-search.interface.ts)`[]>` | Emitted when a filter value is selected |
| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes | | folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes |
| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node | | nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node |
| nodeDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node | | nodeDblClick | `EventEmitter<NodeEntityEvent>` | Emitted when the user double-clicks a list node |
| nodeSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` | Emitted when the node selection change | | nodeSelected | `EventEmitter<NodeEntry[]>` | Emitted when the node selection change |
| preview | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../../lib/content-services/src/lib/document-list/components/node.event.ts)`>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the [Viewer component](../../core/components/viewer.component.md). | | preview | `EventEmitter<NodeEntityEvent>` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the Viewer component. |
| ready | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when the Document List has loaded all items and is ready for use | | ready | `EventEmitter<NodePaging>` | Emitted when the Document List has loaded all items and is ready for use |
## Details ## Details
@@ -115,7 +115,7 @@ The Document list will automatically show special icons for : `Smart Folder`, `L
### DOM Events ### DOM Events
Below are the DOM events the DocumentList component emits. Below are the DOM events the DocumentList component emits.
All of them are _bubbling_, meaning you can handle them in any component up the parent hierarchy, even if the DocumentList is wrapped by one or more other components. All of them are *bubbling*, meaning you can handle them in any component up the parent hierarchy, even if the DocumentList is wrapped by one or more other components.
| Name | Description | | Name | Description |
| ------------- | ---------------------------------------- | | ------------- | ---------------------------------------- |
@@ -217,20 +217,20 @@ The unique identifier of the [`Node`](https://github.com/Alfresco/alfresco-js-ap
You can use one of the well-known reserved aliases: You can use one of the well-known reserved aliases:
- `-root-` * `-root-`
- `-shared-` * `-shared-`
- `-my-` * `-my-`
#### Document List aliases #### Document List aliases
The [Document List component](document-list.component.md) also provides support for the following reserved aliases: The [Document List component](document-list.component.md) also provides support for the following reserved aliases:
- `-trashcan-`, * `-trashcan-`,
- `-sharedlinks-` * `-sharedlinks-`
- `-sites-` * `-sites-`
- `-mysites-` * `-mysites-`
- `-favorites-` * `-favorites-`
- `-recent-` * `-recent-`
Note that due to the nature of the data, these sources do not support navigation. Note that due to the nature of the data, these sources do not support navigation.
You may want to handle single and double clicks yourself to perform navigation to other sources. You may want to handle single and double clicks yourself to perform navigation to other sources.
@@ -245,11 +245,11 @@ You can set the default location format using the `locationFormat` property to a
The default column layout for non-reserved views is: The default column layout for non-reserved views is:
- Icon * Icon
- Name * Name
- Size * Size
- Modified (date) * Modified (date)
- Modified by * Modified by
**Trashcan** **Trashcan**
@@ -262,12 +262,12 @@ The default column layout for non-reserved views is:
Default layout: Default layout:
- Icon * Icon
- Name * Name
- Location * Location
- Size * Size
- Deleted * Deleted
- Deleted by * Deleted by
**Shared Links** **Shared Links**
@@ -280,13 +280,13 @@ Default layout:
Default layout: Default layout:
- Icon * Icon
- Name * Name
- Location * Location
- Size * Size
- Modified * Modified
- Modified by * Modified by
- Shared by * Shared by
**Sites** **Sites**
@@ -298,9 +298,9 @@ Default layout:
Default layout: Default layout:
- Icon * Icon
- Title * Title
- Status * Status
**My Sites** **My Sites**
@@ -312,9 +312,9 @@ Default layout:
Default layout: Default layout:
- Icon * Icon
- Title * Title
- Status * Status
**Favorites** **Favorites**
@@ -327,12 +327,12 @@ Default layout:
Default layout: Default layout:
- Icon * Icon
- Name * Name
- Location * Location
- Size * Size
- Modified * Modified
- Modified by * Modified by
**Recent Files** **Recent Files**
@@ -345,9 +345,9 @@ Default layout:
Default layout: Default layout:
- Icon * Icon
- Name * Name
- Location * Location
### Setting default folder ### Setting default folder
@@ -473,7 +473,7 @@ Now you can access Document List properties or call methods directly:
console.log(documentList.currentFolderId); console.log(documentList.currentFolderId);
``` ```
**Important note**: **Important note**:\
You must not access child components any earlier in the component lifecycle than You must not access child components any earlier in the component lifecycle than
the `AfterViewInit` state. Any UI click (buttons, links, etc.) event handlers are fine but the `AfterViewInit` state. Any UI click (buttons, links, etc.) event handlers are fine but
an earlier event like `ngOnInit` is not. an earlier event like `ngOnInit` is not.
@@ -607,16 +607,16 @@ This column displays a clickable location link pointing to the parent path of th
**Important note**: **Important note**:
_For granular permissions, the Location Column may or may not render the link location_ *For granular permissions, the Location Column may or may not render the link location*
You would normally use this with custom navigation or when displaying content from sources like: You would normally use this with custom navigation or when displaying content from sources like:
- Sites * Sites
- My Sites * My Sites
- Shared Links * Shared Links
- Recent Files * Recent Files
- Favorites * Favorites
- Trashcan * Trashcan
...or any other location where the user needs to be able to navigate to the node parent ...or any other location where the user needs to be able to navigate to the node parent
folder easily. folder easily.
@@ -711,8 +711,8 @@ You can enable Header filters in your document list simply setting to true its `
The Document List has two properties that let you modify behavior with custom The Document List has two properties that let you modify behavior with custom
functions: functions:
- `imageResolver` - Specifies a function to choose image file paths for icons and thumbnails. * `imageResolver` - Specifies a function to choose image file paths for icons and thumbnails.
- `rowFilter` - Selects whether a row is shown or hidden according to its data content. * `rowFilter` - Selects whether a row is shown or hidden according to its data content.
See the [Image Resolver Model](../models/image-resolver.model.md) See the [Image Resolver Model](../models/image-resolver.model.md)
and [Row Filter Model](../models/row-filter.model.md) pages for details of how to and [Row Filter Model](../models/row-filter.model.md) pages for details of how to
@@ -782,18 +782,18 @@ This will give the following output:
## See also ## See also
- [Datatable component](../../core/components/datatable.component.md) * [Datatable component](../../core/components/datatable.component.md)
- [Data column component](../../core/components/data-column.component.md) * [Data column component](../../core/components/data-column.component.md)
- [Pagination component](../../core/components/pagination.component.md) * [Pagination component](../../core/components/pagination.component.md)
- [Infinite pagination component](../../core/components/infinite-pagination.component.md) * [Infinite pagination component](../../core/components/infinite-pagination.component.md)
- [Sites dropdown component](sites-dropdown.component.md) * [Sites dropdown component](sites-dropdown.component.md)
- [Metadata indicators](../../user-guide/metadata-indicators.md) * [Metadata indicators](../../user-guide/metadata-indicators.md)
- [Nodes api service](../../core/services/nodes-api.service.md) * [Nodes api service](../../core/services/nodes-api.service.md)
- [Breadcrumb component](breadcrumb.component.md) * [Breadcrumb component](breadcrumb.component.md)
- [Content action component](content-action.component.md) * [Content action component](content-action.component.md)
- [Content node selector component](content-node-selector.component.md) * [Content node selector component](content-node-selector.component.md)
- [Document list service](../services/document-list.service.md) * [Document list service](../services/document-list.service.md)
- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) * [Dropdown breadcrumb component](dropdown-breadcrumb.component.md)
- [Permissions style model](../models/permissions-style.model.md) * [Permissions style model](../models/permissions-style.model.md)
- [Version manager component](version-manager.component.md) * [Version manager component](version-manager.component.md)
- [Viewer component](../../core/components/viewer.component.md) * [Viewer component](../../core/components/viewer.component.md)
docs/content-services/components/dropdown-breadcrumb.component.md
+5 -5
View File
@@ -25,7 +25,7 @@ Indicates the current position within a navigation hierarchy using a dropdown me
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | --- | --- | --- | --- |
| folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. | | folderNode | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | null | Active node, builds UI based on folderNode.path.elements collection. |
| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | | maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. |
| root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | | root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. |
@@ -36,16 +36,16 @@ Indicates the current position within a navigation hierarchy using a dropdown me
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | --- | --- | --- |
| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. | | navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PathElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PathElement.md)`>` | Emitted when the user clicks on a breadcrumb. |
## Details ## Details
Although this component inherits the `maxItems` property from the [Breadcrumb component,](breadcrumb.component.md) the Although this component inherits the `maxItems` property from the [Breadcrumb component,](breadcrumb.component.md) the
"crumbs" are _always_ shown on a menu. By contrast, the [Breadcrumb component](breadcrumb.component.md) only falls back "crumbs" are *always* shown on a menu. By contrast, the [Breadcrumb component](breadcrumb.component.md) only falls back
to a menu when its maximum number of nodes is exceeded. to a menu when its maximum number of nodes is exceeded.
## See also ## See also
- [Document list component](document-list.component.md) * [Document list component](document-list.component.md)
- [Breadcrumb component](breadcrumb.component.md) * [Breadcrumb component](breadcrumb.component.md)
docs/content-services/components/file-uploading-dialog.component.md
+5 -5
View File
@@ -20,13 +20,13 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -------- | -------- | ------------- | ------------------------------------------ | | --- | --- | --- | --- |
| position | `string` | "right" | Dialog position. Can be 'left' or 'right'. | | position | `string` | "right" | Dialog position. Can be 'left' or 'right'. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ----- | ----------------------------------------------------------------- | --------------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file in the list has an error. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file in the list has an error. |
## Details ## Details
@@ -37,6 +37,6 @@ This component should be used in combination with the
## See also ## See also
- [Upload button component](upload-button.component.md) * [Upload button component](upload-button.component.md)
- [Upload drag area component](upload-drag-area.component.md) * [Upload drag area component](upload-drag-area.component.md)
- [File upload error pipe](../pipes/file-upload-error.pipe.md) * [File upload error pipe](../pipes/file-upload-error.pipe.md)
docs/content-services/components/like.component.md
+4 -4
View File
@@ -22,16 +22,16 @@ Allows a user to add "likes" to an item.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------ | -------- | ------------- | --------------------------------------- | | --- | --- | --- | --- |
| nodeId | `string` | | Identifier of a node to apply likes to. | | nodeId | `string` | | Identifier of a node to apply likes to. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---------- | ----------------------------------------------------------------- | ------------------------------------- | | --- | --- | --- |
| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. | | changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. |
## See also ## See also
- [Rating component](rating.component.md) * [Rating component](rating.component.md)
- [Rating service](../services/rating.service.md) * [Rating service](../services/rating.service.md)
docs/content-services/components/permission-list.component.md
+2 -2
View File
@@ -36,13 +36,13 @@ but you can also supply your own content:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------ | -------- | ------------- | -------------------------------------------------- | | --- | --- | --- | --- |
| nodeId | `string` | "" | ID of the node whose permissions you want to show. | | nodeId | `string` | "" | ID of the node whose permissions you want to show. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`>` | Emitted when the permission is updated. | | update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)`>` | Emitted when the permission is updated. |
docs/content-services/components/rating.component.md
+4 -4
View File
@@ -33,16 +33,16 @@ If the average is decimal number it will be rounded.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------ | -------- | ------------- | ---------------------------------------------- | | --- | --- | --- | --- |
| nodeId | `string` | | Identifier of the node to apply the rating to. | | nodeId | `string` | | Identifier of the node to apply the rating to. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---------- | ----------------------------------------------------------------- | ------------------------------------- | | --- | --- | --- |
| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. | | changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "vote" gets changed. |
## See also ## See also
- [Like component](like.component.md) * [Like component](like.component.md)
- [Rating service](../services/rating.service.md) * [Rating service](../services/rating.service.md)
docs/content-services/components/search-chip-list.component.md
+1 -1
View File
@@ -23,6 +23,6 @@ Displays search criteria as a set of "chips".
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------ | --------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------- | | --- | --- | --- | --- |
| clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. | | clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. |
| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. | | searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. |
docs/content-services/components/search-control.component.md
+3 -3
View File
@@ -41,7 +41,7 @@ You can show your own custom template when no results are found for the search:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -------------------- | --------- | ------------- | ------------------------------------------------------------------------------------------ | | --- | --- | --- | --- |
| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | | autocomplete | `boolean` | false | Toggles auto-completion of the search input field. |
| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. | | expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. |
| highlight | `boolean` | false | Toggles highlighting of the search term in the results. | | highlight | `boolean` | false | Toggles highlighting of the search term in the results. |
@@ -52,10 +52,10 @@ You can show your own custom template when no results are found for the search:
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | --- | --- | --- |
| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file item from the list of "find-as-you-type" results is selected. | | optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a file item from the list of "find-as-you-type" results is selected. |
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | | searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. |
| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | | submit | `EventEmitter<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |
## Details ## Details
docs/content-services/components/search-filter.component.md
+27 -26
View File
@@ -11,17 +11,18 @@ Represents a main container component for custom search and faceted search setti
## Contents ## Contents
- [Basic usage](#basic-usage) * [Basic usage](#basic-usage)
- [Details](#details) * [Properties](#properties)
- [Configuration](#configuration) * [Details](#details)
- [Extra fields and filter queries](#extra-fields-and-filter-queries) * [Configuration](#configuration)
- [Sorting](#sorting) * [Extra fields and filter queries](#extra-fields-and-filter-queries)
- [Categories and widgets](#categories-and-widgets) * [Sorting](#sorting)
- [Facet Fields](#facet-fields) * [Categories and widgets](#categories-and-widgets)
- [Facet Queries](#facet-queries) * [Facet Fields](#facet-fields)
- [Facet Intervals](#facet-intervals) * [Facet Queries](#facet-queries)
- [Highlight](#highlight) * [Facet Intervals](#facet-intervals)
- [See also](#see-also) * [Highlight](#highlight)
* [See also](#see-also)
## Basic usage ## Basic usage
@@ -44,9 +45,9 @@ to build and execute the query.
You may find it useful to check out the following resources for background information You may find it useful to check out the following resources for background information
before customizing the search UI: before customizing the search UI:
- [Search API](https://docs.alfresco.com/5.2/concepts/search-api.html) * [Search API](https://docs.alfresco.com/5.2/concepts/search-api.html)
- [Alfresco Full Text Search Reference](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-intro.html) * [Alfresco Full Text Search Reference](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-intro.html)
- [ACS API Explorer](https://api-explorer.alfresco.com/api-explorer/#!/search/search) * [ACS API Explorer](https://api-explorer.alfresco.com/api-explorer/#!/search/search)
### Configuration ### Configuration
@@ -172,8 +173,8 @@ Note that the entries of the `filterQueries` array are joined using the `AND` op
The Sorting configuration section consists of two blocks: The Sorting configuration section consists of two blocks:
- `options`: a list of items that users can select from * `options`: a list of items that users can select from
- `defaults`: predefined sorting to use by default * `defaults`: predefined sorting to use by default
```json ```json
{ {
@@ -488,13 +489,13 @@ then be added in each node entry response. An example partial response is shown
## See also ## See also
- [Search Query Builder service](../services/search-query-builder.service.md) * [Search Query Builder service](../services/search-query-builder.service.md)
- [Search Chip List Component](search-chip-list.component.md) * [Search Chip List Component](search-chip-list.component.md)
- [Search Sorting Picker Component](search-sorting-picker.component.md) * [Search Sorting Picker Component](search-sorting-picker.component.md)
- [Search Widget Interface](../interfaces/search-widget.interface.md) * [Search Widget Interface](../interfaces/search-widget.interface.md)
- [Search check list component](search-check-list.component.md) * [Search check list component](search-check-list.component.md)
- [Search date range component](search-date-range.component.md) * [Search date range component](search-date-range.component.md)
- [Search number range component](search-number-range.component.md) * [Search number range component](search-number-range.component.md)
- [Search radio component](search-radio.component.md) * [Search radio component](search-radio.component.md)
- [Search slider component](search-slider.component.md) * [Search slider component](search-slider.component.md)
- [Search text component](search-text.component.md) * [Search text component](search-text.component.md)
docs/content-services/components/search.component.md
+13 -13
View File
@@ -11,15 +11,15 @@ Searches items for supplied search terms.
## Contents ## Contents
- [Basic usage](#basic-usage) * [Basic usage](#basic-usage)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Details](#details) * [Details](#details)
- [Customise Search Results](#customise-search-results) * [Customise Search Results](#customise-search-results)
- [Attach an input field to the search](#attach-an-input-field-to-the-search) * [Attach an input field to the search](#attach-an-input-field-to-the-search)
- [Custom search configuration](#custom-search-configuration) * [Custom search configuration](#custom-search-configuration)
- [See Also](#see-also) * [See Also](#see-also)
## Basic usage ## Basic usage
@@ -35,7 +35,7 @@ Searches items for supplied search terms.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------- | ------------------ | ------------- | --------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| displayWith | `Function \| null` | null | Function that maps an option's value to its display value in the trigger. | | displayWith | `Function \| null` | null | Function that maps an option's value to its display value in the trigger. |
| maxResults | `number` | 20 | Maximum number of results to show in the search. | | maxResults | `number` | 20 | Maximum number of results to show in the search. |
| searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. | | searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. |
@@ -45,7 +45,7 @@ Searches items for supplied search terms.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when search results have fully loaded. | | resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when search results have fully loaded. |
@@ -160,5 +160,5 @@ customize your search.
## See Also ## See Also
- [Search configuration interface](../../core/interfaces/search-configuration.interface.md) * [Search configuration interface](../../core/interfaces/search-configuration.interface.md)
- [Search configuration service](../../core/services/search-configuration.service.md) * [Search configuration service](../../core/services/search-configuration.service.md)
docs/content-services/components/sites-dropdown.component.md
+2 -2
View File
@@ -24,7 +24,7 @@ Displays a dropdown menu to show and interact with the sites of the current user
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| hideMyFiles | `boolean` | false | Hide the "My Files" option. | | hideMyFiles | `boolean` | false | Hide the "My Files" option. |
| placeholder | `string` | | Text or a translation key to act as a placeholder. Default value is the key "DROPDOWN.PLACEHOLDER_LABEL". | | placeholder | `string` | | Text or a translation key to act as a placeholder. Default value is the key "DROPDOWN.PLACEHOLDER_LABEL". |
| relations | `string` | | Filter for the results of the sites query. Possible values are "members" and "containers". When "members" is used, the site list will be restricted to the sites that the user is a member of. | | relations | `string` | | Filter for the results of the sites query. Possible values are "members" and "containers". When "members" is used, the site list will be restricted to the sites that the user is a member of. |
@@ -34,5 +34,5 @@ Displays a dropdown menu to show and interact with the sites of the current user
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | --- | --- | --- |
| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` | Emitted when the user selects a site. When the default option is selected, an empty model is emitted. | | change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`>` | Emitted when the user selects a site. When the default option is selected, an empty model is emitted. |
docs/content-services/components/tag-actions.component.md
+3 -3
View File
@@ -24,13 +24,13 @@ Shows available actions for tags.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------ | -------- | ------------- | ------------------------- | | --- | --- | --- | --- |
| nodeId | `string` | | The identifier of a node. | | nodeId | `string` | | The identifier of a node. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---------- | ----------------------------------------------------------------- | ----------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an action is chosen. | | result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an action is chosen. |
| successAdd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is added successfully. | | successAdd | `EventEmitter<any>` | Emitted when a tag is added successfully. |
docs/content-services/components/tag-list.component.md
+2 -2
View File
@@ -16,9 +16,9 @@ Shows tags for an item.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------ | ----------------------------------------------------------------- | ------------------------------- | | --- | --- | --- |
| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. | | result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. |
## See Also ## See Also
- [Tag service](../services/tag.service.md) * [Tag service](../services/tag.service.md)
docs/content-services/components/tag-node-list.component.md
+2 -2
View File
@@ -24,12 +24,12 @@ Shows tags for a node.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---------- | --------- | ------------- | ------------------------- | | --- | --- | --- | --- |
| nodeId | `string` | | The identifier of a node. | | nodeId | `string` | | The identifier of a node. |
| showDelete | `boolean` | true | Show delete button | | showDelete | `boolean` | true | Show delete button |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | ----------------------------------------------------------------- | ------------------------------- | | --- | --- | --- |
| results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. | | results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a tag is selected. |
docs/content-services/components/tree-view.component.md
+2 -2
View File
@@ -24,12 +24,12 @@ Shows the folder and subfolders of a node as a tree view.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------ | -------- | ------------- | ---------------------------------- | | --- | --- | --- | --- |
| nodeId | `string` | | Identifier of the node to display. | | nodeId | `string` | | Identifier of the node to display. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an invalid node id is given. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an invalid node id is given. |
| nodeClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` | Emitted when a node in the tree view is clicked. | | nodeClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` | Emitted when a node in the tree view is clicked. |
docs/content-services/components/upload-button.component.md
+6 -6
View File
@@ -28,7 +28,7 @@ Activates a file upload.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | | acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | | comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | | disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
@@ -46,12 +46,12 @@ Activates a file upload.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | --- | --- | --- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | | beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | | permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. | | success | `EventEmitter<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. | | updateFileVersion | `EventEmitter<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
## Details ## Details
@@ -85,5 +85,5 @@ export class MyComponent {
## See also ## See also
- [Upload Version Button component](upload-version-button.component.md) * [Upload Version Button component](upload-version-button.component.md)
- [File upload error pipe](../pipes/file-upload-error.pipe.md) * [File upload error pipe](../pipes/file-upload-error.pipe.md)
docs/content-services/components/upload-drag-area.component.md
+19 -19
View File
@@ -11,15 +11,15 @@ Adds a drag and drop area to upload files to ACS.
## Contents ## Contents
- [Basic Usage](#basic-usage) * [Basic Usage](#basic-usage)
- [Transclusions](#transclusions) * [Transclusions](#transclusions)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Details](#details) * [Details](#details)
- [Intercepting uploads](#intercepting-uploads) * [Intercepting uploads](#intercepting-uploads)
- [Example](#example) * [Example](#example)
- [See also](#see-also) * [See also](#see-also)
## Basic Usage ## Basic Usage
@@ -60,7 +60,7 @@ as the drag/drop target:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | | acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | | comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | | disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
@@ -73,11 +73,11 @@ as the drag/drop target:
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | --- | --- | --- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | | beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. | | success | `EventEmitter<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. | | updateFileVersion | `EventEmitter<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
## Details ## Details
@@ -87,9 +87,9 @@ You can intercept the upload process using the `beginUpload` event.
The event has a type of [`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts) and provides the following APIs: The event has a type of [`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts) and provides the following APIs:
- **files**: accesses the [`FileInfo`](../../../lib/core/utils/file-utils.ts) objects that are prepared for the upload * **files**: accesses the [`FileInfo`](../../../lib/core/utils/file-utils.ts) objects that are prepared for the upload
- **pauseUpload**: pauses the upload and performs additional tasks, like showing the confirmation dialog * **pauseUpload**: pauses the upload and performs additional tasks, like showing the confirmation dialog
- **resumeUpload**: resumes the upload process * **resumeUpload**: resumes the upload process
### Example ### Example
@@ -139,6 +139,6 @@ This could be either a selection of 2 or more files, or a folder with multiple e
## See also ## See also
- [File uploading dialog component](file-uploading-dialog.component.md) * [File uploading dialog component](file-uploading-dialog.component.md)
- [Upload button component](upload-button.component.md) * [Upload button component](upload-button.component.md)
- [File upload error pipe](../pipes/file-upload-error.pipe.md) * [File upload error pipe](../pipes/file-upload-error.pipe.md)
docs/content-services/components/upload-version-button.component.md
+6 -6
View File
@@ -30,7 +30,7 @@ to enrich the features and decrease the restrictions currently applied to node v
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| acceptedFilesType | `string` | "\*" | Filter for accepted file types. | | acceptedFilesType | `string` | "\*" | Filter for accepted file types. |
| comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history | | comment | `string` | | When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history |
| disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). | | disabled | `boolean` | false | Toggles component disabled state (if there is no node permission checking). |
@@ -49,20 +49,20 @@ to enrich the features and decrease the restrictions currently applied to node v
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | --- | --- | --- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. | | beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../../lib/content-services/src/lib/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. | | permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../../lib/content-services/src/lib/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. | | success | `EventEmitter<any>` | Emitted when the file is uploaded successfully. |
| updateFileVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. | | updateFileVersion | `EventEmitter<CustomEvent<any>>` | Emitted when dropping a file over another file to update the version. |
## Details ## Details
This component extends the [Upload Button component](upload-button.component.md). The This component extends the [Upload Button component](upload-button.component.md). The
properties and events are the same except for the `node` property that specifies the node properties and events are the same except for the `node` property that specifies the node
to be versioned (this is a _required_ input parameter). However, some properties don't make to be versioned (this is a *required* input parameter). However, some properties don't make
sense when applied to the [Upload Version Button component](upload-version-button.component.md) so they are simply ignored. sense when applied to the [Upload Version Button component](upload-version-button.component.md) so they are simply ignored.
## See also ## See also
- [Upload Button component](upload-button.component.md) * [Upload Button component](upload-button.component.md)
docs/content-services/components/version-comparison.component.md
+1 -1
View File
@@ -25,6 +25,6 @@ Displays the side by side comparison between the current target node (type, name
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -------------- | -------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- | | --- | --- | --- | --- |
| newFileVersion | `File` | | New file for updating current version. | | newFileVersion | `File` | | New file for updating current version. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node. | | node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node. |
docs/content-services/components/version-list.component.md
+4 -4
View File
@@ -20,7 +20,7 @@ Displays the version history of a node in a [Version Manager component](version-
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------- | | --- | --- | --- | --- |
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | | allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| allowViewVersions | `boolean` | true | Enable/disable viewing a version of the current node. | | allowViewVersions | `boolean` | true | Enable/disable viewing a version of the current node. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. | | node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. |
@@ -30,10 +30,10 @@ Displays the version history of a node in a [Version Manager component](version-
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- | | --- | --- | --- |
| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is deleted | | deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is deleted |
| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is restored | | restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a version is restored |
| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when viewing a version | | viewVersion | `EventEmitter<string>` | Emitted when viewing a version |
## Details ## Details
@@ -48,4 +48,4 @@ If you want show readonly version list you set this component with showActions f
## See also ## See also
- [Version manager component](version-manager.component.md) * [Version manager component](version-manager.component.md)
docs/content-services/components/version-manager.component.md
+6 -6
View File
@@ -28,7 +28,7 @@ Displays the version history of a node with the ability to upload a new version.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------------------- | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | | allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| newFileVersion | `File` | | New file for updating current version. | | newFileVersion | `File` | | New file for updating current version. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node to manage version history. | | node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Target node to manage version history. |
@@ -38,11 +38,11 @@ Displays the version history of a node with the ability to upload a new version.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | | --- | --- | --- |
| uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when an cancelling during upload. | | uploadCancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when an cancelling during upload. |
| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when an error occurs during upload. | | uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when an error occurs during upload. |
| uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a file is uploaded successfully. | | uploadSuccess | `EventEmitter<Node>` | Emitted when a file is uploaded successfully. |
| viewVersion | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when viewing a version. | | viewVersion | `EventEmitter<string>` | Emitted when viewing a version. |
## Details ## Details
@@ -56,5 +56,5 @@ Each version has a context menu on the right, with the following actions.
## See also ## See also
- [Version list component](version-list.component.md) * [Version list component](version-list.component.md)
- [Document list component](document-list.component.md) * [Document list component](document-list.component.md)
docs/content-services/components/version-upload.component.md
+12 -12
View File
@@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2020-11-06 Last reviewed: 2020-11-06
--- ---
# [Version Upload component](../../../lib/content-services/src/lib/version-manager/version-upload.component.ts "Defined in version-list.component.ts") # [Version Upload component](../../../lib/content-services/src/lib/version-manager/version-upload.component.ts "Defined in version-upload.component.ts")
Displays the new version's minor/major changes and the optional comment of a node in a [Version Manager component](version-manager.component.md). Displays the new version's minor/major changes and the optional comment of a node in a [Version Manager component](version-manager.component.md).
@@ -20,21 +20,21 @@ Displays the new version's minor/major changes and the optional comment of a nod
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------- | | --- | --- | --- | --- |
| showUploadButton | `boolean` | true | Toggles showing/hiding the upload button. | | newFileVersion | `File` | | New file for updating current version. |
| showCancelButton | `boolean` | true | Toggles showing/hiding the cancel button. |
| newFileVersion | `File` | | Used to create a new version of the current node. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. | | node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | The target node. |
| showCancelButton | `boolean` | true | Toggles showing/hiding of cancel button. |
| showUploadButton | `boolean` | true | Toggles showing/hiding upload button. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | --- | --- | --- |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter) | Emitted when a new version is successfully uploaded | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an cancelling during upload. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter) | Emitted when a new version throws an error | | commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the comment is changed. |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter) | Emitted when cancelling uploading a new version | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| versionChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the type of the new version is picked (minor/major) | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the file is uploaded successfully. |
| commentChanged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the comment of the new version has changed. | | versionChanged | `EventEmitter<boolean>` | Emitted when the version is changed. |
## Details ## Details
@@ -43,4 +43,4 @@ load and displays the new node's version choice - minor/major & comment.
## See also ## See also
- [Version manager component](version-manager.component.md) * [Version manager component](version-manager.component.md)
docs/content-services/components/webscript.component.md
+10 -10
View File
@@ -11,14 +11,14 @@ Provides access to Webscript features.
## Contents ## Contents
- [Basic usage](#basic-usage) * [Basic usage](#basic-usage)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Details](#details) * [Details](#details)
- [Webscript View HTML example](#webscript-view-html-example) * [Webscript View HTML example](#webscript-view-html-example)
- [Webscript View DATATABLE example](#webscript-view-datatable-example) * [Webscript View DATATABLE example](#webscript-view-datatable-example)
- [Webscript View JSON example](#webscript-view-json-example) * [Webscript View JSON example](#webscript-view-json-example)
## Basic usage ## Basic usage
@@ -63,7 +63,7 @@ export class AppComponent {
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------- | --------- | ------------- | -------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" | | contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" |
| contextRoot | `string` | "alfresco" | Path where the application is deployed | | contextRoot | `string` | "alfresco" | Path where the application is deployed |
| scriptArgs | `any` | | Arguments to pass to the webscript. | | scriptArgs | `any` | | Arguments to pass to the webscript. |
@@ -74,7 +74,7 @@ export class AppComponent {
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. |
## Details ## Details
docs/content-services/dialogs/library.dialog.md
+3 -3
View File
@@ -26,9 +26,9 @@ Creates a new Content Services document library/site.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the new library is created successfully. The event parameter is a [SiteEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md) object with the details of the newly-created library. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the new library is created successfully. The event parameter is a SiteEntry object with the details of the newly-created library. |
## Details ## Details
@@ -39,4 +39,4 @@ section of the Content Services documentation for more information.
## See also ## See also
- [Sites dropdown component](../components/sites-dropdown.component.md) * [Sites dropdown component](../components/sites-dropdown.component.md)
docs/content-services/directives/content-node-share.directive.md
+1 -1
View File
@@ -34,7 +34,7 @@ Creates and manages public shared links for files.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| baseShareUrl | `string` | | Prefix to add to the generated link. | | baseShareUrl | `string` | | Prefix to add to the generated link. |
| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to share. | | node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to share. |
docs/content-services/directives/file-draggable.directive.md
+3 -3
View File
@@ -39,13 +39,13 @@ Some sample CSS to show the drag and drop area:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------- | --------- | ------------- | --------------------------------------------- | | --- | --- | --- | --- |
| enabled | `boolean` | true | Enables/disables drag-and-drop functionality. | | enabled | `boolean` | true | Enables/disables drag-and-drop functionality. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | --- | --- | --- |
| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<File[]>` | Emitted when one or more files are dragged and dropped onto the draggable element. | | filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<File[]>` | Emitted when one or more files are dragged and dropped onto the draggable element. |
| folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a directory is dragged and dropped onto the draggable element. | | folderEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a directory is dragged and dropped onto the draggable element. |
@@ -75,4 +75,4 @@ export class SomeComponent implements OnInit {
## See also ## See also
- [Upload Drag Area component](../components/upload-drag-area.component.md) * [Upload Drag Area component](../components/upload-drag-area.component.md)
docs/content-services/directives/folder-create.directive.md
+3 -3
View File
@@ -31,7 +31,7 @@ Creates folders.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------ | -------- | ------------- | ------------------------------------------------------------------ | | --- | --- | --- | --- |
| nodeType | `string` | "cm:folder" | Type of node to create. | | nodeType | `string` | "cm:folder" | Type of node to create. |
| parentNodeId | `string` | | Parent folder where the new folder will be located after creation. | | parentNodeId | `string` | | Parent folder where the new folder will be located after creation. |
| title | `string` | null | Title of folder creation dialog. | | title | `string` | null | Title of folder creation dialog. |
@@ -39,7 +39,7 @@ Creates folders.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder is created successfully. |
@@ -52,4 +52,4 @@ then the dialog will emit a `success` event when it closes.
## See also ## See also
- [Folder Edit directive](folder-edit.directive.md) * [Folder Edit directive](folder-edit.directive.md)
docs/content-services/directives/folder-edit.directive.md
+2 -2
View File
@@ -31,14 +31,14 @@ Allows folders to be edited.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------ | -------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------- | | --- | --- | --- | --- |
| folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. | | folder | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | Folder node to edit. |
| title | `string` | null | Title of folder edit dialog. | | title | `string` | null | Title of folder edit dialog. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs (eg, a folder with same name already exists). |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the folder has been edited successfully. |
docs/content-services/directives/inherited-button.directive.md
+2 -2
View File
@@ -23,13 +23,13 @@ Update the current node by adding/removing the inherited permissions.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------ | -------- | ------------- | --------------------------------------------------- | | --- | --- | --- | --- |
| nodeId | `string` | | ID of the node to add/remove inherited permissions. | | nodeId | `string` | | ID of the node to add/remove inherited permissions. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated. | | updated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` | Emitted when the node is updated. |
docs/content-services/directives/node-lock.directive.md
+1 -1
View File
@@ -22,7 +22,7 @@ Locks or unlocks a node.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | -------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock/unlock. | | node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock/unlock. |
## Details ## Details
docs/content-services/interfaces/search-widget.interface.md
+15 -15
View File
@@ -11,14 +11,14 @@ Specifies required properties for [Search filter component](../components/search
## Contents ## Contents
- [Basic usage](#basic-usage) * [Basic usage](#basic-usage)
- [Properties](#properties) * [Properties](#properties)
- [Details](#details) * [Details](#details)
- [Implementing a custom widget](#implementing-a-custom-widget) * [Implementing a custom widget](#implementing-a-custom-widget)
- [Reading external settings](#reading-external-settings) * [Reading external settings](#reading-external-settings)
- [Updating the final query](#updating-the-final-query) * [Updating the final query](#updating-the-final-query)
- [Registering a custom widget](#registering-a-custom-widget) * [Registering a custom widget](#registering-a-custom-widget)
- [See also](#see-also) * [See also](#see-also)
## Basic usage ## Basic usage
@@ -184,10 +184,10 @@ and pass custom attributes, if your component supports them:
## See also ## See also
- [Search filter component](../components/search-filter.component.md) * [Search filter component](../components/search-filter.component.md)
- [Search check list component](../components/search-check-list.component.md) * [Search check list component](../components/search-check-list.component.md)
- [Search date range component](../components/search-date-range.component.md) * [Search date range component](../components/search-date-range.component.md)
- [Search number range component](../components/search-number-range.component.md) * [Search number range component](../components/search-number-range.component.md)
- [Search radio component](../components/search-radio.component.md) * [Search radio component](../components/search-radio.component.md)
- [Search slider component](../components/search-slider.component.md) * [Search slider component](../components/search-slider.component.md)
- [Search text component](../components/search-text.component.md) * [Search text component](../components/search-text.component.md)
docs/content-services/services/audit.service.md
+33 -33
View File
@@ -13,44 +13,44 @@ Manages Audit apps and entries.
### Methods ### Methods
- **deleteAuditEntries**(auditApplicationId: `string`, where: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> * **deleteAuditEntries**(auditApplicationId: `string`, where: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Permanently delete audit entries for an audit application. Permanently delete audit entries for an audit application.
- _auditApplicationId:_ `string` - The identifier of an audit application. * *auditApplicationId:* `string` - The identifier of an audit application.
- _where:_ `string` - Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. * *where:* `string` - Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
- **deleteAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> * **deleteAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Permanently delete an audit entry. Permanently delete an audit entry.
- _auditApplicationId:_ `string` - The identifier of an audit application. * *auditApplicationId:* `string` - The identifier of an audit application.
- _auditEntryId:_ `string` - The identifier of an audit entry. * *auditEntryId:* `string` - The identifier of an audit entry.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
- **getAuditApp**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>`<br/> * **getAuditApp**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>`<br/>
Get audit application info. Get audit application info.
- _auditApplicationId:_ `string` - The identifier of an audit application. * *auditApplicationId:* `string` - The identifier of an audit application.
- _opts:_ `any` - (Optional) (Optional) (Optional) Options. * *opts:* `any` - (Optional) Options.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>` - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppEntry.ts)`>` -
- **getAuditApps**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>`<br/> * **getAuditApps**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>`<br/>
List audit applications. List audit applications.
- _opts:_ `any` - (Optional) (Optional) (Optional) Options. * *opts:* `any` - (Optional) Options.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>` - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditAppPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditAppPaging.ts)`>` -
- **getAuditEntries**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`<br/> * **getAuditEntries**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`<br/>
List audit entries for an audit application. List audit entries for an audit application.
- _auditApplicationId:_ `string` - The identifier of an audit application. * *auditApplicationId:* `string` - The identifier of an audit application.
- _opts:_ `any` - (Optional) (Optional) (Optional) Options. * *opts:* `any` - (Optional) Options.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` -
- **getAuditEntriesForNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`<br/> * **getAuditEntriesForNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>`<br/>
List audit entries for a node. List audit entries for a node.
- _nodeId:_ `string` - The identifier of a node. * *nodeId:* `string` - The identifier of a node.
- _opts:_ `any` - (Optional) (Optional) (Optional) Options. * *opts:* `any` - (Optional) Options.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryPaging.ts)`>` -
- **getAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>`<br/> * **getAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>`<br/>
Get audit entry. Get audit entry.
- _auditApplicationId:_ `string` - The identifier of an audit application. * *auditApplicationId:* `string` - The identifier of an audit application.
- _auditEntryId:_ `string` - The identifier of an audit entry. * *auditEntryId:* `string` - The identifier of an audit entry.
- _opts:_ `any` - (Optional) (Optional) (Optional) Options. * *opts:* `any` - (Optional) Options.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>` - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditEntryEntry`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditEntryEntry.ts)`>` -
- **updateAuditApp**(auditApplicationId: `string`, auditAppBodyUpdate: `boolean`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>`<br/> * **updateAuditApp**(auditApplicationId: `string`, auditAppBodyUpdate: `boolean`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>`<br/>
Update audit application info. Update audit application info.
- _auditApplicationId:_ `string` - The identifier of an audit application. * *auditApplicationId:* `string` - The identifier of an audit application.
- _auditAppBodyUpdate:_ `boolean` - The audit application to update. * *auditAppBodyUpdate:* `boolean` - The audit application to update.
- _opts:_ `any` - (Optional) (Optional) (Optional) Options. * *opts:* `any` - (Optional) Options.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>` - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AuditApp`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/auditApp.ts)`|Function>` -
docs/content-services/services/content-node-dialog.service.md
+37 -37
View File
@@ -13,52 +13,52 @@ Displays and manages dialogs for selecting content to open, copy or upload.
### Methods ### Methods
- **close**()<br/> * **close**()<br/>
Closes the currently open dialog. Closes the currently open dialog.
- **getTitleTranslation**(action: `string`, name: `string`): `string`<br/> * **getTitleTranslation**(action: `string`, name: `string`): `string`<br/>
Gets the translation of the dialog title. Gets the translation of the dialog title.
- _action:_ `string` - Name of the action to display in the dialog title * *action:* `string` - Name of the action to display in the dialog title
- _name:_ `string` - Name of the item on which the action is being performed * *name:* `string` - Name of the item on which the action is being performed
- **Returns** `string` - Translated version of the title * **Returns** `string` - Translated version of the title
- **openCopyMoveDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/> * **openCopyMoveDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a dialog to copy or move an item to a new location. Opens a dialog to copy or move an item to a new location.
- _action:_ `string` - Name of the action (eg, "Copy" or "Move") to show in the title * *action:* `string` - Name of the action (eg, "Copy" or "Move") to show in the title
- _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to be copied or moved * *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to be copied or moved
- _permission:_ `string` - (Optional) Permission for the operation * *permission:* `string` - (Optional) Permission for the operation
- _excludeSiteContent:_ `string[]` - (Optional) The site content that should be filtered out * *excludeSiteContent:* `string[]` - (Optional) The site content that should be filtered out
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about files that were copied/moved * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about files that were copied/moved
- **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/> * **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a file browser at a default myFile location. shows files and folders in the dialog search result. Opens a file browser at a default myFile location. shows files and folders in the dialog search result.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
- **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/> * **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a file browser at a chosen folder location. shows files and folders in the dialog search result. Opens a file browser at a chosen folder location. shows files and folders in the dialog search result.
- _folderNodeId:_ `string` - ID of the folder to use * *folderNodeId:* `string` - ID of the folder to use
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
- **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/> * **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a file browser at a chosen site location. shows files and folders in the dialog search result. Opens a file browser at a chosen site location. shows files and folders in the dialog search result.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s) * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
- **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/> * **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a folder browser at a chosen folder location. Opens a folder browser at a chosen folder location.
- _folderNodeId:_ `string` - ID of the folder to use * *folderNodeId:* `string` - ID of the folder to use
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s) * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s)
- **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/> * **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a folder browser at a chosen site location. Opens a folder browser at a chosen site location.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s) * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s)
- **openLockNodeDialog**(contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Subject`](http://reactivex.io/documentation/subject.html)`<string>`<br/> * **openLockNodeDialog**(contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Subject`](http://reactivex.io/documentation/subject.html)`<string>`<br/>
Opens a lock node dialog. Opens a lock node dialog.
- _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock * *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock
- **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`<string>` - Error/status message (if any) * **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`<string>` - Error/status message (if any)
- **openUploadFileDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), showFilesInResult: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/> * **openUploadFileDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), showFilesInResult: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a dialog to choose a file to upload. Opens a dialog to choose a file to upload.
- _action:_ `string` - Name of the action to show in the title * *action:* `string` - Name of the action to show in the title
- _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload * *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload
- _showFilesInResult:_ `boolean` - Show files in dialog search result * *showFilesInResult:* `boolean` - Show files in dialog search result
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen file(s) * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen file(s)
- **openUploadFolderDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/> * **openUploadFolderDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
Opens a dialog to choose folders to upload. Opens a dialog to choose folders to upload.
- _action:_ `string` - Name of the action to show in the title * *action:* `string` - Name of the action to show in the title
- _contentEntry:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload * *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen folder(s) * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen folder(s)
## Details ## Details
@@ -89,5 +89,5 @@ dialog operation, say) or be set to one of the well-known names "-my-" , "-share
## See Also ## See Also
- [Content node selector panel component](../components/content-node-selector-panel.component.md) * [Content node selector panel component](../components/content-node-selector-panel.component.md)
- [Content node selector component](../components/content-node-selector.component.md) * [Content node selector component](../components/content-node-selector.component.md)
docs/content-services/services/custom-resources.service.md
+51 -51
View File
@@ -13,68 +13,68 @@ Manages Document List information that is specific to a user.
### Methods ### Methods
- **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/> * **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
Gets the contents of one of the well-known aliases in the form of node ID strings. 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 * *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)`<string[]>` - List of node IDs * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - List of node IDs
- **getIdFromEntry**(node: `any`, nodeId: `string`): `string`<br/> * **getIdFromEntry**(node: `any`, nodeId: `string`): `string`<br/>
Chooses the correct ID for a node entry. Chooses the correct ID for a node entry.
- _node:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) object * *node:* `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) object
- _nodeId:_ `string` - ID of the node object * *nodeId:* `string` - ID of the node object
- **Returns** `string` - ID value * **Returns** `string` - ID value
- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/> * **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets files recently accessed by a user. Gets files recently accessed by a user.
- _personId:_ `string` - ID of the user * *personId:* `string` - ID of the 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
- _filters:_ `string[]` - (Optional) Specifies additional filters to apply (joined with **AND**) * *filters:* `string[]` - (Optional) Specifies additional filters to apply (joined with **AND**)
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes for the recently used files * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes for the recently used files
- **hasCorrespondingNodeIds**(nodeId: `string`): `boolean`<br/> * **hasCorrespondingNodeIds**(nodeId: `string`): `boolean`<br/>
Does the well-known alias have a corresponding node ID? Does the well-known alias have a corresponding node ID?
- _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check * *nodeId:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to check
- **Returns** `boolean` - True if the alias has a corresponding node ID, false otherwise * **Returns** `boolean` - True if the alias has a corresponding node ID, false otherwise
- **isCustomSource**(folderId: `string`): `boolean`<br/> * **isCustomSource**(folderId: `string`): `boolean`<br/>
Is the folder ID one of the well-known aliases? Is the folder ID one of the well-known aliases?
- _folderId:_ `string` - Folder ID name to check * *folderId:* `string` - Folder ID name to check
- **Returns** `boolean` - True if the ID is a well-known name, false otherwise * **Returns** `boolean` - True if the ID is a well-known name, false otherwise
- **isSupportedSource**(folderId: `string`): `boolean`<br/> * **isSupportedSource**(folderId: `string`): `boolean`<br/>
Is the folder ID a "-my", "-root-", or "-shared-" alias? Is the folder ID a "-my", "-root-", or "-shared-" alias?
- _folderId:_ `string` - Folder ID name to check * *folderId:* `string` - Folder ID name to check
- **Returns** `boolean` - True if the ID is one of the supported sources, false otherwise * **Returns** `boolean` - True if the ID is one of the supported sources, false otherwise
- **loadFavorites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/> * **loadFavorites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets favorite files for the current user. 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 * *includeFields:* `string[]` - List of data field names to include in the results
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate * *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorite files * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorite files
- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): `any`<br/> * **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): `any`<br/>
Gets a folder's contents. Gets a folder's contents.
- _nodeId:_ `string` - ID of the target folder node * *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 * *includeFields:* `string[]` - List of data field names to include in the results
- _where:_ `string` - (Optional) Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. * *where:* `string` - (Optional) Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) list using the *where* condition of the REST API (for example, isFolder=true). See the REST API documentation for more information.
- **Returns** `any` - List of items contained in the folder * **Returns** `any` - List of items contained in the folder
- **loadMemberSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`<br/> * **loadMemberSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`<br/>
Gets sites that the current user is a member of. Gets sites that the current user is a member of.
- _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
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate * *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - List of sites * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - List of sites
- **loadSharedLinks**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>`<br/> * **loadSharedLinks**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>`<br/>
Gets shared links for the current user. 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 * *includeFields:* `string[]` - List of data field names to include in the results
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate * *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>` - List of shared links * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>` - List of shared links
- **loadSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/> * **loadSites**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets all sites in the repository. Gets all sites in the repository.
- _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
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate * *where:* `string` - (Optional) A string to restrict the returned objects by using a predicate
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of sites * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of sites
- **loadTrashcan**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`<br/> * **loadTrashcan**(pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`<br/>
Gets all items currently in the trash. 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 * *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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>` - List of deleted items
## Details ## Details
@@ -85,4 +85,4 @@ for further details of the returned data and the available fields.
## See also ## See also
- [Document List component](../components/document-list.component.md) * [Document List component](../components/document-list.component.md)
docs/content-services/services/document-actions.service.md
+12 -12
View File
@@ -13,19 +13,19 @@ Implements the document menu actions for the [Document List component](../compon
### Methods ### Methods
- **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/> * **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/>
Checks if actions can be executed for an item. Checks if actions can be executed for an item.
- _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to receive an action * *nodeEntry:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to receive an action
- **Returns** `boolean` - True if the action can be executed on this item, false otherwise * **Returns** `boolean` - True if the action can be executed on this item, false otherwise
- **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)<br/> * **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)<br/>
Gets the handler for an action. Gets the handler for an action.
- _key:_ `string` - Identifier of the action * *key:* `string` - Identifier of the action
- **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler for the action * **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler for the action
- **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`<br/> * **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`<br/>
Sets a new handler for an action. Sets a new handler for an action.
- _key:_ `string` - Identifier of the action * *key:* `string` - Identifier of the action
- _handler:_ [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - Handler for the action * *handler:* [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - Handler for the action
- **Returns** `boolean` - False if the key was an empty/null string, true otherwise * **Returns** `boolean` - False if the key was an empty/null string, true otherwise
## Details ## Details
@@ -99,5 +99,5 @@ with a custom [application service](../../../lib/testing/src/lib/core/actions/AP
## See also ## See also
- [Content action component](../components/content-action.component.md) * [Content action component](../components/content-action.component.md)
- [Folder actions service](folder-actions.service.md) * [Folder actions service](folder-actions.service.md)
docs/content-services/services/document-list.service.md
+35 -35
View File
@@ -13,48 +13,48 @@ Implements node operations used by the [Document List component](../components/d
### Methods ### Methods
- **copyNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/> * **copyNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
Copy a node to destination node Copy a node to destination node
- _nodeId:_ `string` - The id of the node to be copied * *nodeId:* `string` - The id of the node to be copied
- _targetParentId:_ `string` - The id of the folder where the node will be copied * *targetParentId:* `string` - The id of the folder where the node will be copied
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the copied node * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the copied node
- **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> * **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Deletes a node. Deletes a node.
- _nodeId:_ `string` - ID of the node to delete * *nodeId:* `string` - ID of the node to delete
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the operation is complete * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the operation is complete
- **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/> * **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets the folder node with the specified relative name path below the root node. Gets the folder node with the specified relative name path below the root node.
- _folder:_ `string` - Path to folder. * *folder:* `string` - Path to folder.
- _opts:_ `any` - (Optional) Options. * *opts:* `any` - (Optional) Options.
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") * *includeFields:* `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - Details of the folder * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - Details of the folder
- **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/> * **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
Gets a folder node via its node ID. Gets a folder node via its node ID.
- _nodeId:_ `string` - ID of the folder node * *nodeId:* `string` - ID of the folder node
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") * *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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
- **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/> * **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
Gets a node via its node ID. Gets a node via its node ID.
- _nodeId:_ `string` - ID of the target node * *nodeId:* `string` - ID of the target node
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") * *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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
- **isCustomSourceService**(nodeId: `any`): `boolean`<br/> * **isCustomSourceService**(nodeId: `any`): `boolean`<br/>
- _nodeId:_ `any` - * *nodeId:* `any` -
- **Returns** `boolean` - * **Returns** `boolean` -
- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`, orderBy?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`<br/> * **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`, orderBy?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>`<br/>
Load a folder by Node Id. Load a folder by Node Id.
- _nodeId:_ `string` - ID of the folder node * *nodeId:* `string` - ID of the folder node
- _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts) - * *pagination:* [`PaginationModel`](../../../lib/core/models/pagination.model.ts) -
- _includeFields:_ `string[]` - List of data field names to include in the results * *includeFields:* `string[]` - List of data field names to include in the results
- _where:_ `string` - (Optional) Optionally filter the list * *where:* `string` - (Optional) Optionally filter the list
- _orderBy:_ `string[]` - (Optional) order by node property * *orderBy:* `string[]` - (Optional) order by node property
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>` - Details of the folder * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/src/lib/document-list/models/document-folder.model.ts)`>` - Details of the folder
- **moveNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/> * **moveNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
Moves a node to destination node. Moves a node to destination node.
- _nodeId:_ `string` - The id of the node to be moved * *nodeId:* `string` - The id of the node to be moved
- _targetParentId:_ `string` - The id of the folder where the node will be moved * *targetParentId:* `string` - The id of the folder where the node will be moved
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the moved node * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the moved node
## Details ## Details
@@ -94,4 +94,4 @@ values via their string equivalents.
## See also ## See also
- [Document list component](../components/document-list.component.md) * [Document list component](../components/document-list.component.md)
docs/content-services/services/folder-actions.service.md
+12 -12
View File
@@ -13,19 +13,19 @@ Implements the folder menu actions for the [Document List component](../componen
### Methods ### Methods
- **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/> * **canExecuteAction**(nodeEntry: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `boolean`<br/>
Checks if an action is available for a particular item. Checks if an action is available for a particular item.
- _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to check * *nodeEntry:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Item to check
- **Returns** `boolean` - True if the action is available, false otherwise * **Returns** `boolean` - True if the action is available, false otherwise
- **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)<br/> * **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)<br/>
Gets the handler function for an action. Gets the handler function for an action.
- _key:_ `string` - Identifier for the action * *key:* `string` - Identifier for the action
- **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler function * **Returns** [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The handler function
- **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`<br/> * **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts)): `boolean`<br/>
Sets a new handler function for an action. Sets a new handler function for an action.
- _key:_ `string` - Identifier for the action * *key:* `string` - Identifier for the action
- _handler:_ [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The new handler function * *handler:* [`ContentActionHandler`](../../../lib/content-services/src/lib/document-list/models/content-action.model.ts) - The new handler function
- **Returns** `boolean` - True if the key was a valid action identifier, false otherwise * **Returns** `boolean` - True if the key was a valid action identifier, false otherwise
## Details ## Details
@@ -99,5 +99,5 @@ with a custom [application service](../../../lib/testing/src/lib/core/actions/AP
## See also ## See also
- [Document actions service](document-actions.service.md) * [Document actions service](document-actions.service.md)
- [Content action component](../components/content-action.component.md) * [Content action component](../components/content-action.component.md)
docs/content-services/services/node-permission-dialog.service.md
+11 -11
View File
@@ -13,18 +13,18 @@ Displays dialogs to let the user set node permissions.
### Methods ### Methods
- **close**()<br/> * **close**()<br/>
Closes the currently-open dialog. Closes the currently-open dialog.
- **openAddPermissionDialog**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>`<br/> * **openAddPermissionDialog**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>`<br/>
Opens a dialog to add permissions to a node. Opens a dialog to add permissions to a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node
- _title:_ `string` - (Optional) Dialog title * *title:* `string` - (Optional) Dialog title
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` - Node with updated permissions * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]>` - Node with updated permissions
- **updateNodePermissionByDialog**(nodeId?: `string`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/> * **updateNodePermissionByDialog**(nodeId?: `string`, title?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
Opens a dialog to update permissions for a node. Opens a dialog to update permissions for a node.
- _nodeId:_ `string` - (Optional) ID of the target node * *nodeId:* `string` - (Optional) ID of the target node
- _title:_ `string` - (Optional) Dialog title * *title:* `string` - (Optional) Dialog title
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
## Details ## Details
@@ -33,5 +33,5 @@ interface for updating permissions.
## See also ## See also
- [Node Permission service](node-permission.service.md) * [Node Permission service](node-permission.service.md)
- [Add Permission Dialog component](../components/add-permission-dialog.component.md) * [Add Permission Dialog component](../components/add-permission-dialog.component.md)
docs/content-services/services/node-permission.service.md
+25 -25
View File
@@ -13,36 +13,36 @@ Manages role permissions for content nodes.
### Methods ### Methods
- **getGroupMemberByGroupName**(groupName: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>`<br/> * **getGroupMemberByGroupName**(groupName: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>`<br/>
Gets all members related to a group name. Gets all members related to a group name.
- _groupName:_ `string` - Name of group to look for members * *groupName:* `string` - Name of group to look for members
- _opts:_ `any` - (Optional) Extra options supported by JS-API * *opts:* `any` - (Optional) Extra options supported by JS-API
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>` - List of members * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/GroupMemberPaging.md)`>` - List of members
- **getNodeRoles**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/> * **getNodeRoles**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
Gets a list of roles for the current node. Gets a list of roles for the current node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - The target node * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - The target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Array of strings representing the roles * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Array of strings representing the roles
- **removePermission**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permissionToRemove: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/> * **removePermission**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permissionToRemove: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
Removes a permission setting from a node. Removes a permission setting from a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node
- _permissionToRemove:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission setting to remove * *permissionToRemove:* [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission setting to remove
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with modified permissions * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with modified permissions
- **updateLocallySetPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), nodes: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/> * **updateLocallySetPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), nodes: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
Updates the locally set permissions for a node. Updates the locally set permissions for a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - ID of the target node
- _nodes:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - Permission settings * *nodes:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - Permission settings
- _nodeRole:_ `string[]` - Permission role * *nodeRole:* `string[]` - Permission role
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
- **updateNodePermissions**(nodeId: `string`, permissionList: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/> * **updateNodePermissions**(nodeId: `string`, permissionList: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
Update permissions for a node. Update permissions for a node.
- _nodeId:_ `string` - ID of the target node * *nodeId:* `string` - ID of the target node
- _permissionList:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - New permission settings * *permissionList:* [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` - New permission settings
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permissions
- **updatePermissionRole**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), updatedPermissionRole: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/> * **updatePermissionRole**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), updatedPermissionRole: [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>`<br/>
Updates the permission role for a node. Updates the permission role for a node.
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Target node * *node:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Target node
- _updatedPermissionRole:_ [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission role to update or add * *updatedPermissionRole:* [`PermissionElement`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/PermissionElement.md) - Permission role to update or add
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permission * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`>` - Node with updated permission
## Details ## Details
@@ -56,4 +56,4 @@ based on.
## See also ## See also
- [Permission list component](../components/permission-list.component.md) * [Permission list component](../components/permission-list.component.md)
docs/content-services/services/rating.service.md
+15 -15
View File
@@ -13,22 +13,22 @@ Manages ratings for items in Content Services.
### Methods ### Methods
- **deleteRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> * **deleteRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Removes the current user's rating for a node. Removes the current user's rating for a node.
- _nodeId:_ `string` - Target node * *nodeId:* `string` - Target node
- _ratingType:_ `any` - Type of rating to remove (can be "likes" or "fiveStar") * *ratingType:* `any` - Type of rating to remove (can be "likes" or "fiveStar")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null response indicating that the operation is complete * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null response indicating that the operation is complete
- **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`<br/> * **getRating**(nodeId: `string`, ratingType: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`<br/>
Gets the current user's rating for a node. Gets the current user's rating for a node.
- _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to get the rating from * *nodeId:* `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to get the rating from
- _ratingType:_ `any` - Type of rating (can be "likes" or "fiveStar") * *ratingType:* `any` - Type of rating (can be "likes" or "fiveStar")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - The rating value * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - The rating value
- **postRating**(nodeId: `string`, ratingType: `string`, vote: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`<br/> * **postRating**(nodeId: `string`, ratingType: `string`, vote: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>`<br/>
Adds the current user's rating for a node. Adds the current user's rating for a node.
- _nodeId:_ `string` - Target node for the rating * *nodeId:* `string` - Target node for the rating
- _ratingType:_ `string` - Type of rating (can be "likes" or "fiveStar") * *ratingType:* `string` - Type of rating (can be "likes" or "fiveStar")
- _vote:_ `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar") * *vote:* `any` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - Details about the rating, including the new value * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`RatingEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/RatingEntry.md)`|Function>` - Details about the rating, including the new value
## Details ## Details
@@ -44,5 +44,5 @@ REST API that this service is based on.
## See also ## See also
- [Like component](../components/like.component.md) * [Like component](../components/like.component.md)
- [Rating component](../components/rating.component.md) * [Rating component](../components/rating.component.md)
docs/content-services/services/search-query-builder.service.md
+78 -53
View File
@@ -13,66 +13,91 @@ Stores information from all the custom search and faceted search widgets, compil
### Methods ### Methods
- **addFilterQuery**(query: `string`)<br/> * **addFilterQuery**(query: `string`)<br/>
Adds a filter query to the current query. Adds a filter query to the current query.
- _query:_ `string` - Query string to add * *query:* `string` - Query string to add
- **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
* **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
Adds a facet bucket to a field. Adds a facet bucket to a field.
- _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field * *field:* [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field
- _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to add * *bucket:* [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to add
- **buildQuery**(): `QueryBody`<br/>
* **buildQuery**(): `QueryBody`<br/>
Builds the current query. Builds the current query.
- **Returns** `QueryBody` - The finished query * **Returns** `QueryBody` - The finished query
- **execute**(queryBody?: `QueryBody`)<br/>
* **execute**(queryBody?: `QueryBody`)<br/>
Builds and executes the current query. Builds and executes the current query.
- _queryBody:_ `QueryBody` - (Optional) (Optional) * *queryBody:* `QueryBody` - (Optional)
- **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)<br/>
* **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)<br/>
Gets a facet field by label. Gets a facet field by label.
- _label:_ `string` - Label of the facet field * *label:* `string` - Label of the facet field
- **Returns** [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - Facet field data * **Returns** [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - Facet field data
- **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts)<br/>
* **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts)<br/>
Gets a facet query by label. Gets a facet query by label.
- _label:_ `string` - Label of the query * *label:* `string` - Label of the query
- **Returns** [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts) - Facet query data * **Returns** [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts) - Facet query data
- **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)<br/>
* **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)<br/>
Gets the primary sorting definition. Gets the primary sorting definition.
- **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts) - The primary sorting definition * **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts) - The primary sorting definition
- **getQueryGroup**(query: `any`): `any`<br/>
* **getQueryGroup**(query: `any`): `any`<br/>
Gets the query group. Gets the query group.
- _query:_ `any` - Target query * *query:* `any` - Target query
- **Returns** `any` - Query group * **Returns** `any` - Query group
- **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]`<br/>
* **getScope**(): [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts)<br/>
* **Returns** [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts) -
* **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]`<br/>
Gets all pre-configured sorting options that users can choose from. Gets all pre-configured sorting options that users can choose from.
- **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options * **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
- **getSupportedLabel**(configLabel: `string`): `string`<br/>
* **getSupportedLabel**(configLabel: `string`): `string`<br/>
Encloses a label name with double quotes if it contains whitespace characters. Encloses a label name with double quotes if it contains whitespace characters.
- _configLabel:_ `string` - Original label text * *configLabel:* `string` - Original label text
- **Returns** `string` - Label, possibly with quotes if it contains spaces * **Returns** `string` - Label, possibly with quotes if it contains spaces
- **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]`<br/>
* **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]`<br/>
Gets the buckets currently added to a field Gets the buckets currently added to a field
- _field:_ `string` - The target fields * *field:* `string` - The target fields
- **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array * **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array
- **isFilterServiceActive**(): `boolean`<br/>
- **Returns** `boolean` - * **isFilterServiceActive**(): `boolean`<br/>
- **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)<br/>
- **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) - * **Returns** `boolean` -
- **removeFilterQuery**(query: `string`)<br/>
* **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)<br/>
* **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) -
* **removeFilterQuery**(query: `string`)<br/>
Removes an existing filter query. Removes an existing filter query.
- _query:_ `string` - The query to remove * *query:* `string` - The query to remove
- **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
Removes an existing bucket from a field.
- _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field
- _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to remove
- **resetToDefaults**()<br/>
- **search**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`<br/>
- _queryBody:_ `QueryBody` - * **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - Removes an existing bucket from a field.
- **update**(queryBody?: `QueryBody`)<br/> * *field:* [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field
* *bucket:* [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to remove
* **resetToDefaults**()<br/>
* **search**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`<br/>
* *queryBody:* `QueryBody` -
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` -
* **setScope**(scope: [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts))<br/>
* *scope:* [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts) -
* **update**(queryBody?: `QueryBody`)<br/>
Builds the current query and triggers the `updated` event. Builds the current query and triggers the `updated` event.
- _queryBody:_ `QueryBody` - (Optional) (Optional) * *queryBody:* `QueryBody` - (Optional)
## Details ## Details
@@ -84,13 +109,13 @@ You can reuse it with multiple component implementations.
You can use custom widgets to populate and edit the following parts of the resulting query: You can use custom widgets to populate and edit the following parts of the resulting query:
- categories * categories
- query fragments that form a query expression * query fragments that form a query expression
- include fields * include fields
- scope settings * scope settings
- filter queries * filter queries
- facet fields * facet fields
- range queries * range queries
```ts ```ts
constructor(queryBuilder: SearchQueryBuilderService) { constructor(queryBuilder: SearchQueryBuilderService) {
@@ -110,5 +135,5 @@ constructor(queryBuilder: SearchQueryBuilderService) {
## See also ## See also
- [Search filter component](../components/search-filter.component.md) * [Search filter component](../components/search-filter.component.md)
- [Search Widget interface](../interfaces/search-widget.interface.md) * [Search Widget interface](../interfaces/search-widget.interface.md)
docs/content-services/services/tag.service.md
+15 -15
View File
@@ -13,24 +13,24 @@ Manages tags in Content Services.
### Methods ### Methods
- **addTag**(nodeId: `string`, tagName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`<br/> * **addTag**(nodeId: `string`, tagName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`<br/>
Adds a tag to a node. Adds a tag to a node.
- _nodeId:_ `string` - ID of the target node * *nodeId:* `string` - ID of the target node
- _tagName:_ `string` - Name of the tag to add * *tagName:* `string` - Name of the tag to add
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - TagEntry object (defined in JS-API) with details of the new tag * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - TagEntry object (defined in JS-API) with details of the new tag
- **getAllTheTags**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/> * **getAllTheTags**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/>
Gets a list of all the tags already defined in the repository. Gets a list of all the tags already defined in the repository.
- _opts:_ `any` - (Optional) Options supported by JS-API * *opts:* `any` - (Optional) Options supported by JS-API
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags
- **getTagsByNodeId**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/> * **getTagsByNodeId**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`<br/>
Gets a list of tags added to a node. Gets a list of tags added to a node.
- _nodeId:_ `string` - ID of the target node * *nodeId:* `string` - ID of the target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags
- **removeTag**(nodeId: `string`, tag: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> * **removeTag**(nodeId: `string`, tag: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Removes a tag from a node. Removes a tag from a node.
- _nodeId:_ `string` - ID of the target node * *nodeId:* `string` - ID of the target node
- _tag:_ `string` - Name of the tag to remove * *tag:* `string` - Name of the tag to remove
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null object when the operation completes * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Null object when the operation completes
## Details ## Details
@@ -53,4 +53,4 @@ based on.
## See also ## See also
- [Tag list component](../components/tag-list.component.md) * [Tag list component](../components/tag-list.component.md)
docs/core/components/card-view.component.md
+17 -17
View File
@@ -107,7 +107,7 @@ Defining properties from Typescript:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------------------------- | ---------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------ | | --- | --- | --- | --- |
| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. | | copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
| displayClearAction | `boolean` | true | Toggles whether or not to display clear action. | | displayClearAction | `boolean` | true | Toggles whether or not to display clear action. |
| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. | | displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. |
@@ -121,16 +121,16 @@ Defining properties from Typescript:
You define the property list, the [`CardViewComponent`](../../core/components/card-view.component.md) does the rest. Each property represents a card view item (a row) in the [card view component](card-view.component.md). The following item types are available by default: You define the property list, the [`CardViewComponent`](../../core/components/card-view.component.md) does the rest. Each property represents a card view item (a row) in the [card view component](card-view.component.md). The following item types are available by default:
- [**CardViewTextItemModel**](#card-text-item) - _for text items_ * [**CardViewTextItemModel**](#card-text-item) - *for text items*
- [**CardViewMapItemModel**](#card-map-item) - _for map items_ * [**CardViewMapItemModel**](#card-map-item) - *for map items*
- [**CardViewDateItemModel**](#card-date-item) - _for date items_ * [**CardViewDateItemModel**](#card-date-item) - *for date items*
- [**CardViewDatetimeItemModel**](#card-datetime-item) - _for datetime items_ * [**CardViewDatetimeItemModel**](#card-datetime-item) - *for datetime items*
- [**CardViewBoolItemModel**](#card-bool-item) - _for bool items (checkbox)_ * [**CardViewBoolItemModel**](#card-bool-item) - *for bool items (checkbox)*
- [**CardViewIntItemModel**](#card-int-item) - _for integer items_ * [**CardViewIntItemModel**](#card-int-item) - *for integer items*
- [**CardViewFloatItemModel**](#card-float-item) - _for float items_ * [**CardViewFloatItemModel**](#card-float-item) - *for float items*
- [**CardViewKeyValuePairsItemModel**](#card-key-value-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_ * [**CardViewSelectItemModel**](#card-select-item) - *for select items*
- [**CardViewArrayItemModel**](#card-array-item) - _for array items_ * [**CardViewArrayItemModel**](#card-array-item) - *for array items*
Each of these types implements the [Card View Item interface](../interfaces/card-view-item.interface.md): Each of these types implements the [Card View Item interface](../interfaces/card-view-item.interface.md):
@@ -156,8 +156,8 @@ this.
You can optionally set up the card view so that its properties can be edited. You can control You can optionally set up the card view so that its properties can be edited. You can control
the editing of properties at two levels: the editing of properties at two levels:
- **Global level** - _via the editable parameter of the card-view.component_ * **Global level** - *via the editable parameter of the card-view.component*
- **[`Property`](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) level** - _in each property via the editable attribute_ * **[`Property`](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) level** - *in each property via the editable attribute*
If you set the global editable parameter to false, no properties can be edited regardless of their If you set the global editable parameter to false, no properties can be edited regardless of their
individual `editable` settings. individual `editable` settings.
@@ -353,7 +353,7 @@ const selectItemProperty = new CardViewSelectItemModel(options);
| key\* | string | | Identifying key (important when editing the item) | | key\* | string | | Identifying key (important when editing the item) |
| editable | boolean | false | Toggles whether the item is editable | | editable | boolean | false | Toggles whether the item is editable |
| value | string | | The original data value for the item | | value | string | | The original data value for the item |
| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)&lt;[`CardViewSelectItemOption`](../../../lib/core/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item | | options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewSelectItemOption`](../../../lib/core/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item |
#### Card Array Item #### Card Array Item
@@ -368,9 +368,9 @@ const arrayItemProperty = new CardViewArrayItemModel(items);
| label\* | string | | Item label | | label\* | string | | Item label |
| key\* | string | | Identifying key (important when editing the item) | | key\* | string | | Identifying key (important when editing the item) |
| editable | boolean | false | Toggles whether the item is editable | | editable | boolean | false | Toggles whether the item is editable |
| value | [`Observable`](http://reactivex.io/documentation/observable.html)&lt;[`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item | | value | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item |
## See also ## See also
- [Card View Update service](../services/card-view-update.service.md) * [Card View Update service](../services/card-view-update.service.md)
- [Card View Item interface](../interfaces/card-view-item.interface.md) * [Card View Item interface](../interfaces/card-view-item.interface.md)
docs/core/components/comment-list.component.md
+2 -2
View File
@@ -64,11 +64,11 @@ In the component template use the [comment list component](comment-list.componen
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -------- | --------------------------------------------------------------- | ------------- | -------------------------------------------- | | --- | --- | --- | --- |
| comments | [`CommentModel`](../../../lib/core/models/comment.model.ts)`[]` | | The comments data used to populate the list. | | comments | [`CommentModel`](../../../lib/core/models/comment.model.ts)`[]` | | The comments data used to populate the list. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| -------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | --- | --- | --- |
| clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` | Emitted when the user clicks on one of the comment rows. | | 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. |
docs/core/components/comments.component.md
+2 -2
View File
@@ -33,7 +33,7 @@ Displays comments from users involved in a specified task or content and allows
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -------- | --------- | ------------- | --------------------------- | | --- | --- | --- | --- |
| nodeId | `string` | | The numeric ID of the node. | | nodeId | `string` | | The numeric ID of the node. |
| readOnly | `boolean` | false | Are the comments read only? | | readOnly | `boolean` | false | Are the comments read only? |
| taskId | `string` | | The numeric ID of the task. | | taskId | `string` | | The numeric ID of the task. |
@@ -41,5 +41,5 @@ Displays comments from users involved in a specified task or content and allows
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ----- | ----------------------------------------------------------------- | --------------------------------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while displaying/adding a comment. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while displaying/adding a comment. |
docs/core/components/data-column.component.md
+15 -15
View File
@@ -11,17 +11,17 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
## Contents ## Contents
- [Basic Usage](#basic-usage) * [Basic Usage](#basic-usage)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Details](#details) * [Details](#details)
- [Conditional visibility](#conditional-visibility) * [Conditional visibility](#conditional-visibility)
- [Automatic column header translation](#automatic-column-header-translation) * [Automatic column header translation](#automatic-column-header-translation)
- [Custom tooltips](#custom-tooltips) * [Custom tooltips](#custom-tooltips)
- [Column Template](#column-template) * [Column Template](#column-template)
- [Styling Techniques](#styling-techniques) * [Styling Techniques](#styling-techniques)
- [Using the copyContent option](#using-the-copycontent-option) * [Using the copyContent option](#using-the-copycontent-option)
- [See also](#see-also) * [See also](#see-also)
## Basic Usage ## Basic Usage
@@ -42,7 +42,7 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------- | ---------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of cell contents. | | 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). | | cssClass | `string` | | Additional CSS class to be applied to column (header and cells). |
| editable | `boolean` | false | Toggles the editing support of the column data. | | editable | `boolean` | false | Toggles the editing support of the column data. |
@@ -334,6 +334,6 @@ HTML `<data-column>` element example:
## See also ## See also
- [Document list component](../../content-services/components/document-list.component.md) * [Document list component](../../content-services/components/document-list.component.md)
- [Datatable component](datatable.component.md) * [Datatable component](datatable.component.md)
- [Task list component](../../process-services/components/task-list.component.md) * [Task list component](../../process-services/components/task-list.component.md)
docs/core/components/datatable.component.md
+25 -25
View File
@@ -15,21 +15,21 @@ See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/
## Contents ## Contents
- [Basic usage](#basic-usage) * [Basic usage](#basic-usage)
- [Setting the rows and column schema](#setting-the-rows-and-column-schema) * [Setting the rows and column schema](#setting-the-rows-and-column-schema)
- [Transclusions](#transclusions) * [Transclusions](#transclusions)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Details](#details) * [Details](#details)
- [Supplying data for the table](#supplying-data-for-the-table) * [Supplying data for the table](#supplying-data-for-the-table)
- [Customizing columns](#customizing-columns) * [Customizing columns](#customizing-columns)
- [DataTable DOM Events](#datatable-dom-events) * [DataTable DOM Events](#datatable-dom-events)
- [Card view](#card-view) * [Card view](#card-view)
- [Using events](#using-events) * [Using events](#using-events)
- [Customizing the component's styles](#customizing-the-components-styles) * [Customizing the component's styles](#customizing-the-components-styles)
- [Resolver Function](#resolver-function) * [Resolver Function](#resolver-function)
- [See also](#see-also) * [See also](#see-also)
## Basic usage ## Basic usage
@@ -343,7 +343,7 @@ Learm more about styling your datatable: [Customizing the component's styles](#c
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------------- | --------------------------------------------------------------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| actions | `boolean` | false | Toggles the data actions column. | | actions | `boolean` | false | Toggles the data actions column. |
| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | | actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". |
| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. | | allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. |
@@ -362,18 +362,18 @@ Learm more about styling your datatable: [Customizing the component's styles](#c
| 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. | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| showHeader | `string` | ShowHeaderMode.Data | Toggles the header. | | showHeader | `string` | ShowHeaderMode.Data | Toggles the header. |
| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : [`created`, `desc`], [`created`, `asc`], [`due`, `desc`], [`due`, `asc`] | | sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : \[`created`, `desc`], \[`created`, `asc`], \[`due`, `desc`], \[`due`, `asc`] |
| stickyHeader | `boolean` | false | Toggles the sticky header mode. | | stickyHeader | `boolean` | false | Toggles the sticky header mode. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | | --- | --- | --- |
| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | | executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. |
| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. | | rowDblClick | `EventEmitter<DataRowEvent>` | Emitted when the user double-clicks a row. |
| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | | showRowActionsMenu | `EventEmitter<DataCellEvent>` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | showRowContextMenu | `EventEmitter<DataCellEvent>` | Emitted before the context menu is displayed for a row. |
## Details ## Details
@@ -824,7 +824,7 @@ here is the sample resolver which merge the users property and status and it wil
## See also ## See also
- [Data column component](data-column.component.md) * [Data column component](data-column.component.md)
- [Pagination component](pagination.component.md) * [Pagination component](pagination.component.md)
- [Data Table Adapter interface](../interfaces/datatable-adapter.interface.md) * [Data Table Adapter interface](../interfaces/datatable-adapter.interface.md)
- [Document list component](../../content-services/components/document-list.component.md) * [Document list component](../../content-services/components/document-list.component.md)
docs/core/components/empty-content.component.md
+2 -2
View File
@@ -30,7 +30,7 @@ Provides a generic "Empty Content" placeholder for components.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -------- | -------- | ------------- | ---------------------------------------- | | --- | --- | --- | --- |
| icon | `string` | "cake" | Material Icon to use. | | icon | `string` | "cake" | Material Icon to use. |
| subtitle | `string` | "" | String or Resource Key for the subtitle. | | subtitle | `string` | "" | String or Resource Key for the subtitle. |
| title | `string` | "" | String or Resource Key for the title. | | title | `string` | "" | String or Resource Key for the title. |
@@ -72,4 +72,4 @@ You can also use multiple lines instead of the subtitle section:
## See also ## See also
- [Error content component](error-content.component.md) * [Error content component](error-content.component.md)
docs/core/components/error-content.component.md
+2 -2
View File
@@ -22,7 +22,7 @@ this.router.navigate(['/error', errorCode]);
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------- | -------- | ------------- | -------------------------------------- | | --- | --- | --- | --- |
| errorCode | `string` | | Error code associated with this error. | | errorCode | `string` | | Error code associated with this error. |
## Details ## Details
@@ -63,4 +63,4 @@ For example you can have a custom action button with the following code
## See also ## See also
- [Empty Content component](empty-content.component.md) * [Empty Content component](empty-content.component.md)
docs/core/components/form-field.component.md
+2 -2
View File
@@ -26,7 +26,7 @@ based on the field type or the metadata information.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----- | --------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. | | field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. |
## Details ## Details
@@ -38,7 +38,7 @@ uses `<adf-form-field>` components to render the form fields.
Forms defined in APS have the following default mappings for the form fields: Forms defined in APS have the following default mappings for the form fields:
| _APS [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Designer_ [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | Field Type | Component Type | | *APS [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Designer* [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | Field Type | Component Type |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Text | text | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) | | 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) | | Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
docs/core/components/form-list.component.md
+1 -1
View File
@@ -22,5 +22,5 @@ Shows forms as a list.
### Properties ### Properties
| Name | Type | Default value | Description | | 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. |
docs/core/components/header.component.md
+2 -2
View File
@@ -37,7 +37,7 @@ body of the element:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------------- | ----------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| color | `string` | | Background color for the header. It can be any hex color code or one of the Material theme colors: 'primary', 'accent' or 'warn'. | | color | `string` | | Background color for the header. It can be any hex color code or one of the Material theme colors: 'primary', 'accent' or 'warn'. |
| expandedSidenav | `boolean` | true | expandedSidenav: Toggles the expanded state of the component. | | expandedSidenav | `boolean` | true | expandedSidenav: Toggles the expanded state of the component. |
| logo | `string` | | Path to an image file for the application logo. | | logo | `string` | | Path to an image file for the application logo. |
@@ -50,7 +50,7 @@ body of the element:
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | --------------------------------------------------------------------- | ------------------------------------------- | | --- | --- | --- |
| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the sidenav button is clicked. | | clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the sidenav button is clicked. |
## Details ## Details
docs/core/components/host-settings.component.md
+3 -3
View File
@@ -33,13 +33,13 @@ Validates the URLs for ACS and APS and saves them in the user's local storage
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------- | ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| providers | `string[]` | | Tells the component which provider options are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO. | | providers | `string[]` | | Tells the component which provider options are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | --------------------------------------------------------------------- | -------------------------------------------------- | | --- | --- | --- |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the user cancels the changes. | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the user cancels the changes. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the URL is invalid. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the URL is invalid. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the changes are successfully applied. | | success | `EventEmitter<boolean>` | Emitted when the changes are successfully applied. |
docs/core/components/icon.component.md
+2 -2
View File
@@ -27,7 +27,7 @@ Provides a universal way of rendering registered and named icons.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----- | --------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Theme color palette for the component. | | color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Theme color palette for the component. |
| value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. | | value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. |
@@ -80,4 +80,4 @@ using the `adf:` namespace.
## See also ## See also
- [Thumbnail service](../services/thumbnail.service.md) * [Thumbnail service](../services/thumbnail.service.md)
docs/core/components/infinite-pagination.component.md
+4 -4
View File
@@ -37,7 +37,7 @@ Adds "infinite" pagination to the component it is used with.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------- | ------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------- | | --- | --- | --- | --- |
| isLoading | `boolean` | false | Is a new page loading? | | isLoading | `boolean` | false | Is a new page loading? |
| pageSize | `number` | | Number of items that are added with each "load more" event. | | pageSize | `number` | | Number of items that are added with each "load more" event. |
| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | | target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. |
@@ -45,7 +45,7 @@ Adds "infinite" pagination to the component it is used with.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | | --- | --- | --- |
| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RequestPaginationModel`](../../../lib/core/models/request-pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. | | loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RequestPaginationModel`](../../../lib/core/models/request-pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. |
## Details ## Details
@@ -65,5 +65,5 @@ See the [Pagination component](pagination.component.md) for more information abo
## See also ## See also
- [Document list component](../../content-services/components/document-list.component.md) * [Document list component](../../content-services/components/document-list.component.md)
- [Pagination component](pagination.component.md) * [Pagination component](pagination.component.md)
docs/core/components/info-drawer-layout.component.md
+6 -6
View File
@@ -18,9 +18,9 @@ Displays a sidebar-style information panel.
There are three regions where you can add your own content using `<div>` elements There are three regions where you can add your own content using `<div>` elements
with the following names: with the following names:
- info-drawer-title * info-drawer-title
- info-drawer-buttons * info-drawer-buttons
- info-drawer-content * info-drawer-content
```html ```html
<adf-info-drawer-layout [showHeader]="true"> <adf-info-drawer-layout [showHeader]="true">
@@ -43,7 +43,7 @@ with the following names:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---------- | --------- | ------------- | ----------------------------- | | --- | --- | --- | --- |
| showHeader | `boolean` | true | The visibility of the header. | | showHeader | `boolean` | true | The visibility of the header. |
## Details ## Details
@@ -54,5 +54,5 @@ See the [Info drawer tab component](info-drawer-tab.component.md) for an alterna
## See also ## See also
- [Info drawer component](info-drawer.component.md) * [Info drawer component](info-drawer.component.md)
- [Info drawer tab component](info-drawer-tab.component.md) * [Info drawer tab component](info-drawer-tab.component.md)
docs/core/components/info-drawer-tab.component.md
+3 -3
View File
@@ -54,7 +54,7 @@ You can also combine `icon` and `label` properties.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----- | -------- | ------------- | ------------------------------------------------- | | --- | --- | --- | --- |
| icon | `string` | null | Icon to render for the tab. | | icon | `string` | null | Icon to render for the tab. |
| label | `string` | "" | The title of the tab (string or translation key). | | label | `string` | "" | The title of the tab (string or translation key). |
@@ -64,5 +64,5 @@ See the [Info drawer component](info-drawer.component.md) page for details of ho
## See also ## See also
- [Info drawer component](info-drawer.component.md) * [Info drawer component](info-drawer.component.md)
- [Info drawer layout component](info-drawer-layout.component.md) * [Info drawer layout component](info-drawer-layout.component.md)
docs/core/components/info-drawer.component.md
+7 -7
View File
@@ -18,9 +18,9 @@ Displays a sidebar-style information panel with tabs.
There are three regions where you can add your own content using `<div>` elements There are three regions where you can add your own content using `<div>` elements
with the following names (as with the [Info drawer layout component](info-drawer-layout.component.md)): with the following names (as with the [Info drawer layout component](info-drawer-layout.component.md)):
- info-drawer-title * info-drawer-title
- info-drawer-buttons * info-drawer-buttons
- info-drawer-content * info-drawer-content
The tabs are added using one or more `<adf-info-drawer-tab>` elements, which can The tabs are added using one or more `<adf-info-drawer-tab>` elements, which can
have any content you like: have any content you like:
@@ -48,7 +48,7 @@ have any content you like:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------- | ---------------- | ------------- | --------------------------------------------------------- | | --- | --- | --- | --- |
| selectedIndex | `number` | 0 | The selected index tab. | | selectedIndex | `number` | 0 | The selected index tab. |
| showHeader | `boolean` | true | The visibility of the header. | | showHeader | `boolean` | true | The visibility of the header. |
| title | `string \| null` | null | The title of the info drawer (string or translation key). | | title | `string \| null` | null | The title of the info drawer (string or translation key). |
@@ -56,7 +56,7 @@ have any content you like:
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---------- | -------------------------------------------------------------------- | ---------------------------------------------- | | --- | --- | --- |
| currentTab | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<number>` | Emitted when the currently active tab changes. | | currentTab | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<number>` | Emitted when the currently active tab changes. |
## Details ## Details
@@ -65,5 +65,5 @@ This is a variant of the [Info Drawer Layout component](info-drawer-layout.compo
## See also ## See also
- [Info drawer layout component](info-drawer-layout.component.md) * [Info drawer layout component](info-drawer-layout.component.md)
- [Info drawer tab component](info-drawer-tab.component.md) * [Info drawer tab component](info-drawer-tab.component.md)
docs/core/components/json-cell.component.md
+2 -2
View File
@@ -40,7 +40,7 @@ You can specify the cell inside the `app.config.json` file:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------- | --------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------ | | --- | --- | --- | --- |
| column | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | | Data that defines the column. | | column | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | | Data that defines the column. |
| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of the cell's content. | | copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of the cell's content. |
| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data table adapter instance. | | data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data table adapter instance. |
@@ -56,4 +56,4 @@ This component provides a custom display to show JSON data in a
## See also ## See also
- [Datatable component](datatable.component.md) * [Datatable component](datatable.component.md)
docs/core/components/login-dialog-panel.component.md
+2 -2
View File
@@ -14,7 +14,7 @@ Shows and manages a login dialog.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | --- | --- | --- |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. |
## Details ## Details
@@ -24,4 +24,4 @@ but it also creates and manages the dialog for you.
## See also ## See also
- [Login Dialog component](login-dialog.component.md) * [Login Dialog component](login-dialog.component.md)
docs/core/components/login.component.md
+21 -21
View File
@@ -13,20 +13,20 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
## Contents ## Contents
- [Basic usage](#basic-usage) * [Basic usage](#basic-usage)
- [Transclusions](#transclusions) * [Transclusions](#transclusions)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Details](#details) * [Details](#details)
- [Handling events](#handling-events) * [Handling events](#handling-events)
- [Custom logo and background](#custom-logo-and-background) * [Custom logo and background](#custom-logo-and-background)
- [Customizing validation rules](#customizing-validation-rules) * [Customizing validation rules](#customizing-validation-rules)
- [Call an external identity provider to fetch the auth token](#call-an-external-identity-provider-to-fetch-the-auth-token) * [Call an external identity provider to fetch the auth token](#call-an-external-identity-provider-to-fetch-the-auth-token)
- [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour) * [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour)
- [Single Sign-On (SSO)](#single-sign-on-sso) * [Single Sign-On (SSO)](#single-sign-on-sso)
- [Kerberos](#kerberos) * [Kerberos](#kerberos)
- [See Also](#see-also) * [See Also](#see-also)
## Basic usage ## Basic usage
@@ -76,7 +76,7 @@ with custom input fields handled by your application or parent component:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------------ | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| backgroundImageUrl | `string` | | Path to a custom background image. | | backgroundImageUrl | `string` | | Path to a custom background image. |
| copyrightText | `string` | | The copyright text below the login box. | | copyrightText | `string` | | The copyright text below the login box. |
| fieldsValidation | `any` | | Custom validation rules for the login form. | | fieldsValidation | `any` | | Custom validation rules for the login form. |
@@ -90,10 +90,10 @@ with custom input fields handled by your application or parent component:
### Events ### Events
| Name | Type | Description | | 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. | | 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. | | executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. | | success | `EventEmitter<LoginSuccessEvent>` | Emitted when the login is successful. |
## Details ## Details
@@ -265,7 +265,7 @@ export class MyCustomLogin {
``` ```
Note that if you do not call `event.preventDefault()` then the default behaviour Note that if you do not call `event.preventDefault()` then the default behaviour
will execute _after_ your custom code has completed. will execute *after* your custom code has completed.
### Single Sign-On (SSO) ### Single Sign-On (SSO)
@@ -301,8 +301,8 @@ automatically to the authorization server when the user is not logged-in
You can also enable automatic redirection to the OAuth provider using the following properties: You can also enable automatic redirection to the OAuth provider using the following properties:
- `silentLogin` * `silentLogin`
- `redirectSilentIframeUri` * `redirectSilentIframeUri`
```json ```json
{ {
@@ -356,4 +356,4 @@ See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructi
## See Also ## See Also
- [Logout directive](../directives/logout.directive.md) * [Logout directive](../directives/logout.directive.md)
docs/core/components/notification-history.component.md
+1 -1
View File
@@ -23,6 +23,6 @@ The main purpose of the [Notification history component](../../core/components/n
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------- | -------- | ------------- | ----------------------------------------------------------------------------- | | --- | --- | --- | --- |
| menuPositionX | `string` | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | | 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`. | | menuPositionY | `string` | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. |
docs/core/components/pagination.component.md
+14 -14
View File
@@ -13,14 +13,14 @@ Adds pagination to the component it is used with.
## Contents ## Contents
- [Basic Usage](#basic-usage) * [Basic Usage](#basic-usage)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Details](#details) * [Details](#details)
- [Integrating with the Document List component](#integrating-with-the-document-list-component) * [Integrating with the Document List component](#integrating-with-the-document-list-component)
- [Custom pagination](#custom-pagination) * [Custom pagination](#custom-pagination)
- [See also](#see-also) * [See also](#see-also)
## Basic Usage ## Basic Usage
@@ -41,7 +41,7 @@ Adds pagination to the component it is used with.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------------ | ------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------- | | --- | --- | --- | --- |
| supportedPageSizes | `number[]` | | An array of page sizes. | | supportedPageSizes | `number[]` | | An array of page sizes. |
| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | | target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. |
| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. | | pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. |
@@ -49,12 +49,12 @@ Adds pagination to the component it is used with.
### Events ### Events
| Name | Type | Description | | 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. | | 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. | | changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. |
| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page size changes. | | changePageSize | `EventEmitter<PaginationModel>` | 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. | | nextPage | `EventEmitter<PaginationModel>` | 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. | | prevPage | `EventEmitter<PaginationModel>` | Emitted when the previous page is requested. |
## Details ## Details
@@ -102,4 +102,4 @@ and pass the updated parameters.
## See also ## See also
- [Infinite Pagination component](infinite-pagination.component.md) * [Infinite Pagination component](infinite-pagination.component.md)
docs/core/components/search-text-input.component.md
+3 -3
View File
@@ -27,7 +27,7 @@ Displays a input text that supports autocompletion
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------------ | ------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------ | | --- | --- | --- | --- |
| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. | | autocomplete | `boolean` | false | Toggles auto-completion of the search input field. |
| collapseOnSubmit | `boolean` | true | Collapse search bar on submit. | | collapseOnSubmit | `boolean` | true | Collapse search bar on submit. |
| debounceTime | `number` | 0 | Debounce time in milliseconds. | | debounceTime | `number` | 0 | Debounce time in milliseconds. |
@@ -42,8 +42,8 @@ Displays a input text that supports autocompletion
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------------ | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | --- | --- | --- |
| reset | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the result list is reset | | reset | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the result list is reset |
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. | | searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. |
| selectResult | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the result list is selected | | selectResult | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the result list is selected |
| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. | | submit | `EventEmitter<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |
docs/core/components/sidebar-action-menu.component.md
+4 -4
View File
@@ -19,9 +19,9 @@ Displays a sidebar-action menu information panel.
There are three regions where you can add your own content in `<div>` elements with There are three regions where you can add your own content in `<div>` elements with
the following names: the following names:
- adf-sidebar-menu-title-icon * adf-sidebar-menu-title-icon
- adf-sidebar-menu-options * adf-sidebar-menu-options
- adf-sidebar-menu-expand-icon * adf-sidebar-menu-expand-icon
```html ```html
<adf-sidebar-action-menu> <adf-sidebar-action-menu>
@@ -43,7 +43,7 @@ the following names:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -------- | --------- | ------------- | ------------------------------------------------ | | --- | --- | --- | --- |
| expanded | `boolean` | | Toggle the sidebar action menu on expand. | | expanded | `boolean` | | Toggle the sidebar action menu on expand. |
| title | `string` | | The title of the sidebar action. | | title | `string` | | The title of the sidebar action. |
| width | `number` | 272 | Width in pixels for sidebar action menu options. | | width | `number` | 272 | Width in pixels for sidebar action menu options. |
docs/core/components/sidenav-layout.component.md
+16 -16
View File
@@ -13,15 +13,15 @@ Displays the standard three-region ADF application layout.
## Contents ## Contents
- [Basic Usage](#basic-usage) * [Basic Usage](#basic-usage)
- [Transclusions](#transclusions) * [Transclusions](#transclusions)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Details](#details) * [Details](#details)
- [Template context](#template-context) * [Template context](#template-context)
- [menuOpenState$](#menuopenstate) * [menuOpenState$](#menuopenstate)
- [Preserving the menu state](#preserving-the-menu-state) * [Preserving the menu state](#preserving-the-menu-state)
## Basic Usage ## Basic Usage
@@ -68,7 +68,7 @@ sub-components (note the use of `<ng-template>` in the sub-components' body sect
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------------- | --------- | ------------- | -------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? | | expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? |
| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. | | hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. |
| position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. | | position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. |
@@ -79,7 +79,7 @@ sub-components (note the use of `<ng-template>` in the sub-components' body sect
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| -------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | --- | --- | --- |
| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. | | expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. |
## Details ## Details
@@ -114,10 +114,10 @@ Mobile layout (screen width less than the `stepOver` value):
Each template is given a context containing the following methods: Each template is given a context containing the following methods:
- `toggleMenu(): void` * `toggleMenu(): void`
Triggers menu toggling. Triggers menu toggling.
- `isMenuMinimized(): boolean` * `isMenuMinimized(): boolean`
The expanded/compact (minimized) state of the navigation. This one only makes sense in case of desktop size, when the screen size is above the value of stepOver. The expanded/compact (minimized) state of the navigation. This one only makes sense in case of desktop size, when the screen size is above the value of stepOver.
### menuOpenState$ ### menuOpenState$
@@ -126,12 +126,12 @@ Beside the template context's **isMenuMinimized** variable, another way to liste
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------------- | ----------------------------------------------------------------------------- | ------- | ----------------------------------------------- | | -------------- | ----------------------------------------------------------------------------- | ------- | ----------------------------------------------- |
| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)&lt;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: Every time the menu state is changed, the following values are emitted:
- true, if the menu changed to the opened state * true, if the menu changed to the opened state
- false, if the menu changed to the closed state * false, if the menu changed to the closed state
### Preserving the menu state ### Preserving the menu state
docs/core/components/sorting-picker.component.md
+2 -2
View File
@@ -27,7 +27,7 @@ Selects from a set of predefined sorting definitions and directions.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------- | ----------------- | ------------- | ----------------------------- | | --- | --- | --- | --- |
| ascending | `boolean` | true | Current sorting direction | | ascending | `boolean` | true | Current sorting direction |
| options | `Array<Function>` | \[] | Available sorting options | | options | `Array<Function>` | \[] | Available sorting options |
| selected | `string` | | Currently selected option key | | selected | `string` | | Currently selected option key |
@@ -35,7 +35,7 @@ Selects from a set of predefined sorting definitions and directions.
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------------- | --------------------------------------------------------------------- | ------------------------------------------ | | --- | --- | --- |
| sortingChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Raised each time direction gets changed. | | sortingChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Raised each time direction gets changed. |
| valueChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Raised each time sorting key gets changed. | | valueChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Raised each time sorting key gets changed. |
docs/core/components/start-form.component.md
+8 -8
View File
@@ -25,7 +25,7 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode
### Properties ### Properties
| Name | Type | Default value | Description | | 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`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. |
| disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. | | disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. |
| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. | | disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. |
@@ -38,7 +38,7 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode
| nameNode | `string` | | Name to assign to the new node where the metadata are stored. | | nameNode | `string` | | Name to assign to the new node where the metadata are stored. |
| nodeId | `string` | | Content Services node ID for the form metadata. | | nodeId | `string` | | Content Services node ID for the form metadata. |
| path | `string` | | Path of the folder where the metadata will be stored. | | path | `string` | | Path of the folder where the metadata will be stored. |
| processDefinitionId | `string` | | [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId | | processDefinitionId | `string` | | [`Definition`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId |
| processId | `string` | | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId | | processId | `string` | | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId |
| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. | | readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. |
| readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? | | readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? |
@@ -54,16 +54,16 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | | 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. | | 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. | | 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. | | formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. |
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | | formError | `EventEmitter<FormFieldModel[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | | formLoaded | `EventEmitter<FormModel>` | 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. | | formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| outcomeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user clicks one of the outcome buttons that completes the form. | | outcomeClick | `EventEmitter<any>` | Emitted when the user clicks one of the outcome buttons that completes the form. |
## Details ## Details
@@ -78,4 +78,4 @@ the user clicked. You can pass this value to the `startProcess` method (defined
## See also ## See also
- [Process service](../../process-services/services/process.service.md) * [Process service](../../process-services/services/process.service.md)
docs/core/components/text-mask.component.md
+6 -6
View File
@@ -20,7 +20,7 @@ Implements text field input masks.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------- | ---------- | ------------- | ------------------------------------------- | | --- | --- | --- | --- |
| inputMask | `Function` | | Object defining mask and "reversed" status. | | inputMask | `Function` | | Object defining mask and "reversed" status. |
## Details ## Details
@@ -45,11 +45,11 @@ text mask in ADF would be:
The following characters have special meaning within a mask; all other characters The following characters have special meaning within a mask; all other characters
are included in the text as they are: are included in the text as they are:
- **"0"**: Denotes a digit * **"0"**: Denotes a digit
- **"9"**: Denotes a digit that can optionally be left out * **"9"**: Denotes a digit that can optionally be left out
- **"A"**: Denotes a alphanumeric character (upper- or lower-case A-Z and digits 0-9) * **"A"**: Denotes a alphanumeric character (upper- or lower-case A-Z and digits 0-9)
- **"S"**: Denotes a alphabetic character (upper- or lower-case A-Z) * **"S"**: Denotes a alphabetic character (upper- or lower-case A-Z)
- **"#"**: Denotes a string of zero or more digits * **"#"**: Denotes a string of zero or more digits
The mask is passed to the directive in the `mask` field of the parameter object. The The mask is passed to the directive in the `mask` field of the parameter object. The
`reversed` field indicates that digits in the mask are "filled up" in `reversed` field indicates that digits in the mask are "filled up" in
docs/core/components/toolbar.component.md
+11 -11
View File
@@ -13,14 +13,14 @@ Simple container for headers, titles, actions and breadcrumbs.
## Contents ## Contents
- [Basic Usage](#basic-usage) * [Basic Usage](#basic-usage)
- [Transclusions](#transclusions) * [Transclusions](#transclusions)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Details](#details) * [Details](#details)
- [Dropdown menu](#dropdown-menu) * [Dropdown menu](#dropdown-menu)
- [Custom color](#custom-color) * [Custom color](#custom-color)
- [See also](#see-also) * [See also](#see-also)
## Basic Usage ## Basic Usage
@@ -73,7 +73,7 @@ pushed to the right by a spacer:
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----- | --------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Toolbar color. Can be changed to empty value (default), `primary`, `accent` or `warn`. | | color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Toolbar color. Can be changed to empty value (default), `primary`, `accent` or `warn`. |
| title | `string` | "" | Toolbar title. | | title | `string` | "" | Toolbar title. |
@@ -133,5 +133,5 @@ For example:
## See also ## See also
- [Toolbar Divider component](toolbar-divider.component.md) * [Toolbar Divider component](toolbar-divider.component.md)
- [Toolbar Title component](toolbar-title.component.md) * [Toolbar Title component](toolbar-title.component.md)
docs/core/components/user-info.component.md
+1 -1
View File
@@ -20,7 +20,7 @@ Shows user information.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------------ | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS 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. | | ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. |
| menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | | menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. |
docs/core/components/viewer.component.md
+65 -65
View File
@@ -13,22 +13,22 @@ See it live: [Viewer Quickstart](https://embed.plnkr.co/iTuG1lFIXfsP95l6bDW6/)
## Contents ## Contents
- [Basic usage](#basic-usage) * [Basic usage](#basic-usage)
- [Transclusions](#transclusions) * [Transclusions](#transclusions)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Events](#events) * [Events](#events)
- [Keyboard shortcuts](#keyboard-shortcuts) * [Keyboard shortcuts](#keyboard-shortcuts)
- [Details](#details) * [Details](#details)
- [Integrating with the Document List component](#integrating-with-the-document-list-component) * [Integrating with the Document List component](#integrating-with-the-document-list-component)
- [Custom file parameters](#custom-file-parameters) * [Custom file parameters](#custom-file-parameters)
- [Supported file formats](#supported-file-formats) * [Supported file formats](#supported-file-formats)
- [Content Renditions](#content-renditions) * [Content Renditions](#content-renditions)
- [Configuring PDF.js library](#configuring-pdfjs-library) * [Configuring PDF.js library](#configuring-pdfjs-library)
- [Extending the Viewer](#extending-the-viewer) * [Extending the Viewer](#extending-the-viewer)
- [Custom layout](#custom-layout) * [Custom layout](#custom-layout)
- [Printing](#printing) * [Printing](#printing)
- [See also](#see-also) * [See also](#see-also)
## Basic usage ## Basic usage
@@ -75,7 +75,7 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -------------------- | --------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------ | | --- | --- | --- | --- |
| allowDownload | `boolean` | true | Toggles downloading. | | allowDownload | `boolean` | true | Toggles downloading. |
| allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. | | allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. |
| allowGoBack | `boolean` | true | Allows `back` navigation | | allowGoBack | `boolean` | true | Allows `back` navigation |
@@ -84,14 +84,14 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
| allowPrint | `boolean` | false | Toggles printing. | | allowPrint | `boolean` | false | Toggles printing. |
| allowRightSidebar | `boolean` | false | Allow the right sidebar. | | allowRightSidebar | `boolean` | false | Allow the right sidebar. |
| allowThumbnails | `boolean` | true | Toggles PDF thumbnails. | | 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" ("&lt;") button. Requires `allowNavigate` to be enabled. | | canNavigateBefore | `boolean` | true | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. |
| canNavigateNext | `boolean` | true | Toggles the next (">") 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. | | displayName | `string` | | Specifies the name of the file when it is not available from the URL. |
| fileName | `string` | | Content filename. | | fileName | `string` | | Content filename. |
| maxRetries | `number` | 30 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. | | maxRetries | `number` | 30 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. |
| mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). | | mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). |
| nodeId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) Id of the file to load. | | nodeId | `string` | null | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) Id of the file to load. |
| overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. | | 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). |
| showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. | | showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. |
@@ -108,14 +108,14 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | | --- | --- | --- |
| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the filename extension changes. | | extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the filename extension changes. |
| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Back' button. | | goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Back' button. |
| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the shared link used is not valid. | | invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the shared link used is not valid. |
| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Before' ("&lt;") button. | | navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Before' ("<") button. |
| navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Next' (">") button. | | navigateNext | `EventEmitter<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Next' (">") button. |
| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Print' button. | | print | `EventEmitter<BaseEvent<any>>` | Emitted when user clicks the 'Print' button. |
| showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the viewer is shown or hidden. | | showViewerChange | `EventEmitter<boolean>` | Emitted when the viewer is shown or hidden. |
## Keyboard shortcuts ## Keyboard shortcuts
@@ -182,45 +182,45 @@ You can provide custom file parameters, for example a value for the `mimeType` o
The [Viewer component](viewer.component.md) consists of separate Views that handle particular file types or type families based on either a file extension or a mime type: The [Viewer component](viewer.component.md) consists of separate Views that handle particular file types or type families based on either a file extension or a mime type:
- PDF View * PDF View
- application/pdf * application/pdf
- \*.pdf * \*.pdf
- Image View * Image View
- image/png * image/png
- image/jpeg * image/jpeg
- image/gif * image/gif
- image/bmp * image/bmp
- image/svg+xml * image/svg+xml
- \*.png * \*.png
- \*.jpg * \*.jpg
- \*.jpeg * \*.jpeg
- \*.gif * \*.gif
- \*.bpm * \*.bpm
- \*.svg * \*.svg
- Text View * Text View
- text/plain * text/plain
- text/csv * text/csv
- text/xml * text/xml
- text/html * text/html
- application/x-javascript * application/x-javascript
- \*.txt * \*.txt
- \*.xml * \*.xml
- \*.js * \*.js
- \*.html * \*.html
- \*.json * \*.json
- \*.ts * \*.ts
- Media View * Media View
- video/mp4 * video/mp4
- video/webm * video/webm
- video/ogg * video/ogg
- audio/mpeg * audio/mpeg
- audio/ogg * audio/ogg
- audio/wav * audio/wav
- \*.wav * \*.wav
- \*.mp4 * \*.mp4
- \*.mp3 * \*.mp3
- \*.webm * \*.webm
- \*.ogg * \*.ogg
### Content Renditions ### Content Renditions
@@ -502,4 +502,4 @@ content.
## See also ## See also
- [Document List component](../../content-services/components/document-list.component.md) * [Document List component](../../content-services/components/document-list.component.md)
docs/core/directives/check-allowable-operation.directive.md
+12 -12
View File
@@ -11,14 +11,14 @@ Selectively disables an HTML element or Angular component.
## Contents ## Contents
- [Basic Usage](#basic-usage) * [Basic Usage](#basic-usage)
- [Class members](#class-members) * [Class members](#class-members)
- [Properties](#properties) * [Properties](#properties)
- [Details](#details) * [Details](#details)
- [HTML element example](#html-element-example) * [HTML element example](#html-element-example)
- [Angular component example](#angular-component-example) * [Angular component example](#angular-component-example)
- [Implementing the NodeAllowableOperationSubject interface](#implementing-the-nodeallowableoperationsubject-interface) * [Implementing the NodeAllowableOperationSubject interface](#implementing-the-nodeallowableoperationsubject-interface)
- [Defining your component as an EXTENDIBLE_COMPONENT parent component](#defining-your-component-as-an-extendible_component-parent-component) * [Defining your component as an EXTENDIBLE_COMPONENT parent component](#defining-your-component-as-an-extendible_component-parent-component)
## Basic Usage ## Basic Usage
@@ -41,9 +41,9 @@ Selectively disables an HTML element or Angular component.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. | | nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. |
| permission | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). | | permission | `string` | null | Node permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). |
## Details ## Details
@@ -52,8 +52,8 @@ by taking a collection of [`NodeEntry`](https://github.com/Alfresco/alfresco-js-
The decorated element will be disabled if: The decorated element will be disabled if:
- there are no nodes in the collection * there are no nodes in the collection
- at least one of the nodes does not have the required permission * at least one of the nodes does not have the required permission
### HTML element example ### HTML element example
docs/core/directives/clipboard.directive.md
+2 -2
View File
@@ -26,7 +26,7 @@ Copies text to the clipboard.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------- | | --- | --- | --- | --- |
| message | `string` | | Translation key or message for snackbar notification. | | message | `string` | | Translation key or message for snackbar notification. |
| placeholder | `string` | | Translation key or message for the tooltip. | | placeholder | `string` | | Translation key or message for the tooltip. |
| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. | | target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. |
@@ -42,4 +42,4 @@ the user hovers the mouse over the element. You can also provide a snackbar mess
## See also ## See also
- [Clipboard service](../../core/services/clipboard.service.md) * [Clipboard service](../../core/services/clipboard.service.md)
docs/core/directives/context-menu.directive.md
+1 -1
View File
@@ -48,7 +48,7 @@ export class MyComponent implements OnInit {
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------- | --------- | ------------- | -------------------- | | --- | --- | --- | --- |
| enabled | `boolean` | false | Is the menu enabled? | | enabled | `boolean` | false | Is the menu enabled? |
| links | `any[]` | | Items for the menu. | | links | `any[]` | | Items for the menu. |
docs/core/directives/highlight.directive.md
+5 -5
View File
@@ -26,7 +26,7 @@ Adds highlighting to selected sections of an HTML element's content.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------------ | -------- | --------------- | ------------------------------------------ | | --- | --- | --- | --- |
| classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. | | classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. |
| search | `string` | "" | Text to highlight. | | search | `string` | "" | Text to highlight. |
| selector | `string` | "" | Class selector for highlightable elements. | | selector | `string` | "" | Class selector for highlightable elements. |
@@ -52,8 +52,8 @@ If the search string contain spaces then each section between the spaces will
be treated as a separate item to highlight. For example, you could use this to be treated as a separate item to highlight. For example, you could use this to
highlight all occurrences of words in a list. highlight all occurrences of words in a list.
The highlighting works by adding an HTML &lt;span> element around the The highlighting works by adding an HTML \<span> element around the
selected text. The &lt;span> includes a CSS class; this defaults to selected text. The \<span> includes a CSS class; this defaults to
"adf-highlight" but you can supply your own class using the `adf-highlight-class` "adf-highlight" but you can supply your own class using the `adf-highlight-class`
property: property:
@@ -70,5 +70,5 @@ property:
## See also ## See also
- [Text highlight pipe](../pipes/text-highlight.pipe.md) * [Text highlight pipe](../pipes/text-highlight.pipe.md)
- [Highlight transform service](../services/highlight-transform.service.md) * [Highlight transform service](../services/highlight-transform.service.md)
docs/core/directives/logout.directive.md
+2 -2
View File
@@ -20,7 +20,7 @@ Logs the user out when the decorated element is clicked.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| -------------- | --------- | ------------- | ------------------------------------- | | --- | --- | --- | --- |
| enableRedirect | `boolean` | true | Enable redirecting after logout | | enableRedirect | `boolean` | true | Enable redirecting after logout |
| redirectUri | `string` | "/login" | URI to redirect to after logging out. | | redirectUri | `string` | "/login" | URI to redirect to after logging out. |
@@ -34,4 +34,4 @@ See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructi
## See also ## See also
- [Login component](../components/login.component.md) * [Login component](../components/login.component.md)
docs/core/directives/node-delete.directive.md
+3 -3
View File
@@ -29,14 +29,14 @@ Deletes multiple files and folders.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash | | permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash |
| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. | | selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------ | ----------------------------------------------------------------- | ----------------------------------------- | | --- | --- | --- |
| delete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the nodes have been deleted. | | delete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the nodes have been deleted. |
## Details ## Details
@@ -46,4 +46,4 @@ this action will delete the file permanently.
## See also ## See also
- [Node Restore directive](node-restore.directive.md) * [Node Restore directive](node-restore.directive.md)
docs/core/directives/node-download.directive.md
+2 -2
View File
@@ -30,6 +30,6 @@ Allows folders and/or files to be downloaded, with multiple nodes packed as a '.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)` \| `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | | Nodes to download. | | nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)` \| `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | | Nodes to download. |
| version | [`VersionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/VersionEntry.md) | | [Node's](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) version to download. | | version | `VersionEntry` | | Node's version to download. |
docs/core/directives/node-favorite.directive.md
+5 -5
View File
@@ -42,13 +42,13 @@ export class MyComponent {
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- | | --- | --- | --- | --- |
| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. | | selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------ | ----------------------------------------------------------------- | ---------------------------------------------- | | --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting fails. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting fails. |
| toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting is complete. | | toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting is complete. |
@@ -75,9 +75,9 @@ which also lets you add extra styling to the element:
The directive behaves as follows: The directive behaves as follows:
- If there are no favorite nodes in the selection, then all are marked as favorites * If there are no favorite nodes in the selection, then all are marked as favorites
- If there are one or more favorite nodes in the selection, then only those that are not * If there are one or more favorite nodes in the selection, then only those that are not
favorites are marked favorites are marked
- If all nodes in the selection are favorites, then they all have their favorite status removed * If all nodes in the selection are favorites, then they all have their favorite status removed
See the **Demo Shell** for examples of usage. See the **Demo Shell** for examples of usage.
docs/core/directives/node-restore.directive.md
+3 -3
View File
@@ -49,13 +49,13 @@ Restores deleted nodes to their original location.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------- | ---------------------------------- | | --- | --- | --- | --- |
| selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` | | Array of deleted nodes to restore. | | selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` | | Array of deleted nodes to restore. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | | --- | --- | --- |
| restore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RestoreMessageModel`](../../../lib/core/directives/node-restore.directive.ts)`>` | Emitted when restoration is complete. | | restore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RestoreMessageModel`](../../../lib/core/directives/node-restore.directive.ts)`>` | Emitted when restoration is complete. |
## Details ## Details
@@ -69,4 +69,4 @@ been restored. The property specifies the route path where the list of nodes are
## See Also ## See Also
- [Node delete directive](node-delete.directive.md) * [Node delete directive](node-delete.directive.md)
docs/core/directives/upload.directive.md
+7 -7
View File
@@ -22,12 +22,12 @@ Uploads content in response to file drag and drop.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| --------- | ---------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- | --- |
| accept | `string` | | (Click mode only) MIME type filter for files to accept. | | accept | `string` | | (Click mode only) MIME type filter for files to accept. |
| data | `any` | | Data to upload. | | data | `any` | | Data to upload. |
| directory | `boolean` | | (Click mode only) Toggles uploading of directories. | | directory | `boolean` | | (Click mode only) Toggles uploading of directories. |
| enabled | `boolean` | true | Enables/disables uploading. | | enabled | `boolean` | true | Enables/disables uploading. |
| mode | `string[]` | ['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. | | mode | `string[]` | \['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. |
| multiple | `boolean` | | Toggles multiple file uploads. | | multiple | `boolean` | | Toggles multiple file uploads. |
## Details ## Details
@@ -65,8 +65,8 @@ value or expression:
The [Upload directive](upload.directive.md) supports two modes: The [Upload directive](upload.directive.md) supports two modes:
- **drop** mode, where the decorated element acts like a drop zone for files (enabled by default) * **drop** mode, where the decorated element acts like a drop zone for files (enabled by default)
- **click** mode, where the decorated element invokes a file dialog to select files or folders. * **click** mode, where the decorated element invokes a file dialog to select files or folders.
You can also use both modes together: You can also use both modes together:
@@ -80,9 +80,9 @@ You can also use both modes together:
In click mode you can provide extra attributes for the file dialog: In click mode you can provide extra attributes for the file dialog:
- **directory**, enables directory selection * **directory**, enables directory selection
- **multiple**, enables multiple file/folder selection * **multiple**, enables multiple file/folder selection
- **accept**, filters the content accepted * **accept**, filters the content accepted
```html ```html
<div style="width: 50px; height: 50px; background-color: brown" <div style="width: 50px; height: 50px; background-color: brown"
docs/core/directives/version-compatibility.directive.md
+1 -1
View File
@@ -22,7 +22,7 @@ Enables/disables components based on ACS version in use.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ------- | ------ | ------------- | ---------------------------------------------------------- | | --- | --- | --- | --- |
| version | `void` | | Minimum version required for component to work correctly . | | version | `void` | | Minimum version required for component to work correctly . |
## Details ## Details
docs/core/services/app-config.service.md
+15 -15
View File
@@ -13,27 +13,27 @@ Supports app configuration settings, stored server side.
### Methods ### Methods
- **get**(key: `string`, defaultValue?: \`\`)<br/> * **get**(key: `string`, defaultValue?: \`\`)<br/>
Gets the value of a named property. Gets the value of a named property.
- _key:_ `string` - Name of the property * *key:* `string` - Name of the property
- _defaultValue:_ \`\` - (Optional) Value to return if the key is not found * *defaultValue:* \`\` - (Optional) Value to return if the key is not found
- **getLocationHostname**(): `string`<br/> * **getLocationHostname**(): `string`<br/>
Gets the location.hostname property. Gets the location.hostname property.
- **Returns** `string` - Value of the property * **Returns** `string` - Value of the property
- **getLocationPort**(prefix: `string` = `""`): `string`<br/> * **getLocationPort**(prefix: `string` = `""`): `string`<br/>
Gets the location.port property. Gets the location.port property.
- _prefix:_ `string` - Text added before port value * *prefix:* `string` - Text added before port value
- **Returns** `string` - Port with prefix * **Returns** `string` - Port with prefix
- **getLocationProtocol**(): `string`<br/> * **getLocationProtocol**(): `string`<br/>
Gets the location.protocol value. Gets the location.protocol value.
- **Returns** `string` - The location.protocol string * **Returns** `string` - The location.protocol string
- **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>`<br/> * **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>`<br/>
Loads the config file. Loads the config file.
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>` - Notification when loading is complete * **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>` - Notification when loading is complete
- **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> * **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Requests notification of a property value when it is loaded. Requests notification of a property value when it is loaded.
- _property:_ `string` - The desired property value * *property:* `string` - The desired property value
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Property value, when loaded * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Property value, when loaded
## Details ## Details
docs/core/services/apps-process.service.md
+8 -8
View File
@@ -13,17 +13,17 @@ Gets details of the Process Services apps that are deployed for the user.
### Methods ### Methods
- **getApplicationDetailsById**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`<br/> * **getApplicationDetailsById**(appId: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`<br/>
Gets the details for a specific app ID number. Gets the details for a specific app ID number.
- _appId:_ `number` - ID of the target app * *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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>` - Details of the app
- **getDeployedApplications**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`[]>`<br/> * **getDeployedApplications**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`[]>`<br/>
Gets a list of deployed apps for this user. 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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`[]>` - The list of deployed apps
- **getDeployedApplicationsByName**(name: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`<br/> * **getDeployedApplicationsByName**(name: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>`<br/>
Gets a list of deployed apps for this user, where the app name is `name`. Gets a list of deployed apps for this user, where the app name is `name`.
- _name:_ `string` - Name of the app * *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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`AppDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md)`>` - The list of deployed apps
## Details ## Details
docs/core/services/authentication.service.md
+56 -56
View File
@@ -13,85 +13,85 @@ Provides authentication to ACS and APS.
### Methods ### Methods
- **addTokenToHeader**(headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>`<br/> * **addTokenToHeader**(headersArg?: `HttpHeaders`): [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>`<br/>
Adds the auth token to an HTTP header using the 'bearer' scheme. Adds the auth token to an HTTP header using the 'bearer' scheme.
- _headersArg:_ `HttpHeaders` - (Optional) Header that will receive the token * *headersArg:* `HttpHeaders` - (Optional) Header that will receive the token
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>` - The new header with the token added * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<HttpHeaders>` - The new header with the token added
- **getBearerExcludedUrls**(): `string[]`<br/> * **getBearerExcludedUrls**(): `string[]`<br/>
Gets the set of URLs that the token bearer is excluded from. Gets the set of URLs that the token bearer is excluded from.
- **Returns** `string[]` - Array of URL strings * **Returns** `string[]` - Array of URL strings
- **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>`<br/> * **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>`<br/>
Gets information about the user currently logged into APS. Gets information about the user currently logged into APS.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>` - User information * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserRepresentation.md)`>` - User information
- **getBpmUsername**(): `string`<br/> * **getBpmUsername**(): `string`<br/>
Gets the BPM username Gets the BPM username
- **Returns** `string` - The BPM username * **Returns** `string` - The BPM username
- **getEcmUsername**(): `string`<br/> * **getEcmUsername**(): `string`<br/>
Gets the ECM username. Gets the ECM username.
- **Returns** `string` - The ECM username * **Returns** `string` - The ECM username
- **getRedirect**(): `string`<br/> * **getRedirect**(): `string`<br/>
Gets the URL to redirect to after login. Gets the URL to redirect to after login.
- **Returns** `string` - The redirect URL * **Returns** `string` - The redirect URL
- **getTicketBpm**(): `string|null`<br/> * **getTicketBpm**(): `string|null`<br/>
Gets the BPM ticket stored in the Storage. Gets the BPM ticket stored in the Storage.
- **Returns** `string|null` - The ticket or `null` if none was found * **Returns** `string|null` - The ticket or `null` if none was found
- **getTicketEcm**(): `string|null`<br/> * **getTicketEcm**(): `string|null`<br/>
Gets the ECM ticket stored in the Storage. Gets the ECM ticket stored in the Storage.
- **Returns** `string|null` - The ticket or `null` if none was found * **Returns** `string|null` - The ticket or `null` if none was found
- **getTicketEcmBase64**(): `string|null`<br/> * **getTicketEcmBase64**(): `string|null`<br/>
Gets the BPM ticket from the Storage in Base 64 format. Gets the BPM ticket from the Storage in Base 64 format.
- **Returns** `string|null` - The ticket or `null` if none was found * **Returns** `string|null` - The ticket or `null` if none was found
- **getToken**(): `string`<br/> * **getToken**(): `string`<br/>
Gets the auth token. Gets the auth token.
- **Returns** `string` - Auth token string * **Returns** `string` - Auth token string
- **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> * **handleError**(error: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Prints an error message in the console browser Prints an error message in the console browser
- _error:_ `any` - Error message * *error:* `any` - Error message
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Object representing the error message * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Object representing the error message
- **isALLProvider**(): `boolean`<br/> * **isALLProvider**(): `boolean`<br/>
Does the provider support both ECM and BPM? Does the provider support both ECM and BPM?
- **Returns** `boolean` - True if both are supported, false otherwise * **Returns** `boolean` - True if both are supported, false otherwise
- **isBPMProvider**(): `boolean`<br/> * **isBPMProvider**(): `boolean`<br/>
Does the provider support BPM? Does the provider support BPM?
- **Returns** `boolean` - True if supported, false otherwise * **Returns** `boolean` - True if supported, false otherwise
- **isBpmLoggedIn**(): `boolean`<br/> * **isBpmLoggedIn**(): `boolean`<br/>
Checks if the user is logged in on a BPM provider. Checks if the user is logged in on a BPM provider.
- **Returns** `boolean` - True if logged in, false otherwise * **Returns** `boolean` - True if logged in, false otherwise
- **isECMProvider**(): `boolean`<br/> * **isECMProvider**(): `boolean`<br/>
Does the provider support ECM? Does the provider support ECM?
- **Returns** `boolean` - True if supported, false otherwise * **Returns** `boolean` - True if supported, false otherwise
- **isEcmLoggedIn**(): `boolean`<br/> * **isEcmLoggedIn**(): `boolean`<br/>
Checks if the user is logged in on an ECM provider. Checks if the user is logged in on an ECM provider.
- **Returns** `boolean` - True if logged in, false otherwise * **Returns** `boolean` - True if logged in, false otherwise
- **isLoggedIn**(): `boolean`<br/> * **isLoggedIn**(): `boolean`<br/>
Checks if the user logged in. Checks if the user logged in.
- **Returns** `boolean` - True if logged in, false otherwise * **Returns** `boolean` - True if logged in, false otherwise
- **isLoggedInWith**(provider: `string`): `boolean`<br/> * **isLoggedInWith**(provider: `string`): `boolean`<br/>
- _provider:_ `string` - * *provider:* `string` -
- **Returns** `boolean` - * **Returns** `boolean` -
- **isOauth**(): `boolean`<br/> * **isOauth**(): `boolean`<br/>
Does the provider support OAuth? Does the provider support OAuth?
- **Returns** `boolean` - True if supported, false otherwise * **Returns** `boolean` - True if supported, false otherwise
- **isPublicUrl**(): `boolean`<br/> * **isPublicUrl**(): `boolean`<br/>
- **Returns** `boolean` - * **Returns** `boolean` -
- **isRememberMeSet**(): `boolean`<br/> * **isRememberMeSet**(): `boolean`<br/>
Checks whether the "remember me" cookie was set or not. Checks whether the "remember me" cookie was set or not.
- **Returns** `boolean` - True if set, false otherwise * **Returns** `boolean` - True if set, false otherwise
- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>`<br/> * **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>`<br/>
Logs the user in. Logs the user in.
- _username:_ `string` - Username for the login * *username:* `string` - Username for the login
- _password:_ `string` - Password for the login * *password:* `string` - Password for the login
- _rememberMe:_ `boolean` - Stores the user's login details if true * *rememberMe:* `boolean` - Stores the user's login details if true
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>` - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket
- **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> * **logout**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Logs the user out. Logs the user out.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Response event called when logout is complete * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Response event called when logout is complete
- **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))<br/> * **setRedirect**(url: [`RedirectionModel`](../../../lib/core/models/redirection.model.ts))<br/>
Sets the URL to redirect to after login. Sets the URL to redirect to after login.
- _url:_ [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to * *url:* [`RedirectionModel`](../../../lib/core/models/redirection.model.ts) - URL to redirect to
- **ssoImplicitLogin**()<br/> * **ssoImplicitLogin**()<br/>
Logs the user in with SSO Logs the user in with SSO
## Details ## Details
@@ -118,4 +118,4 @@ export class AppComponent {
## See also ## See also
- [Login component](../components/login.component.md) * [Login component](../components/login.component.md)
docs/core/services/bpm-user.service.md
+6 -6
View File
@@ -13,12 +13,12 @@ Gets information about the current Process Services user.
### Methods ### Methods
- **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>`<br/> * **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>`<br/>
Gets information about the current user. Gets information about the current user.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>` - User information object * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>` - User information object
- **getCurrentUserProfileImage**(): `string`<br/> * **getCurrentUserProfileImage**(): `string`<br/>
Gets the current user's profile image as a URL. Gets the current user's profile image as a URL.
- **Returns** `string` - URL string * **Returns** `string` - URL string
## Details ## Details
@@ -33,5 +33,5 @@ methods in the Alfresco JS API for more information about the REST calls used by
## See also ## See also
- [Ecm user service](../services/ecm-user.service.md) * [Ecm user service](../services/ecm-user.service.md)
- [Bpm user model](../models/bpm-user.model.md) * [Bpm user model](../models/bpm-user.model.md)
docs/core/services/card-item-types.service.md
+17 -17
View File
@@ -13,25 +13,25 @@ Maps type names to field component types for the [Card View component](../compon
### Methods ### Methods
- **getComponentTypeResolver**(type: `string`, defaultValue: `Type<Function>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)<br/> * **getComponentTypeResolver**(type: `string`, defaultValue: `Type<Function>` = `this.defaultValue`): [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts)<br/>
Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. Gets the currently active [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type.
- _type:_ `string` - The type whose resolver you want * *type:* `string` - The type whose resolver you want
- _defaultValue:_ `Type<Function>` - Default type returned for types that are not yet mapped * *defaultValue:* `Type<Function>` - Default type returned for types that are not yet mapped
- **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function * **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function
- **register**(components: `Function`, override: `boolean` = `false`)<br/> * **register**(components: `Function`, override: `boolean` = `false`)<br/>
Register multiple components Register multiple components
- _components:_ `Function` - * *components:* `Function` -
- _override:_ `boolean` - * *override:* `boolean` -
- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<Function>` = `this.defaultValue`): `Type<Function>`<br/> * **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<Function>` = `this.defaultValue`): `Type<Function>`<br/>
Finds the component type that is needed to render a form field. Finds the component type that is needed to render a form field.
- _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render * *model:* [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render
- _defaultValue:_ `Type<Function>` - Default type returned for field types that are not yet mapped. * *defaultValue:* `Type<Function>` - Default type returned for field types that are not yet mapped.
- **Returns** `Type<Function>` - Component type * **Returns** `Type<Function>` - Component type
- **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)<br/> * **setComponentTypeResolver**(type: `string`, resolver: [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts), override: `boolean` = `true`)<br/>
Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type. Sets or optionally replaces a [DynamicComponentResolveFunction](../../../lib/core/services/dynamic-component-mapper.service.ts) for a field type.
- _type:_ `string` - The type whose resolver you want to set * *type:* `string` - The type whose resolver you want to set
- _resolver:_ [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function * *resolver:* [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - The new resolver function
- _override:_ `boolean` - The new resolver will only replace an existing one if this parameter is true * *override:* `boolean` - The new resolver will only replace an existing one if this parameter is true
## Details ## Details
@@ -75,5 +75,5 @@ export class SomeParentComponent {
## See also ## See also
- [Card View component](../components/card-view.component.md) * [Card View component](../components/card-view.component.md)
- [Card View Item interface](../interfaces/card-view-item.interface.md) * [Card View Item interface](../interfaces/card-view-item.interface.md)
docs/core/services/clipboard.service.md
+10 -10
View File
@@ -13,18 +13,18 @@ Copies text to the clipboard.
### Methods ### Methods
- **copyContentToClipboard**(content: `string`, message: `string`)<br/> * **copyContentToClipboard**(content: `string`, message: `string`)<br/>
Copies a text string to the clipboard. Copies a text string to the clipboard.
- _content:_ `string` - Text to copy * *content:* `string` - Text to copy
- _message:_ `string` - Snackbar message to alert when copying happens * *message:* `string` - Snackbar message to alert when copying happens
- **copyToClipboard**(target: [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement), message?: `string`)<br/> * **copyToClipboard**(target: [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement), message?: `string`)<br/>
Copies text from an HTML element to the clipboard. Copies text from an HTML element to the clipboard.
- _target:_ [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) - HTML element to be copied * *target:* [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) - HTML element to be copied
- _message:_ `string` - (Optional) Snackbar message to alert when copying happens * *message:* `string` - (Optional) Snackbar message to alert when copying happens
- **isTargetValid**(target: [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement)): `boolean`<br/> * **isTargetValid**(target: [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement)): `boolean`<br/>
Checks if the target element can have its text copied. Checks if the target element can have its text copied.
- _target:_ [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) - Target HTML element * *target:* [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`|`[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) - Target HTML element
- **Returns** `boolean` - True if the text can be copied, false otherwise * **Returns** `boolean` - True if the text can be copied, false otherwise
## Details ## Details
@@ -35,4 +35,4 @@ copying operation takes place.
## See also ## See also
- [Clipboard directive](../../core/directives/clipboard.directive.md) * [Clipboard directive](../../core/directives/clipboard.directive.md)
docs/core/services/comment-content.service.md
+8 -8
View File
@@ -13,15 +13,15 @@ Adds and retrieves comments for nodes in Content Services.
### Methods ### Methods
- **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/> * **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/>
Adds a comment to a node. Adds a comment to a node.
- _nodeId:_ `string` - ID of the target node * *nodeId:* `string` - ID of the target node
- _message:_ `string` - Text for the comment * *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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added
- **getNodeComments**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`<br/> * **getNodeComments**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`<br/>
Gets all comments that have been added to a node. Gets all comments that have been added to a node.
- _nodeId:_ `string` - ID of the target node * *nodeId:* `string` - ID of the target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment
## Details ## Details
@@ -31,4 +31,4 @@ for more information about the underlying REST API.
## See also ## See also
- [Comment process service](comment-process.service.md) * [Comment process service](comment-process.service.md)
docs/core/services/comment-process.service.md
+14 -14
View File
@@ -13,24 +13,24 @@ Adds and retrieves comments for task and process instances in Process Services.
### Methods ### Methods
- **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/> * **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/>
Adds a comment to a process instance. Adds a comment to a process instance.
- _processInstanceId:_ `string` - ID of the target process instance * *processInstanceId:* `string` - ID of the target process instance
- _message:_ `string` - Text for the comment * *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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added
- **addTaskComment**(taskId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/> * **addTaskComment**(taskId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/>
Adds a comment to a task. Adds a comment to a task.
- _taskId:_ `string` - ID of the target task * *taskId:* `string` - ID of the target task
- _message:_ `string` - Text for the comment * *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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details about the comment
- **getProcessInstanceComments**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`<br/> * **getProcessInstanceComments**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`<br/>
Gets all comments that have been added to a process instance. Gets all comments that have been added to a process instance.
- _processInstanceId:_ `string` - ID of the target 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 * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment
- **getTaskComments**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`<br/> * **getTaskComments**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`<br/>
Gets all comments that have been added to a task. Gets all comments that have been added to a task.
- _taskId:_ `string` - ID of the target task * *taskId:* `string` - ID of the target task
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment
## Details ## Details

Some files were not shown because too many files have changed in this diff Show More