diff --git a/docs/content-services/add-permission-panel.component.md b/docs/content-services/add-permission-panel.component.md index 3bae3fba7f..0afa3f396b 100644 --- a/docs/content-services/add-permission-panel.component.md +++ b/docs/content-services/add-permission-panel.component.md @@ -26,7 +26,7 @@ Searches for people or groups to add to the current node permissions. | Name | Type | Description | | -- | -- | -- | -| select | `EventEmitter` | Emitted when a permission list item is selected. | +| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission list item is selected. | ## Details diff --git a/docs/content-services/add-permission.component.md b/docs/content-services/add-permission.component.md index 7e2156fb93..3492682017 100644 --- a/docs/content-services/add-permission.component.md +++ b/docs/content-services/add-permission.component.md @@ -32,8 +32,8 @@ Searches for people or groups to add to the current node permissions. | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs during the update. | -| success | `EventEmitter` | Emitted when the node is updated successfully. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the update. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when the node is updated successfully. | ## Details diff --git a/docs/content-services/breadcrumb.component.md b/docs/content-services/breadcrumb.component.md index 705f73359c..84ce3129ec 100644 --- a/docs/content-services/breadcrumb.component.md +++ b/docs/content-services/breadcrumb.component.md @@ -25,18 +25,18 @@ Indicates the current position within a navigation hierarchy. | Name | Type | Default value | Description | | -- | -- | -- | -- | -| folderNode | `MinimalNodeEntryEntity` | null | Active node, builds UI based on folderNode.path.elements collection. | +| folderNode | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | null | Active node, builds UI based on folderNode.path.elements collection. | +| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | | root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | | rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | | target | [`DocumentListComponent`](../content-services/document-list.component.md) | | (optional) [Document List component](../content-services/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | | transform | `function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | -| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. Not restricted by default. | ### Events | Name | Type | Description | | -- | -- | -- | -| navigate | [`EventEmitter`](../../lib/content-services/document-list/models/document-library.model.ts) | Emitted when the user clicks on a breadcrumb. | +| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks on a breadcrumb. | ## Details diff --git a/docs/content-services/content-action.component.md b/docs/content-services/content-action.component.md index 7b5016143b..b6e2d79536 100644 --- a/docs/content-services/content-action.component.md +++ b/docs/content-services/content-action.component.md @@ -99,9 +99,9 @@ export class MyView { | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs during the action. Applies to copy and move actions. | -| execute | `EventEmitter` | Emitted when the user selects the action from the menu. | -| permissionEvent | `EventEmitter` | Emitted when a permission error occurs | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during the action. Applies to copy and move actions. | +| execute | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user selects the action from the menu. | +| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a permission error occurs | | success | `EventEmitter` | Emitted when the action succeeds with the success string message. Applies to copy, move and delete actions. | ## Details diff --git a/docs/content-services/content-metadata.component.md b/docs/content-services/content-metadata.component.md index 44e4a3d903..b649d1d50e 100644 --- a/docs/content-services/content-metadata.component.md +++ b/docs/content-services/content-metadata.component.md @@ -30,7 +30,7 @@ Displays and edits metadata related to a node. | editable | `boolean` | false | Toggles whether the edit button should be shown | | expanded | `boolean` | false | Toggles between expanded (ie, full information) and collapsed (ie, reduced information) in the display | | multi | `boolean` | false | The multi parameter of the underlying material expansion panel | -| node | `MinimalNodeEntryEntity` | | (required) The node entity to fetch metadata about | +| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | (required) The node entity to fetch metadata about | | preset | `string` | | Name of the metadata preset, which defines aspects and their properties | ## Details diff --git a/docs/content-services/content-node-dialog.service.md b/docs/content-services/content-node-dialog.service.md index 7d6b247558..e89ec34c3f 100644 --- a/docs/content-services/content-node-dialog.service.md +++ b/docs/content-services/content-node-dialog.service.md @@ -19,45 +19,45 @@ Displays and manages dialogs for selecting content to open, copy or upload. - _action:_ `string` - Name of the action to display in the dialog title - _name:_ `string` - Name of the item on which the action is being performed - **Returns** `string` - Translated version of the title -- **openCopyMoveDialog**(action: `string` = `null`, contentEntry: `MinimalNodeEntryEntity` = `null`, permission?: `string` = `null`): `Observable`
+- **openCopyMoveDialog**(action: `string` = `null`, contentEntry: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) = `null`, permission?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
Opens a dialog to copy or move an item to a new location. - _action:_ `string` - Name of the action (eg, "Copy" or "Move") to show in the title - - _contentEntry:_ `MinimalNodeEntryEntity` - Item to be copied or moved - - _permission:_ `string` - (Optional)Permission for the operation - - **Returns** `Observable` - Information about files that were copied/moved -- **openFileBrowseDialogByFolderId**(folderNodeId: `string` = `null`): `Observable`
+ - _contentEntry:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Item to be copied or moved + - _permission:_ `string` - (Optional) Permission for the operation + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about files that were copied/moved +- **openFileBrowseDialogByFolderId**(folderNodeId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
Opens a file browser at a chosen folder location. - _folderNodeId:_ `string` - ID of the folder to use - - **Returns** `Observable` - Information about the selected file(s) -- **openFileBrowseDialogBySite**(): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the selected file(s) +- **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
Opens a file browser at a chosen site location. - - **Returns** `Observable` - Information about the selected file(s) -- **openFolderBrowseDialogByFolderId**(folderNodeId: `string` = `null`): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the selected file(s) +- **openFolderBrowseDialogByFolderId**(folderNodeId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
Opens a folder browser at a chosen folder location. - _folderNodeId:_ `string` - ID of the folder to use - - **Returns** `Observable` - Information about the selected folder(s) -- **openFolderBrowseDialogBySite**(): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the selected folder(s) +- **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
Opens a folder browser at a chosen site location. - - **Returns** `Observable` - Information about the selected folder(s) -- **openLockNodeDialog**(contentEntry: `MinimalNodeEntryEntity` = `null`): `Subject`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the selected folder(s) +- **openLockNodeDialog**(contentEntry: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) = `null`): [`Subject`](http://reactivex.io/documentation/subject.html)``
Opens a lock node dialog. - - _contentEntry:_ `MinimalNodeEntryEntity` - Node to lock - - **Returns** `Subject` - Error/status message (if any) -- **openUploadFileDialog**(action: `string` = `null`, contentEntry: `MinimalNodeEntryEntity` = `null`): `Observable`
+ - _contentEntry:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Node to lock + - **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`` - Error/status message (if any) +- **openUploadFileDialog**(action: `string` = `null`, contentEntry: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
Opens a dialog to choose a file to upload. - _action:_ `string` - Name of the action to show in the title - - _contentEntry:_ `MinimalNodeEntryEntity` - Item to upload - - **Returns** `Observable` - Information about the chosen file(s) -- **openUploadFolderDialog**(action: `string` = `null`, contentEntry: `MinimalNodeEntryEntity` = `null`): `Observable`
+ - _contentEntry:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Item to upload + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the chosen file(s) +- **openUploadFolderDialog**(action: `string` = `null`, contentEntry: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>`
Opens a dialog to choose folders to upload. - _action:_ `string` - Name of the action to show in the title - - _contentEntry:_ `MinimalNodeEntryEntity` - Item to upload - - **Returns** `Observable` - Information about the chosed folder(s) + - _contentEntry:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Item to upload + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` - Information about the chosed folder(s) ## Details The `openXXX` methods return an -[Observable](http://reactivex.io/rxjs/manual/overview.html#observable) that you can subscribe +[`Observable`](http://reactivex.io/documentation/observable.html) that you can subscribe to in order to get the information from the result: ```ts @@ -77,7 +77,7 @@ yourFunctionOnCopyOrMove(){ The `openXXXByFolderId` methods let you set the initial folder location of the browser using a folder ID string. This can be obtained from the `id` property of a -[MinimalNodeEntryEntity](document-library.model.md) object (returned from a previous +[`MinimalNodeEntryEntity`](../content-services/document-library.model.md) object (returned from a previous dialog operation, say) or be set to one of the well-known names "-my-" , "-shared-" or "-root-". diff --git a/docs/content-services/content-node-selector-panel.component.md b/docs/content-services/content-node-selector-panel.component.md index 0ef36d0be0..a9bc5d4187 100644 --- a/docs/content-services/content-node-selector-panel.component.md +++ b/docs/content-services/content-node-selector-panel.component.md @@ -32,17 +32,17 @@ Opens a Content Node Selector in its own dialog window. | breadcrumbTransform | `function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | | currentFolderId | `string` | null | Node ID of the folder currently listed. | | dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | -| dropdownSiteList | `SitePaging` | null | Custom site for site dropdown same as siteList. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | -| imageResolver | `ImageResolver` | null | Custom image resolver function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | -| isSelectionValid | `ValidationFunction` | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | +| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown same as siteList. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | +| imageResolver | [`ImageResolver`](../../lib/content-services/document-list/data/image-resolver.model.ts) | null | Custom image resolver function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | +| isSelectionValid | [`ValidationFunction`](../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | | pageSize | `number` | | Number of items shown per page in the list. | -| rowFilter | `RowFilter` | null | Custom row filter function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | +| rowFilter | [`RowFilter`](../../lib/content-services/document-list/data/row-filter.model.ts) | null | Custom row filter function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | ### Events | Name | Type | Description | | -- | -- | -- | -| select | `EventEmitter` | Emitted when the user has chosen an item. | +| select | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`[]>` | Emitted when the user has chosen an item. | ## Details diff --git a/docs/content-services/content-node-selector.component.md b/docs/content-services/content-node-selector.component.md index 397970f8dd..501916b979 100644 --- a/docs/content-services/content-node-selector.component.md +++ b/docs/content-services/content-node-selector.component.md @@ -33,10 +33,10 @@ Allows a user to select items from a Content Services repository. | -- | -- | -- | -- | | currentFolderId | `string` | null | **Deprecated:** in 2.1.0 | | dropdownHideMyFiles | `boolean` | false | **Deprecated:** in 2.1.0 | -| dropdownSiteList | `SitePaging` | null | **Deprecated:** in 2.1.0 | -| imageResolver | `ImageResolver` | null | **Deprecated:** in 2.1.0 | +| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | **Deprecated:** in 2.1.0 | +| imageResolver | [`ImageResolver`](../../lib/content-services/document-list/data/image-resolver.model.ts) | null | **Deprecated:** in 2.1.0 | | pageSize | `number` | | **Deprecated:** in 2.1.0 | -| rowFilter | `RowFilter` | null | **Deprecated:** in 2.1.0 | +| rowFilter | [`RowFilter`](../../lib/content-services/document-list/data/row-filter.model.ts) | null | **Deprecated:** in 2.1.0 | | title | `string` | null | **Deprecated:** in 2.1.0 | ## Details @@ -80,13 +80,13 @@ The properties are described in the table below: | actionName | `string` | "" | Text to appear on the dialog's main action button ("Move", "Copy", etc) | | currentFolderId | `string` | `null` | Node ID of the folder currently listed. | | dropdownHideMyFiles | `boolean` | `false` | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | -| dropdownSiteList | `SitePaging` | `null` | Custom site for site dropdown same as siteList. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | -| rowFilter | `RowFilter` | `null` | Custom row filter function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | -| imageResolver | `ImageResolver` | `null` | Custom image resolver function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | +| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | `null` | Custom site for site dropdown same as siteList. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. | +| rowFilter | [`RowFilter`](../../lib/content-services/document-list/data/row-filter.model.ts) | `null` | Custom row filter function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | +| imageResolver | [`ImageResolver`](../../lib/content-services/document-list/data/image-resolver.model.ts) | `null` | Custom image resolver function. See the [Document List component](document-list.component.md#custom-row-filter) for more information. | | pageSize | `number` | | Number of items shown per page in the list. | -| isSelectionValid | `ValidationFunction` | `defaultValidation` | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | +| isSelectionValid | [`ValidationFunction`](../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) | `defaultValidation` | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | | breadcrumbTransform | `(node: any) => any` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. | -| select | `EventEmitter` | | Event emitted with the current node selection when the dialog closes | +| select | [`EventEmitter`](../content-services/document-library.model.md) | | Event emitted with the current node selection when the dialog closes | If you don't want to manage the dialog yourself then it is easier to use the [Content Node Selector Panel component](content-node-selector-panel.component.md), or the diff --git a/docs/content-services/custom-resources.service.md b/docs/content-services/custom-resources.service.md index 13a68ce82c..3955f78f6c 100644 --- a/docs/content-services/custom-resources.service.md +++ b/docs/content-services/custom-resources.service.md @@ -12,49 +12,49 @@ Manages Document List information that is specific to a user. ### Methods -- **getCorrespondingNodeIds**(nodeId: `string` = `null`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): `Observable`
+- **getCorrespondingNodeIds**(nodeId: `string` = `null`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets the contents of one of the well-known aliases in the form of node ID strings. - _nodeId:_ `string` - ID of the target folder node - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - **Returns** `Observable` - List of node IDs -- **getRecentFiles**(personId: `string` = `null`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts)
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of node IDs +- **getRecentFiles**(personId: `string` = `null`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets files recently accessed by a user. - _personId:_ `string` - ID of the user - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - **Returns** [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts) - List of nodes for the recently used files + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of nodes for the recently used files - **isCustomSource**(folderId: `string` = `null`): `boolean`
Is the folder ID one of the well-known aliases? - _folderId:_ `string` - Folder ID name to check - **Returns** `boolean` - True if the ID is a well-known name, false otherwise -- **loadFavorites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `[]`): [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts)
+- **loadFavorites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets favorite files for the current user. - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - _includeFields:_ `string[]` - List of data field names to include in the results - - **Returns** [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts) - List of favorite files -- **loadFolderByNodeId**(nodeId: `string` = `null`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `null`): [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts)
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of favorite files +- **loadFolderByNodeId**(nodeId: `string` = `null`, pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets a folder's contents. - _nodeId:_ `string` - ID of the target folder node - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - _includeFields:_ `string[]` - List of data field names to include in the results - - **Returns** [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts) - List of items contained in the folder -- **loadMemberSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts)
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of items contained in the folder +- **loadMemberSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets sites that the current user is a member of. - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - **Returns** [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts) - List of sites -- **loadSharedLinks**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `[]`): [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts)
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of sites +- **loadSharedLinks**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets shared links for the current user. - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - _includeFields:_ `string[]` - List of data field names to include in the results - - **Returns** [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts) - List of shared links -- **loadSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts)
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of shared links +- **loadSites**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets all sites in the respository. - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - - **Returns** [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts) - List of sites -- **loadTrashcan**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `[]`): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of sites +- **loadTrashcan**(pagination: [`PaginationModel`](../../lib/core/models/pagination.model.ts) = `null`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`
Gets all items currently in the trash. - _pagination:_ [`PaginationModel`](../../lib/core/models/pagination.model.ts) - Specifies how to paginate the results - _includeFields:_ `string[]` - List of data field names to include in the results - - **Returns** `Observable` - List of deleted items + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>` - List of deleted items ## Details diff --git a/docs/content-services/document-actions.service.md b/docs/content-services/document-actions.service.md index 378e123567..8093412d14 100644 --- a/docs/content-services/document-actions.service.md +++ b/docs/content-services/document-actions.service.md @@ -16,14 +16,14 @@ Implements the document menu actions for the [Document List component](../conten Checks if actions can be executed for an item. - _obj:_ `any` - Item to receive an action - **Returns** `boolean` - True if the action can be executed on this item, false otherwise -- **getHandler**(key: `string` = `null`): `ContentActionHandler`
+- **getHandler**(key: `string` = `null`): [`ContentActionHandler`](../../lib/content-services/document-list/models/content-action.model.ts)
Gets the handler for an action. - _key:_ `string` - Identifier of the action - - **Returns** `ContentActionHandler` - The handler for the action -- **setHandler**(key: `string` = `null`, handler: `ContentActionHandler` = `null`): `boolean`
+ - **Returns** [`ContentActionHandler`](../../lib/content-services/document-list/models/content-action.model.ts) - The handler for the action +- **setHandler**(key: `string` = `null`, handler: [`ContentActionHandler`](../../lib/content-services/document-list/models/content-action.model.ts) = `null`): `boolean`
Sets a new handler for an action. - _key:_ `string` - Identifier of the action - - _handler:_ `ContentActionHandler` - Handler for the action + - _handler:_ [`ContentActionHandler`](../../lib/content-services/document-list/models/content-action.model.ts) - Handler for the action - **Returns** `boolean` - False if the key was an empty/null string, true otherwise ## Details diff --git a/docs/content-services/document-list.component.md b/docs/content-services/document-list.component.md index 57810ee3ed..8ee4dd07e1 100644 --- a/docs/content-services/document-list.component.md +++ b/docs/content-services/document-list.component.md @@ -69,7 +69,7 @@ Displays the documents from a repository. | display | `string` | [`DisplayMode`](../../lib/core/datatable/components/datatable/datatable.component.ts).List | Change the display mode of the table. Can be "list" or "gallery". | | emptyFolderImageUrl | `string` | "./assets/images/empty_doc_lib.svg" | Custom image for empty folder. Default value: './assets/images/empty_doc_lib.svg' | | enableInfiniteScrolling | `boolean` | false | Set document list to work in infinite scrolling mode | -| folderNode | `MinimalNodeEntryEntity` | null | Currently displayed folder node | +| folderNode | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | null | Currently displayed folder node | | imageResolver | `any \| null` | null | Custom image resolver | | includeFields | `string[]` | | Include additional information about the node in the server request.for example: association, isLink, isLocked and others. | | loading | `boolean` | false | Toggles the loading state and animated spinners for the component. Used in combination with `navigate=false` to perform custom navigation and loading state indication. | @@ -79,7 +79,7 @@ Displays the documents from a repository. | navigate | `boolean` | true | Toggles navigation to folder content or file preview | | navigationMode | `string` | [`DocumentListComponent`](../content-services/document-list.component.md).DOUBLE_CLICK_NAVIGATION | User interaction for folder navigation or file preview. Valid values are "click" and "dblclick". Default value: "dblclick" | | node | [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) | null | The Document list will show all the nodes contained in the [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) entity | -| permissionsStyle | [`PermissionStyleModel[]`](../../lib/content-services/document-list/models/permissions-style.model.ts) | \[] | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../lib/content-services/document-list/models/permissions-style.model.ts) page for further details and examples. | +| permissionsStyle | [`PermissionStyleModel`](../../lib/content-services/document-list/models/permissions-style.model.ts)`[]` | \[] | Define a set of CSS styles styles to apply depending on the permission of the user on that node. See the [Permission Style model](../../lib/content-services/document-list/models/permissions-style.model.ts) page for further details and examples. | | rowFilter | `any \| null` | null | Custom row filter | | rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. | | rowStyleClass | `string` | | The CSS class to apply to every row | @@ -94,11 +94,11 @@ Displays the documents from a repository. | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when the API fails to get the Document List data | -| folderChange | [`EventEmitter`](../../lib/content-services/document-list/components/node.event.ts) | Emitted when the current display folder changes | -| nodeClick | [`EventEmitter`](../../lib/content-services/document-list/components/node.event.ts) | Emitted when the user clicks a list node | -| nodeDblClick | [`EventEmitter`](../../lib/content-services/document-list/components/node.event.ts) | Emitted when the user double-clicks a list node | -| preview | [`EventEmitter`](../../lib/content-services/document-list/components/node.event.ts) | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the [Viewer component](../core/viewer.component.md). | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the API fails to get the Document List data | +| folderChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntryEvent`](../../lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the current display folder changes | +| nodeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the user clicks a list node | +| nodeDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodeEntityEvent`](../../lib/content-services/document-list/components/node.event.ts)`>` | Emitted when the user double-clicks a list node | +| preview | `EventEmitter` | Emitted when the user acts upon files with either single or double click (depends on `navigation-mode`). Useful for integration with the Viewer component. | | ready | `EventEmitter` | Emitted when the Document List has loaded all items and is ready for use | ## Details diff --git a/docs/content-services/document-list.service.md b/docs/content-services/document-list.service.md index 438e59c29b..2308e8222b 100644 --- a/docs/content-services/document-list.service.md +++ b/docs/content-services/document-list.service.md @@ -12,59 +12,59 @@ Implements node operations used by the [Document List component](../content-serv ### Methods -- **copyNode**(nodeId: `string` = `null`, targetParentId: `string` = `null`): `Observable`
+- **copyNode**(nodeId: `string` = `null`, targetParentId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Copy a node to destination node - _nodeId:_ `string` - The id of the node to be copied - _targetParentId:_ `string` - The id of the folder where the node will be copied - - **Returns** `Observable` - NodeEntry for the copied node -- **createFolder**(name: `string` = `null`, parentId: `string` = `null`): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - NodeEntry for the copied node +- **createFolder**(name: `string` = `null`, parentId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntity`](../content-services/document-library.model.md)`>`
Creates a new folder in the path. - _name:_ `string` - Folder name - _parentId:_ `string` - Parent folder ID - - **Returns** `Observable` - Details of the created folder node -- **deleteNode**(nodeId: `string` = `null`): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntity`](../content-services/document-library.model.md)`>` - Details of the created folder node +- **deleteNode**(nodeId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a node. - _nodeId:_ `string` - ID of the node to delete - - **Returns** `Observable` - Empty response when the operation is complete + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Empty response when the operation is complete - **getDefaultMimeTypeIcon**(): `string`
Gets a default icon for MIME types with no specific icon. - **Returns** `string` - Path to the icon file -- **getDocumentThumbnailUrl**(node: `MinimalNodeEntity` = `null`): `string`
+- **getDocumentThumbnailUrl**(node: [`MinimalNodeEntity`](../content-services/document-library.model.md) = `null`): `string`
Get thumbnail URL for the given document node. - - _node:_ `MinimalNodeEntity` - Node to get URL for. + - _node:_ [`MinimalNodeEntity`](../content-services/document-library.model.md) - Node to get URL for. - **Returns** `string` - Thumbnail URL string -- **getFolder**(folder: `string` = `null`, opts?: `any` = `null`, includeFields: `string[]` = `[]`): [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts)
+- **getFolder**(folder: `string` = `null`, opts?: `any` = `null`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`
Gets the folder node with the specified relative name path below the root node. - _folder:_ `string` - Path to folder. - - _opts:_ `any` - (Optional)Options. + - _opts:_ `any` - (Optional) Options. - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - - **Returns** [`Observable`](../../lib/content-services/document-list/models/document-library.model.ts) - Details of the folder -- **getFolderNode**(nodeId: `string` = `null`, includeFields: `string[]` = `[]`): `Observable`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - Details of the folder +- **getFolderNode**(nodeId: `string` = `null`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
- _nodeId:_ `string` - ID of the folder node - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - - **Returns** `Observable` - Details of the folder + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Details of the folder - **getMimeTypeIcon**(mimeType: `string` = `null`): `string`
Gets the icon that represents a MIME type. - _mimeType:_ `string` - MIME type to get the icon for - **Returns** `string` - Path to the icon file -- **getNode**(nodeId: `string` = `null`, includeFields: `string[]` = `[]`): `Observable`
+- **getNode**(nodeId: `string` = `null`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Gets a node via its node ID. - _nodeId:_ `string` - ID of the target node - _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association") - - **Returns** `Observable` - Details of the folder -- **hasPermission**(node: `any` = `null`, permission: `PermissionsEnum | string` = `null`): `boolean`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder +- **hasPermission**(node: `any` = `null`, permission: [`PermissionsEnum`](../../lib/core/models/permissions.enum.ts)` | string` = `null`): `boolean`
- _node:_ `any` - Target node - - _permission:_ `PermissionsEnum | string` - Permission level to query + - _permission:_ [`PermissionsEnum`](../../lib/core/models/permissions.enum.ts)` | string` - Permission level to query - **Returns** `boolean` - True if the node has the permission, false otherwise -- **moveNode**(nodeId: `string` = `null`, targetParentId: `string` = `null`): `Observable`
+- **moveNode**(nodeId: `string` = `null`, targetParentId: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Moves a node to destination node. - _nodeId:_ `string` - The id of the node to be moved - _targetParentId:_ `string` - The id of the folder where the node will be moved - - **Returns** `Observable` - NodeEntry for the moved node + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - NodeEntry for the moved node ## Details diff --git a/docs/content-services/dropdown-breadcrumb.component.md b/docs/content-services/dropdown-breadcrumb.component.md index fd6e006b25..23cff16a91 100644 --- a/docs/content-services/dropdown-breadcrumb.component.md +++ b/docs/content-services/dropdown-breadcrumb.component.md @@ -24,7 +24,8 @@ Indicates the current position within a navigation hierarchy using a dropdown me | Name | Type | Default value | Description | | -- | -- | -- | -- | -| folderNode | `MinimalNodeEntryEntity` | null | Active node, builds UI based on folderNode.path.elements collection. | +| folderNode | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | null | Active node, builds UI based on folderNode.path.elements collection. | +| maxItems | `number` | | Maximum number of nodes to display before wrapping them with a dropdown element. | | root | `string` | null | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use an i18n resource key for the property value. | | rootId | `string` | null | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | | target | [`DocumentListComponent`](../content-services/document-list.component.md) | | (optional) [Document List component](../content-services/document-list.component.md) to operate with. The list will update when the breadcrumb is clicked. | @@ -34,7 +35,7 @@ Indicates the current position within a navigation hierarchy using a dropdown me | Name | Type | Description | | -- | -- | -- | -| navigate | [`EventEmitter`](../../lib/content-services/document-list/models/document-library.model.ts) | Emitted when the user clicks on a breadcrumb. | +| navigate | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the user clicks on a breadcrumb. | ## See also diff --git a/docs/content-services/file-draggable.directive.md b/docs/content-services/file-draggable.directive.md index d9654dce04..a8fded90bf 100644 --- a/docs/content-services/file-draggable.directive.md +++ b/docs/content-services/file-draggable.directive.md @@ -45,8 +45,8 @@ Some sample CSS to show the drag and drop area: | Name | Type | Description | | -- | -- | -- | -| filesDropped | `EventEmitter` | Emitted when one or more files are dragged and dropped onto the draggable element. | -| filesEntityDropped | `EventEmitter` | **Deprecated in 2.4.0**: use `filesDropped` instead. Emitted when one or more files are dragged and dropped onto the draggable element. | +| filesDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when one or more files are dragged and dropped onto the draggable element. | +| filesEntityDropped | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | **Deprecated:** in 2.4.0: use `filesDropped` instead. Emitted when one or more files are dragged and dropped onto the draggable element. | | folderEntityDropped | `EventEmitter` | Emitted when a directory is dragged and dropped onto the draggable element. | ## Details diff --git a/docs/content-services/file-uploading-dialog.component.md b/docs/content-services/file-uploading-dialog.component.md index 4929f03032..55d1af318c 100644 --- a/docs/content-services/file-uploading-dialog.component.md +++ b/docs/content-services/file-uploading-dialog.component.md @@ -26,7 +26,7 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when a file in the list has an error. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file in the list has an error. | ## Details diff --git a/docs/content-services/folder-actions.service.md b/docs/content-services/folder-actions.service.md index f632e10bf5..536e805ef0 100644 --- a/docs/content-services/folder-actions.service.md +++ b/docs/content-services/folder-actions.service.md @@ -16,14 +16,14 @@ Implements the folder menu actions for the [Document List component](../content- Checks if an action is available for a particular item. - _obj:_ `any` - Item to check - **Returns** `boolean` - True if the action is available, false otherwise -- **getHandler**(key: `string` = `null`): `ContentActionHandler`
+- **getHandler**(key: `string` = `null`): [`ContentActionHandler`](../../lib/content-services/document-list/models/content-action.model.ts)
Gets the handler function for an action. - _key:_ `string` - Identifier for the action - - **Returns** `ContentActionHandler` - The handler function -- **setHandler**(key: `string` = `null`, handler: `ContentActionHandler` = `null`): `boolean`
+ - **Returns** [`ContentActionHandler`](../../lib/content-services/document-list/models/content-action.model.ts) - The handler function +- **setHandler**(key: `string` = `null`, handler: [`ContentActionHandler`](../../lib/content-services/document-list/models/content-action.model.ts) = `null`): `boolean`
Sets a new handler function for an action. - _key:_ `string` - Identifier for the action - - _handler:_ `ContentActionHandler` - The new handler function + - _handler:_ [`ContentActionHandler`](../../lib/content-services/document-list/models/content-action.model.ts) - The new handler function - **Returns** `boolean` - True if the key was a valid action identifier, false otherwise ## Details diff --git a/docs/content-services/folder-create.directive.md b/docs/content-services/folder-create.directive.md index f10b942c0b..7afd7c9741 100644 --- a/docs/content-services/folder-create.directive.md +++ b/docs/content-services/folder-create.directive.md @@ -39,8 +39,8 @@ Creates folders. | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs (eg, a folder with same name already exists). | -| success | `EventEmitter` | Emitted when the folder is created successfully. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when the folder is created successfully. | ## Details diff --git a/docs/content-services/folder-edit.directive.md b/docs/content-services/folder-edit.directive.md index b69147f9b3..985ec3fcd3 100644 --- a/docs/content-services/folder-edit.directive.md +++ b/docs/content-services/folder-edit.directive.md @@ -31,15 +31,15 @@ Allows folders to be edited. | Name | Type | Default value | Description | | -- | -- | -- | -- | -| adf-edit-folder | `MinimalNodeEntryEntity` | | Folder node to edit. | +| adf-edit-folder | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | Folder node to edit. | | title | `string` | null | Title of folder edit dialog. | ### Events | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs (eg, a folder with same name already exists). | -| success | `EventEmitter` | Emitted when the folder has been edited successfully. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs (eg, a folder with same name already exists). | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when the folder has been edited successfully. | ## Details diff --git a/docs/content-services/inherited-button.directive.md b/docs/content-services/inherited-button.directive.md index d29c2c6c10..8c267180e6 100644 --- a/docs/content-services/inherited-button.directive.md +++ b/docs/content-services/inherited-button.directive.md @@ -28,7 +28,7 @@ Update the current node by adding/removing the inherited permissions. | Name | Type | Description | | ---- | ---- | ----------- | -| updated | `EventEmitter` | Emitted when the node is updated. | +| updated | [`EventEmitter`](../content-services/document-library.model.md) | Emitted when the node is updated. | ## Details diff --git a/docs/content-services/like.component.md b/docs/content-services/like.component.md index c1b5c1a317..ace1807869 100644 --- a/docs/content-services/like.component.md +++ b/docs/content-services/like.component.md @@ -27,7 +27,7 @@ Allows a user to add "likes" to an item. | Name | Type | Description | | -- | -- | -- | -| changeVote | `EventEmitter` | Emitted when the "vote" gets changed. | +| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also diff --git a/docs/content-services/node-download.directive.md b/docs/content-services/node-download.directive.md index 79c81e2589..9003775441 100644 --- a/docs/content-services/node-download.directive.md +++ b/docs/content-services/node-download.directive.md @@ -29,4 +29,4 @@ Allows folders and/or files to be downloaded, with multiple nodes packed as a '. | Name | Type | Default value | Description | | -- | -- | -- | -- | -| adfNodeDownload | `MinimalNodeEntity[]` | | Nodes to download. | +| adfNodeDownload | [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` | | Nodes to download. | diff --git a/docs/content-services/node-lock.directive.md b/docs/content-services/node-lock.directive.md index 6c1d26dc41..988ef8c447 100644 --- a/docs/content-services/node-lock.directive.md +++ b/docs/content-services/node-lock.directive.md @@ -22,7 +22,7 @@ Locks a node. | Name | Type | Default value | Description | | -- | -- | -- | -- | -| adf-node-lock | `MinimalNodeEntryEntity` | | Node to lock/unlock. | +| adf-node-lock | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | Node to lock/unlock. | ## Details diff --git a/docs/content-services/node-permission-dialog.service.md b/docs/content-services/node-permission-dialog.service.md index ab57c9a4e4..42a55188cf 100644 --- a/docs/content-services/node-permission-dialog.service.md +++ b/docs/content-services/node-permission-dialog.service.md @@ -14,16 +14,16 @@ Displays dialogs to let the user set node permissions. - **close**()
Closes the currently-open dialog. -- **openAddPermissionDialog**(nodeId: `string` = `null`, title?: `string` = `null`): `Observable`
+- **openAddPermissionDialog**(nodeId: `string` = `null`, title?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntity`](../content-services/document-library.model.md)`[]>`
Opens a dialog to add permissions to a node. - _nodeId:_ `string` - ID of the target node - - _title:_ `string` - (Optional)Dialog title - - **Returns** `Observable` - Node with updated permissions -- **updateNodePermissionByDialog**(nodeId?: `string` = `null`, title?: `string` = `null`): `Observable`
+ - _title:_ `string` - (Optional) Dialog title + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntity`](../content-services/document-library.model.md)`[]>` - Node with updated permissions +- **updateNodePermissionByDialog**(nodeId?: `string` = `null`, title?: `string` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
Opens a dialog to update permissions for a node. - - _nodeId:_ `string` - (Optional)ID of the target node - - _title:_ `string` - (Optional)Dialog title - - **Returns** `Observable` - Node with updated permissions + - _nodeId:_ `string` - (Optional) ID of the target node + - _title:_ `string` - (Optional) Dialog title + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permissions ## Details diff --git a/docs/content-services/node-permission.service.md b/docs/content-services/node-permission.service.md index 50be83ce5e..d6e2197822 100644 --- a/docs/content-services/node-permission.service.md +++ b/docs/content-services/node-permission.service.md @@ -12,39 +12,39 @@ Manages role permissions for content nodes. ### Methods -- **getGroupMemeberByGroupName**(groupName: `string` = `null`, opts?: `any` = `null`): `Observable`
+- **getGroupMemeberByGroupName**(groupName: `string` = `null`, opts?: `any` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets all members related to a group name. - _groupName:_ `string` - Name of group to look for members - - _opts:_ `any` - (Optional)Extra options supported by JSAPI - - **Returns** `Observable` - List of members -- **getNodeRoles**(node: `MinimalNodeEntryEntity` = `null`): `Observable`
+ - _opts:_ `any` - (Optional) Extra options supported by JSAPI + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of members +- **getNodeRoles**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets a list of roles for the current node. - - _node:_ `MinimalNodeEntryEntity` - The target node - - **Returns** `Observable` - Array of strings representing the roles -- **removePermission**(node: `MinimalNodeEntryEntity` = `null`, permissionToRemove: `PermissionElement` = `null`): `Observable`
+ - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - The target node + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Array of strings representing the roles +- **removePermission**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) = `null`, permissionToRemove: `PermissionElement` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
- - _node:_ `MinimalNodeEntryEntity` - + - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - - _permissionToRemove:_ `PermissionElement` - - - **Returns** `Observable` - + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - -- **updateLocallySetPermissions**(node: `MinimalNodeEntryEntity` = `null`, nodes: `MinimalNodeEntity[]` = `null`, nodeRole: `string[]` = `null`): `Observable`
+- **updateLocallySetPermissions**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) = `null`, nodes: [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` = `null`, nodeRole: `string[]` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
- - _node:_ `MinimalNodeEntryEntity` - - - _nodes:_ `MinimalNodeEntity[]` - + - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - + - _nodes:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - - _nodeRole:_ `string[]` - - - **Returns** `Observable` - + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - -- **updateNodePermissions**(nodeId: `string` = `null`, permissionList: `MinimalNodeEntity[]` = `null`): `Observable`
+- **updateNodePermissions**(nodeId: `string` = `null`, permissionList: [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
- _nodeId:_ `string` - - - _permissionList:_ `MinimalNodeEntity[]` - - - **Returns** `Observable` - + - _permissionList:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - -- **updatePermissionRole**(node: `MinimalNodeEntryEntity` = `null`, updatedPermissionRole: `PermissionElement` = `null`): `Observable`
+- **updatePermissionRole**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) = `null`, updatedPermissionRole: `PermissionElement` = `null`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`
Updates the permission for a node. - - _node:_ `MinimalNodeEntryEntity` - Target node + - _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Target node - _updatedPermissionRole:_ `PermissionElement` - Permission role to update or add - - **Returns** `Observable` - Node with updated permission + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permission ## Details diff --git a/docs/content-services/node-share.directive.md b/docs/content-services/node-share.directive.md index b327ddfe2f..e3ef1af54c 100644 --- a/docs/content-services/node-share.directive.md +++ b/docs/content-services/node-share.directive.md @@ -32,7 +32,7 @@ Creates and manages public shared links for files. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| node | `MinimalNodeEntity` | | Nodes to share. | +| node | [`MinimalNodeEntity`](../content-services/document-library.model.md) | | Nodes to share. | | baseShareUrl | `string` | | baseShareUrl to add as prefix to the generated link | ## Details diff --git a/docs/content-services/permission-list.component.md b/docs/content-services/permission-list.component.md index def9b83471..f9b42569a3 100644 --- a/docs/content-services/permission-list.component.md +++ b/docs/content-services/permission-list.component.md @@ -40,8 +40,8 @@ or custom template can be added: | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | | -| update | `EventEmitter` | Emitted when the permission is updated. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | | +| update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the permission is updated. | ## Details diff --git a/docs/content-services/rating.component.md b/docs/content-services/rating.component.md index fb140828fe..03b20200b2 100644 --- a/docs/content-services/rating.component.md +++ b/docs/content-services/rating.component.md @@ -29,7 +29,7 @@ Allows a user to add ratings to an item. | Name | Type | Description | | -- | -- | -- | -| changeVote | `EventEmitter` | Emitted when the "vote" gets changed. | +| changeVote | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the "vote" gets changed. | ## See also diff --git a/docs/content-services/search-control.component.md b/docs/content-services/search-control.component.md index 3596e39a64..20c08c9749 100644 --- a/docs/content-services/search-control.component.md +++ b/docs/content-services/search-control.component.md @@ -38,8 +38,8 @@ Displays a input text which shows find-as-you-type suggestions. | Name | Type | Description | | -- | -- | -- | -| optionClicked | `EventEmitter` | Emitted when a file item from the list of "find-as-you-type" results is selected. | -| searchChange | `EventEmitter` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then the term is truncated to an empty string. | +| optionClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file item from the list of "find-as-you-type" results is selected. | +| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then the term is truncated to an empty string. | | submit | `EventEmitter` | Emitted when the search is submitted pressing ENTER button. The search term is provided as value of the event. | ## Details diff --git a/docs/content-services/search-query-builder.service.md b/docs/content-services/search-query-builder.service.md index e55176ae7d..0d5e43f1af 100644 --- a/docs/content-services/search-query-builder.service.md +++ b/docs/content-services/search-query-builder.service.md @@ -23,6 +23,11 @@ Stores information from all the custom search and faceted search widgets, compil - **Returns** `Promise` - +- **getFacetField**(label: `string` = `null`): [`FacetField`](../../lib/content-services/search/facet-field.interface.ts)
+ + - _label:_ `string` - + - **Returns** [`FacetField`](../../lib/content-services/search/facet-field.interface.ts) - + - **getFacetQuery**(label: `string` = `null`): [`FacetQuery`](../../lib/content-services/search/facet-query.interface.ts)
- _label:_ `string` - @@ -31,9 +36,9 @@ Stores information from all the custom search and faceted search widgets, compil - **getPrimarySorting**(): [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts)
Returns primary sorting definition. - **Returns** [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts) - -- **getSortingOptions**(): `SearchSortingDefinition[]`
+- **getSortingOptions**(): [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts)`[]`
Returns all pre-configured sorting options that users can choose from. - - **Returns** `SearchSortingDefinition[]` - + - **Returns** [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts)`[]` - - **removeFilterQuery**(query: `string` = `null`)
- _query:_ `string` - diff --git a/docs/content-services/search.component.md b/docs/content-services/search.component.md index 216ad13a76..b439688408 100644 --- a/docs/content-services/search.component.md +++ b/docs/content-services/search.component.md @@ -51,8 +51,8 @@ Searches items for supplied search terms. | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs. | -| resultLoaded | [`EventEmitter`](../../lib/content-services/document-list/models/document-library.model.ts) | Emitted when search results have fully loaded. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| resultLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when search results have fully loaded. | ## Details @@ -158,7 +158,7 @@ By doing this, you can get the results as the user types into the input text. You can get finer control over the parameters of a search by defining them in a custom [QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) object. The recommended way to do this is with a custom implementation of the -[Search Configuration interface](../core/search-configuration.interface.md) (the `queryBody` parameter of the `Search component` is now deprecated). The ADF source provides a standard implementation of this +[Search Configuration interface](../core/search-configuration.interface.md) (the `queryBody` parameter of the [`Search component`](../content-services/search.component.md) is now deprecated). The ADF source provides a standard implementation of this interface, [`SearchConfigurationService`](../core/search-configuration.service.md) that you can use as a base to adapt to your needs. See the [Search Configuration interface](../core/search-configuration.interface.md) page for full details of how to customize your search. diff --git a/docs/content-services/sites-dropdown.component.md b/docs/content-services/sites-dropdown.component.md index 009ba33449..dceffbd1f8 100644 --- a/docs/content-services/sites-dropdown.component.md +++ b/docs/content-services/sites-dropdown.component.md @@ -25,7 +25,7 @@ Displays a dropdown menu to show and interact with the sites of the current user | Attribute | Type | Default | Description | | --------- | ---- | ------- | ----------- | | hideMyFiles | boolean | false | Hide the "My Files" option added to the list by default | -| siteList | [SitePaging](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. | +| siteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. | | placeholder | string | 'DROPDOWN.PLACEHOLDER_LABEL' | The placeholder text/the key from translation files for the placeholder text to be shown by default | | value | string | null | Id of the select site | | relations | string | null | A custom list of sites to be displayed by the dropdown. If no value is given, the sites of the current user are displayed by default. A list of objects only with properties 'title' and 'guid' is enough to be able to display the dropdown. | diff --git a/docs/content-services/tag-actions.component.md b/docs/content-services/tag-actions.component.md index da1ab8f43c..d3653a66d1 100644 --- a/docs/content-services/tag-actions.component.md +++ b/docs/content-services/tag-actions.component.md @@ -29,6 +29,6 @@ Shows available actions for tags. | Name | Type | Description | | -- | -- | -- | -| error | `EventEmitter` | Emitted when an error occurs. | -| result | `EventEmitter` | Emitted when an action is chosen. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an action is chosen. | | successAdd | `EventEmitter` | Emitted when a tag is added successfully. | diff --git a/docs/content-services/tag-list.component.md b/docs/content-services/tag-list.component.md index 65e35b8321..f31e8e9d36 100644 --- a/docs/content-services/tag-list.component.md +++ b/docs/content-services/tag-list.component.md @@ -15,7 +15,7 @@ Shows tags for an item. | Name | Type | Description | | -- | -- | -- | -| result | `EventEmitter` | Emitted when a tag is selected. | +| result | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | ## See Also diff --git a/docs/content-services/tag-node-list.component.md b/docs/content-services/tag-node-list.component.md index ea997b2f63..69b87560e6 100644 --- a/docs/content-services/tag-node-list.component.md +++ b/docs/content-services/tag-node-list.component.md @@ -29,4 +29,4 @@ Shows tags for a node. | Name | Type | Description | | -- | -- | -- | -| results | `EventEmitter` | Emitted when a tag is selected. | +| results | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a tag is selected. | diff --git a/docs/content-services/tag.service.md b/docs/content-services/tag.service.md index 953b7af592..b33fc3c321 100644 --- a/docs/content-services/tag.service.md +++ b/docs/content-services/tag.service.md @@ -17,9 +17,9 @@ Manages tags in Content Services. - _nodeId:_ `string` - ID of the target node - _tagName:_ `string` - Name of the tag to add - **Returns** `any` - TagEntry object (defined in JSAPI) with details of the new tag -- **getAllTheTags**(): `Observable`
+- **getAllTheTags**(): [`Observable`](http://reactivex.io/documentation/observable.html)``
Gets a list of all the tags already defined in the repository. - - **Returns** `Observable` - TagPaging object (defined in JSAPI) containing the tags + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - TagPaging object (defined in JSAPI) containing the tags - **getTagsByNodeId**(nodeId: `string` = `null`): `any`
Gets a list of tags added to a node. - _nodeId:_ `string` - ID of the target node diff --git a/docs/content-services/upload-button.component.md b/docs/content-services/upload-button.component.md index e461918192..53f3308569 100644 --- a/docs/content-services/upload-button.component.md +++ b/docs/content-services/upload-button.component.md @@ -45,9 +45,10 @@ Activates a file upload. | Name | Type | Description | | -- | -- | -- | -| createFolder | `EventEmitter` | Emitted when a folder is created. | -| error | `EventEmitter` | Emitted when an error occurs. | -| permissionEvent | [`EventEmitter`](../../lib/content-services/document-list/models/permissions.model.ts) | Emitted when create permission is missing. | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | | +| createFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a folder is created. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| permissionEvent | `EventEmitter` | Emitted when create permission is missing. | | success | `EventEmitter` | Emitted when the file is uploaded successfully. | ## Details diff --git a/docs/content-services/upload-drag-area.component.md b/docs/content-services/upload-drag-area.component.md index 368ca6188e..2d3e72766d 100644 --- a/docs/content-services/upload-drag-area.component.md +++ b/docs/content-services/upload-drag-area.component.md @@ -43,26 +43,26 @@ export class AppComponent { | nodeType | `string` | "cm:content" | Custom node type for uploaded file | | rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | | versioning | `boolean` | false | Toggles versioning. | -| parentId | `` | | **Deprecated:** 2.4.0 use rootFolderId ID of parent folder node. | +| parentId | | | **Deprecated:** 2.4.0 use rootFolderId ID of parent folder node. | ### Events | Name | Type | Description | -| --- | --- | --- | -| beginUpload | `EventEmitter()` | Raised after files or folders dropped and before the upload process starts. | -| createFolder | `EventEmitter` | **Deprecated:** No longer used by the framework | -| error | `EventEmitter` | Emitted when the file is uploaded successfully. | -| success | `EventEmitter` | Emitted when an error occurs. | +| -- | -- | -- | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | Raised after files or folders dropped and before the upload process starts. | +| createFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a folder is created. | +| error | `EventEmitter` | Emitted when an error occurs. | +| success | `EventEmitter` | Emitted when the file is uploaded successfully. | ## Intercepting uploads You can intercept the upload process by utilizing the `beginUpload` event. -The event has a type of `UploadFilesEvent` and provides the following APIs: +The event has a type of [`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts) and provides the following APIs: -* **files**: get access to the FileInfo objects that are prepared for the upload -* **pauseUpload**: pause the upload and perform additional tasks, like showing the confirmation dialog -* **resumeUpload**: resume the upload process +- **files**: get access to the [`FileInfo`](../../lib/core/utils/file-utils.ts) objects that are prepared for the upload +- **pauseUpload**: pause the upload and perform additional tasks, like showing the confirmation dialog +- **resumeUpload**: resume the upload process ## Example diff --git a/docs/content-services/upload-version-button.component.md b/docs/content-services/upload-version-button.component.md index 1ed69f9d9a..bed05dd4ae 100644 --- a/docs/content-services/upload-version-button.component.md +++ b/docs/content-services/upload-version-button.component.md @@ -41,7 +41,7 @@ sense when applied to the [Upload Version Button component,](../content-services | majorVersion | `boolean` | false | majorVersion boolean field to true to indicate a major version should be created. | | maxFilesSize | `number` | | Sets a limit on the maximum size (in bytes) of a file to be uploaded. Has no effect if undefined. | | multipleFiles | `boolean` | false | Allows/disallows multiple files | -| node | `MinimalNodeEntryEntity` | | (**Required**) The node to be versioned. | +| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | (**Required**) The node to be versioned. | | nodeType | `string` | "cm:content" | Custom node type for uploaded file | | rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. | | staticTitle | `string` | | Defines the text of the upload button. | @@ -53,9 +53,10 @@ sense when applied to the [Upload Version Button component,](../content-services | Name | Type | Description | | -- | -- | -- | -| createFolder | `EventEmitter` | Emitted when a folder is created. | -| error | `EventEmitter` | Emitted when an error occurs. | -| permissionEvent | [`EventEmitter`](../../lib/content-services/document-list/models/permissions.model.ts) | Emitted when create permission is missing. | +| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | | +| createFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a folder is created. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | +| permissionEvent | `EventEmitter` | Emitted when create permission is missing. | | success | `EventEmitter` | Emitted when the file is uploaded successfully. | ## Details @@ -72,7 +73,7 @@ So, to sum up, this component: - **Can** upload a new version from the same file extension regardless of the file name. - **Cannot** upload a new version that has a different file extension, to the file that was - originally uploaded (an error message will be emitted by the `error` EventEmitter of the component. + originally uploaded (an error message will be emitted by the `error` [`EventEmitter`](https://angular.io/api/core/EventEmitter) of the component. ## See also diff --git a/docs/content-services/version-list.component.md b/docs/content-services/version-list.component.md index e072193ffb..c35726be41 100644 --- a/docs/content-services/version-list.component.md +++ b/docs/content-services/version-list.component.md @@ -22,7 +22,7 @@ Displays the version history of a node in a [Version Manager component](../conte | -- | -- | -- | -- | | allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | | id | `string` | | **Deprecated:** in 2.3.0 | -| node | `MinimalNodeEntryEntity` | | The target node. | +| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | The target node. | | showActions | `boolean` | true | Toggles showing/hiding of version actions | | showComments | `boolean` | true | Toggles showing/hiding of comments | diff --git a/docs/content-services/version-manager.component.md b/docs/content-services/version-manager.component.md index b844028ad6..b7c7f66a49 100644 --- a/docs/content-services/version-manager.component.md +++ b/docs/content-services/version-manager.component.md @@ -29,15 +29,15 @@ Displays the version history of a node with the ability to upload a new version. | Name | Type | Default value | Description | | -- | -- | -- | -- | | allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. | -| node | `MinimalNodeEntryEntity` | | Target node to manage version history. | +| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | Target node to manage version history. | | showComments | `boolean` | true | Toggles showing/hiding of comments. | ### Events | Name | Type | Description | | -- | -- | -- | -| uploadError | `EventEmitter` | Emitted when an error occurs during upload. | -| uploadSuccess | `EventEmitter` | Emitted when a file is uploaded successfully. | +| uploadError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during upload. | +| uploadSuccess | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a file is uploaded successfully. | ## Details diff --git a/docs/content-services/webscript.component.md b/docs/content-services/webscript.component.md index 363e63dd37..604861b364 100644 --- a/docs/content-services/webscript.component.md +++ b/docs/content-services/webscript.component.md @@ -77,7 +77,7 @@ export class AppComponent { | Name | Type | Description | | -- | -- | -- | -| success | `EventEmitter` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. | ## Details diff --git a/tools/doc/tools/typeLinker.js b/tools/doc/tools/typeLinker.js index f5c3e4d1f7..330955f1de 100644 --- a/tools/doc/tools/typeLinker.js +++ b/tools/doc/tools/typeLinker.js @@ -20,6 +20,9 @@ var externalTypes = { 'Observable': 'http://reactivex.io/documentation/observable.html', 'Subject': 'http://reactivex.io/documentation/subject.html', 'AppDefinitionRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md', + 'DeletedNodesPaging': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md', + 'MinimalNodeEntity': '../content-services/document-library.model.md', + 'MinimalNodeEntryEntity': '../content-services/document-library.model.md', 'NodeEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md', 'RelatedContentRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md', 'SiteEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md', diff --git a/tools/doc/tools/typeLinker.ts b/tools/doc/tools/typeLinker.ts index 885b0ea50e..8a25e1d555 100644 --- a/tools/doc/tools/typeLinker.ts +++ b/tools/doc/tools/typeLinker.ts @@ -41,6 +41,9 @@ const externalTypes = { 'Observable': 'http://reactivex.io/documentation/observable.html', 'Subject': 'http://reactivex.io/documentation/subject.html', 'AppDefinitionRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md', + 'DeletedNodesPaging': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md', + 'MinimalNodeEntity': '../content-services/document-library.model.md', + 'MinimalNodeEntryEntity': '../content-services/document-library.model.md', 'NodeEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md', 'RelatedContentRepresentation': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md', 'SiteEntry': 'https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md',