Skip to content

Latest commit

 

History

History
88 lines (79 loc) · 8.45 KB

custom-resources.service.md

File metadata and controls

88 lines (79 loc) · 8.45 KB
Title Added Status Last reviewed
Custom Resources service
v2.3.0
Active
2018-11-16

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
  • getIdFromEntry(node: any, nodeId: string): string
    Chooses the correct ID for a node entry.
    • node: any - Node object
    • nodeId: string - ID of the node object
    • Returns string - ID value
  • getRecentFiles(personId: string, pagination: PaginationModel, filters?: string[]): Observable<NodePaging>
    Gets files recently accessed by a user.
    • personId: string - ID of the user
    • pagination: PaginationModel - Specifies how to paginate the results
    • filters: string[] - (Optional) Specifies additional filters to apply (joined with AND)
    • 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 supported sources, false otherwise
  • loadFavorites(pagination: PaginationModel, includeFields: string[] = [], where?: 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
    • where: string - (Optional) A string to restrict the returned objects by using a predicate
    • Returns Observable<NodePaging> - List of favorite files
  • loadFolderByNodeId(nodeId: string, pagination: PaginationModel, includeFields: string[] = [], where?: string): any
    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
    • where: string - (Optional) Filters the Node list using the where condition of the REST API (for example, isFolder=true). See the REST API documentation for more information.
    • Returns any - List of items contained in the folder
  • loadMemberSites(pagination: PaginationModel, where?: string): Observable<SiteMemberPaging>
    Gets sites that the current user is a member of.
    • pagination: PaginationModel - Specifies how to paginate the results
    • where: string - (Optional) A string to restrict the returned objects by using a predicate
    • Returns Observable<SiteMemberPaging> - List of sites
  • loadSharedLinks(pagination: PaginationModel, includeFields: string[] = [], where?: string): Observable<SharedLinkPaging>
    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
    • where: string - (Optional) A string to restrict the returned objects by using a predicate
    • Returns Observable<SharedLinkPaging> - List of shared links
  • loadSites(pagination: PaginationModel, where?: string): Observable<NodePaging>
    Gets all sites in the repository.
    • pagination: PaginationModel - Specifies how to paginate the results
    • where: string - (Optional) A string to restrict the returned objects by using a predicate
    • Returns Observable<NodePaging> - List of sites
  • 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