descriptions.md

Classes and types

class RestClient

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

Method / Property	Parameter	Returns	Spec	Description
constructor(keyOrTokenStr: String)			RSC1	Constructs a RestClient object using an Ably API key or token string.
	keyOrTokenStr			The Ably API key or token string used to validate the client.
constructor(ClientOptions)			RSC1	Construct a RestClient object using an Ably [ClientOptions]{@link ClientOptions} object.
	ClientOptions			A [ClientOptions]{@link ClientOptions} object to configure the client connection to Ably.
auth: Auth			RSC5	An [Auth]{@link Auth} object.
push: Push			RSH7	A [Push]{@link Push} object.
device() => LocalDevice			RSH8	Retrieves a [LocalDevice]{@link LocalDevice} object that represents the current state of the device as a target for push notifications.
		LocalDevice		A [LocalDevice]{@link LocalDevice} object.
channels: Channels<RestChannel>			RSN1	A [Channels]{@link Channels} object.
request(String method, String path, Int version, Dict<String, String> params?, JsonObject | JsonArray body?, Dict<String, String> headers?) => io HttpPaginatedResponse			RSC19	Makes a REST request to a provided path. This is provided as a convenience for developers who wish to use REST API functionality that is either not documented or is not yet included in the public API, without having to directly handle features such as authentication, paging, fallback hosts, MsgPack and JSON support.
	method			The request method to use, such as GET, POST.
	path			The request path.
	version		RSC19f1	The version of the Ably REST API to use. See the REST API reference for information on versioning.
	params			The parameters to include in the URL query of the request. The parameters depend on the endpoint being queried. See the REST API reference for the available parameters of each endpoint.
	body			The JSON body of the request.
	headers			Additional HTTP headers to include in the request.
		HttpPaginatedResponse		An [HttpPaginatedResponse]{@link HttpPaginatedResponse} object returned by the HTTP request, containing an empty or JSON-encodable object.
