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

ChannelPointsRedemptionAdd

data class ChannelPointsRedemptionAdd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val userInput: String, val status: String, val reward: ChannelPointsReward, val redeemedAt: Instant) : TwitchEvent

Twitch EventSub: channel.channel_points_custom_reward_redemption.add

Constructors

ChannelPointsRedemptionAdd

constructor(subscriptionType: String, messageId: String, timestamp: Instant, id: String, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, userId: String, userLogin: String, userName: String, userInput: String, status: String, reward: ChannelPointsReward, redeemedAt: Instant)

Properties

broadcasterUserId

val broadcasterUserId: String

the ID of the channel where the reward was redeemed.

broadcasterUserLogin

val broadcasterUserLogin: String

the login of the channel where the reward was redeemed.

broadcasterUserName

val broadcasterUserName: String

the display name of the channel where the reward was redeemed.

the redemption identifier.

open override val messageId: String

Unique ID for this EventSub message.

val redeemedAt: Instant

RFC3339 timestamp of when the reward was redeemed.

val reward: ChannelPointsReward

the reward details including id, title, cost, and prompt.

val status: String

the redemption status. For add events, this is always unfulfilled.

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 ID of the user who redeemed the reward.

val userInput: String

the user input provided when redeeming the reward. Empty string if not required.

val userLogin: String

the login of the user who redeemed the reward.

val userName: String

the display name of the user who redeemed the reward.