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

RewardRedemption

@Serializable

data class RewardRedemption(val broadcasterId: String, val broadcasterLogin: String, val broadcasterName: String, val id: String, val userId: String, val userLogin: String, val userName: String, val userInput: String = "", val status: String, val redeemedAt: Instant, val reward: RedeemedReward)

Represents a redemption of a custom channel point reward.

See also

Twitch API Reference - Get Custom Reward Redemption

Constructors

RewardRedemption

constructor(broadcasterId: String, broadcasterLogin: String, broadcasterName: String, id: String, userId: String, userLogin: String, userName: String, userInput: String = "", status: String, redeemedAt: Instant, reward: RedeemedReward)

Properties

@SerialName(value = "broadcaster_id")

val broadcasterId: String

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

the ID that uniquely identifies this redemption.

@SerialName(value = "redeemed_at")

val redeemedAt: Instant

the date and time of when the reward was redeemed, in RFC3339 format.

val reward: RedeemedReward

the reward that the user redeemed.

val status: String

the state of the redemption. Possible values are: CANCELED, FULFILLED, UNFULFILLED.

@SerialName(value = "user_id")

val userId: String

the ID that uniquely identifies the user that redeemed the reward.

@SerialName(value = "user_input")

val userInput: String

the text the user entered at the prompt when they redeemed the reward; otherwise, an empty string if user input was not required.

@SerialName(value = "user_login")

val userLogin: String

the user's login name.

@SerialName(value = "user_name")

val userName: String

the user's display name.