Realm Kotlin SDK/io.realm.kotlin.dynamic/DynamicMutableRealmObject

DynamicMutableRealmObject

interface DynamicMutableRealmObject : DynamicRealmObject

A dynamic mutable realm object gives access and possibility to update the data of the realm objects through a generic string based API instead of the conventional Realm API that only allows access and updates through the properties of the corresponding schema classes supplied in the configuration.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val type: String

The type of the object.

Functions

Link copied to clipboard
abstract fun getBacklinks(propertyName: String): RealmResults<out DynamicRealmObject>

Returns a backlinks collection referenced by the property name as a RealmResults.

Link copied to clipboard
abstract fun <T : Any> getNullableValue(propertyName: String, clazz: KClass<T>): T?

Returns the value of a specific nullable value property.

Link copied to clipboard
inline fun <T : Any> DynamicRealmObject.getNullableValue(fieldName: String): T?

Returns the value of a specific nullable value property.

Link copied to clipboard
abstract fun <T : Any> getNullableValueDictionary(propertyName: String, clazz: KClass<T>): RealmDictionary<T?>

Returns the dictionary of nullable elements referenced by the property name as a RealmDictionary.

Link copied to clipboard
inline fun <T : Any> DynamicRealmObject.getNullableValueDictionary(fieldName: String): RealmDictionary<T?>

Returns the set of nullable elements referenced by the property name as a RealmDictionary.

Link copied to clipboard
abstract fun <T : Any> getNullableValueList(propertyName: String, clazz: KClass<T>): RealmList<T?>

Returns the list of nullable elements referenced by the property name as a RealmList.

Link copied to clipboard
inline fun <T : Any> DynamicRealmObject.getNullableValueList(fieldName: String): RealmList<T?>

Returns the list of nullable elements referenced by the property name as a RealmList.

Link copied to clipboard
abstract fun <T : Any> getNullableValueSet(propertyName: String, clazz: KClass<T>): RealmSet<T?>

Returns the set of nullable elements referenced by the property name as a RealmSet.

Link copied to clipboard
inline fun <T : Any> DynamicRealmObject.getNullableValueSet(fieldName: String): RealmSet<T?>

Returns the set of nullable elements referenced by the property name as a RealmSet.

Link copied to clipboard
abstract override fun getObject(propertyName: String): DynamicMutableRealmObject?

Returns the value of an object property.

Link copied to clipboard
abstract override fun getObjectDictionary(propertyName: String): RealmDictionary<DynamicMutableRealmObject?>

Returns the dictionary of objects referenced by the property name as a RealmDictionary.

Link copied to clipboard
abstract override fun getObjectList(propertyName: String): RealmList<DynamicMutableRealmObject>

Returns the list of objects referenced by the property name as a RealmList.

Link copied to clipboard
abstract override fun getObjectSet(propertyName: String): RealmSet<DynamicMutableRealmObject>

Returns the set of objects referenced by the property name as a RealmSet.

Link copied to clipboard
abstract fun <T : Any> getValue(propertyName: String, clazz: KClass<T>): T

Returns the value of a specific non-nullable value property.

Link copied to clipboard
inline fun <T : Any> DynamicRealmObject.getValue(fieldName: String): T

Returns the value of a specific value property.

Link copied to clipboard
abstract fun <T : Any> getValueDictionary(propertyName: String, clazz: KClass<T>): RealmDictionary<T>

Returns the dictionary of non-nullable value elements referenced by the property name as a RealmDictionary.

Link copied to clipboard
inline fun <T : Any> DynamicRealmObject.getValueDictionary(fieldName: String): RealmDictionary<T>

Returns the set referenced by the property name as a RealmDictionary.

Link copied to clipboard
abstract fun <T : Any> getValueList(propertyName: String, clazz: KClass<T>): RealmList<T>

Returns the list of non-nullable value elements referenced by the property name as a RealmList.

Link copied to clipboard
inline fun <T : Any> DynamicRealmObject.getValueList(fieldName: String): RealmList<T>

Returns the list referenced by the property name as a RealmList.

Link copied to clipboard
abstract fun <T : Any> getValueSet(propertyName: String, clazz: KClass<T>): RealmSet<T>

Returns the set of non-nullable value elements referenced by the property name as a RealmSet.

Link copied to clipboard
inline fun <T : Any> DynamicRealmObject.getValueSet(fieldName: String): RealmSet<T>

Returns the set referenced by the property name as a RealmSet.

Link copied to clipboard
fun BaseRealmObject.isFrozen(): Boolean

Returns whether the object is frozen or not.

Link copied to clipboard
fun BaseRealmObject.isManaged(): Boolean

Returns whether or not this object is managed by Realm.

Link copied to clipboard
fun BaseRealmObject.isValid(): Boolean

Returns true if this object is still valid to use, i.e. the Realm is open and the underlying object has not been deleted. Unmanaged objects are always valid.

Link copied to clipboard
open fun set(vararg pairs: Pair<String, Any?>): DynamicMutableRealmObject

abstract fun <T> set(propertyName: String, value: T): DynamicMutableRealmObject

Sets the value for the given field.

Link copied to clipboard
fun BaseRealmObject.version(): VersionId

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