The channel name.
A Presence object.
A PushChannel object.
Appends data to an existing message. The supplied data field is appended to the previous message's data, while all other fields (name, extras) replace the previous values if provided.
The channel must be configured to allow message appends, enabled by a rule.
The supplied Message must carry a populated serial. A newly constructed Message has none, so the call rejects with an ErrorInfo.
A Message object containing a populated serial field and the data to append.
Optional operation: MessageOperation
An optional MessageOperation object containing metadata about the append operation.
Optional options: PublishOptions
Optional parameters to modify how the publish is made.
A promise which, upon success, will be fulfilled with an UpdateDeleteResult object containing the serial of the new version of the message. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
const result = await channel.appendMessage({ ...message, data: ' more text' });
https://ably.com/docs/pub-sub/api/javascript/rest/channel#append-message
Marks a message as deleted by publishing an update with an action of MESSAGE_DELETE. This does not remove the message from the server, and the full message history remains accessible.
Uses patch semantics: non-null name, data, and extras fields in the provided message replace the corresponding fields in the existing message, while null fields are left unchanged. A deleted message keeps its previous data unless the delete explicitly sets data to an empty value.
The channel must be configured to allow message deletes, enabled by a rule.
The supplied Message must carry a populated serial. A newly constructed Message has none, so the call rejects with an ErrorInfo.
A Message object containing a populated serial field.
Optional operation: MessageOperation
An optional MessageOperation object containing metadata about the delete operation.
Optional options: PublishOptions
Optional parameters to modify how the publish is made.
A promise which, upon success, will be fulfilled with an UpdateDeleteResult object containing the serial of the new version of the message. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
const result = await channel.deleteMessage(message);
https://ably.com/docs/pub-sub/api/javascript/rest/channel#delete-message
Retrieves the latest version of a specific message by its serial identifier.
The channel must be configured to allow message updates, enabled by a rule.
The supplied serial or Message must carry a populated serial. A newly constructed Message has none, so the call rejects with an ErrorInfo.
A promise which, upon success, will be fulfilled with a Message object representing the latest version of the message. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
const message = await channel.getMessage(serial);
https://ably.com/docs/pub-sub/api/javascript/rest/channel#get-message
Retrieves all historical versions of a specific message, ordered by version. This includes the original message and all subsequent update, delete, or append operations.
The supplied serial or Message must carry a populated serial. A newly constructed Message has none, so the call rejects with an ErrorInfo.
Message versions exist only when the channel is configured to allow updating, deleting, or appending messages, enabled by a rule.
A promise which, upon success, will be fulfilled with a PaginatedResult object containing an array of Message objects representing all versions of the message. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
const versions = await channel.getMessageVersions(message);
https://ably.com/docs/pub-sub/api/javascript/rest/channel#get-message-versions
Retrieves a PaginatedResult object, containing an array of historical InboundMessage 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.
A promise which, upon success, will be fulfilled with a PaginatedResult object containing an array of InboundMessage objects. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Publishes an array of messages to the channel.
An array of Message objects.
Optional options: PublishOptions
Optional parameters, such as quickAck sent as part of the query string.
A promise which, upon success, will be fulfilled with a PublishResult object containing the serials of the published messages. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
Publishes a message to the channel.
A Message object.
Optional options: PublishOptions
Optional parameters, such as quickAck sent as part of the query string.
A promise which, upon success, will be fulfilled with a PublishResult object containing the serial of the published message. Upon failure, the promise will be rejected with an ErrorInfo object which explains 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.
A promise which, upon success, will be fulfilled with a PublishResult object containing the serial of the published message. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
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.
Publishes an update to an existing message with patch semantics. Non-null name, data, and extras fields in the provided message replace the corresponding fields in the existing message, while null fields are left unchanged.
The channel must be configured to allow message updates, enabled by a rule.
The supplied Message must carry a populated serial. A newly constructed Message has none, so the call rejects with an ErrorInfo.
A Message object containing a populated serial field and the fields to update.
Optional operation: MessageOperation
An optional MessageOperation object containing metadata about the update operation.
Optional options: PublishOptions
Optional parameters to modify how the publish is made.
A promise which, upon success, will be fulfilled with an UpdateDeleteResult object containing the serial of the new version of the message. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.
await channel.updateMessage({ ...message, data: 'edited text' });
https://ably.com/docs/pub-sub/api/javascript/rest/channel#update-message
Generated using TypeDoc
Enables messages to be published and historic messages to be retrieved for a channel.