A-index

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

A

AblyBase - class in io.ably.lib.rest

A client that offers a simple stateless API to interact directly with Ably's REST API.

AblyBase.Channels - class in io.ably.lib.rest.AblyBase

A collection of Channels associated with an Ably instance.

AblyException - class in io.ably.lib.types

An exception type encapsulating an Ably error code

AblyException.HostFailedException - class in io.ably.lib.types.AblyException

ablyHttpExecute(Http,String,String,Array,Array,HttpCore.RequestBody,HttpCore.ResponseHandler,boolean) - function in io.ably.lib.http.HttpHelpers

Make a synchronous HTTP request to an Ably endpoint, using the Ably auth credentials and fallback hosts if necessary

ablyHttpExecuteWithFallback(String,String,Array,Array,HttpCore.RequestBody,HttpCore.ResponseHandler,boolean,Callback) - function in io.ably.lib.http.HttpScheduler

Make an asynchronous HTTP request to an Ably endpoint, using the Ably auth credentials and fallback hosts if necessary

ablyHttpExecuteWithFallback(String,String,Array,Array,HttpCore.RequestBody,HttpCore.ResponseHandler,boolean,Callback) - function in io.ably.lib.http.AsyncHttpScheduler

Make an asynchronous HTTP request to an Ably endpoint, using the Ably auth credentials and fallback hosts if necessary

ablyHttpExecuteWithFallback(String,String,Array,Array,HttpCore.RequestBody,HttpCore.ResponseHandler,boolean,Callback) - function in io.ably.lib.http.SyncHttpScheduler

Make an asynchronous HTTP request to an Ably endpoint, using the Ably auth credentials and fallback hosts if necessary

ablyHttpExecuteWithRetry(String,String,String,Array,Array,HttpCore.RequestBody,HttpCore.ResponseHandler,boolean,Callback) - function in io.ably.lib.http.HttpScheduler

Make an asynchronous HTTP request to an Ably endpoint, using the Ably auth credentials and reauthentication if necessary

ablyHttpExecuteWithRetry(String,String,String,Array,Array,HttpCore.RequestBody,HttpCore.ResponseHandler,boolean,Callback) - function in io.ably.lib.http.AsyncHttpScheduler

Make an asynchronous HTTP request to an Ably endpoint, using the Ably auth credentials and reauthentication if necessary

ablyHttpExecuteWithRetry(String,String,String,Array,Array,HttpCore.RequestBody,HttpCore.ResponseHandler,boolean,Callback) - function in io.ably.lib.http.SyncHttpScheduler

Make an asynchronous HTTP request to an Ably endpoint, using the Ably auth credentials and reauthentication if necessary

AblyRealtime - class in io.ably.lib.realtime

A client that extends the functionality of the AblyRest and provides additional realtime-specific features.

AblyRealtime.Channels - class in io.ably.lib.realtime.AblyRealtime

A collection of Channels associated with this Ably Realtime instance.

AblyRest - class in io.ably.lib.rest

A client that offers a simple stateless API to interact directly with Ably's REST API.

absent - enum entry in io.ably.lib.types.PresenceMessage.Action

A member is not present in the channel.

Spec: TP2

ack - enum entry in io.ably.lib.types.ProtocolMessage.Action

ackRequired(ProtocolMessage) - function in io.ably.lib.types.ProtocolMessage

(RTN7a)

activate - enum entry in io.ably.lib.types.ProtocolMessage.Action

activate() - function in io.ably.lib.push.Push

Activates the device for push notifications with FCM or APNS, obtaining a unique identifier from them.Subsequently registers the device with Ably and stores the deviceIdentityToken in local storage.

activate(boolean) - function in io.ably.lib.push.Push

Activates the device for push notifications with FCM or APNS, obtaining a unique identifier from them.Subsequently registers the device with Ably and stores the deviceIdentityToken in local storage.

ActivationContext - class in io.ably.lib.push

ActivationStateMachine - class in io.ably.lib.push

ActivationStateMachine.AfterRegistrationSyncFailed - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.CalledActivate - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.CalledDeactivate - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.Deregistered - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.DeregistrationFailed - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.ErrorEvent - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.Event - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.GettingDeviceRegistrationFailed - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.GettingPushDeviceDetailsFailed - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.GotDeviceRegistration - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.GotPushDeviceDetails - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.NotActivated - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.PersistKeys - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.RegistrationSynced - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.State - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.SyncRegistrationFailed - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.WaitingForDeregistration - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.WaitingForDeviceRegistration - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.WaitingForNewPushDeviceDetails - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.WaitingForPushDeviceDetails - class in io.ably.lib.push.ActivationStateMachine

ActivationStateMachine.WaitingForRegistrationSync - class in io.ably.lib.push.ActivationStateMachine

ACTIVE - enum entry in io.ably.lib.rest.DeviceDetails.Push.State

Adapter - class in io.ably.lib.objects

add(T) - function in io.ably.lib.util.CompletionListener.Multicaster

