Show / Hide Table of Contents

    Interface IChangeDetails

    An object containing information about the change that occurred to a Realm.

    Namespace: Realms.Server
    Assembly: Realm.dll
    Syntax
    public interface IChangeDetails

    Properties

    | Improve this Doc View Source

    Changes

    Gets a collection of detailed change information. The keys of the dictionary contain the names of the objects that have been modified, while the values contain IChangeSetDetails instances describing the indexes of the changed objects.

    Declaration
    IReadOnlyDictionary<string, IChangeSetDetails> Changes { get; }
    Property Value
    Type Description
    IReadOnlyDictionary<String, IChangeSetDetails>

    A IReadOnlyDictionary<TKey,TValue> of object name-change details pair.

    | Improve this Doc View Source

    CurrentRealm

    Gets an instance of the Realm just after the change has occurred. This instance is readonly. If you wish to write some data in response to the change, you use GetRealmForWriting().

    Declaration
    Realm CurrentRealm { get; }
    Property Value
    Type Description
    Realm

    A Realm instance.

    | Improve this Doc View Source

    PreviousRealm

    Gets an instance of the Realm just before the change occurred. It can be used to obtain the deleted items or to compare the properties of the changed items. This instance is readonly and may be null if the Realm was just created.

    Declaration
    Realm PreviousRealm { get; }
    Property Value
    Type Description
    Realm

    A Realm instance.

    | Improve this Doc View Source

    RealmPath

    Gets a value representing the relative path of the Realm.

    Declaration
    string RealmPath { get; }
    Property Value
    Type Description
    String

    A relative path in the form of /some-user-id/myrealm.

    Methods

    | Improve this Doc View Source

    GetRealmForWriting()

    Gets an instance of the Realm that can be used for writing new information or updating existing objects. Because changes may have occurred in the background, this Realm may contain slightly newer data than CurrentRealm.

    Declaration
    Realm GetRealmForWriting()
    Returns
    Type Description
    Realm

    A writeable Realm instance.

    Remarks

    Writing to this Realm will cause changes to be propagated to all synchronized clients, including the INotifier. A change notification will then be sent to handlers so care must be taken to avoid creating an endless loop.

    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Realm
    Generated by DocFX