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

S

SafeSSLSocketFactory - class in io.ably.lib.transport
This is a decorator for the SSLSocketFactory which modifies the enabled TLS protocols for each created SSLSocket to only use the protocols which are considered to be safe.
save(DeviceDetails) - function in io.ably.lib.push.PushBase.DeviceRegistrations
Registers or updates a DeviceDetails object with Ably.
save(PushBase.ChannelSubscription) - function in io.ably.lib.push.PushBase.ChannelSubscriptions
Subscribes a device, or a group of devices sharing the same clientId to push notifications on a channel.
saveAsync(DeviceDetails,Callback) - function in io.ably.lib.push.PushBase.DeviceRegistrations
Asynchronously registers or updates a DeviceDetails object with Ably.
saveAsync(PushBase.ChannelSubscription,Callback) - function in io.ably.lib.push.PushBase.ChannelSubscriptions
Asynchronously subscribes a device, or a group of devices sharing the same clientId to push notifications on a channel.
send(ProtocolMessage) - function in io.ably.lib.transport.WebSocketTransport
Send a message on the channel
send(ProtocolMessage) - function in io.ably.lib.transport.ITransport
Send a message on the channel
send(ProtocolMessage,boolean,CompletionListener) - function in io.ably.lib.transport.ConnectionManager
 
sendProtocolMessage(ProtocolMessage,CompletionListener) - function in io.ably.lib.realtime.Channel
(Internal) Sends a protocol message and provides a callback for completion.
sendProtocolMessage(ProtocolMessage,CompletionListener) - function in io.ably.lib.realtime.ChannelBase
(Internal) Sends a protocol message and provides a callback for completion.
Serialisation - class in io.ably.lib.util
 
Serialisation.FromJsonElement - class in io.ably.lib.util.Serialisation
 
Serialisation.HttpBodyHandler - class in io.ably.lib.util.Serialisation
 
Serialisation.HttpResponseHandler - class in io.ably.lib.util.Serialisation
 
serialize(ProtocolMessage.Action,Type,JsonSerializationContext) - function in io.ably.lib.types.ProtocolMessage.ActionSerializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.ProtocolMessage.ActionSerializer
 
serialize(Message,Type,JsonSerializationContext) - function in io.ably.lib.types.Message.Serializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.Message.Serializer
 
serialize(MessageVersion,Type,JsonSerializationContext) - function in io.ably.lib.types.MessageVersion.Serializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.MessageVersion.Serializer
 
serialize(Summary,Type,JsonSerializationContext) - function in io.ably.lib.types.Summary.Serializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.Summary.Serializer
 
serialize(PresenceMessage,Type,JsonSerializationContext) - function in io.ably.lib.types.PresenceMessage.Serializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.PresenceMessage.Serializer
 
serialize(MessageAnnotations,Type,JsonSerializationContext) - function in io.ably.lib.types.MessageAnnotations.Serializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.MessageAnnotations.Serializer
 
serialize(Annotation,Type,JsonSerializationContext) - function in io.ably.lib.types.Annotation.Serializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.Annotation.Serializer
 
serialize(AnnotationAction,Type,JsonSerializationContext) - function in io.ably.lib.types.Annotation.ActionSerializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.Annotation.ActionSerializer
 
serialize(MessageExtras,Type,JsonSerializationContext) - function in io.ably.lib.types.MessageExtras.Serializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.MessageExtras.Serializer
 
serialize(Array,Type,JsonSerializationContext) - function in io.ably.lib.objects.ObjectsJsonSerializer
 
serialize(T,Type,JsonSerializationContext) - function in com.google.gson.ObjectsJsonSerializer
 
serverTimestamp() - function in io.ably.lib.rest.Auth
Using time delta obtained before guess current server time
set(Array,Param) - function in io.ably.lib.types.Param
 
set(Array,String,String) - function in io.ably.lib.types.Param
 
