Struct ChannelChatClearV1

#[non_exhaustive]
pub struct ChannelChatClearV1 {
    pub broadcaster_user_id: UserId,
    pub user_id: UserId,
}

Available on crate feature eventsub only.

channel.chat.clear: a moderator or bot clears all messages from the chat room.

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

User ID of the channel to receive chat clear user messages events for.

user_id: UserId

The user ID to read chat as.

Implementations

impl ChannelChatClearV1

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

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

impl ChannelChatClearV1

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

Get chat clear on broadcasters channel reading chat as a specific user.

Trait Implementations

impl Clone for ChannelChatClearV1

fn clone(&self) -> ChannelChatClearV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelChatClearV1

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelChatClearV1

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventSubscription for ChannelChatClearV1

const EVENT_TYPE: EventType = EventType::ChannelChatClear

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 = ChannelChatClearV1Payload

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 ChannelChatClearV1

fn eq(&self, other: &ChannelChatClearV1) -> 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 ChannelChatClearV1

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 ChannelChatClearV1

impl StructuralPartialEq for ChannelChatClearV1