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

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.

Constructors

constructor(user: User, schema: Set<KClass<out BaseRealmObject>>)

Creates a SyncConfiguration.Builder for Flexible Sync. Flexible Sync must be enabled on the server for this to work.

constructor(user: User, partitionValue: BsonObjectId?, schema: Set<KClass<out BaseRealmObject>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync. Partition-Based Sync must be enabled on the server for this to work.

constructor(user: User, partitionValue: RealmUUID?, schema: Set<KClass<out BaseRealmObject>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync. Partition-Based Sync must be enabled on the server for this to work.

constructor(user: User, partitionValue: Int?, schema: Set<KClass<out BaseRealmObject>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync. Partition-Based Sync must be enabled on the server for this to work.

constructor(user: User, partitionValue: Long?, schema: Set<KClass<out BaseRealmObject>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync. Partition-Based Sync must be enabled on the server for this to work.

constructor(user: User, partitionValue: String?, schema: Set<KClass<out BaseRealmObject>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync. Partition-Based Sync must be enabled on the server for this to work.

Functions

open override fun build(): SyncConfiguration

compactOnLaunch

fun compactOnLaunch(callback: CompactOnLaunchCallback): SyncConfiguration.Builder

fun encryptionKey(encryptionKey: ByteArray): SyncConfiguration.Builder

fun errorHandler(errorHandler: SyncSession.ErrorHandler): SyncConfiguration.Builder

Sets the error handler used by Synced Realms when reporting errors with their session.

fun initialData(callback: InitialDataCallback): SyncConfiguration.Builder

initialRealmFile

fun initialRealmFile(assetFile: String, sha256checkSum: String?): SyncConfiguration.Builder

initialSubscriptions

fun initialSubscriptions(rerunOnOpen: Boolean = false, initialSubscriptionBlock: InitialSubscriptionsCallback): SyncConfiguration.Builder

Define the initial io.realm.mongodb.sync.SubscriptionSet for the Realm. This will only be executed the first time the Realm file is opened (and the file created).

fun inMemory(): SyncConfiguration.Builder

maxNumberOfActiveVersions

fun maxNumberOfActiveVersions(maxVersions: Long): SyncConfiguration.Builder

open override fun name(name: String): SyncConfiguration.Builder

Sets the filename of the realm file.

fun schemaVersion(schemaVersion: Long): SyncConfiguration.Builder

syncClientResetStrategy

fun syncClientResetStrategy(resetStrategy: SyncClientResetStrategy): SyncConfiguration.Builder

Sets the strategy that would handle the client reset by this synced Realm.

waitForInitialRemoteData

fun waitForInitialRemoteData(timeout: Duration = Duration.INFINITE): SyncConfiguration.Builder

Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened. The Realm will not open until all the data has been downloaded. This means that if a device is offline the Realm will not open.