Class SyncConfiguration

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

Inheritance
Object
RealmConfigurationBase
SyncConfigurationBase
PartitionSyncConfiguration
SyncConfiguration
Inherited Members
Namespace: Realms.Sync
Assembly: Realm.dll
Syntax
[Obsolete("Use PartitionSyncConfiguration instead.")]
public class SyncConfiguration : PartitionSyncConfiguration

Constructors

| Improve this Doc View Source

SyncConfiguration(Nullable<ObjectId>, User, String)

Initializes a new instance of the SyncConfiguration class.

Declaration
public SyncConfiguration(ObjectId? partition, User user, string optionalPath = null)
Parameters
Type Name Description
Nullable<MongoDB.Bson.ObjectId> partition

The partition identifying the remote Realm that will be synchronized.
User user

A valid User.
String optionalPath

Path to the realm, must be a valid full path for the current platform, relative subdirectory, or just filename.
| Improve this Doc View Source

SyncConfiguration(Nullable<Guid>, User, String)

Initializes a new instance of the SyncConfiguration class.

Declaration
public SyncConfiguration(Guid? partition, User user, string optionalPath = null)
Parameters
Type Name Description
Nullable<Guid> partition

The partition identifying the remote Realm that will be synchronized.
User user

A valid User.
String optionalPath

Path to the realm, must be a valid full path for the current platform, relative subdirectory, or just filename.
| Improve this Doc View Source

SyncConfiguration(Nullable<Int64>, User, String)

Initializes a new instance of the SyncConfiguration class.

Declaration
public SyncConfiguration(long? partition, User user, string optionalPath = null)
Parameters
Type Name Description
Nullable<Int64> partition

The partition identifying the remote Realm that will be synchronized.
User user

A valid User.
String optionalPath

Path to the realm, must be a valid full path for the current platform, relative subdirectory, or just filename.
| Improve this Doc View Source

SyncConfiguration(String, User, String)

Initializes a new instance of the SyncConfiguration class.

Declaration
public SyncConfiguration(string partition, User user, string optionalPath = null)
Parameters
Type Name Description
String partition

The partition identifying the remote Realm that will be synchronized.
User user

A valid User.
String optionalPath

Path to the realm, must be a valid full path for the current platform, relative subdirectory, or just filename.

Properties

| Improve this Doc View Source

Partition

Gets the partition identifying the Realm this configuration is describing.

Declaration
public object Partition { get; }
Property Value
Type Description
Object

The partition value for the Realm.

See Also