downloadAllServerChanges

abstract suspend fun downloadAllServerChanges(timeout: Duration = Duration.INFINITE): Boolean

Calling this method will block until all known remote changes have been downloaded and applied to the Realm or the specified timeout is hit. This will involve network access, so calling this method should only be done from a non-UI thread.

Return

true if the data was downloaded. false if the download timed out before it could complete. The download will continue in the background, even after returning false.

Parameters

timeout

Maximum amount of time before this method should return.

Throws

if timeout is <= 0.

if a problem was encountered with the connection during the download.