Class Rest

constructor

• new Rest(options): Rest

• Construct a client object using an Ably ClientOptions object.

  Parameters

  • options: ClientOptions<CorePlugins>

    A ClientOptions object to configure the client connection to Ably.

  Returns Rest
• new Rest(keyOrToken): Rest

• Constructs a client object using an Ably API key or token string.

  Parameters

  • keyOrToken: string

    The Ably API key or token string used to validate the client.

  Returns Rest

auth

channels

push

Static Crypto

Static Message

Static PresenceMessage

batchPresence

• batchPresence(channels): Promise<BatchResult<BatchPresenceSuccessResult | BatchPresenceFailureResult>[]>

• 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.

  Parameters

  • channels: string[]

    An array of one or more channel names, up to a maximum of 100 channels.

  Returns Promise<BatchResult<BatchPresenceSuccessResult | BatchPresenceFailureResult>[]>

  A promise which, upon success, will be fulfilled with a BatchResult object containing information about the result of the batch presence request for each requested channel. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.

batchPublish

• batchPublish(spec): Promise<BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>>

• Publishes a BatchPublishSpec object to one or more channels, up to a maximum of 100 channels.

  Parameters

  • spec: BatchPublishSpec

    A BatchPublishSpec object.

  Returns Promise<BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>>

  A promise which, upon success, will be fulfilled with a BatchResult object containing information about the result of the batch publish for each requested channel. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
• batchPublish(specs): Promise<BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>[]>

• Publishes one or more BatchPublishSpec objects to one or more channels, up to a maximum of 100 channels.

  Parameters

  • specs: BatchPublishSpec[]

    An array of BatchPublishSpec objects.

  Returns Promise<BatchResult<BatchPublishSuccessResult | BatchPublishFailureResult>[]>

  A promise which, upon success, will be fulfilled with an array of BatchResult objects containing information about the result of the batch publish for each requested channel for each provided BatchPublishSpec. This array is in the same order as the provided BatchPublishSpec array. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.

request

• request<T>(method, path, version, params?, body?, headers?): Promise<HttpPaginatedResponse<T>>

• 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.

  Type Parameters

  • T = any

  Parameters

  • method: string

    The request method to use, such as GET, POST.

  • path: string

    The request path.

  • version: number

    The version of the Ably REST API to use. See the REST API reference for information on versioning.

  • Optional params: any

    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.

  • Optional body: any

    The JSON body of the request.

  • Optional headers: any

    Additional HTTP headers to include in the request.

  Returns Promise<HttpPaginatedResponse<T>>

  A promise which, upon success, will be fulfilled with an HttpPaginatedResponse response object returned by the HTTP request. This response object will contain an empty or JSON-encodable object. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.

stats

• stats(params?): Promise<PaginatedResult<Stats>>

• Queries the REST /stats API and retrieves your application's usage statistics. Returns a PaginatedResult object, containing an array of Stats objects. See the Stats docs.

  Parameters

  • Optional params: StatsParams

    A set of parameters which are used to specify which statistics should be retrieved. If you do not provide this argument, then this method will use the default parameters described in the StatsParams interface.

  Returns Promise<PaginatedResult<Stats>>

  A promise which, upon success, will be fulfilled with a PaginatedResult object containing an array of Stats objects. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.

time

• time(): Promise<number>

• 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 with a more accurate timestamp should use the queryTime property instead of this method.

  Returns Promise<number>

  A promise which, upon success, will be fulfilled with the time as milliseconds since the Unix epoch. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.