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

Core functionality

BotBotCommandBotCommandContext

Events

AnnouncementEventBanEventBitsBadgeUpgradeEventChatClearEventCommunityPayForwardEventCommunitySubEventEmoteOnlyToggleEventFollowersOnlyToggleEventGiftPaidUpgradeEventJoinEventJoinFailureEventLeaveEventMessageEventMessageRemoveEventPrimePaidUpgradeEventRaidCancelEventRaidEventSlowModeToggleEventStandardPayForwardEventSubEventSubGiftEventSubsOnlyToggleEventUniqueChatToggleEventWhisperEvent

Functions

createBotCommand

Interfaces

BotConfigCreateBotCommandOptions

Type aliases

BotAuthMethodChatAnnouncementColor

PrimePaidUpgradeEvent

An event representing a free subscription from Prime Gaming being replaced by a paid one.

Overview

Properties

Methods

Constructor

new PrimePaidUpgradeEvent(channel, userName, info, msg, bot)

ParameterTypeRequiredDefaultDescription
channelstringnonenone
userNamestringnonenone
infoChatSubUpgradeInfononenone
msgUserNoticenonenone
botBotnonenone

Properties

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

messageObject

Type: UserNotice

The full object that contains all the message information.

plan

Type: string

The plan of the subscription.

userDisplayName

Type: string

The display name of the user who paid for their subscription.

userId

Type: string

The ID of the user who paid for their subscription.

userName

Type: string

The name of the user who paid for their subscription.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getUser()

async

Gets more information about the user who paid for their subscription.

Return type: HelixUser