helix/io.github.captnblubber.twitchkt.helix.model/HypeTrainCurrent

HypeTrainCurrent

@Serializable

data class HypeTrainCurrent(val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val level: Int, val total: Int, val progress: Int, val goal: Int, val topContributions: List<HypeTrainContribution> = emptyList(), val sharedTrainParticipants: List<SharedTrainParticipant>? = null, val startedAt: Instant, val expiresAt: Instant, val type: String, val isSharedTrain: Boolean = false)

Represents a currently active Hype Train.

Constructors

HypeTrainCurrent

constructor(id: String, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, level: Int, total: Int, progress: Int, goal: Int, topContributions: List<HypeTrainContribution> = emptyList(), sharedTrainParticipants: List<SharedTrainParticipant>? = null, startedAt: Instant, expiresAt: Instant, type: String, isSharedTrain: Boolean = false)

Properties

broadcasterUserId

@SerialName(value = "broadcaster_user_id")

val broadcasterUserId: String

the broadcaster ID.

broadcasterUserLogin

@SerialName(value = "broadcaster_user_login")

val broadcasterUserLogin: String

the broadcaster login.

broadcasterUserName

@SerialName(value = "broadcaster_user_name")

val broadcasterUserName: String

the broadcaster display name.

@SerialName(value = "expires_at")

val expiresAt: Instant

the time when the Hype Train expires. The expiration is extended when the Hype Train reaches a new level.

the number of points required to reach the next level.

the Hype Train ID.

@SerialName(value = "is_shared_train")

val isSharedTrain: Boolean

indicates if the Hype Train is shared. When true, sharedTrainParticipants will contain the list of broadcasters the train is shared with.

the current level of the Hype Train.

val progress: Int

the number of points contributed to the Hype Train at the current level.

sharedTrainParticipants

@SerialName(value = "shared_train_participants")

val sharedTrainParticipants: List<SharedTrainParticipant>?

a list containing the broadcasters participating in the shared Hype Train. null if the Hype Train is not shared.

@SerialName(value = "started_at")

val startedAt: Instant

the time when the Hype Train started.

topContributions

@SerialName(value = "top_contributions")

val topContributions: List<HypeTrainContribution>

the contributors with the most points contributed.

total points contributed to the Hype Train.

val type: String

the type of the Hype Train. Possible values are: treasure, golden_kappa, regular.