Skip to content

ChatMessageInstance

ChatMessageInstance is a class returned from a chat message event. It encapsulates data about the message and includes methods to assist with interacting with the specified message event.

Properties

data

Returns

ChatMessageEvent

Methods

chatterIs(chatterStatus)

Check if the user in chat has a specified status. This method checks the badges displayed in chat, and if a certain badge is hidden by the user, it will not return true, even though the user may be a part of this group.

ParameterTypeRequiredDefaultDescription
chatterStatusChatterStatus | stringtrueThe status type you want to check against the user

Returns

boolean


Authentication Required async deleteMessage()

Deletes the message.

Returns

Promise<GenericApiResponse<null>>