waitForSynchronization

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

Wait for the subscription set to synchronize with the server. It will return when the server either accepts the set of queries and has downloaded data for them, or if an error has occurred.

Return

true if all current subscriptions were accepted by the server and data has been downloaded, or false if the timeout was hit before all data could be downloaded.

Parameters

timeout

how long to wait for the synchronization to either succeed or fail.

Throws

io.realm.kotlin.mongodb.exceptions.BadFlexibleSyncQueryException

if the server did not accept the set of queries. The exact reason is found in the exception message. The SubscriptionSet will also enter a SubscriptionSetState.ERROR state.