INotificationProvider.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019, Georg Ehrke
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Georg Ehrke <oc.list@georgehrke.com>
  8. * @author Roeland Jago Douma <roeland@famdouma.nl>
  9. * @author Richard Steinmetz <richard@steinmetz.cloud>
  10. *
  11. * @license GNU AGPL version 3 or any later version
  12. *
  13. * This program is free software: you can redistribute it and/or modify
  14. * it under the terms of the GNU Affero General Public License as
  15. * published by the Free Software Foundation, either version 3 of the
  16. * License, or (at your option) any later version.
  17. *
  18. * This program is distributed in the hope that it will be useful,
  19. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21. * GNU Affero General Public License for more details.
  22. *
  23. * You should have received a copy of the GNU Affero General Public License
  24. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  25. *
  26. */
  27. namespace OCA\DAV\CalDAV\Reminder;
  28. use OCP\IUser;
  29. use Sabre\VObject\Component\VEvent;
  30. /**
  31. * Interface INotificationProvider
  32. *
  33. * @package OCA\DAV\CalDAV\Reminder
  34. */
  35. interface INotificationProvider {
  36. /**
  37. * Send notification
  38. *
  39. * @param VEvent $vevent
  40. * @param string|null $calendarDisplayName
  41. * @param string[] $principalEmailAddresses All email addresses associated to the principal owning the calendar object
  42. * @param IUser[] $users
  43. * @return void
  44. */
  45. public function send(VEvent $vevent,
  46. ?string $calendarDisplayName,
  47. array $principalEmailAddresses,
  48. array $users = []): void;
  49. }