The channel name.
A PresencePromise object.
Retrieves a PaginatedResult object, containing an array of historical 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.
A promise which, upon success, will be fulfilled with a PaginatedResult object containing an array of Message objects. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Optional params: RestHistoryParams
A set of parameters which are used to specify which messages should be retrieved.
Publishes an array of messages to the channel.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
An array of Message objects.
Optional options: PublishOptions
Optional parameters, such as quickAck sent as part of the query string.
Publishes a message to the channel.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
A Message object.
Optional options: PublishOptions
Optional parameters, such as quickAck sent as part of the query string.
Publishes a single message to the channel with the given event name and payload.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
The name of the message.
The payload of the message.
Optional options: PublishOptions
Optional parameters, such as quickAck sent as part of the query string.
Retrieves a ChannelDetails object for the channel, which includes status and occupancy metrics.
A promise which, upon success, will be fulfilled a ChannelDetails object. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Generated using TypeDoc
Enables messages to be published and historic messages to be retrieved for a channel.