inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-4152] Updated folder structure of core docs (#4415)

Browse Source 
* [ADF-4152] Moved core library docs into subfolders

* [ADF-4152] Moved core library docs into subfolders

* [ADF-4152] Manual fixes to core doc file links

* [ADF-4152] Further automatic + manual link tidying
This commit is contained in:
Andy Stark
2019-03-12 14:20:20 +00:00
committed by Eugenio Romano
parent 285e56e9fb
commit 5fc05da7aa
121 changed files with 1112 additions and 1329 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
docs/core/README.md
View File

@@ -1,154 +0,0 @@
---
Title: Core API
Github only: true
---
# Core API
Contains a variety of components used throughout ADF.
See the library's
[README file](../../lib/core/README.md)
for more information about installing and using the source code.
<!--core start-->
## Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [About component](about.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Shows a general version and status overview of the installed ADF library. | [Source](../../lib/core/about/about.component.ts) |
| [Buttons menu component](buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../../lib/core/buttons-menu/buttons-menu.component.ts) |
| [Card view component](card-view.component.md) | Displays a configurable property list renderer. | [Source](../../lib/core/card-view/components/card-view/card-view.component.ts) |
| [Comment list component](comment-list.component.md) | Shows a list of comments. | [Source](../../lib/core/comments/comment-list.component.ts) |
| [Comments component](comments.component.md) | Displays comments from users involved in a specified task or content and allows an involved user to add a comment to a task or a content. | [Source](../../lib/core/comments/comments.component.ts) |
| [Data column component](data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../../lib/core/data-column/data-column.component.ts) |
| [Datatable component](datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../../lib/core/datatable/components/datatable/datatable.component.ts) |
| [Empty list component](empty-list.component.md) | Displays a message indicating that a list is empty. | [Source](../../lib/core/datatable/components/datatable/empty-list.component.ts) |
| [Form field component](form-field.component.md) | Represents a UI field in a form. | [Source](../../lib/core/form/components/form-field/form-field.component.ts) |
| [Form list component](form-list.component.md) | Shows forms as a list. | [Source](../../lib/core/form/components/form-list.component.ts) |
| [Form component](form.component.md) | Shows a Form from APS | [Source](../../lib/core/form/components/form.component.ts) |
| [Start form component](start-form.component.md) | Displays the Start Form for a process. | [Source](../../lib/core/form/components/start-form.component.ts) |
| [Text mask component](text-mask.component.md) | Implements text field input masks. | [Source](../../lib/core/form/components/widgets/text/text-mask.component.ts) |
| [Icon component](icon.component.md) | Provides a universal way of rendering registered and named icons. | [Source](../../lib/core/icon/icon.component.ts) |
| [Info drawer layout component](info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../../lib/core/info-drawer/info-drawer-layout.component.ts) |
| [Info drawer component](info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../../lib/core/info-drawer/info-drawer.component.ts) |
| [Language menu component](language-menu.component.md) | Displays all the languages that are present in "app.config.json" and the default (EN). | [Source](../../lib/core/language-menu/language-menu.component.ts) |
| [Header component](header.component.md) | Reusable header for Alfresco applications. | [Source](../../lib/core/layout/components/header/header.component.ts) |
| [Sidebar action menu component](sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts) |
| [Sidenav layout component](sidenav-layout.component.md) | Displays the standard three-region ADF application layout. | [Source](../../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts) |
| [Login dialog panel component](login-dialog-panel.component.md) | Shows and manages a login dialog. | [Source](../../lib/core/login/components/login-dialog-panel.component.ts) |
| [Login dialog component](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](login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../../lib/core/login/components/login.component.ts) |
| [Infinite pagination component](infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../../lib/core/pagination/infinite-pagination.component.ts) |
| [Pagination component](pagination.component.md) | Adds pagination to the component it is used with. | [Source](../../lib/core/pagination/pagination.component.ts) |
| [Host settings component](host-settings.component.md) ![Internal](../docassets/images/InternalIcon.png) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../../lib/core/settings/host-settings.component.ts) |
| [Sorting picker component](sorting-picker.component.md) | Selects from a set of predefined sorting definitions and directions. | [Source](../../lib/core/sorting-picker/sorting-picker.component.ts) |
| [Empty content component](empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../../lib/core/templates/empty-content/empty-content.component.ts) |
| [Error content component](error-content.component.md) | Displays info about a specific error. | [Source](../../lib/core/templates/error-content/error-content.component.ts) |
| [Toolbar divider component](toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../../lib/core/toolbar/toolbar-divider.component.ts) |
| [Toolbar title component](toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../../lib/core/toolbar/toolbar-title.component.ts) |
| [Toolbar component](toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../../lib/core/toolbar/toolbar.component.ts) |
| [User info component](user-info.component.md) | Shows user information. | [Source](../../lib/core/userinfo/components/user-info.component.ts) |
| [Viewer component](viewer.component.md) | Displays content from an ACS repository. | [Source](../../lib/core/viewer/components/viewer.component.ts) |
## Directives
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Context menu directive](context-menu.directive.md) | Adds a context menu to a component. | [Source](../../lib/core/context-menu/context-menu.directive.ts) |
| [Check allowable operation directive](check-allowable-operation.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../../lib/core/directives/check-allowable-operation.directive.ts) |
| [Highlight directive](highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../../lib/core/directives/highlight.directive.ts) |
| [Logout directive](logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../../lib/core/directives/logout.directive.ts) |
| [Node delete directive](node-delete.directive.md) | Deletes multiple files and folders. | [Source](../../lib/core/directives/node-delete.directive.ts) |
| [Node download directive](node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../../lib/core/directives/node-download.directive.ts) |
| [Node favorite directive](node-favorite.directive.md) | Selectively toggles nodes as favorites. | [Source](../../lib/core/directives/node-favorite.directive.ts) |
| [Node restore directive](node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../../lib/core/directives/node-restore.directive.ts) |
| [Upload directive](upload.directive.md) | Uploads content in response to file drag and drop. | [Source](../../lib/core/directives/upload.directive.ts) |
## Models
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Form field model](form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../../lib/core/form/components/widgets/core/form-field.model.ts) |
| [Product version model](product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../../lib/core/models/product-version.model.ts) |
| [User process model](user-process.model.md) | Represents a Process Services user. | [Source](../../lib/core/models/user-process.model.ts) |
| [Bpm user model](bpm-user.model.md) | Contains information about a Process Services user. | [Source](../../lib/core/userinfo/models/bpm-user.model.ts) |
| [Ecm user model](ecm-user.model.md) | Contains information about a Content Services user. | [Source](../../lib/core/userinfo/models/ecm-user.model.ts) |
## Pipes
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [File size pipe](file-size.pipe.md) | Converts a number of bytes to the equivalent in KB, MB, etc. | [Source](../../lib/core/pipes/file-size.pipe.ts) |
| [Format space pipe](format-space.pipe.md) | Replaces all the white space in a string with a supplied character. | [Source](../../lib/core/pipes/format-space.pipe.ts) |
| [Full name pipe](full-name.pipe.md) | Joins the first and last name properties from a UserProcessModel object into a single string. | [Source](../../lib/core/pipes/full-name.pipe.ts) |
| [Mime type icon pipe](mime-type-icon.pipe.md) | Retrieves an icon to represent a MIME type. | [Source](../../lib/core/pipes/mime-type-icon.pipe.ts) |
| [Node name tooltip pipe](node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../../lib/core/pipes/node-name-tooltip.pipe.ts) |
| [Text highlight pipe](text-highlight.pipe.md) | Adds highlighting to words or sections of text that match a search string. | [Source](../../lib/core/pipes/text-highlight.pipe.ts) |
| [Time ago pipe](time-ago.pipe.md) | Converts a recent past date into a number of days ago. | [Source](../../lib/core/pipes/time-ago.pipe.ts) |
| [User initial pipe](user-initial.pipe.md) | Takes the name fields of a UserProcessModel object and extracts and formats the initials. | [Source](../../lib/core/pipes/user-initial.pipe.ts) |
## Services
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Card item types service](card-item-types.service.md) | Maps type names to field component types for the Card View component. | [Source](../../lib/core/card-view/services/card-item-types.service.ts) |
| [Card view update service](card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | [Source](../../lib/core/card-view/services/card-view-update.service.ts) |
| [Activiti alfresco service](activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../../lib/core/form/services/activiti-alfresco.service.ts) |
| [Form rendering service](form-rendering.service.md) | Maps a form field type string onto the corresponding form widget component type. | [Source](../../lib/core/form/services/form-rendering.service.ts) |
| [Form service](form.service.md) | Implements Process Services form methods | [Source](../../lib/core/form/services/form.service.ts) |
| [Node service](node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../../lib/core/form/services/node.service.ts) |
| [Process content service](process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../../lib/core/form/services/process-content.service.ts) |
| [Alfresco api service](alfresco-api.service.md) | Provides access to an initialized **AlfrescoJSApi** instance. | [Source](../../lib/core/services/alfresco-api.service.ts) |
| [Apps process service](apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../../lib/core/services/apps-process.service.ts) |
| [Auth guard bpm service](auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../../lib/core/services/auth-guard-bpm.service.ts) |
| [Auth guard ecm service](auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../../lib/core/services/auth-guard-ecm.service.ts) |
| [Auth guard service](auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../../lib/core/services/auth-guard.service.ts)
| [Auth guard SSO Role service](auth-guard-sso-role.service.md) | check the roles on a user | [Source](../../lib/core/services/auth-guard-sso-role.service.ts) |
| [Authentication service](authentication.service.md) | Provides authentication to ACS and APS. | [Source](../../lib/core/services/authentication.service.ts) |
| [Comment content service](comment-content.service.md) | Adds and retrieves comments for nodes in Content Services. | [Source](../../lib/core/services/comment-content.service.ts) |
| [Comment process service](comment-process.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../../lib/core/services/comment-process.service.ts) |
| [Content service](content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../../lib/core/services/content.service.ts) |
| [Cookie service](cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../../lib/core/services/cookie.service.ts) |
| [Deleted nodes api service](deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../../lib/core/services/deleted-nodes-api.service.ts) |
| [Discovery api service](discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../../lib/core/services/discovery-api.service.ts) |
| [Download zip service](download-zip.service.md) | Creates and manages downloads. | [Source](../../lib/core/services/download-zip.service.ts) |
| [Favorites api service](favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../../lib/core/services/favorites-api.service.ts) |
| [Highlight transform service](highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../../lib/core/services/highlight-transform.service.ts) |
| [Jwt helper service](jwt-helper.service.md) | Decodes a JSON Web Token (JWT) to a JavaScript object. | [Source](../../lib/core/services/jwt-helper.service.ts) |
| [Log service](log.service.md) | Provides log functionality. | [Source](../../lib/core/services/log.service.ts) |
| [Login dialog service](login-dialog.service.md) | Manages login dialogs. | [Source](../../lib/core/services/login-dialog.service.ts) |
| [Nodes api service](nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../../lib/core/services/nodes-api.service.ts) |
| [Notification service](notification.service.md) | Shows a notification message with optional feedback. | [Source](../../lib/core/services/notification.service.ts) |
| [Page title service](page-title.service.md) | Sets the page title. | [Source](../../lib/core/services/page-title.service.ts) |
| [People content service](people-content.service.md) | Gets information about a Content Services user. | [Source](../../lib/core/services/people-content.service.ts) |
| [People process service](people-process.service.md) | Gets information about Process Services users. | [Source](../../lib/core/services/people-process.service.ts) |
| [Renditions service](renditions.service.md) | Manages prearranged conversions of content to different formats. | [Source](../../lib/core/services/renditions.service.ts) |
| [Search configuration service](search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../../lib/core/services/search-configuration.service.ts) |
| [Search service](search.service.md) | Accesses the Content Services Search API. | [Source](../../lib/core/services/search.service.ts) |
| [Shared links api service](shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../../lib/core/services/shared-links-api.service.ts) |
| [Sites service](sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../../lib/core/services/sites.service.ts) |
| [Storage service](storage.service.md) | Stores items in the form of key-value pairs. | [Source](../../lib/core/services/storage.service.ts) |
| [Thumbnail service](thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../../lib/core/services/thumbnail.service.ts) |
| [Translation service](translation.service.md) | Supports localisation. | [Source](../../lib/core/services/translation.service.ts) |
| [Upload service](upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../../lib/core/services/upload.service.ts) |
| [User preferences service](user-preferences.service.md) | Stores preferences for the app and for individual components. | [Source](../../lib/core/services/user-preferences.service.ts) |
| [Bpm user service](bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../../lib/core/userinfo/services/bpm-user.service.ts) |
| [Ecm user service](ecm-user.service.md) | Gets information about a Content Services user. | [Source](../../lib/core/userinfo/services/ecm-user.service.ts) |
| [Identity user service](identity-user.service.md) | Gets OAuth2 personal details and roles for users. | [Source](../../lib/core/userinfo/services/identity-user.service.ts) |
## Widgets
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Content widget](content.widget.md) | Shows the content preview. | [Source](../../lib/core/form/components/widgets/content/content.widget.ts) |
<!--core end-->
## Other classes and interfaces
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Data Table Adapter interface](datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../../lib/core/datatable/data/datatable-adapter.ts) |
| [Form Field Validator interface](form-field-validator.interface.md) | Defines how the input fields of [`Form`](../../lib/process-services/task-list/models/form.model.ts) and Task Details components are validated. | [Source](../../lib/core/form/components/widgets/core/form-field-validator.ts) |
| [Search Configuration interface](search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../../lib/core/services/search-configuration.service.ts) |

63
docs/core/alfresco-api.service.md
View File

@@ -1,63 +0,0 @@
---
Title: Alfresco Api Service
Added: v2.0.0
Status: Active
Last reviewed: 2019-01-17
---
# [Alfresco Api Service](../../lib/core/services/alfresco-api.service.ts "Defined in alfresco-api.service.ts")
Provides access to an initialized **AlfrescoJSApi** instance.
## Basic Usage
```ts
export class MyComponent implements OnInit {
constructor(private apiService: AlfrescoApiService) {
}
ngOnInit() {
let nodeId = 'some-node-id';
let params = {};
this.apiService.getInstance().nodes
.getNodeChildren(nodeId, params)
.then(result => console.log(result));
}
}
```
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| contentApi | `ContentApi` | | (Read only) Accesses the Content API |
| nodesApi | `NodesApi` | | (Read only) Accesses the Nodes API |
| renditionsApi | `RenditionsApi` | | (Read only) Accesses the Renditions API |
| sharedLinksApi | `SharedLinksApi` | | (Read only) Accesses the Shared Links API |
| sitesApi | `SitesApi` | | (Read only) Accesses the Sites API |
| favoritesApi | `FavoritesApi` | | (Read only) Accesses the Favorites API |
| peopleApi | `PeopleApi` | | (Read only) Accesses the People API |
| searchApi | `SearchApi` | | (Read only) Accesses the Search API |
| versionsApi | `VersionsApi` | | (Read only) Accesses the Versions API |
| classesApi | `ClassesApi` | | (Read only) Accesses the Classes API |
| groupsApi | `GroupsApi` | | (Read only) Accesses the Groups API |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| nodeUpdated | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a node updates. |
## Details
**Note for developers**: The TypeScript declaration files for the Alfresco JS API
are still under development and some Alfresco APIs may not be accessible
via your IDE's intellisense or TypeScript compiler.
To avoid these TypeScript type check errors, you can call any supported
Alfresco JS api by casting the instance to the `any` type as in the following example:
```ts
let api: any = this.apiService.getInstance();
api.nodes.addNode('-root-', body, {});
```

4
docs/core/about.component.md → docs/core/components/about.component.md
View File

@@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2018-11-14
---
# [About Component](../../lib/core/about/about.component.ts "Defined in about.component.ts")
# [About Component](../../../lib/core/about/about.component.ts "Defined in about.component.ts")
Shows a general version and status overview of the installed ADF library.
@@ -17,7 +17,7 @@ Shows a general version and status overview of the installed ADF library.
## Details
Use this component to get a general overview of the version of ADF installed and the status of the [Content service](../core/content.service.md) and [Process service](../process-services/process.service.md).
Use this component to get a general overview of the version of ADF installed and the status of the [Content service](../services/content.service.md) and [Process service](../../process-services/services/process.service.md).
Note at the moment this component is mostly for internal use and it requires you to:

10
docs/core/buttons-menu.component.md → docs/core/components/buttons-menu.component.md
View File

@@ -5,15 +5,15 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Buttons Menu Component](../../lib/core/buttons-menu/buttons-menu.component.ts "Defined in buttons-menu.component.ts")
# [Buttons Menu Component](../../../lib/core/buttons-menu/buttons-menu.component.ts "Defined in buttons-menu.component.ts")
Displays buttons on a responsive menu.
![adf-buttons-menu-desktop](../docassets/images/adf-buttons-menu-desktop.png)
![adf-buttons-menu-desktop](../../docassets/images/adf-buttons-menu-desktop.png)
## Basic Usage
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
Place the buttons for the menu inside this component's HTML tags.
They must use the following structure:
@@ -47,11 +47,11 @@ depending on the screen size:
**Desktop View**
![adf-buttons-menu-desktop](../docassets/images/adf-buttons-menu-desktop.png)
![adf-buttons-menu-desktop](../../docassets/images/adf-buttons-menu-desktop.png)
**Mobile View**
![adf-buttons-menu-mobile](../docassets/images/adf-buttons-menu-mobile.png)
![adf-buttons-menu-mobile](../../docassets/images/adf-buttons-menu-mobile.png)
The component has a property called `isMenuEmpty` that you can access from code. If this is
set to true then the component will not show an empty menu with no buttons defined.

