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

ChannelChatNotification

data class ChannelChatNotification(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 noticeType: String, val message: ChatMessage, val sub: SubNotification?, val resub: ResubNotification?, val subGift: SubGiftNotification?, val communitySubGift: CommunitySubGiftNotification?, val giftPaidUpgrade: GiftPaidUpgradeNotification?, val primePaidUpgrade: PrimePaidUpgradeNotification?, val payItForward: PayItForwardNotification?, val raid: RaidNotification?, val unraid: JsonObject?, val announcement: AnnouncementNotification?, val bitsBadgeTier: BitsBadgeTierNotification?, val charityDonation: CharityDonationNotification?) : TwitchEvent

Twitch EventSub: channel.chat.notification

Constructors

constructor(subscriptionType: String, messageId: String, timestamp: Instant, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, chatterUserId: String, chatterUserLogin: String, chatterUserName: String, noticeType: String, message: ChatMessage, sub: SubNotification?, resub: ResubNotification?, subGift: SubGiftNotification?, communitySubGift: CommunitySubGiftNotification?, giftPaidUpgrade: GiftPaidUpgradeNotification?, primePaidUpgrade: PrimePaidUpgradeNotification?, payItForward: PayItForwardNotification?, raid: RaidNotification?, unraid: JsonObject?, announcement: AnnouncementNotification?, bitsBadgeTier: BitsBadgeTierNotification?, charityDonation: CharityDonationNotification?)

Properties

announcement

val announcement: AnnouncementNotification?

information about the announcement event. Null if noticeType is not announcement.

bitsBadgeTier

val bitsBadgeTier: BitsBadgeTierNotification?

information about the Bits badge tier event. Null if noticeType is not bits_badge_tier.

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.

charityDonation

val charityDonation: CharityDonationNotification?

information about the charity donation event. Null if noticeType is not charity_donation.

chatterUserId

val chatterUserId: String

the user ID of the user in the notification.

chatterUserLogin

val chatterUserLogin: String

the user login of the user in the notification.

chatterUserName

val chatterUserName: String

the user display name of the user in the notification.

communitySubGift

val communitySubGift: CommunitySubGiftNotification?

information about the community gift sub event. Null if noticeType is not community_sub_gift.

giftPaidUpgrade

val giftPaidUpgrade: GiftPaidUpgradeNotification?

information about the gift paid upgrade event. Null if noticeType is not gift_paid_upgrade.

message

val message: ChatMessage

the notification message text and fragments.

messageId

open override val messageId: String

Unique ID for this EventSub message.

noticeType

val noticeType: String

the type of notice: sub, resub, sub_gift, community_sub_gift, raid, announcement, etc.

payItForward

val payItForward: PayItForwardNotification?

information about the pay-it-forward event. Null if noticeType is not pay_it_forward.

primePaidUpgrade

val primePaidUpgrade: PrimePaidUpgradeNotification?

information about the Prime paid upgrade event. Null if noticeType is not prime_paid_upgrade.

raid

val raid: RaidNotification?

information about the raid event. Null if noticeType is not raid.

resub

val resub: ResubNotification?

information about the resub event. Null if noticeType is not resub.

sub

val sub: SubNotification?

information about the sub event. Null if noticeType is not sub.

subGift

val subGift: SubGiftNotification?

information about the gift sub event. Null if noticeType is not sub_gift.

subscriptionType

open override val subscriptionType: String

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

timestamp

open override val timestamp: Instant

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

unraid

val unraid: JsonObject?

information about the unraid event. Null if noticeType is not unraid.