IBroadcastEvent.php 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  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\Broadcast\Events;
  25. use JsonSerializable;
  26. /**
  27. * @since 18.0.0
  28. */
  29. interface IBroadcastEvent {
  30. /**
  31. * @return string the name of the event
  32. * @since 18.0.0
  33. */
  34. public function getName(): string;
  35. /**
  36. * @return string[]
  37. * @since 18.0.0
  38. */
  39. public function getUids(): array;
  40. /**
  41. * @return JsonSerializable the data to be sent to the client
  42. * @since 18.0.0
  43. */
  44. public function getPayload(): JsonSerializable;
  45. /**
  46. * @since 18.0.0
  47. */
  48. public function setBroadcasted(): void;
  49. }