subscribe

Automatically create a named Subscription from a query in the background and return the result of running the same query against the local Realm file.

This is a more streamlined alternative to doing something like this:

fun suspend getData(realm: Realm): RealmResults<Person> {
    realm.subscriptions.update { bgRealm ->
        add("myquery", bgRealm.query<Person>())
    }
    realm.subscriptions.waitForSynchronization()
    return realm.query<Person>().find()
}

It is possible to define whether or not to wait for the server to send all data before running the local query. This is relevant as there might be delay from creating a subscription to the data being available on the device due to either latency or because a large dataset needs to be downloaded.

The default behaviour is that the first time subscribe is called, the query result will not be returned until data has been downloaded from the server. On subsequent calls to subscribe for the same query, the query will run immediately on the local database while any updates are downloaded in the background.

Parameters

Throws

Automatically create an anonymous Subscription from a local query result in the background and return the result of re-running the same query against the Realm file. This behaves the same as creating a named variant by calling subscribe. See this method for details about the exact behavior.

Parameters

Throws

Automatically create a named Subscription from a local query result in the background and return the result of re-running the same query against the Realm file.

This is a more streamlined alternative to doing something like this:

fun suspend getData(realm: Realm): RealmResults<Person> {
    val results = realm.query<Person>().find()
    realm.subscriptions.update { bgRealm ->
        add("myquery", results.query(""))
    }
    realm.subscriptions.waitForSynchronization()
    return realm.query<Person>().find()
}

It is possible to define whether or not to wait for the server to send all data before running the local query. This is relevant as there might be delay from creating a subscription to the data being available on the device due to either latency or because a large dataset needs be downloaded.

The default behaviour is that the first time subscribe is called, the query result will not be returned until data has been downloaded from the server. On subsequent calls to subscribe for the same query, the query will run immediately on the local database while any updates are downloaded in the background.

Parameters

Throws