Package io.ably.lib.liveobjects.path

Interface PathObjectSubscriptionEvent

public interface PathObjectSubscriptionEvent
Event delivered to PathObjectListener.onUpdated(PathObjectSubscriptionEvent) when a change affects the subscribed path.

Spec: RTPO19e / RTTS3d

  • Method Details

    • getObject

      @NotNull @NotNull PathObject getObject()
      Returns a PathObject pointing to the path where the change occurred.

      Spec: RTPO19e1

      Returns:
      the PathObject at the changed path

    • 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: RTPO19e2 / PAOM1

      Returns:
      the source ObjectMessage, or null if unavailable