Struct ChannelRaidV1

#[non_exhaustive]
pub struct ChannelRaidV1 {
    pub from_broadcaster_user_id: Option<UserId>,
    pub to_broadcaster_user_id: Option<UserId>,
}

Available on crate feature eventsub only.

channel.raid: a a broadcaster raids another broadcaster’s 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.

from_broadcaster_user_id: Option<UserId>

The broadcaster user ID that created the channel raid you want to get notifications for. Use this parameter if you want to know when a specific broadcaster raids another broadcaster.

to_broadcaster_user_id: Option<UserId>

The broadcaster user ID that received the channel raid you want to get notifications for. Use this parameter if you want to know when a specific broadcaster is raided by another broadcaster.

Implementations

impl ChannelRaidV1

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

Create a builder for building ChannelRaidV1. On the builder, call .from_broadcaster_user_id(...)(optional), .to_broadcaster_user_id(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ChannelRaidV1.

impl ChannelRaidV1

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

The broadcaster user ID that created the channel raid you want to get notifications for.

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

The broadcaster user ID that received the channel raid you want to get notifications for.

Trait Implementations

impl Clone for ChannelRaidV1

fn clone(&self) -> ChannelRaidV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelRaidV1

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

Formats the value using the given formatter.

impl Default for ChannelRaidV1

fn default() -> ChannelRaidV1

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChannelRaidV1

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventSubscription for ChannelRaidV1

const EVENT_TYPE: EventType = EventType::ChannelRaid

Subscription type name.

const SCOPE: Validator

Available on crate feature twitch_oauth2 only.

Scopes needed by this subscription

const VERSION: &'static str = "1"

Subscription type version

type Payload = ChannelRaidV1Payload

Payload for given subscription

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 for ChannelRaidV1

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ChannelRaidV1

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 ChannelRaidV1

impl StructuralPartialEq for ChannelRaidV1