44
docs/core/card-view.component.md → docs/core/components/card-view.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-05-09
---
# [Card View component](../../lib/core/card-view/components/card-view/card-view.component.ts "Defined in card-view.component.ts")
# [Card View component](../../../lib/core/card-view/components/card-view/card-view.component.ts "Defined in card-view.component.ts")
Displays a configurable property list renderer.
![adf-custom-view](../docassets/images/adf-custom-view.png)
![adf-custom-view](../../docassets/images/adf-custom-view.png)
## Basic Usage
@@ -98,11 +98,11 @@ Defining properties from Typescript:
| ---- | ---- | ------------- | ----------- |
| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. |
| editable | `boolean` | | Toggles whether or not the items can be edited. |
| properties | [`CardViewItem`](../../lib/core/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. |
| properties | [`CardViewItem`](../../../lib/core/card-view/interfaces/card-view-item.interface.ts)`[]` | | (**required**) Items to show in the card view. |
## Details
You define the property list, the [`CardViewComponent`](../core/card-view.component.md) does the rest. Each property represents a card view item (a row) in the [card view component](../core/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_
- [**CardViewMapItemModel**](#card-map-item) - _for map items_
@@ -114,7 +114,7 @@ You define the property list, the [`CardViewComponent`](../core/card-view.compon
- [**CardViewKeyValuePairsItemModel**](#card-key-value-pairs-item) - _for key-value-pairs items_
- [**CardViewSelectItemModel**](#card-select-item) - _for select items_
Each of these types implements the [Card View Item interface](card-view-item.interface.md):
Each of these types implements the [Card View Item interface](../interfaces/card-view-item.interface.md):
```ts
export interface CardViewItem {
@@ -130,7 +130,7 @@ export interface CardViewItem {
```
You can also define your own item types. See the
[Card View Item interface](card-view-item.interface.md) page for details of how to do
[Card View Item interface](../interfaces/card-view-item.interface.md) page for details of how to do
this.
### Editing
@@ -139,12 +139,12 @@ You can optionally set up the card view so that its properties can be edited. Yo
the editing of properties at two levels:
- **Global level** - _via the editable parameter of the card-view.component_
- **[`Property`](../../lib/content-services/content-metadata/interfaces/property.interface.ts) level** - _in each property via the editable attribute_
- **[`Property`](../../../lib/content-services/content-metadata/interfaces/property.interface.ts) level** - _in each property via the editable attribute_
If you set the global editable parameter to false, no properties can be edited regardless of their
individual `editable` settings.
See the [Card View Update service](card-view-update.service.md)
See the [Card View Update service](../services/card-view-update.service.md)
page for details of how to use the service to respond to clicks and edits in a card view.
You can use this, for example, to save the edits within your application or to highlight a
clicked item.
@@ -153,12 +153,12 @@ clicked item.
The `properties` array contains instances of models that represent the layout of the Card View.
The ordering of the models in the array matches the ordering of items in the view. Each of the
models extends the abstract [`CardViewBaseItemModel`](../../lib/core/card-view/models/card-view-baseitem.model.ts) class to add functionality for
models extends the abstract [`CardViewBaseItemModel`](../../../lib/core/card-view/models/card-view-baseitem.model.ts) class to add functionality for
specific data types, as described below.
#### Card Text Item
[`CardViewTextItemModel`](../../lib/core/card-view/models/card-view-textitem.model.ts) is a property type for text properties.
[`CardViewTextItemModel`](../../../lib/core/card-view/models/card-view-textitem.model.ts) is a property type for text properties.
```ts
const textItemProperty = new CardViewTextItemModel(options);
@@ -175,7 +175,7 @@ const textItemProperty = new CardViewTextItemModel(options);
| clickable | boolean | false | Toggles whether the property responds to clicks |
| icon | string | | The material icon to show beside the item if it is clickable |
| multiline | boolean | false | Single or multiline text |
| pipes | [`CardViewTextItemPipeProperty`](../../lib/core/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display |
| pipes | [`CardViewTextItemPipeProperty`](../../../lib/core/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display |
##### Using pipes with a Card Text Item
@@ -199,7 +199,7 @@ new CardViewTextItemModel({
#### Card Map Item
[`CardViewMapItemModel`](../../lib/core/card-view/models/card-view-mapitem.model.ts) is a property type for map properties.
[`CardViewMapItemModel`](../../../lib/core/card-view/models/card-view-mapitem.model.ts) is a property type for map properties.
```ts
const mapItemProperty = new CardViewMapItemModel(options);
@@ -216,7 +216,7 @@ const mapItemProperty = new CardViewMapItemModel(options);
#### Card Date Item
[`CardViewDateItemModel`](../../lib/core/card-view/models/card-view-dateitem.model.ts) is a property type for date properties.
[`CardViewDateItemModel`](../../../lib/core/card-view/models/card-view-dateitem.model.ts) is a property type for date properties.
```ts
const dateItemProperty = new CardViewDateItemModel(options);
@@ -234,7 +234,7 @@ const dateItemProperty = new CardViewDateItemModel(options);
#### Card Datetime Item
[`CardViewDatetimeItemModel`](../../lib/core/card-view/models/card-view-datetimeitem.model.ts) is a property type for datetime properties.
[`CardViewDatetimeItemModel`](../../../lib/core/card-view/models/card-view-datetimeitem.model.ts) is a property type for datetime properties.
```ts
const datetimeItemProperty = new CardViewDatetimeItemModel(options);
@@ -252,7 +252,7 @@ const datetimeItemProperty = new CardViewDatetimeItemModel(options);
#### Card Bool Item
[`CardViewBoolItemModel`](../../lib/core/card-view/models/card-view-boolitem.model.ts) is a property type for boolean properties.
[`CardViewBoolItemModel`](../../../lib/core/card-view/models/card-view-boolitem.model.ts) is a property type for boolean properties.
```ts
const boolItemProperty = new CardViewBoolItemModel(options);
@@ -269,7 +269,7 @@ const boolItemProperty = new CardViewBoolItemModel(options);
#### Card Int Item
[`CardViewIntItemModel`](../../lib/core/card-view/models/card-view-intitem.model.ts) is a property type for integer properties.
[`CardViewIntItemModel`](../../../lib/core/card-view/models/card-view-intitem.model.ts) is a property type for integer properties.
```ts
const intItemProperty = new CardViewIntItemModel(options);
@@ -286,7 +286,7 @@ const intItemProperty = new CardViewIntItemModel(options);
#### Card Float Item
[`CardViewFloatItemModel`](../../lib/core/card-view/models/card-view-floatitem.model.ts) is a property type for float properties.
[`CardViewFloatItemModel`](../../../lib/core/card-view/models/card-view-floatitem.model.ts) is a property type for float properties.
```ts
const floatItemProperty = new CardViewFloatItemModel(options);
@@ -303,7 +303,7 @@ const floatItemProperty = new CardViewFloatItemModel(options);
#### Card Key Value Pairs Item
[`CardViewKeyValuePairsItemModel`](../../lib/core/card-view/models/card-view-keyvaluepairs.model.ts) is a property type for key-value properties.
[`CardViewKeyValuePairsItemModel`](../../../lib/core/card-view/models/card-view-keyvaluepairs.model.ts) is a property type for key-value properties.
```ts
const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options);
@@ -318,7 +318,7 @@ const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options);
#### Card Select Item
[`CardViewSelectItemModel`](../../lib/core/card-view/models/card-view-selectitem.model.ts) is a property type for select properties.
[`CardViewSelectItemModel`](../../../lib/core/card-view/models/card-view-selectitem.model.ts) is a property type for select properties.
```ts
const selectItemProperty = new CardViewSelectItemModel(options);
@@ -330,9 +330,9 @@ const selectItemProperty = new CardViewSelectItemModel(options);
| key\* | string | | Identifying key (important when editing the item) |
| editable | boolean | false | Toggles whether the item is editable |
| value | string | | The original data value for the item |
| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)&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)&lt;[`CardViewSelectItemOption`](../../../lib/core/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item |
## See also
- [Card View Update service](card-view-update.service.md)
- [Card View Item interface](card-view-item.interface.md)
- [Card View Update service](../services/card-view-update.service.md)
- [Card View Item interface](../interfaces/card-view-item.interface.md)

10
docs/core/comment-list.component.md → docs/core/components/comment-list.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-14
---
# [Comment list component](../../lib/core/comments/comment-list.component.ts "Defined in comment-list.component.ts")
# [Comment list component](../../../lib/core/comments/comment-list.component.ts "Defined in comment-list.component.ts")
Shows a list of comments.
![ADF Comment List](../docassets/images/adf-comment-list.png)
![ADF Comment List](../../docassets/images/adf-comment-list.png)
## Basic Usage
@@ -50,7 +50,7 @@ export class SomeComponent implements OnInit {
}
```
In the component template use the [comment list component](../core/comment-list.component.md):
In the component template use the [comment list component](comment-list.component.md):
```html
<adf-comment-list
@@ -65,10 +65,10 @@ In the component template use the [comment list component](../core/comment-list.
| 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
| 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. |

4
docs/core/comments.component.md → docs/core/components/comments.component.md
View File

@@ -4,11 +4,11 @@ Added: v2.0.0
Status: Active
---
# [Comments Component](../../lib/core/comments/comments.component.ts "Defined in comments.component.ts")
# [Comments Component](../../../lib/core/comments/comments.component.ts "Defined in comments.component.ts")
Displays comments from users involved in a specified task or content and allows an involved user to add a comment to a task or a content.
![adf-comments](../docassets/images/adf-comments.png)
![adf-comments](../../docassets/images/adf-comments.png)
## Basic Usage Task

26
docs/core/data-column.component.md → docs/core/components/data-column.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-12
---
# [Data Column Component](../../lib/core/data-column/data-column.component.ts "Defined in data-column.component.ts")
# [Data Column Component](../../../lib/core/data-column/data-column.component.ts "Defined in data-column.component.ts")
Defines column properties for DataTable, Tasklist, Document List and other components.
@@ -68,7 +68,7 @@ You can use `ngIf` directives to provide conditional visibility support for the
### Automatic column header translation
You can use i18n resource keys with the
[`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) `title` property.
[`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) `title` property.
The component will automatically check the appropriate i18n resources and fetch the corresponding value.
```html
@@ -121,9 +121,9 @@ Every cell in the DataTable component is bound to the dynamic data context conta
| Name | Type | Description |
| ---- | ---- | ----------- |
| data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | Data adapter instance. |
| row | [`DataRow`](../../lib/core/datatable/data/data-row.model.ts) | Current data row instance. |
| col | [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) | Current data column instance. |
| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | Data adapter instance. |
| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | Current data row instance. |
| col | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | Current data column instance. |
You can use all three properties to gain full access to underlying data from within your custom templates.
In order to wire HTML templates with the data context you will need to define a variable that is bound to `$implicit` as shown below:
@@ -136,7 +136,7 @@ In order to wire HTML templates with the data context you will need to define a
The name format is `let-VARIABLE_NAME="$implicit"` where `VARIABLE_NAME` is the name of the variable you want to bind the template data context to.
You can also get a cell value from the underlying [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts):
You can also get a cell value from the underlying [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts):
```ts
context.data.getValue(entry.row, entry.col);
@@ -180,7 +180,7 @@ In the Example below we will prepend `Hi!` to each file and folder name in the l
<!-- {% endraw %} -->
In the Example below we will integrate the [adf-tag-node-list](../content-services/tag-node-list.component.md) component
In the Example below we will integrate the [adf-tag-node-list](../../content-services/tag-node-list.component.md) component
within the document list.
<!-- {% raw %} -->
@@ -199,7 +199,7 @@ within the document list.
<!-- {% endraw %} -->
![Tag component in document List](../docassets/images/document-list-tag-template.png)
![Tag component in document List](../../docassets/images/document-list-tag-template.png)
### Styling Techniques
@@ -238,7 +238,7 @@ adf-document-list ::ng-deep adf-datatable > table > tbody > tr.is-selected > td.
Once your application starts you should see the following icon for each selected row:
![view-child](../docassets/images/document-list-custom-icon.png)
![view-child](../../docassets/images/document-list-custom-icon.png)
#### Hiding columns on small screens
@@ -292,14 +292,14 @@ Now you can declare columns and assign the `desktop-only` class where needed:
**Desktop View**
![Responsive Desktop](../docassets/images/responsive-desktop.png)
![Responsive Desktop](../../docassets/images/responsive-desktop.png)
**Mobile View**
![Responsive Mobile](../docassets/images/responsive-mobile.png)
![Responsive Mobile](../../docassets/images/responsive-mobile.png)
## See also
- [Document list component](../content-services/document-list.component.md)
- [Document list component](../../content-services/document-list.component.md)
- [Datatable component](datatable.component.md)
- [Task list component](../process-services/task-list.component.md)
- [Task list component](../../process-services/components/task-list.component.md)

63
docs/core/datatable.component.md → docs/core/components/datatable.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-12
---
# [DataTable component](../../lib/core/datatable/components/datatable/datatable.component.ts "Defined in datatable.component.ts")
# [DataTable component](../../../lib/core/datatable/components/datatable/datatable.component.ts "Defined in datatable.component.ts")
Displays data as a table with customizable columns and presentation.
![DataTable demo](../docassets/images/datatable-demo.png)
![DataTable demo](../../docassets/images/datatable-demo.png)
See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/)
@@ -28,11 +28,15 @@ See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/
- [Card view](#card-view)
- [Using events](#using-events)
- [Customizing the component's styles](#customizing-the-components-styles)
- [Truncated text](#truncated-text)
- [Expanded cells](#expanded-cells)
- [Combining classes](#combining-classes)
- [Sticky header](#sticky-header)
- [See also](#see-also)
## Basic usage
**[app.component](../../demo-shell/src/app/app.component.ts).html**
**app.component.html**
```html
<adf-datatable
@@ -40,7 +44,7 @@ See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/
</adf-datatable>
```
**[app.component](../../demo-shell/src/app/app.component.ts).ts**
**app.component.ts**
```ts
import { ObjectDataTableAdapter } from '@alfresco/adf-core';
@@ -79,7 +83,7 @@ export class DataTableDemo {
### Setting the rows and column schema
You can set rows and columns in the [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) as shown below:
You can set rows and columns in the [`ObjectDataTableAdapter`](../../../lib/core/datatable/data/object-datatable-adapter.ts) as shown below:
```ts
import { ObjectDataTableAdapter } from '@alfresco/adf-core';
@@ -156,7 +160,7 @@ export class DataTableDemo {
</adf-datatable>
```
You can also set rows to the [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) and set columns as an input as shown below :
You can also set rows to the [`ObjectDataTableAdapter`](../../../lib/core/datatable/data/object-datatable-adapter.ts) and set columns as an input as shown below :
```ts
import { ObjectDataTableAdapter } from '@alfresco/adf-core';
@@ -246,7 +250,7 @@ export class DataTableDemo {
</adf-datatable>
```
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
You can add [Data column component](data-column.component.md) instances to define columns for the
table as described in the usage examples and the [Customizing columns](#customizing-columns) section.
@@ -311,10 +315,10 @@ together in the same datatable.
| ---- | ---- | ------------- | ----------- |
| actions | `boolean` | false | Toggles the data actions column. |
| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". |
| allowDropFiles | `boolean` | false | Toggles file drop support for rows (see [Upload directive](upload.directive.md) for further details). |
| allowDropFiles | `boolean` | false | Toggles file drop support for rows (see [Upload directive](../directives/upload.directive.md) for further details). |
| columns | `any[]` | \[] | The columns that the datatable will show. |
| contextMenu | `boolean` | false | Toggles custom context menu for the component. |
| data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | | Data source for the table |
| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source for the table |
| display | `string` | DisplayMode.List | Selects the display mode of the table. Can be "list" or "gallery". |
| fallbackThumbnail | `string` | | Fallback image for rows where the thumbnail is missing. |
| loading | `boolean` | false | Flag that indicates if the datatable is in loading state and needs to show the loading template (see the docs to learn how to configure a loading template). |
@@ -327,27 +331,27 @@ together in the same datatable.
| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| showHeader | `boolean` | true | Toggles the header. |
| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : [`created`, `desc`], [`created`, `asc`], [`due`, `desc`], [`due`, `asc`] |
| stickyHeader | `boolean` | false | Toggles a sticky (fixed) header that stays in place while the rows become scrollable. [Sticky header](#sticky-header)|
| stickyHeader | `boolean` | false | Toggles the sticky header mode. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../lib/core/datatable/components/datatable/data-row-action.event.ts)`>` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. |
| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. |
| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. |
| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/datatable/data-row-action.event.ts)`>` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. |
| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. |
| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. |
## Details
### Supplying data for the table
The column layout and row data are supplied to the table using an object that implements the
[`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) interface. This interface hides the internal details of the class that provides
[`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) interface. This interface hides the internal details of the class that provides
the data, which gives a lot of flexibility in how the data can be stored and accessed. The DataTable
library includes a standard adapter class called [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) that is useful in many
common cases. See the [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) for full details about the interface and the [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) class.
library includes a standard adapter class called [`ObjectDataTableAdapter`](../../../lib/core/datatable/data/object-datatable-adapter.ts) that is useful in many
common cases. See the [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) for full details about the interface and the [`ObjectDataTableAdapter`](../../../lib/core/datatable/data/object-datatable-adapter.ts) class.
### Customizing columns
@@ -384,7 +388,7 @@ onRowClick(event) {
}
```
![](../docassets/images/datatable-dom-events.png)
![](../../docassets/images/datatable-dom-events.png)
### Card view
@@ -397,7 +401,7 @@ Set the `display` property to "gallery" to enable Card View mode:
</adf-datatable
```
![card-view](../docassets/images/document-list-card-view.png)
![card-view](../../docassets/images/document-list-card-view.png)
### Using events
@@ -552,9 +556,9 @@ onExecuteRowAction(event: DataRowActionEvent) {
}
```
![](../docassets/images/datatable-actions-ui.png)
![](../../docassets/images/datatable-actions-ui.png)
![](../docassets/images/datatable-actions-console.png)
![](../../docassets/images/datatable-actions-console.png)
You can use any payloads for row actions. The only requirement for the objects is that they
must have a `title` property.
@@ -571,7 +575,7 @@ The datatable component is ready to be used out of the box although you might wa
By default, the content of the cells is wrapped so you can see all the data inside. See picture bellow.
![](../docassets/images/datatable-wrapped-text.png)
![](../../docassets/images/datatable-wrapped-text.png)
However, you can also truncate the text within these cells by using the `adf-ellipsis-cell` class in the desired column.
@@ -585,17 +589,16 @@ However, you can also truncate the text within these cells by using the `adf-ell
}
```
![](../docassets/images/datatable-truncated-text.png)
![](../../docassets/images/datatable-truncated-text.png)
### Expanded cells
This component makes use of a flex layout. All cells have the same semantic importance, so all of them have the same width. You can alter this behavior by adding one of the following classes in the desired column to make it grow wider.
![](../docassets/images/datatable-expand-5.png)
![](../../docassets/images/datatable-expand-5.png)
This classes go from `adf-expand-cell-1` to `adf-expand-cell-5`. The higher the number in the class the wider the column will get. You can choose the one that better suits your needs.
### Combining classes
All these classes can be combined together to fully fit your needs and make your datatable component look as you want.
@@ -609,8 +612,8 @@ All these classes can be combined together to fully fit your needs and make your
}
```
### Sticky header
If you have a long list of rows and you want to fix the header in place so you always see it you only have to follow this 2-step process.
First, you will need to set the stickyHeader property of your datatable to `true`:
@@ -635,11 +638,11 @@ Second and last, you will need to set the height of your datatable in its parent
Final result
![](../docassets/images/datatable-sticky-header.png)
![](../../docassets/images/datatable-sticky-header.png)
## See also
- [Data column component](data-column.component.md)
- [Pagination component](pagination.component.md)
- [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts)
- [Document list component](../content-services/document-list.component.md)
- [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts)
- [Document list component](../../content-services/document-list.component.md)

8
docs/core/empty-content.component.md → docs/core/components/empty-content.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-02-01
---
# [Empty Content Component](../../lib/core/templates/empty-content/empty-content.component.ts "Defined in empty-content.component.ts")
# [Empty Content Component](../../../lib/core/templates/empty-content/empty-content.component.ts "Defined in empty-content.component.ts")
Provides a generic "Empty Content" placeholder for components.
![Favorites screen](../docassets/images/empty-content-favorites.png)
![Favorites screen](../../docassets/images/empty-content-favorites.png)
## Basic usage
@@ -51,7 +51,7 @@ Provides a generic "Empty Content" placeholder for components.
</adf-document-list>
```
![Favorites screen](../docassets/images/empty-content-favorites.png)
![Favorites screen](../../docassets/images/empty-content-favorites.png)
You can also use multiple lines instead of the subtitle section:
@@ -68,7 +68,7 @@ You can also use multiple lines instead of the subtitle section:
</adf-document-list>
```
![Trashcan screen](../docassets/images/empty-content-trashcan.png)
![Trashcan screen](../../docassets/images/empty-content-trashcan.png)
## See also

6
docs/core/empty-list.component.md → docs/core/components/empty-list.component.md
View File

@@ -4,11 +4,11 @@ Added: v2.0.0
Status: Active
---
# [Empty list component](../../lib/core/datatable/components/datatable/empty-list.component.ts "Defined in empty-list.component.ts")
# [Empty list component](../../../lib/core/datatable/components/datatable/empty-list.component.ts "Defined in empty-list.component.ts")
Displays a message indicating that a list is empty.
![](../docassets/images/adf-empty-list.png)
![](../../docassets/images/adf-empty-list.png)
## Basic Usage
@@ -25,7 +25,7 @@ Displays a message indicating that a list is empty.
</adf-datatable>
```
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
You can supply a custom header, body, and footer for an empty list using special
sub-components:

4
docs/core/error-content.component.md → docs/core/components/error-content.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-09-13
---
# [Error Content Component](../../lib/core/templates/error-content/error-content.component.ts "Defined in error-content.component.ts")
# [Error Content Component](../../../lib/core/templates/error-content/error-content.component.ts "Defined in error-content.component.ts")
Displays info about a specific error.
@@ -23,7 +23,7 @@ this.router.navigate(['/error', errorCode]);
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| errorCode | `string` | | Error code associated with this error. |
| errorCode | `string` | "UNKNOWN" | Error code associated with this error. |
| returnButtonUrl | `string` | "/" | Target URL for the return button. |
| secondaryButtonUrl | `string` | "report-issue" | Target URL for the secondary button. |

61
docs/core/components/form-field.component.md Normal file
View File

@@ -0,0 +1,61 @@
---
Title: Form field component
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-20
---
# [Form field component](../../../lib/core/form/components/form-field/form-field.component.ts "Defined in form-field.component.ts")
Represents a UI field in a form.
## Basic Usage
All form field editors (aka widgets) on a [`Form`](../../../lib/process-services/task-list/models/form.model.ts) are rendered by means of a [`FormFieldComponent`](../../core/components/form-field.component.md)
that takes an instance of a [`FormFieldModel`](../../core/models/form-field.model.md):
```html
<adf-form-field [field]="field"></adf-form-field>
```
This component depends on the [`FormRenderingService`](../../core/services/form-rendering.service.md) to map the [`FormFieldModel`](../../core/models/form-field.model.md) to a [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Field UI component
based on the field type or the metadata information.
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the [`FormFieldModel`](../../core/models/form-field.model.md) definitions. |
## Details
You would typically not use this component directly but instead use the `<adf-form>` component, which under the hood
uses `<adf-form-field>` components to render the form fields.
### Field Type -> Form Field Component mappings
Forms defined in APS have the following default mappings for the form fields:
| _APS [Form](../../../lib/process-services/task-list/models/form.model.ts) Designer_ Widget | Field Type | Component Type |
| ------------------------------------------------------------------------------------------ | ---------- | -------------- |
| Text | text | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
| Number | integer | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) |
| Checkbox | boolean | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
| Date | date | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) |
| Dropdown | dropdown | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
| Amount | amount | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) |
| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
| People | people | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) |
| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
| Header | group | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) |
| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
| Display value | readonly | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
| Display text | readonly-text | [`DisplayTextWidgetComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
| N/A | container | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) |
| N/A | N/A | [`UnknownWidgetComponent`](../../../lib/core/form/components/widgets/unknown/unknown.widget.ts) |

2
docs/core/form-list.component.md → docs/core/components/form-list.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Form List Component](../../lib/core/form/components/form-list.component.ts "Defined in form-list.component.ts")
# [Form List Component](../../../lib/core/form/components/form-list.component.ts "Defined in form-list.component.ts")
Shows forms as a list.

58
docs/core/form.component.md → docs/core/components/form.component.md
View File

@@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Form component](../../lib/core/form/components/form.component.ts "Defined in form.component.ts")
# [Form component](../../../lib/core/form/components/form.component.ts "Defined in form.component.ts")
Shows a [`Form`](../../lib/process-services/task-list/models/form.model.ts) from APS
Shows a [`Form`](../../../lib/process-services/task-list/models/form.model.ts) from APS
(See it live: [Form Quickstart](https://embed.plnkr.co/YSLXTqb3DtMhVJSqXKkE/))
@@ -34,7 +34,7 @@ Shows a [`Form`](../../lib/process-services/task-list/models/form.model.ts) from
</adf-form>
```
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
Any content in the body of `<adf-form>` will be shown when no form definition is found:
@@ -54,11 +54,11 @@ Any content in the body of `<adf-form>` will be shown when no form definition is
| 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. |
| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. |
| fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. |
| form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. |
| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. |
| form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../../lib/core/form/components/widgets/core/form.model.ts) instance. |
| formId | `number` | | The id of the form definition to load and display with custom values. |
| formName | `string` | | Name of the form definition to load and display with custom values. |
| nameNode | `string` | | Name to assign to the new node where the metadata are stored. |
@@ -79,17 +79,17 @@ Any content in the body of `<adf-form>` will be shown when no form definition is
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. |
| formDataRefreshed | [`EventEmitter`](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/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. |
| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. |
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
## Details
All `formXXX` events receive a [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) instance as their argument:
All `formXXX` events receive a [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) instance as their argument:
**MyView.component.html**
@@ -178,7 +178,7 @@ The `nameNode` parameter is optional.
</adf-form>
```
Here, the node metadata is shown in an APS [Form,](../../lib/process-services/task-list/models/form.model.ts)
Here, the node metadata is shown in an APS [`Form`](../../../lib/process-services/task-list/models/form.model.ts)
with the form fields themselves saved as metadata. The `nameNode` parameter is optional.
### Controlling outcome execution behaviour
@@ -238,13 +238,13 @@ property. Each validator implements a check for a particular type of data (eg, a
date validator might check that the date in the field falls between 1980 and 2017).
ADF supplies a standard set of validators that handle most common cases but you can
also implement your own custom validators to replace or extend the set. See the
[Form Field Validator](form-field-validator.interface.md) interface for full details and examples.
[Form Field Validator](../interfaces/form-field-validator.interface.md) interface for full details and examples.
### Common scenarios
#### Rendering a form using form definition JSON
See the [demo-form](../docassets/demo-form.json) file for an example of form definition JSON.
See the [demo-form](../../docassets/demo-form.json) file for an example of form definition JSON.
The component below (with the JSON assigned to the `formDefinitionJSON` property), shows how a
form definition is rendered:
@@ -279,7 +279,7 @@ could use this, say, to provide two alternative ways of entering the same inform
up default values that can be edited.
You can implement this in ADF using the `formFieldValueChanged` event of the
[Form service](form.service.md). For example, if you had a form with a dropdown widget (id: `type`)
[Form service](../services/form.service.md). For example, if you had a form with a dropdown widget (id: `type`)
and a multiline text (id:`description`), you could synchronize their values as follows:
```ts
@@ -301,11 +301,11 @@ to its `value` property.
The result should look like the following:
![](../docassets/images/form-service-sample-01.png)
![](../../docassets/images/form-service-sample-01.png)
#### Responding to all form events
Subscribe to the `formEvents` event of the [Form service](form.service.md) to get notification
Subscribe to the `formEvents` event of the [Form service](../services/form.service.md) to get notification
of all form events:
```ts
@@ -342,14 +342,14 @@ In the CSS, you can target any outcome ID and change the style as in this exampl
}
```
![](../docassets/images/form-style-sample.png)
![](../../docassets/images/form-style-sample.png)
### Alfresco Repositories APS configuration
APS allows you to configure where to store files and folders in your on-site Alfresco repositories.
If you have your repositories configured like this, you can use the attach file/folder
form widget to get a file from those repositories and attach it to the Form.
form widget to get a file from those repositories and attach it to the [`Form`](../../../lib/process-services/task-list/models/form.model.ts).
**Note:** your repositories could be configured to be on different servers from the one
where your front-end is deployed. Make sure you are using the right Proxy or configuration,
@@ -357,14 +357,12 @@ otherwise you will get a cross-origin resource sharing (CORS) error.
Also, don't forget to set the `providers` property to `ALL` in the `app.config.json` login configuration:
```
"providers": "ALL",
```
"providers": "ALL",
## See also
- [Form Field Validator interface](form-field-validator.interface.md)
- [Extensibility](../user-guide/extensibility.md)
- [Form rendering service](form-rendering.service.md)
- [Form field model](form-field.model.md)
- [Form service](form.service.md)
- [Form Field Validator interface](../interfaces/form-field-validator.interface.md)
- [Extensibility](../../user-guide/extensibility.md)
- [Form rendering service](../services/form-rendering.service.md)
- [Form field model](../models/form-field.model.md)
- [Form service](../services/form.service.md)

4
docs/core/header.component.md → docs/core/components/header.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Header component](../../lib/core/layout/components/header/header.component.ts "Defined in header.component.ts")
# [Header component](../../../lib/core/layout/components/header/header.component.ts "Defined in header.component.ts")
Reusable header for Alfresco applications.
@@ -21,7 +21,7 @@ Reusable header for Alfresco applications.
</adf-layout-header>
```
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
The right-hand side of the header has free-form content that you supply in the
body of the element:

4
docs/core/host-settings.component.md → docs/core/components/host-settings.component.md
View File

@@ -5,13 +5,13 @@ Status: Internal
Last reviewed: 2019-01-16
---
# [Host settings component](../../lib/core/settings/host-settings.component.ts "Defined in host-settings.component.ts")
# [Host settings component](../../../lib/core/settings/host-settings.component.ts "Defined in host-settings.component.ts")
Validates the URLs for ACS and APS and saves them in the user's local storage
**Note:** this is an internal component and is not meant to be used in production.
![Host settings](../docassets/images/host-settings-component.png)
![Host settings](../../docassets/images/host-settings-component.png)
## Basic Usage

6
docs/core/icon.component.md → docs/core/components/icon.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-02-08
---
# [Icon Component](../../lib/core/icon/icon.component.ts "Defined in icon.component.ts")
# [Icon Component](../../../lib/core/icon/icon.component.ts "Defined in icon.component.ts")
Provides a universal way of rendering registered and named icons.
@@ -71,7 +71,7 @@ In the HTML, you can now use the icon as shown below:
### Thumbnail Service
You can also reference the icons registered with the [Thumbnail Service](thumbnail.service.md)
You can also reference the icons registered with the [Thumbnail Service](../services/thumbnail.service.md)
using the `adf:` namespace.
```html
@@ -80,4 +80,4 @@ using the `adf:` namespace.
## See also
- [Thumbnail service](../core/thumbnail.service.md)
- [Thumbnail service](../services/thumbnail.service.md)

14
docs/core/infinite-pagination.component.md → docs/core/components/infinite-pagination.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-02-08
---
# [Infinite Pagination component](../../lib/core/pagination/infinite-pagination.component.ts "Defined in infinite-pagination.component.ts")
# [Infinite Pagination component](../../../lib/core/pagination/infinite-pagination.component.ts "Defined in infinite-pagination.component.ts")
Adds "infinite" pagination to the component it is used with.
![Infinite Pagination screenshot](../docassets/images/InfPagination.png)
![Infinite Pagination screenshot](../../docassets/images/InfPagination.png)
## Basic Usage
@@ -40,24 +40,24 @@ Adds "infinite" pagination to the component it is used with.
| ---- | ---- | ------------- | ----------- |
| isLoading | `boolean` | false | Is a new page loading? |
| pageSize | `number` | | Number of items that are added with each "load more" event. |
| target | [`PaginatedComponent`](../../lib/core/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. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RequestPaginationModel`](../../lib/core/models/request-pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. |
| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RequestPaginationModel`](../../../lib/core/models/request-pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. |
## Details
[`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) is the process of dividing a list into separate ranges or "pages" with a
[`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) is the process of dividing a list into separate ranges or "pages" with a
certain number of items each. This allows a long list to be delivered in manageable pieces
rather than all at once. "Infinite" pagination means that there is no upper limit on
the number of items that can be displayed visually; a single page is shown initially but
the user can extend the list one page at a time by clicking a "Load More" button.
The `loadMore` event is emitted when the button is pressed. It is passed a
[`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts)
[`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts)
parameter which contains the details of the current page (the start offset of the
page within the list to be shown, whether there are more items left to show, etc).
@@ -65,5 +65,5 @@ See the [Pagination component](pagination.component.md) for more information abo
## See also
- [Document list component](../content-services/document-list.component.md)
- [Document list component](../../content-services/document-list.component.md)
- [Pagination component](pagination.component.md)

9
docs/core/info-drawer-layout.component.md → docs/core/components/info-drawer-layout.component.md
View File

@@ -5,15 +5,15 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Info drawer layout component](../../lib/core/info-drawer/info-drawer-layout.component.ts "Defined in info-drawer-layout.component.ts")
# [Info drawer layout component](../../../lib/core/info-drawer/info-drawer-layout.component.ts "Defined in info-drawer-layout.component.ts")
Displays a sidebar-style information panel.
![Info drawer layout screenshot](../docassets/images/infodrawerlayout.png)
![Info drawer layout screenshot](../../docassets/images/infodrawerlayout.png)
## Basic usage
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
There are three regions where you can add your own content using `<div>` elements
with the following names:
@@ -42,8 +42,9 @@ with the following names:
As the name suggests, this is basically just a layout with CSS styling.
See the [Info drawer layout component](../core/info-drawer-layout.component.md) for an alternative approach that uses tabs to structure the content of the info drawer.
See the [Info drawer tab component](info-drawer-tab.component.md) for an alternative approach that uses tabs to structure the content of the info drawer.
## See also
- [Info drawer component](info-drawer.component.md)
- [Info drawer tab component](info-drawer-tab.component.md)

10
docs/core/info-drawer-tab.component.md → docs/core/components/info-drawer-tab.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Info Drawer Tab component](../../lib/core/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts")
# [Info Drawer Tab component](../../../lib/core/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts")
Renders tabs in a [Info drawer component](../core/info-drawer.component.md).
Renders tabs in a [Info drawer component](info-drawer.component.md).
![Info drawer screenshot](../docassets/images/label-tab.png)
![Info drawer screenshot](../../docassets/images/label-tab.png)
## Basic usage
@@ -44,7 +44,7 @@ Render tab with icon instead of labels:
</adf-info-drawer>
```
![Info drawer screenshot](../docassets/images/icon-tab.png)
![Info drawer screenshot](../../docassets/images/icon-tab.png)
## Class members
@@ -57,7 +57,7 @@ Render tab with icon instead of labels:
## Details
See the [Info drawer component](../core/info-drawer.component.md) page for details of how to use this subcomponent.
See the [Info drawer component](info-drawer.component.md) page for details of how to use this subcomponent.
## See also

6
docs/core/info-drawer.component.md → docs/core/components/info-drawer.component.md
View File

@@ -5,15 +5,15 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Info Drawer component](../../lib/core/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts")
# [Info Drawer component](../../../lib/core/info-drawer/info-drawer.component.ts "Defined in info-drawer.component.ts")
Displays a sidebar-style information panel with tabs.
![Info drawer screenshot](../docassets/images/activities-infodrawer.png)
![Info drawer screenshot](../../docassets/images/activities-infodrawer.png)
## Basic usage
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
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)):