add(T) - function in io.ably.lib.util.ConnectionStateListener.Multicaster

add(T) - function in io.ably.lib.util.ChannelStateListener.Multicaster

add(String,Object) - function in io.ably.lib.util.JsonUtils.JsonUtilsObject

add(T) - function in io.ably.lib.util.Multicaster

addErrorInfo(Intent,ErrorInfo) - function in io.ably.lib.util.IntentUtils

addListener(NetworkConnectivity.NetworkConnectivityListener) - function in io.ably.lib.transport.AndroidNetworkConnectivity

addListener(NetworkConnectivity.NetworkConnectivityListener) - function in io.ably.lib.transport.NetworkConnectivity

addListener(NetworkConnectivity.NetworkConnectivityListener) - function in io.ably.lib.transport.NetworkConnectivity.DefaultNetworkConnectivity

addListener(NetworkConnectivity.NetworkConnectivityListener) - function in io.ably.lib.transport.NetworkConnectivity.DelegatedNetworkConnectivity

addOperation(String,String) - function in io.ably.lib.types.Capability

Add an operation to an existing Capability instance for agiven resource.

addResource(String,Array) - function in io.ably.lib.types.Capability

Add a resource to an existing Capability instance with thegiven set of operations.

addSuppressed(Throwable) - function in java.lang.MessageDecodeException

addSuppressed(Throwable) - function in java.lang.AblyException

addSuppressed(Throwable) - function in java.lang.AblyException.HostFailedException

addSuppressed(Throwable) - function in java.lang.HttpCore.AuthRequiredException

AgentHeaderCreator - class in io.ably.lib.util

AndroidNetworkConnectivity - class in io.ably.lib.platform

AndroidPlatformAgentProvider - class in io.ably.lib.util

annotation - enum entry in io.ably.lib.types.ProtocolMessage.Action

Annotation - class in io.ably.lib.types

Annotation.ActionSerializer - class in io.ably.lib.types.Annotation

Annotation.Serializer - class in io.ably.lib.types.Annotation

ANNOTATION_CREATE - enum entry in io.ably.lib.types.AnnotationAction

(TAN2b) A created annotation

ANNOTATION_DELETE - enum entry in io.ably.lib.types.AnnotationAction

(TAN2b) A deleted annotation

annotation_publish - enum entry in io.ably.lib.types.ProtocolMessage.Flag

annotation_publish - enum entry in io.ably.lib.types.ChannelMode

The client can publish annotation messages.

annotation_subscribe - enum entry in io.ably.lib.types.ProtocolMessage.Flag

annotation_subscribe - enum entry in io.ably.lib.types.ChannelMode

The client can subscribe to annotation messages.

AnnotationAction - class in io.ably.lib.types

Enumerates the possible values of the action field of an Annotation

AnnotationSerializer - class in io.ably.lib.types

annotationType() - function in java.lang.annotation.Annotation

array(Param) - function in io.ably.lib.types.Param

asJson() - function in io.ably.lib.rest.Auth.TokenDetails

Convert a TokenDetails into a JSON string.

asJson() - function in io.ably.lib.rest.Auth.TokenRequest

Convert a TokenParams into a JSON string.

asJsonArray(Array) - function in io.ably.lib.objects.ObjectsSerializer

Serializes the given Object array as a JSON array.

asJsonElement() - function in io.ably.lib.rest.Auth.TokenDetails

Convert a TokenDetails into a JSON object.

asJsonElement() - function in io.ably.lib.rest.Auth.TokenRequest

Convert a TokenParams into a JSON object.

asJsonObject() - function in io.ably.lib.types.MessageExtras

asJsonRequest(PresenceMessage) - function in io.ably.lib.types.PresenceSerializer

**************************************JSON encode

asJsonRequest(Array) - function in io.ably.lib.types.PresenceSerializer

asJsonRequest(Message) - function in io.ably.lib.types.MessageSerializer

**************************************JSON encode

asJsonRequest(Array) - function in io.ably.lib.types.MessageSerializer

asJSONRequest(Array) - function in io.ably.lib.types.MessageSerializer

asJsonRequest(Message,MessageOperation,ChannelOptions) - function in io.ably.lib.types.MessageOperationSerializer

Creates a JSON request body for a message update/delete operation.

asJsonRequest(Array) - function in io.ably.lib.types.AnnotationSerializer

asMap() - function in io.ably.lib.rest.Auth.TokenParams

Internal; convert a TokenParams to a collection of Params

asMap() - function in io.ably.lib.rest.Auth.TokenRequest

Internal; convert a TokenParams to a collection of Params

asMsgpackRequest(Message) - function in io.ably.lib.types.MessageSerializer

**************************************Msgpack encode

asMsgpackRequest(Array) - function in io.ably.lib.types.MessageSerializer

asMsgPackRequest(Message,MessageOperation,ChannelOptions) - function in io.ably.lib.types.MessageOperationSerializer

Creates a MessagePack request body for a message update/delete operation.

