Twurple Authentication Getting data Examples FAQ Migration

Reference

api api-call auth auth-tmi chat common easy-bot ebs-helper eventsub-base eventsub-http eventsub-ws pubsub

Classes

EventSubChannelAdBreakBeginEvent EventSubChannelBanEvent EventSubChannelCharityAmount EventSubChannelCharityCampaignProgressEvent EventSubChannelCharityCampaignStartEvent EventSubChannelCharityCampaignStopEvent EventSubChannelCharityDonationEvent EventSubChannelChatClearEvent EventSubChannelChatClearUserMessagesEvent EventSubChannelChatMessageDeleteEvent EventSubChannelChatMessageEvent EventSubChannelChatSettingsUpdateEvent EventSubChannelCheerEvent EventSubChannelFollowEvent EventSubChannelGoalBeginEvent EventSubChannelGoalEndEvent EventSubChannelGoalProgressEvent EventSubChannelHypeTrainBeginEvent EventSubChannelHypeTrainContribution EventSubChannelHypeTrainEndEvent EventSubChannelHypeTrainProgressEvent EventSubChannelModeratorEvent EventSubChannelPollBeginChoice EventSubChannelPollBeginEvent EventSubChannelPollChoice EventSubChannelPollEndEvent EventSubChannelPollProgressEvent EventSubChannelPredictionBeginEvent EventSubChannelPredictionBeginOutcome EventSubChannelPredictionEndEvent EventSubChannelPredictionLockEvent EventSubChannelPredictionOutcome EventSubChannelPredictionPredictor EventSubChannelPredictionProgressEvent EventSubChannelRaidEvent EventSubChannelRedemptionAddEvent EventSubChannelRedemptionUpdateEvent EventSubChannelRewardEvent EventSubChannelShieldModeBeginEvent EventSubChannelShieldModeEndEvent EventSubChannelShoutoutCreateEvent EventSubChannelShoutoutReceiveEvent EventSubChannelSubscriptionEndEvent EventSubChannelSubscriptionEvent EventSubChannelSubscriptionGiftEvent EventSubChannelSubscriptionMessageEvent EventSubChannelUnbanEvent EventSubChannelUpdateEvent EventSubDropEntitlementGrantEvent EventSubExtensionBitsTransactionCreateEvent EventSubStreamOfflineEvent EventSubStreamOnlineEvent EventSubSubscription EventSubUserAuthorizationGrantEvent EventSubUserAuthorizationRevokeEvent EventSubUserUpdateEvent

Interfaces

EventSubBaseConfig EventSubListener

Type aliases

EventSubChannelChatNotificationEvent EventSubChannelGoalType EventSubChannelHypeTrainContributionType EventSubChannelPollEndStatus EventSubChannelPredictionColor EventSubChannelPredictionEndStatus EventSubChannelSubscriptionEndEventTier EventSubChannelSubscriptionEventTier EventSubChannelSubscriptionGiftEventTier EventSubChannelSubscriptionMessageEventTier EventSubStreamOnlineEventStreamType

EventSubChannelPredictionPredictor

A user that voted on a prediction.

Overview

Properties

Methods

getUsera

Properties

channelPointsUsed

Type: number

The number of channel points the predictor used.

channelPointsWon

Type: number | null

The number of channel points the predictor won, or null if they didn't win (yet).

userDisplayName

Type: string

The display name of the predictor.

userId

Type: string

The ID of the predictor.

userName

Type: string

The name of the predictor.

Methods

getUser()

Gets more information about the predictor.

Return type: HelixUser