Realm Kotlin SDK - Sync/io.realm.kotlin.mongodb.sync/SyncConfiguration

SyncConfiguration

interface SyncConfiguration : Configuration

A SyncConfiguration is used to setup a Realm Database that can be synchronized between devices using Atlas Device Sync.

A valid User is required to create a SyncConfiguration. See Credentials and App.login for more information on how to get a user object.

A minimal SyncConfiguration can be found below.

    val app = App.create(appId)
    val user = app.login(Credentials.anonymous())
    val config = SyncConfiguration.create(user, "partition-value", setOf(YourRealmObject::class))
    val realm = Realm.open(config)

Types

Builder

class Builder : Configuration.SharedBuilder<SyncConfiguration, SyncConfiguration.Builder>

Used to create a SyncConfiguration. For common use cases, a SyncConfiguration can be created using the SyncConfiguration.create function.

Companion

object Companion

Properties

compactOnLaunchCallback

abstract val compactOnLaunchCallback: CompactOnLaunchCallback?

encryptionKey

abstract val encryptionKey: ByteArray?

errorHandler

abstract val errorHandler: SyncSession.ErrorHandler

initialDataCallback

abstract val initialDataCallback: InitialDataCallback?

initialRealmFileConfiguration

abstract val initialRealmFileConfiguration: InitialRealmFileConfiguration?

initialRemoteData

abstract val initialRemoteData: InitialRemoteDataConfiguration?

Configuration options if downloading initial data from the server has been enabled for this realm.

initialSubscriptions

abstract val initialSubscriptions: InitialSubscriptionsConfiguration?

Configuration options if initial subscriptions have been enabled for this realm.

inMemory

abstract val inMemory: Boolean

maxNumberOfActiveVersions

abstract val maxNumberOfActiveVersions: Long

name

abstract val name: String

path

abstract val path: String

schema

abstract val schema: Set<KClass<out BaseRealmObject>>

schemaVersion

abstract val schemaVersion: Long

syncClientResetStrategy

abstract val syncClientResetStrategy: SyncClientResetStrategy

Strategy used to handle client reset scenarios.

syncMode

abstract val syncMode: SyncMode

The mode of synchronization for this realm.

user

abstract val user: User