Show / Hide Table of Contents

    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
    RealmConfigurationBase.DefaultRealmName
    RealmConfigurationBase.DatabasePath
    RealmConfigurationBase.ObjectClasses
    RealmConfigurationBase.GetPathToRealm(String)
    RealmConfigurationBase.SchemaVersion
    RealmConfigurationBase.EncryptionKey
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    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

    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

    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.

    See Also

    LoginAsync(Credentials, Uri)
    Credentials
    • Improve this Doc
    • View Source
    Back to top Copyright © 2017 Realm
    Generated by DocFX