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

ChannelSubscriptionMessage

data class ChannelSubscriptionMessage(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val tier: String, val message: ChatMessage, val cumulativeMonths: Int, val streakMonths: Int?, val durationMonths: Int) : TwitchEvent

Twitch EventSub: channel.subscription.message

Constructors

ChannelSubscriptionMessage

constructor(subscriptionType: String, messageId: String, timestamp: Instant, userId: String, userLogin: String, userName: String, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, tier: String, message: ChatMessage, cumulativeMonths: Int, streakMonths: Int?, durationMonths: Int)

Properties

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.

cumulativeMonths

val cumulativeMonths: Int

the total number of months the user has been subscribed to the channel.

val durationMonths: Int

the month duration of the subscription.

val message: ChatMessage

an object containing the resubscription message text and emote information.

open override val messageId: String

Unique ID for this EventSub message.

val streakMonths: Int?

the number of consecutive months the user's current subscription has been active. Null if opted out.

subscriptionType

open override val subscriptionType: String

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

val tier: String

the tier of the user's subscription: 1000 (Tier 1), 2000 (Tier 2), or 3000 (Tier 3).

open override val timestamp: Instant

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

val userId: String

the user ID of the user who sent a resubscription chat message.

val userLogin: String

the user login of the user who sent a resubscription chat message.

val userName: String

the user display name of the user who sent a resubscription chat message.