#[non_exhaustive]pub struct CreateCustomRewardBody {Show 13 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.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: 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
sourceimpl CreateCustomRewardBody
impl CreateCustomRewardBody
sourcepub fn builder(
) -> CreateCustomRewardBodyBuilder<((), (), (), (), (), (), (), (), (), (), (), (), ())>
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
sourceimpl Clone for CreateCustomRewardBody
impl Clone for CreateCustomRewardBody
sourcefn clone(&self) -> CreateCustomRewardBody
fn clone(&self) -> CreateCustomRewardBody
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateCustomRewardBody
impl Debug for CreateCustomRewardBody
sourceimpl<'de> Deserialize<'de> for CreateCustomRewardBody
impl<'de> Deserialize<'de> for CreateCustomRewardBody
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>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<CreateCustomRewardBody> for CreateCustomRewardBody
impl PartialEq<CreateCustomRewardBody> for CreateCustomRewardBody
sourcefn eq(&self, other: &CreateCustomRewardBody) -> bool
fn eq(&self, other: &CreateCustomRewardBody) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateCustomRewardBody) -> bool
fn ne(&self, other: &CreateCustomRewardBody) -> bool
This method tests for !=
.
sourceimpl Serialize for CreateCustomRewardBody
impl Serialize for CreateCustomRewardBody
impl StructuralPartialEq for CreateCustomRewardBody
Auto Trait Implementations
impl RefUnwindSafe for CreateCustomRewardBody
impl Send for CreateCustomRewardBody
impl Sync for CreateCustomRewardBody
impl Unpin for CreateCustomRewardBody
impl UnwindSafe for CreateCustomRewardBody
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> HelixRequestBody for T where
T: Serialize + SealedSerialize,
impl<T> HelixRequestBody for T where
T: Serialize + SealedSerialize,
sourcefn try_to_body(&self) -> Result<Bytes, BodyError>
fn try_to_body(&self) -> Result<Bytes, BodyError>
helix
only.Create the body
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more