A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  R  S  T  U  V  W  X 

O

object - enum entry in io.ably.lib.types.ProtocolMessage.Action
 
object() - function in io.ably.lib.util.JsonUtils
 
object_publish - enum entry in io.ably.lib.types.ProtocolMessage.Flag
 
object_publish - enum entry in io.ably.lib.types.ChannelMode

The client can publish object messages.

object_subscribe - enum entry in io.ably.lib.types.ProtocolMessage.Flag
 
object_subscribe - enum entry in io.ably.lib.types.ChannelMode

The client can subscribe to object messages.

object_sync - enum entry in io.ably.lib.types.ProtocolMessage.Action
 
ObjectLifecycleChange - class in io.ably.lib.objects.type
Interface for managing subscriptions to Object lifecycle events.
ObjectLifecycleChange.Listener - class in io.ably.lib.objects.type.ObjectLifecycleChange
Interface for receiving notifications about Object lifecycle changes.
ObjectLifecycleEvent - class in io.ably.lib.objects.type
Represents lifecycle events for an Ably Object.
ObjectsAdapter - class in io.ably.lib.objects
 
ObjectsCallback - class in io.ably.lib.objects
Callback interface for handling results of asynchronous Objects operations.
ObjectsHelper - class in io.ably.lib.objects
 
ObjectsJsonSerializer - class in io.ably.lib.objects
 
ObjectsSerializer - class in io.ably.lib.objects
Serializer interface for converting between objects and their MessagePack or JSON representations.
ObjectsStateChange - class in io.ably.lib.objects.state
 
ObjectsStateChange.Listener - class in io.ably.lib.objects.state.ObjectsStateChange
Interface for receiving notifications about Objects synchronization state changes.
ObjectsStateEvent - class in io.ably.lib.objects.state
Represents the synchronization state of Ably Objects.
ObjectsSubscription - class in io.ably.lib.objects
Represents a objects subscription that can be unsubscribed from.
ObjectUpdate - class in io.ably.lib.objects.type
Abstract base class for all LiveMap/LiveCounter update notifications.
of(Boolean) - function in io.ably.lib.objects.type.map.LiveMapValue
Creates a LiveMapValue from a Boolean.
of(Array) - function in io.ably.lib.objects.type.map.LiveMapValue
Creates a LiveMapValue from a Binary.
of(Number) - function in io.ably.lib.objects.type.map.LiveMapValue
Creates a LiveMapValue from a Number.
of(String) - function in io.ably.lib.objects.type.map.LiveMapValue
Creates a LiveMapValue from a String.
of(JsonArray) - function in io.ably.lib.objects.type.map.LiveMapValue
Creates a LiveMapValue from a JsonArray.
of(JsonObject) - function in io.ably.lib.objects.type.map.LiveMapValue
Creates a LiveMapValue from a JsonObject.
of(LiveCounter) - function in io.ably.lib.objects.type.map.LiveMapValue
Creates a LiveMapValue from a LiveCounter.
of(LiveMap) - function in io.ably.lib.objects.type.map.LiveMapValue
Creates a LiveMapValue from a LiveMap.
off() - function in io.ably.lib.util.Channel
Deregisters all registrations, for all events and listeners.
off(Listener) - function in io.ably.lib.util.Channel
Deregisters the specified listener.Removes all registrations matching the given listener, regardless of whether they are associated with an event or not.
off(Event,Listener) - function in io.ably.lib.util.Channel
Removes all registrations that match both the specified listener and the specified event.
off() - function in io.ably.lib.util.ChannelBase
Deregisters all registrations, for all events and listeners.
off(Listener) - function in io.ably.lib.util.ChannelBase
Deregisters the specified listener.Removes all registrations matching the given listener, regardless of whether they are associated with an event or not.
off(Event,Listener) - function in io.ably.lib.util.ChannelBase
Removes all registrations that match both the specified listener and the specified event.
off() - function in io.ably.lib.util.Connection
Deregisters all registrations, for all events and listeners.
off(Listener) - function in io.ably.lib.util.Connection
Deregisters the specified listener.Removes all registrations matching the given listener, regardless of whether they are associated with an event or not.
off(Event,Listener) - function in io.ably.lib.util.Connection
Removes all registrations that match both the specified listener and the specified event.
off() - function in io.ably.lib.util.EventEmitter
Deregisters all registrations, for all events and listeners.
off(Listener) - function in io.ably.lib.util.EventEmitter
Deregisters the specified listener.Removes all registrations matching the given listener, regardless of whether they are associated with an event or not.
off(Event,Listener) - function in io.ably.lib.util.EventEmitter
Removes all registrations that match both the specified listener and the specified event.
off(ObjectsStateChange.Listener) - function in io.ably.lib.objects.state.RealtimeObjects
Unsubscribes the specified listener from all synchronization state events.
off(ObjectLifecycleChange.Listener) - function in io.ably.lib.objects.type.ObjectLifecycleChange
Unsubscribes the specified listener from all lifecycle events.
off(ObjectLifecycleChange.Listener) - function in io.ably.lib.objects.type.LiveMap
Unsubscribes the specified listener from all lifecycle events.
off(ObjectLifecycleChange.Listener) - function in io.ably.lib.objects.type.LiveCounter
Unsubscribes the specified listener from all lifecycle events.
off(ObjectsStateChange.Listener) - function in io.ably.lib.objects.state.ObjectsStateChange
Unsubscribes the specified listener from all synchronization state events.
offAll() - function in io.ably.lib.objects.state.RealtimeObjects
Unsubscribes all listeners from all synchronization state events.
offAll() - function in io.ably.lib.objects.type.ObjectLifecycleChange
Unsubscribes all listeners from all lifecycle events.
offAll() - function in io.ably.lib.objects.type.LiveMap
Unsubscribes all listeners from all lifecycle events.
offAll() - function in io.ably.lib.objects.type.LiveCounter
Unsubscribes all listeners from all lifecycle events.
offAll() - function in io.ably.lib.objects.state.ObjectsStateChange
Unsubscribes all listeners from all synchronization state events.
on(ChannelState,ChannelStateListener) - function in io.ably.lib.realtime.Channel
 
