alfresco-ng2-components/docs/content-services/services/document-list.service.md

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Document List service	v2.0.0	Active	2019-01-16

Document List service

Implements node operations used by the Document List component.

Class members

Methods

• copyNode(nodeId: string, targetParentId: string): Observable<NodeEntry>
  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> - NodeEntry for the copied node

• deleteNode(nodeId: string): Observable<any>
  Deletes a node.

  • nodeId: string - ID of the node to delete
  • Returns Observable<any> - Empty response when the operation is complete

• getFolder(folder: string, opts?: any, includeFields: string[] = []): Observable<NodePaging>
  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<NodePaging> - Details of the folder

• getFolderNode(nodeId: string, includeFields: string[] = []): Observable<NodeEntry>
  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<NodeEntry> - Details of the folder

• getNode(nodeId: string, includeFields: string[] = []): Observable<NodeEntry>
  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<NodeEntry> - Details of the folder

• isCustomSourceService(nodeId: any): boolean
  

  • nodeId: any -
  • Returns boolean -

• loadFolderByNodeId(nodeId: string, pagination: PaginationModel, includeFields: string[], where?: string, orderBy?: string[]): Observable<DocumentLoaderNode>
  Load a folder by Node Id.

  • nodeId: string - ID of the folder node
  • pagination: PaginationModel -
  • includeFields: string[] - List of data field names to include in the results
  • where: string - (Optional) Optionally filter the list
  • orderBy: string[] - (Optional) order by node property
  • Returns Observable<DocumentLoaderNode> - Details of the folder

• moveNode(nodeId: string, targetParentId: string): Observable<NodeEntry>
  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> - NodeEntry for the moved node

Details

This service makes extensive use of the Alfresco JS API. In particular, see the Nodes API 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 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