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

Classes

EventSubChannelAdBreakBeginEventEventSubChannelBanEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatSettingsUpdateEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEvent

Interfaces

EventSubBaseConfigEventSubListener

Type aliases

EventSubChannelChatNotificationEventEventSubChannelGoalTypeEventSubChannelHypeTrainContributionTypeEventSubChannelPollEndStatusEventSubChannelPredictionColorEventSubChannelPredictionEndStatusEventSubChannelSubscriptionEndEventTierEventSubChannelSubscriptionEventTierEventSubChannelSubscriptionGiftEventTierEventSubChannelSubscriptionMessageEventTierEventSubStreamOnlineEventStreamType

EventSubChannelBanEvent

An EventSub event representing a user being banned in a channel.

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster from whose chat the user was banned.

broadcasterId

Type: string

The ID of the broadcaster from whose chat the user was banned.

broadcasterName

Type: string

The name of the broadcaster from whose chat the user was banned.

endDate

Type: Date | null

If it is a timeout, the date and time when the timeout will end. Will be null if permanent ban.

isPermanent

Type: boolean

Whether the ban is permanent.

moderatorDisplayName

Type: string

The display name of the moderator who issued the ban/timeout.

moderatorId

Type: string

The ID of the moderator who issued the ban/timeout.

moderatorName

Type: string

The name of the moderator who issued the ban/timeout.

reason

Type: string

The reason behind the ban.

startDate

Type: Date

The date and time when the user was banned or put in a timeout.

userDisplayName

Type: string

The display name of the banned user.

userId

Type: string

The ID of the banned user.

userName

Type: string

The name of the banned user.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getModerator()

async

Gets more information about the moderator.

Return type: HelixUser

getUser()

async

Gets more information about the banned user.

Return type: HelixUser