Package io.realm

Core functions and types.

Types

BaseRealm

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

CompactOnLaunchCallback

fun fun interface CompactOnLaunchCallback

This interface is used to determine if a Realm file should be compacted the first time the file is opened and before the instance is returned.

Configuration

interface Configuration

Base configuration options shared between all realm configuration types.

Deleteable

interface Deleteable

A deleteable is an entity that can be deleted in a write transaction or as part of a migration.

LogConfiguration

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

Configuration for log events created by a Realm instance.

MutableRealm

interface MutableRealm : TypedRealm

Represents the writeable state of a Realm file.

Queryable

interface Queryable<T : RealmObject>

Interface holding common query methods.

Realm

interface Realm : TypedRealm

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

RealmConfiguration

interface RealmConfiguration : Configuration

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

RealmInstant

interface RealmInstant : Comparable<RealmInstant>

A representation of a Realm timestamp.

RealmList

interface RealmList<E> : MutableList<E> , Deleteable

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

RealmObject

interface RealmObject : Deleteable

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

RealmResults

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

A Realm Result holds the results of querying the Realm.

TypedRealm

interface TypedRealm : BaseRealm

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

Versioned

interface Versioned

VersionId

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

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

Functions

asFlow

fun <T : RealmObject> T.asFlow(): Flow<ObjectChange<T>>

Observe changes to a Realm object.

isFrozen

fun RealmObject.isFrozen(): Boolean

Returns whether the object is frozen or not.

isManaged

fun RealmObject.isManaged(): Boolean

Returns whether or not this object is managed by Realm.

isValid

fun RealmObject.isValid(): Boolean

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

query

inline fun <T : RealmObject> MutableRealm.query(query: String = "TRUEPREDICATE", vararg args: Any?): RealmQuery<T>

Returns a RealmQuery matching the predicate represented by query.

inline fun <T : RealmObject> Realm.query(query: String = "TRUEPREDICATE", vararg args: Any?): RealmQuery<T>

Returns a RealmQuery matching the predicate represented by query.

inline fun <T : RealmObject> TypedRealm.query(query: String = "TRUEPREDICATE", vararg args: Any?): RealmQuery<T>

Returns a RealmQuery matching the predicate represented by query.

realmListOf

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

Instantiates an unmanagedRealmList.

toRealmList

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

Instantiates an unmanagedRealmList containing all the elements of this iterable.

version

fun RealmObject.version(): VersionId

Returns the Realm version of this object.