on(Listener) - function in io.ably.lib.util.Channel
Registers the provided listener all events.If on() is called more than once with the same listener, the listeneris only added once.Note: This is in deviation from the spec (see below).
on(Event,Listener) - function in io.ably.lib.util.Channel
Registers the provided listener for the specified event.If on() is called more than once with the same listener, even witha different event, the original listener is replaced.Note: This is in deviation from the spec (see below).
on(ChannelState,ChannelStateListener) - function in io.ably.lib.realtime.ChannelBase
 
on(Listener) - function in io.ably.lib.util.ChannelBase
Registers the provided listener all events.If on() is called more than once with the same listener, the listeneris only added once.Note: This is in deviation from the spec (see below).
on(Event,Listener) - function in io.ably.lib.util.ChannelBase
Registers the provided listener for the specified event.If on() is called more than once with the same listener, even witha different event, the original listener is replaced.Note: This is in deviation from the spec (see below).
on(ConnectionState,ConnectionStateListener) - function in io.ably.lib.realtime.Connection
 
on(Listener) - function in io.ably.lib.util.Connection
Registers the provided listener all events.If on() is called more than once with the same listener, the listeneris only added once.Note: This is in deviation from the spec (see below).
on(Event,Listener) - function in io.ably.lib.util.Connection
Registers the provided listener for the specified event.If on() is called more than once with the same listener, even witha different event, the original listener is replaced.Note: This is in deviation from the spec (see below).
on(Listener) - function in io.ably.lib.util.EventEmitter
Registers the provided listener all events.If on() is called more than once with the same listener, the listeneris only added once.Note: This is in deviation from the spec (see below).
on(Event,Listener) - function in io.ably.lib.util.EventEmitter
Registers the provided listener for the specified event.If on() is called more than once with the same listener, even witha different event, the original listener is replaced.Note: This is in deviation from the spec (see below).
on(ObjectsStateEvent,ObjectsStateChange.Listener) - function in io.ably.lib.objects.state.RealtimeObjects
Subscribes to a specific Objects synchronization state event.
on(ObjectLifecycleEvent,ObjectLifecycleChange.Listener) - function in io.ably.lib.objects.type.ObjectLifecycleChange
Subscribes to a specific Object lifecycle event.
on(ObjectLifecycleEvent,ObjectLifecycleChange.Listener) - function in io.ably.lib.objects.type.LiveMap
Subscribes to a specific Object lifecycle event.
on(ObjectLifecycleEvent,ObjectLifecycleChange.Listener) - function in io.ably.lib.objects.type.LiveCounter
Subscribes to a specific Object lifecycle event.
on(ObjectsStateEvent,ObjectsStateChange.Listener) - function in io.ably.lib.objects.state.ObjectsStateChange
Subscribes to a specific Objects synchronization state event.
onAnnotation(ProtocolMessage) - function in io.ably.lib.realtime.RealtimeAnnotations
Internal method.
onAnnotation(Annotation) - function in io.ably.lib.realtime.RealtimeAnnotations.AnnotationListener
 
