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

ChannelCheer

data class ChannelCheer(val subscriptionType: String, val messageId: String, val timestamp: Instant, val isAnonymous: Boolean, val userId: String?, val userLogin: String?, val userName: String?, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val message: String, val bits: Int) : TwitchEvent

Twitch EventSub: channel.cheer

Constructors

constructor(subscriptionType: String, messageId: String, timestamp: Instant, isAnonymous: Boolean, userId: String?, userLogin: String?, userName: String?, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, message: String, bits: Int)

Properties

the number of Bits cheered.

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 isAnonymous: Boolean

whether the cheer was anonymous.

val message: String

the chat message sent with the cheer.

open override val messageId: String

Unique ID for this EventSub message.

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 userId: String?

the user ID of the user who cheered; null if anonymous.

val userLogin: String?

the login of the user who cheered; null if anonymous.

val userName: String?

the display name of the user who cheered; null if anonymous.