dav/SabreDAV/lib/Sabre/CalDAV/Backend/NotificationSupport.php

   1 <?php
   2
   3 /**
   4  * Adds caldav notification support to a backend.
   5  *
   6  * Notifications are defined at:
   7  * http://svn.calendarserver.org/repository/calendarserver/CalendarServer/trunk/doc/Extensions/caldav-notifications.txt
   8  *
   9  * These notifications are basically a list of server-generated notifications
  10  * displayed to the user. Users can dismiss notifications by deleting them.
  11  *
  12  * The primary usecase is to allow for calendar-sharing.
  13  *
  14  * @package Sabre
  15  * @subpackage CalDAV
  16  * @copyright Copyright (C) 2007-2012 Rooftop Solutions. All rights reserved.
  17  * @author Evert Pot (http://www.rooftopsolutions.nl/)
  18  * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
  19  */
  20 interface Sabre_CalDAV_Backend_NotificationSupport extends Sabre_CalDAV_Backend_BackendInterface {
  21
  22     /**
  23      * Returns a list of notifications for a given principal url.
  24      *
  25      * The returned array should only consist of implementations of
  26      * Sabre_CalDAV_Notifications_INotificationType.
  27      *
  28      * @param string $principalUri
  29      * @return array
  30      */
  31     public function getNotificationsForPrincipal($principalUri);
  32
  33     /**
  34      * This deletes a specific notifcation.
  35      *
  36      * This may be called by a client once it deems a notification handled.
  37      *
  38      * @param string $principalUri
  39      * @param Sabre_CalDAV_Notifications_INotificationType $notification
  40      * @return void
  41      */
  42     public function deleteNotification($principalUri, Sabre_CalDAV_Notifications_INotificationType $notification);
  43
  44 }