Package io.ably.lib.objects.type.map

Interface LiveMapChange

All Known Subinterfaces:
LiveMap
public interface LiveMapChange
Provides methods to subscribe to real-time updates on LiveMap objects. Enables clients to receive notifications when map entries are added, updated, or removed. Uses last-write-wins conflict resolution when multiple clients modify the same key.

  • Method Details

    • subscribe

      @NonBlocking @NotNull @NotNull ObjectsSubscription subscribe(@NotNull @NotNull LiveMapChange.Listener listener)
      Subscribes to real-time updates on this LiveMap object. Multiple listeners can be subscribed to the same object independently. Spec: RTLO4b
      Parameters:
      listener - the listener to be notified of map updates
      Returns:
      an ObjectsSubscription for managing this specific listener

    • unsubscribe

      @NonBlocking void unsubscribe(@NotNull @NotNull LiveMapChange.Listener listener)
      Unsubscribes a specific listener from receiving updates. Has no effect if the listener is not currently subscribed. Spec: RTLO4c
      Parameters:
      listener - the listener to be unsubscribed

    • unsubscribeAll

      @NonBlocking void unsubscribeAll()
      Unsubscribes all listeners from receiving updates. No notifications will be delivered until new listeners are subscribed. Spec: RTLO4d