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

ChannelShoutoutReceive

data class ChannelShoutoutReceive(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val fromBroadcasterUserId: String, val fromBroadcasterUserLogin: String, val fromBroadcasterUserName: String, val viewerCount: Int, val startedAt: Instant) : TwitchEvent

Twitch EventSub: channel.shoutout.receive

Constructors

ChannelShoutoutReceive

constructor(subscriptionType: String, messageId: String, timestamp: Instant, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, fromBroadcasterUserId: String, fromBroadcasterUserLogin: String, fromBroadcasterUserName: String, viewerCount: 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.

fromBroadcasterUserId

val fromBroadcasterUserId: String

the user ID of the broadcaster who sent the shoutout.

fromBroadcasterUserLogin

val fromBroadcasterUserLogin: String

the login of the broadcaster who sent the shoutout.

fromBroadcasterUserName

val fromBroadcasterUserName: String

the display name of the broadcaster who sent the shoutout.

open override val messageId: String

Unique ID for this EventSub message.

val startedAt: Instant

RFC3339 timestamp of when the shoutout was received.

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.

val viewerCount: Int

the number of viewers at the time of the shoutout.