Realm Kotlin SDK/io.realm.kotlin/TypedRealm

TypedRealm

A typed realm that can be queried for objects of a specific type.

Functions

copyFromRealm

abstract fun <T : TypedRealmObject> copyFromRealm(obj: T, depth: UInt = UInt.MAX_VALUE): T

Makes an unmanaged in-memory copy of an already persisted io.realm.kotlin.types.RealmObject. This is a deep copy that will copy all referenced objects.

abstract fun <T : TypedRealmObject> copyFromRealm(dictionary: RealmDictionary<T?>, depth: UInt = UInt.MAX_VALUE): Map<String, T?>

Makes an unmanaged in-memory copy of a RealmDictionary of already persisted io.realm.kotlin.types.RealmObjects. This is a deep copy that will copy all referenced objects.

abstract fun <T : TypedRealmObject> copyFromRealm(collection: Iterable<T>, depth: UInt = UInt.MAX_VALUE): List<T>

Makes an unmanaged in-memory copy of a collection of already persisted io.realm.kotlin.types.RealmObjects. This is a deep copy that will copy all referenced objects.

getNumberOfActiveVersions

abstract fun getNumberOfActiveVersions(): Long

Returns the current number of active versions in the Realm file. A large number of active versions can have a negative impact on the Realm file size on disk.

isClosed

abstract fun isClosed(): Boolean

Check if this Realm has been closed or not. If the Realm has been closed, most methods will throw IllegalStateException if called.

query

abstract fun <T : TypedRealmObject> query(clazz: KClass<T>, query: String = TRUE_PREDICATE, vararg args: Any?): RealmQuery<T>

Returns a RealmQuery matching the predicate represented by query.

schema

abstract fun schema(): RealmSchema

Returns an immutable schema of the realm.

schemaVersion

abstract fun schemaVersion(): Long

Returns the schema version of the realm.

version

abstract fun version(): VersionId

Returns the Realm version of this object. This version number is tied to the transaction the object was read from.

Properties

configuration

abstract val configuration: Configuration

Configuration used to configure this Realm instance.

Inheritors

MutableRealm

Realm

Extensions

query

inline fun <T : TypedRealmObject> TypedRealm.query(query: String = TRUE_PREDICATE, vararg args: Any?): RealmQuery<T>

Returns a RealmQuery matching the predicate represented by query.