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

EventSubAutoModMessageAutoMod EventSubAutoModMessageAutoModBoundary EventSubAutoModMessageBlockedTerm EventSubAutoModMessageHoldEvent EventSubAutoModMessageHoldV2Event EventSubAutoModMessageUpdateEvent EventSubAutoModMessageUpdateV2Event EventSubAutoModSettingsUpdateEvent EventSubAutoModTermsUpdateEvent EventSubChannelAdBreakBeginEvent EventSubChannelAutomaticRewardRedemptionAddEvent EventSubChannelAutoModTermsModerationEvent EventSubChannelBanEvent EventSubChannelBanModerationEvent EventSubChannelCharityAmount EventSubChannelCharityCampaignProgressEvent EventSubChannelCharityCampaignStartEvent EventSubChannelCharityCampaignStopEvent EventSubChannelCharityDonationEvent EventSubChannelChatAnnouncementNotificationEvent EventSubChannelChatBitsBadgeTierNotificationEvent EventSubChannelChatCharityDonationNotificationEvent EventSubChannelChatClearEvent EventSubChannelChatClearUserMessagesEvent EventSubChannelChatCommunitySubGiftNotificationEvent EventSubChannelChatGiftPaidUpgradeNotificationEvent EventSubChannelChatMessageDeleteEvent EventSubChannelChatMessageEvent EventSubChannelChatPayItForwardNotificationEvent EventSubChannelChatPrimePaidUpgradeNotificationEvent EventSubChannelChatRaidNotificationEvent EventSubChannelChatResubNotificationEvent EventSubChannelChatSettingsUpdateEvent EventSubChannelChatSharedChatAnnouncementNotificationEvent EventSubChannelChatSharedChatCommunitySubGiftNotificationEvent EventSubChannelChatSharedChatGiftPaidUpgradeNotificationEvent EventSubChannelChatSharedChatPayItForwardNotificationEvent EventSubChannelChatSharedChatPrimePaidUpgradeNotificationEvent EventSubChannelChatSharedChatRaidNotificationEvent EventSubChannelChatSharedChatResubNotificationEvent EventSubChannelChatSharedChatSubGiftNotificationEvent EventSubChannelChatSharedChatSubNotificationEvent EventSubChannelChatSubGiftNotificationEvent EventSubChannelChatSubNotificationEvent EventSubChannelChatUnraidNotificationEvent EventSubChannelChatUserMessageHoldEvent EventSubChannelChatUserMessageUpdateEvent EventSubChannelCheerEvent EventSubChannelClearModerationEvent EventSubChannelDeleteModerationEvent EventSubChannelEmoteOnlyModerationEvent EventSubChannelEmoteOnlyOffModerationEvent EventSubChannelFollowersModerationEvent EventSubChannelFollowersOffModerationEvent EventSubChannelFollowEvent EventSubChannelGoalBeginEvent EventSubChannelGoalEndEvent EventSubChannelGoalProgressEvent EventSubChannelHypeTrainBeginEvent EventSubChannelHypeTrainContribution EventSubChannelHypeTrainEndEvent EventSubChannelHypeTrainProgressEvent EventSubChannelModeratorEvent EventSubChannelModModerationEvent EventSubChannelPollBeginChoice EventSubChannelPollBeginEvent EventSubChannelPollChoice EventSubChannelPollEndEvent EventSubChannelPollProgressEvent EventSubChannelPredictionBeginEvent EventSubChannelPredictionBeginOutcome EventSubChannelPredictionEndEvent EventSubChannelPredictionLockEvent EventSubChannelPredictionOutcome EventSubChannelPredictionPredictor EventSubChannelPredictionProgressEvent EventSubChannelRaidEvent EventSubChannelRaidModerationEvent EventSubChannelRedemptionAddEvent EventSubChannelRedemptionUpdateEvent EventSubChannelRewardEvent EventSubChannelSharedChatBanModerationEvent EventSubChannelSharedChatDeleteModerationEvent EventSubChannelSharedChatSessionBeginEvent EventSubChannelSharedChatSessionEndEvent EventSubChannelSharedChatSessionParticipant EventSubChannelSharedChatSessionUpdateEvent EventSubChannelSharedChatTimeoutModerationEvent EventSubChannelSharedChatUnbanModerationEvent EventSubChannelSharedChatUntimeoutModerationEvent EventSubChannelShieldModeBeginEvent EventSubChannelShieldModeEndEvent EventSubChannelShoutoutCreateEvent EventSubChannelShoutoutReceiveEvent EventSubChannelSlowModerationEvent EventSubChannelSlowOffModerationEvent EventSubChannelSubscribersModerationEvent EventSubChannelSubscribersOffModerationEvent EventSubChannelSubscriptionEndEvent EventSubChannelSubscriptionEvent EventSubChannelSubscriptionGiftEvent EventSubChannelSubscriptionMessageEvent EventSubChannelSuspiciousUserMessageEvent EventSubChannelSuspiciousUserUpdateEvent EventSubChannelTimeoutModerationEvent EventSubChannelUnbanEvent EventSubChannelUnbanModerationEvent EventSubChannelUnbanRequestCreateEvent EventSubChannelUnbanRequestModerationEvent EventSubChannelUnbanRequestResolveEvent EventSubChannelUniqueChatModerationEvent EventSubChannelUniqueChatOffModerationEvent EventSubChannelUnmodModerationEvent EventSubChannelUnraidModerationEvent EventSubChannelUntimeoutModerationEvent EventSubChannelUnvipModerationEvent EventSubChannelUpdateEvent EventSubChannelVipEvent EventSubChannelVipModerationEvent EventSubChannelWarningAcknowledgeEvent EventSubChannelWarningSendEvent EventSubDropEntitlementGrantEvent EventSubExtensionBitsTransactionCreateEvent EventSubStreamOfflineEvent EventSubStreamOnlineEvent EventSubSubscription EventSubUserAuthorizationGrantEvent EventSubUserAuthorizationRevokeEvent EventSubUserUpdateEvent EventSubUserWhisperMessageEvent

Interfaces

EventSubBaseConfig EventSubListener

Type aliases

EventSubAutomaticRewardType EventSubAutoModLevel EventSubAutoModMessageHoldReason EventSubAutoModResolutionStatus EventSubAutoModTermsUpdateAction EventSubChannelAutomodTermsModerationEventAction EventSubChannelAutomodTermsModerationEventList EventSubChannelBanEvasionEvaluation EventSubChannelChatAnnouncementColor EventSubChannelChatNotificationEvent EventSubChannelChatNotificationSubTier EventSubChannelChatNotificationType EventSubChannelGoalType EventSubChannelHypeTrainContributionType EventSubChannelModerationAction EventSubChannelModerationEvent EventSubChannelPollEndStatus EventSubChannelPredictionColor EventSubChannelPredictionEndStatus EventSubChannelSubscriptionEndEventTier EventSubChannelSubscriptionEventTier EventSubChannelSubscriptionGiftEventTier EventSubChannelSubscriptionMessageEventTier EventSubChannelSuspiciousUserLowTrustStatus EventSubChannelSuspiciousUserType EventSubChannelUnbanRequestStatus EventSubStreamOnlineEventStreamType

EventSubAutoModMessageHoldEvent

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

Overview

Properties

Methods

Properties

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.

category

Type: string

The category of the message.

holdDate

Type: Date

The date of when AutoMod held the message.

level

Type: EventSubAutoModLevel

The level of severity.

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.

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()

Gets more information about the broadcaster.

Return type: HelixUser

getUser()

Gets more information about the user.

Return type: HelixUser