Interface UseMessagesResponse

The response from the useMessages hook.

interface UseMessagesResponse {
    connectionError?: ErrorInfo;
    connectionStatus: ConnectionStatus;
    deleteMessage: (
        serial: Serial,
        deleteMessageParams?: DeleteMessageParams,
    ) => Promise<Message>;
    deleteReaction: (
        messageSerial: Serial,
        params?: DeleteMessageReactionParams,
    ) => Promise<void>;
    history: (options: QueryOptions) => Promise<PaginatedResult<Message>>;
    historyBeforeSubscribe?: (
        params: Omit<QueryOptions, "orderBy">,
    ) => Promise<PaginatedResult<Message>>;
    messages?: Messages;
    roomError?: ErrorInfo;
    roomStatus: RoomStatus;
    send: (params: SendMessageParams) => Promise<Message>;
    sendReaction: (
        messageSerial: Serial,
        params: AddMessageReactionParams,
    ) => Promise<void>;
    update: (
        serial: Serial,
        updateParams: UpdateMessageParams,
        details?: OperationDetails,
    ) => Promise<Message>;
}

Hierarchy (View Summary)

ChatStatusResponse
- UseMessagesResponse

Index

Properties

connectionError? connectionStatus deleteMessage deleteReaction history historyBeforeSubscribe? messages? roomError? roomStatus send sendReaction update

Properties

`Optional` `Readonly`connectionError

connectionError?: ErrorInfo

If there's a connection error it will be available here.

`Readonly`connectionStatus

connectionStatus: ConnectionStatus

Provides the connection status of the Ably connection.

`Readonly`deleteMessage

deleteMessage: (
serial: Serial,
deleteMessageParams?: DeleteMessageParams,
) => Promise<Message>

A shortcut to the Messages.delete method.

Type declaration

- (serial: Serial, deleteMessageParams?: DeleteMessageParams): Promise<Message>
- 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.
  
  NOTE: The Message instance returned by this method is the state of the message as a result of the delete operation. If you have a subscription to message events via subscribe, you should discard the message instance returned by this method and use the event payloads from the subscription instead.
  
  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.
  Parameters
  - serial: Serial
    A string or object that conveys the serial of the message to delete.
  - OptionaldeleteMessageParams: DeleteMessageParams
    Optional details to record about the delete action.
  Returns Promise<Message>
  A promise that resolves when the message was deleted.

`Readonly`deleteReaction

deleteReaction: (
messageSerial: Serial,
params?: DeleteMessageReactionParams,
) => Promise<void>

A shortcut to the MessagesReactions.delete method.

Type declaration

- (messageSerial: Serial, params?: DeleteMessageReactionParams): Promise<void>
- Delete a message reaction
  Parameters
  - messageSerial: Serial
    The serial of the message to remove the reaction from.
  - Optionalparams: DeleteMessageReactionParams
    The type of reaction annotation and the specific reaction to remove. The reaction to remove is required for all types except MessageReactionType.Unique.
  Returns Promise<void>
  A promise that resolves when the reaction is deleted.

`Readonly`history

history: (options: QueryOptions) => Promise<PaginatedResult<Message>>

A shortcut to the Messages.history method.

Type declaration

- (options: QueryOptions): Promise<PaginatedResult<Message>>
- Get messages that have been previously sent to the chat room, based on the provided options.
  Parameters
  - options: QueryOptions
    Options for the query.
  Returns Promise<PaginatedResult<Message>>
  A promise that resolves with the paginated result of messages. This paginated result can be used to fetch more messages if available.

`Optional` `Readonly`historyBeforeSubscribe

historyBeforeSubscribe?: (
params: Omit<QueryOptions, "orderBy">,
) => Promise<PaginatedResult<Message>>

Retrieves 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 newest-to-oldest 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.

Type declaration

- (params: Omit<QueryOptions, "orderBy">): Promise<PaginatedResult<Message>>
- Get the previous messages that were sent to the room before the listener was subscribed.
  
  If the client experiences a discontinuity event (i.e. the connection was lost and could not be resumed), the starting point of historyBeforeSubscribe will be reset.
  
  Calls to historyBeforeSubscribe will wait for continuity to be restored before resolving.
  
  Once continuity is restored, the subscription point will be set to the beginning of this new period of continuity. To ensure that no messages are missed, you should call historyBeforeSubscribe after any period of discontinuity to fill any gaps in the message history.
