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

Core functionality

BotBotCommandBotCommandContext

Events

AnnouncementEventBanEventBitsBadgeUpgradeEventChatClearEventCommunityPayForwardEventCommunitySubEventEmoteOnlyToggleEventFollowersOnlyToggleEventGiftPaidUpgradeEventJoinEventJoinFailureEventLeaveEventMessageEventMessageRemoveEventPrimePaidUpgradeEventRaidCancelEventRaidEventSlowModeToggleEventStandardPayForwardEventSubEventSubGiftEventSubsOnlyToggleEventUniqueChatToggleEventWhisperEvent

Functions

createBotCommand

Interfaces

BotConfigCreateBotCommandOptions

Type aliases

BotAuthMethodChatAnnouncementColor

SlowModeToggleEvent

An event representing slow mode being toggled in a channel.

Overview

Properties

Methods

Properties

broadcasterName

Type: string

The name of the broadcaster.

delay

Type: number | null

The time (in seconds) a user has to wait after sending a message to send another one.

enabled

Type: boolean

Whether slow mode was enabled.

true means it was enabled, false means it was disabled.

Methods

disable()

async

Disables slow mode in the channel.

Return type: void

enable(delay)

async

Enables slow mode in the channel.

ParameterTypeRequiredDefaultDescription
delaynumber30

The time (in seconds) a user has to wait after sending a message to send another one.

Return type: void

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser