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

ChannelSubscriptionGift

data class ChannelSubscriptionGift(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String?, val userLogin: String?, val userName: String?, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val total: Int, val tier: String, val cumulativeTotal: Int?, val isAnonymous: Boolean) : TwitchEvent

Twitch EventSub: channel.subscription.gift

Constructors

ChannelSubscriptionGift

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

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.

cumulativeTotal

val cumulativeTotal: Int?

the number of gift subscriptions the gifter has given in this channel. Null if anonymous.

val isAnonymous: Boolean

whether the gift was anonymous.

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).

val tier: String

the tier of the subscription gift: 1000 (Tier 1), 2000 (Tier 2), or 3000 (Tier 3).

open override val timestamp: Instant

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

the number of subscriptions in the gift.

val userId: String?

the user ID of the user who sent the gift subscription. Null if anonymous.

val userLogin: String?

the user login of the user who sent the gift subscription. Null if anonymous.

val userName: String?

the user display name of the user who sent the gift subscription. Null if anonymous.