```
const { historyBeforeSubscribe } = room.messages.subscribe(listener);
await historyBeforeSubscribe({ limit: 10 });
```
  Parameters
  - params: Omit<QueryOptions, "orderBy">
    Options for the history query.
  Returns Promise<PaginatedResult<Message>>
  A promise that resolves with the paginated result of messages, in newest-to-oldest order.

Param: options

The query options to use when fetching the previous messages.

Default Value

This will be undefined if no listener is provided in the UseMessagesParams.

`Optional` `Readonly`messages

messages?: Messages

Provides access to the underlying Messages instance of the room.

`Optional` `Readonly`roomError

roomError?: ErrorInfo

If there's an error with the room it will be available here.

`Readonly`roomStatus

roomStatus: RoomStatus

Provides the status of the room.

`Readonly`send

send: (params: SendMessageParams) => Promise<Message>

A shortcut to the Messages.send method.

Type declaration

- (params: SendMessageParams): Promise<Message>
- 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.
  Parameters
  - params: SendMessageParams
    an object containing {text, headers, metadata} for the message to be sent. Text is required, metadata and headers are optional.
  Returns Promise<Message>
  A promise that resolves when the message was published.

`Readonly`sendReaction

sendReaction: (
messageSerial: Serial,
params: AddMessageReactionParams,
) => Promise<void>

A shortcut to the MessagesReactions.send method.

Type declaration

- (messageSerial: Serial, params: AddMessageReactionParams): Promise<void>
- Add a message reactions
  Parameters
  - messageSerial: Serial
    The serial of the message to react to
  - params: AddMessageReactionParams
    Describe the reaction to add.
  Returns Promise<void>
  A promise that resolves when the reaction is added.

`Readonly`update

update: (
    serial: Serial,
    updateParams: UpdateMessageParams,
    details?: OperationDetails,
) => Promise<Message>

A shortcut to the Messages.update method.

Type declaration

- (
      serial: Serial,
      updateParams: UpdateMessageParams,
      details?: OperationDetails,
  ): Promise<Message>
- 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.
  
  NOTE: The Message instance returned by this method is the state of the message as a result of the update operation. If you have a subscription to message events via subscribe, you should discard the message instance returned by this method and use the event payloads from the subscription instead.
  
  This method uses PUT-like semantics: if headers and metadata are omitted from the updateParams, then the existing headers and metadata are replaced with the empty objects.
  Parameters
  - serial: Serial
    A string or object that conveys the serial of the message to update.
  - updateParams: UpdateMessageParams
    The parameters for updating the message.
  - Optionaldetails: OperationDetails
    Optional details to record about the update action.
  Returns Promise<Message>
  A promise of the updated message.

Interface UseMessagesResponse

Hierarchy (View Summary)

Index

Properties

Properties

Optional ReadonlyconnectionError

ReadonlyconnectionStatus

ReadonlydeleteMessage

Type declaration

Parameters

Returns Promise<Message>

ReadonlydeleteReaction

Type declaration

Parameters

Returns Promise<void>

Readonlyhistory

Type declaration

Parameters

Returns Promise<PaginatedResult<Message>>

Optional ReadonlyhistoryBeforeSubscribe

Type declaration

Parameters

Returns Promise<PaginatedResult<Message>>

Param: options

Default Value

Optional Readonlymessages

Optional ReadonlyroomError

ReadonlyroomStatus

Readonlysend

Type declaration

Parameters

Returns Promise<Message>

ReadonlysendReaction

Type declaration

Parameters

Returns Promise<void>

Readonlyupdate

Type declaration

Parameters

Returns Promise<Message>

Settings

On This Page

`Optional` `Readonly`connectionError

`Readonly`connectionStatus

`Readonly`deleteMessage

`Readonly`deleteReaction

`Readonly`history

`Optional` `Readonly`historyBeforeSubscribe

`Optional` `Readonly`messages

`Optional` `Readonly`roomError

`Readonly`roomStatus

`Readonly`send

`Readonly`sendReaction

`Readonly`update