ChatMessage

Properties

• bits
• channelId
• date
• emoteOffsets
• hypeChatAmount
• hypeChatCurrency
• hypeChatDecimalPlaces
• hypeChatIsSystemMessage
• hypeChatLevel
• hypeChatLocalizedAmount
• id
• isCheer
• isFirst
• isHighlight
• isHypeChat
• isRedemption
• isReply
• isReturningChatter
• parentMessageId
• parentMessageText
• parentMessageUserDisplayName
• parentMessageUserId
• parentMessageUserName
• rewardId
• threadMessageId
• threadMessageUserId
• userInfo

The number of bits cheered with the message.

The ID of the channel the message is in.

The date the message was sent at.

The offsets of emote usages in the message.

The amount of money that was sent for Hype Chat, specified in the currency’s minor unit, or null if the message is not a Hype Chat.

For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.

The ISO-4217 three-letter currency code that identifies the currency used for Hype Chat, or null if the message is not a Hype Chat.

The number of decimal places used by the currency used for Hype Chat, or null if the message is not a Hype Chat.

For example, USD uses two decimal places. Use this number to translate hypeChatAmount from minor units to major units by using the formula:

value / 10^decimalPlaces

Whether the system filled in the message for the Hype Chat (because the user didn't type one), or null if the message is not a Hype Chat.

The level of the Hype Chat, or null if the message is not a Hype Chat.

The localized amount of money sent for Hype Chat, based on the value and the decimal places of the currency, or null if the message is not a Hype Chat.

For example, the minor units for USD is cents which uses two decimal places, so if value is 550, localizedValue is set to 5.50.

The ID of the message.

Whether the message is a cheer.

Whether the message is the first message of the chatter who sent it.

Whether the message is highlighted by using channel points.

Whether the message is a Hype Chat.

Whether the message represents a redemption of a custom channel points reward.

Whether the message is a reply to another message.

Whether the message is sent by a returning chatter.

Twitch defines this as a new viewer who has chatted at least twice in the last 30 days.

The ID of the message that this message is a reply to, or null if it's not a reply.

The text of the message that this message is a reply to, or null if it's not a reply.

The display name of the user that wrote the message that this message is a reply to, or null if it's not a reply.

The ID of the user that wrote the message that this message is a reply to, or null if it's not a reply.

The name of the user that wrote the message that this message is a reply to, or null if it's not a reply.

The ID of the redeemed reward, or null if the message does not represent a redemption.

The ID of the message that is the thread starter of this message, or null if it's not a reply.

The ID of the user that wrote the thread starter message of this message, or null if it's not a reply.

Info about the user that send the message, like their user ID and their status in the current channel.