Package io.ably.lib.liveobjects.instance

Interface InstanceSubscriptionEvent

public interface InstanceSubscriptionEvent
Event delivered to InstanceListener.onUpdated(InstanceSubscriptionEvent) when the LiveObject wrapped by a subscribed LiveMapInstance or LiveCounterInstance is updated.

Spec: RTINS16e

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable ObjectMessage
    getMessage()
    Returns the ObjectMessage describing the operation that caused this event, if any.
    @NotNull Instance
    getObject()
    Returns an Instance wrapping the LiveObject that was updated.

  • Method Details

    • getObject

      @NotNull @NotNull Instance getObject()
      Returns an Instance wrapping the LiveObject that was updated.

      Spec: RTINS16e1

      Returns:
      the updated instance

    • getMessage

      @Nullable @Nullable ObjectMessage getMessage()
      Returns the ObjectMessage describing the operation that caused this event, if any. The value is present whenever the underlying update carried an object message with an operation; otherwise it is null.

      Spec: RTINS16e2 / PAOM1

      Returns:
      the source ObjectMessage, or null if unavailable