dank-twitch-irc

Appearance

@mastondzn/dank-twitch-irc / UserstateMessage

Class: UserstateMessage ​

Defined in: src/message/twitch-types/userstate.ts:25

State of the logged in user in a channel.

Extends ​

Implements ​

Constructors ​

Constructor ​

new UserstateMessage(message): UserstateMessage

Defined in: src/message/twitch-types/userstate.ts:38

Parameters ​

message ​

IRCMessageData

Returns ​

UserstateMessage

Overrides ​

ChannelIRCMessage.constructor

Properties ​

_channelLogin ​

protected readonly _channelLogin: string

Defined in: src/message/irc/channel-irc-message.ts:41

Inherited from ​

ChannelIRCMessage._channelLogin

badgeInfo ​

readonly badgeInfo: TwitchBadgesList

Defined in: src/message/twitch-types/userstate.ts:26

Implementation of ​

UserState.badgeInfo

badgeInfoRaw ​

readonly badgeInfoRaw: string

Defined in: src/message/twitch-types/userstate.ts:27

Implementation of ​

UserState.badgeInfoRaw

badges ​

readonly badges: TwitchBadgesList

Defined in: src/message/twitch-types/userstate.ts:28

Implementation of ​

UserState.badges

badgesRaw ​

readonly badgesRaw: string

Defined in: src/message/twitch-types/userstate.ts:29

Implementation of ​

UserState.badgesRaw

color ​

readonly color: Color | undefined

Defined in: src/message/twitch-types/userstate.ts:30

Implementation of ​

UserState.color

colorRaw ​

readonly colorRaw: string

Defined in: src/message/twitch-types/userstate.ts:31

Implementation of ​

UserState.colorRaw

displayName ​

readonly displayName: string

Defined in: src/message/twitch-types/userstate.ts:32

Implementation of ​

UserState.displayName

emoteSets ​

readonly emoteSets: TwitchEmoteSets

Defined in: src/message/twitch-types/userstate.ts:33

Implementation of ​

UserState.emoteSets

emoteSetsRaw ​

readonly emoteSetsRaw: string

Defined in: src/message/twitch-types/userstate.ts:34

Implementation of ​

UserState.emoteSetsRaw

ircCommand ​

readonly ircCommand: string

Defined in: src/message/irc/irc-message.ts:28

The parser ensures this is always uppercase

Inherited from ​

ChannelIRCMessage.ircCommand

ircParameters ​

readonly ircParameters: string[]

Defined in: src/message/irc/irc-message.ts:29

Inherited from ​

ChannelIRCMessage.ircParameters

ircPrefix ​

readonly ircPrefix: IRCMessagePrefix | undefined

Defined in: src/message/irc/irc-message.ts:23

Inherited from ​

ChannelIRCMessage.ircPrefix

ircPrefixRaw ​

readonly ircPrefixRaw: string | undefined

Defined in: src/message/irc/irc-message.ts:22

Inherited from ​

ChannelIRCMessage.ircPrefixRaw

ircTags ​

readonly ircTags: IRCMessageTags

Defined in: src/message/irc/irc-message.ts:30

Inherited from ​

ChannelIRCMessage.ircTags

isMod ​

readonly isMod: boolean

Defined in: src/message/twitch-types/userstate.ts:35

Implementation of ​

UserState.isMod

isModRaw ​

readonly isModRaw: string

Defined in: src/message/twitch-types/userstate.ts:36

Implementation of ​

UserState.isModRaw

rawSource ​

readonly rawSource: string

Defined in: src/message/irc/irc-message.ts:20

Inherited from ​

ChannelIRCMessage.rawSource

Accessors ​

channel ​

Get Signature ​

get channel(): Channel

Defined in: src/message/irc/channel-irc-message.ts:43

Returns ​

Channel

Inherited from ​

ChannelIRCMessage.channel

channelName ​

Get Signature ​

get channelName(): string

Defined in: src/message/irc/channel-irc-message.ts:51

Deprecated ​

Use channel.login instead.

Returns ​

string

Inherited from ​

ChannelIRCMessage.channelName

Methods ​

extractUserState() ​

extractUserState(): UserState

Defined in: src/message/twitch-types/userstate.ts:61

Returns ​

UserState