[ADF-2847] Added Class members headings and rebuilt prop/method tables for docs (#3240)

* [ADF-2847] Added class members heading to content services docs

* [ADF-2847] Updated all prop/method tables in content services
This commit is contained in:
Andy Stark
2018-04-26 14:54:25 +01:00
committed by Eugenio Romano
parent 616036f9e7
commit 2c0e7aa035
40 changed files with 541 additions and 405 deletions

View File

@@ -2,25 +2,31 @@
Added: v2.0.0
Status: Active
---
# Node Permission service
Manages the role permissions for the content nodes
## Methods
## Class members
- `getNodeRoles(node: MinimalNodeEntryEntity): Observable<string[]>`
Gets a list of roles for the current node.
- `node` - the target node
- `updatePermissionRoles(node: MinimalNodeEntryEntity, updatedPermissionRole: PermissionElement): Observable<MinimalNodeEntryEntity>`
Update the given permission for the related node
- `node` - the target node
- `updatedPermissionRole` the permission role to update/add
### Methods
- `getGroupMemeberByGroupName(groupName: string, opts?: any): Observable<GroupMemberPaging>`
Perform a call to the groups api to retrieve all the members related to that group name.
- `groupName` the members group name
- `opts` additional parameters to perform the call
- `getGroupMemeberByGroupName(groupName: string = null, opts?: any = null): Observable<GroupMemberPaging>`<br/>
- `groupName: string = null` -
- `opts?: any = null` - (Optional)
- **Returns** `Observable<GroupMemberPaging>` -
- `getNodeRoles(node: MinimalNodeEntryEntity = null): Observable<string[]>`<br/>
- `node: MinimalNodeEntryEntity = null` -
- **Returns** `Observable<string[]>` -
- `updatePermissionRoles(node: MinimalNodeEntryEntity = null, updatedPermissionRole: PermissionElement = null): Observable<MinimalNodeEntryEntity>`<br/>
- `node: MinimalNodeEntryEntity = null` -
- `updatedPermissionRole: PermissionElement = null` -
- **Returns** `Observable<MinimalNodeEntryEntity>` -
## Details