set(String,LiveMapValue) - function in io.ably.lib.objects.type.map.LiveMap
Sets the specified key to the given value in the map.Send a MAP_SET operation to the realtime system to set a key on this LiveMap object to a specified value.This does not modify the underlying data of this LiveMap object.
setAbly(AblyRest) - function in io.ably.lib.push.ActivationContext
 
setActivationContext(Context,ActivationContext) - function in io.ably.lib.push.ActivationContext
 
setActivationStateMachine(ActivationStateMachine) - function in io.ably.lib.push.ActivationContext
 
setAndroidContext(Context) - function in io.ably.lib.rest.AblyRest
Set the Android Context for this instance
setAndroidContext(Context) - function in io.ably.lib.rest.AblyRealtime
Set the Android Context for this instance
setAndroidContext(Context) - function in io.ably.lib.platform.Platform
Set the Android Context for this instance
setAsync(String,LiveMapValue,ObjectsCallback) - function in io.ably.lib.objects.type.map.LiveMap
Asynchronously sets the specified key to the given value in the map.Send a MAP_SET operation to the realtime system to set a key on this LiveMap object to a specified value.This does not modify the underlying data of this LiveMap object.
setClientId(String) - function in io.ably.lib.rest.Auth
Set the clientId, after first initialisation in the construction of the librarytherefore an existing null value is significant - it means that ClientOptions.
setClientId(String,boolean) - function in io.ably.lib.push.ActivationContext
 
setConnected() - function in io.ably.lib.realtime.Channel
 
setConnected() - function in io.ably.lib.realtime.ChannelBase
 
setConnectionClosed(ErrorInfo) - function in io.ably.lib.realtime.Channel
(RTL3b) If the connection state enters the CLOSED state, then anATTACHING or ATTACHED channel state will transition to DETACHED.
setConnectionClosed(ErrorInfo) - function in io.ably.lib.realtime.ChannelBase
(RTL3b) If the connection state enters the CLOSED state, then anATTACHING or ATTACHED channel state will transition to DETACHED.
setConnectionFailed(ErrorInfo) - function in io.ably.lib.realtime.Channel
If the connection state enters the FAILED state, then an ATTACHINGor ATTACHED channel state will transition to FAILED and set theChannel#errorReason
setConnectionFailed(ErrorInfo) - function in io.ably.lib.realtime.ChannelBase
If the connection state enters the FAILED state, then an ATTACHINGor ATTACHED channel state will transition to FAILED and set theChannel#errorReason
setDeviceIdentityToken(String) - function in io.ably.lib.push.LocalDevice
 
setFlag(ProtocolMessage.Flag) - function in io.ably.lib.types.ProtocolMessage
 
setFlags(int) - function in io.ably.lib.types.ProtocolMessage
 
setHandler(Log.LogHandler) - function in io.ably.lib.util.Log
 
setLastMessageData(String) - function in io.ably.lib.types.DecodingContext
 
setLastMessageData(Array) - function in io.ably.lib.types.DecodingContext
 
setLevel(int) - function in io.ably.lib.util.Log
 
setOptions(ChannelOptions) - function in io.ably.lib.realtime.Channel
Sets the ChannelOptions for the channel.
setOptions(ChannelOptions,CompletionListener) - function in io.ably.lib.realtime.Channel
Sets the ChannelOptions for the channel.
setOptions(ChannelOptions) - function in io.ably.lib.realtime.ChannelBase
Sets the ChannelOptions for the channel.
setPreferredHost(String,boolean) - function in io.ably.lib.transport.Hosts
set preferred hostname, which might not be the primary
setPreferredHost(String) - function in io.ably.lib.http.HttpCore
Sets host for this HTTP client
setReinitialized() - function in io.ably.lib.realtime.Channel
Internal(RTN11d) Resets channels back to initialized and clears error reason
setReinitialized() - function in io.ably.lib.realtime.ChannelBase
Internal(RTN11d) Resets channels back to initialized and clears error reason
setStackTrace(Array) - function in java.lang.MessageDecodeException
 
setStackTrace(Array) - function in java.lang.AblyException
 
