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

HypeTrainEnd

data class HypeTrainEnd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val level: Int, val total: Int, val topContributions: List<HypeTrainContribution>, val startedAt: Instant, val endedAt: Instant, val cooldownEndsAt: Instant, val isGoldenKappaTrain: Boolean = false) : TwitchEvent

Twitch EventSub: channel.hype_train.end v2

See HypeTrainBegin for how points are calculated from bits and subscriptions.

Constructors

constructor(subscriptionType: String, messageId: String, timestamp: Instant, id: String, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, level: Int, total: Int, topContributions: List<HypeTrainContribution>, startedAt: Instant, endedAt: Instant, cooldownEndsAt: Instant, isGoldenKappaTrain: Boolean = false)

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.

val cooldownEndsAt: Instant

the time when the Hype Train cooldown ends so the next one can start.

val endedAt: Instant

the time when the Hype Train ended.

the Hype Train ID.

isGoldenKappaTrain

val isGoldenKappaTrain: Boolean

whether the Hype Train was a Golden Kappa Train (v2).

the final level of the Hype Train.

open override val messageId: String

Unique ID for this EventSub message.

val startedAt: Instant

the time when the Hype Train started.

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.

topContributions

val topContributions: List<HypeTrainContribution>

the contributors with the most points, each with user_id, type, and total.

total points contributed to the Hype Train.