Struct twitch_api::helix::points::CreateCustomRewardBody
source · [−]#[non_exhaustive]pub struct CreateCustomRewardBody<'a> {Show 13 fields
pub title: Cow<'a, str>,
pub prompt: Option<Cow<'a, str>>,
pub cost: usize,
pub is_enabled: Option<bool>,
pub background_color: Option<Cow<'a, str>>,
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>,
}
helix
only.Expand description
Body Parameters for Create Custom Rewards
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.title: Cow<'a, str>
The title of the reward
prompt: Option<Cow<'a, str>>
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<Cow<'a, str>>
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
sourceimpl<'a> CreateCustomRewardBody<'a>
impl<'a> CreateCustomRewardBody<'a>
sourcepub fn builder(
) -> CreateCustomRewardBodyBuilder<'a, ((), (), (), (), (), (), (), (), (), (), (), (), ())>
pub fn builder(
) -> CreateCustomRewardBodyBuilder<'a, ((), (), (), (), (), (), (), (), (), (), (), (), ())>
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
sourceimpl<'a> Clone for CreateCustomRewardBody<'a>
impl<'a> Clone for CreateCustomRewardBody<'a>
sourcefn clone(&self) -> CreateCustomRewardBody<'a>
fn clone(&self) -> CreateCustomRewardBody<'a>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'a> Debug for CreateCustomRewardBody<'a>
impl<'a> Debug for CreateCustomRewardBody<'a>
sourceimpl<'de: 'a, 'a> Deserialize<'de> for CreateCustomRewardBody<'a>
impl<'de: 'a, 'a> Deserialize<'de> for CreateCustomRewardBody<'a>
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl<'a> PartialEq<CreateCustomRewardBody<'a>> for CreateCustomRewardBody<'a>
impl<'a> PartialEq<CreateCustomRewardBody<'a>> for CreateCustomRewardBody<'a>
sourcefn eq(&self, other: &CreateCustomRewardBody<'a>) -> bool
fn eq(&self, other: &CreateCustomRewardBody<'a>) -> bool
sourceimpl<'a> Serialize for CreateCustomRewardBody<'a>
impl<'a> Serialize for CreateCustomRewardBody<'a>
impl<'a> Eq for CreateCustomRewardBody<'a>
impl<'a> StructuralEq for CreateCustomRewardBody<'a>
impl<'a> StructuralPartialEq for CreateCustomRewardBody<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for CreateCustomRewardBody<'a>
impl<'a> Send for CreateCustomRewardBody<'a>
impl<'a> Sync for CreateCustomRewardBody<'a>
impl<'a> Unpin for CreateCustomRewardBody<'a>
impl<'a> UnwindSafe for CreateCustomRewardBody<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.sourceimpl<T> HelixRequestBody for Twhere
T: Serialize + SealedSerialize,
impl<T> HelixRequestBody for Twhere
T: Serialize + SealedSerialize,
sourcefn try_to_body(&self) -> Result<Bytes, BodyError>
fn try_to_body(&self) -> Result<Bytes, BodyError>
helix
only.