Struct twitch_api2::pubsub::channel_points::Reward

#[non_exhaustive]pub struct Reward {
    pub background_color: String,
    pub channel_id: UserId,
    pub cooldown_expires_at: Option<Timestamp>,
    pub cost: u32,
    pub default_image: Option<Image>,
    pub global_cooldown: GlobalCooldown,
    pub id: RewardId,
    pub image: Option<Image>,
    pub is_enabled: bool,
    pub is_in_stock: bool,
    pub is_paused: bool,
    pub is_sub_only: bool,
    pub is_user_input_required: bool,
    pub max_per_stream: Max,
    pub max_per_user_per_stream: Max,
    pub prompt: String,
    pub redemptions_redeemed_current_stream: Option<u32>,
    pub should_redemptions_skip_request_queue: bool,
    pub template_id: Option<String>,
    pub title: String,
    pub updated_for_indicator_at: Option<Timestamp>,
}

This is supported on crate feature pubsub only.

Reward data

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct {{ .. }} syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

background_color: String

Color of background in rewards & challenges screen on client

channel_id: UserId

ID of channel where the redemption was triggered

cooldown_expires_at: Option<Timestamp>

Cooldown will expire after this timestamp

cost: u32

Cost of reward.

default_image: Option<Image>

Default image of reward in rewards & challenges screen on client

global_cooldown: GlobalCooldown

Information about global cooldown

id: RewardId

ID of reward.

image: Option<Image>

Set image of reward in rewards & challenges screen on client. If none, see Reward::default_image

is_enabled: bool

Reward is enabled or not.

is_in_stock: bool

Reward is in stock

is_paused: bool

Reward is paused

is_sub_only: bool

Reward is sub only

is_user_input_required: bool

Reward requires input from user on rewards & challenges screen on client

max_per_stream: Max

Maximum redemptions per stream

max_per_user_per_stream: Max

Maximum redemptions per user per stream

prompt: String

Prompt shown when clicking reward on rewards & challenges screen on client

redemptions_redeemed_current_stream: Option<u32>

Amount of times this has been redeemed this stream.

should_redemptions_skip_request_queue: bool

Does redemption skip queue?

template_id: Option<String>

Template ID

title: String

Title or Name of reward

updated_for_indicator_at: Option<Timestamp>

Unknown

Trait Implementations

impl Clone for Reward

fn clone(&self) -> Reward

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Reward

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reward

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Reward

impl PartialEq<Reward> for Reward

fn eq(&self, other: &Reward) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Reward) -> bool

This method tests for !=.

impl Serialize for Reward

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Reward

impl StructuralPartialEq for Reward