inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-19 17:14:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/content-services/custom-resources.service.md
Andy Stark 3ba72f00f8 [ADF-3551] Updates for doc review (#3784) 
* [ADF-3551] Updated doc comments

* [ADF-3551] Updated doc comments

* [ADF-3551] Doc files updated with new doc comments
2018-09-13 12:59:57 +01:00

7.1 KiB
Raw Blame History

Added, Status, Last reviewed
Added Status Last reviewed
v2.3.0 Active 2018-09-13

Custom Resources service

Manages Document List information that is specific to a user.

Class members

Methods

  • getCorrespondingNodeIds(nodeId: string, pagination: PaginationModel = {}): Observable<string[]>
    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 - Specifies how to paginate the results
    • Returns Observable<string[]> - List of node IDs
  • getRecentFiles(personId: string, pagination: PaginationModel): Observable<NodePaging>
    Gets files recently accessed by a user.
    • personId: string - ID of the user
    • pagination: PaginationModel - Specifies how to paginate the results
    • Returns Observable<NodePaging> - List of nodes for the recently used files
  • hasCorrespondingNodeIds(nodeId: string): boolean
    Does the well-known alias have a corresponding node ID?
    • nodeId: string - Node to check
    • Returns boolean - True if the alias has a corresponding node ID, false otherwise
  • isCustomSource(folderId: string): 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
  • isSupportedSource(folderId: string): boolean
    Is the folder ID a "-my", "-root-", or "-shared-" alias?
    • folderId: string - Folder ID name to check
    • Returns boolean - True if the ID is one of the suppored sources, false otherwise
  • loadFavorites(pagination: PaginationModel, includeFields: string[] = []): Observable<NodePaging>
    Gets favorite files for the current user.
    • pagination: PaginationModel - Specifies how to paginate the results
    • includeFields: string[] - List of data field names to include in the results
    • Returns Observable<NodePaging> - List of favorite files
  • loadFolderByNodeId(nodeId: string, pagination: PaginationModel, includeFields: string[]): Observable<NodePaging>
    Gets a folder's contents.
    • nodeId: string - ID of the target folder node
    • pagination: PaginationModel - Specifies how to paginate the results
    • includeFields: string[] - List of data field names to include in the results
    • Returns Observable<NodePaging> - List of items contained in the folder
  • loadMemberSites(pagination: PaginationModel): Observable<NodePaging>
    Gets sites that the current user is a member of.
  • loadSharedLinks(pagination: PaginationModel, includeFields: string[] = []): Observable<NodePaging>
    Gets shared links for the current user.
    • pagination: PaginationModel - Specifies how to paginate the results
    • includeFields: string[] - List of data field names to include in the results
    • Returns Observable<NodePaging> - List of shared links
  • loadSites(pagination: PaginationModel): Observable<NodePaging>
    Gets all sites in the respository.
  • loadTrashcan(pagination: PaginationModel, includeFields: string[] = []): Observable<DeletedNodesPaging>
    Gets all items currently in the trash.

Details

The includeFields parameter used by some of the methods lets you specify which data fields you want in the result objects. See the Alfresco JSAPI for further details of the returned data and the available fields.

See also