helix/io.github.captnblubber.twitchkt.helix.model/CustomReward

CustomReward

@Serializable

data class CustomReward(val broadcasterId: String, val broadcasterLogin: String, val broadcasterName: String, val id: String, val title: String, val prompt: String = "", val cost: Int, val image: RewardImage? = null, val defaultImage: RewardImage? = null, val backgroundColor: String = "", val isEnabled: Boolean = true, val isUserInputRequired: Boolean = false, val maxPerStreamSetting: MaxPerStreamSetting = MaxPerStreamSetting(), val maxPerUserPerStreamSetting: MaxPerUserPerStreamSetting = MaxPerUserPerStreamSetting(), val globalCooldownSetting: GlobalCooldownSetting = GlobalCooldownSetting(), val isPaused: Boolean = false, val isInStock: Boolean = true, val shouldRedemptionsSkipRequestQueue: Boolean = false, val redemptionsRedeemedCurrentStream: Int? = null, val cooldownExpiresAt: Instant? = null)

Twitch API: Get Custom Reward

Constructors

constructor(broadcasterId: String, broadcasterLogin: String, broadcasterName: String, id: String, title: String, prompt: String = "", cost: Int, image: RewardImage? = null, defaultImage: RewardImage? = null, backgroundColor: String = "", isEnabled: Boolean = true, isUserInputRequired: Boolean = false, maxPerStreamSetting: MaxPerStreamSetting = MaxPerStreamSetting(), maxPerUserPerStreamSetting: MaxPerUserPerStreamSetting = MaxPerUserPerStreamSetting(), globalCooldownSetting: GlobalCooldownSetting = GlobalCooldownSetting(), isPaused: Boolean = false, isInStock: Boolean = true, shouldRedemptionsSkipRequestQueue: Boolean = false, redemptionsRedeemedCurrentStream: Int? = null, cooldownExpiresAt: Instant? = null)

Properties

backgroundColor

@SerialName(value = "background_color")

val backgroundColor: String

the background color of the reward in hex format (e.g., #FA1ED2).

@SerialName(value = "broadcaster_id")

val broadcasterId: String

an ID that uniquely identifies the broadcaster.

broadcasterLogin

@SerialName(value = "broadcaster_login")

val broadcasterLogin: String

the broadcaster's login name.

broadcasterName

@SerialName(value = "broadcaster_name")

val broadcasterName: String

the broadcaster's display name.

cooldownExpiresAt

@SerialName(value = "cooldown_expires_at")

val cooldownExpiresAt: Instant?

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

the cost of the reward in Channel Points.

@SerialName(value = "default_image")

val defaultImage: RewardImage?

a set of default images for the reward.

globalCooldownSetting

@SerialName(value = "global_cooldown_setting")

val globalCooldownSetting: GlobalCooldownSetting

the settings for the cooldown period between redemptions.

an ID that uniquely identifies this custom reward.

val image: RewardImage?

a set of custom images for the reward; null if no custom images were uploaded.

@SerialName(value = "is_enabled")

val isEnabled: Boolean

whether the reward is enabled; viewers see only enabled rewards.

@SerialName(value = "is_in_stock")

val isInStock: Boolean

whether the reward is currently in stock.

@SerialName(value = "is_paused")

val isPaused: Boolean

whether the reward is currently paused.

isUserInputRequired

@SerialName(value = "is_user_input_required")

val isUserInputRequired: Boolean

whether the user must enter information when redeeming the reward.

maxPerStreamSetting

@SerialName(value = "max_per_stream_setting")

val maxPerStreamSetting: MaxPerStreamSetting

the settings for the maximum number of redemptions per live stream.

maxPerUserPerStreamSetting

@SerialName(value = "max_per_user_per_stream_setting")

val maxPerUserPerStreamSetting: MaxPerUserPerStreamSetting

the settings for the maximum number of redemptions per user per stream.

val prompt: String

the prompt shown to the viewer when they redeem the reward.

redemptionsRedeemedCurrentStream

@SerialName(value = "redemptions_redeemed_current_stream")

val redemptionsRedeemedCurrentStream: Int?

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

shouldRedemptionsSkipRequestQueue

@SerialName(value = "should_redemptions_skip_request_queue")

val shouldRedemptionsSkipRequestQueue: Boolean

whether redemptions are set to FULFILLED automatically rather than entering the request queue.

val title: String

the reward's title.