12
docs/core/language-menu.component.md → docs/core/components/language-menu.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-09
---
# [Language Menu component](../../lib/core/language-menu/language-menu.component.ts "Defined in language-menu.component.ts")
# [Language Menu component](../../../lib/core/language-menu/language-menu.component.ts "Defined in language-menu.component.ts")
Displays all the languages that are present in "app.config.json" and the default (EN).
![Language Menu screenshot](../docassets/images/languages-menu.png)
![Language Menu screenshot](../../docassets/images/languages-menu.png)
## Basic usage
@@ -26,10 +26,10 @@ How to attach an ADF Language Menu as a main menu
## Details
Add a [Language Menu component](../core/language-menu.component.md) to let the
Add a [Language Menu component](language-menu.component.md) to let the
user set the locale language for the app. For further information about the
locale language, see the
[Internationalization](../user-guide/internationalization.md#how-the-display-language-is-selected)
[Internationalization](../../user-guide/internationalization.md#how-the-display-language-is-selected)
page in the user guide.
The component fetches the list of available languages from `app.config.json`:
@@ -71,8 +71,8 @@ You can also attach the Language Menu as a nested menu:
</mat-menu>
```
![Nested Language Menu screenshot](../docassets/images/languages-menu-nested.png)
![Nested Language Menu screenshot](../../docassets/images/languages-menu-nested.png)
## See Also
- [Internationalization](../user-guide/internationalization.md)
- [Internationalization](../../user-guide/internationalization.md)

8
docs/core/login-dialog-panel.component.md → docs/core/components/login-dialog-panel.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-10-02
---
# [Login Dialog Panel component](../../lib/core/login/components/login-dialog-panel.component.ts "Defined in login-dialog-panel.component.ts")
# [Login Dialog Panel component](../../../lib/core/login/components/login-dialog-panel.component.ts "Defined in login-dialog-panel.component.ts")
Shows and manages a login dialog.
@@ -15,13 +15,13 @@ Shows and manages a login dialog.
| Name | Type | Description |
| ---- | ---- | ----------- |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. |
## Details
This component has similar features to the [Login Dialog component](../core/login-dialog.component.md)
This component has similar features to the [Login Dialog component](login-dialog.component.md)
but it also creates and manages the dialog for you.
## See also
- [Login Dialog component](../core/login-dialog.component.md)
- [Login Dialog component](login-dialog.component.md)

12
docs/core/login-dialog.component.md → docs/core/components/login-dialog.component.md
View File

@@ -5,20 +5,20 @@ Status: Active
Last reviewed: 2018-10-02
---
# [Login Dialog component](../../lib/core/login/components/login-dialog.component.ts "Defined in login-dialog.component.ts")
# [Login Dialog component](../../../lib/core/login/components/login-dialog.component.ts "Defined in login-dialog.component.ts")
Allows a user to perform a login via a dialog.
## Details
The [Login Dialog component](../core/login-dialog.component.md) allows you to perform a login via a dialog.
The [Login Dialog component](login-dialog.component.md) allows you to perform a login via a dialog.
### Showing the dialog
Unlike most components, the [Login Dialog Component](../core/login-dialog.component.md) is typically shown in a dialog box
Unlike most components, the [Login Dialog Component](login-dialog.component.md) is typically shown in a dialog box
rather than the main page and you are responsible for opening the dialog yourself. You can use the
[Angular Material Dialog](https://material.angular.io/components/dialog/overview) for this,
as shown in the usage example. ADF provides the [`LoginDialogComponentData`](../../lib/core/login/components/login-dialog-component-data.interface.ts) interface
as shown in the usage example. ADF provides the [`LoginDialogComponentData`](../../../lib/core/login/components/login-dialog-component-data.interface.ts) interface
to work with the Dialog's
[data option](https://material.angular.io/components/dialog/overview#sharing-data-with-the-dialog-component-):
@@ -40,7 +40,7 @@ The properties are described in the table below:
If you don't want to manage the dialog yourself then it is easier to use the
[Login Dialog Panel component](login-dialog-panel.component.md), or the
methods of the [Login Dialog service](login-dialog.service.md), which create
methods of the [Login Dialog service](../services/login-dialog.service.md), which create
the dialog for you.
### Usage example
@@ -81,7 +81,7 @@ openLoginDialog() {
}
```
All the results will be streamed to the logged [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present in the [`LoginDialogComponentData`](../../lib/core/login/components/login-dialog-component-data.interface.ts) object passed to the dialog.
All the results will be streamed to the logged [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present in the [`LoginDialogComponentData`](../../../lib/core/login/components/login-dialog-component-data.interface.ts) object passed to the dialog.
When the dialog action is selected by clicking, the `data.logged` stream will be completed.
## See also

28
docs/core/login.component.md → docs/core/components/login.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2019-02-06
---
# [Login component](../../lib/core/login/components/login.component.ts "Defined in login.component.ts")
# [Login component](../../../lib/core/login/components/login.component.ts "Defined in login.component.ts")
Authenticates to Alfresco Content Services and Alfresco Process Services.
![Login component](../docassets/images/login-extra-content.png)
![Login component](../../docassets/images/login-extra-content.png)
## Contents
@@ -36,9 +36,9 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
</adf-login>
```
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
You can replace the content of the header and footer of the [Login component](../core/login.component.md) with your own custom content:
You can replace the content of the header and footer of the [Login component](login.component.md) with your own custom content:
```html
<adf-login ...>
@@ -49,11 +49,11 @@ You can replace the content of the header and footer of the [Login component](..
Header:
![Login with custom header](../docassets/images/custom-header.png)
![Login with custom header](../../docassets/images/custom-header.png)
Footer:
![Login with custom footer](../docassets/images/custom-footer.png)
![Login with custom footer](../../docassets/images/custom-footer.png)
Also, any content that you put inside the `<adf-login>` tags will be rendered as part
of the Login dialog:
@@ -69,7 +69,7 @@ of the Login dialog:
This is useful if you need to extend the functionality of the dialog
with custom input fields handled by your application or parent component:
![Login with custom content](../docassets/images/login-extra-content.png)
![Login with custom content](../../docassets/images/login-extra-content.png)
## Class members
@@ -91,9 +91,9 @@ with custom input fields handled by your application or parent component:
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. |
| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. |
| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. |
## Details
@@ -135,7 +135,7 @@ You can change the logo and background images using the `backgroundImageUrl` and
</adf-login>
```
![Login with custom logo and background](../docassets/images/custom-login.png)
![Login with custom logo and background](../../docassets/images/custom-login.png)
You can also bind to your component properties and provide values dynamically if you need to:
@@ -272,7 +272,7 @@ will execute _after_ your custom code has completed.
#### Implicit Flow
If you used the host-setting component to enable SSO Oauth (or if you
enabled the setting in `app.config.json`) then the [login component](../core/login.component.md) will show only a button to login:
enabled the setting in `app.config.json`) then the [login component](login.component.md) will show only a button to login:
```JSON
{
@@ -291,7 +291,7 @@ enabled the setting in `app.config.json`) then the [login component](../core/log
}
```
![Login component](../docassets/images/sso-login.png)
![Login component](../../docassets/images/sso-login.png)
Note that if the `silentLogin` property in the `oauth2` configuration is set to true
then the login page will not be shown. Instead, the application will redirect
@@ -349,4 +349,4 @@ Setting the `withCredentials` property to true in the `auth` section of
## See Also
- [Logout directive](logout.directive.md)
- [Logout directive](../directives/logout.directive.md)

30
docs/core/pagination.component.md → docs/core/components/pagination.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Pagination Component](../../lib/core/pagination/pagination.component.ts "Defined in pagination.component.ts")
# [Pagination Component](../../../lib/core/pagination/pagination.component.ts "Defined in pagination.component.ts")
Adds pagination to the component it is used with.
![](../docassets/images/basic.png)
![](../../docassets/images/basic.png)
## Contents
@@ -42,26 +42,26 @@ Adds pagination to the component it is used with.
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| pagination | [`PaginationModel`](../../lib/core/models/pagination.model.ts) | | [Pagination](../../lib/content-services/document-list/models/document-library.model.ts) object. |
| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. |
| 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. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../lib/core/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. |
| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. |
| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../lib/core/models/pagination.model.ts)`>` | Emitted when the page size changes. |
| nextPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../lib/core/models/pagination.model.ts)`>` | Emitted when the next page is requested. |
| prevPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../lib/core/models/pagination.model.ts)`>` | Emitted when the previous page is requested. |
| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. |
| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. |
| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page size changes. |
| nextPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the next page is requested. |
| prevPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the previous page is requested. |
## Details
You can use the [`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) component to add pagination features to other components. The Alfresco
You can use the [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) component to add pagination features to other components. The Alfresco
APIs make use of pagination to reduce the amount of data transferred in a single call. The start offset
and number of items in the page are passed during the call. The items of interest will be
returned along with a [`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) object. You can use this object to set up the [pagination component](../core/pagination.component.md)
returned along with a [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) object. You can use this object to set up the [pagination component](pagination.component.md)
and then subscribe to one of the page change events. This will return updated pagination data that you
can pass to a subsequent API call.
@@ -69,7 +69,7 @@ Each event corresponds to a particular action from the user. For the `change` ev
PaginationQueryParams object is returned. This contains the query
parameters supported by the REST API, `skipCount` and `maxItems`.
For all events other than `change`, a new [`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) object is returned as in the following example. The
For all events other than `change`, a new [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) object is returned as in the following example. The
new object contains updated properties that you can use to fetch the next page of information.
### Integrating with the Document List component
@@ -84,7 +84,7 @@ new object contains updated properties that you can use to fetch the next page o
### Custom pagination
The component also makes it easy to integrate your own implementation of pagination.
You can supply any component that implements the [`PaginatedComponent`](../../lib/core/pagination/paginated-component.interface.ts) interface as the value of the
You can supply any component that implements the [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) interface as the value of the
`target` property.
```js
@@ -96,8 +96,8 @@ export interface PaginatedComponent {
}
```
Your component must provide a `pagination` subject to allow the [`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) component to respond to changes.
Every time user interacts with the [`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) component, it will call the `updatePagination` method
Your component must provide a `pagination` subject to allow the [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) component to respond to changes.
Every time user interacts with the [`Pagination`](../../../lib/content-services/document-list/models/document-library.model.ts) component, it will call the `updatePagination` method
and pass the updated parameters.
## See also

8
docs/core/sidebar-action-menu.component.md → docs/core/components/sidebar-action-menu.component.md
View File

@@ -5,16 +5,16 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Sidebar action menu component](../../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts "Defined in sidebar-action-menu.component.ts")
# [Sidebar action menu component](../../../lib/core/layout/components/sidebar-action/sidebar-action-menu.component.ts "Defined in sidebar-action-menu.component.ts")
Displays a sidebar-action menu information panel.
![Sidebar action menu button screenshot](../docassets/images/sidebar-action-menu-button.png)
![Sidebar action menu icon screenshot](../docassets/images/sidebar-action-menu-icon.png)
![Sidebar action menu button screenshot](../../docassets/images/sidebar-action-menu-button.png)
![Sidebar action menu icon screenshot](../../docassets/images/sidebar-action-menu-icon.png)
## Basic usage
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
There are three regions where you can add your own content in `<div>` elements with
the following names:

10
docs/core/sidenav-layout.component.md → docs/core/components/sidenav-layout.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Sidenav Layout component](../../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts "Defined in sidenav-layout.component.ts")
# [Sidenav Layout component](../../../lib/core/layout/components/sidenav-layout/sidenav-layout.component.ts "Defined in sidenav-layout.component.ts")
Displays the standard three-region ADF application layout.
![Sidenav on desktop](../docassets/images/sidenav-layout.png)
![Sidenav on desktop](../../docassets/images/sidenav-layout.png)
## Contents
@@ -25,7 +25,7 @@ Displays the standard three-region ADF application layout.
## Basic Usage
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
The content for the header, navigation area, and main content are transcluded using three special
sub-components (note the use of `<ng-template>` in the sub-components' body sections):
@@ -104,11 +104,11 @@ in the usage example above.
Desktop layout (screen width greater than the `stepOver` value):
![Sidenav on desktop](../docassets/images/sidenav-layout.png)
![Sidenav on desktop](../../docassets/images/sidenav-layout.png)
Mobile layout (screen width less than the `stepOver` value):
![Sidenav on mobile](../docassets/images/sidenav-layout-mobile.png)
![Sidenav on mobile](../../docassets/images/sidenav-layout-mobile.png)
### Template context

7
docs/core/sorting-picker.component.md → docs/core/components/sorting-picker.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Sorting Picker Component](../../lib/core/sorting-picker/sorting-picker.component.ts "Defined in sorting-picker.component.ts")
# [Sorting Picker Component](../../../lib/core/sorting-picker/sorting-picker.component.ts "Defined in sorting-picker.component.ts")
Selects from a set of predefined sorting definitions and directions.
![Sorting Picker](../docassets/images/sorting-picker.png)
![Sorting Picker](../../docassets/images/sorting-picker.png)
## Basic Usage
@@ -36,7 +36,8 @@ Selects from a set of predefined sorting definitions and directions.
| Name | Type | Description |
| ---- | ---- | ----------- |
| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Function>` | Raised each time sorting key or 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. |
## Details

34
docs/core/start-form.component.md → docs/core/components/start-form.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Start Form component](../../lib/core/form/components/start-form.component.ts "Defined in start-form.component.ts")
# [Start Form component](../../../lib/core/form/components/start-form.component.ts "Defined in start-form.component.ts")
Displays the Start [`Form`](../../lib/process-services/task-list/models/form.model.ts) for a process.
Displays the Start [`Form`](../../../lib/process-services/task-list/models/form.model.ts) for a process.
![Start Form screenshot](../docassets/images/ProcessStartForm.png)
![Start Form screenshot](../../docassets/images/ProcessStartForm.png)
## Basic Usage
@@ -26,12 +26,12 @@ Displays the Start [`Form`](../../lib/process-services/task-list/models/form.mod
| 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. |
| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. |
| fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. |
| form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. |
| formId | `string` | | The id of the form definition to load and display with custom values. |
| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. |
| form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../../lib/core/form/components/widgets/core/form.model.ts) instance. |
| formId | `number` | | The id of the form definition to load and display with custom values. |
| formName | `string` | | Name of the form definition to load and display with custom values. |
| nameNode | `string` | | Name to assign to the new node where the metadata are stored. |
| nodeId | `string` | | Content Services node ID for the form metadata. |
@@ -54,27 +54,27 @@ Displays the Start [`Form`](../../lib/process-services/task-list/models/form.mod
| Name | Type | Description |
| ---- | ---- | ----------- |
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when a field of the form is clicked. |
| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. |
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../core/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when a field of the form is clicked. |
| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. |
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| outcomeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user clicks one of the outcome buttons that completes the form. |
## Details
The [Start Process component](../process-services/start-process.component.md) uses the Start [`Form`](../../lib/process-services/task-list/models/form.model.ts) component
The [Start Process component](../../process-services/components/start-process.component.md) uses the Start [`Form`](../../../lib/process-services/task-list/models/form.model.ts) component
to display the
[start form](http://docs.alfresco.com/process-services1.6/topics/none_start_event.html)
for the process.
The `outcomeClick` event is passed a string containing the ID of the outcome button that
the user clicked. You can pass this value to the `startProcess` method (defined in the
[Process service](../process-services/process.service.md)) when activating the process, if necessary.
[Process service](../../process-services/services/process.service.md)) when activating the process, if necessary.
## See also
- [Process service](../process-services/process.service.md)
- [Process service](../../process-services/services/process.service.md)

2
docs/core/text-mask.component.md → docs/core/components/text-mask.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Text Mask directive](../../lib/core/form/components/widgets/text/text-mask.component.ts "Defined in text-mask.component.ts")
# [Text Mask directive](../../../lib/core/form/components/widgets/text/text-mask.component.ts "Defined in text-mask.component.ts")
Implements text field input masks.

2
docs/core/toolbar-divider.component.md → docs/core/components/toolbar-divider.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Toolbar Divider Component](../../lib/core/toolbar/toolbar-divider.component.ts "Defined in toolbar-divider.component.ts")
# [Toolbar Divider Component](../../../lib/core/toolbar/toolbar-divider.component.ts "Defined in toolbar-divider.component.ts")
Divides groups of elements in a Toolbar with a visual separator.

6
docs/core/toolbar-title.component.md → docs/core/components/toolbar-title.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Toolbar Title Component](../../lib/core/toolbar/toolbar-title.component.ts "Defined in toolbar-title.component.ts")
# [Toolbar Title Component](../../../lib/core/toolbar/toolbar-title.component.ts "Defined in toolbar-title.component.ts")
Supplies custom HTML to be included in a [Toolbar component](../core/toolbar.component.md) title.
Supplies custom HTML to be included in a [Toolbar component](toolbar.component.md) title.
![](../docassets/images/adf-toolbar-02.png)
![](../../docassets/images/adf-toolbar-02.png)
## Basic Usage

22
docs/core/toolbar.component.md → docs/core/components/toolbar.component.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Toolbar Component](../../lib/core/toolbar/toolbar.component.ts "Defined in toolbar.component.ts")
# [Toolbar Component](../../../lib/core/toolbar/toolbar.component.ts "Defined in toolbar.component.ts")
Simple container for headers, titles, actions and breadcrumbs.
![](../docassets/images/adf-toolbar-01.png)
![](../../docassets/images/adf-toolbar-01.png)
## Contents
@@ -35,7 +35,7 @@ Simple container for headers, titles, actions and breadcrumbs.
</adf-toolbar>
```
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
You can set the title content using an `<adf-toolbar-title>` element (although
you can also set a simple textual title with the `title` attribute).
@@ -63,10 +63,10 @@ toolbar:
```
For example, the image below shows a toolbar with a
[Breadcrumb component](../content-services/breadcrumb.component.md) title, and then some buttons
[Breadcrumb component](../../content-services/breadcrumb.component.md) title, and then some buttons
pushed to the right by a spacer:
![](../docassets/images/adf-toolbar-02.png)
![](../../docassets/images/adf-toolbar-02.png)
## Class members
@@ -109,27 +109,27 @@ but you could also use your own custom menu components:
</adf-toolbar>
```
![](../docassets/images/adf-toolbar-03.png)
![](../../docassets/images/adf-toolbar-03.png)
With the menu set up like this, you would see the following menu items as defined earlier
when you click the menu button:
![](../docassets/images/adf-toolbar-04.png)
![](../../docassets/images/adf-toolbar-04.png)
### Custom color
Besides the default color you can use 'primary', 'accent', or 'warn' values:
You might also want to change colors to follow your application's color
[theme](../user-guide/theming.md):
[theme](../../user-guide/theming.md):
For example:
![](../docassets/images/adf-toolbar-05.png)
![](../../docassets/images/adf-toolbar-05.png)
![](../docassets/images/adf-toolbar-06.png)
![](../../docassets/images/adf-toolbar-06.png)
![](../docassets/images/adf-toolbar-07.png)
![](../../docassets/images/adf-toolbar-07.png)
## See also

2
docs/core/user-info.component.md → docs/core/components/user-info.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19
---
# [User Info component](../../lib/core/userinfo/components/user-info.component.ts "Defined in user-info.component.ts")
# [User Info component](../../../lib/core/userinfo/components/user-info.component.ts "Defined in user-info.component.ts")
Shows user information.

34
docs/core/viewer.component.md → docs/core/components/viewer.component.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Viewer component](../../lib/core/viewer/components/viewer.component.ts "Defined in viewer.component.ts")
# [Viewer component](../../../lib/core/viewer/components/viewer.component.ts "Defined in viewer.component.ts")
Displays content from an ACS repository.
@@ -64,9 +64,9 @@ Note that if you have a URL which contains a shared link ID, you should extract
ID portion and use it with the `sharedLinkId` property rather than using the whole
URL with `urlFile`.
### [Transclusions](../user-guide/transclusion.md)
### [Transclusions](../../user-guide/transclusion.md)
The [Viewer component](../core/viewer.component.md) lets you transclude content for the toolbar (and toolbar buttons),
The [Viewer component](viewer.component.md) lets you transclude content for the toolbar (and toolbar buttons),
the sidebar, thumbnails, and the "Open with" and "More actions" menus.
See the [Custom layout](#custom-layout) section for full details of all available tranclusions.
@@ -109,11 +109,11 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
| Name | Type | Description |
| ---- | ---- | ----------- |
| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<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)`<Object>` | Emitted when the shared link used is not valid. |
| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when user clicks 'Navigate Before' ("&lt;") button. |
| navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | 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`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`<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. |
## Keyboard shortcuts
@@ -130,7 +130,7 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
### Integrating with the Document List component
Below is the most simple integration of the Viewer and
[Document List](../content-services/document-list.component.md) components within your custom component:
[Document List](../../content-services/document-list.component.md) components within your custom component:
```html
<adf-document-list
@@ -179,7 +179,7 @@ You can provide custom file parameters, for example a value for the `mimeType` o
### Supported file formats
The [Viewer component](../core/viewer.component.md) consists of separate Views that handle particular 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 types or type families based on either a file extension or a mime type:
- PDF View
- application/pdf
@@ -237,7 +237,7 @@ Configure your webpack-enabled application with the PDF.js library as follows.
npm install pdfjs-dist
```
2. Update `vendors.ts` by appending the following code. This will enable the [viewer component](../core/viewer.component.md)
2. Update `vendors.ts` by appending the following code. This will enable the [viewer component](viewer.component.md)
and compatibility mode for all browsers. It will also configure the web worker for the PDF.js
library to render PDF files in the background:
@@ -261,12 +261,12 @@ new CopyWebpackPlugin([
])
```
The [Viewer component](../core/viewer.component.md) now should be able to display PDF files.
The [Viewer component](viewer.component.md) now should be able to display PDF files.
### Extending the Viewer
You can define your own custom handler to handle other file formats that are not yet supported by
the [Viewer component](../core/viewer.component.md). Below is an example that shows how to use the `adf-viewer-extension`
the [Viewer component](viewer.component.md). Below is an example that shows how to use the `adf-viewer-extension`
to handle 3D data files:
```html
@@ -311,7 +311,7 @@ You can define multiple `adf-viewer-extension` templates if required:
### Custom layout
The [Viewer component](../core/viewer.component.md) lets you transclude custom content in several different places as
The [Viewer component](viewer.component.md) lets you transclude custom content in several different places as
explained in the sections below.
#### Custom toolbar
@@ -352,11 +352,11 @@ then you can do so as shown in the following example:
The result should look like this:
![Custom Toolbar Actions](../docassets/images/viewer-toolbar-actions.png)
![Custom Toolbar Actions](../../docassets/images/viewer-toolbar-actions.png)
#### Custom sidebar
The [Viewer component](../core/viewer.component.md) also supports custom sidebar components and layouts.
The [Viewer component](viewer.component.md) also supports custom sidebar components and layouts.
Set the `allowRightSidebar` property to `true` to enable this feature.
The custom sidebar can be injected in two different ways. The first way is to use
@@ -386,7 +386,7 @@ The PDF viewer comes with its own default list of thumbnails but you can replace
by providing a custom template and binding to the context property `viewer` to access the PDFJS.PDFViewer
instance.
![PDF thumbnails](../docassets/images/pdf-thumbnails.png)
![PDF thumbnails](../../docassets/images/pdf-thumbnails.png)
Provide the custom template as in the following example:
@@ -438,7 +438,7 @@ You can enable a custom "Open With" menu by providing at least one action inside
</adf-viewer>
```
![Open with](../docassets/images/viewer-open-with.png)
![Open with](../../docassets/images/viewer-open-with.png)
#### Custom "More actions" menu
@@ -465,7 +465,7 @@ You can enable a custom "More actions" menu by providing at least one action ins
</adv-viewer>
```
![More actions](../docassets/images/viewer-more-actions.png)
![More actions](../../docassets/images/viewer-more-actions.png)
### Printing
@@ -484,4 +484,4 @@ content.
## See also
- [Document List component](../content-services/document-list.component.md)
- [Document List component](../../content-services/document-list.component.md)

18
docs/core/check-allowable-operation.directive.md → docs/core/directives/check-allowable-operation.directive.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-02-13
---
# [Check Allowable Operation directive](../../lib/core/directives/check-allowable-operation.directive.ts "Defined in check-allowable-operation.directive.ts")
# [Check Allowable Operation directive](../../../lib/core/directives/check-allowable-operation.directive.ts "Defined in check-allowable-operation.directive.ts")
Selectively disables an HTML element or Angular component.
@@ -47,7 +47,7 @@ Selectively disables an HTML element or Angular component.
## Details
The [Check Allowable Operation Directive](../core/check-allowable-operation.directive.md) lets you disable an HTML element or Angular component
The [Check Allowable Operation Directive](check-allowable-operation.directive.md) lets you disable an HTML element or Angular component
by taking a collection of [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) instances and checking their permissions.
The decorated element will be disabled if:
@@ -57,7 +57,7 @@ The decorated element will be disabled if:
### HTML element example
A typical use case is to bind a [Document List](../content-services/document-list.component.md)
A typical use case is to bind a [Document List](../../content-services/document-list.component.md)
selection property to a toolbar button. In the following example, the "Delete" button should
be disabled if no selection is present or if user does not have permission to delete at least one node in the selection:
@@ -80,8 +80,8 @@ one or more documents that they have permission to delete.
### Angular component example
You can add the directive to any Angular component that implements the [`NodeAllowableOperationSubject`](../../lib/core/directives/check-allowable-operation.directive.ts)
interface (the [Upload Drag Area component](../content-services/upload-drag-area.component.md),
You can add the directive to any Angular component that implements the [`NodeAllowableOperationSubject`](../../../lib/core/directives/check-allowable-operation.directive.ts)
interface (the [Upload Drag Area component](../../content-services/upload-drag-area.component.md),
for example). You can also use it in much the same way as you would with an HTML element:
```html
@@ -95,14 +95,14 @@ for example). You can also use it in much the same way as you would with an HTML
```
To enable your own component to work with this directive, you need to implement the
[`NodeAllowableOperationSubject`](../../lib/core/directives/check-allowable-operation.directive.ts) interface and also define it as an
[`EXTENDIBLE_COMPONENT`](../../lib/core/interface/injection.tokens.ts)
[`NodeAllowableOperationSubject`](../../../lib/core/directives/check-allowable-operation.directive.ts) interface and also define it as an
[`EXTENDIBLE_COMPONENT`](../../../lib/core/interface/injection.tokens.ts)
parent component,
as described in the following sections.
### Implementing the NodeAllowableOperationSubject interface
The component must implement the [`NodeAllowableOperationSubject`](../../lib/core/directives/check-allowable-operation.directive.ts) interface which means it must have a
The component must implement the [`NodeAllowableOperationSubject`](../../../lib/core/directives/check-allowable-operation.directive.ts) interface which means it must have a
boolean `disabled` property. This is the property that will be set by the directive:
```js
@@ -121,7 +121,7 @@ up to the `@Host()` component. The host component is typically the component tha
the dependency. However, when this component is projected into a parent component, the
parent becomes the host. This means you must provide your component with forward referencing
as the
[`EXTENDIBLE_COMPONENT`](../../lib/core/interface/injection.tokens.ts)
[`EXTENDIBLE_COMPONENT`](../../../lib/core/interface/injection.tokens.ts)
and also provide your component as a `viewProvider`:
```js

6
docs/core/context-menu.directive.md → docs/core/directives/context-menu.directive.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Context Menu directive](../../lib/core/context-menu/context-menu.directive.ts "Defined in context-menu.directive.ts")
# [Context Menu directive](../../../lib/core/context-menu/context-menu.directive.ts "Defined in context-menu.directive.ts")
Adds a context menu to a component.
@@ -54,5 +54,5 @@ export class MyComponent implements OnInit {
## Details
See the [Demo Shell](../../demo-shell/README.md)
or [Document List component](../content-services/document-list.component.md) implementation for more details and use cases.
See the [Demo Shell](../../../demo-shell/README.md)
or [Document List component](../../content-services/document-list.component.md) implementation for more details and use cases.

6
docs/core/highlight.directive.md → docs/core/directives/highlight.directive.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Highlight directive](../../lib/core/directives/highlight.directive.ts "Defined in highlight.directive.ts")
# [Highlight directive](../../../lib/core/directives/highlight.directive.ts "Defined in highlight.directive.ts")
Adds highlighting to selected sections of an HTML element's content.
@@ -70,5 +70,5 @@ property:
## See also
- [Text highlight pipe](text-highlight.pipe.md)
- [Highlight transform service](highlight-transform.service.md)
- [Text highlight pipe](../pipes/text-highlight.pipe.md)
- [Highlight transform service](../services/highlight-transform.service.md)

4
docs/core/logout.directive.md → docs/core/directives/logout.directive.md
View File

@@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active
---
# [Logout directive](../../lib/core/directives/logout.directive.ts "Defined in logout.directive.ts")
# [Logout directive](../../../lib/core/directives/logout.directive.ts "Defined in logout.directive.ts")
Logs the user out when the decorated element is clicked.
@@ -25,4 +25,4 @@ Logs the user out when the decorated element is clicked.
## See also
- [Login component](login.component.md)
- [Login component](../components/login.component.md)

2
docs/core/node-delete.directive.md → docs/core/directives/node-delete.directive.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Node Delete directive](../../lib/core/directives/node-delete.directive.ts "Defined in node-delete.directive.ts")
# [Node Delete directive](../../../lib/core/directives/node-delete.directive.ts "Defined in node-delete.directive.ts")
Deletes multiple files and folders.

