Interface MessageSubscriptionResponse

A response object that allows you to control a message subscription.

interface MessageSubscriptionResponse {
unsubscribe: (() => void);
getPreviousMessages(params: Omit<QueryOptions, "direction">): Promise<PaginatedResult<Message>>;
}

Index

Properties

Methods

getPreviousMessages

Properties

unsubscribe

unsubscribe: (() => void)

Unsubscribe the listener registered with Messages.subscribe from message events.

Methods

getPreviousMessages

getPreviousMessages(params): Promise<PaginatedResult<Message>>
Get the previous messages that were sent to the room before the listener was subscribed.
Parameters
- params: Omit<QueryOptions, "direction">
  Options for the history query.
Returns Promise<PaginatedResult<Message>>
A promise that resolves with the paginated result of messages, in newest-to-oldest order.
- Defined in src/core/messages.ts:189