Struct twitch_api2::helix::points::create_custom_rewards::CreateCustomRewardBody [−][src]
#[non_exhaustive]pub struct CreateCustomRewardBody {}Show fields
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>,
helix
only.Body Parameters for Create Custom Rewards
Fields (Non-exhaustive)
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
[src]
impl CreateCustomRewardBody
[src]pub fn builder(
) -> CreateCustomRewardBodyBuilder<((), (), (), (), (), (), (), (), (), (), (), (), ())>
[src]
) -> 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
[src]
impl Clone for CreateCustomRewardBody
[src]fn clone(&self) -> CreateCustomRewardBody
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'de> Deserialize<'de> for CreateCustomRewardBody
[src]
impl<'de> Deserialize<'de> for CreateCustomRewardBody
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<CreateCustomRewardBody> for CreateCustomRewardBody
[src]
impl PartialEq<CreateCustomRewardBody> for CreateCustomRewardBody
[src]fn eq(&self, other: &CreateCustomRewardBody) -> bool
[src]
fn ne(&self, other: &CreateCustomRewardBody) -> bool
[src]
impl Serialize for CreateCustomRewardBody
[src]
impl Serialize for CreateCustomRewardBody
[src]Auto Trait Implementations
impl RefUnwindSafe for CreateCustomRewardBody
impl RefUnwindSafe for CreateCustomRewardBody
impl Send for CreateCustomRewardBody
impl Send for CreateCustomRewardBody
impl Sync for CreateCustomRewardBody
impl Sync for CreateCustomRewardBody
impl Unpin for CreateCustomRewardBody
impl Unpin for CreateCustomRewardBody
impl UnwindSafe for CreateCustomRewardBody
impl UnwindSafe for CreateCustomRewardBody
Blanket Implementations
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]impl<T> HelixRequestBody for T where
T: Serialize + SealedSerialize,
[src]
impl<T> HelixRequestBody for T where
T: Serialize + SealedSerialize,
[src]impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
impl<T> WithSubscriber for T
[src]pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,