Realm Kotlin SDK - Sync/io.realm.kotlin.mongodb.ext

Package-level declarations

Types

CallBuilder

@ExperimentalRealmSerializerApi

class CallBuilder<T>

Builder used to construct a call defining serializers for the different arguments and return value.

Functions

call

inline suspend fun <T> Functions.call(name: String, vararg args: Any?): T

Invokes an Atlas function.

@ExperimentalRealmSerializerApi

inline suspend fun <T> Functions.call(name: String, callBuilderBlock: CallBuilder<T>.() -> Unit): T

Invokes an Atlas function using the EJson encoder defined in AppConfiguration.ejson.

customData

@ExperimentalRealmSerializerApi

inline fun <T> User.customData(): T?

@ExperimentalRealmSerializerApi

fun <T> User.customData(serializer: KSerializer<T>): T?

Returns the custom user data associated with the user in the Realm App as T.

customDataAsBsonDocument

inline fun User.customDataAsBsonDocument(): BsonDocument?

Return the custom user data associated with the user in the Realm App as BsonDocument.

insert

@ExperimentalAsymmetricSyncApi

fun <T : AsymmetricRealmObject> MutableRealm.insert(obj: T)

Insert an AsymmetricRealmObject into Realm. Since asymmetric objects are "write-only", it is not possible to access the managed data after it has been inserted.

@ExperimentalAsymmetricSyncApi

fun DynamicMutableRealm.insert(obj: DynamicRealmObject)

Insert a dynamic version of a AsymmetricRealmObject into a realm. Since asymmetric objects are "write-only", it is not possible to access the managed data after it has been inserted.

profile

@ExperimentalRealmSerializerApi

inline fun <T> User.profile(): T

@ExperimentalRealmSerializerApi

fun <T> User.profile(serializer: KSerializer<T>): T

Returns the profile for this user as a T.

profileAsBsonDocument

inline fun User.profileAsBsonDocument(): BsonDocument

Returns the profile for this user as BsonDocument.

@ExperimentalFlexibleSyncApi

suspend fun <T : RealmObject> RealmQuery<T>.subscribe(mode: WaitForSync = WaitForSync.FIRST_TIME, timeout: Duration = Duration.INFINITE): RealmResults<T>

@ExperimentalFlexibleSyncApi

suspend fun <T : RealmObject> RealmResults<T>.subscribe(mode: WaitForSync = WaitForSync.FIRST_TIME, timeout: Duration = Duration.INFINITE): RealmResults<T>

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.

@ExperimentalFlexibleSyncApi

suspend fun <T : RealmObject> RealmQuery<T>.subscribe(name: String, updateExisting: Boolean = false, mode: WaitForSync = WaitForSync.FIRST_TIME, timeout: Duration = Duration.INFINITE): RealmResults<T>

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.

@ExperimentalFlexibleSyncApi

suspend fun <T : RealmObject> RealmResults<T>.subscribe(name: String, updateExisting: Boolean = false, mode: WaitForSync = WaitForSync.FIRST_TIME, timeout: Duration = Duration.INFINITE): RealmResults<T>

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.