Overview
Properties
channelId
Type: string
The ID of the channel where the reward was redeemed.
defaultImage
Type: PubSubRedemptionMessageImageData
The default image set associated with the reward.
id
Type: string
The internal redemption ID.
message
Type: string
The full message that was sent with the notification.
redemptionDate
Type: Date
The date when the reward was redeemed.
rewardCost
Type: number
The cost of the reward, in channel points.
rewardId
Type: string
The ID of the reward.
rewardImage
Type: PubSubRedemptionMessageImageData
The image set associated with the reward.
rewardIsQueued
Type: boolean
Whether the reward gets added to the request queue.
rewardName
Type: string
The name of the reward.
rewardPrompt
Type: string
The prompt of the reward.
status
Type: PubSubRedemptionStatus
The status of the redemption.
userDisplayName
Type: string
The display name of the user that redeemed the reward.
userId
Type: string
The ID of the user that redeemed the reward.
userName
Type: string
The name of the user that redeemed the reward.
Methods
getChannel()
asyncRetrieves more information about the channel where the reward was redeemed.
getUser()
asyncRetrieves more information about the user.