Realm Kotlin SDK - Sync/io.realm.kotlin.mongodb.sync/Subscription

Subscription

A subscription defines a specific server query and its metadata. The result of this query is continuously being synchronized with the device as long as the subscription is part of a SubscriptionSet with a state of SubscriptionSetState.COMPLETE.

Subscriptions can be updated using MutableSubscriptionSet.add with updateExisting = true.

Properties

createdAt

abstract val createdAt: RealmInstant

The timestamp for when this subscription was created.

abstract val id: ObjectId

An unique id, generated by Realm, that identifies this subscription.

name

abstract val name: String?

The name of subscription or null if this is an anonymous subscription.

objectType

abstract val objectType: String

The class name of the objects being queried.

queryDescription

abstract val queryDescription: String

The subscription query that is running on objects of type objectType.

updatedAt

abstract val updatedAt: RealmInstant

The timestamp for when a persisted subscription was updated. When the subscription is created, this field is equal to createdAt.

Functions

asQuery

abstract fun <T : RealmObject> asQuery(type: KClass<T>): RealmQuery<T>

Converts the Subscription.queryDescription back to a RealmQuery that can be executed against the local Realm.

asQuery

inline fun <T : RealmObject> Subscription.asQuery(): RealmQuery<T>

Converts the Subscription.queryDescription back to a RealmQuery that can be executed against the local Realm.