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

Classes

EventSubAutoModMessageAutoModEventSubAutoModMessageAutoModBoundaryEventSubAutoModMessageBlockedTermEventSubAutoModMessageHoldEventEventSubAutoModMessageHoldV2EventEventSubAutoModMessageUpdateEventEventSubAutoModMessageUpdateV2EventEventSubAutoModSettingsUpdateEventEventSubAutoModTermsUpdateEventEventSubChannelAdBreakBeginEventEventSubChannelAutomaticRewardRedemptionAddEventEventSubChannelAutoModTermsModerationEventEventSubChannelBanEventEventSubChannelBanModerationEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatAnnouncementNotificationEventEventSubChannelChatBitsBadgeTierNotificationEventEventSubChannelChatCharityDonationNotificationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatCommunitySubGiftNotificationEventEventSubChannelChatGiftPaidUpgradeNotificationEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatPayItForwardNotificationEventEventSubChannelChatPrimePaidUpgradeNotificationEventEventSubChannelChatRaidNotificationEventEventSubChannelChatResubNotificationEventEventSubChannelChatSettingsUpdateEventEventSubChannelChatSharedChatAnnouncementNotificationEventEventSubChannelChatSharedChatCommunitySubGiftNotificationEventEventSubChannelChatSharedChatGiftPaidUpgradeNotificationEventEventSubChannelChatSharedChatPayItForwardNotificationEventEventSubChannelChatSharedChatPrimePaidUpgradeNotificationEventEventSubChannelChatSharedChatRaidNotificationEventEventSubChannelChatSharedChatResubNotificationEventEventSubChannelChatSharedChatSubGiftNotificationEventEventSubChannelChatSharedChatSubNotificationEventEventSubChannelChatSubGiftNotificationEventEventSubChannelChatSubNotificationEventEventSubChannelChatUnraidNotificationEventEventSubChannelChatUserMessageHoldEventEventSubChannelChatUserMessageUpdateEventEventSubChannelCheerEventEventSubChannelClearModerationEventEventSubChannelDeleteModerationEventEventSubChannelEmoteOnlyModerationEventEventSubChannelEmoteOnlyOffModerationEventEventSubChannelFollowersModerationEventEventSubChannelFollowersOffModerationEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelModModerationEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRaidModerationEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelSharedChatBanModerationEventEventSubChannelSharedChatDeleteModerationEventEventSubChannelSharedChatSessionBeginEventEventSubChannelSharedChatSessionEndEventEventSubChannelSharedChatSessionParticipantEventSubChannelSharedChatSessionUpdateEventEventSubChannelSharedChatTimeoutModerationEventEventSubChannelSharedChatUnbanModerationEventEventSubChannelSharedChatUntimeoutModerationEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSlowModerationEventEventSubChannelSlowOffModerationEventEventSubChannelSubscribersModerationEventEventSubChannelSubscribersOffModerationEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelSuspiciousUserMessageEventEventSubChannelSuspiciousUserUpdateEventEventSubChannelTimeoutModerationEventEventSubChannelUnbanEventEventSubChannelUnbanModerationEventEventSubChannelUnbanRequestCreateEventEventSubChannelUnbanRequestModerationEventEventSubChannelUnbanRequestResolveEventEventSubChannelUniqueChatModerationEventEventSubChannelUniqueChatOffModerationEventEventSubChannelUnmodModerationEventEventSubChannelUnraidModerationEventEventSubChannelUntimeoutModerationEventEventSubChannelUnvipModerationEventEventSubChannelUpdateEventEventSubChannelVipEventEventSubChannelVipModerationEventEventSubChannelWarningAcknowledgeEventEventSubChannelWarningSendEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEventEventSubUserWhisperMessageEvent

Interfaces

EventSubBaseConfigEventSubListener

Type aliases

EventSubAutomaticRewardTypeEventSubAutoModLevelEventSubAutoModMessageHoldReasonEventSubAutoModResolutionStatusEventSubAutoModTermsUpdateActionEventSubChannelAutomodTermsModerationEventActionEventSubChannelAutomodTermsModerationEventListEventSubChannelBanEvasionEvaluationEventSubChannelChatAnnouncementColorEventSubChannelChatNotificationEventEventSubChannelChatNotificationSubTierEventSubChannelChatNotificationTypeEventSubChannelGoalTypeEventSubChannelHypeTrainContributionTypeEventSubChannelModerationActionEventSubChannelModerationEventEventSubChannelPollEndStatusEventSubChannelPredictionColorEventSubChannelPredictionEndStatusEventSubChannelSubscriptionEndEventTierEventSubChannelSubscriptionEventTierEventSubChannelSubscriptionGiftEventTierEventSubChannelSubscriptionMessageEventTierEventSubChannelSuspiciousUserLowTrustStatusEventSubChannelSuspiciousUserTypeEventSubChannelUnbanRequestStatusEventSubStreamOnlineEventStreamType

EventSubChannelSharedChatTimeoutModerationEvent

An EventSub event representing a moderator timing out a user in another channel during a shared chat session.

Overview

Properties

Methods

Properties

expiryDate

Type: Date

The time at which the timeout ends.

moderationAction

Value: "shared_chat_timeout"

reason

Type: string

The reason given for the timeout.

userDisplayName

Type: string

The display name of the user being timed out.

userId

Type: string

The ID of the user being timed out.

userName

Type: string

The name of the user being timed out.

Methods

getUser()

async

Gets more information about the user.

Return type: HelixUser | null