INotifier.php 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2016, ownCloud, Inc.
  5. *
  6. * @author Joas Schilling <coding@schilljs.com>
  7. *
  8. * @license AGPL-3.0
  9. *
  10. * This code is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License, version 3,
  12. * as published by the Free Software Foundation.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License, version 3,
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>
  21. *
  22. */
  23. namespace OCP\Notification;
  24. /**
  25. * Interface INotifier
  26. *
  27. * @since 9.0.0
  28. */
  29. interface INotifier {
  30. /**
  31. * Identifier of the notifier, only use [a-z0-9_]
  32. *
  33. * @return string
  34. * @since 17.0.0
  35. */
  36. public function getID(): string;
  37. /**
  38. * Human readable name describing the notifier
  39. *
  40. * @return string
  41. * @since 17.0.0
  42. */
  43. public function getName(): string;
  44. /**
  45. * @param INotification $notification
  46. * @param string $languageCode The code of the language that should be used to prepare the notification
  47. * @return INotification
  48. * @throws \InvalidArgumentException When the notification was not prepared by a notifier
  49. * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
  50. * @since 9.0.0
  51. */
  52. public function prepare(INotification $notification, string $languageCode): INotification;
  53. }