Sabre\CalDAV\Backend\NotificationSupport Interface Reference

Adds caldav notification support to a backend. More...

Inheritance diagram for Sabre\CalDAV\Backend\NotificationSupport:

Collaboration diagram for Sabre\CalDAV\Backend\NotificationSupport:

Public Member Functions
	getNotificationsForPrincipal ($principalUri)
	Returns a list of notifications for a given principal url. More...
	deleteNotification ($principalUri, NotificationInterface $notification)
	This deletes a specific notifcation. More...
	shareReply ($href, $status, $calendarUri, $inReplyTo, $summary=null)
	This method is called when a user replied to a request to share. More...
Public Member Functions inherited from Sabre\CalDAV\Backend\BackendInterface
	getCalendarsForUser ($principalUri)
	Returns a list of calendars for a principal. More...
	createCalendar ($principalUri, $calendarUri, array $properties)
	Creates a new calendar for a principal. More...
	updateCalendar ($calendarId, \Sabre\DAV\PropPatch $propPatch)
	Updates properties for a calendar. More...
	deleteCalendar ($calendarId)
	Delete a calendar and all its objects. More...
	getCalendarObjects ($calendarId)
	Returns all calendar objects within a calendar. More...
	getCalendarObject ($calendarId, $objectUri)
	Returns information from a single calendar object, based on it's object uri. More...
	getMultipleCalendarObjects ($calendarId, array $uris)
	Returns a list of calendar objects. More...
	createCalendarObject ($calendarId, $objectUri, $calendarData)
	Creates a new calendar object. More...
	updateCalendarObject ($calendarId, $objectUri, $calendarData)
	Updates an existing calendarobject, based on it's uri. More...
	deleteCalendarObject ($calendarId, $objectUri)
	Deletes an existing calendar object. More...
	calendarQuery ($calendarId, array $filters)
	Performs a calendar-query on the contents of this calendar. More...
	getCalendarObjectByUID ($principalUri, $uid)
	Searches through all of a users calendars and calendar objects to find an object with a specific UID. More...

Detailed Description

Adds caldav notification support to a backend.

Note: This feature is experimental, and may change in between different SabreDAV versions.

Notifications are defined at: http://svn.calendarserver.org/repository/calendarserver/CalendarServer/trunk/doc/Extensions/caldav-notifications.txt

These notifications are basically a list of server-generated notifications displayed to the user. Users can dismiss notifications by deleting them.

The primary usecase is to allow for calendar-sharing.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 25 of file NotificationSupport.php.

Member Function Documentation

deleteNotification()

Sabre\CalDAV\Backend\NotificationSupport::deleteNotification	(		$principalUri,
		NotificationInterface	$notification
	)

This deletes a specific notifcation.

This may be called by a client once it deems a notification handled.

Parameters

string	$principalUri
NotificationInterface	$notification

Returns

void

Implemented in Sabre\CalDAV\Backend\MockSharing.

getNotificationsForPrincipal()

Sabre\CalDAV\Backend\NotificationSupport::getNotificationsForPrincipal

(

$principalUri

)

Returns a list of notifications for a given principal url.

Parameters

string

$principalUri

Returns

NotificationInterface[]

Implemented in Sabre\CalDAV\Backend\MockSharing.

shareReply()

Sabre\CalDAV\Backend\NotificationSupport::shareReply	(		$href,
			$status,
			$calendarUri,
			$inReplyTo,
			$summary = null
	)

This method is called when a user replied to a request to share.

If the user chose to accept the share, this method should return the newly created calendar url.

Parameters

string	$href	The sharee who is replying (often a mailto: address)
int	$status	One of the SharingPlugin::STATUS_* constants
string	$calendarUri	The url to the calendar thats being shared
string	$inReplyTo	The unique id this message is a response to
string	$summary	A description of the reply

Returns

null|string

Implemented in Sabre\CalDAV\Backend\MockSharing.

---

The documentation for this interface was generated from the following file:

• libs/composer/vendor/sabre/dav/lib/CalDAV/Backend/NotificationSupport.php