TwurpleAuthenticationGetting dataExamplesFAQMigration

ChatUser

A user in chat.

Overview

Properties

badgeInfo

Type: Map<string, string>

The badge info of the user. Returned as a map that maps the badge category to the detail.

badges

Type: Map<string, string>

The badges of the user. Returned as a map that maps the badge category to the detail.

color

Type: ?string

The color the user chose to display in chat.

Returns undefined if the user didn't choose a color. In this case, you should generate your own color for this user and stick to it at least for one runtime.

displayName

Type: string

The display name of the user.

isArtist

Type: boolean

Whether the user is an artist of the channel.

isBroadcaster

Type: boolean

Whether the user is the broadcaster.

isFounder

Type: boolean

Whether the user is a Founder of the channel.

isMod

Type: boolean

Whether the user is a moderator of the channel.

isSubscriber

Type: boolean

Whether the user is subscribed to the channel.

isVip

Type: boolean

Whether the user is a VIP in the channel.

userId

Type: string

The ID of the user.

userName

Type: string

The name of the user.

userType

Type: ?string

The type of the user. Possible values are undefined, 'mod', 'global_mod', 'admin' and 'staff'.