mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
* [ADF-3551] Updated docs and JSDocs * [ADF-3551] Updated docs and JSDocs * [ADF-3551] Updated docs and JSDocs
4.5 KiB
4.5 KiB
Added, Status, Last reviewed
Added | Status | Last reviewed |
---|---|---|
v2.0.0 | Active | 2018-09-14 |
Node Permission service
Manages role permissions for content nodes.
Class members
Methods
- getGroupMemeberByGroupName(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 JSAPI - Returns
Observable
<GroupMemberPaging>
- List of members
- groupName:
- getNodeRoles(node:
MinimalNodeEntryEntity
):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
- node:
- removePermission(node:
MinimalNodeEntryEntity
, permissionToRemove:PermissionElement
):Observable
<
MinimalNodeEntryEntity
>
Removes a permission setting from a node.- node:
MinimalNodeEntryEntity
- ID of the target node - permissionToRemove:
PermissionElement
- Permission setting to remove - Returns
Observable
<
MinimalNodeEntryEntity
>
- Node with modified permissions
- node:
- updateLocallySetPermissions(node:
MinimalNodeEntryEntity
, nodes:MinimalNodeEntity
[]
, nodeRole:string[]
):Observable
<
MinimalNodeEntryEntity
>
Updates the locally set permissions for a node.- node:
MinimalNodeEntryEntity
- ID of the target node - nodes:
MinimalNodeEntity
[]
- Permission settings - nodeRole:
string[]
- Permission role - Returns
Observable
<
MinimalNodeEntryEntity
>
- Node with updated permissions
- node:
- updateNodePermissions(nodeId:
string
, permissionList:MinimalNodeEntity
[]
):Observable
<
MinimalNodeEntryEntity
>
Update permissions for a node.- nodeId:
string
- ID of the target node - permissionList:
MinimalNodeEntity
[]
- New permission settings - Returns
Observable
<
MinimalNodeEntryEntity
>
- Node with updated permissions
- nodeId:
- updatePermissionRole(node:
MinimalNodeEntryEntity
, updatedPermissionRole:PermissionElement
):Observable
<
MinimalNodeEntryEntity
>
Updates the permission role for a node.- node:
MinimalNodeEntryEntity
- Target node - updatedPermissionRole:
PermissionElement
- Permission role to update or add - Returns
Observable
<
MinimalNodeEntryEntity
>
- Node with updated permission
- node:
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.