IDismissableNotifier.php 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl>
  5. *
  6. * @author Roeland Jago Douma <roeland@famdouma.nl>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Notification;
  25. /**
  26. * Interface INotifier classes should implement if they want to process notifications
  27. * that are dismissed by the user.
  28. *
  29. * This can be useful if dismissing the notification will leave it in an incomplete
  30. * state. The handler can chose to for example do some default action.
  31. *
  32. * @since 18.0.0
  33. */
  34. interface IDismissableNotifier extends INotifier {
  35. /**
  36. * @param INotification $notification
  37. * @throws \InvalidArgumentException In case the handler can't handle the notification
  38. *
  39. * @since 18.0.0
  40. */
  41. public function dismissNotification(INotification $notification): void;
  42. }