mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Restructured Content Services docs (#4429)
* [ADF-4152] Moved content services docs to subfolders * [ADF-4152] Manual URL fixes for cont services docs * [ADF-4152] Moved content services docs to subfolders * [ADF-4152] Manual URL fixes for cont services docs * [ADF-4152] Updated doc index pages for content services
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
bc5208b767
commit
dfea5c2f04
96
docs/content-services/services/document-list.service.md
Normal file
96
docs/content-services/services/document-list.service.md
Normal file
@@ -0,0 +1,96 @@
|
||||
---
|
||||
Title: Document List service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Document List service](../../../lib/content-services/document-list/services/document-list.service.ts "Defined in document-list.service.ts")
|
||||
|
||||
Implements node operations used by the [Document List component](../components/document-list.component.md).
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **copyNode**(nodeId: `string`, targetParentId: `string`): `any`<br/>
|
||||
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** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the copied node
|
||||
- **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Deletes a node.
|
||||
- _nodeId:_ `string` - ID of the node to delete
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the operation is complete
|
||||
- **getDefaultMimeTypeIcon**(): `string`<br/>
|
||||
Gets a default icon for MIME types with no specific icon.
|
||||
- **Returns** `string` - Path to the icon file
|
||||
- **getDocumentThumbnailUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `string`<br/>
|
||||
Get thumbnail URL for the given document node.
|
||||
- _node:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to get URL for.
|
||||
- **Returns** `string` - Thumbnail URL string
|
||||
- **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`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 folder node with the specified relative name path below the root node.
|
||||
- _folder:_ `string` - Path to folder.
|
||||
- _opts:_ `any` - (Optional) Options.
|
||||
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>` - Details of the folder
|
||||
- **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
|
||||
Gets a folder node via its node ID.
|
||||
- _nodeId:_ `string` - ID of the folder node
|
||||
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
|
||||
- **getMimeTypeIcon**(mimeType: `string`): `string`<br/>
|
||||
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`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
|
||||
Gets a node via its node ID.
|
||||
- _nodeId:_ `string` - ID of the target node
|
||||
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
|
||||
- **moveNode**(nodeId: `string`, targetParentId: `string`): `any`<br/>
|
||||
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** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the moved node
|
||||
|
||||
## Details
|
||||
|
||||
This service makes extensive use of the Alfresco JS API. In particular,
|
||||
see the
|
||||
[Nodes API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#getNodeChildren)
|
||||
for further details of the types, options and the underlying REST architecture.
|
||||
|
||||
### Moving, copying and deleting nodes
|
||||
|
||||
Both `moveNode` and `copyNode` create a copy of the existing node under a new
|
||||
parent, but `moveNode` also deletes the original. The new node has the same
|
||||
name as the original and if it is a folder then all its contents will be copied
|
||||
in-place.
|
||||
|
||||
Use `deleteNode` to move a node from its original location into the trash (from
|
||||
where it can be restored if necessary). If the deleted node is a folder then its
|
||||
child items will also be moved to the trash.
|
||||
|
||||
### Folder operations
|
||||
|
||||
Use `getFolderNode` to get a folder node by its node ID and `getFolder` to access
|
||||
the folder via its pathname from the root folder. Also, `getFolder` allows you to
|
||||
specify extra options in the `opts` parameter; see the
|
||||
[getNodeChildren](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#getNodeChildren)
|
||||
method in the Alfresco JS API for more information about the available options.
|
||||
|
||||
Use `createFolder` to add a new folder in a given parent folder node. You can
|
||||
specify the well-known names "-my-" , "-shared-" and "-root-" as shortcuts for
|
||||
the `parentId`.
|
||||
|
||||
### Permissions
|
||||
|
||||
The `hasAllowableOperations` method reports whether or not the user has the specified permission for the
|
||||
node. The Permissions enum contains the values DELETE, UPDATE, CREATE, UPDATEPERMISSIONS, NOT_DELETE, NOT_UPDATE, NOT_CREATE and NOT_UPDATEPERMISSIONS but you can also supply these
|
||||
values via their string equivalents.
|
||||
|
||||
## See also
|
||||
|
||||
- [Document list component](../components/document-list.component.md)
|
||||
Reference in New Issue
Block a user