TwurpleAuthenticationGetting dataExamplesFAQMigration
Reference
apiapi-callauthauth-tmichatcommoneasy-botebs-helpereventsub-baseeventsub-httpeventsub-wspubsub

Core functionality

BotBotCommandBotCommandContext

Events

AnnouncementEventBanEventBitsBadgeUpgradeEventChatClearEventCommunityPayForwardEventCommunitySubEventEmoteOnlyToggleEventFollowersOnlyToggleEventGiftPaidUpgradeEventJoinEventJoinFailureEventLeaveEventMessageEventMessageRemoveEventPrimePaidUpgradeEventRaidCancelEventRaidEventSlowModeToggleEventStandardPayForwardEventSubEventSubGiftEventSubsOnlyToggleEventUniqueChatToggleEventWhisperEvent

Functions

createBotCommand

Interfaces

BotConfigCreateBotCommandOptions

Type aliases

BotAuthMethodChatAnnouncementColor

MessageEvent

An event representing a user sending a message to a channel's chat.

Overview

Properties

Methods

Properties

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

emoteOffsets

Type: Map<string, string[]>

The offsets of the emotes contained in the message.

isAction

Type: boolean

Whether the message is formatted as an action (sent using the /me chat command).

text

Type: string

The text that was sent.

userDisplayName

Type: string

The display name of the user who sent the message.

userId

Type: string

The ID of the user who sent the message.

userName

Type: string

The name of the user who sent the message.

Methods

delete()

async

Deletes the message.

Return type: void

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getUser()

async

Gets more information about the user who sent the message.

Return type: HelixUser

reply(text)

async

Replies to the message.

ParameterTypeRequiredDefaultDescription
textstringnone

The text to send as a reply.

Return type: void