Variable RestConst

Provides REST-related functionality to a BaseRealtime client.

To create a client that includes this plugin, include it in the client options that you pass to the constructor:

import { BaseRealtime, WebSocketTransport, FetchRequest, Rest } from 'ably/modular';
const realtime = new BaseRealtime({ ...options, plugins: { WebSocketTransport, FetchRequest, Rest } });
Copy

When provided, the following functionality becomes available:

• push admin
• retrieving Ably service time
• creating a token request using the queryTime option
• retrieving your application’s usage statistics
• making arbitrary REST requests
• batch publishing of messages
• batch retrieval of channel presence state
• requesting the revocation of tokens
• retrieving the message history of a channel
• retrieving the presence history of a channel

If this plugin is not provided, then trying to use the above functionality will cause a runtime error.