Enumeration SyncMode

SyncMode defines synchronization modes for the PushPullChanges API (documents) and the RefreshChannel heartbeat (channels).

Enumeration Members

Manual: "manual"

Manual mode indicates that changes are not automatically pushed or pulled.

Polling: "polling"

Polling mode runs the sync loop without opening a watch stream.

For Channel: heartbeat refreshes TTL and brings sessionCount.
For Document: PushPullChanges runs at the polling interval. Remote changes arrive on the next tick (latency = interval). Not suitable for collaborative editing — use Realtime for that.

Realtime: "realtime"

Realtime mode indicates that changes are automatically pushed and pulled.

RealtimePushOnly: "realtime-pushonly"

RealtimePushOnly mode indicates that only local changes are automatically pushed.

RealtimeSyncOff: "realtime-syncoff"

RealtimeSyncOff mode indicates that changes are not automatically pushed or pulled, but the watch stream is kept active.