SharedBuilder

abstract class SharedBuilder<T, S : RealmConfiguration.SharedBuilder<T, S>>(schema: Set<KClass<out RealmObject>>)

This class contains shared properties across the two types of configuration builders. Abstracting this allows for minimal rewiring by the compiler plugin since build is available to both builders.

The property functions in this builder return the type of the builder itself, represented by S. This is due to library-base not having visibility over library-sync and therefore all function return types have to be typecast as S.

Parameters

the type of RealmConfiguration the builder should generate

the type of builder, needed to distinguish between local and sync variants.

Constructors

SharedBuilder

common

fun SharedBuilder(schema: Set<KClass<out RealmObject>> = setOf())

the type of RealmConfiguration the builder should generate

Functions

build

common

fun build(): T

Creates the RealmConfiguration based on the builder properties.

deleteRealmIfMigrationNeeded

common

fun deleteRealmIfMigrationNeeded(): S

Setting this will change the behavior of how migration exceptions are handled.

encryptionKey

common

fun encryptionKey(encryptionKey: ByteArray): S

Sets the 64 byte key used to encrypt and decrypt the Realm file.

log

common

fun log(level: LogLevel = LogLevel.WARN, customLoggers: List<RealmLogger> = emptyList()): S

Configure how Realm will report log events.

maxNumberOfActiveVersions

common

fun maxNumberOfActiveVersions(maxVersions: Long = 8): S

Sets the maximum number of live versions in the Realm file before an IllegalStateException is thrown when attempting to write more data.

name

common

fun name(name: String): S

Sets the filename of the realm file.

path

common

fun path(path: String?): S

Sets the absolute path of the realm file.

schema

common

fun schema(vararg classes: KClass<out RealmObject>): S

Sets the classes of the schema.

fun schema(classes: Set<KClass<out RealmObject>>): S

Sets the classes of the schema.

schemaVersion

common

fun schemaVersion(schemaVersion: Long): S

Sets the schema version of the Realm.

Properties

schema

common

var schema: Set<KClass<out RealmObject>>

Inheritors

RealmConfiguration