ShareCreated
extends Share
in package
Parent class representing different types of share objects
Table of Contents
Methods
- delete() : bool
- Permanently delete the current share or share link
- getDriveId() : string
- getExpiration() : DateTimeImmutable|null
- getPermissionId() : string
- getReceiver() : User|Group
- getResourceId() : string
- setExpiration() : bool
- Change the Expiration date for the current share or share link Set to null to remove the expiration date
- setRole() : bool
- Change the Role of the particular Share.
Methods
delete()
Permanently delete the current share or share link
public
delete() : bool
Tags
Return values
boolgetDriveId()
public
getDriveId() : string
Return values
stringgetExpiration()
public
getExpiration() : DateTimeImmutable|null
Return values
DateTimeImmutable|nullgetPermissionId()
public
getPermissionId() : string
Return values
stringgetReceiver()
public
getReceiver() : User|Group
Tags
Return values
User|GroupgetResourceId()
public
getResourceId() : string
Return values
stringsetExpiration()
Change the Expiration date for the current share or share link Set to null to remove the expiration date
public
setExpiration(DateTimeImmutable|null $expiration) : bool
Parameters
- $expiration : DateTimeImmutable|null
Tags
Return values
boolsetRole()
Change the Role of the particular Share.
public
setRole(SharingRole $role) : bool
Possible roles are defined by the resource and have to be queried using OcisResource::getRoles() Roles for shares are not to be confused with the types of share links!
Parameters
- $role : SharingRole