mirror of
https://github.com/nextcloud/server.git
synced 2024-12-29 16:38:28 +00:00
47 lines
1.1 KiB
PHP
47 lines
1.1 KiB
PHP
<?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();
|
|
}
|