setStackTrace(Array) - function in java.lang.AblyException.HostFailedException
 
setStackTrace(Array) - function in java.lang.HttpCore.AuthRequiredException
 
setState(ChannelState,ErrorInfo) - function in io.ably.lib.realtime.ChannelBase
 
setSuspended(ErrorInfo,boolean) - function in io.ably.lib.realtime.Channel
(RTL3c) If the connection state enters the SUSPENDED state, then anATTACHING or ATTACHED channel state will transition to SUSPENDED.(RTN15c3) The client library should initiate an attach for channelsthat are in the SUSPENDED state.
setSuspended(ErrorInfo,boolean) - function in io.ably.lib.realtime.ChannelBase
(RTL3c) If the connection state enters the SUSPENDED state, then anATTACHING or ATTACHED channel state will transition to SUSPENDED.(RTN15c3) The client library should initiate an attach for channelsthat are in the SUSPENDED state.
setTokenDetails(String) - function in io.ably.lib.rest.Auth
 
SharedPreferenceStorage - class in io.ably.lib.push
 
size() - function in io.ably.lib.types.ReadOnlyMap
 
size() - function in io.ably.lib.rest.AblyBase.Channels
 
size() - function in io.ably.lib.util.CompletionListener.Multicaster
 
size() - function in io.ably.lib.util.ConnectionStateListener.Multicaster
 
size() - function in io.ably.lib.types.AblyRealtime.Channels
 
size() - function in io.ably.lib.util.ChannelStateListener.Multicaster
 
size() - function in io.ably.lib.util.InternalMap
 
size() - function in io.ably.lib.util.Multicaster
 
size() - function in io.ably.lib.objects.type.map.LiveMap
Retrieves the number of entries in the map.
sortAuthenticateHeaders(Collection) - function in io.ably.lib.http.HttpAuth
Split a compound authenticate header string to get details for each auth type
Stats - class in io.ably.lib.types
Contains application statistics for a specified time interval and time period.
stats(Array) - function in io.ably.lib.rest.AblyRest
Queries the REST /stats API and retrieves your application's usage statistics.
stats(Array) - function in io.ably.lib.rest.AblyBase
Queries the REST /stats API and retrieves your application's usage statistics.
stats(Array) - function in io.ably.lib.rest.AblyRealtime
Queries the REST /stats API and retrieves your application's usage statistics.
Stats.ConnectionTypes - class in io.ably.lib.types.Stats
Contains a breakdown of summary stats data for different (TLS vs non-TLS) connection types.
Stats.Granularity - class in io.ably.lib.types.Stats
Describes the interval unit over which statistics are gathered.
Stats.MessageCategory - class in io.ably.lib.types.Stats
 
Stats.MessageCount - class in io.ably.lib.types.Stats
Contains the aggregate counts for messages and data transferred.
Stats.MessageTraffic - class in io.ably.lib.types.Stats
Contains a breakdown of summary stats data for traffic over various transport types.
Stats.MessageTypes - class in io.ably.lib.types.Stats
Contains a breakdown of summary stats data for different (channel vs presence) message types.
Stats.ProcessedCount - class in io.ably.lib.types.Stats
 
Stats.ProcessedMessages - class in io.ably.lib.types.Stats
 
Stats.PushedMessages - class in io.ably.lib.types.Stats
Details the stats on push notifications.
Stats.RequestCount - class in io.ably.lib.types.Stats
Contains the aggregate counts for requests made.
Stats.ResourceCount - class in io.ably.lib.types.Stats
Contains the aggregate data for usage of a resource in a specific scope.
statsAsync(Array,Callback) - function in io.ably.lib.rest.AblyRest
Asynchronously queries the REST /stats API and retrieves your application's usage statistics.
statsAsync(Array,Callback) - function in io.ably.lib.rest.AblyBase
Asynchronously queries the REST /stats API and retrieves your application's usage statistics.
statsAsync(Array,Callback) - function in io.ably.lib.rest.AblyRealtime
Asynchronously queries the REST /stats API and retrieves your application's usage statistics.
StatsReader - class in io.ably.lib.types
StatsReader: internal Utility class to convert response bodies in different formats to Stats data.
Storage - class in io.ably.lib.push
Interface for an entity that supplies key value store
StringUtils - class in io.ably.lib.util
 
