diff options
Diffstat (limited to 'lib/public/Broadcast/Events/IBroadcastEvent.php')
-rw-r--r-- | lib/public/Broadcast/Events/IBroadcastEvent.php | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/lib/public/Broadcast/Events/IBroadcastEvent.php b/lib/public/Broadcast/Events/IBroadcastEvent.php new file mode 100644 index 00000000000..0aa7ff45eec --- /dev/null +++ b/lib/public/Broadcast/Events/IBroadcastEvent.php @@ -0,0 +1,57 @@ +<?php declare(strict_types=1); + +/** + * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @author 2019 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCP\Broadcast\Events; + +use JsonSerializable; + +/** + * @since 18.0.0 + */ +interface IBroadcastEvent { + + /** + * @return string the name of the event + * @since 18.0.0 + */ + public function getName(): string; + + /** + * @return string[] + * @since 18.0.0 + */ + public function getUids(): array; + + /** + * @return JsonSerializable the data to be sent to the client + * @since 18.0.0 + */ + public function getPayload(): JsonSerializable; + + /** + * @since 18.0.0 + */ + public function setBroadcasted(): void; + +} |