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

ChannelGoalBegin

data class ChannelGoalBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val type: String, val description: String, val currentAmount: Int, val targetAmount: Int, val startedAt: Instant) : TwitchEvent

Twitch EventSub: channel.goal.begin

Constructors

ChannelGoalBegin

constructor(subscriptionType: String, messageId: String, timestamp: Instant, id: String, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, type: String, description: String, currentAmount: Int, targetAmount: Int, startedAt: Instant)

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 currentAmount: Int

the current progress toward the goal.

val description: String

the goal description.

the goal ID.

open override val messageId: String

Unique ID for this EventSub message.

val startedAt: Instant

RFC3339 timestamp of when the goal started.

subscriptionType

open override val subscriptionType: String

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

val targetAmount: Int

the target amount for the goal.

open override val timestamp: Instant

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

val type: String

the goal type (e.g. follower, subscription, subscription_count, new_subscription, new_subscription_count).