asMsgpackRequest(Array) - function in io.ably.lib.types.AnnotationSerializer

assertAuthorizationHeader(boolean) - function in io.ably.lib.rest.Auth

Get the Authorization header, forcing the creation of a new token if requested

assertValidToken() - function in io.ably.lib.rest.Auth

asSummaryDistinctV1(JsonObject) - function in io.ably.lib.types.Summary

asSummaryFlagV1(JsonObject) - function in io.ably.lib.types.Summary

asSummaryMultipleV1(JsonObject) - function in io.ably.lib.types.Summary

asSummaryTotalV1(JsonObject) - function in io.ably.lib.types.Summary

asSummaryUniqueV1(JsonObject) - function in io.ably.lib.types.Summary

async(Callback) - function in io.ably.lib.http.BasePaginatedQuery.ResultRequest

async(Callback) - function in io.ably.lib.http.BasePaginatedQuery.ResultRequest.Failed

async(Callback) - function in io.ably.lib.http.Http.Request

AsyncHttpPaginatedQuery - class in io.ably.lib.http

AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult - class in io.ably.lib.http.AsyncHttpPaginatedQuery

A private class encapsulating the result of a single page response

AsyncHttpPaginatedResponse - class in io.ably.lib.types

AsyncHttpPaginatedResponse.Callback - class in io.ably.lib.types.AsyncHttpPaginatedResponse

An interface allowing a client to be notified of the outcomeof an asynchronous operation.

AsyncHttpScheduler - class in io.ably.lib.http

A HttpScheduler that uses a thread pool to run HTTP operations.

AsyncPaginatedQuery - class in io.ably.lib.http

An object that encapsulates parameters of a REST query with a paginated response

AsyncPaginatedResult - class in io.ably.lib.types

A type that represents a page of results from a paginated query.

attach - enum entry in io.ably.lib.types.ProtocolMessage.Action

attach() - function in io.ably.lib.realtime.Channel

Attach to this channel ensuring the channel is created in the Ably system and all messages publishedon the channel are received by any channel listeners registered using subscribe.

attach(CompletionListener) - function in io.ably.lib.realtime.Channel

Attach to this channel ensuring the channel is created in the Ably system and all messages publishedon the channel are received by any channel listeners registered using subscribe.

attach() - function in io.ably.lib.realtime.ChannelBase

Attach to this channel ensuring the channel is created in the Ably system and all messages publishedon the channel are received by any channel listeners registered using subscribe.

attach(CompletionListener) - function in io.ably.lib.realtime.ChannelBase

Attach to this channel ensuring the channel is created in the Ably system and all messages publishedon the channel are received by any channel listeners registered using subscribe.

attach_resume - enum entry in io.ably.lib.types.ProtocolMessage.Flag

attached - enum entry in io.ably.lib.types.ProtocolMessage.Action

attached - enum entry in io.ably.lib.realtime.ChannelEvent

attached - enum entry in io.ably.lib.realtime.ChannelState

The attach has succeeded.In the ATTACHED state a client may publish and subscribe to messages, or be present on the channel.

attaching - enum entry in io.ably.lib.realtime.ChannelEvent

attaching - enum entry in io.ably.lib.realtime.ChannelState

An attach has been initiated by sending a request to Ably.This is a transient state, followed either by a transition to ATTACHED, SUSPENDED, or FAILED.

auth - enum entry in io.ably.lib.types.ProtocolMessage.Action

Auth - class in io.ably.lib.rest

Token-generation and authentication operations for the Ably API.

Auth.AuthMethod - class in io.ably.lib.rest.Auth

Authentication methods

Auth.AuthOptions - class in io.ably.lib.rest.Auth

Passes authentication-specific properties in authentication requests to Ably.Properties set using AuthOptions are used instead of the default values set when the client libraryis instantiated, as opposed to being merged with them.

Auth.AuthUpdateResult - class in io.ably.lib.rest.Auth

An interface providing update result for onAuthUpdated

Auth.RenewAuthResult - class in io.ably.lib.rest.Auth

An interface providing completion callbackk for renewAuth

Auth.TokenCallback - class in io.ably.lib.rest.Auth

An interface implemented by a callback that provides either tokens,or signed token requests, in response to a request with given token params.

Auth.TokenDetails - class in io.ably.lib.rest.Auth

Contains an Ably Token and its associated metadata.

Auth.TokenParams - class in io.ably.lib.rest.Auth

Defines the properties of an Ably Token.

Auth.TokenRequest - class in io.ably.lib.rest.Auth

Contains the properties of a request for a token to Ably.

authorise(Auth.TokenParams,Auth.AuthOptions) - function in io.ably.lib.rest.Auth

Alias of authorize() (0.

authorize(Auth.TokenParams,Auth.AuthOptions) - function in io.ably.lib.rest.Auth

Instructs the library to get a new token immediately.When using the realtime client, it upgrades the current realtime connection to use the new token,or if not connected, initiates a connection to Ably, once the new token has been obtained.

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