summaryrefslogtreecommitdiffstats
path: root/lib/public/Files/Storage/INotifyStorage.php
blob: 8656f709116da8ffe83261fcb5e9ed6164511811 (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
40
41
42
43
44
45
<?php
/**
 * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Files\Storage;

use OCP\Files\Notify\INotifyHandler;

/**
 * Storage backend that support active notifications
 *
 * @since 9.1.0
 */
interface INotifyStorage {
	/**
	 * @since 9.1.0
	 */
	public const NOTIFY_ADDED = 1;

	/**
	 * @since 9.1.0
	 */
	public const NOTIFY_REMOVED = 2;

	/**
	 * @since 9.1.0
	 */
	public const NOTIFY_MODIFIED = 3;

	/**
	 * @since 9.1.0
	 */
	public const NOTIFY_RENAMED = 4;

	/**
	 * Start the notification handler for this storage
	 *
	 * @param $path
	 * @return INotifyHandler
	 *
	 * @since 12.0.0
	 */
	public function notify($path);
}