Show / Hide Table of Contents

    Class ClientResetException

    An exception describing a condition where a reset of the local Realm is required.

    Inheritance
    Object
    Exception
    SessionException
    ClientResetException
    Implements
    ISerializable
    Inherited Members
    SessionException.ErrorCode
    Namespace: Realms.Sync.Exceptions
    Assembly: Realm.dll
    Syntax
    public class ClientResetException : SessionException, ISerializable

    Properties

    | Improve this Doc View Source

    BackupFilePath

    Gets the path where the backup copy of the realm will be placed once the client reset process is complete.

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

    The path to the backup realm.

    Methods

    | Improve this Doc View Source

    InitiateClientReset()

    Initiates the client reset process.

    Declaration
    public bool InitiateClientReset()
    Returns
    Type Description
    Boolean

    true if actions were run successfully, false otherwise.

    Remarks

    On Windows, all Realm instances for that path must be disposed before this method is called or an Exception will be thrown.

    Implements

    System.Runtime.Serialization.ISerializable
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Realm
    Generated by DocFX