Package com.github.twitch4j.eventsub.subscriptions

Interface SubscriptionType<C extends EventSubCondition,B,E extends EventSubEvent>

All Known Implementing Classes:
AutomodMessageHoldType, AutomodMessageUpdateType, AutomodSettingsUpdateType, AutomodTermsUpdateType, ChannelAdBreakBeginType, ChannelBanType, ChannelCharityDonateType, ChannelChatClearType, ChannelChatMessageType, ChannelChatNotificationType, ChannelChatSettingsUpdateType, ChannelCheerType, ChannelClearUserMessagesType, ChannelFollowType, ChannelFollowTypeV2, ChannelGoalBeginType, ChannelGoalEndType, ChannelGoalProgressType, ChannelMessageDeleteType, ChannelModerateType, ChannelModeratorAddType, ChannelModeratorRemoveType, ChannelPointsAutomaticRewardRedemptionAddType, ChannelPointsCustomRewardAddType, ChannelPointsCustomRewardRedemptionAddType, ChannelPointsCustomRewardRedemptionUpdateType, ChannelPointsCustomRewardRemoveType, ChannelPointsCustomRewardUpdateType, ChannelRaidType, ChannelSubscribeType, ChannelSubscriptionEndType, ChannelSubscriptionGiftType, ChannelSubscriptionMessageType, ChannelUnbanType, ChannelUpdateType, ChannelUpdateV2Type, ChannelVipAddType, ChannelVipRemoveType, ChannelWarningAcknowledgeType, ChannelWarningSendType, CharityCampaignProgressType, CharityCampaignStartType, CharityCampaignStopType, ConduitShardDisabledType, DropEntitlementGrantType, ExtensionBitsTransactionCreateType, HypeTrainBeginType, HypeTrainEndType, HypeTrainProgressType, PollBeginType, PollEndType, PollProgressType, PredictionBeginType, PredictionEndType, PredictionLockType, PredictionProgressType, ShieldModeBeginType, ShieldModeEndType, ShoutoutCreateType, ShoutoutReceiveType, StreamOfflineType, StreamOnlineType, SuspiciousUserMessageType, SuspiciousUserUpdateType, UnbanRequestCreateType, UnbanRequestResolveType, UserAuthorizationGrantType, UserAuthorizationRevokeType, UserMessageHoldType, UserMessageUpdateType, UserUpdateType, WhisperReceivedType
public interface SubscriptionType<C extends EventSubCondition,B,E extends EventSubEvent>

  • Method Details

    • getName

      String getName()
      Returns:
      the subscription type name.

    • getVersion

      String getVersion()
      Returns:
      the subscription type version.

    • getConditionBuilder

      B getConditionBuilder()
      The parameters inside these objects differ by subscription type and may differ by version.
      Returns:
      Subscription-specific parameter builder.

    • getEventClass

      Class<E> getEventClass()
      Returns:
      the associated event class for this subscription type.

    • isBatchingEnabled

      default boolean isBatchingEnabled()
      Returns:
      whether Twitch batches events for this subscription type.

    • getConditionClass

      default Class<C> getConditionClass()

    • prepareSubscription

      default EventSubSubscription prepareSubscription(Function<B,C> conditions, EventSubTransport transport)