Skip to content

Latest commit

 

History

History
92 lines (74 loc) · 7.31 KB

node-permission.service.md

File metadata and controls

92 lines (74 loc) · 7.31 KB
Title Added Status Last reviewed
Node Permission service
v2.0.0
Active
2019-01-16

Node Permission service

Manages role permissions for content nodes.

Class members

Methods

  • getGroupMemberByGroupName(groupName: string, opts?: any): 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 JS-API
    • Returns Observable<GroupMemberPaging> - List of members

  • getInheritedPermission(node: Node): PermissionDisplayModel[]

  • getLocalPermissions(node: Node): PermissionDisplayModel[]

  • getNodePermissions(node: Node): PermissionDisplayModel[]

  • getNodeRoles(node: Node): Observable<string[]>
    Gets a list of roles for the current node.

    • node: Node - The target node
    • Returns Observable<string[]> - Array of strings representing the roles

  • getNodeWithRoles(nodeId: string): Observable<Function>
    Gets all node detail for nodeId along with settable permissions.

    • nodeId: string - Id of the node
    • Returns Observable<Function> - node and it's associated roles { node: Node; roles: RoleModel[] }

  • removePermission(node: Node, permissionToRemove: PermissionElement): Observable<Node>
    Removes a permission setting from a node.

    • node: Node - ID of the target node
    • permissionToRemove: PermissionElement - Permission setting to remove
    • Returns Observable<Node> - Node with modified permissions

  • removePermissions(node: Node, permissions: PermissionElement[]): Observable<Node>
    Removes permissions setting from a node.

    • node: Node - target node with permission
    • permissions: PermissionElement[] - Permissions to remove
    • Returns Observable<Node> - Node with modified permissions

  • transformNodeToUserPerson(node: Node): Function

    • node: Node -
    • Returns Function -

  • updateLocallySetPermissions(node: Node, permissions: PermissionElement[]): Observable<Node>
    Updates the locally set permissions for a node.

    • node: Node - ID of the target node
    • permissions: PermissionElement[] - Permission settings
    • Returns Observable<Node> - Node with updated permissions

  • updateNodePermissions(nodeId: string, permissionList: PermissionElement[]): Observable<Node>
    Update permissions for a node.

    • nodeId: string - ID of the target node
    • permissionList: PermissionElement[] - New permission settings
    • Returns Observable<Node> - Node with updated permissions

  • updatePermissionRole(node: Node, updatedPermissionRole: PermissionElement): Observable<Node>
    Updates the permission role for a node.

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

  • updatePermissions(node: Node, permissions: PermissionElement[]): Observable<Node>
    updates permissions setting from a node.

    • node: Node - target node with permission
    • permissions: PermissionElement[] - Permissions to update
    • Returns Observable<Node> - Node with modified permissions

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