ISharingManager
in
Tags
Attributes
- #[Consumable]
- $since: '35.0.0'
Table of Contents
Methods
- addShareRecipient() : void
- Add a new recipient to a share.
- addShareSource() : void
- Add a new source to a share.
- createShare() : string
- Create a new share.
- deleteShare() : void
- Delete a share.
- generateSecret() : non-empty-string
- Generate a new secret.
- generateTimestamp() : int
- Generate a new timestamp in milliseconds since the UNIX epoch.
- getShare() : Share
- Get a share.
- getShares() : array<int, Share>
- Get multiple shares.
- onInitiatorDeleted() : void
- Perform all updates when the initiator was deleted.
- onOwnerDeleted() : void
- Perform all updates when the owner was deleted.
- onRecipientDeleted() : void
- Perform all updates when the recipient was deleted.
- onSourceDeleted() : void
- Perform all updates when the source was deleted.
- removeShareRecipient() : void
- Remove an existing recipient from a share.
- removeShareSource() : void
- Remove an existing source from a share.
- searchRecipients() : array<int, ShareRecipient>
- Search for recpients that can be added to a share.
- selectSharePermissionPreset() : void
- Select a permission preset for a share.
- updateSharePermission() : void
- Update a permission of a share.
- updateShareProperty() : void
- Update a property of a share.
- updateShareRecipientSecret() : void
- Update the scecret of a recipient.
- updateShareState() : void
- Update the state of a share.
Methods
addShareRecipient()
Add a new recipient to a share.
public
addShareRecipient(ShareAccessContext $accessContext, string $id, ShareRecipient $recipient) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
- $recipient : ShareRecipient
Tags
addShareSource()
Add a new source to a share.
public
addShareSource(ShareAccessContext $accessContext, string $id, ShareSource $source) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
- $source : ShareSource
Tags
createShare()
Create a new share.
public
createShare(ShareAccessContext $accessContext) : string
Parameters
- $accessContext : ShareAccessContext
Tags
Return values
stringdeleteShare()
Delete a share.
public
deleteShare(ShareAccessContext $accessContext, string $id) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
Tags
generateSecret()
Generate a new secret.
public
generateSecret() : non-empty-string
Tags
Return values
non-empty-stringgenerateTimestamp()
Generate a new timestamp in milliseconds since the UNIX epoch.
public
generateTimestamp() : int
Tags
Return values
intgetShare()
Get a share.
public
getShare(ShareAccessContext $accessContext, string $id) : Share
Parameters
- $accessContext : ShareAccessContext
- $id : string
Tags
Return values
SharegetShares()
Get multiple shares.
public
getShares(ShareAccessContext $accessContext, IShareSourceType>|null $filterSourceTypeClass, string|null $filterSourceTypeValue, string|null $lastShareID, positive-int|null $limit) : array<int, Share>
Parameters
- $accessContext : ShareAccessContext
- $filterSourceTypeClass : IShareSourceType>|null
- $filterSourceTypeValue : string|null
- $lastShareID : string|null
- $limit : positive-int|null
Tags
Return values
array<int, Share>onInitiatorDeleted()
Perform all updates when the initiator was deleted.
public
onInitiatorDeleted(ShareAccessContext $accessContext, IUser $initiator) : void
Parameters
- $accessContext : ShareAccessContext
- $initiator : IUser
Tags
onOwnerDeleted()
Perform all updates when the owner was deleted.
public
onOwnerDeleted(ShareAccessContext $accessContext, IUser $owner) : void
Parameters
- $accessContext : ShareAccessContext
- $owner : IUser
Tags
onRecipientDeleted()
Perform all updates when the recipient was deleted.
public
onRecipientDeleted(ShareAccessContext $accessContext, ShareRecipient $recipient) : void
Parameters
- $accessContext : ShareAccessContext
- $recipient : ShareRecipient
Tags
onSourceDeleted()
Perform all updates when the source was deleted.
public
onSourceDeleted(ShareAccessContext $accessContext, ShareSource $source) : void
Parameters
- $accessContext : ShareAccessContext
- $source : ShareSource
Tags
removeShareRecipient()
Remove an existing recipient from a share.
public
removeShareRecipient(ShareAccessContext $accessContext, string $id, ShareRecipient $recipient) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
- $recipient : ShareRecipient
Tags
removeShareSource()
Remove an existing source from a share.
public
removeShareSource(ShareAccessContext $accessContext, string $id, ShareSource $source) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
- $source : ShareSource
Tags
searchRecipients()
Search for recpients that can be added to a share.
public
searchRecipients(ShareAccessContext $accessContext, array<int, IShareRecipientType>>|null $recipientTypeClasses, string $query, positive-int $limit, int $offset) : array<int, ShareRecipient>
Parameters
- $accessContext : ShareAccessContext
- $recipientTypeClasses : array<int, IShareRecipientType>>|null
- $query : string
- $limit : positive-int
- $offset : int
Tags
Return values
array<int, ShareRecipient>selectSharePermissionPreset()
Select a permission preset for a share.
public
selectSharePermissionPreset(ShareAccessContext $accessContext, string $id, ISharePermissionPreset> $permissionPresetClass) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
- $permissionPresetClass : ISharePermissionPreset>
Tags
updateSharePermission()
Update a permission of a share.
public
updateSharePermission(ShareAccessContext $accessContext, string $id, SharePermission $permission) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
- $permission : SharePermission
Tags
updateShareProperty()
Update a property of a share.
public
updateShareProperty(ShareAccessContext $accessContext, string $id, ShareProperty $property) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
- $property : ShareProperty
Tags
updateShareRecipientSecret()
Update the scecret of a recipient.
public
updateShareRecipientSecret(ShareAccessContext $accessContext, string $id, ShareRecipient $recipient, string $secret) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
- $recipient : ShareRecipient
- $secret : string
Tags
updateShareState()
Update the state of a share.
public
updateShareState(ShareAccessContext $accessContext, string $id, ShareState $state) : void
Parameters
- $accessContext : ShareAccessContext
- $id : string
- $state : ShareState