Struct twitch_api::eventsub::channel::channel_points_custom_reward::ChannelPointsCustomRewardAddV1Payload
source · [−]#[non_exhaustive]pub struct ChannelPointsCustomRewardAddV1Payload {Show 20 fields
pub background_color: String,
pub broadcaster_user_id: UserId,
pub broadcaster_user_login: UserName,
pub broadcaster_user_name: DisplayName,
pub cooldown_expires_at: Option<Timestamp>,
pub cost: i64,
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_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 title: String,
}
eventsub
only.Expand description
channel.channel_points_custom_reward.add
response payload.
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.background_color: String
Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2.
broadcaster_user_id: UserId
The requested broadcaster ID.
broadcaster_user_login: UserName
The requested broadcaster login.
broadcaster_user_name: DisplayName
The requested broadcaster display name.
cooldown_expires_at: Option<Timestamp>
Timestamp of the cooldown expiration. null if the reward isn’t on cooldown.
cost: i64
The reward cost.
default_image: Option<Image>
Set of default images of 1x, 2x and 4x sizes for the reward.
global_cooldown: GlobalCooldown
Whether a cooldown is enabled and what the cooldown is in seconds.
id: RewardId
The reward identifier.
image: Option<Image>
Set of custom images of 1x, 2x and 4x sizes for the reward. Can be null if no images have been uploaded.
is_enabled: bool
Is the reward currently enabled. If false, the reward won’t show up to viewers.
is_in_stock: bool
Is the reward currently in stock. If false, viewers can’t redeem.
is_paused: bool
Is the reward currently paused. If true, viewers can’t redeem.
is_user_input_required: bool
Does the viewer need to enter information when redeeming the reward.
max_per_stream: Max
Whether a maximum per stream is enabled and what the maximum is.
max_per_user_per_stream: Max
Whether a maximum per user per stream is enabled and what the maximum is.
prompt: String
The reward description.
redemptions_redeemed_current_stream: Option<u32>
The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn’t live or max_per_stream isn’t enabled.
should_redemptions_skip_request_queue: bool
Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status.
title: String
The reward title.
Trait Implementations
sourceimpl Clone for ChannelPointsCustomRewardAddV1Payload
impl Clone for ChannelPointsCustomRewardAddV1Payload
sourcefn clone(&self) -> ChannelPointsCustomRewardAddV1Payload
fn clone(&self) -> ChannelPointsCustomRewardAddV1Payload
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'de> Deserialize<'de> for ChannelPointsCustomRewardAddV1Payload
impl<'de> Deserialize<'de> for ChannelPointsCustomRewardAddV1Payload
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 PartialEq<ChannelPointsCustomRewardAddV1Payload> for ChannelPointsCustomRewardAddV1Payload
impl PartialEq<ChannelPointsCustomRewardAddV1Payload> for ChannelPointsCustomRewardAddV1Payload
sourcefn eq(&self, other: &ChannelPointsCustomRewardAddV1Payload) -> bool
fn eq(&self, other: &ChannelPointsCustomRewardAddV1Payload) -> bool
impl Eq for ChannelPointsCustomRewardAddV1Payload
impl StructuralEq for ChannelPointsCustomRewardAddV1Payload
impl StructuralPartialEq for ChannelPointsCustomRewardAddV1Payload
Auto Trait Implementations
impl RefUnwindSafe for ChannelPointsCustomRewardAddV1Payload
impl Send for ChannelPointsCustomRewardAddV1Payload
impl Sync for ChannelPointsCustomRewardAddV1Payload
impl Unpin for ChannelPointsCustomRewardAddV1Payload
impl UnwindSafe for ChannelPointsCustomRewardAddV1Payload
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.