INode.php 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <?php
  2. declare(strict_types=1);
  3. namespace Sabre\CalDAV\Notifications;
  4. use Sabre\CalDAV\Xml\Notification\NotificationInterface;
  5. /**
  6. * This node represents a single notification.
  7. *
  8. * The signature is mostly identical to that of Sabre\DAV\IFile, but the get() method
  9. * MUST return an xml document that matches the requirements of the
  10. * 'caldav-notifications.txt' spec.
  11. *
  12. * For a complete example, check out the Notification class, which contains
  13. * some helper functions.
  14. *
  15. * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
  16. * @author Evert Pot (http://evertpot.com/)
  17. * @license http://sabre.io/license/ Modified BSD License
  18. */
  19. interface INode
  20. {
  21. /**
  22. * This method must return an xml element, using the
  23. * Sabre\CalDAV\Xml\Notification\NotificationInterface classes.
  24. *
  25. * @return NotificationInterface
  26. */
  27. public function getNotificationType();
  28. /**
  29. * Returns the etag for the notification.
  30. *
  31. * The etag must be surrounded by literal double-quotes.
  32. *
  33. * @return string
  34. */
  35. public function getETag();
  36. }