onAuthError(ErrorInfo) - function in io.ably.lib.rest.Auth
 
onAuthError(ErrorInfo) - function in io.ably.lib.transport.ConnectionManager
Called when where was an error during authentication attempt
onAuthUpdated(String,boolean) - function in io.ably.lib.transport.ConnectionManager
(RTC8) For a realtime client, Auth.authorize instructs the library toobtain a token using the provided tokenParams and authOptions and upgradethe current connection to use that token; or if not currently connected,to connect with the token.
onAuthUpdatedAsync(String,Auth.AuthUpdateResult) - function in io.ably.lib.transport.ConnectionManager
Async version of onAuthUpdated that returns a Future that includes an option Ably exception
once(ChannelState,ChannelStateListener) - function in io.ably.lib.realtime.Channel
 
once(Listener) - function in io.ably.lib.util.Channel
Registers the provided listener for the first event that is emitted.If once() is called more than once with the same listener,the listener is added multiple times to its listener registry.Therefore, as an example, assuming the same listener is registered twice using once(),and an event is emitted once, the listener would be invoked twice.However, all subsequent events emitted would not invoke the listener as once() ensures that each registration is only invoked once.
once(Event,Listener) - function in io.ably.lib.util.Channel
Registers the provided listener for the first occurrence of a single named event specified as the Event argument.If once() is called more than once with the same listener, the listener is added multiple times to its listener registry.Therefore, as an example, assuming the same listener is registered twice using once(), and an event is emitted once,the listener would be invoked twice.However, all subsequent events emitted would not invoke the listener as once() ensures that each registration is only invoked once.
once(ChannelState,ChannelStateListener) - function in io.ably.lib.realtime.ChannelBase
 
once(Listener) - function in io.ably.lib.util.ChannelBase
Registers the provided listener for the first event that is emitted.If once() is called more than once with the same listener,the listener is added multiple times to its listener registry.Therefore, as an example, assuming the same listener is registered twice using once(),and an event is emitted once, the listener would be invoked twice.However, all subsequent events emitted would not invoke the listener as once() ensures that each registration is only invoked once.
once(Event,Listener) - function in io.ably.lib.util.ChannelBase
Registers the provided listener for the first occurrence of a single named event specified as the Event argument.If once() is called more than once with the same listener, the listener is added multiple times to its listener registry.Therefore, as an example, assuming the same listener is registered twice using once(), and an event is emitted once,the listener would be invoked twice.However, all subsequent events emitted would not invoke the listener as once() ensures that each registration is only invoked once.
once(ConnectionState,ConnectionStateListener) - function in io.ably.lib.realtime.Connection
 
