Struct twitchchat::commands::UserNotice

pub struct UserNotice { /* fields omitted */ }

Announces Twitch-specific events to the channel (e.g., a user's subscription notification).

Methods

impl UserNotice

pub fn tags(&self) -> &Tags

IRC tags

pub fn channel(&self) -> &Channel

The channel this event is for

pub fn message(&self) -> Option<&str>

The message. This is omitted if the user did not enter a message.

impl UserNotice

pub fn badge_info(&self) -> Vec<BadgeInfo>

Metadata related to the chat badges

Currently used only for subscriber, to indicate the exact number of months the user has been a subscriber.

pub fn badges(&self) -> Vec<Badge>

List of badges attached to this message

pub fn color(&self) -> Option<Color>

The color of the user who sent this message, if set

pub fn display_name(&self) -> Option<&str>

The display name of the user, if set

pub fn emotes(&self) -> Vec<Emotes>

List of emotes found in the message body.

pub fn id(&self) -> Option<&str>

A unique id (UUID) attached to this message (used for Localization)

pub fn login(&self) -> Option<&str>

The name of the user who sent the notice.

pub fn moderator(&self) -> bool

Whether this user is a moderator

pub fn msg_id(&self) -> NoticeType

The type of notice, see NoticeType

pub fn msg_param_cumulative_months(&self) -> Option<u64>

(Sent only on sub, resub) The total number of months the user has subscribed. This is the same as msg-param-months but sent for different types of user notices.

pub fn msg_param_display_name(&self) -> Option<&str>

(Sent only on raid) The display name of the source user raiding this channel.

pub fn msg_param_login(&self) -> Option<&str>

(Sent on only raid) The name of the source user raiding this channel.

pub fn msg_param_months(&self) -> Option<u64>

(Sent only on subgift, anonsubgift) The total number of months the user has subscribed. This is the same as msg-param-cumulative-months but sent for different types of user notices.

pub fn msg_param_recipient_display_name(&self) -> Option<&str>

(Sent only on subgift, anonsubgift) The display name of the subscription gift recipient.

pub fn msg_param_recipient_id(&self) -> Option<u64>

(Sent only on subgift, anonsubgift) The user ID of the subscription gift recipient.

pub fn msg_param_recipient_user_name(&self) -> Option<&str>

(Sent only on subgift, anonsubgift) The user name of the subscription gift recipient.

pub fn msg_param_should_share_streak(&self) -> bool

(Sent only on sub, resub) Boolean indicating whether users want their streaks to be shared.

pub fn msg_param_streak_months(&self) -> Option<u64>

(Sent only on sub, resub) The number of consecutive months the user has subscribed. This is 0 if msg-param-should-share-streak is 0.

pub fn msg_param_sub_plan(&self) -> Option<SubPlan>

(Sent only on sub, resub, subgift, anonsubgift) The type of subscription plan being used. Valid values: Prime, 1000, 2000, 3000. 1000, 2000, and 3000 refer to the first, second, and third levels of paid subscriptions, respectively (currently $4.99, $9.99, and $24.99).

pub fn msg_param_sub_plan_name(&self) -> Option<&str>

(Sent only on sub, resub, subgift, anonsubgift) The display name of the subscription plan. This may be a default name or one created by the channel owner.

pub fn msg_param_viewer_count(&self) -> Option<u64>

(Sent only on raid) The number of viewers watching the source channel raiding this channel.

pub fn msg_param_ritual_name(&self) -> Option<&str>

(Sent only on ritual) The name of the ritual this notice is for. Valid value: new_chatter.

pub fn room_id(&self) -> Option<u64>

The id for the room for this notice

pub fn system_msg(&self) -> String

The message printed in chat along with this notice.

pub fn tmi_sent_ts(&self) -> Option<u64>

Timestamp of when the notice was sent

pub fn user_id(&self) -> Option<u64>

The id of the user who sent the notice

Trait Implementations

impl Tag for UserNotice

fn get(&self, key: &str) -> Option<&str>

Gets the key from the mapping, returning the value if found

impl PartialEq<UserNotice> for UserNotice

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

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

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

This method tests for !=.

impl Clone for UserNotice

fn clone(&self) -> UserNotice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Message> for UserNotice

fn from(msg: Message) -> Self

Performs the conversion.

impl Debug for UserNotice

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

Formats the value using the given formatter.

impl Serialize for UserNotice

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for UserNotice

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

Deserialize this value from the given Serde deserializer.