|
|
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
|
..
|
|
|
-.TH "SYNCTHING-EVENT-API" "7" "Mar 13, 2022" "v1.19.1" "Syncthing"
|
|
|
+.TH "SYNCTHING-EVENT-API" "7" "Mar 20, 2022" "v1.19.1" "Syncthing"
|
|
|
.SH NAME
|
|
|
syncthing-event-api \- Event API
|
|
|
.SH DESCRIPTION
|
|
|
@@ -593,6 +593,32 @@ state.
|
|
|
.fi
|
|
|
.UNINDENT
|
|
|
.UNINDENT
|
|
|
+.SS FolderWatchStateChanged
|
|
|
+.sp
|
|
|
+The \fBFolderWatchStateChanged\fP event is emitted when a folder’s watcher routine
|
|
|
+encounters a new error, or when a previous error disappeared after retrying.
|
|
|
+The event contains the ID of the affected folder and textual error messages
|
|
|
+describing the previous (\fBfrom\fP) and the updated (\fBto\fP) error conditions.
|
|
|
+If there was no error in either of these, the respective field is omitted.
|
|
|
+.INDENT 0.0
|
|
|
+.INDENT 3.5
|
|
|
+.sp
|
|
|
+.nf
|
|
|
+.ft C
|
|
|
+{
|
|
|
+ "id": 123,
|
|
|
+ "type": "FolderWatchStateChanged",
|
|
|
+ "time": "2022\-03\-14T12:34:56.890000000+01:00",
|
|
|
+ "data": {
|
|
|
+ "folder": "default",
|
|
|
+ "from": "Something bad happened.",
|
|
|
+ "to": "Something worse happened."
|
|
|
+ }
|
|
|
+}
|
|
|
+.ft P
|
|
|
+.fi
|
|
|
+.UNINDENT
|
|
|
+.UNINDENT
|
|
|
.SS ItemFinished
|
|
|
.sp
|
|
|
Generated when Syncthing ends synchronizing a file to a newer version. A
|
|
|
@@ -738,8 +764,16 @@ This event is emitted when a listen address changes.
|
|
|
.sp
|
|
|
Generated upon scan whenever the local disk has discovered an updated file from the
|
|
|
previous scan. This does \fInot\fP include events that are discovered and copied from
|
|
|
-other devices (remote\-change\-detected), only files that were changed on the
|
|
|
+other devices (remotechangedetected), only files that were changed on the
|
|
|
local filesystem.
|
|
|
+.sp
|
|
|
+\fBNOTE:\fP
|
|
|
+.INDENT 0.0
|
|
|
+.INDENT 3.5
|
|
|
+This event is not included in /rest/events\-get endpoint without
|
|
|
+a mask specified, but needs to be selected explicitly.
|
|
|
+.UNINDENT
|
|
|
+.UNINDENT
|
|
|
.INDENT 0.0
|
|
|
.INDENT 3.5
|
|
|
.sp
|
|
|
@@ -895,7 +929,15 @@ longer pending for any device.
|
|
|
.SS RemoteChangeDetected
|
|
|
.sp
|
|
|
Generated upon scan whenever a file is locally updated due to a remote change.
|
|
|
-Files that are updated locally produce a local\-change\-detected event.
|
|
|
+Files that are updated locally produce a localchangedetected event.
|
|
|
+.sp
|
|
|
+\fBNOTE:\fP
|
|
|
+.INDENT 0.0
|
|
|
+.INDENT 3.5
|
|
|
+This event is not included in /rest/events\-get endpoint without
|
|
|
+a mask specified, but needs to be selected explicitly.
|
|
|
+.UNINDENT
|
|
|
+.UNINDENT
|
|
|
.INDENT 0.0
|
|
|
.INDENT 3.5
|
|
|
.sp
|