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

Classes

EventSubAutoModMessageAutoModEventSubAutoModMessageAutoModBoundaryEventSubAutoModMessageBlockedTermEventSubAutoModMessageHoldEventEventSubAutoModMessageHoldV2EventEventSubAutoModMessageUpdateEventEventSubAutoModMessageUpdateV2EventEventSubAutoModSettingsUpdateEventEventSubAutoModTermsUpdateEventEventSubChannelAdBreakBeginEventEventSubChannelAutomaticRewardRedemptionAddEventEventSubChannelAutoModTermsModerationEventEventSubChannelBanEventEventSubChannelBanModerationEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatAnnouncementNotificationEventEventSubChannelChatBitsBadgeTierNotificationEventEventSubChannelChatCharityDonationNotificationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatCommunitySubGiftNotificationEventEventSubChannelChatGiftPaidUpgradeNotificationEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatPayItForwardNotificationEventEventSubChannelChatPrimePaidUpgradeNotificationEventEventSubChannelChatRaidNotificationEventEventSubChannelChatResubNotificationEventEventSubChannelChatSettingsUpdateEventEventSubChannelChatSharedChatAnnouncementNotificationEventEventSubChannelChatSharedChatCommunitySubGiftNotificationEventEventSubChannelChatSharedChatGiftPaidUpgradeNotificationEventEventSubChannelChatSharedChatPayItForwardNotificationEventEventSubChannelChatSharedChatPrimePaidUpgradeNotificationEventEventSubChannelChatSharedChatRaidNotificationEventEventSubChannelChatSharedChatResubNotificationEventEventSubChannelChatSharedChatSubGiftNotificationEventEventSubChannelChatSharedChatSubNotificationEventEventSubChannelChatSubGiftNotificationEventEventSubChannelChatSubNotificationEventEventSubChannelChatUnraidNotificationEventEventSubChannelChatUserMessageHoldEventEventSubChannelChatUserMessageUpdateEventEventSubChannelCheerEventEventSubChannelClearModerationEventEventSubChannelDeleteModerationEventEventSubChannelEmoteOnlyModerationEventEventSubChannelEmoteOnlyOffModerationEventEventSubChannelFollowersModerationEventEventSubChannelFollowersOffModerationEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelModModerationEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRaidModerationEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelSharedChatBanModerationEventEventSubChannelSharedChatDeleteModerationEventEventSubChannelSharedChatSessionBeginEventEventSubChannelSharedChatSessionEndEventEventSubChannelSharedChatSessionParticipantEventSubChannelSharedChatSessionUpdateEventEventSubChannelSharedChatTimeoutModerationEventEventSubChannelSharedChatUnbanModerationEventEventSubChannelSharedChatUntimeoutModerationEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSlowModerationEventEventSubChannelSlowOffModerationEventEventSubChannelSubscribersModerationEventEventSubChannelSubscribersOffModerationEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelSuspiciousUserMessageEventEventSubChannelSuspiciousUserUpdateEventEventSubChannelTimeoutModerationEventEventSubChannelUnbanEventEventSubChannelUnbanModerationEventEventSubChannelUnbanRequestCreateEventEventSubChannelUnbanRequestModerationEventEventSubChannelUnbanRequestResolveEventEventSubChannelUniqueChatModerationEventEventSubChannelUniqueChatOffModerationEventEventSubChannelUnmodModerationEventEventSubChannelUnraidModerationEventEventSubChannelUntimeoutModerationEventEventSubChannelUnvipModerationEventEventSubChannelUpdateEventEventSubChannelVipEventEventSubChannelVipModerationEventEventSubChannelWarningAcknowledgeEventEventSubChannelWarningSendEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEventEventSubUserWhisperMessageEvent

Interfaces

EventSubBaseConfigEventSubListener

Type aliases

EventSubAutomaticRewardTypeEventSubAutoModLevelEventSubAutoModMessageHoldReasonEventSubAutoModResolutionStatusEventSubAutoModTermsUpdateActionEventSubChannelAutomodTermsModerationEventActionEventSubChannelAutomodTermsModerationEventListEventSubChannelBanEvasionEvaluationEventSubChannelChatAnnouncementColorEventSubChannelChatNotificationEventEventSubChannelChatNotificationSubTierEventSubChannelChatNotificationTypeEventSubChannelGoalTypeEventSubChannelHypeTrainContributionTypeEventSubChannelModerationActionEventSubChannelModerationEventEventSubChannelPollEndStatusEventSubChannelPredictionColorEventSubChannelPredictionEndStatusEventSubChannelSubscriptionEndEventTierEventSubChannelSubscriptionEventTierEventSubChannelSubscriptionGiftEventTierEventSubChannelSubscriptionMessageEventTierEventSubChannelSuspiciousUserLowTrustStatusEventSubChannelSuspiciousUserTypeEventSubChannelUnbanRequestStatusEventSubStreamOnlineEventStreamType

EventSubAutoModMessageHoldV2Event

An EventSub event representing chat message being held by AutoMod in a channel.

Overview

Properties

Methods

Properties

autoMod

Type: EventSubAutoModMessageAutoMod | null

The AutoMod violation data if the message was caught by AutoMod.

This is only relevant if EventSubAutoModMessageHoldEvent#reason is automod, otherwise it is null.

blockedTerms

Type: EventSubAutoModMessageBlockedTerm[] | null

The list of blocked terms caused the message to be caught.

This is only relevant if EventSubAutoModMessageHoldEvent#reason is blocked_term, otherwise it is null.

broadcasterDisplayName

Type: string

The display name of the broadcaster in whose channel the message has been held by AutoMod.

broadcasterId

Type: string

The ID of the broadcaster in whose channel the message has been held by AutoMod.

broadcasterName

Type: string

The name of the broadcaster in whose channel the message has been held by AutoMod.

holdDate

Type: Date

The date of when AutoMod held the message.

messageId

Type: string

The ID of the chat message held by AutoMod.

messageParts

Type: EventSubAutoModMessagePart[]

The pre-parsed message parts.

messageText

Type: string

The plain text of the message.

reason

Type: EventSubAutoModMessageHoldReason

The reason why the message was caught.

userDisplayName

Type: string

The display name of the user whose message has been held by AutoMod.

userId

Type: string

The ID of the user whose message has been held by AutoMod.

userName

Type: string

The name of the user whose message has been held by AutoMod.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getUser()

async

Gets more information about the user.

Return type: HelixUser