ISharedCalendar
extends
ISharedNode
in
This interface represents a Calendar that is shared by a different user.
Tags
Table of Contents
- delete() : mixed
- Deleted the current node.
- getInvites() : array<string|int, Sharee>
- Returns the list of people whom this resource is shared with.
- getLastModified() : int|null
- Returns the last modification time, as a unix timestamp. Return null if the information is not available.
- getName() : string
- Returns the name of the node.
- getShareAccess() : int
- Returns the 'access level' for the instance of this shared resource.
- getShareResourceUri() : string
- This function must return a URI that uniquely identifies the shared resource. This URI should be identical across instances, and is also used in several other XML bodies to connect invites to resources.
- setName() : mixed
- Renames the node.
- setPublishStatus() : mixed
- Marks this calendar as published.
- updateInvites() : mixed
- Updates the list of sharees.
Methods
delete()
Deleted the current node.
public
delete() : mixed
Return values
mixed —getInvites()
Returns the list of people whom this resource is shared with.
public
getInvites() : array<string|int, Sharee>
Every item in the returned array must be a Sharee object with at least the following properties set:
- $href
- $shareAccess
- $inviteStatus
and optionally:
- $properties
Return values
array<string|int, Sharee> —getLastModified()
Returns the last modification time, as a unix timestamp. Return null if the information is not available.
public
getLastModified() : int|null
Return values
int|null —getName()
Returns the name of the node.
public
getName() : string
This is used to generate the url.
Return values
string —getShareAccess()
Returns the 'access level' for the instance of this shared resource.
public
getShareAccess() : int
The value should be one of the Sabre\DAV\Sharing\Plugin::ACCESS_ constants.
Return values
int —getShareResourceUri()
This function must return a URI that uniquely identifies the shared resource. This URI should be identical across instances, and is also used in several other XML bodies to connect invites to resources.
public
getShareResourceUri() : string
This may simply be a relative reference to the original shared instance, but it could also be a urn. As long as it's a valid URI and unique.
Return values
string —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name
Return values
mixed —setPublishStatus()
Marks this calendar as published.
public
setPublishStatus(bool $value) : mixed
Publishing a calendar should automatically create a read-only, public, subscribable calendar.
Parameters
- $value : bool
Return values
mixed —updateInvites()
Updates the list of sharees.
public
updateInvites(array<string|int, Sharee> $sharees) : mixed
Every item must be a Sharee object.
Parameters
- $sharees : array<string|int, Sharee>