subscribe - enum entry in io.ably.lib.types.ProtocolMessage.Flag
 
subscribe - enum entry in io.ably.lib.types.ChannelMode

The client can subscribe to messages.

subscribe(ChannelBase.MessageListener) - function in io.ably.lib.realtime.Channel
Registers a listener for messages on this channel.The caller supplies a listener function, which is called each time one or more messages arrives on the channel.
subscribe(String,ChannelBase.MessageListener) - function in io.ably.lib.realtime.Channel
Registers a listener for messages with a given event name on this channel.The caller supplies a listener function, which is called each time one or more matching messages arrives on the channel.
subscribe(Array,ChannelBase.MessageListener) - function in io.ably.lib.realtime.Channel
Registers a listener for messages on this channel for multiple event name values.The caller supplies a listener function, which is called each time one or more matching messages arrives on the channel.
subscribe(RealtimeAnnotations.AnnotationListener) - function in io.ably.lib.realtime.RealtimeAnnotations
Subscribes the given AnnotationListener to the channel, allowing it to receive annotations.If the channel's attach on subscribe option is enabled, the channel is attached automatically.
subscribe(String,RealtimeAnnotations.AnnotationListener) - function in io.ably.lib.realtime.RealtimeAnnotations
Subscribes the given AnnotationListener to the channel for a specific annotation type,allowing it to receive annotations of the specified type.
subscribe(ChannelBase.MessageListener) - function in io.ably.lib.realtime.ChannelBase
Registers a listener for messages on this channel.The caller supplies a listener function, which is called each time one or more messages arrives on the channel.
subscribe(String,ChannelBase.MessageListener) - function in io.ably.lib.realtime.ChannelBase
Registers a listener for messages with a given event name on this channel.The caller supplies a listener function, which is called each time one or more matching messages arrives on the channel.
subscribe(Array,ChannelBase.MessageListener) - function in io.ably.lib.realtime.ChannelBase
Registers a listener for messages on this channel for multiple event name values.The caller supplies a listener function, which is called each time one or more matching messages arrives on the channel.
subscribe(Presence.PresenceListener,CompletionListener) - function in io.ably.lib.realtime.Presence
Registers a listener that is called each time a PresenceMessage matching a given PresenceMessage.Action,or an action within an array of PresenceMessage.Action, is received on the channel,such as a new member entering the presence set.
subscribe(Presence.PresenceListener) - function in io.ably.lib.realtime.Presence
Registers a listener that is called each time a PresenceMessage matching a given PresenceMessage.Action,or an action within an array of PresenceMessage.Action, is received on the channel,such as a new member entering the presence set.
subscribe(PresenceMessage.Action,Presence.PresenceListener,CompletionListener) - function in io.ably.lib.realtime.Presence
Registers a listener that is called each time a PresenceMessage matching a given PresenceMessage.Action,or an action within an array of PresenceMessage.Action, is received on the channel,such as a new member entering the presence set.
subscribe(PresenceMessage.Action,Presence.PresenceListener) - function in io.ably.lib.realtime.Presence
Registers a listener that is called each time a PresenceMessage matching a given PresenceMessage.Action,or an action within an array of PresenceMessage.Action, is received on the channel,such as a new member entering the presence set.
subscribe(EnumSet,Presence.PresenceListener,CompletionListener) - function in io.ably.lib.realtime.Presence
Registers a listener that is called each time a PresenceMessage matching a given PresenceMessage.Action,or an action within an array of PresenceMessage.Action, is received on the channel,such as a new member entering the presence set.
subscribe(EnumSet,Presence.PresenceListener) - function in io.ably.lib.realtime.Presence
Registers a listener that is called each time a PresenceMessage matching a given PresenceMessage.Action,or an action within an array of PresenceMessage.Action, is received on the channel,such as a new member entering the presence set.
subscribe(LiveMapChange.Listener) - function in io.ably.lib.objects.type.map.LiveMapChange
Subscribes to real-time updates on this LiveMap object.Multiple listeners can be subscribed to the same object independently.
subscribe(LiveMapChange.Listener) - function in io.ably.lib.objects.type.map.LiveMap
Subscribes to real-time updates on this LiveMap object.Multiple listeners can be subscribed to the same object independently.
subscribe(LiveCounterChange.Listener) - function in io.ably.lib.objects.type.counter.LiveCounter
Subscribes to real-time updates on this LiveCounter object.Multiple listeners can be subscribed to the same object independently.
subscribe(LiveCounterChange.Listener) - function in io.ably.lib.objects.type.counter.LiveCounterChange
Subscribes to real-time updates on this LiveCounter object.Multiple listeners can be subscribed to the same object independently.
subscribeClient() - function in io.ably.lib.push.PushChannel
Subscribes all devices associated with the current device's clientId to push notifications for the channel.
subscribeClientAsync(CompletionListener) - function in io.ably.lib.push.PushChannel
Asynchronously subscribes all devices associated with the current device's clientId to push notifications for the channel.
subscribeDevice() - function in io.ably.lib.push.PushChannel
Subscribes the device to push notifications for the channel.
subscribeDeviceAsync(CompletionListener) - function in io.ably.lib.push.PushChannel
Asynchronously subscribes the device to push notifications for the channel.
Summary - class in io.ably.lib.types
A summary of all the annotations that have been made to the message.
Summary.Serializer - class in io.ably.lib.types.Summary
 
