blob: 8777779ca4ac50030caa73e74aa7179ac96d9993 (
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
46
|
<?php
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Files\Notify;
/**
* Provides access to detected changes in the storage by either actively listening
* or getting the list of changes that happened in the background
*
* @since 12.0.0
*/
interface INotifyHandler {
/**
* Start listening for update notifications
*
* The provided callback will be called for every incoming notification with the following parameters
* - IChange|IRenameChange $change
*
* Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback
*
* @param callable $callback
*
* @since 12.0.0
*/
public function listen(callable $callback);
/**
* Get all changes detected since the start of the notify process or the last call to getChanges
*
* @return IChange[]
*
* @since 12.0.0
*/
public function getChanges();
/**
* Stop listening for changes
*
* Note that any pending changes will be discarded
*
* @since 12.0.0
*/
public function stop();
}
|
