Andy Stark b393708514 [ADF-2905] Updated JSDocs for content services (#3262)
* [ADF-2905] Updated JSDocs for content services

* [ADF-2905] Updated JSDocs for content services

* [ADF-2911] Improved error message handling in doc tools (#3267)

* [ADF-2772] Sidenav Layout - UX review (#3264)

* Add border-right in mat-sidenav

* workaround for enum issue in js-api

* fix the AoT buid error

* fix AoT build error

* fix export problem for AoT

* [ADF-2905] Updated JSDocs for content services

* [ADF-2905] Updated JSDocs for content services
2018-05-04 11:11:11 +01:00

41 lines
1.1 KiB
Markdown

---
Added: v2.2.0
Status: Active
Last reviewed: 2018-04-10
---
# Node Lock directive
Locks a node.
## Basic Usage
```html
<button mat-icon-button [adf-node-lock]="node.entry">
<mat-icon>lock</mat-icon> Lock file
</button>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| adf-node-lock | `MinimalNodeEntryEntity` | | Node to lock/unlock. |
## Details
When the decorated element (eg, div) is clicked, a dialog is shown to let you lock
or unlock a file (a folder cannot be locked).
There are two types of lock: indefinite lock and time lock.
If the time is not selected the user will lock the file it until will not unlock it
When a file is locked it can be locked and unlocked by default only by the user that creates the lock but you can also allow the other file owners to modify it
![adf-lock](../docassets/images/lock-directive.png)
This calls the `openLockNodeDialog` method from the
[Content Node Dialog service](content-node-dialog.service.md) method when clicked,
and disables the target button if the provided node is not a file or the user doesn't
have permissions.