irc/io.github.captnblubber.twitchkt.irc/IrcMessage/UserNotice

UserNotice

A USERNOTICE message dispatched by Twitch for subscriptions, raids, watch streaks, and other channel events. Subclasses represent specific msg-id values.

Inheritors

Types

Raid

class Raid(channel: String, tags: Map<String, String>, userId: String, userLogin: String, displayName: String, systemMessage: String, val viewerCount: Int) : IrcMessage.UserNotice

Incoming raid (msg-id=raid).

Resub

class Resub(channel: String, tags: Map<String, String>, userId: String, userLogin: String, displayName: String, systemMessage: String, val tier: SubTier, val cumulativeMonths: Int, val streakMonths: Int?, val userMessage: String?) : IrcMessage.UserNotice

Resubscription (msg-id=resub).

Sub

class Sub(channel: String, tags: Map<String, String>, userId: String, userLogin: String, displayName: String, systemMessage: String, val tier: SubTier, val isGift: Boolean) : IrcMessage.UserNotice

New subscription (msg-id=sub).

SubGift

class SubGift(channel: String, tags: Map<String, String>, userId: String, userLogin: String, displayName: String, systemMessage: String, val tier: SubTier, val recipientLogin: String, val recipientDisplayName: String) : IrcMessage.UserNotice

Gifted subscription (msg-id=subgift).

Unknown

class Unknown(channel: String, tags: Map<String, String>, userId: String, userLogin: String, displayName: String, systemMessage: String, val msgId: String) : IrcMessage.UserNotice

Catch-all for unrecognized msg-id values.

WatchStreak

class WatchStreak(channel: String, tags: Map<String, String>, userId: String, userLogin: String, displayName: String, systemMessage: String, val streakMonths: Int, val userMessage: String?) : IrcMessage.UserNotice

Viewer milestone: watch streak (msg-id=viewer-milestone, msg-param-category=watch-streak).

Properties

channel

open override val channel: String

Channel name without the # prefix.

displayName

val displayName: String

systemMessage

val systemMessage: String