cozy-client / models / permission
Namespace: permission¶
models.permission
Interfaces¶
Type aliases¶
PermissionVerb¶
Ƭ PermissionVerb<>: "ALL" | "GET" | "PATCH" | "POST" | "PUT" | "DELETE"
Defined in
packages/cozy-client/src/models/permission.js:18
Functions¶
fetchOwn¶
▸ fetchOwn(client): Promise<PermissionItem[]>
Fetches the list of permissions blocks
Parameters
| Name | Type | Description |
|---|---|---|
client |
CozyClient |
- |
Returns
Promise<PermissionItem[]>
list of permissions
Defined in
packages/cozy-client/src/models/permission.js:53
isDocumentReadOnly¶
▸ isDocumentReadOnly(args): Promise<boolean>
Parameters
| Name | Type |
|---|---|
args |
any |
Returns
Promise<boolean>
Defined in
packages/cozy-client/src/models/permission.js:129
isForType¶
▸ isForType(permission, type): boolean
Checks if the permission item is about a specific doctype
Parameters
| Name | Type | Description |
|---|---|---|
permission |
PermissionItem |
- |
type |
string |
doctype |
Returns
boolean
Defined in
packages/cozy-client/src/models/permission.js:67
isShortcutCreatedOnTheRecipientCozy¶
▸ isShortcutCreatedOnTheRecipientCozy(permission): boolean
When a cozy to cozy sharing is created Cozy’s stack creates a
shortcut in /Inbox of sharing on the recipient’s cozy to have a
quick access even when the sharing is not accepted yet.
However, this file is created only if the stack knows the URL of the cozy. This is not always the case.
This method is here to tell us if the shortcut’s file is created on the recipient’s cozy. It can be used to make an UI distinction between the both situation.
property {object} data Permission document
property {Array} included Member information from the sharing
Parameters
| Name | Type | Description |
|---|---|---|
permission |
Permission |
From getOwnPermissions mainly |
Returns
boolean
Defined in