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

Classes

EventSubChannelBanEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatSettingsUpdateEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEvent

Interfaces

EventSubBaseConfigEventSubListener

Type aliases

EventSubChannelChatNotificationEventEventSubChannelGoalTypeEventSubChannelHypeTrainContributionTypeEventSubChannelPollEndStatusEventSubChannelPredictionColorEventSubChannelPredictionEndStatusEventSubChannelSubscriptionEndEventTierEventSubChannelSubscriptionEventTierEventSubChannelSubscriptionGiftEventTierEventSubChannelSubscriptionMessageEventTierEventSubStreamOnlineEventStreamType

EventSubChannelSubscriptionMessageEvent

An EventSub event representing the public announcement of a channel subscription by the subscriber.

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

cumulativeMonths

Type: number

The total number of months the user has been subscribed.

durationMonths

Type: number

The number of months the user has now subscribed.

emoteOffsets

Type: Map<string, string[]>

The offsets of emote usages in the message.

messageText

Type: string

The text of the message.

streakMonths

Type: number | null

The number of months the user has been subscribed in a row, or null if they don't want to share it.

tier

Type: EventSubChannelSubscriptionMessageEventTier

The tier of the subscription, either 1000, 2000 or 3000.

userDisplayName

Type: string

The display name of the user whose subscription is being announced.

userId

Type: string

The ID of the user whose subscription is being announced.

userName

Type: string

The name of the user whose subscription is being announced.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getUser()

async

Gets more information about the user whose subscription is being announced.

Return type: HelixUser