Files
alfresco-ng2-components/docs/content-services/node-permission.service.md
Andy Stark c8f04193c7 [ADF-2764] Updated doc files with latest script features (#3368)
* [ADF-2764] Updated doc files with latest script features

* [ADF-2764] Rebuilt full index instead of just content services index
2018-05-23 00:40:02 +01:00

2.7 KiB

Added, Status, Last reviewed
Added Status Last reviewed
v2.0.0 Active 2018-05-08

Node Permission service

Manages role permissions for content nodes.

Class members

Methods

  • getGroupMemeberByGroupName(groupName: string = null, opts?: any = null): Observable<GroupMemberPaging>
    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<GroupMemberPaging> - List of members
  • getNodeRoles(node: MinimalNodeEntryEntity = null): Observable<string[]>
    Gets a list of roles for the current node.

    • node: MinimalNodeEntryEntity - The target node
    • Returns Observable<string[]> - Array of strings representing the roles
  • removePermission(node: MinimalNodeEntryEntity = null, permissionToRemove: PermissionElement = null): Observable<MinimalNodeEntryEntity>

    • node: MinimalNodeEntryEntity -
    • permissionToRemove: PermissionElement -
    • Returns Observable<MinimalNodeEntryEntity> -
  • updateLocallySetPermissions(node: MinimalNodeEntryEntity = null, nodes: MinimalNodeEntity[] = null, nodeRole: string[] = null): Observable<MinimalNodeEntryEntity>

    • node: MinimalNodeEntryEntity -
    • nodes: MinimalNodeEntity[] -
    • nodeRole: string[] -
    • Returns Observable<MinimalNodeEntryEntity> -
  • updateNodePermissions(nodeId: string = null, permissionList: MinimalNodeEntity[] = null): Observable<MinimalNodeEntryEntity>

    • nodeId: string -
    • permissionList: MinimalNodeEntity[] -
    • Returns Observable<MinimalNodeEntryEntity> -
  • updatePermissionRole(node: MinimalNodeEntryEntity = null, updatedPermissionRole: PermissionElement = null): Observable<MinimalNodeEntryEntity>
    Updates the permission for a node.

    • node: MinimalNodeEntryEntity - Target node
    • updatedPermissionRole: PermissionElement - Permission role to update or add
    • Returns Observable<MinimalNodeEntryEntity> - Node with updated permission

Details

This service requires the Content Services Groups API, which is available from version 5.2.1.

See the Groups API docs in the Alfresco JS API for more information about the types returned by the methods and for the implementation of the REST API the service is based on.

See also