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

HypeTrainBegin

data class HypeTrainBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val total: Int, val progress: Int, val goal: Int, val topContributions: List<HypeTrainContribution>, val lastContribution: HypeTrainContribution?, val level: Int, val startedAt: Instant, val expiresAt: Instant, val isGoldenKappaTrain: Boolean = false, val allTimeHighLevel: Int = 0, val allTimeHighTotal: Int = 0) : TwitchEvent

Twitch EventSub: channel.hype_train.begin v2

Points are earned from viewer contributions:

Bits: 1 bit = 1 point
Tier 1 sub: 500 points
Tier 2 sub: 1,000 points
Tier 3 sub: 2,500 points

Gift subs contribute at their respective tier's point value per recipient.

Constructors

constructor(subscriptionType: String, messageId: String, timestamp: Instant, id: String, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, total: Int, progress: Int, goal: Int, topContributions: List<HypeTrainContribution>, lastContribution: HypeTrainContribution?, level: Int, startedAt: Instant, expiresAt: Instant, isGoldenKappaTrain: Boolean = false, allTimeHighLevel: Int = 0, allTimeHighTotal: Int = 0)

Properties

allTimeHighLevel

val allTimeHighLevel: Int

the all-time highest level reached on this channel (v2).

allTimeHighTotal

val allTimeHighTotal: Int

the all-time highest total points on this channel (v2).

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 expiresAt: Instant

the time when the Hype Train expires; extended when it reaches a new level.

the number of points required to reach the next level.

the Hype Train ID.

isGoldenKappaTrain

val isGoldenKappaTrain: Boolean

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

lastContribution

val lastContribution: HypeTrainContribution?

the most recent contribution with user_id, type, and total.

the starting level of the Hype Train.

open override val messageId: String

Unique ID for this EventSub message.

val progress: Int

the number of points contributed at the current level.

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.