once(Listener) - function in io.ably.lib.util.Connection
Registers the provided listener for the first event that is emitted.If once() is called more than once with the same listener,the listener is added multiple times to its listener registry.Therefore, as an example, assuming the same listener is registered twice using once(),and an event is emitted once, the listener would be invoked twice.However, all subsequent events emitted would not invoke the listener as once() ensures that each registration is only invoked once.
once(Event,Listener) - function in io.ably.lib.util.Connection
Registers the provided listener for the first occurrence of a single named event specified as the Event argument.If once() is called more than once with the same listener, the listener is added multiple times to its listener registry.Therefore, as an example, assuming the same listener is registered twice using once(), and an event is emitted once,the listener would be invoked twice.However, all subsequent events emitted would not invoke the listener as once() ensures that each registration is only invoked once.
once(Listener) - function in io.ably.lib.util.EventEmitter
Registers the provided listener for the first event that is emitted.If once() is called more than once with the same listener,the listener is added multiple times to its listener registry.Therefore, as an example, assuming the same listener is registered twice using once(),and an event is emitted once, the listener would be invoked twice.However, all subsequent events emitted would not invoke the listener as once() ensures that each registration is only invoked once.
once(Event,Listener) - function in io.ably.lib.util.EventEmitter
Registers the provided listener for the first occurrence of a single named event specified as the Event argument.If once() is called more than once with the same listener, the listener is added multiple times to its listener registry.Therefore, as an example, assuming the same listener is registered twice using once(), and an event is emitted once,the listener would be invoked twice.However, all subsequent events emitted would not invoke the listener as once() ensures that each registration is only invoked once.
onChannelStateChanged(ChannelStateListener.ChannelStateChange) - function in io.ably.lib.realtime.ChannelStateListener
Called when channel state changes.
onChannelStateChanged(ChannelStateListener.ChannelStateChange) - function in io.ably.lib.realtime.ChannelStateListener.Multicaster
Called when channel state changes.
onChannelStateChanged(ChannelStateListener.ChannelStateChange) - function in io.ably.lib.realtime.ChannelStateListener.Filter
Called when channel state changes.
onCompletion(boolean,Auth.TokenDetails,ErrorInfo) - function in io.ably.lib.rest.Auth.RenewAuthResult
Signals completion of renewAuth
onConnectionStateChange(ConnectionStateListener.ConnectionStateChange) - function in io.ably.lib.realtime.Connection
 
onConnectionStateChanged(ConnectionStateListener.ConnectionStateChange) - function in io.ably.lib.realtime.ConnectionStateListener
Called when connection state changes.
onConnectionStateChanged(ConnectionStateListener.ConnectionStateChange) - function in io.ably.lib.realtime.ConnectionStateListener.Multicaster
Called when connection state changes.
onConnectionStateChanged(ConnectionStateListener.ConnectionStateChange) - function in io.ably.lib.realtime.ConnectionStateListener.Multicaster
Called when connection state changes.
onConnectionStateChanged(ConnectionStateListener.ConnectionStateChange) - function in io.ably.lib.realtime.ConnectionStateListener.Filter
Called when connection state changes.
onConnectionStateChanged(ConnectionStateListener.ConnectionStateChange) - function in io.ably.lib.realtime.ConnectionStateListener.Filter
Called when connection state changes.
onError(ErrorInfo) - function in io.ably.lib.types.Callback
Called when the associated operation completes with an error.
onError(ErrorInfo) - function in io.ably.lib.types.Callback.Map
Called when the associated operation completes with an error.
onError(ErrorInfo) - function in io.ably.lib.types.AsyncHttpPaginatedResponse.Callback
Called when the associated operation completes with an error.
onError(ErrorInfo) - function in io.ably.lib.realtime.CompletionListener
Called when the associated operation completes with an error.
onError(ErrorInfo) - function in io.ably.lib.realtime.CompletionListener.Multicaster
Called when the associated operation completes with an error.
onError(ErrorInfo) - function in io.ably.lib.realtime.CompletionListener.ToCallback
Called when the associated operation completes with an error.
onError(ErrorInfo) - function in io.ably.lib.realtime.CompletionListener.FromCallback
Called when the associated operation completes with an error.
onError(AblyException) - function in io.ably.lib.objects.ObjectsCallback
Called when the asynchronous operation fails.The exception contains detailed error information including error codes and messages.Common errors include network issues, authentication failures, and validation errors.
onLifecycleEvent(ObjectLifecycleEvent) - function in io.ably.lib.objects.type.ObjectLifecycleChange.Listener
Called when a lifecycle event occurs.
onMessage(Message) - function in io.ably.lib.realtime.Channel.MessageListener
 
onMessage(Message) - function in io.ably.lib.realtime.ChannelBase.MessageListener
 
onMessage(ITransport,ProtocolMessage) - function in io.ably.lib.transport.ConnectionManager
React on message from the transport
onMessage(ProtocolMessage) - function in io.ably.lib.transport.ConnectionManager.Channels
 
