inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-3551] Doc review updates (#3793)

Browse Source 
* [ADF-3551] Updated docs and JSDocs

* [ADF-3551] Updated docs and JSDocs

* [ADF-3551] Updated docs and JSDocs
This commit is contained in:
Andy Stark
2018-09-14 14:41:25 +01:00
committed by Eugenio Romano
parent a67263462c
commit 58d765a355
18 changed files with 104 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/content-services/node-permission.service.md
View File

@@ -1,7 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-05-08
Last reviewed: 2018-09-14
---
# Node Permission service
@@ -22,26 +22,23 @@ Manages role permissions for content nodes.
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - The target node
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Array of strings representing the roles
- **removePermission**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), permissionToRemove: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) -
- _permissionToRemove:_ `PermissionElement` -
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` -
Removes a permission setting from a node.
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - ID of the target node
- _permissionToRemove:_ `PermissionElement` - Permission setting to remove
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with modified permissions
- **updateLocallySetPermissions**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), nodes: [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]`, nodeRole: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) -
- _nodes:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` -
- _nodeRole:_ `string[]` -
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` -
Updates the locally set permissions for a node.
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - ID of the target node
- _nodes:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - Permission settings
- _nodeRole:_ `string[]` - Permission role
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permissions
- **updateNodePermissions**(nodeId: `string`, permissionList: [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
- _nodeId:_ `string` -
- _permissionList:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` -
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` -
Update permissions for a node.
- _nodeId:_ `string` - ID of the target node
- _permissionList:_ [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` - New permission settings
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permissions
- **updatePermissionRole**(node: [`MinimalNodeEntryEntity`](../content-services/document-library.model.md), updatedPermissionRole: `PermissionElement`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
Updates the permission for a node.
Updates the permission role for a node.
- _node:_ [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) - Target node
- _updatedPermissionRole:_ `PermissionElement` - Permission role to update or add
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Node with updated permission

13
docs/content-services/search-chip-list.component.md
View File

@@ -1,15 +1,26 @@
---
Added: v2.3.0
Status: Active
Last reviewed: 2018-09-14
---
# Search Chip List Component
Displays search criteria as a set of "chips".
![Selected Facets](../docassets/images/selected-facets.png)
## Basic usage
```html
<adf-search-chip-list [searchFilter]="searchFilter"></adf-search-chip-list>
<adf-search-filter #searchFilter></adf-search-filter>
```
![Selected Facets](../docassets/images/selected-facets.png)
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| searchFilter | [`SearchFilterComponent`](../content-services/search-filter.component.md) | | Search filter to supply the data for the chips. |