[ADF-2905] Updated JSDocs for content services (#3269)

* [ADF-2905] Updated JSDocs for content services

* [ADF-2905] Added missing update to version manager MD file
This commit is contained in:
Andy Stark
2018-05-04 13:56:01 +01:00
committed by Eugenio Romano
parent b393708514
commit 563af3bbfa
15 changed files with 50 additions and 40 deletions

View File

@@ -6,7 +6,7 @@ Last reviewed: 2018-05-03
# Add Permission Component
Allow user to search people or group that could be added to the current node permissions.
Searches for people or groups to add to the current node permissions.
![Add Permission Component](../docassets/images/add-permission-component.png)
@@ -14,7 +14,7 @@ Allow user to search people or group that could be added to the current node per
```html
<adf-add-permission [nodeId]="nodeId"
(success)="onSuccess($event)" (error)="onError($event)">
(success)="onSuccess($event)" (error)="onError($event)">
</adf-add-permission>
```
@@ -24,18 +24,17 @@ Allow user to search people or group that could be added to the current node per
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| nodeId | `string` | "" | |
| nodeId | `string` | | ID of the target node. |
### Events
| Name | Type | Description |
| -- | -- | -- |
| success | `EventEmitter<MinimalNodeEntryEntity>` | |
| error | `EventEmitter<any>` | |
| error | `EventEmitter<any>` | Emitted when an error occurs during the update. |
| success | `EventEmitter<MinimalNodeEntryEntity>` | Emitted when the node is updated successfully. |
## Details
This component extends the [Add permission panel component](../add-permission-panel.component.md)
and apply the action confirm when the selection made is accepted.
The `success` event will be emitted when the node is correctly updated.
The `error` event will be thrown whenever the node update permission will fail.