Struct twitch_api::eventsub::channel::channel_points_custom_reward_redemption::add::ChannelPointsCustomRewardRedemptionAddV1

#[non_exhaustive]
pub struct ChannelPointsCustomRewardRedemptionAddV1 {
    pub broadcaster_user_id: UserId,
    pub reward_id: Option<RewardId>,
}

Available on crate feature eventsub only.

channel.channel_points_custom_reward_redemption.add: a viewer has redeemed a custom channel points reward on the specified channel.

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.

broadcaster_user_id: UserId

The broadcaster user ID for the channel you want to receive channel points custom reward redemption add notifications for.

reward_id: Option<RewardId>

Optional. Specify a reward id to only receive notifications for a specific reward.

Implementations

impl ChannelPointsCustomRewardRedemptionAddV1

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

Create a builder for building ChannelPointsCustomRewardRedemptionAddV1. On the builder, call .broadcaster_user_id(...), .reward_id(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ChannelPointsCustomRewardRedemptionAddV1.

impl ChannelPointsCustomRewardRedemptionAddV1

pub fn broadcaster_user_id(broadcaster_user_id: impl Into<UserId>) -> Self

The broadcaster user ID for the channel you want to receive channel points custom reward redemption add notifications for.

pub fn reward_id(self, reward_id: impl Into<RewardId>) -> Self

Specify a reward id to only receive notifications for a specific reward.

Trait Implementations

impl Clone for ChannelPointsCustomRewardRedemptionAddV1

fn clone(&self) -> ChannelPointsCustomRewardRedemptionAddV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelPointsCustomRewardRedemptionAddV1

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelPointsCustomRewardRedemptionAddV1

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

Deserialize this value from the given Serde deserializer.

impl EventSubscription for ChannelPointsCustomRewardRedemptionAddV1

type Payload = ChannelPointsCustomRewardRedemptionAddV1Payload

Payload for given subscription

const EVENT_TYPE: EventType = EventType::ChannelPointsCustomRewardRedemptionAdd

Subscription type name.

const SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Scopes needed by this subscription

const VERSION: &'static str = "1"

Subscription type version

const OPT_SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this subscription

fn condition(&self) -> Result<Value, Error>

Creates the condition for this EventSub subscription

impl PartialEq<ChannelPointsCustomRewardRedemptionAddV1> for ChannelPointsCustomRewardRedemptionAddV1

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ChannelPointsCustomRewardRedemptionAddV1

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

Serialize this value into the given Serde serializer.

impl Eq for ChannelPointsCustomRewardRedemptionAddV1

impl StructuralEq for ChannelPointsCustomRewardRedemptionAddV1

impl StructuralPartialEq for ChannelPointsCustomRewardRedemptionAddV1