Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsernoticeMessage

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly badgeInfo

badgeInfo: TwitchBadgesList

Readonly badgeInfoRaw

badgeInfoRaw: string

Readonly badges

Readonly badgesRaw

badgesRaw: string

Readonly bits

bits: number | undefined

Readonly bitsRaw

bitsRaw: string | undefined

Readonly channelID

channelID: string

Readonly channelName

channelName: string

Readonly color

color: Color | undefined

Readonly colorRaw

colorRaw: string

Readonly displayName

displayName: string

Readonly emotes

Readonly emotesRaw

emotesRaw: string

Readonly eventParams

eventParams: EventParams

Readonly flags

flags: TwitchFlagList | undefined

Can be an array of Twitch AutoMod flagged words, for use in moderation and/or filtering purposes.

If the flags tag is missing or of a unparseable format, this will be undefined. This is unlike most other attributes which when missing or malformed will fail the message parsing. However since this attribute is completely undocumented we cannot rely on the flags tag being stable, so this soft fallback is used instead. While it will be a major version release if this attribute changes format in dank-twitch-irc, using this is still at your own risk since it may suddenly contain unexpected data or turn undefined one day as Twitch changes something. In short: Use at your own risk and make sure your implementation can handle the case where this is undefined.

Readonly flagsRaw

flagsRaw: string | undefined

Twitch AutoMod raw flags string.

If the flags tag is missing or of a unparseable format, this will be undefined. This is unlike most other attributes which when missing or malformed will fail the message parsing. However since this attribute is completely undocumented we cannot rely on the flags tag being stable, so this soft fallback is used instead. In short, ensure your implementation can handle the case where this is undefined or is in a format you don't expect.

Readonly ircCommand

ircCommand: string

The parser ensures this is always uppercase

Readonly ircParameters

ircParameters: string[]

Readonly ircPrefix

ircPrefix: IRCMessagePrefix | undefined

Readonly ircPrefixRaw

ircPrefixRaw: string | undefined

Readonly ircTags

Readonly isMod

isMod: boolean

Readonly isModRaw

isModRaw: string

Readonly messageID

messageID: string

Readonly messageText

messageText: string | undefined

Readonly messageTypeID

messageTypeID: string

sub, resub, subgift, etc...

Readonly rawSource

rawSource: string

Readonly senderUserID

senderUserID: string

Readonly senderUsername

senderUsername: string

Readonly serverTimestamp

serverTimestamp: Date

Readonly serverTimestampRaw

serverTimestampRaw: string

Readonly systemMessage

systemMessage: string

Methods

isAnonGiftPaidUpgrade

  • isAnonGiftPaidUpgrade(): this is AnonGiftPaidUpgradeUsernoticeMessage

isAnonSubgift

  • isAnonSubgift(): this is AnonSubgiftUsernoticeMessage

isBitsBadgeTier

  • isBitsBadgeTier(): this is BitsBadgeTierUsernoticeMessage

isCheer

  • isCheer(): this is CheerUsernoticeMessage

isGiftPaidUpgrade

  • isGiftPaidUpgrade(): this is GiftPaidUpgradeUsernoticeMessage

isRaid

  • isRaid(): this is RaidUsernoticeMessage

isResub

  • isResub(): this is ResubUsernoticeMessage

isRitual

  • isRitual(): this is RitualUsernoticeMessage

isSub

  • isSub(): this is SubUsernoticeMessage

isSubgift

  • isSubgift(): this is SubgiftUsernoticeMessage

Generated using TypeDoc