Skip to main content

chatHistory

Emitted in response to meeting.getChatHistory(...)

This event is emitted with a page of past chat messages after you call meeting.getChatHistory(...).

JavaScript
meeting.on("chatHistory", function(chatHistory) {

});

Properties

chatHistory is an object that contains the following properties:

PropertyDescription
chatRoomIdID of the chat room, or null
beforeThe cursor you requested, or null for the initial page
messagesArray of message objects, oldest first. Each has the same shape as the chatMessageReceived payload
historyEnabledBoolean. false when the room stores no history (retention Off), in which case messages is served from the SDK's in-session buffer

To page backwards through older messages, call meeting.getChatHistory(...) again with the created and _id of messages[0].