Class SyncConfiguration

A SyncConfiguration is used to setup a Realm that can be synchronized between devices using the Realm Object Server. A valid User is required to create a SyncConfiguration.

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

Constructors

| Improve this Doc View Source

SyncConfiguration(User, Uri, String)

Initializes a new instance of the SyncConfiguration class.

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

A valid User. If not provided, the currently logged-in user will be used.
Uri serverUri

A unique Uri that identifies the Realm. In URIs, ~ can be used as a placeholder for a user Id. If a relative Uri is provided, it will be resolved using the user's ServerUri as baseUri. If null is passed, a Uri will be constructed from the user's ServerUri, combined with /default and IsPartial will be set to true.
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

IsPartial

Gets or sets a value indicating whether this Realm should be opened in 'query-based synchronization' mode. Query-based synchronization mode means that no objects are synchronized from the remote Realm except those matching queries that the user explicitly specifies.

Declaration
[Obsolete("Create QueryBasedSyncConfiguration instead.")]
public bool IsPartial { get; set; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

SetFeatureToken(String)

Sets the feature token, associated with your edition. You only need to call it if you're using a professional or higher edition and only on platforms where features are disabled for lower editions.

Declaration
[Obsolete("Feature tokens are no longer necessary to access Professional or Enterprise API.")]
public static void SetFeatureToken(string token)
Parameters
Type Name Description
String token

The feature token provided to you by the Realm team.
See Also

See Also