eventsub/io.github.captnblubber.twitchkt.eventsub/EventSubSubscriptionType

EventSubSubscriptionType

sealed class EventSubSubscriptionType : EventSubSubscriptionType

Type-safe representation of an EventSub subscription type.

Each subclass encodes the Twitch type string, version, and the exact condition fields required for that subscription — eliminating raw strings and untyped maps from the call site.

Inheritors

ChannelSubscribe

ChannelSubscriptionGift

ChannelSubscriptionMessage

ChannelSubscriptionEnd

ChannelChatMessage

ChannelChatNotification

ChannelPointsRedemptionAdd

ChannelPointsRedemptionUpdate

HypeTrainProgress

ChannelAdBreakBegin

ChannelChatClear

ChannelChatClearUserMessages

ChannelChatMessageDelete

ChannelChatSettingsUpdate

ChannelChatUserMessageHold

ChannelChatUserMessageUpdate

ChannelSharedChatBegin

ChannelSharedChatUpdate

ChannelSharedChatEnd

ChannelModerate

ChannelModeratorAdd

ChannelModeratorRemove

ChannelUnbanRequestCreate

ChannelUnbanRequestResolve

ChannelSuspiciousUserMessage

ChannelSuspiciousUserUpdate

ChannelWarningAcknowledge

ChannelWarningSend

ChannelVipRemove

ChannelShieldModeBegin

ChannelShieldModeEnd

ChannelPointsAutomaticRedemptionAdd

ChannelPointsCustomRewardAdd

ChannelPointsCustomRewardUpdate

ChannelPointsCustomRewardRemove

PredictionBegin

PredictionProgress

ChannelGoalBegin

ChannelGoalProgress

CharityCampaignStart

CharityCampaignProgress

CharityCampaignStop

AutomodMessageHold

AutomodMessageUpdate

AutomodSettingsUpdate

AutomodTermsUpdate

ChannelShoutoutCreate

ChannelShoutoutReceive

UserAuthorizationGrant

UserAuthorizationRevoke

ExtensionBitsTransactionCreate

ConduitShardDisabled

Types

AutomodMessageHold

