Package io.realm

Core functions and types.

Types

BaseRealm

common

interface BaseRealm : Versioned

Base class for all Realm instances (Realm and MutableRealm).

LogConfiguration

common

data class LogConfiguration(level: LogLevel, loggers: List<RealmLogger>)

Configuration for log events created by a Realm instance.

MutableRealm

common

interface MutableRealm : TypedRealm

Represents the writeable state of a Realm file.

Queryable

common

interface Queryable<T : RealmObject>

Interface holding common query methods.

Realm

common

interface Realm : TypedRealm

A Realm instance is the main entry point for interacting with a persisted Realm.

RealmConfiguration

common

interface RealmConfiguration

A Realm Configuration defining specific setup and configuration for a Realm instance.

RealmList

common

interface RealmList<E> : MutableList<E>

RealmList is used to model one-to-many relationships in a RealmObject.

RealmObject

common

interface RealmObject

Marker interface to define a model (managed by Realm).

RealmResults

common

interface RealmResults<T : RealmObject> : List<T> , Queryable<T> , Versioned

A Realm Result holds the results of querying the Realm.

TypedRealm

common

interface TypedRealm : BaseRealm

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

Versioned

common

interface Versioned

VersionId

common

data class VersionId(version: Long) : Comparable<VersionId>

A VersionId representing the transactional id of the Realm itself or it's objects.

Functions

delete

common

fun RealmObject.delete()

Deletes the RealmObject.

isFrozen

common

fun RealmObject.isFrozen(): Boolean

Returns whether the object is frozen or not.

isManaged

common

fun RealmObject.isManaged(): Boolean

Returns whether or not this object is managed by Realm.

isValid

common

fun RealmObject.isValid(): Boolean

Returns true if this object is still valid to use, i.e.

objects

common

inline fun <T : RealmObject> TypedRealm.objects(): RealmResults<T>

Returns the results of querying for all objects of a specific type.

observe

common

fun <T : RealmObject> T.observe(): Flow<T>

Observe changes to a Realm object.

realmListOf

common

fun <T> realmListOf(vararg elements: T): RealmList<T>

Instantiates an unmanagedRealmList.

toRealmList

common

fun <T> Iterable<T>.toRealmList(): RealmList<T>

Instantiates an unmanagedRealmList containing all the elements of this iterable.

version

common

fun RealmObject.version(): VersionId

Returns the Realm version of this object.