setDelayForSyncingLocalChanges

abstract fun setDelayForSyncingLocalChanges(syncDelay: Long)

Delay in milliseconds before kicking off automatic sync after local changes are made to the document.

Setting this to a higher value will reduce the load on the network and reduce energy use but means other users will not see annotation updates as soon, which also increases the chance of sync conflicts. Setting this to a positive value less than 1000 ms may strain the network and battery and is not recommended.

Important: When using this constant, remember to also disable listening for server changes - Instant’s sync operations are always two-way, so any incoming changes from the server would cause your local changes to be sent to the server.

Parameters

syncDelay

Delay in ms for automatic pushing of local changes to Instant Server (PSPDFKit Document Engine). Defaults to 1000 ms. Setting this to SYNC_LOCAL_CHANGES_DISABLED deactivates automatic pushing of local changes. It's callers responsibility to call syncAnnotationsAsync to push latest changes in that case.

See also