Configuration

interface Configuration

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 RealmObject>>)
Base class for configuration builders that holds properties available to both RealmConfiguration and SyncConfiguration.

Properties

compactOnLaunchCallback
Link copied to clipboard
abstract val compactOnLaunchCallback: CompactOnLaunchCallback?
Callback that determines if the realm file should be compacted as part of opening it.
encryptionKey
Link copied to clipboard
abstract val encryptionKey: ByteArray?
64 byte key used to encrypt and decrypt the Realm file.
log
Link copied to clipboard
abstract val log: LogConfiguration
The log configuration used for the realm instance.
maxNumberOfActiveVersions
Link copied to clipboard
abstract val maxNumberOfActiveVersions: Long
Maximum number of active versions.
name
Link copied to clipboard
abstract val name: String
Filename of the realm file.
path
Link copied to clipboard
abstract val path: String
Path to the realm file.
schema
Link copied to clipboard
abstract val schema: Set<KClass<out RealmObject>>
The set of classes included in the schema for the realm.
schemaVersion
Link copied to clipboard
abstract val schemaVersion: Long
The schema version.

Inheritors

RealmConfiguration
Link copied to clipboard