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

Core functionality

BotBotCommandBotCommandContext

Events

AnnouncementEventBanEventBitsBadgeUpgradeEventChatClearEventCommunityPayForwardEventCommunitySubEventEmoteOnlyToggleEventFollowersOnlyToggleEventGiftPaidUpgradeEventJoinEventJoinFailureEventLeaveEventMessageEventMessageRemoveEventPrimePaidUpgradeEventRaidCancelEventRaidEventSlowModeToggleEventStandardPayForwardEventSubEventSubGiftEventSubsOnlyToggleEventUniqueChatToggleEventWhisperEvent

Functions

createBotCommand

Interfaces

BotConfigCreateBotCommandOptions

Type aliases

BotAuthMethodChatAnnouncementColor

FollowersOnlyToggleEvent

An event representing followers-only 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 minutes) a user needs to follow the channel in order to be able to send messages in its chat.

There needs to be a distinction between the values 0 (a user can chat immediately after following) and null (followers-only mode was disabled).

enabled

Type: boolean

Whether followers-only mode was enabled.

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

Methods

disable()

async

Disables followers-only mode in the channel.

Return type: void

enable(delay)

async

Enables followers-only mode in the channel.

ParameterTypeRequiredDefaultDescription
delaynumber0

The time (in minutes) a user needs to follow the channel in order to be able to send messages.

Return type: void

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser