[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
This commit is contained in:
Andy Stark
2018-05-23 00:40:02 +01:00
committed by Eugenio Romano
parent f69bad3732
commit c8f04193c7
39 changed files with 353 additions and 280 deletions
@@ -12,19 +12,38 @@ Manages role permissions for content nodes.
### Methods
- `getGroupMemeberByGroupName(groupName: string = null, opts?: any = null): Observable<GroupMemberPaging>`<br/>
- **getGroupMemeberByGroupName**(groupName: `string` = `null`, opts?: `any` = `null`): `Observable<GroupMemberPaging>`<br/>
Gets all members related to a group name.
- `groupName: string = null` - Name of group to look for members
- `opts?: any = null` - (Optional) Extra options supported by JSAPI
- _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[]>`<br/>
- **getNodeRoles**(node: `MinimalNodeEntryEntity` = `null`): `Observable<string[]>`<br/>
Gets a list of roles for the current node.
- `node: MinimalNodeEntryEntity = null` - The target node
- _node:_ `MinimalNodeEntryEntity` - The target node
- **Returns** `Observable<string[]>` - Array of strings representing the roles
- `updatePermissionRoles(node: MinimalNodeEntryEntity = null, updatedPermissionRole: PermissionElement = null): Observable<MinimalNodeEntryEntity>`<br/>
- **removePermission**(node: `MinimalNodeEntryEntity` = `null`, permissionToRemove: `PermissionElement` = `null`): `Observable<MinimalNodeEntryEntity>`<br/>
- _node:_ `MinimalNodeEntryEntity` -
- _permissionToRemove:_ `PermissionElement` -
- **Returns** `Observable<MinimalNodeEntryEntity>` -
- **updateLocallySetPermissions**(node: `MinimalNodeEntryEntity` = `null`, nodes: `MinimalNodeEntity[]` = `null`, nodeRole: `string[]` = `null`): `Observable<MinimalNodeEntryEntity>`<br/>
- _node:_ `MinimalNodeEntryEntity` -
- _nodes:_ `MinimalNodeEntity[]` -
- _nodeRole:_ `string[]` -
- **Returns** `Observable<MinimalNodeEntryEntity>` -
- **updateNodePermissions**(nodeId: `string` = `null`, permissionList: `MinimalNodeEntity[]` = `null`): `Observable<MinimalNodeEntryEntity>`<br/>
- _nodeId:_ `string` -
- _permissionList:_ `MinimalNodeEntity[]` -
- **Returns** `Observable<MinimalNodeEntryEntity>` -
- **updatePermissionRole**(node: `MinimalNodeEntryEntity` = `null`, updatedPermissionRole: `PermissionElement` = `null`): `Observable<MinimalNodeEntryEntity>`<br/>
Updates the permission for a node.
- `node: MinimalNodeEntryEntity = null` - Target node
- `updatedPermissionRole: PermissionElement = null` - Permission role to update or add
- _node:_ `MinimalNodeEntryEntity` - Target node
- _updatedPermissionRole:_ `PermissionElement` - Permission role to update or add
- **Returns** `Observable<MinimalNodeEntryEntity>` - Node with updated permission
## Details