Search Results for

    Show / Hide Table of Contents

    Class PartitionSyncConfiguration

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

    Inheritance
    Object
    RealmConfigurationBase
    SyncConfigurationBase
    PartitionSyncConfiguration
    SyncConfiguration
    Inherited Members
    SyncConfigurationBase.User
    SyncConfigurationBase.ClientResetHandler
    SyncConfigurationBase.OnSessionError
    SyncConfigurationBase.CancelAsyncOperationsOnNonFatalErrors
    RealmConfigurationBase.DefaultRealmName
    RealmConfigurationBase.DatabasePath
    RealmConfigurationBase.FallbackPipePath
    RealmConfigurationBase.IsDynamic
    RealmConfigurationBase.ObjectClasses
    RealmConfigurationBase.Schema
    RealmConfigurationBase.GetPathToRealm(String)
    RealmConfigurationBase.SchemaVersion
    RealmConfigurationBase.EncryptionKey
    RealmConfigurationBase.MaxNumberOfActiveVersions
    Namespace: Realms.Sync
    Assembly: Realm.dll
    Syntax
    public class PartitionSyncConfiguration : SyncConfigurationBase

    Constructors

    | Improve this Doc View Source

    PartitionSyncConfiguration(Nullable<ObjectId>, User, String)

    Initializes a new instance of the PartitionSyncConfiguration class.

    Declaration
    public PartitionSyncConfiguration(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

    PartitionSyncConfiguration(Nullable<Guid>, User, String)

    Initializes a new instance of the PartitionSyncConfiguration class.

    Declaration
    public PartitionSyncConfiguration(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

    PartitionSyncConfiguration(Nullable<Int64>, User, String)

    Initializes a new instance of the PartitionSyncConfiguration class.

    Declaration
    public PartitionSyncConfiguration(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

    PartitionSyncConfiguration(String, User, String)

    Initializes a new instance of the PartitionSyncConfiguration class.

    Declaration
    public PartitionSyncConfiguration(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

    OnProgress

    Gets or sets a callback that is invoked when download progress is made when using GetInstanceAsync(RealmConfigurationBase, CancellationToken). This will only be invoked for the initial download of the Realm and will not be invoked as futher download progress is made during the lifetime of the Realm. It is ignored when using GetInstance(RealmConfigurationBase).

    Declaration
    public Action<SyncProgress> OnProgress { get; set; }
    Property Value
    Type Description
    Action<SyncProgress>

    A callback that will be periodically invoked as the Realm is downloaded.

    | Improve this Doc View Source

    Partition

    Gets the partition identifying the Realm this configuration is describing.

    Declaration
    public RealmValue Partition { get; }
    Property Value
    Type Description
    RealmValue

    The partition value for the Realm.

    See Also

    Sync Overview Docs
    • Improve this Doc
    • View Source
    In This Article
    Back to top Copyright © 2020 Realm
    Generated by DocFX