IWithSharingBehavior

Interface

Sharing behavior for Item-Backed Entities

Methods

Method	Returns	Notes
setAccess(access: AccessLevel)	Promise<void>	Set the access level for the item
shareWithGroup(groupId: string)	Promise<void>	Share the item with the specified group
shareWithGroups(groupIds: string[])	Promise<void>	Share the item with multiple groups
sharedWith()	Promise<IGroup[]>	Get the list of groups that the item is shared to. Limited to Groups that the user has access to
unshareWithGroup(groupId: string)	Promise<void>	Unshare the item with the specified group
unshareWithGroups(groupIds: string[])	Promise<void>	Unshare the item with the specified group

setAccess

Interface Method

Set the access level for the item

setAccess(access: AccessLevel) : Promise<void>

Parameters

Parameter	Type	Default	Notes
access Required	AccessLevel

Returns

Promise<void>

shareWithGroup

Interface Method

Share the item with the specified group

shareWithGroup(groupId: string) : Promise<void>

Parameters

Parameter	Type	Default	Notes
groupId Required	string

Returns

Promise<void>

shareWithGroups

Interface Method

Share the item with multiple groups

shareWithGroups(groupIds: string[]) : Promise<void>

Parameters

Parameter	Type	Default	Notes
groupIds Required	string[]

Returns

Promise<void>

sharedWith

Interface Method

Get the list of groups that the item is shared to. Limited to Groups that the user has access to

sharedWith() : Promise<IGroup[]>

Returns

Promise<IGroup[]>

unshareWithGroup

Interface Method

Unshare the item with the specified group

unshareWithGroup(groupId: string) : Promise<void>

Parameters

Parameter	Type	Default	Notes
groupId Required	string

Returns

Promise<void>

unshareWithGroups

Interface Method

Unshare the item with the specified group

unshareWithGroups(groupIds: string[]) : Promise<void>

Parameters

Parameter	Type	Default	Notes
groupIds Required	string[]

Returns

Promise<void>

Interface defined in packages/common/src/core/behaviors/IWithSharingBehavior.ts:7