Sha256: 9c9814329a4faf2739f19dc3bbd87150435332c859b2db48bbc8305161645ed9
Contents?: true
Size: 1.77 KB
Versions: 8
Compression:
Stored size: 1.77 KB
Contents
# Lock
## Example Lock Object
```
{
"path": "locked_file",
"timeout": 43200,
"depth": "infinity",
"owner": "user",
"scope": "shared",
"token": "17c54824e9931a4688ca032d03f6663c",
"type": "write",
"user_id": 1,
"username": ""
}
```
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
* `timeout` (int64): Lock timeout
* `depth` (string): Lock depth (0 or infinity)
* `owner` (string): Owner of lock. This can be any arbitrary string.
* `scope` (string): Lock scope(shared or exclusive)
* `token` (string): Lock token. Use to release lock.
* `type` (string): Lock type
* `user_id` (int64): Lock creator user ID
* `username` (string): Lock creator username
---
## List Locks by path
```
Files::Lock.list_for(path,
page: 1,
per_page: 1,
include_children: true
)
```
### Parameters
* `page` (int64): Current page number.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
* `path` (string): Required - Path to operate on.
* `include_children` (boolean): Include locks from children objects?
---
## Create Lock
```
Files::Lock.create(path,
timeout: 1
)
```
### Parameters
* `path` (string): Required - Path
* `timeout` (int64): Lock timeout length
---
## Delete Lock
```
Files::Lock.delete(path,
token: "token"
)
```
### Parameters
* `path` (string): Required - Path
* `token` (string): Required - Lock token
---
## Delete Lock
```
lock = Files::Lock.list_for(path).first
lock.delete(
token: "token"
)
```
### Parameters
* `path` (string): Required - Path
* `token` (string): Required - Lock token
Version data entries
8 entries across 8 versions & 1 rubygems