stats(start: Time api-default epoch(), end: Time api-default now(), direction: .Backwards | Forwards api-default .Backwards, limit: int api-default 100, unit: .Minute | .Hour | .Day | .Month api-default .Minute => io PaginatedResult<Stats>			RSC6a	Queries the REST /stats API and retrieves your application's usage statistics. Returns a [PaginatedResult]{@link PaginatedResult} object, containing an array of [Stats]{@link Stats} objects. See the Stats docs.
	start		RSC6b1	The time from which stats are retrieved, specified as milliseconds since the Unix epoch.
	end		RSC6b1	The time until stats are retrieved, specified as milliseconds since the Unix epoch.
	direction		RSC6b2	The order for which stats are returned in. Valid values are backwards which orders stats from most recent to oldest, or forwards which orders stats from oldest to most recent. The default is backwards.
	limit		RSC6b3	An upper limit on the number of stats returned. The default is 100, and the maximum is 1000.
	unit		RSC6b4	minute, hour, day or month. Based on the unit selected, the given start or end times are rounded down to the start of the relevant interval depending on the unit granularity of the query.
		PaginatedResult		A [PaginatedResult]{@link PaginatedResult} object containing an array of [Stats]{@link Stats} objects.
time() => io Time			RSC16	Retrieves the time from the Ably service as milliseconds since the Unix epoch. Clients that do not have access to a sufficiently well maintained time source and wish to issue Ably [TokenRequests]{@link TokenRequest} with a more accurate timestamp should use the [queryTime]{@link ClientOptions#queryTime} property instead of this method.
		Time		The time as milliseconds since the Unix epoch.
batchPublish(BatchPublishSpec) => io BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>			RSC22	Publishes a [BatchPublishSpec]{@link BatchPublishSpec} object to one or more channels, up to a maximum of 100 channels.
	BatchPublishSpec			A [BatchPublishSpec]{@link BatchPublishSpec} object.
		BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>		A [BatchResult]{@link BatchResult} object containing information about the result of the batch publish for each requested channel.
batchPublish([BatchPublishSpec]) => io [BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>]			RSC22	Publishes one or more [BatchPublishSpec]{@link BatchPublishSpec} objects to one or more channels, up to a maximum of 100 channels.
	[BatchPublishSpec]			An array of [BatchPublishSpec]{@link BatchPublishSpec} objects.
		[BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>]		An array of [BatchResult]{@link BatchResult} objects containing information about the result of the batch publish for each requested channel for each provided [BatchPublishSpec]{@link BatchPublishSpec}. The array returned is in the same order as the provided [BatchPublishSpec]{@link BatchPublishSpec} array.
batchPresence([String]) => io BatchResult<BatchPresenceSuccessResult | BatchPresenceFailureResult>			RSC23	Retrieves the presence state for one or more channels, up to a maximum of 100 channels. Presence state includes the clientId of members and their current [PresenceAction]{@link PresenceAction}.
	[String]			An array of one or more channel names, up to a maximum of 100 channels.
		BatchResult<BatchPresenceSuccessResult | BatchPresenceFailureResult>		A [BatchResult]{@link BatchResult} object containing information about the result of the batch presence request for each requested channel.

class RealtimeClient

A client that extends the functionality of the [RestClient]{@link RestClient} and provides additional realtime-specific features.

Method / Property	Parameter	Returns	Spec	Description
constructor(keyOrTokenStr: String)			RSC1	Constructs a RealtimeClient object using an Ably API key or token string.
	keyOrTokenStr			The Ably API key or token string used to validate the client.
constructor(ClientOptions)			RSC1	Constructs a RealtimeClient object using an Ably [ClientOptions]{@link ClientOptions} object.
	ClientOptions			A [ClientOptions]{@link ClientOptions} object.
auth: Auth			RTC4	An [Auth]{@link Auth} object.
push: Push				A [Push]{@link Push} object.
device() => LocalDevice			RSH8	Retrieves a [LocalDevice]{@link LocalDevice} object that represents the current state of the device as a target for push notifications.
		LocalDevice		A [LocalDevice]{@link LocalDevice} object.
channels: Channels<RealtimeChannel>			RTC3, RTS1	A [Channels]{@link Channels} object.
clientId: String?			proxy for RSA7	A client ID, used for identifying this client when publishing messages or for presence purposes. The clientId can be any non-empty string, except it cannot contain a *. This option is primarily intended to be used in situations where the library is instantiated with a key. A clientId may also be implicit in a token used to instantiate the library; an error will be raised if a clientId specified here conflicts with the clientId implicit in the token.
connection: Connection			RTC2	A [Connection]{@link Connection} object.
request(String method, String path, Dict<String, String> params?, JsonObject | JsonArray body?, Dict<String, String> headers?) => io HttpPaginatedResponse			RTC9	Makes a REST request to a provided path. This is provided as a convenience for developers who wish to use REST API functionality that is either not documented or is not yet included in the public API, without having to directly handle features such as authentication, paging, fallback hosts, MsgPack and JSON support.
	method			The request method to use, such as GET, POST.
	path			The request path.
	params			The parameters to include in the URL query of the request. The parameters depend on the endpoint being queried. See the REST API reference for the available parameters of each endpoint.
	body			The JSON body of the request.
	headers			Additional HTTP headers to include in the request.
		HttpPaginatedResponse		An [HttpPaginatedResponse]{@link HttpPaginatedResponse} response object returned by the HTTP request, containing an empty or JSON-encodable object.
stats(start: Time api-default epoch(), end: Time api-default now(), direction: .Backwards | Forwards api-default .Backwards, limit: int api-default 100, unit: .Minute | .Hour | .Day | .Month api-default .Minute => io PaginatedResult<Stats>			Same as RestClient.stats, RTC5	Queries the REST /stats API and retrieves your application's usage statistics. Returns a [PaginatedResult]{@link PaginatedResult} object, containing an array of [Stats]{@link Stats} objects. See the Stats docs.
	start			The time from which stats are retrieved, specified as milliseconds since the Unix epoch.
	end			The time until stats are retrieved, specified as milliseconds since the Unix epoch.
	direction			The order for which stats are returned in. Valid values are backwards which orders stats from most recent to oldest, or forwards which orders stats from oldest to most recent. The default is backwards.
	limit			An upper limit on the number of stats returned. The default is 100, and the maximum is 1000.
	unit			minute, hour, day or month. Based on the unit selected, the given start or end times are rounded down to the start of the relevant interval depending on the unit granularity of the query.
		PaginatedResult		A [PaginatedResult]{@link PaginatedResult} object containing an array of [Stats]{@link Stats} objects.
close()			proxy for RTN12	Calls [connection.close()]{@link Connection#close} and causes the connection to close, entering the closing state. Once closed, the library will not attempt to re-establish the connection without an explicit call to [connect()]{@link Connection#connect}.
connect()			proxy for RTN11	Calls [connection.connect()]{@link Connection#connect} and causes the connection to open, entering the connecting state. Explicitly calling connect() is needed if the [autoConnect]{@link ClientOptions#autoConnect} property is disabled.
time() => io Time			RTC6a	Retrieves the time from the Ably service as milliseconds since the Unix epoch. Clients that do not have access to a sufficiently well maintained time source and wish to issue Ably [TokenRequests]{@link TokenRequest with a more accurate timestamp should use the [queryTime]{@link ClientOptions#queryTime} property instead of this method.
		Time		The time as milliseconds since the Unix epoch.
batchPublish(BatchPublishSpec) => io BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>			RSC22	Publishes a [BatchPublishSpec]{@link BatchPublishSpec} object to one or more channels, up to a maximum of 100 channels.
	BatchPublishSpec			A [BatchPublishSpec]{@link BatchPublishSpec} object.
		BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>		A [BatchResult]{@link BatchResult} object containing information about the result of the batch publish for each requested channel.
batchPublish([BatchPublishSpec]) => io [BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>]			RSC22	Publishes one or more [BatchPublishSpec]{@link BatchPublishSpec} object to one or more channels, up to a maximum of 100 channels.
	[BatchPublishSpec]			An array of [BatchPublishSpec]{@link BatchPublishSpec} objects.
		[BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>]		An array of [BatchResult]{@link BatchResult} objects containing information about the result of the batch publish for each requested channel for each provided [BatchPublishSpec]{@link BatchPublishSpec}. The array returned is in the same order as the provided [BatchPublishSpec]{@link BatchPublishSpec} array.
batchPresence([String]) => io BatchResult<BatchPresenceSuccessResult | BatchPresenceFailureResult>			RSC23	Retrieves the presence state for one or more channels, up to a maximum of 100 channels. Presence state includes the clientId of members and their current [PresenceAction]{@link PresenceAction}.
	[String]			An array of one or more channel names, up to a maximum of 100 channels.
		BatchResult<BatchPresenceSuccessResult | BatchPresenceFailureResult>		A [BatchResult]{@link BatchResult} object containing information about the result of the batch presence request for each requested channel.

class ClientOptions

Passes additional client-specific properties to the REST [constructor()]{@link RestClient#constructor} or the Realtime [constructor()]{@link RealtimeClient#constructor}.

Method / Property	Parameter	Returns	Spec	Description
embeds AuthOptions			TO3j	Embeds an [AuthOptions]{@link AuthOptions} object.
autoConnect: Bool default true			RTC1b, TO3e	When true, the client connects to Ably as soon as it is instantiated. You can set this to false and explicitly connect to Ably using the [connect()]{@link Connection#connect} method. The default is true.
clientId: String?			RSC17, RSA4, RSA15, TO3a	A client ID, used for identifying this client when publishing messages or for presence purposes. The clientId can be any non-empty string, except it cannot contain a *. This option is primarily intended to be used in situations where the library is instantiated with a key. Note that a clientId may also be implicit in a token used to instantiate the library. An error will be raised if a clientId specified here conflicts with the clientId implicit in the token.
defaultTokenParams: TokenParams?			TO3j11	When a [TokenParams]{@link TokenParams} object is provided, it overrides the client library defaults when issuing new Ably Tokens or Ably [TokenRequests]{@link TokenRequest}.
echoMessages: Bool default true			RTC1a, TO3h	If false, prevents messages originating from this connection being echoed back on the same connection. The default is true.
environment: String?			RSC15b, TO3k1	Enables a custom environment to be used with the Ably service.
logHandler:			platform specific - TO3c	Controls the log output of the library. This is a function to handle each line of log output.
logLevel:			platform specific - TO3b	Controls the verbosity of the logs output from the library. Levels include verbose, debug, info, warn and error.
logExceptionReportingUrl: String default "[library specific]"			TO3m (deprecated)	DEPRECATED: this property is deprecated and will be removed in a future version. Defaults to a string value for an Ably error reporting DSN (Data Source Name), which is typically a URL in the format https://[KEY]:[SECRET]@errors.ably.io/[ID]. When set to null, false or an empty string (depending on what is idiomatic for the platform), exception reporting is disabled.
port: Int default 80			TO3k4	Enables a non-default Ably port to be specified. For development environments only. The default value is 80.
queueMessages: Bool default true			RTP16b, TO3g	If false, this disables the default behavior whereby the library queues messages on a connection in the disconnected or connecting states. The default behavior enables applications to submit messages immediately upon instantiating the library without having to wait for the connection to be established. Applications may use this option to disable queueing if they wish to have application-level control over the queueing. The default is true.
restHost: String default "rest.ably.io"			RSC12, TO3k2	Enables a non-default Ably host to be specified. For development environments only. The default value is rest.ably.io.
realtimeHost: String default "realtime.ably.io"			RTC1d, TO3k3	Enables a non-default Ably host to be specified for realtime connections. For development environments only. The default value is realtime.ably.io.
fallbackHosts: String[] default nil			RSC15b, RSC15a, TO3k6	An array of fallback hosts to be used in the case of an error necessitating the use of an alternative host. If you have been provided a set of custom fallback hosts by Ably, please specify them here.
fallbackHostsUseDefault: Bool default false			TO3k7 (deprecated)	DEPRECATED: this property is deprecated and will be removed in a future version. Enables default fallback hosts to be used.
recover: String?			RTC1c, TO3i	Enables a connection to inherit the state of a previous connection that may have existed under a different instance of the Realtime library. This might typically be used by clients of the browser library to ensure connection state can be preserved when the user refreshes the page. A recovery key string can be explicitly provided, or alternatively if a callback function is provided, the client library will automatically persist the recovery key between page reloads and call the callback when the connection is recoverable. The callback is then responsible for confirming whether the connection should be recovered or not. See connection state recovery for further information.
tls: Bool default true			RSC18, TO3d	When false, the client will use an insecure connection. The default is true, meaning a TLS connection will be used to connect to Ably.
tlsPort: Int default 443			TO3k5	Enables a non-default Ably TLS port to be specified. For development environments only. The default value is 443.
useBinaryProtocol: Bool default true			TO3f	When true, the more efficient MsgPack binary encoding is used. When false, JSON text encoding is used. The default is true.
transportParams: [String: Stringifiable]?			RTC1f	A set of key-value pairs that can be used to pass in arbitrary connection parameters, such as heartbeatInterval or remainPresentFor.
addRequestIds: Bool default false			TO3p	When true, every REST request to Ably should include a random string in the request_id query string parameter. The random string should be a url-safe base64-encoding sequence of at least 9 bytes, obtained from a source of randomness. This request ID must remain the same if a request is retried to a fallback host. Any log messages associated with the request should include the request ID. If the request fails, the request ID must be included in the [ErrorInfo]{@link ErrorInfo} returned to the user. The default is false.
disconnectedRetryTimeout: Duration default 15s			TO3l1	When the connection enters the [DISCONNECTED]{@link ConnectionState#disconnected} state, after this delay, if the state is still [DISCONNECTED]{@link ConnectionState#disconnected}, the client library will attempt to reconnect automatically. The default is 15 seconds.
suspendedRetryTimeout: Duration default 30s			RTN14d, TO3l2	When the connection enters the [SUSPENDED]{@link ConnectionState#suspended} state, after this delay, if the state is still [SUSPENDED]{@link ConnectionState#suspended}, the client library attempts to reconnect automatically. The default is 30 seconds.
channelRetryTimeout: Duration default 15s			RTL13b, TO3l7	When a channel becomes [SUSPENDED]{@link ChannelState#suspended} following a server initiated [DETACHED]{@link ChannelState#detached}, after this delay, if the channel is still [SUSPENDED]{@link ChannelState#suspended} and the connection is in [CONNECTED]{@link ConnectionState#connected}, the client library will attempt to re-attach the channel automatically. The default is 15 seconds.
httpOpenTimeout: Duration default 4s			TO3l3	Timeout for opening a connection to Ably to initiate an HTTP request. The default is 4 seconds.
httpRequestTimeout: Duration default 10s			TO3l4	Timeout for a client performing a complete HTTP request to Ably, including the connection phase. The default is 10 seconds.
realtimeRequestTimeout: Duration default 10s			TO3l11	Timeout for the wait of acknowledgement for operations performed via a realtime connection, before the client library considers a request failed and triggers a failure condition. Operations include establishing a connection with Ably, or sending a HEARTBEAT, CONNECT, ATTACH, DETACH or CLOSE request. It is the equivalent of httpRequestTimeout but for realtime operations, rather than REST. The default is 10 seconds.
httpMaxRetryCount: Int default 3			TO3l5	The maximum number of fallback hosts to use as a fallback when an HTTP request to the primary host is unreachable or indicates that it is unserviceable. The default value is 3.
httpMaxRetryDuration: Duration default 15s			TO3l6	The maximum elapsed time in which fallback host retries for HTTP requests will be attempted. The default is 15 seconds.
maxMessageSize: Int default 65536			TO3l8	The maximum message size is an attribute of an Ably account which represents the largest permitted payload size of a single message or set of messages published in a single operation. Publish requests whose payload exceeds this limit are rejected by the server. maxMessageSize enables the client to enforce, or further restrict, the maximum size of a single message or set of messages published via REST. The default value is 65536 (64 KiB). In the case of a realtime connection, the server may indicate the associated maximum message size on connection establishment; this value takes precedence over the client's default maxMessageSize.
maxFrameSize: Int default 524288			TO3l8	The maximum size of a single POST body or WebSocket frame. This is mostly only relevant for a REST client request (for batch publishes), since publishes will hit the maxMessageSize limit before this. The default value is 524288 (512 KiB).
fallbackRetryTimeout: Duration default 600s			TO3l10	The maximum time before HTTP requests are retried against the default endpoint. The default is 600 seconds.
plugins: Dict<PluginType, Plugin>			TO3o	A map between a [PluginType]{@link PluginType} and a Plugin object.
idempotentRestPublishing: bool default true			RSL1k1, RTL6a1, TO3n	When true, enables idempotent publishing by assigning a unique message ID client-side, allowing the Ably servers to discard automatic publish retries following a failure such as a network fault. The default is true.
agents: [String: String?]?			RSC7d6 - interface only offered by some libraries	A set of additional entries for the Ably agent header. Each entry can be a key string or set of key-value pairs.

class AuthOptions

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

Method / Property	Parameter	Returns	Spec	Description
authCallback: ((TokenParams) -> io (String | TokenDetails | TokenRequest | JsonObject))?			RSA4a, RSA4, TO3j5, AO2b	Called when a new token is required. The role of the callback is to obtain a fresh token, one of: an Ably Token string (in plain text format); a signed [TokenRequest]{@link TokenRequest}; a [TokenDetails]{@link TokenDetails} (in JSON format); an Ably JWT. See the authentication documentation for details of the Ably [TokenRequest]{@link TokenRequest} format and associated API calls.
authHeaders: [String: Stringifiable]?			RSA8c3, TO3j8, AO2e	A set of key-value pair headers to be added to any request made to the authUrl. Useful when an application requires these to be added to validate the request or implement the response. If the authHeaders object contains an authorization key, then withCredentials is set on the XHR request.
authMethod: .GET | .POST default .GET			RSA8c, TO3j7, AO2d	The HTTP verb to use for any request made to the authUrl, either GET or POST. The default value is GET.
authParams: [String: Stringifiable]?			RSA8c3, RSA8c1, TO3j9, AO2f	A set of key-value pair params to be added to any request made to the authUrl. When the authMethod is GET, query params are added to the URL, whereas when authMethod is POST, the params are sent as URL encoded form data. Useful when an application requires these to be added to validate the request or implement the response.
authUrl: String?			RSA4a, RSA4, RSA8c, TO3j6, AO2c	A URL that the library may use to obtain a token string (in plain text format), or a signed [TokenRequest]{@link TokenRequest} or [TokenDetails]{@link TokenDetails} (in JSON format) from.
key: String?			RSA11, RSA14, TO3j1, AO2a	The full API key string, as obtained from the Ably dashboard. Use this option if you wish to use Basic authentication, or wish to be able to issue Ably Tokens without needing to defer to a separate entity to sign Ably [TokenRequests]{@link TokenRequest}. Read more about Basic authentication.
queryTime: Bool default false			RSA9d, TO3j10, AO2a	If true, the library queries the Ably servers for the current time when issuing [TokenRequests]{@link TokenRequest} instead of relying on a locally-available time of day. Knowing the time accurately is needed to create valid signed Ably [TokenRequests]{@link TokenRequest}, so this option is useful for library instances on auth servers where for some reason the server clock cannot be kept synchronized through normal means, such as an NTP daemon. The server is queried for the current time once per client library instance (which stores the offset from the local clock), so if using this option you should avoid instancing a new version of the library for each request. The default is false.
token: String? | TokenDetails? | TokenRequest?			RSA4a, RSA4, TO3j2	An authenticated token. This can either be a [TokenDetails]{@link TokenDetails} object, a [TokenRequest]{@link TokenRequest} object, or token string (obtained from the token property of a [TokenDetails]{@link TokenDetails} component of an Ably [TokenRequest]{@link TokenRequest} response, or a JSON Web Token satisfying the Ably requirements for JWTs). This option is mostly useful for testing: since tokens are short-lived, in production you almost always want to use an authentication method that enables the client library to renew the token automatically when the previous one expires, such as authUrl or authCallback. Read more about Token authentication.
tokenDetails: TokenDetails?			RSA4a, RSA4, TO3j3	An authenticated [TokenDetails]{@link TokenDetails} object (most commonly obtained from an Ably Token Request response). This option is mostly useful for testing: since tokens are short-lived, in production you almost always want to use an authentication method that enables the client library to renew the token automatically when the previous one expires, such as authUrl or authCallback. Use this option if you wish to use Token authentication. Read more about Token authentication.
useTokenAuth: Bool?			RSA4, RSA14, TO3j4	When true, forces token authentication to be used by the library. If a clientId is not specified in the [ClientOptions]{@link ClientOptions} or [TokenParams]{@link TokenParams}, then the Ably Token issued is anonymous.

class TokenParams

Defines the properties of an Ably Token.

Method / Property	Parameter	Returns	Spec	Description
capability: String api-default '{"*":["*"]}'			RSA9f, TK2b	The capabilities associated with this Ably Token. The capabilities value is a JSON-encoded representation of the resource paths and associated operations. Read more about capabilities in the capabilities docs.
clientId: String?			TK2c	A client ID, used for identifying this client when publishing messages or for presence purposes. The clientId can be any non-empty string, except it cannot contain a *. This option is primarily intended to be used in situations where the library is instantiated with a key. Note that a clientId may also be implicit in a token used to instantiate the library. An error is raised if a clientId specified here conflicts with the clientId implicit in the token. Find out more about identified clients.
nonce: String?			RSA9c, Tk2d	A cryptographically secure random string of at least 16 characters, used to ensure the [TokenRequest]{@link TokenRequest} cannot be reused.
timestamp: Time?			RSA9d, Tk2d	The timestamp of this request as milliseconds since the Unix epoch. Timestamps, in conjunction with the nonce, are used to prevent requests from being replayed. timestamp is a "one-time" value, and is valid in a request, but is not validly a member of any default token params such as ClientOptions.defaultTokenParams.
ttl: Duration api-default 60min			RSA9e, TK2a	Requested time to live for the token in milliseconds. The default is 60 minutes.

class Auth

Creates Ably [TokenRequest]{@link TokenRequest} objects and obtains Ably Tokens from Ably to subsequently issue to less trusted clients.

Method / Property	Parameter	Returns	Spec	Description
clientId: String?			RSA7, RSC17, RSA12	A client ID, used for identifying this client when publishing messages or for presence purposes. The clientId can be any non-empty string, except it cannot contain a *. This option is primarily intended to be used in situations where the library is instantiated with a key. Note that a clientId may also be implicit in a token used to instantiate the library. An error is raised if a clientId specified here conflicts with the clientId implicit in the token. Find out more about identified clients.
authorize(TokenParams?, AuthOptions?) => io TokenDetails			RSA10	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. Also stores any [TokenParams]{@link TokenParams} and [AuthOptions]{@link AuthOptions} passed in as the new defaults, to be used for all subsequent implicit or explicit token requests. Any [TokenParams]{@link TokenParams} and [AuthOptions]{@link AuthOptions} objects passed in entirely replace, as opposed to being merged with, the current client library saved values.
	TokenParams			A [TokenParams]{@link TokenParams} object.
	AuthOptions			An [AuthOptions]{@link AuthOptions} object.
		TokenDetails		A [TokenDetails]{@link TokenDetails} object.
createTokenRequest(TokenParams?, AuthOptions?) => io TokenRequest			RSA9	Creates and signs an Ably [TokenRequest]{@link TokenRequest} based on the specified (or if none specified, the client library stored) [TokenParams]{@link TokenParams} and [AuthOptions]{@link AuthOptions}. Note this can only be used when the API key value is available locally. Otherwise, the Ably [TokenRequest]{@link TokenRequest} must be obtained from the key owner. Use this to generate an Ably [TokenRequest]{@link TokenRequest} in order to implement an Ably Token request callback for use by other clients. Both [TokenParams]{@link TokenParams} and [AuthOptions]{@link AuthOptions} are optional. When omitted or null, the default token parameters and authentication options for the client library are used, as specified in the [ClientOptions]{@link ClientOptions} when the client library was instantiated, or later updated with an explicit authorize request. Values passed in are used instead of, rather than being merged with, the default values. To understand why an Ably [TokenRequest]{@link TokenRequest} may be issued to clients in favor of a token, see Token Authentication explained.
	TokenParams			A [TokenParams]{@link TokenParams} object.
	AuthOptions			An [AuthOptions]{@link AuthOptions} object.
		TokenRequest		A [TokenRequest]{@link TokenRequest} object.
requestToken(TokenParams?, AuthOptions?) => io TokenDetails			RSA8e	Calls the requestToken REST API endpoint to obtain an Ably Token according to the specified [TokenParams]{@link TokenParams} and [AuthOptions]{@link AuthOptions}. Both [TokenParams]{@link TokenParams} and [AuthOptions]{@link AuthOptions} are optional. When omitted or null, the default token parameters and authentication options for the client library are used, as specified in the [ClientOptions]{@link ClientOptions} when the client library was instantiated, or later updated with an explicit authorize request. Values passed in are used instead of, rather than being merged with, the default values. To understand why an Ably [TokenRequest]{@link TokenRequest} may be issued to clients in favor of a token, see Token Authentication explained.
	TokenParams			A [TokenParams]{@link TokenParams} object.
	AuthOptions			An [AuthOptions]{@link AuthOptions} object.
		TokenDetails		A [TokenDetails]{@link TokenDetails} object.
TokenDetails: TokenDetails?			RSA16	A [TokenDetails]{@link TokenDetails} object.
revokeTokens([TokenRevocationTargetSpecifier], issuedBefore number?, allowReauthMargin boolean?) => io BatchResult<TokenRevocationSuccessResult | TokenRevocationFailureResult>			RSA17	Revokes the tokens specified by the provided array of [TokenRevocationTargetSpecifier]{@link TokenRevocationTargetSpecifier}s. Only tokens issued by an API key that had revocable tokens enabled before the token was issued can be revoked. See the token revocation docs for more information.
	[TokenRevocationTargetSpecifier]			An array of [TokenRevocationTargetSpecifier]{@link TokenRevocationTargetSpecifier} objects.
	issuedBefore			A Unix timestamp in milliseconds where only tokens issued before this time are revoked. The default is the current time. Requests with an issuedBefore in the future, or more than an hour in the past, will be rejected.
	allowReauthMargin			If true, permits a token renewal cycle to take place without needing established connections to be dropped, by postponing enforcement to 30 seconds in the future, and sending any existing connections a hint to obtain (and upgrade the connection to use) a new token. The default is false, meaning that the effect is near-immediate.
		BatchResult<TokenRevocationSuccessResult | TokenRevocationFailureResult>		A [BatchResult]{@link BatchResult} containing information about the result of the token revocation request for each provided [TokenRevocationTargetSpecifier]{@link TokenRevocationTargetSpecifier}.

class TokenDetails

Contains an Ably Token and its associated metadata.

Method / Property	Parameter	Returns	Spec	Description
+fromJson(String | JsonObject) -> TokenDetails			TD7	A static factory method to create a TokenDetails object from a deserialized TokenDetails-like object or a JSON stringified TokenDetails object. This method is provided to minimize bugs as a result of differing types by platform for fields such as timestamp or ttl. For example, in Ruby ttl in the TokenDetails object is exposed in seconds as that is idiomatic for the language, yet when serialized to JSON using to_json it is automatically converted to the Ably standard which is milliseconds. By using the fromJson() method when constructing a TokenDetails object, Ably ensures that all fields are consistently serialized and deserialized across platforms.
	String | JsonObject			A deserialized TokenDetails-like object or a JSON stringified TokenDetails object.
		TokenDetails		An Ably authentication token.
capability: String			TD5	The capabilities associated with this Ably Token. The capabilities value is a JSON-encoded representation of the resource paths and associated operations. Read more about capabilities in the capabilities docs.
clientId: String?			TD6	The client ID, if any, bound to this Ably Token. If a client ID is included, then the Ably Token authenticates its bearer as that client ID, and the Ably Token may only be used to perform operations on behalf of that client ID. The client is then considered to be an identified client.
expires: Time			TD3	The timestamp at which this token expires as milliseconds since the Unix epoch.
issued: Time			TD4	The timestamp at which this token was issued as milliseconds since the Unix epoch.
token: String			TD2	The Ably Token itself. A typical Ably Token string appears with the form xVLyHw.A-pwh7wicf3afTfgiw4k2Ku33kcnSA7z6y8FjuYpe3QaNRTEo4.

class TokenRequest

Contains the properties of a request for a token to Ably. Tokens are generated using [requestToken]{@link Auth#requestToken}.

Method / Property	Parameter	Returns	Spec	Description
+fromJson(String | JsonObject) -> TokenRequest			TE6	A static factory method to create a TokenRequest object from a deserialized TokenRequest-like object or a JSON stringified TokenRequest object. This method is provided to minimize bugs as a result of differing types by platform for fields such as timestamp or ttl. For example, in Ruby ttl in the TokenRequest object is exposed in seconds as that is idiomatic for the language, yet when serialized to JSON using to_json it is automatically converted to the Ably standard which is milliseconds. By using the fromJson() method when constructing a TokenRequest object, Ably ensures that all fields are consistently serialized and deserialized across platforms.
	String | JsonObject			A deserialized TokenRequest-like object or a JSON stringified TokenRequest object to create a TokenRequest.
		TokenRequest		An Ably token request object.
capability: String			TE3	Capability of the requested Ably Token. If the Ably TokenRequest is successful, the capability of the returned Ably Token will be the intersection of this capability with the capability of the issuing key. The capabilities value is a JSON-encoded representation of the resource paths and associated operations. Read more about capabilities in the capabilities docs.
clientId: String?			TE2	The client ID to associate with the requested Ably Token. When provided, the Ably Token may only be used to perform operations on behalf of that client ID.
keyName: String			TE2	The name of the key against which this request is made. The key name is public, whereas the key secret is private.
mac: String			TE2	The Message Authentication Code for this request.
nonce: String			TE2	A cryptographically secure random string of at least 16 characters, used to ensure the TokenRequest cannot be reused.
timestamp: Time?			TE5	The timestamp of this request as milliseconds since the Unix epoch.
ttl: Duration? api-default 60min			TE4	Requested time to live for the Ably Token in milliseconds. If the Ably TokenRequest is successful, the TTL of the returned Ably Token is less than or equal to this value, depending on application settings and the attributes of the issuing key. The default is 60 minutes.

class Channels<ChannelType>

Creates and destroys [RestChannel]{@link RestChannel} and [RealtimeChannel]{@link RealtimeChannel} objects.

Method / Property	Parameter	Returns	Spec	Description
exists(String) -> Bool			RSN2, RTS2	Checks if the channel by the given name exists locally.
	String			The channel name.
		Bool		true if the channel exists, otherwise false.
get(String) -> ChannelType			RSN3a, RTS3a	Creates a new [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object, or returns the existing channel object.
	String			The channel name.
		ChannelType		A [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object.
get(String, ChannelOptions) -> ChannelType			RSN3c, RTS3c	Creates a new [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object, with the specified [ChannelOptions]{@link ChannelOptions}, or returns the existing channel object.
	String			The channel name.
	ChannelOptions			A [ChannelOptions]{@link ChannelOptions} object.
		ChannelType		A [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object.
getDerived(String, DeriveOptions) -> ChannelType			RTS5, RTS5a, RTS5a1	Creates a new derived [RealtimeChannel]{@link RealtimeChannel} object, with the provided [DeriveOptions]{@link DeriveOptions}, or returns the existing derived channel object.
	String			The channel name.
	DeriveOptions			A [DeriveOptions]{@link DeriveOptions} object.
		ChannelType		A [RealtimeChannel]{@link RealtimeChannel} object.
getDerived(String, DeriveOptions, ChannelOptions) -> ChannelType			RTS5, RTS5a, RTS5a2	Creates a new derived [RealtimeChannel]{@link RealtimeChannel} object, with the provided [DeriveOptions]{@link DeriveOptions} and [ChannelOptions]{@link ChannelOptions}, or returns the existing derived channel object.
	String			The channel name.
	DeriveOptions			A [DeriveOptions]{@link DeriveOptions} object.
	ChannelOptions			A [ChannelOptions]{@link ChannelOptions} object.
		ChannelType		A [RealtimeChannel]{@link RealtimeChannel} object.
iterate() -> Iterator<ChannelType>			RSN2, RTS2	Iterates through the existing channels.
		ChannelType		Each iteration returns a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object.
release(String)			RSN4, RTS4	Releases a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object, deleting it, and enabling it to be garbage collected. It also removes any listeners associated with the channel. To release a channel, the [ChannelState]{@link ChannelState} must be INITIALIZED, DETACHED, or FAILED.
	String			The channel name.

class RestChannel

Enables messages to be published and historic messages to be retrieved for a channel.

Method / Property	Parameter	Returns	Spec	Description
name: String?				The channel name.
presence: RestPresence			RSL3	A [RestPresence]{@link RestPresence} object.
history(start: Time, end: Time api-default now(), direction: .Backwards | .Forwards api-default .Backwards, limit: int api-default 100) => io PaginatedResult<Message>			RSL2a	Retrieves a [PaginatedResult]{@link PaginatedResult} object, containing an array of historical [Message]{@link Message} objects for the channel. If the channel is configured to persist messages, then messages can be retrieved from history for up to 72 hours in the past. If not, messages can only be retrieved from history for up to two minutes in the past.
	start		RSL2b1	The time from which messages are retrieved, specified as milliseconds since the Unix epoch.
	end		RSL2b1	The time until messages are retrieved, specified as milliseconds since the Unix epoch.
	direction		RSL2b2	The order for which messages are returned in. Valid values are backwards which orders messages from most recent to oldest, or forwards which orders messages from oldest to most recent. The default is backwards.
	limit		RSL2b3	An upper limit on the number of messages returned. The default is 100, and the maximum is 1000.
		PaginatedResult<Message>		A [PaginatedResult]{@link PaginatedResult} object containing an array of [Message]{@link Message} objects.
status() => ChannelDetails			RSL8	Retrieves a [ChannelDetails]{@link ChannelDetails} object for the channel, which includes status and occupancy metrics.
		ChannelDetails		A [ChannelDetails]{@link ChannelDetails} object.
publish(Message, params?: Dict<String, Stringifiable>) => io			RSL1	Publishes a message to the channel. A callback may optionally be passed in to this call to be notified of success or failure of the operation.
	Message			A [Message]{@link Message} object.
	params			Optional parameters, such as quickAck sent as part of the query string.
publish([Message], params?: Dict<String, Stringifiable>			RSL1	Publishes an array of messages to the channel. A callback may optionally be passed in to this call to be notified of success or failure of the operation.
	[Message]			An array of [Message]{@link Message} objects.
	params			Optional parameters, such as quickAck sent as part of the query string.
publish(name: String?, data: Data?) => io			RSL1	Publishes a single message to the channel with the given event name and payload. A callback may optionally be passed in to this call to be notified of success or failure of the operation.
	name			The name of the message.
	data			The payload of the message.
setOptions(options: ChannelOptions) => io			RSL7	Sets the [ChannelOptions]{@link ChannelOptions} for the channel.
	options			A [ChannelOptions]{@link ChannelOptions} object.
push: PushChannel			RSH4	A [PushChannel]{@link PushChannel} object.

class RealtimeChannel

Enables messages to be published and subscribed to. Also enables historic messages to be retrieved and provides access to the [RealtimePresence]{@link RealtimePresence} object of a channel.

Method / Property	Parameter	Returns	Spec	Description
embeds EventEmitter<ChannelEvent, ChannelStateChange?>			RTL2a, RTL2d, RTL2e	RealtimeChannel implements [EventEmitter]{@link EventEmitter} and emits [ChannelEvent]{@link ChannelEvent} events, where a ChannelEvent is either a [ChannelState]{@link ChannelState} or an [UPDATE]{@link ChannelEvent#UPDATE}.
name: String?				The channel name.
errorReason: ErrorInfo?			RTL4e	An [ErrorInfo]{@link ErrorInfo} object describing the last error which occurred on the channel, if any.
state: ChannelState			RTL2b	The current [ChannelState]{@link ChannelState} of the channel.
whenState(ChannelState, (ChannelStateChange?) ->)			RTL25	If the channel is already in the given state, calls the listener immediately with a null argument. Else, calls [once()]{@link EventEmitter#once} to register the listener to be called the next time the channel transitions to the given state.
	ChannelState			The channel state to wait for.
	(ChannelStateChange?) ->			The event listener.
presence: RealtimePresence			RTL9	A [RealtimePresence]{@link RealtimePresence} object.
properties: ChannelProperties			CP1, RTL15	A [ChannelProperties]{@link ChannelProperties} object.
push: PushChannel				A [PushChannel]{@link PushChannel} object.
modes: readonly [ChannelMode]			RTL4m	An array of [ChannelMode]{@link ChannelMode} objects.
params: readonly Dict<String, String>			RTL4k1	Optional channel parameters that configure the behavior of the channel.
attach() => io			RTL4d	Attach to this channel ensuring the channel is created in the Ably system and all messages published on the channel are received by any channel listeners registered using [subscribe()]{@link RealtimeChannel#subscribe}. Any resulting channel state change will be emitted to any listeners registered using the [on()]{@link EventEmitter#on} or [once()]{@link EventEmitter#once} methods. A callback may optionally be passed in to this call to be notified of success or failure of the operation. As a convenience, attach() is called implicitly if [subscribe()]{@link RealtimeChannel#subscribe} is called on the channel or [subscribe()]{@link RealtimePresence#subscribe} is called on the [RealtimePresence]{@link RealtimePresence} object for this channel, unless you’ve set the [attachOnSubscribe]{@link ChannelOptions#attachOnSubscribe} channel option to false. It is also called implicitly if [enter()]{@link RealtimePresence#enter} is called on the [RealtimePresence]{@link RealtimePresence} object for this channel.
detach() => io			RTL5e	Detach from this channel. Any resulting channel state change is emitted to any listeners registered using the [on()]{@link EventEmitter#on} or [once()]{@link EventEmitter#once} methods. A callback may optionally be passed in to this call to be notified of success or failure of the operation. Once all clients globally have detached from the channel, the channel will be released in the Ably service within two minutes.
history(start: Time, end: Time api-default now(), direction: .Backwards | .Forwards api-default .Backwards, limit: int api-default 100, untilAttach: Bool default false) => io PaginatedResult<Message>			RSL2a	Retrieves a [PaginatedResult]{@link PaginatedResult} object, containing an array of historical [Message]{@link Message} objects for the channel. If the channel is configured to persist messages, then messages can be retrieved from history for up to 72 hours in the past. If not, messages can only be retrieved from history for up to two minutes in the past.
	start		RTL10a	The time from which messages are retrieved, specified as milliseconds since the Unix epoch.
	end		RTL10a	The time until messages are retrieved, specified as milliseconds since the Unix epoch.
	direction		RTL10a	The order for which messages are returned in. Valid values are backwards which orders messages from most recent to oldest, or forwards which orders messages from oldest to most recent. The default is backwards.
	limit		RTL10a	An upper limit on the number of messages returned. The default is 100, and the maximum is 1000.
	untilAttach		RTL10b	When true, ensures message history is up until the point of the channel being attached. See continuous history for more info. Requires the direction to be backwards. If the channel is not attached, or if direction is set to forwards, this option results in an error.
		PaginatedResult<Message>		A [PaginatedResult]{@link PaginatedResult} object containing an array of [Message]{@link Message} objects.
publish(Message) => io			RTL6i	Publish a message to the channel. A callback may optionally be passed in to this call to be notified of success or failure of the operation. When publish is called with this client library, it won't attempt to implicitly attach to the channel.
	Message			A [Message]{@link Message} object.
publish([Message]) => io			RTL6i	Publishes an array of messages to the channel. A callback may optionally be passed in to this call to be notified of success or failure of the operation. When publish is called with this client library, it won't attempt to implicitly attach to the channel.
	[Message]			An array of [Message]{@link Message} objects.
publish(name: String?, data: Data?) => io			RTL6i	Publishes a single message to the channel with the given event name and payload. A callback may optionally be passed in to this call to be notified of success or failure of the operation. When publish is called with this client library, it won't attempt to implicitly attach to the channel, so long as transient publishing is available in the library. Otherwise, the client will implicitly attach.
	name			The event name.
	data			The message payload.
subscribe((Message) ->) => io			RTL7a	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. A callback may optionally be passed in to this call to be notified of success or failure of the channel [attach()]{@link RealtimeChannel#attach} operation. It will not be called if the [attachOnSubscribe]{@link ChannelOptions#attachOnSubscribe} channel option is set to false.
	(Message)			An event listener function.
subscribe(String, (Message) ->) => io			RTL7b	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. A callback may optionally be passed in to this call to be notified of success or failure of the channel [attach()]{@link RealtimeChannel#attach} operation. It will not be called if the [attachOnSubscribe]{@link ChannelOptions#attachOnSubscribe} channel option is set to false.
	String			The event name.
	(Message)			An event listener function.
subscribe([String], (Message) ->) => io			RTL7a	Registers a listener for messages on this channel for multiple event name values. A callback may optionally be passed in to this call to be notified of success or failure of the channel [attach()]{@link RealtimeChannel#attach} operation. It will not be called if the [attachOnSubscribe]{@link ChannelOptions#attachOnSubscribe} channel option is set to false.
	[String]			An array of event names.
	(Message)			An event listener function.
subscribe(MessageFilterObject, (Message) ->)			RTL22	Registers a listener for messages on this channel that match the supplied filter.
	MessageFilterObject			A [MessageFilterObject]{@link MessageFilterObject}.
	(Message)			An event listener function.
unsubscribe(String, (Message) ->)			RTL8a	Deregisters the given listener for the specified event name. This removes an earlier event-specific subscription.
	String			The event name.
	(Message)			An event listener function.
unsubscribe((Message) ->)			RTL8a	Deregisters the given listener (for any/all event names). This removes an earlier subscription.
	(Message)			An event listener function.
unsubscribe([String], (Message) ->)			RTL8a	Deregisters the given listener from all event names in the array.
	[String]			An array of event names.
	(Message)			An event listener function.
unsubscribe(String)			RTL8a	Deregisters all listeners for the given event name.
	String			The event name.
unsubscribe([String])			RTL8a	Deregisters all listeners for all event names in the array.
	[String]			An array of event names.
unsubscribe()			RTL8a, RTE5	Deregisters all listeners to messages on this channel. This removes all earlier subscriptions.
unsubscribe(MessageFilterObject, (Message) ->)			RTL22	Deregisters all listeners to messages on this channel that match the supplied filter.
	MessageFilterObject			A [MessageFilterObject]{@link MessageFilterObject}.
	(Message)			An event listener function.
setOptions(options: ChannelOptions) => io			RTL16	Sets the [ChannelOptions]{@link ChannelOptions} for the channel. An optional callback may be provided to notify of the success or failure of the operation.
	options			A [ChannelOptions]{@link ChannelOptions} object.

class MessageFilterObject

Contains properties to filter messages with when calling [subscribe()]{@link RealtimeChannel#subscribe}.

Method / Property	Parameter	Returns	Spec	Description
isRef: bool			RTL22b	Filters messages based on whether they contain an extras.ref.
refTimeserial: string			RTL22a	Filters messages by a specific extras.ref.timeserial value.
refType: string			RTL22a	Filters messages by a specific extras.ref.type value.
name: string			RTL22a	Filters messages by a specific message name.
clientId: string			RTL22a	Filters messages by a specific message clientId.

class ChannelProperties

Describes the properties of the channel state.

Method / Property	Parameter	Returns	Spec	Description
attachSerial: String			CP2a	Starts unset when a channel is instantiated, then updated with the channelSerial from each [ATTACHED]{@link ChannelState#ATTACHED} event that matches the channel. Used as the value for [untilAttach]{@link RealtimeChannel#history}.

class PushChannel

Enables devices to subscribe to push notifications for a channel.

Method / Property	Parameter	Returns	Spec	Description
subscribeDevice() => io			RSH7a	Subscribes the device to push notifications for the channel.
subscribeClient() => io			RSH7b	Subscribes all devices associated with the current device's clientId to push notifications for the channel.
unsubscribeDevice() => io			RSH7c	Unsubscribes the device from receiving push notifications for the channel.
unsubscribeClient() => io			RSH7d	Unsubscribes all devices associated with the current device's clientId from receiving push notifications for the channel.
listSubscriptions(params?: Dict<String, String>) => io PaginatedResult<PushChannelSubscription>			RSH7e	Retrieves all push subscriptions for the channel. Subscriptions can be filtered using a params object. Returns a [PaginatedResult]{@link PaginatedResult} object containing an array of [PushChannelSubscription]{@link PushChannelSubscription} objects.
	params			An object containing key-value pairs to filter subscriptions by. Can contain clientId, deviceId or a combination of both if concatFilters is set to true, and a limit on the number of subscriptions returned, up to 1,000.
		PaginatedResult<PushChannelSubscription>		A [PaginatedResult]{@link PaginatedResult} object containing an array of [PushChannelSubscription]{@link PushChannelSubscription} objects.

enum ChannelState

Describes the possible states of a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object.

Enum	Spec	Description
INITIALIZED		The channel has been initialized but no attach has yet been attempted.
ATTACHING		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.
ATTACHED		The attach has succeeded. In the ATTACHED state a client may publish and subscribe to messages, or be present on the channel.
DETACHING		A detach has been initiated on an ATTACHED channel by sending a request to Ably. This is a transient state, followed either by a transition to DETACHED or FAILED.
DETACHED		The channel, having previously been ATTACHED, has been detached by the user.
SUSPENDED		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.
FAILED		An indefinite failure condition. This state is entered if a channel error has been received from the Ably service, such as an attempt to attach without the necessary access rights.

enum ChannelEvent

Describes the events emitted by a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object. An event is either an UPDATE or a [ChannelState]{@link ChannelState}.

Enum	Spec	Description
embeds ChannelState		The event contains a [ChannelState]{@link ChannelState}.
UPDATE	RTL2g	An event for changes to channel conditions that do not result in a change in [ChannelState]{@link ChannelState}.

enum ChannelMode

Describes the possible flags used to configure client capabilities, using [ChannelOptions]{@link ChannelOptions}.

Enum	Spec	Description
PRESENCE		The client can enter the presence set.
PUBLISH		The client can publish messages.
SUBSCRIBE		The client can subscribe to messages.
PRESENCE_SUBSCRIBE		The client can receive presence messages.

class ChannelStateChange

Contains state change information emitted by [RestChannel]{@link RestChannel} and [RealtimeChannel]{@link RealtimeChannel} objects.

Method / Property	Parameter	Returns	Spec	Description
current: ChannelState			RTL2a, RTL2b	The new current [ChannelState]{@link ChannelState}.
event: ChannelEvent			TH5	The event that triggered this [ChannelState]{@link ChannelState} change.
previous: ChannelState			RTL2a, RTL2b	The previous state. For the [UPDATE]{@link ChannelEvent#UPDATE} event, this is equal to the current [ChannelState]{@link ChannelState}.
reason: ErrorInfo?			RTL2e, TH3	An [ErrorInfo]{@link ErrorInfo} object containing any information relating to the transition.
resumed: Boolean			RTL2f, TH4	Indicates whether message continuity on this channel is preserved, see Nonfatal channel errors for more info.

class ChannelOptions

Passes additional properties to a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object, such as encryption, [ChannelMode]{@link ChannelMode} and channel parameters.

Method / Property	Parameter	Returns	Spec	Description
+withCipherKey(key: Binary | String)? -> ChannelOptions			TB3	Constructor withCipherKey takes a key as a argument.
	key			A private key used to encrypt and decrypt payloads.
		ChannelOptions		A ChannelOptions object.
cipher?: (CipherParams | CipherParamOptions)			RSL5a, TB2b	Requests encryption for this channel when not null, and specifies encryption-related parameters (such as algorithm, chaining mode, key length and key). See an example.
params?: Dict<String, String>			TB2c	Channel Parameters that configure the behavior of the channel.
modes?: [ChannelMode]			TB2d	An array of [ChannelMode]{@link ChannelMode} objects.
attachOnSubscribe: Boolean			TB4	A boolean which determines whether calling [subscribe()]{@link RealtimeChannel#subscribe} on a channel or presence object should trigger an implicit attach (for realtime client libraries only). Defaults to true.

class DeriveOptions

Passes properties to a [RealtimeChannel]{@link RealtimeChannel} object, such as a filter, to create a derived channel.

Method / Property	Parameter	Returns	Spec	Description
filter: String			RTS5a	A filter expression written in JMESPath, used to filter messages received by the derived channel.

class ChannelDetails

Contains the details of a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object such as its ID and [ChannelStatus]{@link ChannelStatus}.

Method / Property	Parameter	Returns	Spec	Description
channelId: String			CHD2a	The identifier of the channel.
status: ChannelStatus			CHD2b	A [ChannelStatus]{@link ChannelStatus} object.

class ChannelStatus

Contains the status of a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object such as whether it is active and its [ChannelOccupancy]{@link ChannelOccupancy}.

Method / Property	Parameter	Returns	Spec	Description
isActive: Boolean			CHS2a	If true, the channel is active, otherwise inactive.
occupancy: ChannelOccupancy			CHS2b	A [ChannelOccupancy]{@link ChannelOccupancy} object.

class ChannelOccupancy

Contains the metrics of a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object.

Method / Property	Parameter	Returns	Spec	Description
metrics: ChannelMetrics			CHO2a	A [ChannelMetrics]{@link ChannelMetrics} object.

class ChannelMetrics

Contains the metrics associated with a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel}, such as the number of publishers, subscribers and connections it has.

Method / Property	Parameter	Returns	Spec	Description
connections: Int			CHM2a	The number of realtime connections attached to the channel.
presenceConnections: Int			CHM2b	The number of realtime connections attached to the channel with permission to enter the presence set, regardless of whether or not they have entered it. This requires the presence capability and for a client to not have specified a [ChannelMode]{@link ChannelMode} flag that excludes [PRESENCE]{@link ChannelMode#PRESENCE}.
presenceMembers: Int			CHM2c	The number of members in the presence set of the channel.
presenceSubscribers: Int			CHM2d	The number of realtime attachments receiving presence messages on the channel. This requires the subscribe capability and for a client to not have specified a [ChannelMode]{@link ChannelMode} flag that excludes [PRESENCE_SUBSCRIBE]{@link ChannelMode#PRESENCE_SUBSCRIBE}.
publishers: Int			CHM2e	The number of realtime attachments permitted to publish messages to the channel. This requires the publish capability and for a client to not have specified a [ChannelMode]{@link ChannelMode} flag that excludes [PUBLISH]{@link ChannelMode#PUBLISH}.
subscribers: Int			CHM2f	The number of realtime attachments receiving messages on the channel. This requires the subscribe capability and for a client to not have specified a [ChannelMode]{@link ChannelMode} flag that excludes [SUBSCRIBE]{@link ChannelMode#SUBSCRIBE}.

class CipherParams

Sets the properties to configure encryption for a [RestChannel]{@link RestChannel} or [RealtimeChannel]{@link RealtimeChannel} object.

Method / Property	Parameter	Spec	Description
algorithm: String default "AES"		TZ2a	The algorithm to use for encryption. Only AES is supported and is the default value.
key: Binary		TZ2d	The private key used to encrypt and decrypt payloads.
keyLength: Int		TZ2b	The length of the key in bits; for example 128 or 256.
mode: String default "CBC"		TZ2c	The cipher mode. Only CBC is supported and is the default value.

class CipherParamOptions

Contains the properties used to generate a [CipherParams]{@link CipherParams} object.

Method / Property	Parameter	Returns	Spec	Description
algorithm?: String			CO2a	The algorithm to use for encryption. Only AES is supported.
key: Binary | String			CO2b	The private key used to encrypt and decrypt payloads.
keyLength?: Int			CO2c	The length of the key in bits; for example 128 or 256.
mode?: String			CO2d	The cipher mode. Only CBC is supported.

class Crypto

Contains the properties required to configure the encryption of [Message]{@link Message} payloads.

Method / Property	Parameter	Returns	Spec	Description
+getDefaultParams(CipherParamOptions) -> CipherParams			RSE1	Returns a [CipherParams]{@link CipherParams} object, using the default values for any fields not supplied by the [CipherParamOptions]{@link CipherParamOptions} object.
	CipherParamOptions		RSE1b	A [CipherParamOptions]{@link CipherParamOptions} object.
		CipherParams	RSE1a	A [CipherParams]{@link CipherParams} object, using the default values for any fields not supplied.
+generateRandomKey(keyLength: Int?) => io Binary			RSE2	Generates a random key to be used in the encryption of the channel. If the language cryptographic randomness primitives are blocking or async, a callback is used. The callback returns a generated binary key.
	keyLength		RSE2a	The length of the key, in bits, to be generated. If not specified, this is equal to the default keyLength of the default algorithm: for AES this is 256 bits.
		Binary	RSE2b	The key as a binary, for example, a byte array.

class RestPresence

Enables the retrieval of the current and historic presence set for a channel.

Method / Property	Parameter	Returns	Spec	Description
get(limit: int api-default 100, clientId: String?, connectionId: String?) => io PaginatedResult<PresenceMessage>			RSPa	Retrieves the current members present on the channel and the metadata for each member, such as their [PresenceAction]{@link PresenceAction} and ID. Returns a [PaginatedResult]{@link PaginatedResult} object, containing an array of [PresenceMessage]{@link PresenceMessage} objects.
	limit		RSP3a	An upper limit on the number of messages returned. The default is 100, and the maximum is 1000.
	clientId		RSP3a2	Filters the list of returned presence members by a specific client using its ID.
	connectionId		RSP3a3	Filters the list of returned presence members by a specific connection using its ID.
		PaginatedResult<PresenceMessage>		A [PaginatedResult]{@link PaginatedResult} object containing an array of [PresenceMessage]{@link PresenceMessage} objects.
history(start: Time, end: Time api-default now(), direction: .Backwards | .Forwards api-default .Backwards, limit: int api-default 100) => io PaginatedResult<PresenceMessage>			RSP4a	Retrieves a [PaginatedResult]{@link PaginatedResult} object, containing an array of historical [PresenceMessage]{@link PresenceMessage} objects for the channel. If the channel is configured to persist messages, then presence messages can be retrieved from history for up to 72 hours in the past. If not, presence messages can only be retrieved from history for up to two minutes in the past.
	start		RSP4b1	The time from which messages are retrieved, specified as milliseconds since the Unix epoch.
	end		RSP4b1	The time until messages are retrieved, specified as milliseconds since the Unix epoch.
	direction		RSP4b2	The order for which messages are returned in. Valid values are backwards which orders messages from most recent to oldest, or forwards which orders messages from oldest to most recent. The default is backwards.
	limit		RSP4b3	An upper limit on the number of messages returned. The default is 100, and the maximum is 1000.
		PaginatedResult<PresenceMessage>		A [PaginatedResult]{@link PaginatedResult} object containing an array of [PresenceMessage]{@link PresenceMessage} objects.

class RealtimePresence

Enables the presence set to be entered and subscribed to, and the historic presence set to be retrieved for a channel.

Method / Property	Parameter	Returns	Spec	Description
syncComplete: Bool			RTP13	Indicates whether the presence set synchronization between Ably and the clients on the channel has been completed. Set to true when the sync is complete.
get(waitForSync: Bool default true, clientId: String?, connectionId: String?) => io [PresenceMessage]			RTP11	Retrieves the current members present on the channel and the metadata for each member, such as their [PresenceAction]{@link PresenceAction} and ID. Returns an array of [PresenceMessage]{@link PresenceMessage} objects.
	waitForSync		RTP11c1	Sets whether to wait for a full presence set synchronization between Ably and the clients on the channel to complete before returning the results. Synchronization begins as soon as the channel is [ATTACHED]{@link ChannelState#ATTACHED}. When set to true the results will be returned as soon as the sync is complete. When set to false the current list of members will be returned without the sync completing. The default is true.
	clientId		RTP11c2	Filters the array of returned presence members by a specific client using its ID.
	connectionId		RTP11c3	Filters the array of returned presence members by a specific connection using its ID.
		[PresenceMessage]		An array of [PresenceMessage]{@link PresenceMessage} objects.
history(start: Time, end: Time, direction: .Backwards | .Forwards api-default .Backwards, limit: int api-default 100) => io PaginatedResult<PresenceMessage>			RTP12c	Retrieves a [PaginatedResult]{@link PaginatedResult} object, containing an array of historical [PresenceMessage]{@link PresenceMessage} objects for the channel. If the channel is configured to persist messages, then presence messages can be retrieved from history for up to 72 hours in the past. If not, presence messages can only be retrieved from history for up to two minutes in the past.
	start		RTP12a	The time from which messages are retrieved, specified as milliseconds since the Unix epoch.
	end		RTP12a	The time until messages are retrieved, specified as milliseconds since the Unix epoch.
	direction		RTP12a	The order for which messages are returned in. Valid values are backwards which orders messages from most recent to oldest, or forwards which orders messages from oldest to most recent. The default is backwards.
	limit		RTP12a	An upper limit on the number of messages returned. The default is 100, and the maximum is 1000.
		PaginatedResult<PresenceMessage>		A [PaginatedResult]{@link PaginatedResult} object containing an array of [PresenceMessage]{@link PresenceMessage} objects.
subscribe((PresenceMessage) ->) => io			RTP6a	Registers a listener that is called each time a [PresenceMessage]{@link PresenceMessage} is received on the channel, such as a new member entering the presence set. A callback may optionally be passed in to this call to be notified of success or failure of the channel [attach()]{@link RealtimeChannel#attach} operation. It will not be called if the [attachOnSubscribe]{@link ChannelOptions#attachOnSubscribe} channel option is set to false.
	(PresenceMessage)			An event listener function.
subscribe(PresenceAction | [PresenceAction], (PresenceMessage) ->) => io			RTP6b	Registers a listener that is called each time a [PresenceMessage]{@link PresenceMessage} matching a given [PresenceAction]{@link PresenceAction}, or an action within an array of [PresenceActions]{@link PresenceAction}, is received on the channel, such as a new member entering the presence set. A callback may optionally be passed in to this call to be notified of success or failure of the channel [attach()]{@link RealtimeChannel#attach} operation. It will not be called if the [attachOnSubscribe]{@link ChannelOptions#attachOnSubscribe} channel option is set to false.
	PresenceAction | [PresenceAction]			A [PresenceAction]{@link PresenceAction} or an array of [PresenceActions]{@link PresenceAction} to register the listener for.
	(PresenceMessage)			An event listener function.
unsubscribe()			RTP7a, RTE5	Deregisters all listeners currently receiving [PresenceMessage]{@link PresenceMessage} for the channel.
unsubscribe((PresenceMessage) ->)			RTP7a	Deregisters a specific listener that is registered to receive [PresenceMessage]{@link PresenceMessage} on the channel.
unsubscribe(PresenceAction, (PresenceMessage) ->)			RTP7b	Deregisters a specific listener that is registered to receive [PresenceMessage]{@link PresenceMessage} on the channel for a given [PresenceAction]{@link PresenceAction}.
	PresenceAction			A specific [PresenceAction]{@link PresenceAction} to deregister the listener for.
enter(Data?, extras?: JsonObject) => io			RTP8	Announces the presence of the current client with optional data payload (enter message) on the channel. Enters client presence into the channel presence set. A valid clientId is required to be present on the connection. An optional callback may be provided to notify of the success or failure of the operation.
	Data			The payload associated with the presence member.
	extras			A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads.
update(Data?, extras?: JsonObject) => io			RTP9	Announces an updated presence message for the current client.Updates the data payload for a presence member. If the current client is not present on the channel, update will behave as Enter method, i.e. if called before entering the presence set, this is treated as an [ENTER]{@link PresenceAction#ENTER} event. An optional callback may be provided to notify of the success or failure of the operation.
	Data			The payload to update for the presence member.
	extras			A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads.
leave(Data?, extras?: JsonObject) => io			RTP10	Announces current client leave on the channel altogether with a optional data payload (leave message). It is removed from the channel presence members set. A client must have previously entered the presence set before they can leave it. An optional callback may be provided to notify of the success or failure of the operation.
	Data			The payload associated with the presence member.
	extras			A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads.
enterClient(clientId: String, Data?, extras?: JsonObject) => io			RTP4, RTP14, RTP15	Announces presence of the given clientID altogether with a enter message for the associated channel. Enters the given clientId in the channel presence set. Enables a single client to update presence on behalf of any number of clients using a single connection. The library must have been instantiated with an API key or a token bound to a wildcard (*) clientId. An optional callback may be provided to notify of the success or failure of the operation.
	clientId			The ID of the client to enter into the presence set.
	Data			The payload associated with the presence member.
	extras			A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads.
updateClient(clientId: String, Data?, extras?: JsonObject) => io			RTP15	Announces an updated presence message for the given clientID. Updates the data payload for a presence member using a given clientId. Enables a single client to update presence on behalf of any number of clients using a single connection. The library must have been instantiated with an API key or a token bound to a wildcard (*) clientId. An optional callback may be provided to notify of the success or failure of the operation.
	clientId			The ID of the client to update in the presence set.
	Data			The payload to update for the presence member.
	extras			A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads.
leaveClient(clientId: String, Data?, extras?: JsonObject) => io			RTP15	Announces the given clientID leave from associated channel altogether with a optional leave message. Leaves the given clientId from channel presence set. Enables a single client to update presence on behalf of any number of clients using a single connection. The library must have been instantiated with an API key or a token bound to a wildcard (*) clientId. An optional callback may be provided to notify of the success or failure of the operation.
	clientId			The ID of the client to leave the presence set for.
	Data			The payload associated with the presence member.
	extras			A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads.

enum PresenceAction

Describes the possible actions members in the presence set can emit.

Enum	Spec	Description
ABSENT	TP2	A member is not present in the channel.
PRESENT	TP2	When subscribing to presence events on a channel that already has members present, this event is emitted for every member already present on the channel before the subscribe listener was registered.
ENTER	TP2	A new member has entered the channel.
LEAVE	TP2	A member who was present has now left the channel. This may be a result of an explicit request to leave or implicitly when detaching from the channel. Alternatively, if a member's connection is abruptly disconnected and they do not resume their connection within a minute, Ably treats this as a leave event as the client is no longer present.
UPDATE	TP2	An already present member has updated their member data. Being notified of member data updates can be very useful, for example, it can be used to update the status of a user when they are typing a message.

class ConnectionDetails

Contains any constraints a client should adhere to and provides additional metadata about a [Connection]{@link Connection}, such as if a request to [publish()]{@link RealtimeClient#publish} a message that exceeds the maximum message size should be rejected immediately without communicating with Ably.

Method / Property	Parameter	Returns	Spec	Description
clientId: String?			RSA12a, CD2a	Contains the client ID assigned to the token. If clientId is null or omitted, then the client is prohibited from assuming a clientId in any operations, however if clientId is a wildcard string *, then the client is permitted to assume any clientId. Any other string value for clientId implies that the clientId is both enforced and assumed for all operations from this client.
connectionKey: String			RTN15e, CD2b	The connection secret key string that is used to resume a connection and its state.
connectionStateTtl: Duration			CD2f, RTN14e, DF1a	The duration that Ably will persist the connection state for when a Realtime client is abruptly disconnected.
maxFrameSize: Int default 524288			CD2d	Overrides the default maxFrameSize.
maxInboundRate: Int			CD2e	The maximum allowable number of requests per second from a client or Ably. In the case of a realtime connection, this restriction applies to the number of messages sent, whereas in the case of REST, it is the total number of REST requests per second.
maxMessageSize: Int default 65536			CD2c	The maximum message size is an attribute of an Ably account and enforced by Ably servers. maxMessageSize indicates the maximum message size allowed by the Ably account this connection is using. Overrides the default value of [ClientOptions.maxMessageSize]{@link ClientOptions#maxMessageSize}.
serverId: String			CD2g	A unique identifier for the front-end server that the client has connected to. This server ID is only used for the purposes of debugging.
maxIdleInterval: Duration			CD2h	The maximum length of time in milliseconds that the server will allow no activity to occur in the server to client direction. After such a period of inactivity, the server will send a HEARTBEAT or transport-level ping to the client. If the value is 0, the server will allow arbitrarily-long levels of inactivity.

class Message

Contains an individual message that is sent to, or received from, Ably.

Method / Property	Parameter	Returns	Spec	Description
constructor(name: String?, data: Data?)			TM2	Construct a Message object with an event name and payload.
	name			The event name.
	data			The message payload.
constructor(name: String?, data: Data?, clientId: String?)			TM2	Construct a Message object with an event name, payload, and a unique client ID.
	name			The event name.
	data			The message payload.
	clientId			The client ID of the publisher of this message.
+fromEncoded(JsonObject, ChannelOptions?) -> Message			TM3	A static factory method to create a Message object from a deserialized Message-like object encoded using Ably's wire protocol.
	JsonObject			A Message-like deserialized object.
	ChannelOptions			A [ChannelOptions]{@link ChannelOptions} object. If you have an encrypted channel, use this to allow the library to decrypt the data.
		Message		A Message object.
+fromEncodedArray(JsonArray, ChannelOptions?) -> [Message]			TM3	A static factory method to create an array of Message objects from an array of deserialized Message-like object encoded using Ably's wire protocol.
	JsonArray			An array of Message-like deserialized objects.
	ChannelOptions			A [ChannelOptions]{@link ChannelOptions} object. If you have an encrypted channel, use this to allow the library to decrypt the data.
		[Message]		An array of [Message]{@link Message} objects.
clientId: String?			RSL1g1, TM2b	The client ID of the publisher of this message.
connectionId: String?			TM2c	The connection ID of the publisher of this message.
data: Data?			TM2d	The message payload, if provided.
encoding: String?			TM2e	This is typically empty, as all messages received from Ably are automatically decoded client-side using this value. However, if the message encoding cannot be processed, this attribute contains the remaining transformations not applied to the data payload.
extras: JsonObject?			TM2i	A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads. Valid payloads include [push]{@link Push}, [delta]{@link DeltaExtras}, [ref]{@link ReferenceExtras} and headers.
id: String			TM2a	A Unique ID assigned by Ably to this message.
name: String?			TM2g	The event name.
timestamp: Time			TM2f	Timestamp of when the message was received by Ably, as milliseconds since the Unix epoch.

class PresenceMessage

Contains an individual presence update sent to, or received from, Ably.

Method / Property	Parameter	Returns	Spec	Description
+fromEncoded(JsonObject, ChannelOptions?) -> PresenceMessage			TP4	Decodes and decrypts a deserialized PresenceMessage-like object using the cipher in [ChannelOptions]{@link ChannelOptions}. Any residual transforms that cannot be decoded or decrypted will be in the encoding property. Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue) to avoid having to parse the encoding string.
	JsonObject			The deserialized PresenceMessage-like object to decode and decrypt.
	ChannelOptions			A [ChannelOptions]{@link ChannelOptions} object containing the cipher.
+fromEncodedArray(JsonArray, ChannelOptions?) -> [PresenceMessage]			TP4	Decodes and decrypts an array of deserialized PresenceMessage-like object using the cipher in [ChannelOptions]{@link ChannelOptions}. Any residual transforms that cannot be decoded or decrypted will be in the encoding property. Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue) to avoid having to parse the encoding string.
	JsonArray			An array of deserialized PresenceMessage-like objects to decode and decrypt.
	ChannelOptions			A [ChannelOptions]{@link ChannelOptions} object containing the cipher.
action: PresenceAction			TP3b	The type of [PresenceAction]{@link PresenceAction} the PresenceMessage is for.
clientId: String			TP3c	The ID of the client that published the PresenceMessage.
connectionId: String			TP3d	The ID of the connection associated with the client that published the PresenceMessage.
data: Data?			TP3e	The payload of the PresenceMessage.
encoding: String?			TP3f	This will typically be empty as all presence messages received from Ably are automatically decoded client-side using this value. However, if the message encoding cannot be processed, this attribute will contain the remaining transformations not applied to the data payload.
extras: JsonObject?			TP3i	A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads.
id: String			TP3a	A unique ID assigned to each PresenceMessage by Ably.
timestamp: Time			TP3g	The time the PresenceMessage was received by Ably, as milliseconds since the Unix epoch.
memberKey() -> String			TP3h	Combines clientId and connectionId to ensure that multiple connected clients with an identical clientId are uniquely identifiable. A string function that returns the combined clientId and connectionId.
		String		A combination of clientId and connectionId.

class AuthDetails

Contains the token string used to authenticate a client with Ably.

Method / Property	Parameter	Returns	Spec	Description
accessToken: String			AD2	The authentication token string.

class Connection

Enables the management of a connection to Ably.

Method / Property	Parameter	Returns	Spec	Description
embeds EventEmitter<ConnectionEvent, ConnectionStateChange>			RTN4a, RTN4e, RTN4g	Embeds an [EventEmitter]{@link EventEmitter} object.
errorReason: ErrorInfo?			RTN14a	An [ErrorInfo]{@link ErrorInfo} object describing the last error received if a connection failure occurs.
id: String?			RTN8	A unique public identifier for this connection, used to identify this member.
key: String?			RTN9	A unique private connection key used to recover or resume a connection, assigned by Ably. When recovering a connection explicitly, the recoveryKey is used in the recover client options as it contains both the key and the last message serial. This private connection key can also be used by other REST clients to publish on behalf of this client. See the publishing over REST on behalf of a realtime client docs for more info.
recoveryKey: String?			RTN16b, RTN16c	This property is deprecated and will be removed in future versions of the library. You should use [createRecoveryKey]{@link Connection#createRecoveryKey} method instead.
createRecoveryKey: String?			RTN16b, RTN16c	The recovery key string can be used by another client to recover this connection's state using the [ClientOptions.recover]{@ link ClientOptions#recover} property. It will return nil if connection is in the [CLOSED]{@link ConnectionState#CLOSED}, [CLOSING]{@link ConnectionState#CLOSING}, [FAILED]{@link ConnectionState#FAILED}, or [SUSPENDED]{@link ConnectionState#SUSPENDED} states, or when it does not have a connection [key]{@link Connection#key} (for example, if it has not yet become connected). See connection state recovery options for more information.
serial: Int?			RTN10	The serial number of the last message to be received on this connection, used automatically by the library when recovering or resuming a connection. When recovering a connection explicitly, the recoveryKey is used in the recover client options as it contains both the key and the last message serial.
state: ConnectionState			RTN4d	The current [ConnectionState]{@link ConnectionState} of the connection.
whenState(ConnectionState, (ConnectionStateChange?) ->)			RTN26	If the connection is already in the given state, calls the listener immediately with a null argument. Else, calls [once()]{@link EventEmitter#once} to register the listener to be called the next time the connection transitions to the given state.
	ConnectionState			The connection state to wait for.
	(ConnectionStateChange?) ->			The event listener.
close()			RTN12	Causes the connection to close, entering the [CLOSING]{@link ConnectionState#CLOSING} state. Once closed, the library does not attempt to re-establish the connection without an explicit call to [connect()]{@link Connection#connect}.
connect()			RTC1b, RTN3, RTN11	Explicitly calling connect() is needed if the autoConnect attribute of the [ClientOptions]{@link ClientOptions} object is false. If not already connected or connecting, this method causes the connection to open, entering the [CONNECTING]{@link ConnectionState#CONNECTING} state.
ping() => io Duration			RTN13	When connected, sends a heartbeat ping to the Ably server and executes the callback with any error and the response time in milliseconds when a heartbeat ping request is echoed from the server. This can be useful for measuring true round-trip latency to the connected Ably server.
		Duration		The response time in milliseconds.

enum ConnectionState

Describes the realtime [Connection]{@link Connection} object states.

Enum	Spec	Description
INITIALIZED		A connection with this state has been initialized but no connection has yet been attempted.
CONNECTING		A connection attempt has been initiated. The connecting state is entered as soon as the library has completed initialization, and is reentered each time connection is re-attempted following disconnection.
CONNECTED		A connection exists and is active.
DISCONNECTED		A temporary failure condition. No current connection exists because there is no network connectivity or no host is available. The disconnected state is entered if an established connection is dropped, or if a connection attempt was unsuccessful. In the disconnected state the library will periodically attempt to open a new connection (approximately every 15 seconds), anticipating that the connection will be re-established soon and thus connection and channel continuity will be possible. In this state, developers can continue to publish messages as they are automatically placed in a local queue, to be sent as soon as a connection is reestablished. Messages published by other clients while this client is disconnected will be delivered to it upon reconnection, so long as the connection was resumed within 2 minutes. After 2 minutes have elapsed, recovery is no longer possible and the connection will move to the SUSPENDED state.
SUSPENDED		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()]{@link Connection#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.
CLOSING		An explicit request by the developer to close the connection has been sent to the Ably service. If a reply is not received from Ably within a short period of time, the connection is forcibly terminated and the connection state becomes CLOSED.
CLOSED		The connection has been explicitly closed by the client. In the closed state, no reconnection attempts are made automatically by the library, and clients may not publish messages. No connection state is preserved by the service or by the library. A new connection attempt can be triggered by an explicit call to [connect()]{@link Connection#connect}, which results in a new connection.
FAILED		This state is entered if the client library encounters a failure condition that it cannot recover from. This may be a fatal connection error received from the Ably service, for example an attempt to connect with an incorrect API key, or a local terminal error, for example the token in use has expired and the library does not have any way to renew it. In the failed state, no reconnection attempts are made automatically by the library, and clients may not publish messages. A new connection attempt can be triggered by an explicit call to [connect()]{@link Connection#connect}.

enum ConnectionEvent

Describes the events emitted by a [Connection]{@link} object. An event is either an UPDATE or a [ConnectionState]{@link ConnectionState}.

Enum	Spec	Description
embeds ConnectionState		The event contains a [ConnectionState]{@link ConnectionState}.
UPDATE	RTN4h	An event for changes to connection conditions for which the [ConnectionState]{@link ConnectionState} does not change.

class ConnectionStateChange

Contains [ConnectionState]{@link} change information emitted by the [Connection]{@link} object.

Method / Property	Parameter	Returns	Spec	Description
current: ConnectionState			TA2	The new [ConnectionState]{@link ConnectionState}.
event: ConnectionEvent			TA5	The event that triggered this [ConnectionState]{@link ConnectionState} change.
previous: ConnectionState			TA2	The previous [ConnectionState]{@link ConnectionState}. For the [UPDATE]{@link ConnectionEvent#UPDATE} event, this is equal to the current [ConnectionState]{@link ConnectionState}.
reason: ErrorInfo?			RTN4f, TA3	An [ErrorInfo]{@link ErrorInfo} object containing any information relating to the transition.
retryIn: Duration?			RTN14d, TA2	Duration in milliseconds, after which the client retries a connection where applicable.

class Stats

Contains application statistics for a specified time interval and time period.

Method / Property	Parameter	Returns	Spec	Description
intervalId: String			TS15a	The UTC time at which the time period covered begins. If unit is set to minute this will be in the format YYYY-mm-dd:HH:MM, if hour it will be YYYY-mm-dd:HH, if day it will be YYYY-mm-dd:00 and if month it will be YYYY-mm-01:00.
intervalTime: Time			TS15g (calculated client-side)	Represents the intervalId as a time object.
unit: Stats.IntervalGranularity			TS15b	The length of the interval the stats span. Values will be a [StatsIntervalGranularity]{@link StatsIntervalGranularity}.
inProgress: String?			TS15c	For entries that are still in progress, such as the current month: the last sub-interval included in this entry (in format yyyy-mm-dd:hh:mm:ss), else undefined.
entries: Dict<String, Int>			TS15d	The statistics for this time interval and time period. See the JSON schema which the [schema]{@link Stats#schema} property points to for more information.
schema: String			TS15e	The URL of a JSON Schema which describes the structure of this Stats object.
appId: String			TS15f	The ID of the Ably application the statistics are for.

enum StatsIntervalGranularity

Describes the interval unit over which statistics are gathered.

Enum	Spec	Description
MINUTE		Interval unit over which statistics are gathered as minutes.
HOUR		Interval unit over which statistics are gathered as hours.
DAY		Interval unit over which statistics are gathered as days.
MONTH		Interval unit over which statistics are gathered as months.

class DeviceDetails

Contains the properties of a device registered for push notifications.

Method / Property	Parameter	Returns	Spec	Description
id: String				A unique ID generated by the device.
clientId: String?				The client ID the device is connected to Ably with.
formFactor: DeviceFormFactor				The [DeviceFormFactor]{@link DeviceFormFactor} object associated with the device. Describes the type of the device, such as phone or tablet.
metadata: JsonObject				A JSON object of key-value pairs that contains metadata for the device.
platform: DevicePlatform				The [DevicePlatform]{@link DevicePlatform} associated with the device. Describes the platform the device uses, such as android or ios.
push: DevicePushDetails				The [DevicePushDetails]{@link DevicePushDetails} object associated with the device. Describes the details of the push registration of the device.

class DevicePushDetails

Contains the details of the push registration of a device.

Method / Property	Parameter	Returns	Spec	Description
errorReason: ErrorInfo?				An [ErrorInfo]{@link ErrorInfo} object describing the most recent error when the state is Failing or Failed.
recipient: JsonObject				A JSON object of key-value pairs that contains of the push transport and address.
state: .Active | .Failing | .Failed				The current state of the push registration.

class LocalDevice (extends DeviceDetails)

Contains the device identity token and secret of a device. LocalDevice extends [DeviceDetails]{@link}.

Method / Property	Parameter	Returns	Spec	Description
deviceIdentityToken: String				A unique device identity token used to communicate with APNS or FCM.
deviceSecret: String				A unique device secret generated by the Ably SDK.

class Push

Enables a device to be registered and deregistered from receiving push notifications.

Method / Property	Parameter	Returns	Spec	Description
admin: PushAdmin			RSH1	A [PushAdmin]{@link PushAdmin} object.
activate(registerCallback: ((ErrorInfo?, DeviceDetails?) -> io String)?, updateFailedCallback: ((ErrorInfo) ->)) => io ErrorInfo?			RSH2a	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.
		ErrorInfo		Describes why the activation was unsuccessful as an [ErrorInfo]{@link ErrorInfo} object.
deactivate(deregisterCallback: ((ErrorInfo?, deviceId: String?) -> io)?) => io ErrorInfo?			RSH2b	Deactivates the device from receiving push notifications with Ably and FCM or APNS.
		ErrorInfo		Describes why the deactivation was unsuccessful as an [ErrorInfo]{@link ErrorInfo} object.

class PushAdmin

Enables the management of device registrations and push notification subscriptions. Also enables the publishing of push notifications to devices.

Method / Property	Parameter	Returns	Spec	Description
publish(recipient: JsonObject, data: JsonObject) => io			RSH1a	Sends a push notification directly to a device, or a group of devices sharing the same clientId.
	recipient			A JSON object containing the recipient details using clientId, deviceId or the underlying notifications service.
	data			A JSON object containing the push notification payload.
deviceRegistrations: PushDeviceRegistrations			RSH1b	A [PushDeviceRegistrations]{@link PushDeviceRegistrations} object.
channelSubscriptions: PushChannelSubscriptions			RSH1c	A [PushChannelSubscriptions]{@link PushChannelSubscriptions} object.

class JsonObject

Describes any type or interface in the target language that represents an RFC4627 object or array value respectively. Such types serialize to, and may be deserialized from, the corresponding JSON text. JsonObject is platform-dependent, typically a dictionary-like object.

class PushDeviceRegistrations

Enables the management of push notification registrations with Ably.

Method / Property	Parameter	Returns	Spec	Description
get(DeviceDetails) => io DeviceDetails			RSH1b1	Retrieves the [DeviceDetails]{@link DeviceDetails} of a device registered to receive push notifications using the id property of a [DeviceDetails]{@link DeviceDetails} object.
	DeviceDetails			The [DeviceDetails]{@link DeviceDetails} object containing the id property of the device.
		DeviceDetails		A [DeviceDetails]{@link DeviceDetails} object.
get(deviceId: String) => io DeviceDetails			RSH1b1	Retrieves the [DeviceDetails]{@link DeviceDetails} of a device registered to receive push notifications using its deviceId.
	deviceId			The unique ID of the device.
		DeviceDetails		A [DeviceDetails]{@link DeviceDetails} object.
list(params: Dict<String, String>) => io PaginatedResult<DeviceDetails>			RSH1b2	Retrieves all devices matching the filter params provided. Returns a [PaginatedResult]{@link PaginatedResult} object, containing an array of [DeviceDetails]{@link DeviceDetails} objects.
	params			An object containing key-value pairs to filter devices by. Can contain clientId, deviceId and a limit on the number of devices returned, up to 1,000.
		PaginatedResult<DeviceDetails>		A [PaginatedResult]{@link PaginatedResult} object containing an array of [DeviceDetails]{@link DeviceDetails} objects.
save(DeviceDetails) => io DeviceDetails			RSH1b3	Registers or updates a [DeviceDetails]{@link DeviceDetails} object with Ably. Returns the new, or updated [DeviceDetails]{@link DeviceDetails} object.
	DeviceDetails			The [DeviceDetails]{@link DeviceDetails} object to create or update.
		DeviceDetails		A [DeviceDetails]{@link DeviceDetails} object.
remove(DeviceDetails) => io			RSH1b4	Removes a device registered to receive push notifications from Ably using the id property of a [DeviceDetails]{@link DeviceDetails} object.
	DeviceDetails			The [DeviceDetails]{@link DeviceDetails} object containing the id property of the device.
remove(deviceId: String) => io			RSH1b4	Removes a device registered to receive push notifications from Ably using its deviceId.
	deviceId			The unique ID of the device.
removeWhere(params: Dict<String, String>) => io			RSH1b5	Removes all devices registered to receive push notifications from Ably matching the filter params provided.
	params			An object containing key-value pairs to filter devices by. Can contain clientId and deviceId.

class PushChannelSubscriptions

Enables device push channel subscriptions.

Method / Property	Parameter	Returns	Spec	Description
list(params: Dict<String, String>) => io PaginatedResult<PushChannelSubscription>			RSH1c1	Retrieves all push channel subscriptions matching the filter params provided. Returns a [PaginatedResult]{@link PaginatedResult} object, containing an array of [PushChannelSubscription]{@link PushChannelSubscription} objects.
	params			An object containing key-value pairs to filter subscriptions by. Can contain channel, clientId, deviceId and a limit on the number of devices returned, up to 1,000.
		PaginatedResult<PushChannelSubscription>		A [PaginatedResult]{@link PaginatedResult} object containing an array of [PushChannelSubscription]{@link PushChannelSubscription} objects.
listChannels(params?: Dict<String, String>) => io PaginatedResult<String>			RSH1c2	Retrieves all channels with at least one device subscribed to push notifications. Returns a [PaginatedResult]{@link PaginatedResult} object, containing an array of channel names.
	params			An object containing key-value pairs to filter channels by. Can contain a limit on the number of channels returned, up to 1,000.
		PaginatedResult<String>		A [PaginatedResult]{@link PaginatedResult} object containing an array of channel names.
save(PushChannelSubscription) => io PushChannelSubscription			RSH1c3	Subscribes a device, or a group of devices sharing the same clientId to push notifications on a channel. Returns a [PushChannelSubscription]{@link PushChannelSubscription} object.
	PushChannelSubscription			A [PushChannelSubscription]{@link PushChannelSubscription} object.
		PushChannelSubscription		A [PushChannelSubscription]{@link PushChannelSubscription} object describing the new or updated subscriptions.
remove(PushChannelSubscription) => io			RSH1c4	Unsubscribes a device, or a group of devices sharing the same clientId from receiving push notifications on a channel.
	PushChannelSubscription			A [PushChannelSubscription]{@link PushChannelSubscription} object.
removeWhere(params: Dict<String, String>) => io			RSH1c5	Unsubscribes all devices from receiving push notifications on a channel that match the filter params provided.
	params			An object containing key-value pairs to filter subscriptions by. Can contain channel, and optionally either clientId or deviceId.

enum DevicePlatform

Describes the device receiving push notifications.

Enum	Spec	Description
"android"	PCD6	The device platform is Android.
"ios"	PCD6	The device platform is iOS.
"browser"	PCD6	The device platform is a web browser.

enum DeviceFormFactor

Describes the type of device receiving a push notification.

Enum	Spec	Description
"phone"	PCD4	The device is a phone.
"tablet"	PCD4	The device is tablet.
"desktop"	PCD4	The device is a desktop.
"tv"	PCD4	The device is a TV.
"watch"	PCD4	The device is a watch.
"car"	PCD4	The device is a car.
"embedded"	PCD4	The device is embedded.
"other"	PCD4	The device is other.

class PushChannelSubscription

Contains the subscriptions of a device, or a group of devices sharing the same clientId, has to a channel in order to receive push notifications.

Method / Property	Parameter	Returns	Spec	Description
+forDevice(channel: String, deviceId: String) => PushChannelSubscription				A static factory method to create a PushChannelSubscription object for a channel and single device.
	channel			The channel name.
	deviceId			The unique ID of the device.
		PushChannelSubscription		A PushChannelSubscription object.
+forClientId(channel: String, clientId: String) => PushChannelSubscription				A static factory method to create a PushChannelSubscription object for a channel and group of devices sharing the same clientId.
	channel			The channel name.
	clientId			The ID of the client.
		PushChannelSubscription		A PushChannelSubscription object.
deviceId: String?			PCS2, PCS5, PCS6	The unique ID of the device.
clientId: String?			PCS3, PCS6	The ID of the client the device, or devices are associated to.
channel: String			PCS4	The channel the push notification subscription is for.

class ErrorInfo

A generic Ably error object that contains an Ably-specific status code, and a generic status code. Errors returned from the Ably server are compatible with the ErrorInfo structure and should result in errors that inherit from ErrorInfo.

Method / Property	Parameter	Returns	Spec	Description
code: Int			TI1	Ably error code.
href: String?			TI4	This is included for REST responses to provide a URL for additional help on the error code.
message: String			TI1	Additional message information, where available.
cause: ErrorInfo?			TI1	Information pertaining to what caused the error where available.
statusCode: Int			TI1	HTTP Status Code corresponding to this error, where applicable.
requestId: String?			RSC7c	If a request fails, the request ID must be included in the ErrorInfo returned to the user.

class EventEmitter<Event, Data>

A generic interface for event registration and delivery used in a number of the types in the Realtime client library. For example, the [Connection]{@link} object emits events for connection state using the EventEmitter pattern.

Method / Property	Parameter	Returns	Spec	Description
on((Data...) ->)			RTE4	Registers the provided listener all events. If on() is called more than once with the same listener and event, the listener is added multiple times to its listener registry. Therefore, as an example, assuming the same listener is registered twice using on(), and an event is emitted once, the listener would be invoked twice.
	Data			The event listener.
on(Event, (Data...) ->)			RTE4	Registers the provided listener for the specified event. If on() is called more than once with the same listener and event, the listener is added multiple times to its listener registry. Therefore, as an example, assuming the same listener is registered twice using on(), and an event is emitted once, the listener would be invoked twice.
	Event			The named event to listen for.
	Data			The event listener.
once((Data...) ->)			RTE4	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.
	Data			The event listener.
once(Event, (Data...) ->)			RTE4	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.
	Event			The named event to listen for.
	Data			The event listener.
off()			RTE5	Deregisters all registrations, for all events and listeners.
off(Event)			RTE5	Deregisters all registrations that match the specified event.
	Event			The named event.
off((Data...) ->)			RTE5	Deregisters the specified listener. Removes all registrations matching the given listener, regardless of whether they are associated with an event or not.
	Data			The event listener.
off(Event, (Data...) ->)			RTE5	Deregisters all registrations that match both the specified listener and the specified event.
	Event			The named event.
	Data			The event listener.
emit(Event, Data...)			internal, RTE6	Emits an event, calling registered listeners with the given event name and any other given arguments. If an exception is raised in any of the listeners, the exception is caught by the EventEmitter and the exception is logged to the Ably logger.
	Event			The named event.
	Data			The event listener.

class PaginatedResult<T>

Contains a page of results for message or presence history, stats, or REST presence requests. A PaginatedResult response from a REST API paginated query is also accompanied by metadata that indicates the relative queries available to the PaginatedResult object.

Method / Property	Parameter	Returns	Spec	Description
items: [T]			TG3	Contains the current page of results; for example, an array of [Message]{@link Message} or [PresenceMessage]{@link PresenceMessage} objects for a channel history request.
first() => io PaginatedResult<T>			TG5	Returns a new PaginatedResult for the first page of results.
		PaginatedResult<T>		A page of results for message and presence history, stats, and REST presence requests.
hasNext() -> Bool			TG6	Returns true if there are more pages available by calling next and returns false if this page is the last page available.
		Bool		Whether or not there are more pages of results.
isLast() -> Bool			TG7	Returns true if this page is the last page and returns false if there are more pages available by calling next available.
		Bool		Whether or not this is the last page of results.
next() => io PaginatedResult<T>?			TG4	Returns a new PaginatedResult loaded with the next page of results. If there are no further pages, then null is returned.
		PaginatedResult<T>		A page of results for message and presence history, stats, and REST presence requests.

class HttpPaginatedResponse

A superset of [PaginatedResult]{@link PaginatedResult} which represents a page of results plus metadata indicating the relative queries available to it. HttpPaginatedResponse additionally carries information about the response to an HTTP request.

Method / Property	Parameter	Returns	Spec	Description
embeds PaginatedResult<JsonObject>				HttpPaginatedResponse embeds [PaginatedResult]{@link PaginatedResult}.
items: [JsonObject]			HP3	Contains a page of results; for example, an array of [Message]{@link Message} or [PresenceMessage]{@link PresenceMessage} objects for a channel history request.
statusCode: Int			HP4	The HTTP status code of the response.
success: Bool			HP5	Whether statusCode indicates success. This is equivalent to 200 <= statusCode < 300.
errorCode: Int			HP6	The error code if the X-Ably-Errorcode HTTP header is sent in the response.
errorMessage: String			HP7	The error message if the X-Ably-Errormessage HTTP header is sent in the response.
headers: Dict<String, String>			HP8	The headers of the response.

enum PluginType

Describes the type of plugin used.

Enum	Spec	Description
"vcdiff"		A plugin capable of decoding vcdiff-encoded messages. It must implement the [VCDiffDecoder]{@link VCDiffDecoder} interface.

class VCDiffDecoder

Enables vcdiff encoded messages to be decoded.

Method / Property	Parameter	Returns	Spec	Description
decode([byte] delta, [byte] base) -> [byte]			PC3	Decodes vcdiff encoded messages.
	delta		PC3a	The delta encoded data.
	base		PC3a	The stored base payload of the last message on a channel.
		[byte]	PC3a	The decoded data.

class DeltaExtras

Contains any arbitrary key-value pairs, which may also contain other primitive JSON types, JSON-encodable objects, or JSON-encodable arrays from delta compression.

Method / Property	Parameter	Returns	Spec	Description
from: String				The ID of the message the delta was generated from.
format: String				The delta compression format. Only vcdiff is supported.

class ReferenceExtras

Contains fields used when referencing a previous message.

Method / Property	Parameter	Returns	Spec	Description
timeserial: String			REX2a	A unique identifier indicating the message being interacted with.
type: String			REX2b	The reason for interacting with the previous message, for example, com.ably.reaction to indicate a reaction.

class ClientInformation

Provides information about the Ably client library and the environment in which it’s running.

Method / Property	Parameter	Returns	Spec	Description
+agents: Dict<String, String?>			CR2	Returns the default key-value entries that the Ably client library uses to identify itself, and the environment in which it’s running, to the Ably service. Its keys are the names of the software components, and its values are their optional versions. The full list of keys that this method might return can be found here. For example, users of the ably-cocoa client library can find out the library version by fetching the value for the "ably-cocoa" key from the return value of this method.
+agentIdentifier(additionalAgents: Dict<String, String?>?) => String			CR3	Returns the Agent library identifier. This method should only be used by Ably-authored SDKs.
	additionalAgents		CR3c	A set of additional entries for the Agent library identifier. Its keys are the names of the agents, and its values are their optional versions.
		String	CR3b	The Agent library identifier.

class BatchResult<T>

Contains information about the results of a batch operation.

Method / Property	Parameter	Returns	Spec	Description
successCount: Int			BAR2a	The number of successful operations in the request.
failureCount: Int			BAR2b	The number of unsuccessful operations in the request.
results: [T]			BAR2c	An array of results for the batch operation.

class BatchPublishSpec

Describes the messages that should be published by a batch publish operation, and the channels to which they should be published.

Method / Property	Parameter	Returns	Spec	Description
channels: [String]			BSP2a	The names of the channels to publish the messages to.
messages: [Message]			BSP2b	An array of [Message]{@link Message} objects.

class BatchPublishSuccessResult

Contains information about the result of successful publishes to a channel requested by a single [BatchPublishSpec]{@link BatchPublishSpec}.

Method / Property	Parameter	Returns	Spec	Description
channel: String			BPR2a	The name of the channel the message(s) was published to.
messageId: String			BPR2b	A unique ID prefixed to the [id]{@link Message#id} of each published message.

class BatchPublishFailureResult

Contains information about the result of unsuccessful publishes to a channel requested by a single [BatchPublishSpec]{@link BatchPublishSpec}.

Method / Property	Parameter	Returns	Spec	Description
channel: String			BPF2a	The name of the channel the message(s) failed to be published to.
error: ErrorInfo			BPF2b	Describes the reason for which the message(s) failed to be published to the channel as an [ErrorInfo]{@link ErrorInfo} object.

class BatchPresenceSuccessResult

Contains information about the result of a successful batch presence request for a single channel.

Method / Property	Parameter	Returns	Spec	Description
channel: String			BGR2a	The channel name the presence state was retrieved for.
presence: [PresenceMessage]			BGR2b	An array of [PresenceMessage]{@link PresenceMessage}s describing members present on the channel.

class BatchPresenceFailureResult

Contains information about the result of an unsuccessful batch presence request for a single channel.

Method / Property	Parameter	Returns	Spec	Description
channel: String			BGF2a	The channel name the presence state failed to be retrieved for.
error: ErrorInfo			BGF2b	Describes the reason for which presence state could not be retrieved for the channel as an [ErrorInfo]{@link ErrorInfo} object.

class TokenRevocationTargetSpecifier

Describes which tokens should be affected by a token revocation request.

Method / Property	Parameter	Returns	Spec	Description
type: String			TRT2a	The type of token revocation target specifier. Valid values include clientId, revocationKey and channel.
value: String			TRT2b	The value of the token revocation target specifier.

class TokenRevocationSuccessResult

Contains information about the result of a successful token revocation request for a single target specifier.

Method / Property	Parameter	Returns	Spec	Description
target: String			TRS2a	The target specifier.
appliesAt: Int			TRS2b	The time at which the token revocation will take effect, as a Unix timestamp in milliseconds.
issuedBefore: Int			TRS2c	A Unix timestamp in milliseconds. Only tokens issued earlier than this time will be revoked.

class TokenRevocationFailureResult

Contains information about the result of an unsuccessful token revocation request for a single target specifier.

Method / Property	Parameter	Returns	Spec	Description
target: String			TRF2a	The target specifier.
error: ErrorInfo			TRF2b	Describes the reason for which token revocation failed for the given target as an [ErrorInfo]{@link ErrorInfo} object.