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

Core functionality

BotBotCommandBotCommandContext

Events

AnnouncementEventBanEventBitsBadgeUpgradeEventChatClearEventCommunityPayForwardEventCommunitySubEventEmoteOnlyToggleEventFollowersOnlyToggleEventGiftPaidUpgradeEventJoinEventJoinFailureEventLeaveEventMessageEventMessageRemoveEventPrimePaidUpgradeEventRaidCancelEventRaidEventSlowModeToggleEventStandardPayForwardEventSubEventSubGiftEventSubsOnlyToggleEventUniqueChatToggleEventWhisperEvent

Functions

createBotCommand

Interfaces

BotConfigCreateBotCommandOptions

Type aliases

BotAuthMethodChatAnnouncementColor

WhisperEvent

An event representing a whisper message.

Overview

Properties

Methods

Properties

text

Type: string

The text of the message.

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

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