Realm Kotlin SDK/io.realm.kotlin/Configuration

Configuration

interface Configuration
Content copied to clipboard

Base configuration options shared between all realm configuration types.

Types

SharedBuilder
Link copied to clipboard
abstract class SharedBuilder<T, S : Configuration.SharedBuilder<T, S>>(schema: Set<KClass<out BaseRealmObject>>)
Content copied to clipboard

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

Properties

compactOnLaunchCallback
Link copied to clipboard
abstract val compactOnLaunchCallback: CompactOnLaunchCallback?
Content copied to clipboard

Callback that determines if the realm file should be compacted as part of opening it.

encryptionKey
Link copied to clipboard
abstract val encryptionKey: ByteArray?
Content copied to clipboard

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

initialDataCallback
Link copied to clipboard
abstract val initialDataCallback: InitialDataCallback?
Content copied to clipboard

Callback that will be triggered in order to write initial data when the Realm file is created for the first time.

initialRealmFileConfiguration
Link copied to clipboard
abstract val initialRealmFileConfiguration: InitialRealmFileConfiguration?
Content copied to clipboard

Configuration that holds details of a bundled asset file used as initial state of the realm file. See SharedBuilder.initialRealmFile for details. null is returned if no initial realm file has been configured.

inMemory
Link copied to clipboard
abstract val inMemory: Boolean
Content copied to clipboard

Describes whether the realm should reside in memory or on disk.

log
Link copied to clipboard
abstract val log: LogConfiguration
Content copied to clipboard

The log configuration used for the realm instance.

maxNumberOfActiveVersions
Link copied to clipboard
abstract val maxNumberOfActiveVersions: Long
Content copied to clipboard

Maximum number of active versions.

name
Link copied to clipboard
abstract val name: String
Content copied to clipboard

Filename of the realm file.

path
Link copied to clipboard
abstract val path: String
Content copied to clipboard

Path to the realm file.

schema
Link copied to clipboard
abstract val schema: Set<KClass<out BaseRealmObject>>
Content copied to clipboard

The set of classes included in the schema for the realm.

schemaVersion
Link copied to clipboard
abstract val schemaVersion: Long
Content copied to clipboard

The schema version.

Inheritors

RealmConfiguration
Link copied to clipboard