Package io.ably.lib.objects

Interface LiveObjectsPlugin

All Superinterfaces:
PluginInstance
public interface LiveObjectsPlugin extends PluginInstance
The LiveObjectsPlugin interface provides a mechanism for managing and interacting with live data objects in a real-time environment. It allows for the retrieval, disposal, and management of LiveObjects instances associated with specific channel names.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose(@NotNull String channelName)
    Disposes of the LiveObjects instance associated with the specified channel name.
    @NotNull LiveObjects
    getInstance(@NotNull String channelName)
    Retrieves an instance of LiveObjects associated with the specified channel name.

    Methods inherited from interface io.ably.lib.plugins.PluginInstance

    dispose, handle

  • Method Details

    • getInstance

      @NotNull @NotNull LiveObjects getInstance(@NotNull @NotNull String channelName)
      Retrieves an instance of LiveObjects associated with the specified channel name. This method ensures that a LiveObjects instance is available for the given channel, creating one if it does not already exist.
      Parameters:
      channelName - the name of the channel for which the LiveObjects instance is to be retrieved.
      Returns:
      the LiveObjects instance associated with the specified channel name.

    • dispose

      void dispose(@NotNull @NotNull String channelName)
      Disposes of the LiveObjects instance associated with the specified channel name. This method removes the LiveObjects instance for the given channel, releasing any resources associated with it.
      Parameters:
      channelName - the name of the channel whose LiveObjects instance is to be removed.