SummaryClientIdCounts - class in io.ably.lib.types
The per-name value for the multiple.v1 aggregation method.
SummaryClientIdList - class in io.ably.lib.types
The summary entry for aggregated annotations that use the flag.v1 aggregation method; also the per-name value for some other aggregation methods.
SummaryTotal - class in io.ably.lib.types
 
suspendAll(ErrorInfo,boolean) - function in io.ably.lib.transport.ConnectionManager.Channels
 
suspended - enum entry in io.ably.lib.realtime.ChannelEvent
 
suspended - enum entry in io.ably.lib.realtime.ChannelState

The channel, having previously been ATTACHED, has lost continuity,usually due to the client being disconnected from Ably for longer than two minutes.It will automatically attempt to reattach as soon as connectivity is restored.

suspended - enum entry in io.ably.lib.realtime.ConnectionEvent
 
suspended - enum entry in io.ably.lib.realtime.ConnectionState

A long term failure condition.No current connection exists because there is no network connectivity or no host is available.The suspended state is entered after a failed connection attempt if there has then been no connection for a period of two minutes.In the suspended state, the library will periodically attempt to open a new connection every 30 seconds.Developers are unable to publish messages in this state.A new connection attempt can also be triggered by an explicit call to connect.Once the connection has been re-established, channels will be automatically re-attached.The client has been disconnected for too long for them to resume from where they left off,so if it wants to catch up on messages published by other clients while it was disconnected,it needs to use the History API.

sync - enum entry in io.ably.lib.types.ProtocolMessage.Action
 
sync() - function in io.ably.lib.realtime.Channel
 
sync() - function in io.ably.lib.realtime.ChannelBase
 
sync() - function in io.ably.lib.http.BasePaginatedQuery.ResultRequest
 
sync() - function in io.ably.lib.http.BasePaginatedQuery.ResultRequest.Failed
 
sync() - function in io.ably.lib.http.Http.Request
 
SYNCED - enum entry in io.ably.lib.objects.state.ObjectsStateEvent

Indicates that synchronization has completed successfully and objects are in sync.

SyncHttpScheduler - class in io.ably.lib.http
A HttpScheduler that runs everything in the current thread.
SYNCING - enum entry in io.ably.lib.objects.state.ObjectsStateEvent

Indicates that synchronization between local and remote objects is in progress.

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