diff --git a/events/foldererrors.rst b/events/foldererrors.rst new file mode 100644 index 000000000..d3aa8d65e --- /dev/null +++ b/events/foldererrors.rst @@ -0,0 +1,29 @@ +FolderErrors +------------ + +The ``FolderErrors`` event is emitted when a folder cannot be successfully +synchronized. The event contains the ID of the affected folder and a list of +errors as the pertain to files or directories therein. This list of errors is +obsolete once the folder changes state to ``syncing`` - if errors remain after +the next synchronization attempt, a new ``FolderErrors`` event is emitted. + +.. code-block:: json + + { + "id": 132, + "type": "FolderErrors", + "time": "2015-06-26T13:39:24.697401384+02:00", + "data": { + "errors": [ + { + "error": "open /Users/jb/src/github.com/syncthing/syncthing/test/s2/h2j/.syncthing.aslkjd.tmp: permission denied", + "path": "h2j/aslkjd" + } + ], + "folder": "default" + } + } + +.. versionadded:: 0.11.12 + +.. seealso:: The :ref:`statechanged` event. diff --git a/events/statechanged.rst b/events/statechanged.rst index 7c19ea100..509bf6b28 100644 --- a/events/statechanged.rst +++ b/events/statechanged.rst @@ -1,3 +1,5 @@ +.. _statechanged: + StateChanged ------------