getMessages

getMessages(params): Promise<{ cursor: PaginationCursor ; messages: ChatMessageEntity[] }> - See ChatMessageEntity for more details.

Returns the list of messages that were sent to the specified channel.

Parameters

Name	Type	Description
`params`	`Object`	-
`params.channel`	`string`	Channel for which to retrieve the messages.
`params.cursor?`	`PaginationCursor`	Cursor for pagination.

Returns

Promise<{ cursor: PaginationCursor ; messages: ChatMessageEntity[] }> - See ChatMessageEntity for more details.

Example

1 const m = await chatClient.getMessages({ channel: "chan1" });
2 
3 m.messages.length; // 23
4 m.messages[0]; // the most recent message
5 m.messages[0].member; // the sender
6 m.messages[0].content; // the content
7 m.messages[0].meta; // the metadata (if any)
8 
9 m.cursor.next; // if not null, there are more messages.
10 
11 // Get the next page using the cursor
12 const next = await chatClient.getMessages({
13   channel: "chan1",
14   cursor: {
15     after: m.cursor.after,
16   },
17 });