aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Broadcast/Events/IBroadcastEvent.php
blob: 00cd79f7d77b07e4a33bbe29e612720386d55b94 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
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;
}