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
    SyncConfiguration
    Inherited Members
    Namespace:Realms.Sync
    Assembly:Realm.Sync.dll
    Syntax
    public class SyncConfiguration : RealmConfigurationBase

    Constructors

    | Improve this Doc View Source

    SyncConfiguration(User, Uri, String)

    Initializes a new instance of the SyncConfiguration class.

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

    A valid User.
    Uri serverUri

    A unique Uri that identifies the Realm. In URIs, ~ can be used as a placeholder for a user Id.
    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

    EnableSSLValidation

    Gets or sets a value indicating whether SSL certificate validation is enabled for the connection associated with this configuration value.

    Declaration
    public bool EnableSSLValidation { get; set; }
    Property Value
    Type Description
    Boolean

    true if SSL validation is enabled; otherwise, false. Default value is true.
    | Improve this Doc View Source

    ServerUri

    Gets the Uri used to create this SyncConfiguration.

    Declaration
    public Uri ServerUri { get; }
    Property Value
    Type Description
    Uri

    The Uri where the Realm Object Server is hosted.
    | Improve this Doc View Source

    TrustedCAPath

    Gets or sets the path to the trusted root certificate(s) authority (CA) in PEM format, that should be used to validate the TLS connections to the Realm Object Server.

    Declaration
    public string TrustedCAPath { get; set; }
    Property Value
    Type Description
    String

    The path to the certificate.
    Remarks

    The file will be copied at runtime into the internal storage.
    It is recommended to include only the root CA you trust, and not the entire list of root CA as this file will be loaded at runtime. It is your responsibility to download and verify the correct PEM for the root CA you trust.

    See Also
    | Improve this Doc View Source

    User

    Gets the User used to create this SyncConfiguration.

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

    The User whose Realms will be synced.

    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
    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