SyncConfiguration
@frozen
public struct SyncConfiguration : Sendable
A SyncConfiguration
represents configuration parameters for Realms intended to sync with
Atlas App Services.
-
The
SyncUser
who owns the Realm that this configuration should open.Declaration
Swift
public var user: User { get }
-
The value this Realm is partitioned on. The partition key is a property defined in Atlas App Services. All classes with a property with this value will be synchronized to the Realm.
Declaration
Swift
public var partitionValue: AnyBSON? { get }
-
An enum which determines file recovery behavior in the event of a client reset.
Note
Defaults to
.recoverUnsyncedChanges
See
ClientResetMode
andRLMClientResetMode
Declaration
Swift
public var clientResetMode: ClientResetMode { get }
-
By default, Realm.asyncOpen() swallows non-fatal connection errors such as a connection attempt timing out and simply retries until it succeeds. If this is set to
true
, instead the error will be reported to the callback and the async open will be cancelled.Declaration
Swift
public var cancelAsyncOpenOnNonFatalErrors: Bool { get }
-
A configuration that controls how initial subscriptions are populated when the Realm is opened.
Declaration
Swift
public var initialSubscriptions: InitialSubscriptionsConfiguration? { get }