4
docs/core/node-download.directive.md → docs/core/directives/node-download.directive.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Node Download directive](../../lib/content-services/directives/node-download.directive.ts "Defined in node-download.directive.ts")
# [Node Download directive](../../../lib/core/directives/node-download.directive.ts "Defined in node-download.directive.ts")
Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive.
@@ -30,4 +30,4 @@ Allows folders and/or files to be downloaded, with multiple nodes packed as a '.
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| nodes | [`MinimalNodeEntity`](../content-services/document-library.model.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. |

2
docs/core/node-favorite.directive.md → docs/core/directives/node-favorite.directive.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Node Favorite directive](../../lib/core/directives/node-favorite.directive.ts "Defined in node-favorite.directive.ts")
# [Node Favorite directive](../../../lib/core/directives/node-favorite.directive.ts "Defined in node-favorite.directive.ts")
Selectively toggles nodes as favorites.

8
docs/core/node-restore.directive.md → docs/core/directives/node-restore.directive.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Node Restore directive](../../lib/core/directives/node-restore.directive.ts "Defined in node-restore.directive.ts")
# [Node Restore directive](../../../lib/core/directives/node-restore.directive.ts "Defined in node-restore.directive.ts")
Restores deleted nodes to their original location.
@@ -50,17 +50,17 @@ Restores deleted nodes to their original location.
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| selection | `DeletedNodeEntry[]` | | Array of deleted nodes to restore. |
| selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` | | Array of deleted nodes to restore. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| restore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RestoreMessageModel`](../../lib/core/directives/node-restore.directive.ts)`>` | Emitted when restoration is complete. |
| restore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RestoreMessageModel`](../../../lib/core/directives/node-restore.directive.ts)`>` | Emitted when restoration is complete. |
## Details
The directive takes a selection of `DeletedNodeEntry` instances and restores them to
The directive takes a selection of [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DeletedNodeEntry.md) instances and restores them to
their original locations. If the original location doesn't exist anymore then they remain
in the trash list.

6
docs/core/upload.directive.md → docs/core/directives/upload.directive.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Upload Directive](../../lib/core/directives/upload.directive.ts "Defined in upload.directive.ts")
# [Upload Directive](../../../lib/core/directives/upload.directive.ts "Defined in upload.directive.ts")
Uploads content in response to file drag and drop.
@@ -63,7 +63,7 @@ value or expression:
### Modes
The [Upload directive](../core/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)
- **click** mode, where the decorated element invokes a file dialog to select files or folders.
@@ -100,7 +100,7 @@ In click mode you can provide extra attributes for the file dialog:
#### Drop mode
Currently, the [upload directive](../core/upload.directive.md) supports only file drops (single or multiple).
Currently, the [upload directive](upload.directive.md) supports only file drops (single or multiple).
Support for folders and `accept` filters will probably be implemented in a
future version.

61
docs/core/form-field.component.md
View File

@@ -1,61 +0,0 @@
---
Title: Form field component
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-20
---
# [Form field component](../../lib/core/form/components/form-field/form-field.component.ts "Defined in form-field.component.ts")
Represents a UI field in a form.
## Basic Usage
All form field editors (aka widgets) on a [`Form`](../../lib/process-services/task-list/models/form.model.ts) are rendered by means of a [`FormFieldComponent`](../core/form-field.component.md)
that takes an instance of a [`FormFieldModel`](../core/form-field.model.md):
```html
<adf-form-field [field]="field"></adf-form-field>
```
This component depends on the [`FormRenderingService`](../core/form-rendering.service.md) to map the [`FormFieldModel`](../core/form-field.model.md) to a [`Form`](../../lib/process-services/task-list/models/form.model.ts) Field UI component
based on the field type or the metadata information.
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| field | [`FormFieldModel`](../core/form-field.model.md) | null | Contains all the necessary data needed to determine what UI `Widget` to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. |
## Details
You would typically not use this component directly but instead use the `<adf-form>` component, which under the hood
uses `<adf-form-field>` components to render the form fields.
### Field Type -> Form Field Component mappings
Forms defined in APS have the following default mappings for the form fields:
| _APS Form Designer_ Widget | Field Type | Component Type |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------- |
| Text | text | [`TextWidgetComponent`](../../lib/core/form/components/widgets/text/text.widget.ts) |
| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
| Number | integer | [`NumberWidgetComponent`](../../lib/core/form/components/widgets/number/number.widget.ts) |
| Checkbox | boolean | [`CheckboxWidgetComponent`](../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
| Date | date | [`DateWidgetComponent`](../../lib/core/form/components/widgets/date/date.widget.ts) |
| Dropdown | dropdown | [`DropdownWidgetComponent`](../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
| Amount | amount | [`AmountWidgetComponent`](../../lib/core/form/components/widgets/amount/amount.widget.ts) |
| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
| People | people | [`PeopleWidgetComponent`](../../lib/core/form/components/widgets/people/people.widget.ts) |
| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
| Header | group | [`ContainerWidgetComponent`](../../lib/core/form/components/widgets/container/container.widget.ts) |
| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
| Display value | readonly | [`TextWidgetComponent`](../../lib/core/form/components/widgets/text/text.widget.ts) |
| Display text | readonly-text | [`DisplayTextWidgetComponent`](../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
| N/A | container | [`ContainerWidgetComponent`](../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) |
| N/A | N/A | [`UnknownWidgetComponent`](../../lib/core/form/components/widgets/unknown/unknown.widget.ts) |

101
docs/core/identity-user.service.md
View File

@@ -1,101 +0,0 @@
---
Title: Identity user service
Added: v3.0.0
Status: Active
Last reviewed: 2019-02-08
---
# [Identity user service](../../lib/lib/core/userinfo/services/identity-user.service.ts "Defined in identity-user.service.ts")
Gets OAuth2 personal details and roles for users.
## Class members
### Methods
- **checkUserHasAnyApplicationRole**(userId: `string`, applicationName: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
Checks if a user has any application role.
- _userId:_ `string` - ID of the target user
- _applicationName:_ `string` - Name of the application
- _roleNames:_ `string[]` - List of role names to check for
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has one or more of the roles, false otherwise
- **checkUserHasAnyClientAppRole**(userId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
Checks whether a user has any of the client app roles.
- _userId:_ `string` - ID of the target user
- _clientId:_ `string` - ID of the client app
- _roleNames:_ `string[]` - List of role names to check for
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has one or more of the roles, false otherwise
- **checkUserHasApplicationAccess**(userId: `string`, applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
Checks if a user has access to an application.
- _userId:_ `string` - ID of the user
- _applicationName:_ `string` - Name of the application
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has access, false otherwise
- **checkUserHasClientApp**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
Checks whether user has access to a client app.
- _userId:_ `string` - ID of the target user
- _clientId:_ `string` - ID of the client app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has access, false otherwise
- **checkUserHasRole**(userId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
Checks if a user has one of the roles from a list.
- _userId:_ `string` - ID of the target user
- _roleNames:_ `string[]` - Array of roles to check for
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the user has one of the roles, false otherwise
- **findUserByEmail**(email: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Find users based on email input.
- _email:_ `string` - [Search](../../lib/node_modules/@alfresco/js-api/src/api-legacy/legacy.ts) query string
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of users
- **findUserById**(id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Find users based on id input.
- _id:_ `string` - [Search](../../lib/node_modules/@alfresco/js-api/src/api-legacy/legacy.ts) query string
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - users object
- **findUserByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Find users based on username input.
- _username:_ `string` - [Search](../../lib/node_modules/@alfresco/js-api/src/api-legacy/legacy.ts) query string
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of users
- **findUsersByName**(search: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Find users based on search input.
- _search:_ `string` - [Search](../../lib/node_modules/@alfresco/js-api/src/api-legacy/legacy.ts) query string
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of users
- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
Gets the client ID for an application.
- _applicationName:_ `string` - Name of the application
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - Client ID string
- **getClientRoles**(userId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`<br/>
Get client roles of a user for a particular client.
- _userId:_ `string` - ID of the target user
- _clientId:_ `string` - ID of the client app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - List of client roles
- **getCurrentUserInfo**(): [`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts)<br/>
Gets the name and other basic details of the current user.
- **Returns** [`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts) - The user's details
- **getUserRoles**(userId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../lib/core/userinfo/models/identity-role.model.ts)`[]>`<br/>
Gets a list of roles for a user.
- _userId:_ `string` - ID of the user
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../lib/lib/core/userinfo/models/identity-role.model.ts)`[]>` - Array of role info objects
- **getUsers**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../lib/lib/core/userinfo/models/identity-user.model.ts)`[]>`<br/>
Gets details for all users.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts)`[]>` - Array of user info objects
- **getUsersByRolesWithCurrentUser**(roleNames: `string[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts)`[]>`<br/>
Gets an array of users (including the current user) who have any of the roles in the supplied list.
- _roleNames:_ `string[]` - List of role names to look for
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts)`[]>` - Array of user info objects
- **getUsersByRolesWithoutCurrentUser**(roleNames: `string[]`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts)`[]>`<br/>
Gets an array of users (not including the current user) who have any of the roles in the supplied list.
- _roleNames:_ `string[]` - List of role names to look for
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts)`[]>` - Array of user info objects
- **getValueFromToken**(key: `string`)<br/>
Gets a named value from the user access token.
- _key:_ `string` - Key name of the field to retrieve
## Details
[OAuth2](https://oauth.net/2/) defines an _access token_ (used when
authenticating a user) and a number of _authentication roles_ that the user
can participate in (see
[this page](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2)
for an introduction to OAuth2 and a description of the roles). You can use the
[Identity user service](identity-user.service.md) to access this information for users, including the current user.
## See also
- [JWT helper service](../core/jwt-helper.service.md)

18
docs/core/card-view-item.interface.md → docs/core/interfaces/card-view-item.interface.md
View File

@@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2018-05-08
---
# [Card View Item interface](../../lib/core/card-view/interfaces/card-view-item.interface.ts "Defined in card-view-item.interface.ts")
# [Card View Item interface](../../../lib/core/card-view/interfaces/card-view-item.interface.ts "Defined in card-view-item.interface.ts")
Defines the implementation of an item in a [Card View component](../core/card-view.component.md).
Defines the implementation of an item in a [Card View component](../components/card-view.component.md).
## Definition
@@ -42,7 +42,7 @@ export interface CardViewItem {
## Details
Card item components are loaded dynamically by the
main [Card View component](card-view.component.md). This allows you to define your own
main [Card View component](../components/card-view.component.md). This allows you to define your own
component for a custom item type.
For example, follow the steps given below to add a **stardate** type to display Captain
@@ -50,8 +50,8 @@ Picard's birthday (47457.1):
1. Define the model for the custom type.
Your model must extend the [`CardViewBaseItemModel`](../../lib/core/card-view/models/card-view-baseitem.model.ts) class and implement the [`CardViewItem`](../../lib/core/card-view/interfaces/card-view-item.interface.ts)
and [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts) interfaces. See the
Your model must extend the [`CardViewBaseItemModel`](../../../lib/core/card-view/models/card-view-baseitem.model.ts) class and implement the [`CardViewItem`](../../../lib/core/card-view/interfaces/card-view-item.interface.ts)
and [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) interfaces. See the
[Card View Text Item model source](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts)
for an example of how to do this.
@@ -142,11 +142,11 @@ Picard's birthday (47457.1):
}
```
The [Card Item Type service](card-item-types.service.md) maps each item type to the
corresponding component. See its [doc page](card-item-types.service.md) for further
The [Card Item Type service](../services/card-item-types.service.md) maps each item type to the
corresponding component. See its [doc page](../services/card-item-types.service.md) for further
details.
## See also
- [Card View component](card-view.component.md)
- [Card Item Types service](card-item-types.service.md)
- [Card View component](../components/card-view.component.md)
- [Card Item Types service](../services/card-item-types.service.md)

50
docs/core/datatable-adapter.interface.md → docs/core/interfaces/datatable-adapter.interface.md
View File

@@ -4,37 +4,36 @@ Added: v2.0.0
Status: Active
---
# [DataTableAdapter interface](../../lib/core/datatable/data/datatable-adapter.ts "Defined in datatable-adapter.ts")
# [DataTableAdapter interface](../../../lib/core/datatable/data/datatable-adapter.ts "Defined in datatable-adapter.ts")
Defines how table data is supplied to [DataTable](datatable.component.md)
and [Tasklist](../process-services/task-list.component.md) components.
Defines how table data is supplied to [DataTable](../components/datatable.component.md) and [Tasklist](../../process-services/components/task-list.component.md) components.
## Properties
| Name | Type | Description |
| ---- | ---- | ----------- |
| selectedRow | [`DataRow`](../../lib/core/datatable/data/data-row.model.ts) | The data for the currently selected row. |
| selectedRow | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | The data for the currently selected row. |
## Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| rowsChanged | [`Subject<Array<DataRow>>`](../../lib/core/datatable/data/data-row.model.ts) | Raised when data adapter gets new rows. |
| rowsChanged | [`Subject<Array<DataRow>>`](../../../lib/core/datatable/data/data-row.model.ts) | Raised when data adapter gets new rows. |
## Methods
[`getRows(): Array<DataRow>;`](../../lib/core/datatable/data/data-row.model.ts)<br/>
[`setRows(rows: Array<DataRow>): void;`](../../lib/core/datatable/data/data-row.model.ts)<br/>
[`getRows(): Array<DataRow>;`](../../../lib/core/datatable/data/data-row.model.ts)<br/>
[`setRows(rows: Array<DataRow>): void;`](../../../lib/core/datatable/data/data-row.model.ts)<br/>
Get/set the values for display in the table using an array of rows.
[`getColumns(): Array<DataColumn>;`](../../lib/core/datatable/data/data-column.model.ts)<br/>
[`setColumns(columns: Array<DataColumn>): void;`](../../lib/core/datatable/data/data-column.model.ts)<br/>
[`getColumns(): Array<DataColumn>;`](../../../lib/core/datatable/data/data-column.model.ts)<br/>
[`setColumns(columns: Array<DataColumn>): void;`](../../../lib/core/datatable/data/data-column.model.ts)<br/>
Get/set an array of column specifications.
`getValue(row:`[`DataRow,`](../../lib/core/datatable/data/data-row.model.ts)`col: DataColumn): any;`<br/>
`getValue(row:`[`DataRow,`](../../../lib/core/datatable/data/data-row.model.ts)`col: DataColumn): any;`<br/>
Get the data value from a specific table cell.
`getSorting():`[`DataSorting`](../../lib/core/datatable/data/data-sorting.model.ts)`;`<br/>
`getSorting():`[`DataSorting`](../../../lib/core/datatable/data/data-sorting.model.ts)`;`<br/>
`setSorting(sorting: DataSorting): void;`<br/>
Get/set the sorting key and direction (ascending or descending).
@@ -43,22 +42,22 @@ Sort the table with a specified key and direction (ascending or descending).
## Details
You can implement [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) in your own class to display your data with the [DataTable](datatable.component.md)
and [Tasklist](../process-services/task-list.component.md) components.
This interface (along with other interfaces for column and row data) hides the details of your class from the caller, so you can store your data internally however you like. The DataTable library implements the interface in the [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) class which is the standard adapter for the Datatable component.
You can implement [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) in your own class to display your data with the [DataTable](../components/datatable.component.md)
and [Tasklist](../../process-services/components/task-list.component.md) components.
This interface (along with other interfaces for column and row data) hides the details of your class from the caller, so you can store your data internally however you like. The DataTable library implements the interface in the [`ObjectDataTableAdapter`](../../../lib/core/datatable/data/object-datatable-adapter.ts) class which is the standard adapter for the Datatable component.
The basic idea of [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) is that the caller can request your class to return an array of column
The basic idea of [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) is that the caller can request your class to return an array of column
definition objects. Each of these objects specifies the unique key, name, type and other properties of a single column.
The caller can also request the data values for the table as an array of row objects. The caller accesses the data from a row using a `getValue` method that returns the data from a specified column. This column is identified by the unique key that was set during the column definition.
The data-hiding works the other way around when the caller needs to set data in the [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) class - the internal
The data-hiding works the other way around when the caller needs to set data in the [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) class - the internal
details of the caller's storage are hidden by the column and row interfaces. When the `setColumns` and `setRows` methods are
called on the adapter, it can simply query the column/row objects it receives and then store the data in its own format.
### Columns and rows
Columns are defined by the [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) interface:
Columns are defined by the [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) interface:
```ts
interface DataColumn {
@@ -76,7 +75,7 @@ interface DataColumn {
An array of these objects is passed to your object when the `setColumns` method is called. The `key` property is used to identify columns and so each column's key should be unique. The `type` string can have a value of 'text', 'image' or 'date'.
An array of [`DataRow`](../../lib/core/datatable/data/data-row.model.ts) objects is passed to your object when the `setRows` method is called:
An array of [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) objects is passed to your object when the `setRows` method is called:
```ts
interface DataRow {
@@ -92,8 +91,8 @@ Each row contains a set of values. An item in the set is retrieved by passing it
### ObjectDataTableAdapter
The DataTable library provides a implementation of [DataTableAdapter,](../../lib/core/datatable/data/datatable-adapter.ts) called
[`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts). This is a simple adapter that binds to object arrays and turns object fields into columns:
The DataTable library provides a implementation of [DataTableAdapter,](../../../lib/core/datatable/data/datatable-adapter.ts) called
[`ObjectDataTableAdapter`](../../../lib/core/datatable/data/object-datatable-adapter.ts). This is a simple adapter that binds to object arrays and turns object fields into columns:
```ts
let data = new ObjectDataTableAdapter(
@@ -120,7 +119,7 @@ let data = new ObjectDataTableAdapter(
);
```
![DataTable demo](../docassets/images/datatable-demo.png)
![DataTable demo](../../docassets/images/datatable-demo.png)
If you don't specify the column array then the constructor will infer the layout of the columns from
the structure of the row objects. The field names ('id' and 'name' in the example below) will be used
@@ -152,12 +151,7 @@ let schema = ObjectDataTableAdapter.generateSchema(data);
*/
```
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Datatable component](datatable.component.md)
- [Task list component](../process-services/task-list.component.md)
<!-- seealso end -->
- [Datatable component](../components/datatable.component.md)
- [Task list component](../../process-services/components/task-list.component.md)

42
docs/core/form-field-validator.interface.md → docs/core/interfaces/form-field-validator.interface.md
View File

@@ -4,9 +4,9 @@ Added: v2.0.0
Status: Active
---
# [FormFieldValidator interface](../../lib/core/form/components/widgets/core/form-field-validator.ts "Defined in form-field-validator.ts")
# [FormFieldValidator interface](../../../lib/core/form/components/widgets/core/form-field-validator.ts "Defined in form-field-validator.ts")
Defines how the input fields of [`Form`](../../lib/process-services/task-list/models/form.model.ts) and Task Details components are validated.
Defines how the input fields of [`Form`](../../../lib/process-services/task-list/models/form.model.ts) and Task Details components are validated.
## Basic Usage
@@ -54,26 +54,26 @@ Perform validation on `field`.
You can supply a set of validator objects for a form using its `fieldValidators` property.
ADF will determine if a validator should be used with a given field by calling its
`isSupported` method, passing the field's [`FormFieldModel`](../core/form-field.model.md) as a parameter. If the validator
does support the field then its `validate` method will be called on the [`FormFieldModel`](../core/form-field.model.md)
`isSupported` method, passing the field's [`FormFieldModel`](../../core/models/form-field.model.md) as a parameter. If the validator
does support the field then its `validate` method will be called on the [`FormFieldModel`](../../core/models/form-field.model.md)
during the validation phase.
Several validator classes are predefined for you to use:
| Validator name | Checks that: |
| -------------- | ------------ |
| [`RequiredFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field is not left blank |
| [`NumberFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field contains numeric data |
| [`MinLengthFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field text has at least a minimum number of characters |
| [`MaxLengthFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field text has no more than a maximum number of characters |
| [`MinValueFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Numeric field's value is greater than a lower limit |
| [`MaxValueFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Numeric field's vaue is less than an upper limit |
| [`RegExFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field text matches a regular expression |
| [`DateFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field contains a date in the correct format |
| [`MinDateFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Date within a field occurs after a certain starting point |
| [`MaxDateFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | Date within a field occurs before a certain end point |
| [`RequiredFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field is not left blank |
| [`NumberFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field contains numeric data |
| [`MinLengthFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field text has at least a minimum number of characters |
| [`MaxLengthFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field text has no more than a maximum number of characters |
| [`MinValueFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Numeric field's value is greater than a lower limit |
| [`MaxValueFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Numeric field's vaue is less than an upper limit |
| [`RegExFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field text matches a regular expression |
| [`DateFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Field contains a date in the correct format |
| [`MinDateFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Date within a field occurs after a certain starting point |
| [`MaxDateFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) | Date within a field occurs before a certain end point |
The `FORM_FIELD_VALIDATORS` array contains an instance of each of these classes. You can assign this to the `fieldValidators` property of an Activiti [`Form`](../../lib/process-services/task-list/models/form.model.ts) or Activiti [Task Details component](../process-services/task-details.component.md) to enable standard validation.
The `FORM_FIELD_VALIDATORS` array contains an instance of each of these classes. You can assign this to the `fieldValidators` property of a [`Form`](../../../lib/process-services/task-list/models/form.model.ts) or [Task Details component](../../process-services/components/task-details.component.md) to enable standard validation.
### Custom validators
@@ -81,9 +81,9 @@ You can implement your own custom validator classes if the standard set doesn't
features you need. For example, you could check for consistency between separate fields on
the form (currency values adding up to a given total, say).
The `type` property of [`FormFieldModel`](../core/form-field.model.md) is often used in the `isSupported` function, since
The `type` property of [`FormFieldModel`](../../core/models/form-field.model.md) is often used in the `isSupported` function, since
validation methods typically apply only to specific types of data.
The [`FormFieldTypes`](../../lib/core/form/components/widgets/core/form-field-types.ts)
The [`FormFieldTypes`](../../../lib/core/form/components/widgets/core/form-field-types.ts)
class defines convenient constants for the type strings.
The validator in the example
@@ -128,7 +128,7 @@ export class AppComponent {
}
```
You can now use the 'fieldValidators' property of the [`Form`](../../lib/process-services/task-list/models/form.model.ts) or Task Details components to assign your
You can now use the 'fieldValidators' property of the [`Form`](../../../lib/process-services/task-list/models/form.model.ts) or Task Details components to assign your
custom validator set:
```html
@@ -147,9 +147,9 @@ custom validator set:
If you now run the application and try to enter "admin" in one of the text fields (either optional or required), you should see the following error:
![](../docassets/images/demo-validator.png)
![](../../docassets/images/demo-validator.png)
## See also
- [Form field model](form-field.model.md)
- [Form component](form.component.md)
- [Form field model](../models/form-field.model.md)
- [Form component](../components/form.component.md)

12
docs/core/search-configuration.interface.md → docs/core/interfaces/search-configuration.interface.md
View File

@@ -4,7 +4,7 @@ Added: v2.1.0
Status: Active
---
# [Search Configuration interface](../../lib/core/interface/search-configuration.interface.ts "Defined in search-configuration.interface.ts")
# [Search Configuration interface](../../../lib/core/interface/search-configuration.interface.ts "Defined in search-configuration.interface.ts")
Provides fine control of parameters to a search.
@@ -20,7 +20,7 @@ The interface defines a service that generates a custom
object. This object can then be supplied to a search operation to refine the search parameters.
A standard implementation, the
[Search Configuration service](search-configuration.service.md) is provided in the ADF Core library
[Search Configuration service](../services/search-configuration.service.md) is provided in the ADF Core library
source. This works fine in most cases but if you need to, you can implement your own service, as
described below.
@@ -28,7 +28,7 @@ described below.
1. Implement the service class
Create your own service class to implement the [`SearchConfigurationInterface`](../core/search-configuration.interface.md). This defines the
Create your own service class to implement the [`SearchConfigurationInterface`](../../core/interfaces/search-configuration.interface.md). This defines the
the `generateQueryBody` method that returns the QueryBody object. See the
[QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md)
page in the Alfresco JS API for further details about the options this object provides.
@@ -85,10 +85,10 @@ described below.
})
```
You also need to add the [`SearchService`](../core/search.service.md) as a provider to avoid overriding the module instance. This component will have his own instance of the [`SearchService`](../core/search.service.md) that will use the class you have provided
You also need to add the [`SearchService`](../../core/services/search.service.md) as a provider to avoid overriding the module instance. This component will have his own instance of the [`SearchService`](../../core/services/search.service.md) that will use the class you have provided
as its configuration.
## See also
- [Search component](../content-services/search.component.md)
- [Search configuration service](search-configuration.service.md)
- [Search component](../../content-services/search.component.md)
- [Search configuration service](../services/search-configuration.service.md)

30
docs/core/mime-type-icon.pipe.md
View File

@@ -1,30 +0,0 @@
---
Title: Mime Type Icon pipe
Added: v2.0.0
Status: Active
---
# [Mime Type Icon pipe](../../lib/core/pipes/mime-type-icon.pipe.ts "Defined in mime-type-icon.pipe.ts")
Retrieves an icon to represent a MIME type.
## Basic Usage
<!-- {% raw %} -->
```HTML
<div>
<img src='{{ "image/jpeg" | adfMimeTypeIcon }}' />
</div>
```
<!-- {% endraw %} -->
## Details
The pipe takes a MIME type as input and returns the URL of an SVG file that
symbolizes that type (see the [Thumbnail service](thumbnail.service.md) for the mapping between types and icons). The pipe will return a "miscellaneous" icon when no specific mapping is defined.
## See also
- [Thumbnail service](thumbnail.service.md)

8
docs/core/bpm-user.model.md → docs/core/models/bpm-user.model.md
View File

@@ -4,14 +4,14 @@ Added: v2.0.0
Status: Active
---
# [Bpm User model](../../lib/core/userinfo/models/bpm-user.model.ts "Defined in bpm-user.model.ts")
# [Bpm User model](../../../lib/core/userinfo/models/bpm-user.model.ts "Defined in bpm-user.model.ts")
Contains information about a Process Services user.
## Details
Instances of this class are returned by the methods of the
[Bpm User service](bpm-user.service.md). It implements the
[Bpm User service](../services/bpm-user.service.md). It implements the
[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/UserRepresentation.md) interface, which is defined in the
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UserRepresentation.md).
@@ -22,6 +22,6 @@ latest version of the class, see the
## See also
- [Bpm user service](bpm-user.service.md)
- [Bpm user service](../services/bpm-user.service.md)
- [Ecm user model](ecm-user.model.md)
- [People process service](people-process.service.md)
- [People process service](../services/people-process.service.md)

8
docs/core/ecm-user.model.md → docs/core/models/ecm-user.model.md
View File

@@ -4,14 +4,14 @@ Added: v2.0.0
Status: Active
---
# [Ecm User model](../../lib/core/userinfo/models/ecm-user.model.ts "Defined in ecm-user.model.ts")
# [Ecm User model](../../../lib/core/userinfo/models/ecm-user.model.ts "Defined in ecm-user.model.ts")
Contains information about a Content Services user.
## Details
Instances of this class are returned by the methods of the
[Ecm User service](ecm-user.service.md). It implements the `Person`
[Ecm User service](../services/ecm-user.service.md). It implements the `Person`
interface, which is defined in the
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/Person.md).
@@ -22,6 +22,6 @@ latest version of the class, see the
## See also
- [Ecm user service](ecm-user.service.md)
- [People content service](people-content.service.md)
- [Ecm user service](../services/ecm-user.service.md)
- [People content service](../services/people-content.service.md)
- [Bpm user model](bpm-user.model.md)

40
docs/core/form-field.model.md → docs/core/models/form-field.model.md
View File

@@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2018-03-20
---
# [Form Field model](../../lib/core/form/components/widgets/core/form-field.model.ts "Defined in form-field.model.ts")
# [Form Field model](../../../lib/core/form/components/widgets/core/form-field.model.ts "Defined in form-field.model.ts")
Contains the value and metadata for a field of a [`Form`](../../lib/process-services/task-list/models/form.model.ts) component.
Contains the value and metadata for a field of a [`Form`](../../../lib/process-services/task-list/models/form.model.ts) component.
## Properties
@@ -15,7 +15,7 @@ Contains the value and metadata for a field of a [`Form`](../../lib/process-serv
| ---- | ---- | ------- | ----------- |
| id | string | | Field ID |
| name | string | | Field name |
| type | string | | Field type (see [Form Rendering service](form-rendering.service.md) for a list of available type strings) |
| type | string | | Field type (see [Form Rendering service](../services/form-rendering.service.md) for a list of available type strings) |
| value | any | | Field value (implemented by get/set) |
| readOnly | boolean | | Is this a read-only field? (Implemented by get/set) |
| required | boolean | | Is the field required to have a value? (Implemented by get/set) |
@@ -30,7 +30,7 @@ Contains the value and metadata for a field of a [`Form`](../../lib/process-serv
| minValue | string | | Minimum allowed value (eg, for number or date) |
| maxValue | string | | Minimum allowed value (eg, for number or date) |
| regexPattern | string | | Regular expression that text data should match |
| options | [`FormFieldOption`](../../lib/core/form/components/widgets/core/form-field-option.ts)\[] | \[] | Option items for a dropdown menu |
| options | [`FormFieldOption`](../../../lib/core/form/components/widgets/core/form-field-option.ts)\[] | \[] | Option items for a dropdown menu |
| restUrl | string | | URL for a REST call to populate a dropdown menu |
| restResponsePath | string | | Path within REST response JSON to the array of dropdown data |
| restIdProperty | string | | JSON property name to use for the `id` property of a dropdown item |
@@ -38,42 +38,42 @@ Contains the value and metadata for a field of a [`Form`](../../lib/process-serv
| hasEmptyValue | boolean | | Is the field's value empty? (eg, dropdown with no item selected) |
| className | string | | CSS class name for the field |
| optionType | string | | |
| params | [`FormFieldMetadata`](../../lib/core/form/components/widgets/core/form-field-metadata.ts) | {} | |
| params | [`FormFieldMetadata`](../../../lib/core/form/components/widgets/core/form-field-metadata.ts) | {} | |
| hyperlinkUrl | string | | URL for Hyperlink widgets |
| displayText | string | | Displayed text for Hyperlink widgets |
| isVisible | boolean | true | Is the field shown on the form? |
| visibilityCondition | [`WidgetVisibilityModel`](../../lib/core/form/models/widget-visibility.model.ts) | null | Defines a expression that determines whether the field is visible or not, based on its logical relation to values in other fields |
| visibilityCondition | [`WidgetVisibilityModel`](../../../lib/core/form/models/widget-visibility.model.ts) | null | Defines a expression that determines whether the field is visible or not, based on its logical relation to values in other fields |
| enableFractions | boolean | false | Are numeric values allowed to contain a decimal point? |
| currency | string | null | Currency symbol for Amount widgets |
| dateDisplayFormat | string | | Date/time display format template |
| numberOfColumns | number | 1 | Number of columns defined by a container field |
| fields | [`FormFieldModel`](../core/form-field.model.md)\[] | \[] | Fields contained within a container field |
| columns | [`ContainerColumnModel`](../../lib/core/form/components/widgets/core/container-column.model.ts)\[] | \[] | Column definitions for a container field |
| emptyOption | [`FormFieldOption`](../../lib/core/form/components/widgets/core/form-field-option.ts) | | Dropdown menu item to use when no option is chosen |
| validationSummary | string | | Error/information message added during field validation (see [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) interface) |
| fields | [`FormFieldModel`](../../core/models/form-field.model.md)\[] | \[] | Fields contained within a container field |
| columns | [`ContainerColumnModel`](../../../lib/core/form/components/widgets/core/container-column.model.ts)\[] | \[] | Column definitions for a container field |
| emptyOption | [`FormFieldOption`](../../../lib/core/form/components/widgets/core/form-field-option.ts) | | Dropdown menu item to use when no option is chosen |
| validationSummary | string | | Error/information message added during field validation (see [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) interface) |
## Details
Every field of a form has an associated [`FormFieldModel`](../core/form-field.model.md) instance that contains the
Every field of a form has an associated [`FormFieldModel`](../../core/models/form-field.model.md) instance that contains the
field's value and metadata. The standard widgets use this information to render fields and you can also make use of it in your own custom widgets and field validators.
### Custom widgets
You will need to use the properties of [`FormFieldModel`](../core/form-field.model.md) if you want to implement your own
You will need to use the properties of [`FormFieldModel`](../../core/models/form-field.model.md) if you want to implement your own
custom widgets. Aside from the `value` property (which contains the data value entered into
the field), there are also a few other fields that are used for specific types of data. For
example, the `currency` property holds the currency symbol to be displayed next to the value
(such as the dollar sign $) and the `dateDisplayFormat` defines how the elements of a date/time will be arranged. See the [Form Extensibility and Customization](../user-guide/extensibility.md) for more information about creating custom widgets.
(such as the dollar sign $) and the `dateDisplayFormat` defines how the elements of a date/time will be arranged. See the [Form Extensibility and Customization](../../user-guide/extensibility.md) for more information about creating custom widgets.
### Validation
A [`Form`](../../lib/process-services/task-list/models/form.model.ts) or [Task Details](../process-services/task-details.component.md) component can
A [`Form`](../../../lib/process-services/task-list/models/form.model.ts) or [Task Details](../../process-services/components/task-details.component.md) component can
be supplied with a set of validator objects. Each validator applies a particular kind of
check to a field. A number of [`FormFieldModel`](../core/form-field.model.md) properties are used by validators. For
check to a field. A number of [`FormFieldModel`](../../core/models/form-field.model.md) properties are used by validators. For
example, `minValue` and `maxValue` are used to check that a numeric value falls within an
allowed range and `regexPattern` defines a regular expression that a text field should
match. Also, the `validationSummary` is used to send a message back from the validator
for the user to read. See the [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts) page for more information about implementing validators.
for the user to read. See the [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) page for more information about implementing validators.
### REST properties
@@ -96,7 +96,7 @@ contains full details about how the REST calls work, along with a worked example
## See also
- [Extensibility](../user-guide/extensibility.md)
- [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)
- [Form rendering service](form-rendering.service.md)
- [Form component](form.component.md)
- [Extensibility](../../user-guide/extensibility.md)
- [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)
- [Form rendering service](../services/form-rendering.service.md)
- [Form component](../components/form.component.md)

6
docs/core/product-version.model.md → docs/core/models/product-version.model.md
View File

@@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active
---
# [Product Version model](../../lib/core/models/product-version.model.ts "Defined in product-version.model.ts")
# [Product Version model](../../../lib/core/models/product-version.model.ts "Defined in product-version.model.ts")
Contains version and license information classes for Alfresco products.
@@ -12,7 +12,7 @@ Contains version and license information classes for Alfresco products.
The classes in this model contain details about the version and license
status of Process Services and Content Services. You can access this
information from ADF using the [Discovery Api service](discovery-api.service.md).
information from ADF using the [Discovery Api service](../services/discovery-api.service.md).
See also the
[Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-discovery-rest-api)
to learn more about the REST architecture that the service is based on.
@@ -75,4 +75,4 @@ class VersionModuleModel {
## See also
- [Discovery api service](discovery-api.service.md)
- [Discovery api service](../services/discovery-api.service.md)

4
docs/core/user-process.model.md → docs/core/models/user-process.model.md
View File

@@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active
---
# [User Process model](../../lib/core/models/user-process.model.ts "Defined in user-process.model.ts")
# [User Process model](../../../lib/core/models/user-process.model.ts "Defined in user-process.model.ts")
Represents a Process Services user.
@@ -21,4 +21,4 @@ latest version of the class, see the
## See also
- [People process service](people-process.service.md)
- [People process service](../services/people-process.service.md)

57
docs/core/node.service.md
View File

@@ -1,57 +0,0 @@
---
Title: Node Service
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-20
---
# [Node Service](../../lib/core/form/services/node.service.ts "Defined in node.service.ts")
Gets Alfresco Repository node metadata and creates nodes with metadata.
## Class members
### Methods
- **createNode**(name: `string`, nodeType: `string`, properties: `any`, path: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Create a new Node from form metadata
- _name:_ `string` - Node name
- _nodeType:_ `string` - Node type
- _properties:_ `any` - Node body properties
- _path:_ `string` - Path to the node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - The created node
- **createNodeMetadata**(nodeType: `string`, nameSpace: `any`, data: `any`, path: `string`, name?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Create a new Node from form metadata.
- _nodeType:_ `string` - Node type
- _nameSpace:_ `any` - Namespace for properties
- _data:_ `any` - [Property](../../lib/content-services/content-metadata/interfaces/property.interface.ts) data to store in the node under namespace
- _path:_ `string` - Path to the node
- _name:_ `string` - (Optional) Node name
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - The created node
- **getNodeMetadata**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../lib/core/form/models/node-metadata.model.ts)`>`<br/>
Get the metadata and the nodeType for a nodeId cleaned by the prefix.
- _nodeId:_ `string` - ID of the target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../lib/core/form/models/node-metadata.model.ts)`>` - Node metadata
## Details
Note that this service cannot be used to create nodes with content.
The `path` parameter to `createNode` and `createNodeMetadata` specifies an intermediate
path of folders to create between the root and the target node.
### Importing
```ts
import { NodeService } from '@alfresco/adf-core';
export class SomePageComponent implements OnInit {
constructor(private nodeService: NodeService) {
}
```
## See also
- [Nodes api service](nodes-api.service.md)
- [Deleted nodes api service](deleted-nodes-api.service.md)

4
docs/core/app-config.pipe.md → docs/core/pipes/app-config.pipe.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-05-24
---
# [App Config Pipe](../../lib/core/app-config/app-config.pipe.ts "Defined in app-config.pipe.ts")
# [App Config Pipe](../../../lib/core/app-config/app-config.pipe.ts "Defined in app-config.pipe.ts")
Retrieves values from the application configuration file directly.
@@ -42,4 +42,4 @@ You can also chain values with other pipes such as the translation pipe:
## See also
- [App Config service](app-config.service.md)
- [App Config service](../services/app-config.service.md)

2
docs/core/file-size.pipe.md → docs/core/pipes/file-size.pipe.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14
---
# [File Size pipe](../../lib/core/pipes/file-size.pipe.ts "Defined in file-size.pipe.ts")
# [File Size pipe](../../../lib/core/pipes/file-size.pipe.ts "Defined in file-size.pipe.ts")
Converts a number of bytes to the equivalent in KB, MB, etc.

2
docs/core/format-space.pipe.md → docs/core/pipes/format-space.pipe.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-27
---
# [Format Space pipe](../../lib/core/pipes/format-space.pipe.ts "Defined in format-space.pipe.ts")
# [Format Space pipe](../../../lib/core/pipes/format-space.pipe.ts "Defined in format-space.pipe.ts")
Replaces all the white space in a string with a supplied character.

6
docs/core/full-name.pipe.md → docs/core/pipes/full-name.pipe.md
View File

@@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2018-11-12
---
# [Full name pipe](../../lib/core/pipes/full-name.pipe.ts "Defined in full-name.pipe.ts")
# [Full name pipe](../../../lib/core/pipes/full-name.pipe.ts "Defined in full-name.pipe.ts")
Joins the first and last name properties from a [`UserProcessModel`](../core/user-process.model.md) object into a single string.
Joins the first and last name properties from a [`UserProcessModel`](../../core/models/user-process.model.md) object into a single string.
## Basic Usage
@@ -23,7 +23,7 @@ Joins the first and last name properties from a [`UserProcessModel`](../core/use
## Details
The pipe offers a convenient way to extract the name from a [User process model](../core/user-process.model.md) object.
The pipe offers a convenient way to extract the name from a [User process model](../models/user-process.model.md) object.
## See also

30
docs/core/pipes/mime-type-icon.pipe.md Normal file
View File

@@ -0,0 +1,30 @@
---
Title: Mime Type Icon pipe
Added: v2.0.0
Status: Active
---
# [Mime Type Icon pipe](../../../lib/core/pipes/mime-type-icon.pipe.ts "Defined in mime-type-icon.pipe.ts")
Retrieves an icon to represent a MIME type.
## Basic Usage
<!-- {% raw %} -->
```HTML
<div>
<img src='{{ "image/jpeg" | adfMimeTypeIcon }}' />
</div>
```
<!-- {% endraw %} -->
## Details
The pipe takes a MIME type as input and returns the URL of an SVG file that
symbolizes that type (see the [Thumbnail service](../services/thumbnail.service.md) for the mapping between types and icons). The pipe will return a "miscellaneous" icon when no specific mapping is defined.
## See also
- [Thumbnail service](../services/thumbnail.service.md)

4
docs/core/node-name-tooltip.pipe.md → docs/core/pipes/node-name-tooltip.pipe.md
View File

@@ -4,9 +4,9 @@ Added: v2.0.0
Status: Active
---
# [Node Name Tooltip pipe](../../lib/core/pipes/node-name-tooltip.pipe.ts "Defined in node-name-tooltip.pipe.ts")
# [Node Name Tooltip pipe](../../../lib/core/pipes/node-name-tooltip.pipe.ts "Defined in node-name-tooltip.pipe.ts")
Formats the tooltip for a Node.
Formats the tooltip for a [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md).
## Basic Usage

8
docs/core/text-highlight.pipe.md → docs/core/pipes/text-highlight.pipe.md
View File

@@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active
---
# [Text Highlight pipe](../../lib/core/pipes/text-highlight.pipe.ts "Defined in text-highlight.pipe.ts")
# [Text Highlight pipe](../../../lib/core/pipes/text-highlight.pipe.ts "Defined in text-highlight.pipe.ts")
Adds highlighting to words or sections of text that match a search string.
@@ -24,10 +24,10 @@ Adds highlighting to words or sections of text that match a search string.
The pipe's parameter is a string to search for in the text. Any occurrences of the string will
be highlighted with added HTML (see the
[Highlight Transform service](highlight-transform.service.md) for more information about how
[Highlight Transform service](../services/highlight-transform.service.md) for more information about how
this is implemented). The parameter can contain spaces, in which case each separate "word" in the string will be highlighted individually.
## See also
- [Highlight directive](highlight.directive.md)
- [Highlight transform service](highlight-transform.service.md)
- [Highlight directive](../directives/highlight.directive.md)
- [Highlight transform service](../services/highlight-transform.service.md)

2
docs/core/time-ago.pipe.md → docs/core/pipes/time-ago.pipe.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Time Ago pipe](../../lib/core/pipes/time-ago.pipe.ts "Defined in time-ago.pipe.ts")
# [Time Ago pipe](../../../lib/core/pipes/time-ago.pipe.ts "Defined in time-ago.pipe.ts")
Converts a recent past date into a number of days ago.

6
docs/core/user-initial.pipe.md → docs/core/pipes/user-initial.pipe.md
View File

@@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2018-11-12
---
# [User Initial pipe](../../lib/core/pipes/user-initial.pipe.ts "Defined in user-initial.pipe.ts")
# [User Initial pipe](../../../lib/core/pipes/user-initial.pipe.ts "Defined in user-initial.pipe.ts")
Takes the name fields of a [`UserProcessModel`](../core/user-process.model.md) object and extracts and formats the initials.
Takes the name fields of a [`UserProcessModel`](../../core/models/user-process.model.md) object and extracts and formats the initials.
## Basic Usage
@@ -33,4 +33,4 @@ Both parameters default to empty strings.
## See also
- [Full name pipe](../core/full-name.pipe.md)
- [Full name pipe](full-name.pipe.md)

2
docs/core/activiti-alfresco.service.md → docs/core/services/activiti-alfresco.service.md
View File

@@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active
---
# [APS Alfresco Content Service](../../lib/core/form/services/activiti-alfresco.service.ts "Defined in activiti-alfresco.service.ts")
# [APS Alfresco Content Service](../../../lib/core/form/services/activiti-alfresco.service.ts "Defined in activiti-alfresco.service.ts")
Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS).

63
docs/core/services/alfresco-api.service.md Normal file
View File

@@ -0,0 +1,63 @@
---
Title: Alfresco Api Service
Added: v2.0.0
Status: Active
Last reviewed: 2019-01-17
---
# [Alfresco Api Service](../../../lib/core/services/alfresco-api.service.ts "Defined in alfresco-api.service.ts")
Provides access to an initialized **AlfrescoJSApi** instance.
## Basic Usage
```ts
export class MyComponent implements OnInit {
constructor(private apiService: AlfrescoApiService) {
}
ngOnInit() {
let nodeId = 'some-node-id';
let params = {};
this.apiService.getInstance().nodes
.getNodeChildren(nodeId, params)
.then(result => console.log(result));
}
}
```
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| contentApi | [`ContentApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/content.api.ts) | | (Read only) Accesses the Content API |
| nodesApi | [`NodesApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/nodes.api.ts) | | (Read only) Accesses the Nodes API |
| renditionsApi | [`RenditionsApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/renditions.api.ts) | | (Read only) Accesses the Renditions API |
| sharedLinksApi | [`SharedLinksApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/sharedlinks.api.ts) | | (Read only) Accesses the Shared Links API |
| sitesApi | [`SitesApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/sites.api.ts) | | (Read only) Accesses the Sites API |
| favoritesApi | [`FavoritesApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/favorites.api.ts) | | (Read only) Accesses the Favorites API |
| peopleApi | [`PeopleApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/people.api.ts) | | (Read only) Accesses the People API |
| searchApi | [`SearchApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api-legacy/legacy.ts) | | (Read only) Accesses the Search API |
| versionsApi | [`VersionsApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/versions.api.ts) | | (Read only) Accesses the Versions API |
| classesApi | [`ClassesApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/classes.api.ts) | | (Read only) Accesses the Classes API |
| groupsApi | [`GroupsApi`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/api/groups.api.ts) | | (Read only) Accesses the Groups API |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| nodeUpdated | [`Subject`](http://reactivex.io/documentation/subject.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md)`>` | Emitted when a node updates. |
## Details
**Note for developers**: The TypeScript declaration files for the Alfresco JS API
are still under development and some Alfresco APIs may not be accessible
via your IDE's intellisense or TypeScript compiler.
To avoid these TypeScript type check errors, you can call any supported
Alfresco JS api by casting the instance to the `any` type as in the following example:
```ts
let api: any = this.apiService.getInstance();
api.nodes.addNode('-root-', body, {});
```

12
docs/core/app-config.service.md → docs/core/services/app-config.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-09-13
---
# [App Config service](../../lib/core/app-config/app-config.service.ts "Defined in app-config.service.ts")
# [App Config service](../../../lib/core/app-config/app-config.service.ts "Defined in app-config.service.ts")
Supports app configuration settings, stored server side.
@@ -37,7 +37,7 @@ Supports app configuration settings, stored server side.
## Details
The [`AppConfigService`](../core/app-config.service.md) service provides support for loading and accessing global application configuration settings that you store on the server side in the form of a JSON file.
The [`AppConfigService`](../../core/services/app-config.service.md) service provides support for loading and accessing global application configuration settings that you store on the server side in the form of a JSON file.
You may need this service when deploying your ADF-based application to production servers.
There can be more than one server running web apps with different settings, like different addresses for Alfresco Content/Process services.
@@ -66,9 +66,9 @@ Example of the default settings file content:
Note that the settings in the example above are the default ones supplied with the server.
You can override the values in your custom `app.config.json` file if necessary.
Below is a simple example of using the [`AppConfigService`](../core/app-config.service.md) in practice.
Below is a simple example of using the [`AppConfigService`](../../core/services/app-config.service.md) in practice.
**[app.component](../../demo-shell/src/app/app.component.ts).ts**
**app.component.ts**
```ts
import { AppConfigService } from '@alfresco/adf-core';
@@ -88,12 +88,12 @@ export class AppComponent {
}
```
Your custom components can also benefit from the [`AppConfigService`](../core/app-config.service.md).
Your custom components can also benefit from the [`AppConfigService`](../../core/services/app-config.service.md).
You can create an unlimited number of settings and optionally organize them as a nested JSON hierarchy.
### Variable substitution in configuration strings
The [`AppConfigService`](../core/app-config.service.md) supports a limited set of variable substitutions to greatly simplify certain scenarios.
The [`AppConfigService`](../../core/services/app-config.service.md) supports a limited set of variable substitutions to greatly simplify certain scenarios.
```json
{

2
docs/core/apps-process.service.md → docs/core/services/apps-process.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-16
---
# [Apps Process service](../../lib/core/services/apps-process.service.ts "Defined in apps-process.service.ts")
# [Apps Process service](../../../lib/core/services/apps-process.service.ts "Defined in apps-process.service.ts")
Gets details of the Process Services apps that are deployed for the user.

2
docs/core/auth-guard-bpm.service.md → docs/core/services/auth-guard-bpm.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Auth Guard Bpm service](../../lib/core/services/auth-guard-bpm.service.ts "Defined in auth-guard-bpm.service.ts")
# [Auth Guard Bpm service](../../../lib/core/services/auth-guard-bpm.service.ts "Defined in auth-guard-bpm.service.ts")
Adds authentication with Process Services to a route within the app.

2
docs/core/auth-guard-ecm.service.md → docs/core/services/auth-guard-ecm.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Auth Guard Ecm service](../../lib/core/services/auth-guard-ecm.service.ts "Defined in auth-guard-ecm.service.ts")
# [Auth Guard Ecm service](../../../lib/core/services/auth-guard-ecm.service.ts "Defined in auth-guard-ecm.service.ts")
Adds authentication with Content Services to a route within the app.

5
docs/core/auth-guard-sso-role.service.md → docs/core/services/auth-guard-sso-role.service.md
View File

@@ -4,18 +4,17 @@ Added: v3.1.0
Status: Active
---
# [Auth Guard SSO role service](../../lib/core/services/auth-guard-sso-role.service.ts "Defined in auth-guard-sso-role.service.ts")
# [Auth Guard SSO role service](../../../lib/core/services/auth-guard-sso-role.service.ts "Defined in auth-guard-sso-role.service.ts")
Allow to check the user roles of a user
## Details
The Auth Guard SSO role service implements an Angular
The [Auth Guard SSO role service](../../core/services/auth-guard-sso-role.service.md) implements an Angular
[route guard](https://angular.io/guide/router#milestone-5-route-guards)
to check the user has the right role permission. This is typically used with the
`canActivate` guard check in the route definition. The roles that user needs to have in order to access the route has to be specified in the roles array as in the example below:
```ts
const appRoutes: Routes = [
...

2
docs/core/auth-guard.service.md → docs/core/services/auth-guard.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Auth Guard service](../../lib/core/services/auth-guard.service.ts "Defined in auth-guard.service.ts")
# [Auth Guard service](../../../lib/core/services/auth-guard.service.ts "Defined in auth-guard.service.ts")
Adds authentication to a route within the app.

11
docs/core/authentication.service.md → docs/core/services/authentication.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Authentication Service](../../lib/core/services/authentication.service.ts "Defined in authentication.service.ts")
# [Authentication Service](../../../lib/core/services/authentication.service.ts "Defined in authentication.service.ts")
Provides authentication to ACS and APS.
@@ -72,6 +72,9 @@ Provides authentication to ACS and APS.
- **isRememberMeSet**(): `boolean`<br/>
Checks whether the "remember me" cookie was set or not.
- **Returns** `boolean` - True if set, false otherwise
- **isSSODiscoveryConfigured**(): `boolean`<br/>
Check if SSO is configured correctly
- **Returns** `boolean` -
- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>`<br/>
Logs the user in.
- _username:_ `string` - Username for the login
@@ -81,9 +84,9 @@ Provides authentication to ACS and APS.
- **logout**(): `any`<br/>
Logs the user out.
- **Returns** `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.
- _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/>
Logs the user in with SSO
@@ -111,4 +114,4 @@ export class AppComponent {
## See also
- [Login component](login.component.md)
- [Login component](../components/login.component.md)

12
docs/core/bpm-user.service.md → docs/core/services/bpm-user.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Bpm User service](../../lib/core/userinfo/services/bpm-user.service.ts "Defined in bpm-user.service.ts")
# [Bpm User service](../../../lib/core/userinfo/services/bpm-user.service.ts "Defined in bpm-user.service.ts")
Gets information about the current Process Services user.
@@ -13,9 +13,9 @@ Gets information about the current Process Services user.
### Methods
- **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../core/bpm-user.model.md)`>`<br/>
- **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../../core/models/bpm-user.model.md)`>`<br/>
Gets information about the current user.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmUserModel`](../core/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/>
Gets the current user's profile image as a URL.
- **Returns** `string` - URL string
@@ -23,7 +23,7 @@ Gets information about the current Process Services user.
## Details
The class returned by `getCurrentUserInfo` is detailed
in the [Bpm User model docs](bpm-user.model.md).
in the [Bpm User model docs](../models/bpm-user.model.md).
See the
[getProfile](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProfileApi.md#getProfile)
@@ -33,5 +33,5 @@ methods in the Alfresco JS API for more information about the REST calls used by
## See also
- [Ecm user service](ecm-user.service.md)
- [Bpm user model](bpm-user.model.md)
- [Ecm user service](../services/ecm-user.service.md)
- [Bpm user model](../models/bpm-user.model.md)

34
docs/core/card-item-types.service.md → docs/core/services/card-item-types.service.md
View File

@@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Card Item Type service](../../lib/core/card-view/services/card-item-types.service.ts "Defined in card-item-types.service.ts")
# [Card Item Type service](../../../lib/core/card-view/services/card-item-types.service.ts "Defined in card-item-types.service.ts")
Maps type names to field component types for the [Card View component](../core/card-view.component.md).
Maps type names to field component types for the [Card View component](../components/card-view.component.md).
## Class members
@@ -18,9 +18,9 @@ Maps type names to field component types for the [Card View component](../core/c
- _type:_ `string` - The type whose resolver you want
- _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped
- **Returns** `DynamicComponentResolveFunction` - Resolver function
- **resolveComponentType**(model: [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
Finds the component type that is needed to render a form field.
- _model:_ [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../lib/process-services/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/task-list/models/form.model.ts) field model for the field to render
- _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped.
- **Returns** `Type<__type>` - Component type
- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)<br/>
@@ -31,7 +31,7 @@ Maps type names to field component types for the [Card View component](../core/c
## Details
The [Card View component](card-view.component.md) uses this service to find the component
The [Card View component](../components/card-view.component.md) uses this service to find the component
type that is required to display a particular field type (text, date, etc). The service
maps a type name string to a corresponding `DynamicComponentResolveFunction` that takes a
model object as a parameter and returns the component type needed to display that model.
@@ -40,20 +40,20 @@ The default mapping is shown below:
| Type string | Component |
| ----------- | --------- |
| 'text' | [`CardViewTextItemComponent`](../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
| 'int' | [`CardViewTextItemComponent`](../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
| 'float' | [`CardViewTextItemComponent`](../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
| 'date' | [`CardViewDateItemComponent`](../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) |
| 'datetime' | [`CardViewDateItemComponent`](../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) |
| 'bool' | [`CardViewBoolItemComponent`](../../lib/core/card-view/components/card-view-boolitem/card-view-boolitem.component.ts) |
| 'map' | [`CardViewMapItemComponent`](../../lib/core/card-view/components/card-view-mapitem/card-view-mapitem.component.ts) |
| 'text' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
| 'int' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
| 'float' | [`CardViewTextItemComponent`](../../../lib/core/card-view/components/card-view-textitem/card-view-textitem.component.ts) |
| 'date' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) |
| 'datetime' | [`CardViewDateItemComponent`](../../../lib/core/card-view/components/card-view-dateitem/card-view-dateitem.component.ts) |
| 'bool' | [`CardViewBoolItemComponent`](../../../lib/core/card-view/components/card-view-boolitem/card-view-boolitem.component.ts) |
| 'map' | [`CardViewMapItemComponent`](../../../lib/core/card-view/components/card-view-mapitem/card-view-mapitem.component.ts) |
### Adding new type mappings
You can define your own custom field types for the Card View (see the
[Card View Item interface](card-view-item.interface.md) page for full details of how to do this).
When you have defined the field component, you need to register it with the [Card Item Type service](../../lib/core/card-view/services/card-item-types.service.ts)
so that the [Card View component](../core/card-view.component.md) can make use of it:
[Card View Item interface](../interfaces/card-view-item.interface.md) page for full details of how to do this).
When you have defined the field component, you need to register it with the [Card Item Types service](../../../lib/core/card-view/services/card-item-types.service.ts)
so that the [Card View component](../components/card-view.component.md) can make use of it:
```ts
@Component({
@@ -71,5 +71,5 @@ export class SomeParentComponent {
## See also
- [Card View component](card-view.component.md)
- [Card View Item interface](card-view-item.interface.md)
- [Card View component](../components/card-view.component.md)
- [Card View Item interface](../interfaces/card-view-item.interface.md)

22
docs/core/card-view-update.service.md → docs/core/services/card-view-update.service.md
View File

@@ -5,13 +5,13 @@ Status: Active
Last reviewed: 2018-11-14
---
# [Card View Update service](../../lib/core/card-view/services/card-view-update.service.ts "Defined in card-view-update.service.ts")
# [Card View Update service](../../../lib/core/card-view/services/card-view-update.service.ts "Defined in card-view-update.service.ts")
Reports edits and clicks within fields of a [Card View component](../core/card-view.component.md).
Reports edits and clicks within fields of a [Card View component](../components/card-view.component.md).
## Details
You can use the [Card View Update service](../core/card-view-update.service.md) to respond to edits and clicks within items on
You can use the [Card View Update service](card-view-update.service.md) to respond to edits and clicks within items on
a card view. This might involve updating application data to reflect the changes made to
the view or could simply be a matter of highlighting a clicked item.
@@ -55,8 +55,8 @@ constructor(private cardViewUpdateService: CardViewUpdateService) {
}
```
The constructor here also sets the [`CardViewTextItemModel`](../../lib/core/card-view/models/card-view-textitem.model.ts) instances that define the layout of the
card view (see the [Card View component](card-view.component.md) for further information
The constructor here also sets the [`CardViewTextItemModel`](../../../lib/core/card-view/models/card-view-textitem.model.ts) instances that define the layout of the
card view (see the [Card View component](../components/card-view.component.md) for further information
about this). The model objects and the `key` property are used to identify which item has been clicked
or updated when an event occurs.
@@ -77,7 +77,7 @@ called after updates and clicks, respectively.
### Responding to updates
The update function is passed a parameter of type [`UpdateNotification`](../../lib/core/card-view/services/card-view-update.service.ts):
The update function is passed a parameter of type [`UpdateNotification`](../../../lib/core/card-view/services/card-view-update.service.ts):
```ts
export interface UpdateNotification {
@@ -86,8 +86,8 @@ export interface UpdateNotification {
}
```
Here, `target` contains the [`CardViewTextItemModel`](../../lib/core/card-view/models/card-view-textitem.model.ts) that was used to initialize
the field in question (in practice, this might be a [`CardViewDateItemModel`](../../lib/core/card-view/models/card-view-dateitem.model.ts) or [`CardViewMapItemModel`](../../lib/core/card-view/models/card-view-mapitem.model.ts) if
Here, `target` contains the [`CardViewTextItemModel`](../../../lib/core/card-view/models/card-view-textitem.model.ts) that was used to initialize
the field in question (in practice, this might be a [`CardViewDateItemModel`](../../../lib/core/card-view/models/card-view-dateitem.model.ts) or [`CardViewMapItemModel`](../../../lib/core/card-view/models/card-view-mapitem.model.ts) if
the card layout includes these objects). The `changed` property contains an object with a single property:
```ts
@@ -111,11 +111,11 @@ respondToCardUpdate(un: UpdateNotification) {
Note that the function will only be called if the `editable` property of the model object is set to true
for this item. Also, the `editable` value of all items will be overridden if `editable` is set to false
on the [Card View component](card-view.component.md) itself.
on the [Card View component](../components/card-view.component.md) itself.
### Responding to clicks
The click function is passed a [`ClickNotification`](../../lib/core/card-view/services/card-view-update.service.ts) object, which is similar to [`UpdateNotification`](../../lib/core/card-view/services/card-view-update.service.ts) described above,
The click function is passed a [`ClickNotification`](../../../lib/core/card-view/services/card-view-update.service.ts) object, which is similar to [`UpdateNotification`](../../../lib/core/card-view/services/card-view-update.service.ts) described above,
but without the `changed` property. Use the `target` property to identify the item that was clicked:
```ts
@@ -128,4 +128,4 @@ Note that this function will only be called if the `clickable` property of the m
## See also
- [Card view component](card-view.component.md)
- [Card view component](../components/card-view.component.md)

10
docs/core/comment-content.service.md → docs/core/services/comment-content.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-04-12
---
# [Comment Content service](../../lib/core/services/comment-content.service.ts "Defined in comment-content.service.ts")
# [Comment Content service](../../../lib/core/services/comment-content.service.ts "Defined in comment-content.service.ts")
Adds and retrieves comments for nodes in Content Services.
@@ -13,15 +13,15 @@ Adds and retrieves comments for nodes in Content Services.
### Methods
- **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>`<br/>
- **addNodeComment**(nodeId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/>
Adds a comment to a node.
- _nodeId:_ `string` - ID of the target node
- _message:_ `string` - Text for the comment
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>` - Details of the comment added
- **getNodeComments**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>`<br/>
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added
- **getNodeComments**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`<br/>
Gets all comments that have been added to a node.
- _nodeId:_ `string` - ID of the target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>` - Details for each comment
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment
## Details

18
docs/core/comment-process.service.md → docs/core/services/comment-process.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-14
---
# [Comment Process service](../../lib/core/services/comment-process.service.ts "Defined in comment-process.service.ts")
# [Comment Process service](../../../lib/core/services/comment-process.service.ts "Defined in comment-process.service.ts")
Adds and retrieves comments for task and process instances in Process Services.
@@ -13,24 +13,24 @@ Adds and retrieves comments for task and process instances in Process Services.
### Methods
- **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>`<br/>
- **addProcessInstanceComment**(processInstanceId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/>
Adds a comment to a process instance.
- _processInstanceId:_ `string` - ID of the target process instance
- _message:_ `string` - Text for the comment
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>` - Details of the comment added
- **addTaskComment**(taskId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>`<br/>
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details of the comment added
- **addTaskComment**(taskId: `string`, message: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>`<br/>
Adds a comment to a task.
- _taskId:_ `string` - ID of the target task
- _message:_ `string` - Text for the comment
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`>` - Details about the comment
- **getProcessInstanceComments**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>`<br/>
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` - Details about the comment
- **getProcessInstanceComments**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`<br/>
Gets all comments that have been added to a process instance.
- _processInstanceId:_ `string` - ID of the target process instance
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>` - Details for each comment
- **getTaskComments**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>`<br/>
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment
- **getTaskComments**(taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>`<br/>
Gets all comments that have been added to a task.
- _taskId:_ `string` - ID of the target task
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../lib/core/models/comment.model.ts)`[]>` - Details for each comment
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`[]>` - Details for each comment
## Details

25
docs/core/content.service.md → docs/core/services/content.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-02-13
---
# [Content service](../../lib/core/services/content.service.ts "Defined in content.service.ts")
# [Content service](../../../lib/core/services/content.service.ts "Defined in content.service.ts")
Accesses app-generated data objects via URLs and file downloads.
@@ -13,12 +13,6 @@ Accesses app-generated data objects via URLs and file downloads.
### Methods
- **createFolder**(relativePath: `string`, name: `string`, parentId?: `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/>
Creates a folder.
- _relativePath:_ `string` - Location to create the folder
- _name:_ `string` - Folder name
- _parentId:_ `string` - (Optional) Node ID of parent folder
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Information about the new folder
- **createTrustedUrl**(blob: [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)): `string`<br/>
Creates a trusted object URL from the [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob). WARNING: calling this method with untrusted user data exposes your application to XSS security risks!
- _blob:_ [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) - Data to wrap into object URL
@@ -37,13 +31,13 @@ Accesses app-generated data objects via URLs and file downloads.
- _fileName:_ `string` - Name of the resulting file.
- **getContentUrl**(node: `any`, attachment?: `boolean`, ticket?: `string`): `string`<br/>
Gets a content URL for the given node.
- _node:_ `any` - Node to get URL for.
- _node:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to get URL for.
- _attachment:_ `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download
- _ticket:_ `string` - (Optional) Custom ticket to use for authentication
- **Returns** `string` - URL string
- **getDocumentThumbnailUrl**(node: `any`, attachment?: `boolean`, ticket?: `string`): `string`<br/>
Gets a thumbnail URL for the given document node.
- _node:_ `any` - Node to get URL for.
- _node:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to get URL for.
- _attachment:_ `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download
- _ticket:_ `string` - (Optional) Custom ticket to use for authentication
- **Returns** `string` - URL string
@@ -56,15 +50,20 @@ Accesses app-generated data objects via URLs and file downloads.
Gets content for the given node.
- _nodeId:_ `string` - ID of the target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Content data
- **hasAllowableOperations**(node: `Node`, allowableOperation: [`AllowableOperationsEnum`](../../lib/core/models/allowable-operations.enum.ts)`|string`): `boolean`<br/>
- **hasAllowableOperations**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), allowableOperation: [`AllowableOperationsEnum`](../../../lib/core/models/allowable-operations.enum.ts)`|string`): `boolean`<br/>
Checks if the user has permissions on that node
- _node:_ `Node` - Node to check allowableOperations
- _allowableOperation:_ [`AllowableOperationsEnum`](../../lib/core/models/allowable-operations.enum.ts)`|string` - Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to check allowableOperations
- _allowableOperation:_ [`AllowableOperationsEnum`](../../../lib/core/models/allowable-operations.enum.ts)`|string` - Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
- **Returns** `boolean` - True if the user has the required permissions, false otherwise
- **hasPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), permission: [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string`): `boolean`<br/>
Checks if the user has permission on that node
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to check permissions
- _permission:_ [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string` -
- **Returns** `boolean` - True if the user has the required permissions, false otherwise
## Details
Use the [Content service](../core/content.service.md) to deliver data to the user from [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) objects.
Use the [Content service](content.service.md) to deliver data to the user from [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) objects.
The [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) class
(implemented in the browser, not ADF) represents an array of bytes that you can

2
docs/core/cookie.service.md → docs/core/services/cookie.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Cookie service](../../lib/core/services/cookie.service.ts "Defined in cookie.service.ts")
# [Cookie service](../../../lib/core/services/cookie.service.ts "Defined in cookie.service.ts")
Stores key-value data items as browser cookies.

8
docs/core/deleted-nodes-api.service.md → docs/core/services/deleted-nodes-api.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-04-05
---
# [Deleted Nodes Api service](../../lib/core/services/deleted-nodes-api.service.ts "Defined in deleted-nodes-api.service.ts")
# [Deleted Nodes Api service](../../../lib/core/services/deleted-nodes-api.service.ts "Defined in deleted-nodes-api.service.ts")
Gets a list of Content Services nodes currently in the trash.
@@ -13,14 +13,14 @@ Gets a list of Content Services nodes currently in the trash.
### Methods
- **getDeletedNodes**(options?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
- **getDeletedNodes**(options?: `Object`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets a list of nodes in the trash.
- _options:_ `Object` - (Optional) Options for JS-API call
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of nodes in the trash
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes in the trash
## Details
The `getDeletedNodes` method returns a [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) object that lists
The `getDeletedNodes` method returns a [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md) object that lists
the items in the trash. The format of the `options` parameter is
described in the [getDeletedNodes](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#getDeletedNodes)
page of the Alfresco JS API docs.

14
docs/core/discovery-api.service.md → docs/core/services/discovery-api.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Discovery Api service](../../lib/core/services/discovery-api.service.ts "Defined in discovery-api.service.ts")
# [Discovery Api service](../../../lib/core/services/discovery-api.service.ts "Defined in discovery-api.service.ts")
Gets version and license information for Process Services and Content Services.
@@ -13,21 +13,21 @@ Gets version and license information for Process Services and Content Services.
### Methods
- **getBpmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../lib/core/models/product-version.model.ts)`>`<br/>
- **getBpmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>`<br/>
Gets product information for Process Services.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details
- **getEcmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmProductVersionModel`](../../lib/core/models/product-version.model.ts)`>`<br/>
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details
- **getEcmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>`<br/>
Gets product information for Content Services.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmProductVersionModel`](../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details
## Details
The product license and version information is returned using the
classes defined in the [Product Version model](product-version.model.md).
classes defined in the [Product Version model](../models/product-version.model.md).
See the
[Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-discovery-rest-api)
to learn more about the REST API used by this service.
## See also
- [Product version model](product-version.model.md)
- [Product version model](../models/product-version.model.md)

2
docs/core/download-zip.service.md → docs/core/services/download-zip.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-08
---
# [Download zip service](../../lib/core/services/download-zip.service.ts "Defined in download-zip.service.ts")
# [Download zip service](../../../lib/core/services/download-zip.service.ts "Defined in download-zip.service.ts")
Creates and manages downloads.

18
docs/core/ecm-user.service.md → docs/core/services/ecm-user.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Ecm User service](../../lib/core/userinfo/services/ecm-user.service.ts "Defined in ecm-user.service.ts")
# [Ecm User service](../../../lib/core/userinfo/services/ecm-user.service.ts "Defined in ecm-user.service.ts")
Gets information about a Content Services user.
@@ -13,13 +13,13 @@ Gets information about a Content Services user.
### Methods
- **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../core/ecm-user.model.md)`>`<br/>
- **getCurrentUserInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`<br/>
Gets information about the user who is currently logged-in.
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../core/ecm-user.model.md)`>` - User information as for getUserInfo
- **getUserInfo**(userName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../core/ecm-user.model.md)`>`<br/>
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - User information as for getUserInfo
- **getUserInfo**(userName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>`<br/>
Gets information about a user identified by their username.
- _userName:_ `string` - Target username
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../core/ecm-user.model.md)`>` - User information
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`EcmUserModel`](../../core/models/ecm-user.model.md)`>` - User information
- **getUserProfileImage**(avatarId: `string`): `string`<br/>
Returns a profile image as a URL.
- _avatarId:_ `string` - Target avatar
@@ -28,8 +28,8 @@ Gets information about a Content Services user.
## Details
The class returned by `getUserInfo` and `getCurrentUserInfo` is detailed
in the [Ecm User model docs](ecm-user.model.md). The `avatarId` passed to
`getUserProfileImage` is available as a field of the [`EcmUserModel`](../core/ecm-user.model.md) instance
in the [Ecm User model docs](../models/ecm-user.model.md). The `avatarId` passed to
`getUserProfileImage` is available as a field of the [`EcmUserModel`](../../core/models/ecm-user.model.md) instance
returned for a particular person.
See the
@@ -38,5 +38,5 @@ method in the Alfresco JS API for more information about the REST calls used by
## See also
- [Bpm user service](bpm-user.service.md)
- [Ecm user model](ecm-user.model.md)
- [Bpm user service](../services/bpm-user.service.md)
- [Ecm user model](../models/ecm-user.model.md)

10
docs/core/favorites-api.service.md → docs/core/services/favorites-api.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-05-04
---
# [Favorites Api service](../../lib/core/services/favorites-api.service.ts "Defined in favorites-api.service.ts")
# [Favorites Api service](../../../lib/core/services/favorites-api.service.ts "Defined in favorites-api.service.ts")
Gets a list of items a user has marked as their favorites.
@@ -13,20 +13,20 @@ Gets a list of items a user has marked as their favorites.
### Methods
- **getFavorites**(personId: `string`, options?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
- **getFavorites**(personId: `string`, options?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets the favorites for a user.
- _personId:_ `string` - ID of the user
- _options:_ `any` - (Optional) Options supported by JS-API
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of favorites
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorites
- **remapFavoriteEntries**(entries: `any[]`): `any[]`<br/>
- _entries:_ `any[]` -
- **Returns** `any[]` -
- **remapFavoritesData**(data: `any` = `{}`): [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
- **remapFavoritesData**(data: `any` = `{}`): [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)<br/>
- _data:_ `any` -
- **Returns** [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) -
- **Returns** [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md) -
- **remapEntry**(\_\_namedParameters: `Function`): `any`<br/>

58
docs/core/form-rendering.service.md → docs/core/services/form-rendering.service.md
View File

@@ -5,9 +5,9 @@ Status: Active
Last reviewed: 2018-11-20
---
# [Form Rendering service](../../lib/core/form/services/form-rendering.service.ts "Defined in form-rendering.service.ts")
# [Form Rendering service](../../../lib/core/form/services/form-rendering.service.ts "Defined in form-rendering.service.ts")
Maps a form field type string onto the corresponding form [widget component](../insights/widget.component.md) type.
Maps a form field type string onto the corresponding form [widget component](../../insights/widget.component.md) type.
## Class members
@@ -18,9 +18,9 @@ Maps a form field type string onto the corresponding form [widget component](../
- _type:_ `string` - The type whose resolver you want
- _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped
- **Returns** `DynamicComponentResolveFunction` - Resolver function
- **resolveComponentType**(model: [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
- **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`<br/>
Finds the component type that is needed to render a form field.
- _model:_ [`DynamicComponentModel`](../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../lib/process-services/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/task-list/models/form.model.ts) field model for the field to render
- _defaultValue:_ `Type<__type>` - Default type returned for field types that are not yet mapped.
- **Returns** `Type<__type>` - Component type
- **setComponentTypeResolver**(type: `string`, resolver: `DynamicComponentResolveFunction`, override: `boolean` = `true`)<br/>
@@ -31,10 +31,10 @@ Maps a form field type string onto the corresponding form [widget component](../
## Details
The [`Form`](../../lib/process-services/task-list/models/form.model.ts) Field component uses this service to choose which widget to use to render an instance of a
form field. The [`Form`](../../lib/process-services/task-list/models/form.model.ts) Field model stores the field type name as a string (see the table below).
The [`Form`](../../lib/process-services/task-list/models/form.model.ts) Rendering service maintains a mapping between each type name and
a corresponding `DynamicComponentResolveFunction`. The function takes a [`FormFieldModel`](../core/form-field.model.md) object as its argument and
The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Field component uses this service to choose which widget to use to render an instance of a
form field. The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Field model stores the field type name as a string (see the table below).
The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Rendering service maintains a mapping between each type name and
a corresponding `DynamicComponentResolveFunction`. The function takes a [`FormFieldModel`](../../core/models/form-field.model.md) object as its argument and
uses the data from the object to determine which widget should be used to render the field.
In some cases, the field type string alone is enough to determine the widget type and so the function
@@ -60,27 +60,27 @@ formRenderingService.setComponentTypeResolver('text', customResolver, true);
### Default type mapping
The [`Form`](../../lib/process-services/task-list/models/form.model.ts) Rendering service is initialized with the mapping shown in the table below:
The [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Rendering service is initialized with the mapping shown in the table below:
| Stencil name | Field type string | Component type |
| ------------ | ----------------- | -------------- |
| Amount | "amount" | [`AmountWidgetComponent`](../../lib/core/form/components/widgets/amount/amount.widget.ts) |
| Attach | "upload" | AttachWidgetComponent or [`UploadWidgetComponent`](../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
| Checkbox | "boolean" | [`CheckboxWidgetComponent`](../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
| Date | "date" | [`DateWidgetComponent`](../../lib/core/form/components/widgets/date/date.widget.ts) |
| Display text | "readonly-text" | [`DisplayTextWidgetComponentComponent`](../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
| Amount | "amount" | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) |
| Attach | "upload" | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
| Checkbox | "boolean" | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
| Date | "date" | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) |
| Display text | "readonly-text" | [`DisplayTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
| Display value | "readonly" | DisplayValueWidgetComponent |
| Dropdown | "dropdown" | [`DropdownWidgetComponent`](../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
| Dynamic table | "dynamic-table" | [`DynamicTableWidgetComponent`](../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
| Group of people | "functional-group" | [`FunctionalGroupWidgetComponent`](../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
| Header | "group" | [`ContainerWidgetComponent`](../../lib/core/form/components/widgets/container/container.widget.ts) |
| Hyperlink | "hyperlink" | [`HyperlinkWidgetComponent`](../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
| Multi-line text | "multi-line-text" | [`MultilineTextWidgetComponentComponent`](../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
| Number | "integer" | [`NumberWidgetComponent`](../../lib/core/form/components/widgets/number/number.widget.ts) |
| People | "people" | [`PeopleWidgetComponent`](../../lib/core/form/components/widgets/people/people.widget.ts) |
| Radio buttons | "radio-buttons" | [`RadioButtonsWidgetComponent`](../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
| Text | "text" | [`TextWidgetComponent`](../../lib/core/form/components/widgets/text/text.widget.ts) |
| Typeahead | "typeahead" | [`TypeaheadWidgetComponent`](../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
| Dropdown | "dropdown" | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
| Dynamic table | "dynamic-table" | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
| Group of people | "functional-group" | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
| Header | "group" | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) |
| Hyperlink | "hyperlink" | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
| Multi-line text | "multi-line-text" | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
| Number | "integer" | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) |
| People | "people" | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) |
| Radio buttons | "radio-buttons" | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
| Text | "text" | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
| Typeahead | "typeahead" | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
You can add new items to the mapping or replace existing items in order to customize the way
fields are rendered.
@@ -97,11 +97,11 @@ formRenderingService.setComponentTypeResolver('text', newResolver, true);
You would typically use this to replace an existing widget with your own custom version that
implements a modified layout or responds differently when the data is entered. See the
[Form Extensibility and Customisation](../user-guide/extensibility.md) guide for further details and examples
[Form Extensibility and Customisation](../../user-guide/extensibility.md) guide for further details and examples
of this technique.
## See also
- [Extensibility](../user-guide/extensibility.md)
- [Form field model](form-field.model.md)
- [Form component](form.component.md)
- [Extensibility](../../user-guide/extensibility.md)
- [Form field model](../models/form-field.model.md)
- [Form component](../components/form.component.md)

50
docs/core/form.service.md → docs/core/services/form.service.md
View File

@@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active
---
# [Form service](../../lib/core/form/services/form.service.ts "Defined in form.service.ts")
# [Form service](../../../lib/core/form/services/form.service.ts "Defined in form.service.ts")
Implements Process Services form methods
@@ -39,29 +39,29 @@ class MyComponent {
| Name | Args Type | Description |
| ---- | --------- | ----------- |
| formLoaded | [`FormEvent`](../../lib/core/form/events/form.event.ts) | Raised when form has been loaded or reloaded |
| formFieldValueChanged | [`FormFieldEvent`](../../lib/core/form/events/form-field.event.ts) | Raised when input values change |
| taskCompleted | [`FormEvent`](../../lib/core/form/events/form.event.ts) | Raised when a task is completed successfully |
| taskCompletedError | [`FormErrorEvent`](../../lib/core/form/events/form-error.event.ts) | Raised when a task is completed unsuccessfully |
| taskSaved | [`FormEvent`](../../lib/core/form/events/form.event.ts) | Raised when a task is saved successfully |
| taskSavedError | [`FormErrorEvent`](../../lib/core/form/events/form-error.event.ts) | Raised when a task is saved unsuccessfully |
| executeOutcome | [`FormOutcomeEvent`](../../lib/core/form/components/widgets/core/form-outcome-event.model.ts) | Raised when a form outcome is executed |
| formLoaded | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when form has been loaded or reloaded |
| formFieldValueChanged | [`FormFieldEvent`](../../../lib/core/form/events/form-field.event.ts) | Raised when input values change |
| taskCompleted | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is completed successfully |
| taskCompletedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is completed unsuccessfully |
| taskSaved | [`FormEvent`](../../../lib/core/form/events/form.event.ts) | Raised when a task is saved successfully |
| taskSavedError | [`FormErrorEvent`](../../../lib/core/form/events/form-error.event.ts) | Raised when a task is saved unsuccessfully |
| executeOutcome | [`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts) | Raised when a form outcome is executed |
| formEvents | Event | You can subscribe to this event to listen : ( click, blur, change, focus, focusin, focusout, input, invalid, select) of any elements in the form , see doc below |
| validateForm | [`ValidateFormEvent`](../../lib/core/form/events/validate-form.event.ts) | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. |
| validateFormField | [`ValidateFormFieldEvent`](../../lib/core/form/events/validate-form-field.event.ts) | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. |
| validateForm | [`ValidateFormEvent`](../../../lib/core/form/events/validate-form.event.ts) | Raised each time a form is validated. You can use it to provide custom validation or prevent default behaviour. |
| validateFormField | [`ValidateFormFieldEvent`](../../../lib/core/form/events/validate-form-field.event.ts) | Raised each time a form field is validated. You can use it to provide custom validation or prevent default behaviour. |
### Methods
- `parseForm(json: any, data?:`[`FormValues,`](../../lib/core/form/components/widgets/core/form-values.ts)`readOnly: boolean = false):`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)
Parses JSON data to create a corresponding [`Form`](../../lib/process-services/task-list/models/form.model.ts) model.
- `parseForm(json: any, data?:`[`FormValues,`](../../../lib/core/form/components/widgets/core/form-values.ts)`readOnly: boolean = false):`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)
Parses JSON data to create a corresponding [`Form`](../../../lib/process-services/task-list/models/form.model.ts) model.
- `json` - JSON to create the form
- `data` - (Optional) Values for the form fields
- `readOnly` - Should the form fields be read-only?
- `createFormFromANode(formName: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Create a [`Form`](../../lib/process-services/task-list/models/form.model.ts) with a field for each metadata property.
Create a [`Form`](../../../lib/process-services/task-list/models/form.model.ts) with a field for each metadata property.
- `formName` - Name of the new form
- `createForm(formName: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Create a [`Form`](../../lib/process-services/task-list/models/form.model.ts).
Create a [`Form`](../../../lib/process-services/task-list/models/form.model.ts).
- `formName` - Name of the new form
- `saveForm(formId: string, formModel: FormDefinitionModel):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Saves a form.
@@ -86,20 +86,20 @@ class MyComponent {
Gets a task.
- `taskId` - Task Id
- `saveTaskForm(taskId: string, formValues: FormValues):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Save Task [`Form`](../../lib/process-services/task-list/models/form.model.ts).
Save Task [`Form`](../../../lib/process-services/task-list/models/form.model.ts).
- `taskId` - Task Id
- `formValues` - [`Form`](../../lib/process-services/task-list/models/form.model.ts) Values
- `completeTaskForm(taskId: string, formValues:`[`FormValues,`](../../lib/core/form/components/widgets/core/form-values.ts)`outcome?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Complete Task [`Form`](../../lib/process-services/task-list/models/form.model.ts)
- `formValues` - [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Values
- `completeTaskForm(taskId: string, formValues:`[`FormValues,`](../../../lib/core/form/components/widgets/core/form-values.ts)`outcome?: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Complete Task [`Form`](../../../lib/process-services/task-list/models/form.model.ts)
- `taskId` - Task Id
- `formValues` - [`Form`](../../lib/process-services/task-list/models/form.model.ts) Values
- `outcome` - (Optional) [`Form`](../../lib/process-services/task-list/models/form.model.ts) Outcome
- `formValues` - [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Values
- `outcome` - (Optional) [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Outcome
- `getTaskForm(taskId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Get [`Form`](../../lib/process-services/task-list/models/form.model.ts) related to a taskId
Get [`Form`](../../../lib/process-services/task-list/models/form.model.ts) related to a taskId
- `taskId` - Task Id
- `getFormDefinitionById(formId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Get [`Form`](../../lib/process-services/task-list/models/form.model.ts) Definition
- `formId` - [`Form`](../../lib/process-services/task-list/models/form.model.ts) Id
Get [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Definition
- `formId` - [`Form`](../../../lib/process-services/task-list/models/form.model.ts) Id
- `getFormDefinitionByName(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`
Returns form definition with a given name.
- `name` - The form name
@@ -133,11 +133,11 @@ class MyComponent {
- `getUserProfileImageApi(userId: number): string`
Returns a URL for the profile picture of a user.
- `userId` - ID of the target user
- [`getWorkflowUsers(filter: string, groupId?: string): Observable<UserProcessModel[]>`](../core/user-process.model.md)
- [`getWorkflowUsers(filter: string, groupId?: string): Observable<UserProcessModel[]>`](../../core/models/user-process.model.md)
Gets a list of workflow users.
- `filter` - Filter to select specific users
- `groupId` - (Optional) Group ID for the search
- [`getWorkflowGroups(filter: string, groupId?: string): Observable<GroupModel[]>`](../../lib/core/form/components/widgets/core/group.model.ts)
- [`getWorkflowGroups(filter: string, groupId?: string): Observable<GroupModel[]>`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)
Gets a list of groups in a workflow.
- `filter` - Filter to select specific groups
- `groupId` - (Optional) Group ID for the search

12
docs/core/highlight-transform.service.md → docs/core/services/highlight-transform.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-13
---
# [Highlight Transform service](../../lib/core/services/highlight-transform.service.ts "Defined in highlight-transform.service.ts")
# [Highlight Transform service](../../../lib/core/services/highlight-transform.service.ts "Defined in highlight-transform.service.ts")
Adds HTML to a string to highlight chosen sections.
@@ -13,12 +13,12 @@ Adds HTML to a string to highlight chosen sections.
### Methods
- **highlight**(text: `string`, search: `string`, wrapperClass: `string` = `"highlight"`): [`HighlightTransformResult`](../../lib/core/services/highlight-transform.service.ts)<br/>
- **highlight**(text: `string`, search: `string`, wrapperClass: `string` = `"adf-highlight"`): [`HighlightTransformResult`](../../../lib/core/services/highlight-transform.service.ts)<br/>
Searches for `search` string(s) within `text` and highlights all occurrences.
- _text:_ `string` - Text to search within
- _search:_ `string` - Text pattern to search for
- _wrapperClass:_ `string` - CSS class used to provide highlighting style
- **Returns** [`HighlightTransformResult`](../../lib/core/services/highlight-transform.service.ts) - New text along with boolean value to indicate whether anything was highlighted
- **Returns** [`HighlightTransformResult`](../../../lib/core/services/highlight-transform.service.ts) - New text along with boolean value to indicate whether anything was highlighted
## Details
@@ -33,7 +33,7 @@ highlight any of those words individually. The &lt;span> element includes a
`class` attribute which defaults to "highlight" but you can pass any class name
you like using the `wrapperClass` parameter.
The resulting text with HTML highlighting is returned within a [`HighlightTransformResult`](../../lib/core/services/highlight-transform.service.ts)
The resulting text with HTML highlighting is returned within a [`HighlightTransformResult`](../../../lib/core/services/highlight-transform.service.ts)
object:
```ts
@@ -48,5 +48,5 @@ took place) and true otherwise.
## See also
- [Text highlight pipe](text-highlight.pipe.md)
- [Highlight directive](highlight.directive.md)
- [Text highlight pipe](../pipes/text-highlight.pipe.md)
- [Highlight directive](../directives/highlight.directive.md)

32
docs/core/services/identity-user.service.md Normal file
View File

@@ -0,0 +1,32 @@
---
Title: Identity user service
Added: v3.0.0
Status: Active
Last reviewed: 2019-02-08
---
# [Identity user service](../../../lib/process-services-cloud/src/lib/services/identity-user.service.ts "Defined in identity-user.service.ts")
Gets OAuth2 personal details and roles for users.
## Class members
### Methods
- **findUsersByUsername**(username: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Finds groups filtered by username.
- _username:_ `string` - Object containing the name filter string
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of users information
## Details
[OAuth2](https://oauth.net/2/) defines an _access token_ (used when
authenticating a user) and a number of _authentication roles_ that the user
can participate in (see
[this page](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2)
for an introduction to OAuth2 and a description of the roles). You can use the
[Identity user service](identity-user.service.md) to access this information for users, including the current user.
## See also
- [JWT helper service](jwt-helper.service.md)

2
docs/core/jwt-helper.service.md → docs/core/services/jwt-helper.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-09
---
# [JWT helper service](../../lib/core/services/jwt-helper.service.ts "Defined in jwt-helper.service.ts")
# [JWT helper service](../../../lib/core/services/jwt-helper.service.ts "Defined in jwt-helper.service.ts")
Decodes a JSON Web Token (JWT) to a JavaScript object.

10
docs/core/log.service.md → docs/core/services/log.service.md
View File

@@ -5,13 +5,13 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Log Service](../../lib/core/services/log.service.ts "Defined in log.service.ts")
# [Log Service](../../../lib/core/services/log.service.ts "Defined in log.service.ts")
Provides log functionality.
## Basic Usage
**[app.component](../../demo-shell/src/app/app.component.ts).ts**
**app.component.ts**
```ts
import { LogService } from '@alfresco/adf-core';
@@ -64,10 +64,10 @@ export class AppComponent {
Logs a message at the "ERROR" level.
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../lib/core/models/log-levels.model.ts)<br/>
- **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts)<br/>
Converts a log level name string into its numeric equivalent.
- _level:_ `string` - Level name
- **Returns** [`LogLevelsEnum`](../../lib/core/models/log-levels.model.ts) - Numeric log level
- **Returns** [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts) - Numeric log level
- **group**(groupTitle?: `string`, optionalParams: `any[]`)<br/>
Starts an indented group of log messages.
- _groupTitle:_ `string` - (Optional) Title shown at the start of the group
@@ -125,7 +125,7 @@ For example, you can set the default log level to `WARNING` as follows:
### Log message bus
The [log service](../core/log.service.md) also provides an
The [log service](log.service.md) also provides an
[`Observable`](http://reactivex.io/documentation/observable.html) called `_onMessage_`
that you can subscribe to if you want to receive all the log messages.
The message object passed as a parameter to the `onMessage` handler has the following format:

8
docs/core/login-dialog.service.md → docs/core/services/login-dialog.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-02-08
---
# [Login Dialog service](../../lib/core/services/login-dialog.service.ts "Defined in login-dialog.service.ts")
# [Login Dialog service](../../../lib/core/services/login-dialog.service.ts "Defined in login-dialog.service.ts")
Manages login dialogs.
@@ -22,10 +22,10 @@ Manages login dialogs.
## Details
Use the methods of this service to manage login dialogs from code. As an alternative, you may
find it easier to use the [Login dialog component](login-dialog.component.md) to display the
find it easier to use the [Login dialog component](../components/login-dialog.component.md) to display the
dialog directly from HTML.
## See also
- [Login dialog component](login-dialog.component.md)
- [Login component](login.component.md)
- [Login dialog component](../components/login-dialog.component.md)
- [Login component](../components/login.component.md)

57
docs/core/services/node.service.md Normal file
View File

@@ -0,0 +1,57 @@
---
Title: Node Service
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-20
---
# [Node Service](../../../lib/core/form/services/node.service.ts "Defined in node.service.ts")
Gets Alfresco Repository node metadata and creates nodes with metadata.
## Class members
### Methods
- **createNode**(name: `string`, nodeType: `string`, properties: `any`, path: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
Create a new Node from form metadata
- _name:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) name
- _nodeType:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) type
- _properties:_ `any` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) body properties
- _path:_ `string` - Path to the node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node
- **createNodeMetadata**(nodeType: `string`, nameSpace: `any`, data: `any`, path: `string`, name?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
Create a new Node from form metadata.
- _nodeType:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) type
- _nameSpace:_ `any` - Namespace for properties
- _data:_ `any` - [Property](../../../lib/content-services/content-metadata/interfaces/property.interface.ts) data to store in the node under namespace
- _path:_ `string` - Path to the node
- _name:_ `string` - (Optional) [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) name
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - The created node
- **getNodeMetadata**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/form/models/node-metadata.model.ts)`>`<br/>
Get the metadata and the nodeType for a nodeId cleaned by the prefix.
- _nodeId:_ `string` - ID of the target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../../lib/core/form/models/node-metadata.model.ts)`>` - Node metadata
## Details
Note that this service cannot be used to create nodes with content.
The `path` parameter to `createNode` and `createNodeMetadata` specifies an intermediate
path of folders to create between the root and the target node.
### Importing
```ts
import { NodeService } from '@alfresco/adf-core';
export class SomePageComponent implements OnInit {
constructor(private nodeService: NodeService) {
}
```
## See also
- [Nodes api service](nodes-api.service.md)
- [Deleted nodes api service](deleted-nodes-api.service.md)

18
docs/core/nodes-api.service.md → docs/core/services/nodes-api.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-16
---
# [Nodes Api service](../../lib/core/services/nodes-api.service.ts "Defined in nodes-api.service.ts")
# [Nodes Api service](../../../lib/core/services/nodes-api.service.ts "Defined in nodes-api.service.ts")
Accesses and manipulates ACS document nodes using their node IDs.
@@ -46,11 +46,11 @@ Accesses and manipulates ACS document nodes using their node IDs.
- _nodeId:_ `string` - ID of the target node
- _options:_ `any` - Optional parameters supported by JS-API
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>` - Node information
- **getNodeChildren**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
- **getNodeChildren**(nodeId: `string`, options: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
Gets the items contained in a folder node.
- _nodeId:_ `string` - ID of the target node
- _options:_ `any` - Optional parameters supported by JS-API
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of child items from the folder
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>` - List of child items from the folder
- **restoreNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)`>`<br/>
Restores a node previously moved to the trashcan.
- _nodeId:_ `string` - ID of the node to restore
@@ -73,7 +73,7 @@ by dashes, eg:
The string is convenient for storage, for passing as an
[Angular route parameter](https://angular.io/guide/router)
and other purposes but doesn't enable you to do very much with the node itself.
The [Nodes Api Service](../core/nodes-api.service.md) has methods for getting information about nodes and
The [Nodes Api Service](nodes-api.service.md) has methods for getting information about nodes and
managing them within the repository (creating, deleting, etc).
Other lower level interfaces to the ACS nodes API are also available - see the
@@ -85,7 +85,7 @@ for more information.
### Getting node information
The `getNode` method gives access to the [MinimalNode](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) object that represents the
The `getNode` method gives access to the [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) object that represents the
details of a node:
```ts
@@ -111,11 +111,11 @@ modification dates, etc. Also, the `id` and `parentId` properties contain the no
ID strings for the current node and its enclosing folder.
Sometimes, a [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) is provided directly, for example, the `folderNode` property
of a [Document List component](../content-services/document-list.component.md) or the data context of a
[Document List row](../content-services/document-list.component.md#underlying-node-object). In these cases,
of a [Document List component](../../content-services/document-list.component.md) or the data context of a
[Document List row](../../content-services/document-list.component.md#underlying-node-object). In these cases,
you might pass the `id` or `parentId` as a [route parameter](https://angular.io/guide/router)
to a page describing the node in full detail. The component receiving the node ID can
use the [Nodes Api service](../core/nodes-api.service.md) to "decode" the ID string into a `MinimalNode`:
use the [Nodes Api service](nodes-api.service.md) to "decode" the ID string into a [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md):
```ts
import { ActivatedRoute, Router } from '@angular/router';
@@ -188,5 +188,5 @@ pages in the Alfresco JS API for further details and options. Note that you can
## See also
- [Deleted nodes api service](deleted-nodes-api.service.md)
- [Document list component](../content-services/document-list.component.md)
- [Document list component](../../content-services/document-list.component.md)
- [Node service](node.service.md)

10
docs/core/notification.service.md → docs/core/services/notification.service.md
View File

@@ -5,11 +5,11 @@ Status: Active
Last reviewed: 2018-06-08
---
# [Notification Service](../../lib/core/services/notification.service.ts "Defined in notification.service.ts")
# [Notification Service](../../../lib/core/services/notification.service.ts "Defined in notification.service.ts")
Shows a notification message with optional feedback.
![Notification Service screenshot](../docassets/images/NotiService.png)
![Notification Service screenshot](../../docassets/images/NotiService.png)
## Class members
@@ -17,12 +17,12 @@ Shows a notification message with optional feedback.
- **dismissSnackMessageAction**()<br/>
dismiss the notification snackbar
- **openSnackMessage**(message: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../core/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
- **openSnackMessage**(message: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../../core/services/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
Opens a SnackBar notification to show a message.
- _message:_ `string` - The message (or resource key) to show.
- _config:_ `number|MatSnackBarConfig` - Time before notification disappears after being shown or MatSnackBarConfig object
- **Returns** [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>` - Information/control object for the SnackBar
- **openSnackMessageAction**(message: `string`, action: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../core/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
- **openSnackMessageAction**(message: `string`, action: `string`, config: `number|MatSnackBarConfig` = [`NotificationService`](../../core/services/notification.service.md)`.DEFAULT_DURATION_MESSAGE`): [`MatSnackBarRef`](https://material.angular.io/components/snack-bar/overview)`<any>`<br/>
Opens a SnackBar notification with a message and a response button.
- _message:_ `string` - The message (or resource key) to show.
- _action:_ `string` - Caption for the response button
@@ -31,7 +31,7 @@ Shows a notification message with optional feedback.
## Details
The [Notification Service](../core/notification.service.md) is implemented on top of the Angular Material Design snackbar.
The [Notification Service](notification.service.md) is implemented on top of the Angular Material Design snackbar.
Use this service to show a notification message, and optionally get feedback from it.
```ts

2
docs/core/page-title.service.md → docs/core/services/page-title.service.md
View File

@@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-11-19
---
# [Page Title service](../../lib/core/services/page-title.service.ts "Defined in page-title.service.ts")
# [Page Title service](../../../lib/core/services/page-title.service.ts "Defined in page-title.service.ts")
Sets the page title.

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