diff --git a/lib/public/Files/Notify/IChange.php b/lib/public/Files/Notify/IChange.php index 09d9500a3d..1e6aaa8abe 100644 --- a/lib/public/Files/Notify/IChange.php +++ b/lib/public/Files/Notify/IChange.php @@ -23,6 +23,11 @@ namespace OCP\Files\Notify; +/** + * Represents a detected change in the storage + * + * @since 12.0.0 + */ interface IChange { const ADDED = 1; const REMOVED = 2; @@ -33,6 +38,8 @@ interface IChange { * Get the type of the change * * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED + * + * @since 12.0.0 */ public function getType(); @@ -42,6 +49,8 @@ interface IChange { * Note, for rename changes this path is the old path for the file * * @return mixed + * + * @since 12.0.0 */ public function getPath(); } diff --git a/lib/public/Files/Notify/INotifyHandler.php b/lib/public/Files/Notify/INotifyHandler.php index be672426a0..7e0e6a610d 100644 --- a/lib/public/Files/Notify/INotifyHandler.php +++ b/lib/public/Files/Notify/INotifyHandler.php @@ -23,6 +23,12 @@ 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 @@ -33,6 +39,8 @@ interface INotifyHandler { * 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); @@ -40,6 +48,8 @@ interface INotifyHandler { * 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(); @@ -47,6 +57,8 @@ interface INotifyHandler { * Stop listening for changes * * Note that any pending changes will be discarded + * + * @since 12.0.0 */ public function stop(); } diff --git a/lib/public/Files/Notify/IRenameChange.php b/lib/public/Files/Notify/IRenameChange.php index 710a8acf0f..c95499a7e7 100644 --- a/lib/public/Files/Notify/IRenameChange.php +++ b/lib/public/Files/Notify/IRenameChange.php @@ -23,11 +23,18 @@ namespace OCP\Files\Notify; +/** + * Represents a detected rename change + * + * @since 12.0.0 + */ interface IRenameChange extends IChange { /** * Get the new path of the renamed file relative to the storage root * * @return string + * + * @since 12.0.0 */ public function getTargetPath(); }