class AutomodMessageHold(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

automod.message.hold v2

AutomodMessageUpdate

class AutomodMessageUpdate(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

automod.message.update v2

AutomodSettingsUpdate

class AutomodSettingsUpdate(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

automod.settings.update v2

AutomodTermsUpdate

class AutomodTermsUpdate(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

automod.terms.update v1

ChannelAdBreakBegin

class ChannelAdBreakBegin(val broadcasterUserId: String) : EventSubSubscriptionType

channel.ad_break.begin v1

class ChannelBan(val broadcasterUserId: String) : EventSubSubscriptionType

class ChannelBitsUse(val broadcasterUserId: String) : EventSubSubscriptionType

channel.bits.use v1

ChannelChatClear

class ChannelChatClear(val broadcasterUserId: String, val userId: String) : EventSubSubscriptionType

channel.chat.clear v1

ChannelChatClearUserMessages

class ChannelChatClearUserMessages(val broadcasterUserId: String, val userId: String) : EventSubSubscriptionType

channel.chat.clear_user_messages v1

ChannelChatMessage

class ChannelChatMessage(val broadcasterUserId: String, val userId: String) : EventSubSubscriptionType

channel.chat.message v1

ChannelChatMessageDelete

class ChannelChatMessageDelete(val broadcasterUserId: String, val userId: String) : EventSubSubscriptionType

channel.chat.message_delete v1

ChannelChatNotification

class ChannelChatNotification(val broadcasterUserId: String, val userId: String) : EventSubSubscriptionType

channel.chat.notification v1

ChannelChatSettingsUpdate

class ChannelChatSettingsUpdate(val broadcasterUserId: String, val userId: String) : EventSubSubscriptionType

channel.chat_settings.update v1

ChannelChatUserMessageHold

class ChannelChatUserMessageHold(val broadcasterUserId: String, val userId: String) : EventSubSubscriptionType

channel.chat.user_message_hold v1

ChannelChatUserMessageUpdate

class ChannelChatUserMessageUpdate(val broadcasterUserId: String, val userId: String) : EventSubSubscriptionType

channel.chat.user_message_update v1

class ChannelCheer(val broadcasterUserId: String) : EventSubSubscriptionType

channel.cheer v1

class ChannelFollow(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.follow v2

ChannelGoalBegin

class ChannelGoalBegin(val broadcasterUserId: String) : EventSubSubscriptionType

channel.goal.begin v1

class ChannelGoalEnd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.goal.end v1

ChannelGoalProgress

class ChannelGoalProgress(val broadcasterUserId: String) : EventSubSubscriptionType

channel.goal.progress v1

ChannelModerate

class ChannelModerate(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.moderate v2

ChannelModeratorAdd

class ChannelModeratorAdd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.moderator.add v1

ChannelModeratorRemove

class ChannelModeratorRemove(val broadcasterUserId: String) : EventSubSubscriptionType

channel.moderator.remove v1

ChannelPointsAutomaticRedemptionAdd

class ChannelPointsAutomaticRedemptionAdd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.channel_points_automatic_reward_redemption.add v2

ChannelPointsCustomRewardAdd

class ChannelPointsCustomRewardAdd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.channel_points_custom_reward.add v1

ChannelPointsCustomRewardRemove

class ChannelPointsCustomRewardRemove(val broadcasterUserId: String) : EventSubSubscriptionType

channel.channel_points_custom_reward.remove v1

ChannelPointsCustomRewardUpdate

class ChannelPointsCustomRewardUpdate(val broadcasterUserId: String) : EventSubSubscriptionType

channel.channel_points_custom_reward.update v1

ChannelPointsRedemptionAdd

class ChannelPointsRedemptionAdd(val broadcasterUserId: String, val rewardId: String? = null) : EventSubSubscriptionType

channel.channel_points_custom_reward_redemption.add v1

ChannelPointsRedemptionUpdate

class ChannelPointsRedemptionUpdate(val broadcasterUserId: String, val rewardId: String? = null) : EventSubSubscriptionType

channel.channel_points_custom_reward_redemption.update v1

class ChannelRaid(val toBroadcasterUserId: String) : EventSubSubscriptionType

channel.raid v1

ChannelSharedChatBegin

class ChannelSharedChatBegin(val broadcasterUserId: String) : EventSubSubscriptionType

channel.shared_chat.begin v1

ChannelSharedChatEnd

class ChannelSharedChatEnd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.shared_chat.end v1

ChannelSharedChatUpdate

class ChannelSharedChatUpdate(val broadcasterUserId: String) : EventSubSubscriptionType

channel.shared_chat.update v1

ChannelShieldModeBegin

class ChannelShieldModeBegin(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.shield_mode.begin v1

ChannelShieldModeEnd

class ChannelShieldModeEnd(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.shield_mode.end v1

ChannelShoutoutCreate

class ChannelShoutoutCreate(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.shoutout.create v1

ChannelShoutoutReceive

class ChannelShoutoutReceive(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.shoutout.receive v1

ChannelSubscribe

class ChannelSubscribe(val broadcasterUserId: String) : EventSubSubscriptionType

channel.subscribe v1

ChannelSubscriptionEnd

class ChannelSubscriptionEnd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.subscription.end v1

ChannelSubscriptionGift

class ChannelSubscriptionGift(val broadcasterUserId: String) : EventSubSubscriptionType

channel.subscription.gift v1

ChannelSubscriptionMessage

class ChannelSubscriptionMessage(val broadcasterUserId: String) : EventSubSubscriptionType

channel.subscription.message v1

ChannelSuspiciousUserMessage

class ChannelSuspiciousUserMessage(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.suspicious_user.message v1

ChannelSuspiciousUserUpdate

class ChannelSuspiciousUserUpdate(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.suspicious_user.update v1

class ChannelUnban(val broadcasterUserId: String) : EventSubSubscriptionType

channel.unban v1

ChannelUnbanRequestCreate

class ChannelUnbanRequestCreate(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.unban_request.create v1

ChannelUnbanRequestResolve

class ChannelUnbanRequestResolve(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.unban_request.resolve v1

class ChannelUpdate(val broadcasterUserId: String) : EventSubSubscriptionType

channel.update v2

class ChannelVipAdd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.vip.add v1

ChannelVipRemove

class ChannelVipRemove(val broadcasterUserId: String) : EventSubSubscriptionType

channel.vip.remove v1

ChannelWarningAcknowledge

class ChannelWarningAcknowledge(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.warning.acknowledge v1

ChannelWarningSend

class ChannelWarningSend(val broadcasterUserId: String, val moderatorUserId: String) : EventSubSubscriptionType

channel.warning.send v1

CharityCampaignProgress

class CharityCampaignProgress(val broadcasterUserId: String) : EventSubSubscriptionType

channel.charity_campaign.progress v1

CharityCampaignStart

class CharityCampaignStart(val broadcasterUserId: String) : EventSubSubscriptionType

channel.charity_campaign.start v1

CharityCampaignStop

class CharityCampaignStop(val broadcasterUserId: String) : EventSubSubscriptionType

channel.charity_campaign.stop v1

class CharityDonate(val broadcasterUserId: String) : EventSubSubscriptionType

channel.charity_campaign.donate v1

ConduitShardDisabled

class ConduitShardDisabled(val clientId: String) : EventSubSubscriptionType

conduit.shard.disabled v1

ExtensionBitsTransactionCreate

class ExtensionBitsTransactionCreate(val extensionClientId: String) : EventSubSubscriptionType

extension.bits_transaction.create v1

class HypeTrainBegin(val broadcasterUserId: String) : EventSubSubscriptionType

channel.hype_train.begin v2

class HypeTrainEnd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.hype_train.end v2

HypeTrainProgress

class HypeTrainProgress(val broadcasterUserId: String) : EventSubSubscriptionType

channel.hype_train.progress v2

class PollBegin(val broadcasterUserId: String) : EventSubSubscriptionType

channel.poll.begin v1

class PollEnd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.poll.end v1

class PollProgress(val broadcasterUserId: String) : EventSubSubscriptionType

channel.poll.progress v1

PredictionBegin

class PredictionBegin(val broadcasterUserId: String) : EventSubSubscriptionType

channel.prediction.begin v1

class PredictionEnd(val broadcasterUserId: String) : EventSubSubscriptionType

channel.prediction.end v1

class PredictionLock(val broadcasterUserId: String) : EventSubSubscriptionType

channel.prediction.lock v1

PredictionProgress

class PredictionProgress(val broadcasterUserId: String) : EventSubSubscriptionType

channel.prediction.progress v1

class StreamOffline(val broadcasterUserId: String) : EventSubSubscriptionType

stream.offline v1

class StreamOnline(val broadcasterUserId: String) : EventSubSubscriptionType

stream.online v1

UserAuthorizationGrant

class UserAuthorizationGrant(val clientId: String) : EventSubSubscriptionType

user.authorization.grant v1

UserAuthorizationRevoke

class UserAuthorizationRevoke(val clientId: String) : EventSubSubscriptionType

user.authorization.revoke v1

class UserUpdate(val userId: String) : EventSubSubscriptionType

Properties

open override val type: String

the EventSub subscription type identifier (e.g. channel.follow).

open override val version: String

the schema version for this subscription type.

Functions

abstract override fun toCondition(): Map<String, String>

Serializes the typed condition fields into the condition map expected by the Twitch API.