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

Core functionality

BotBotCommandBotCommandContext

Events

AnnouncementEventBanEventBitsBadgeUpgradeEventChatClearEventCommunityPayForwardEventCommunitySubEventEmoteOnlyToggleEventFollowersOnlyToggleEventGiftPaidUpgradeEventJoinEventJoinFailureEventLeaveEventMessageEventMessageRemoveEventPrimePaidUpgradeEventRaidCancelEventRaidEventSlowModeToggleEventStandardPayForwardEventSubEventSubGiftEventSubsOnlyToggleEventUniqueChatToggleEventWhisperEvent

Functions

createBotCommand

Interfaces

BotConfigCreateBotCommandOptions

Type aliases

BotAuthMethodChatAnnouncementColor

SubsOnlyToggleEvent

An event representing subscriber-only mode being toggled in a channel.

Overview

Properties

Methods

Properties

broadcasterName

Type: string

The name of the broadcaster.

enabled

Type: boolean

Whether subscriber-only mode was enabled.

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

Methods

disable()

async

Disables subscriber-only mode in the channel.

Return type: void

enable()

async

Enables subscriber-only mode in the channel.

Return type: void

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser