Class SyncConfigurationBase

A SyncConfigurationBase is used to setup a Realm that can be synchronized between devices using Atlas Device Sync. There are two synchronization modes with their respective configurations - "partition" sync with PartitionSyncConfiguration allows you to split your data in separarate partitions and synchronize an entire partition with an entire Realm; "flexible" sync with FlexibleSyncConfiguration allows you to start with an empty Realm and send the server a set of queries which it will run and populate the Realm with all documents matching them.

Inheritance
Object
RealmConfigurationBase
SyncConfigurationBase
FlexibleSyncConfiguration
PartitionSyncConfiguration
Inherited Members
Namespace: Realms.Sync
Assembly: Realm.dll
Syntax
public abstract class SyncConfigurationBase : RealmConfigurationBase

Constructors

| Improve this Doc View Source

SyncConfigurationBase(User)

Initializes a new instance of the SyncConfigurationBase class.

Declaration
protected SyncConfigurationBase(User user)
Parameters
Type Name Description
User user

A valid User.

Properties

| Improve this Doc View Source

ClientResetHandler

Gets or sets a handler that will be invoked if a client reset error occurs for this Realm. Default is RecoverUnsyncedChangesHandler with fallback to discarding unsynced local changes.

Declaration
public virtual ClientResetHandlerBase ClientResetHandler { get; set; }
Property Value
Type Description
ClientResetHandlerBase

The ClientResetHandlerBase that will be used to handle a client reset.
Remarks

Supported values are instances of ManualRecoveryHandler, DiscardUnsyncedChangesHandler and RecoverUnsyncedChangesHandler. The default RecoverUnsyncedChangesHandler will have no custom actions set for the before and after callbacks.

See Also
| Improve this Doc View Source

OnSessionError

Gets or sets a callback that will be invoked whenever a SessionException occurs for the synchronized Realm.

Declaration
public SyncConfigurationBase.SessionErrorCallback OnSessionError { get; set; }
Property Value
Type Description
SyncConfigurationBase.SessionErrorCallback

The SyncConfigurationBase.SessionErrorCallback that will be used to report transient session errors.
Remarks

Client reset errors will not be reported through this callback as they are handled by the set ClientResetHandler.

| Improve this Doc View Source

User

Gets the User used to create this SyncConfigurationBase.

Declaration
public User User { get; }
Property Value
Type Description
User

The User whose Realms will be synced.

See Also