Reaccionar a los cambios - SDK .NET

Registrar un oyente de cambio de reino

Puedes registrar un controlador de notificaciones en todo un dominio. El dominio invoca el controlador de notificaciones cada vez que se confirma una transacción de escritura en ese dominio.

El controlador no recibe información específica sobre el cambio. Esto es útil cuando se desea saber si ha habido un cambio, pero no se necesita saber específicamente qué cambio se ha producido.

Supone que estás creando una aplicación colaborativa en tiempo real y deseas tener un contador que aumente cada vez que se realice un cambio. En este escenario, podrías suscribirte al gestor de notificaciones del realm y añadir el código que controla el indicador.

// Observe realm notifications.
realm.RealmChanged += (sender, eventArgs) =>
{
    // The "sender" object is the realm that has changed.
    // "eventArgs" is reserved for future use.
    // ... update UI ...
};

Esté atento a los cambios en la colección

Puedes observar los cambios en una colección de objetos de dominio y en las propiedades de la colección de dominios de un objeto. Hay dos maneras de recibir notificaciones sobre los cambios en una colección: registrar un controlador de notificaciones en la colección o controlar el evento CollectionChanged.

Puedes registrar un controlador de notificaciones en una colección específica dentro de un dominio. La colección puede estar formada por objetos del dominio (como realm.All<Person>()) o por una propiedad de colección en un objeto del dominio (como house.Owners, donde "Propietarios" es de tipo IList).

El controlador recibe una descripción de los cambios realizados en la colección desde la última notificación. A diferencia de las notificaciones de todo el dominio, las notificaciones de colección contienen información detallada sobre el cambio y proporcionan la información necesaria para administrar una lista u otra vista que represente la colección en la interfaz de usuario.

Realm emite una notificación inicial al añadir una suscripción. Tras la notificación inicial, Realm envía notificaciones asincrónicamente cada vez que una transacción de escritura añade, modifica o elimina objetos de la colección.

// Watch for collection notifications.
var subscriptionToken = realm.All<Dog>()
    .SubscribeForNotifications((sender, changes) =>
{
    if (changes == null)
    {
        // This is the case when the notification is called
        // for the first time.
        // Populate tableview/listview with all the items
        // from `collection`
        return;
    }
    // Handle individual changes
    foreach (var i in changes.DeletedIndices)
    {
        // ... handle deletions ...
    }
    foreach (var i in changes.InsertedIndices)
    {
        // ... handle insertions ...
    }
    foreach (var i in changes.NewModifiedIndices)
    {
        // ... handle modifications ...
    }
    if (changes.IsCleared)
    {
        // A special case if the collection has been cleared:
        // i.e., all items have been deleted by calling
        // the Clear() method.
    }
});

var query = realm.All<Person>();
KeyPathsCollection kpc;
// Use one of these equivalent declarations to 
// specify the fields you want to monitor for changes:
kpc = KeyPathsCollection.Of("Email", "Name");
kpc = new List<KeyPath> {"Email", "Name"};
// To get all notifications for top-level properties
// and 4 nested levels of properties, use the `Full` 
// static value:
kpc = KeyPathsCollection.Full;
// To receive notifications for changes to the
// collection only and none of the properties,
// use the `Shallow` static value:
kpc = KeyPathsCollection.Shallow;
query.SubscribeForNotifications(notificationCallback, kpc);

Anular el registro de un detector de cambios

Para anular el registro de un detector de cambios, llame a Dispose en el token. El siguiente código muestra cómo hacerlo:

// Watch for collection notifications.
// Call Dispose() when you are done observing the
// collection.
var token = realm.All<Dog>()
    .SubscribeForNotifications((sender, changes) =>
    {
        // etc.
    });
// When you no longer want to receive notifications:
token.Dispose();

{
    // Subscribe to a query
    realm.All<Dog>().AsRealmCollection().CollectionChanged +=
        HandleCollectionChanged;
    // Subscribe to a property collection
    gracie.Owners.AsRealmCollection().CollectionChanged +=
        HandleCollectionChanged;
   ...
}
private void HandleCollectionChanged(object? sender,
    NotifyCollectionChangedEventArgs e)
{
    // Use e.Action to get the
    // NotifyCollectionChangedAction type.
    if (e.Action == NotifyCollectionChangedAction.Add)
    {
        // etc.
    }
}

Registrar un detector de cambios de objetos

Puedes registrar un controlador de notificaciones en un objeto específico dentro de un dominio para que el SDK te notifique cuando cambie alguna de sus propiedades. El controlador recibe información sobre qué campo ha cambiado. Con el nombre del campo, puedes obtener el nuevo valor.

El siguiente código muestra cómo observar un objeto en busca de cambios.

    var artist = realm.All<Person>()
        .FirstOrDefault(p => p.Name == "Elvis Presley");
    artist.PropertyChanged += (sender, eventArgs) =>
    {
        var changedProperty = eventArgs.PropertyName!;
        Debug.WriteLine(
            $@"New value set for 'artist':
            '{changedProperty}' is now {artist.GetType()
            .GetProperty(changedProperty).GetValue(artist)}");
    };
    realm.Write(() =>
    {
        artist.Name = "Elvis Costello";
    });
    realm.Refresh();
}

Anular el registro de un detector de cambios

Cuando ya no desee recibir notificaciones sobre un detector de cambios, cancele el registro del controlador. El código es el mismo para una colección de objetos de dominio y una propiedad de colección. El siguiente código muestra cómo cancelar el registro de un detector de cambios en ambos casos:

// Unsubscribe from notifications on a
// realm listener
realm.RealmChanged -= OnRealmChanged;
// Unsubscribe from notifications on a
// collection of realm objects
realm.All<Item>().AsRealmCollection()
    .CollectionChanged -= OnItemsChangedHandler;
// Unsubscribe from notifications on a
// collection property
items.AsRealmCollection().CollectionChanged -= OnItemsChangedHandler;

Límites de notificación de cambios

Los cambios en documentos anidados a más de cuatro niveles de profundidad no activan notificaciones de cambio.

Si tiene una estructura de datos en la que necesita escuchar cambios cinco niveles más abajo o más profundos, las soluciones alternativas incluyen:

• Refactorice el esquema para reducir la anidación.

• Agregue algo como "push-to-refresh" para permitir que los usuarios actualicen los datos manualmente.