TwitchLib 3.5.3
Loading...
Searching...
No Matches
TwitchLib.Client.Models.Announcement Class Reference

Class representing Announcement in a Twitch channel. More...

Public Member Functions

 Announcement (IrcMessage ircMessage)
 Announcement object constructor. More...
 

Properties

string Id [get]
 Property representing announcement message id More...
 
List< KeyValuePair< string, string > > Badges [get]
 Property representing list of badges assigned. More...
 
List< KeyValuePair< string, string > > BadgeInfo [get]
 Metadata associated with each badge More...
 
string SystemMessage [get]
 Property representing internal system message value. More...
 
string SystemMessageParsed [get]
 Property representing internal system message value, parsed. More...
 
bool IsBroadcaster [get]
 Property representing whether or not the announcer is the broadcaster. More...
 
bool IsModerator [get]
 Property representing whether or not the announcer is a moderator. More...
 
bool IsPartner [get]
 Property representing whether or not announcer is a partner. More...
 
bool IsSubscriber [get]
 Property representing whether or not the announcer is a subscriber. More...
 
bool IsStaff [get]
 Property representing whether or not the announcer is a twitch staff member. More...
 
bool IsTurbo [get]
 Property representing whether or not the announcer is a turbo member. More...
 
string Login [get]
 Property representing the user's login. More...
 
string UserId [get]
 Property representing the user's id. More...
 
string RoomId [get]
 Property representing the room id. More...
 
UserType UserType [get]
 Property representing the user type of the announcer. More...
 
string TmiSentTs [get]
 Property representing the tmi-sent-ts value. More...
 
string EmoteSet [get]
 Property representing emote set of announcement. More...
 
string RawIrc [get]
 Property representing the raw IRC message (for debugging/customized parsing) More...
 
string MsgId [get]
 Property representing the msg-id value. More...
 
string MsgParamColor [get]
 Property representing the color value of the announcement. More...
 
string ColorHex [get]
 Property representing the colorhex of the announcer. More...
 
Color Color [get]
 Property representing HEX color as a System.Drawing.Color object. More...
 
string Message [get]
 Property representing the message of the announcement. More...
 

Detailed Description

Class representing Announcement in a Twitch channel.

Constructor & Destructor Documentation

◆ Announcement()

TwitchLib.Client.Models.Announcement.Announcement ( IrcMessage  ircMessage)

Announcement object constructor.

SAMPLE: @badge-info=;badges=broadcaster/1,ambassador/1;color=#033700;display-name=BarryCarlyon;emotes=;flags=;id=55d90904-e515-47d0-ac1d-879f7f1d7b01;login=barrycarlyon;mod=0;msg-id=announcement;msg-param-color=PRIMARY;room-id=15185913;subscriber=0;system-msg=;tmi-sent-ts=1648758023469;user-id=15185913;user-type= :tmi.twitch.tv USERNOTICE #barrycarlyon :test announcment main

Parameters
ircMessageThe IRC message from Twitch to be processed.

Property Documentation

◆ BadgeInfo

List<KeyValuePair<string, string> > TwitchLib.Client.Models.Announcement.BadgeInfo
get

Metadata associated with each badge

◆ Badges

List<KeyValuePair<string, string> > TwitchLib.Client.Models.Announcement.Badges
get

Property representing list of badges assigned.

◆ Color

Color TwitchLib.Client.Models.Announcement.Color
get

Property representing HEX color as a System.Drawing.Color object.

◆ ColorHex

string TwitchLib.Client.Models.Announcement.ColorHex
get

Property representing the colorhex of the announcer.

◆ EmoteSet

string TwitchLib.Client.Models.Announcement.EmoteSet
get

Property representing emote set of announcement.

◆ Id

string TwitchLib.Client.Models.Announcement.Id
get

Property representing announcement message id

◆ IsBroadcaster

bool TwitchLib.Client.Models.Announcement.IsBroadcaster
get

Property representing whether or not the announcer is the broadcaster.

◆ IsModerator

bool TwitchLib.Client.Models.Announcement.IsModerator
get

Property representing whether or not the announcer is a moderator.

◆ IsPartner

bool TwitchLib.Client.Models.Announcement.IsPartner
get

Property representing whether or not announcer is a partner.

◆ IsStaff

bool TwitchLib.Client.Models.Announcement.IsStaff
get

Property representing whether or not the announcer is a twitch staff member.

◆ IsSubscriber

bool TwitchLib.Client.Models.Announcement.IsSubscriber
get

Property representing whether or not the announcer is a subscriber.

◆ IsTurbo

bool TwitchLib.Client.Models.Announcement.IsTurbo
get

Property representing whether or not the announcer is a turbo member.

◆ Login

string TwitchLib.Client.Models.Announcement.Login
get

Property representing the user's login.

◆ Message

string TwitchLib.Client.Models.Announcement.Message
get

Property representing the message of the announcement.

◆ MsgId

string TwitchLib.Client.Models.Announcement.MsgId
get

Property representing the msg-id value.

◆ MsgParamColor

string TwitchLib.Client.Models.Announcement.MsgParamColor
get

Property representing the color value of the announcement.

◆ RawIrc

string TwitchLib.Client.Models.Announcement.RawIrc
get

Property representing the raw IRC message (for debugging/customized parsing)

◆ RoomId

string TwitchLib.Client.Models.Announcement.RoomId
get

Property representing the room id.

◆ SystemMessage

string TwitchLib.Client.Models.Announcement.SystemMessage
get

Property representing internal system message value.

◆ SystemMessageParsed

string TwitchLib.Client.Models.Announcement.SystemMessageParsed
get

Property representing internal system message value, parsed.

◆ TmiSentTs

string TwitchLib.Client.Models.Announcement.TmiSentTs
get

Property representing the tmi-sent-ts value.

◆ UserId

string TwitchLib.Client.Models.Announcement.UserId
get

Property representing the user's id.

◆ UserType

UserType TwitchLib.Client.Models.Announcement.UserType
get

Property representing the user type of the announcer.


The documentation for this class was generated from the following file: