This interface represents a resource that has sharing capabilities, either because it's possible for an owner to share the resource, or because this is an instance of a shared resource. More...
Inheritance diagram for Sabre\DAV\Sharing\ISharedNode:
Collaboration diagram for Sabre\DAV\Sharing\ISharedNode:
Public Member Functions | |
| getShareAccess () | |
| Returns the 'access level' for the instance of this shared resource. More... | |
| getShareResourceUri () | |
| This function must return a URI that uniquely identifies the shared resource. More... | |
| updateInvites (array $sharees) | |
| Updates the list of sharees. More... | |
| getInvites () | |
| Returns the list of people whom this resource is shared with. More... | |
| Public Member Functions inherited from Sabre\DAV\INode | |
| delete () | |
| Deleted the current node. More... | |
| getName () | |
| Returns the name of the node. More... | |
| setName ($name) | |
| Renames the node. More... | |
| getLastModified () | |
| Returns the last modification time, as a unix timestamp. More... | |
Detailed Description
This interface represents a resource that has sharing capabilities, either because it's possible for an owner to share the resource, or because this is an instance of a shared resource.
- Copyright
- Copyright (C) fruux GmbH. (https://fruux.com/)
Definition at line 16 of file ISharedNode.php.
Member Function Documentation
◆ getInvites()
| Sabre\DAV\Sharing\ISharedNode::getInvites | ( | ) |
Returns the list of people whom this resource is shared with.
Every item in the returned array must be a Sharee object with at least the following properties set:
- $href
- $shareAccess
- $inviteStatus
and optionally:
- $properties
- Returns
- []
Implemented in Sabre\DAV\Mock\SharedNode, and Sabre\CalDAV\SharedCalendar.
◆ getShareAccess()
| Sabre\DAV\Sharing\ISharedNode::getShareAccess | ( | ) |
Returns the 'access level' for the instance of this shared resource.
The value should be one of the Sabre::ACCESS_ constants.
- Returns
- int
Implemented in Sabre\DAV\Mock\SharedNode, and Sabre\CalDAV\SharedCalendar.
◆ getShareResourceUri()
| Sabre\DAV\Sharing\ISharedNode::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.
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.
- Returns
- string
Implemented in Sabre\DAV\Mock\SharedNode, and Sabre\CalDAV\SharedCalendar.
◆ updateInvites()
| Sabre\DAV\Sharing\ISharedNode::updateInvites | ( | array | $sharees | ) |
Updates the list of sharees.
Every item must be a Sharee object.
- Parameters
-
Implemented in Sabre\DAV\Mock\SharedNode, and Sabre\CalDAV\SharedCalendar.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/sabre/dav/lib/DAV/Sharing/ISharedNode.php
