Optional ReadonlyconnectionIf there's a connection error it will be available here.
ReadonlyconnectionProvides the connection status of the Ably connection.
ReadonlydeleteA shortcut to the Messages.delete method.
Delete a message in the chat room.
This method uses the Ably Chat API REST endpoint for deleting messages.
It performs a soft delete, meaning the message is marked as deleted.
Note that the Promise may resolve before OR after the message is deleted
from the realtime channel. This means you may see the message that was just
deleted in a callback to subscribe before the returned promise resolves.
Should you wish to restore a deleted message, and providing you have the appropriate permissions, you can simply send an update to the original message. Note: This is subject to change in future versions, whereby a new permissions model will be introduced and a deleted message may not be restorable in this way.
The message to delete.
OptionaldeleteMessageParams: DeleteMessageParamsOptional details to record about the delete action.
A promise that resolves when the message was deleted.
ReadonlygetA shortcut to the Messages.get method.
Get messages that have been previously sent to the chat room, based on the provided options.
Options for the query.
A promise that resolves with the paginated result of messages. This paginated result can be used to fetch more messages if available.
Optional ReadonlygetRetrieves the previous messages in the room.
This method is available only if a MessageListener has been provided in the UseMessagesParams. Calling will return a promise that resolves to a paginated response of the previous messages received in the room, up until the listener was attached, in the oldest to newest order.
It is advised to call this method after any discontinuity event; to retrieve messages that may have been missed before the listener was re-attached.
This is removed when the component unmounts or when the previously provided listener is removed.
Get the previous messages that were sent to the room before the listener was subscribed.
Options for the history query.
A promise that resolves with the paginated result of messages, in newest-to-oldest order.
Optional ReadonlymessagesProvides access to the underlying Messages instance of the room.
Optional ReadonlyroomIf there's an error with the room it will be available here.
ReadonlyroomProvides the status of the room.
ReadonlysendA shortcut to the Messages.send method.
Send a message in the chat room.
This method uses the Ably Chat API endpoint for sending messages.
Note that the Promise may resolve before OR after the message is received
from the realtime channel. This means you may see the message that was just
sent in a callback to subscribe before the returned promise resolves.
an object containing {text, headers, metadata} for the message to be sent. Text is required, metadata and headers are optional.
A promise that resolves when the message was published.
ReadonlyupdateA shortcut to the Messages.update method.
Update a message in the chat room.
Note that the Promise may resolve before OR after the updated message is
received from the realtime channel. This means you may see the update that
was just sent in a callback to subscribe before the returned promise
resolves.
The message to update.
The new message content including headers and metadata. This fully replaces the old content. Everything that's not set will be removed.
Optionaldetails: ActionDetailsOptional details to record about the update action.
A promise of the updated message.
The response from the useMessages hook.