onNetworkAvailable() - function in io.ably.lib.transport.NetworkConnectivity.NetworkConnectivityListener
 
onNetworkAvailable() - function in io.ably.lib.transport.NetworkConnectivity.DelegatedNetworkConnectivity
 
onNetworkUnavailable(ErrorInfo) - function in io.ably.lib.transport.NetworkConnectivity.NetworkConnectivityListener
 
onNetworkUnavailable(ErrorInfo) - function in io.ably.lib.transport.NetworkConnectivity.DelegatedNetworkConnectivity
 
onNewRegistrationToken(RegistrationToken.Type,String) - function in io.ably.lib.push.ActivationContext
 
onPresenceMessage(PresenceMessage) - function in io.ably.lib.realtime.Presence.PresenceListener
 
onRawConnect(String) - function in io.ably.lib.debug.DebugOptions.RawProtocolListener
 
onRawConnectRequested(String) - function in io.ably.lib.debug.DebugOptions.RawProtocolListener
 
onRawHttpException(String,String,Throwable) - function in io.ably.lib.debug.DebugOptions.RawHttpListener
 
onRawHttpRequest(String,HttpRequest,String,Map,HttpCore.RequestBody) - function in io.ably.lib.debug.DebugOptions.RawHttpListener
 
onRawHttpResponse(String,String,HttpCore.Response) - function in io.ably.lib.debug.DebugOptions.RawHttpListener
 
onRawMessageRecv(ProtocolMessage) - function in io.ably.lib.debug.DebugOptions.RawProtocolListener
 
onRawMessageSend(ProtocolMessage) - function in io.ably.lib.debug.DebugOptions.RawProtocolListener
 
onResponse(AsyncHttpPaginatedResponse) - function in io.ably.lib.types.AsyncHttpPaginatedResponse.Callback
Called when the associated request completes with an Http response,
onStateChanged(ObjectsStateEvent) - function in io.ably.lib.objects.state.ObjectsStateChange.Listener
Called when the synchronization state changes.
onSuccess(T) - function in io.ably.lib.types.Callback
Called when the associated operation completes successfully,
onSuccess(T) - function in io.ably.lib.types.Callback.Map
Called when the associated operation completes successfully,
onSuccess() - function in io.ably.lib.realtime.CompletionListener
Called when the associated operation completes successfully.
onSuccess() - function in io.ably.lib.realtime.CompletionListener.Multicaster
Called when the associated operation completes successfully.
onSuccess(Void) - function in io.ably.lib.realtime.CompletionListener.ToCallback
Called when the associated operation completes successfully,
onSuccess(T) - function in io.ably.lib.types.CompletionListener.ToCallback
Called when the associated operation completes successfully,
onSuccess() - function in io.ably.lib.realtime.CompletionListener.FromCallback
Called when the associated operation completes successfully.
onSuccess(T) - function in io.ably.lib.objects.ObjectsCallback
Called when the asynchronous operation completes successfully.For modification operations (set, remove, increment), result is typically Void.For creation/retrieval operations, result contains the created/retrieved object.
onTransportAvailable(ITransport) - function in io.ably.lib.transport.ITransport.ConnectListener
 
onTransportAvailable(ITransport) - function in io.ably.lib.transport.ConnectionManager
 
onTransportUnavailable(ITransport,ErrorInfo) - function in io.ably.lib.transport.ITransport.ConnectListener
 
onTransportUnavailable(ITransport,ErrorInfo) - function in io.ably.lib.transport.ConnectionManager
 
onUpdate(boolean,ErrorInfo) - function in io.ably.lib.rest.Auth.AuthUpdateResult
Signals an update from onAuthUpdatedAsync
onUpdated(LiveMapUpdate) - function in io.ably.lib.objects.type.map.LiveMapChange.Listener
Called when the LiveMap has been updated.Should execute quickly as it's called from the real-time processing thread.
onUpdated(LiveCounterUpdate) - function in io.ably.lib.objects.type.counter.LiveCounterChange.Listener
Called when the LiveCounter has been updated.Should execute quickly as it's called from the real-time processing thread.
A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  R  S  T  U  V  W  X