The channel name.
A PresenceCallbacks 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.
Optional params: RestHistoryParams
A set of parameters which are used to specify which messages should be retrieved.
Optional callback: paginatedResultCallback<Message>
A function which, upon success, will be called with a PaginatedResult object containing an array of Message objects. Upon failure, the function will be called with information about the error.
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.
Optional callback: paginatedResultCallback<Message>
A function which, upon success, will be called with a PaginatedResult object containing an array of Message objects. Upon failure, the function will be called with information about the error.
Publishes a single message to the channel with the given event name and payload.
The name of the message.
The payload of the message.
Optional callback: errorCallback
A function which will be called upon completion of the operation. If the operation succeeded, then the function will be called with null. If it failed, the function will be called with information about the error.
Publishes an array of messages to the channel.
An array of Message objects.
Optional callback: errorCallback
A function which will be called upon completion of the operation. If the operation succeeded, then the function will be called with null. If it failed, the function will be called with information about the error.
Publishes a message to the channel.
A Message object.
Optional callback: errorCallback
A function which will be called upon completion of the operation. If the operation succeeded, then the function will be called with null. If it failed, the function will be called with information about the error.
Publishes a single message to the channel with the given event name and payload.
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.
Optional callback: errorCallback
A function which will be called upon completion of the operation. If the operation succeeded, then the function will be called with null. If it failed, the function will be called with information about the error.
Retrieves a ChannelDetails object for the channel, which includes status and occupancy metrics.
A function which, upon success, will be called a ChannelDetails object. Upon failure, the function will be called with information about the error.
Generated using TypeDoc
Enables messages to be published and historic messages to be retrieved for a channel.