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

ChannelPointsCustomRewardAdd

data class ChannelPointsCustomRewardAdd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val isEnabled: Boolean, val isPaused: Boolean, val isInStock: Boolean, val title: String, val cost: Int, val prompt: String, val isUserInputRequired: Boolean, val shouldRedemptionsSkipRequestQueue: Boolean, val maxPerStream: MaxPerStreamSetting, val maxPerUserPerStream: MaxPerStreamSetting, val backgroundColor: String, val image: RewardImage?, val defaultImage: RewardImage, val globalCooldown: GlobalCooldownSetting, val cooldownExpiresAt: Instant?, val redemptionsRedeemedCurrentStream: Int?) : TwitchEvent

Twitch EventSub: channel.channel_points_custom_reward.add

Constructors

ChannelPointsCustomRewardAdd

constructor(subscriptionType: String, messageId: String, timestamp: Instant, id: String, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, isEnabled: Boolean, isPaused: Boolean, isInStock: Boolean, title: String, cost: Int, prompt: String, isUserInputRequired: Boolean, shouldRedemptionsSkipRequestQueue: Boolean, maxPerStream: MaxPerStreamSetting, maxPerUserPerStream: MaxPerStreamSetting, backgroundColor: String, image: RewardImage?, defaultImage: RewardImage, globalCooldown: GlobalCooldownSetting, cooldownExpiresAt: Instant?, redemptionsRedeemedCurrentStream: Int?)

Properties

backgroundColor

val backgroundColor: String

the reward background color.

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.

cooldownExpiresAt

val cooldownExpiresAt: Instant?

RFC3339 timestamp of when the cooldown expires; null if not on cooldown.

the reward cost in channel points.

val defaultImage: RewardImage

the default image URLs.

val globalCooldown: GlobalCooldownSetting

global cooldown settings.

the reward ID.

val image: RewardImage?

the reward image URLs.

val isEnabled: Boolean

whether the reward is enabled.

val isInStock: Boolean

whether the reward is in stock.

val isPaused: Boolean

whether the reward is paused.

isUserInputRequired

val isUserInputRequired: Boolean

whether user input is required.

val maxPerStream: MaxPerStreamSetting

max per stream settings.

maxPerUserPerStream

val maxPerUserPerStream: MaxPerStreamSetting

max per user per stream settings.

open override val messageId: String

Unique ID for this EventSub message.

val prompt: String

the reward prompt.

redemptionsRedeemedCurrentStream

val redemptionsRedeemedCurrentStream: Int?

number of redemptions in the current stream; null if not live.

shouldRedemptionsSkipRequestQueue

val shouldRedemptionsSkipRequestQueue: Boolean

whether redemptions skip the request queue.

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 title: String

the reward title.