Struct twitchchat::messages::UserNotice

pub struct UserNotice<'a> { /* fields omitted */ }

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

Implementations

impl<'a> UserNotice<'a>

pub fn raw(&self) -> &str

Get the raw message

pub fn tags(&self) -> Tags<'_>

Get a view of parsable tags

pub fn channel(&self) -> &str

The channel that this event is happening on

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

Optional message attached to the event

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

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(&'a self) -> Vec<Badge<'a>>

Badges attached to this message

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

The user's color, if set

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

The user's display name, if set

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

Emotes attached to this message

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

A unique id (UUID) attached to this message

(this is used for message localization)

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

The name of the user who sent this notice

pub fn is_moderator(&self) -> bool

Whether this user is a moderator

pub fn msg_id(&'a self) -> Option<NoticeType<'a>>

The kind of notice this message is

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

The id of the room for this notice

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

The timestamp which twitch received this message

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

User id of the user who sent this notice

pub fn system_msg(&self) -> Option<String>

The message printed in chat along with this notice

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_promo_gift_total(&self) -> Option<u64>

(Sent only on anongiftpaidupgrade, giftpaidupgrade) The number of gifts the gifter has given during the promo indicated by msg-param-promo-name.

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

(Sent only on anongiftpaidupgrade, giftpaidupgrade) The subscriptions promo, if any, that is ongoing; e.g. Subtember 2018.

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_sender_login(&self) -> Option<&str>

(Sent only on giftpaidupgrade) The login of the user who gifted the subscription.

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

(Sent only on giftpaidupgrade) The display name of the user who gifted the subscription.

pub fn msg_param_should_share_streak(&self) -> Option<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(&'a self) -> Option<SubPlan<'a>>

(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 msg_param_threshold(&self) -> Option<u64>

(Sent only on bitsbadgetier) The tier of the bits badge the user just earned; e.g. 100, 1000, 10000.

Trait Implementations

impl<'a> Clone for UserNotice<'a>

fn clone(&self) -> UserNotice<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UserNotice<'a>

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<UserNotice<'a>, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> From<UserNotice<'a>> for Commands<'a>

fn from(msg: UserNotice<'a>) -> Self

Performs the conversion.

impl<'a> FromIrcMessage<'a> for UserNotice<'a>

type Error = MessageError

An error returned if this message could not be parsed.

fn from_irc(msg: IrcMessage<'a>) -> Result<Self, Self::Error>

This method consumes an IrcMessage and tries to produce an instance of Self

fn into_inner(self) -> MaybeOwned<'a>

Consumes the message, returning the raw MaybeOwned<'_>

impl<'a> IntoOwned<'a> for UserNotice<'a>

type Output = UserNotice<'static>

The output type

fn into_owned(self) -> Self::Output

Consumes self, returning an owned version

impl<'a> PartialEq<UserNotice<'a>> for UserNotice<'a>

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

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

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

This method tests for !=.

impl<'a> Serialize for UserNotice<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for UserNotice<'a>