Struct twitch_api2::helix::points::CreateCustomRewardBody

#[non_exhaustive]
pub struct CreateCustomRewardBody {

    pub title: String,
    pub prompt: Option<String>,
    pub cost: usize,
    pub is_enabled: Option<bool>,
    pub background_color: Option<String>,
    pub is_user_input_required: Option<bool>,
    pub is_max_per_stream_enabled: Option<bool>,
    pub max_per_stream: Option<usize>,
    pub is_max_per_user_per_stream_enabled: Option<bool>,
    pub max_per_user_per_stream: Option<usize>,
    pub is_global_cooldown_enabled: Option<bool>,
    pub global_cooldown_seconds: Option<usize>,
    pub should_redemptions_skip_request_queue: Option<bool>,
}

This is supported on crate feature helix only.

Body Parameters for Create Custom Rewards

create-custom-rewards

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.

title: String

The title of the reward

prompt: Option<String>

The prompt for the viewer when they are redeeming the reward

cost: usize

The cost of the reward

is_enabled: Option<bool>

Is the reward currently enabled, if false the reward won’t show up to viewers. Defaults true

background_color: Option<String>

Custom background color for the reward. Format: Hex with # prefix. Example: #00E5CB.

is_user_input_required: Option<bool>

Does the user need to enter information when redeeming the reward. Defaults false

is_max_per_stream_enabled: Option<bool>

Whether a maximum per stream is enabled. Defaults to false.

max_per_stream: Option<usize>

The maximum number per stream if enabled

is_max_per_user_per_stream_enabled: Option<bool>

Whether a maximum per user per stream is enabled. Defaults to false.

max_per_user_per_stream: Option<usize>

The maximum number per user per stream if enabled

is_global_cooldown_enabled: Option<bool>

Whether a cooldown is enabled. Defaults to false.

global_cooldown_seconds: Option<usize>

The cooldown in seconds if enabled

should_redemptions_skip_request_queue: Option<bool>

Should redemptions be set to FULFILLED status immediately when redeemed and skip the request queue instead of the normal UNFULFILLED status. Defaults false

Implementations

impl CreateCustomRewardBody

pub fn builder(
) -> CreateCustomRewardBodyBuilder<((), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building CreateCustomRewardBody. On the builder, call .title(...), .prompt(...)(optional), .cost(...), .is_enabled(...)(optional), .background_color(...)(optional), .is_user_input_required(...)(optional), .is_max_per_stream_enabled(...)(optional), .max_per_stream(...)(optional), .is_max_per_user_per_stream_enabled(...)(optional), .max_per_user_per_stream(...)(optional), .is_global_cooldown_enabled(...)(optional), .global_cooldown_seconds(...)(optional), .should_redemptions_skip_request_queue(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateCustomRewardBody.

Trait Implementations

impl Clone for CreateCustomRewardBody

fn clone(&self) -> CreateCustomRewardBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCustomRewardBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateCustomRewardBody

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<CreateCustomRewardBody> for CreateCustomRewardBody

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

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

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

This method tests for !=.

impl Serialize for CreateCustomRewardBody

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateCustomRewardBody