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

EventSubChannelShieldModeBeginEvent

An EventSub event representing Shield Mode being activated on a broadcaster's channel.

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster on whose channel Shield Mode was activated.

broadcasterId

Type: string

The ID of the broadcaster on whose channel Shield Mode was activated.

broadcasterName

Type: string

The name of the broadcaster on whose channel Shield Mode was activated.

moderatorDisplayName

Type: string

The display name of the moderator who activated Shield Mode

moderatorId

Type: string

The ID of the moderator who activated Shield Mode.

moderatorName

Type: string

The name of the moderator who activated Shield Mode.

startDate

Type: Date

The date when Shield Mode was activated.

Methods

getBroadcaster()

Gets more information about the broadcaster.

Return type: HelixUser

getModerator()

Gets more information about the moderator.

Return type: HelixUser