IWithSharingBehavior
Interface
Sharing behavior for Item-Backed Entities
Methods
Method |
Returns |
Notes |
|
Promise<void> |
Set the access level for the item
|
|
Promise<void> |
Share the item with the specified group
|
|
Promise<IGroup[]> |
Get the list of groups that the item is shared to.
Limited to Groups that the user has access to
|
|
Promise<void> |
Unshare the item with the specified group
|
setAccess
Interface Method
Parameters
Parameter |
Type |
Default |
Notes |
access
Required
|
AccessLevel |
|
|
Returns
Promise<void>
shareWithGroup
Interface Method
- shareWithGroup(groupId: string) : Promise<void>
Parameters
Parameter |
Type |
Default |
Notes |
groupId
Required
|
string |
|
|
Returns
Promise<void>
sharedWith
Interface Method
- sharedWith() : Promise<IGroup[]>
Returns
Promise<IGroup[]>
unshareWithGroup
Interface Method
- unshareWithGroup(groupId: string) : Promise<void>
Parameters
Parameter |
Type |
Default |
Notes |
groupId
Required
|
string |
|
|
Returns
Promise<void>
Interface defined in common/src/core/behaviors/IWithSharingBehavior.ts:7
Set the access level for the item