1
0

ICloudFederationNotification.php 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
  4. *
  5. * @author Bjoern Schiessle <bjoern@schiessle.org>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  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
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\Federation;
  24. /**
  25. * Interface ICloudFederationNotification
  26. *
  27. *
  28. * @since 14.0.0
  29. */
  30. interface ICloudFederationNotification {
  31. /**
  32. * add a message to the notification
  33. *
  34. * @param string $notificationType (e.g. SHARE_ACCEPTED)
  35. * @param string $resourceType (e.g. file, calendar, contact,...)
  36. * @param string $providerId id of the share
  37. * @param array $notification payload of the notification
  38. *
  39. * @since 14.0.0
  40. */
  41. public function setMessage($notificationType, $resourceType, $providerId, array $notification);
  42. /**
  43. * get message, ready to send out
  44. *
  45. * @return array
  46. *
  47. * @since 14.0.0
  48. */
  49. public function getMessage();
  50. }