SharedBuilder

Base class for configuration builders that holds properties available to both RealmConfiguration and SyncConfiguration.

Parameters

the type of Configuration the builder should generate.

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

SharedBuilder

the type of Configuration the builder should generate.

build

abstract fun build(): T

Creates the RealmConfiguration based on the builder properties.

compactOnLaunch

fun compactOnLaunch(callback: CompactOnLaunchCallback = Realm.DEFAULT_COMPACT_ON_LAUNCH_CALLBACK): S

Sets a callback for controlling whether the realm should be compacted when opened.

encryptionKey

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

initialData

Writes initial data to the Realm file.

initialRealmFile

fun initialRealmFile(assetFile: String, sha256checkSum: String? = null): S

Initializes a realm file with a bundled asset realm file.

inMemory

Setting this will create an in-memory Realm instead of saving it to disk.

log

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

Configure how Realm will report log events.

maxNumberOfActiveVersions

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

name

abstract fun name(name: String): S

Sets the filename of the realm file.

schemaVersion

fun schemaVersion(schemaVersion: Long): S

Sets the schema version of the Realm.

RealmConfiguration