eventsub/io.github.captnblubber.twitchkt.eventsub.model/ChannelChatMessage

ChannelChatMessage

data class ChannelChatMessage(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val chatterUserId: String, val chatterUserLogin: String, val chatterUserName: String, val chatMessageId: String, val message: ChatMessage, val color: String, val badges: List<ChatBadge>, val messageType: ChatMessageType, val cheer: ChatCheer?, val reply: ChatReply?, val channelPointsCustomRewardId: String?) : TwitchEvent

Twitch EventSub: channel.chat.message

Constructors

ChannelChatMessage

constructor(subscriptionType: String, messageId: String, timestamp: Instant, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, chatterUserId: String, chatterUserLogin: String, chatterUserName: String, chatMessageId: String, message: ChatMessage, color: String, badges: List<ChatBadge>, messageType: ChatMessageType, cheer: ChatCheer?, reply: ChatReply?, channelPointsCustomRewardId: String?)

Properties

val badges: List<ChatBadge>

list of chat badges worn by the chatter.

broadcasterUserId

val broadcasterUserId: String

the broadcaster's user ID.

broadcasterUserLogin

val broadcasterUserLogin: String

the broadcaster's login.

broadcasterUserName

val broadcasterUserName: String

the broadcaster's display name.

channelPointsCustomRewardId

val channelPointsCustomRewardId: String?

the ID of a channel points custom reward that was redeemed; null if not a reward redemption.

val chatMessageId: String

a UUID that identifies the message.

val chatterUserId: String

the user ID of the user that sent the message.

chatterUserLogin

val chatterUserLogin: String

the user login of the user that sent the message.

chatterUserName

val chatterUserName: String

the user display name of the user that sent the message.

val cheer: ChatCheer?

cheer metadata if the message includes a cheer; null otherwise.

val color: String

the color of the user's name in the chat room. Empty string if not set.

val message: ChatMessage

the structured chat message, containing text and fragments.

open override val messageId: String

Unique ID for this EventSub message.

val messageType: ChatMessageType

the type of message.

val reply: ChatReply?

reply metadata if this message is a reply to another message; null otherwise.

subscriptionType

open override val subscriptionType: String

The EventSub subscription type string (e.g. channel.follow).

open override val timestamp: Instant

The Instant when the EventSub notification was sent, parsed from ISO-8601.