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

ChannelShoutoutCreate

data class ChannelShoutoutCreate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val toBroadcasterUserId: String, val toBroadcasterUserLogin: String, val toBroadcasterUserName: String, val viewerCount: Int, val startedAt: Instant, val cooldownEndsAt: Instant, val targetCooldownEndsAt: Instant) : TwitchEvent

Twitch EventSub: channel.shoutout.create

Constructors

ChannelShoutoutCreate

constructor(subscriptionType: String, messageId: String, timestamp: Instant, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, moderatorUserId: String, moderatorUserLogin: String, moderatorUserName: String, toBroadcasterUserId: String, toBroadcasterUserLogin: String, toBroadcasterUserName: String, viewerCount: Int, startedAt: Instant, cooldownEndsAt: Instant, targetCooldownEndsAt: 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 cooldownEndsAt: Instant

RFC3339 timestamp of when the shoutout cooldown ends.

open override val messageId: String

Unique ID for this EventSub message.

moderatorUserId

val moderatorUserId: String

the user ID of the moderator who created the shoutout.

moderatorUserLogin

val moderatorUserLogin: String

the login of the moderator who created the shoutout.

moderatorUserName

val moderatorUserName: String

the display name of the moderator who created the shoutout.

val startedAt: Instant

RFC3339 timestamp of when the shoutout started.

subscriptionType

open override val subscriptionType: String

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

targetCooldownEndsAt

val targetCooldownEndsAt: Instant

RFC3339 timestamp of when the target cooldown ends.

open override val timestamp: Instant

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

toBroadcasterUserId

val toBroadcasterUserId: String

the user ID of the broadcaster receiving the shoutout.

toBroadcasterUserLogin

val toBroadcasterUserLogin: String

the login of the broadcaster receiving the shoutout.

toBroadcasterUserName

val toBroadcasterUserName: String

the display name of the broadcaster receiving the shoutout.

val viewerCount: Int

the number of viewers at the time of the shoutout.