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

ChannelAdBreakBegin

data class ChannelAdBreakBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val durationSeconds: Int, val startedAt: Instant, val isAutomatic: Boolean, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val requesterUserId: String, val requesterUserLogin: String, val requesterUserName: String) : TwitchEvent

Twitch EventSub: channel.ad_break.begin

Constructors

ChannelAdBreakBegin

constructor(subscriptionType: String, messageId: String, timestamp: Instant, durationSeconds: Int, startedAt: Instant, isAutomatic: Boolean, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, requesterUserId: String, requesterUserLogin: String, requesterUserName: String)

Properties

broadcasterUserId

val broadcasterUserId: String

the broadcaster's user ID for the channel the ad was run on.

broadcasterUserLogin

val broadcasterUserLogin: String

the broadcaster's login for the channel the ad was run on.

broadcasterUserName

val broadcasterUserName: String

the broadcaster's display name for the channel the ad was run on.

durationSeconds

val durationSeconds: Int

length in seconds of the mid-roll ad break requested.

val isAutomatic: Boolean

whether the ad was automatically scheduled via Ads Manager.

open override val messageId: String

Unique ID for this EventSub message.

requesterUserId

val requesterUserId: String

the ID of the user that requested the ad. For automatic ads, this is the broadcaster's ID.

requesterUserLogin

val requesterUserLogin: String

the login of the user that requested the ad.

requesterUserName

val requesterUserName: String

the display name of the user that requested the ad.

val startedAt: Instant

the UTC timestamp (RFC3339) of when the ad break began.

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.