Package com.github.twitch4j.pubsub
Interface ITwitchPubSub
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
TwitchPubSub,TwitchPubSubConnectionPool
@Deprecated
@ScheduledForRemoval(inVersion="2.0.0")
public interface ITwitchPubSub
extends AutoCloseable
Deprecated.
Twitch will decommission PubSub on April 14, 2025, with shutdown windows starting in February.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Deprecated.Deprecated.longDeprecated.default PubSubSubscriptionlistenForAdPropertyRefreshEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForAdsEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForAdsManagerEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.default PubSubSubscriptionlistenForAutomodLevelsModificationEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.default PubSubSubscriptionlistenForAutomodQueueEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.default PubSubSubscriptionlistenForBitsBadgeEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.default PubSubSubscriptionlistenForBountyBoardEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForBroadcastSettingUpdateEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForCelebrationEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelBitsLeaderboardAllTimeEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelBitsLeaderboardEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelBitsLeaderboardEvents(OAuth2Credential credential, String channelId, String timeAggregationUnit) Deprecated.default PubSubSubscriptionlistenForChannelBitsLeaderboardMonthlyEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelChatroomEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelClipsLeaderboardEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelDropEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelExtensionEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelPointsRedemptionEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission PubSub on April 14, 2025.default PubSubSubscriptionlistenForChannelPredictionsEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelPrimeGiftStatusEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelSquadEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelSubGiftsEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelSubLeaderboardAllTimeEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelSubLeaderboardEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelSubLeaderboardEvents(OAuth2Credential credential, String channelId, String timeAggregationUnit) Deprecated.default PubSubSubscriptionlistenForChannelSubLeaderboardMonthlyEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChannelUnbanRequestEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.default PubSubSubscriptionlistenForCharityCampaignEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForChatHighlightEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.default PubSubSubscriptionlistenForCheerEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.default PubSubSubscriptionlistenForCommerceEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.default PubSubSubscriptionlistenForCommunityBoostEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForCreatorGoalsEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForCrowdChantEvents(OAuth2Credential credential, String channelId) Deprecated.the crowd chant experiment was disabled by Twitch on 2022-02-02default PubSubSubscriptionlistenForDashboardActivityFeedEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForExtensionControlEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForFollowingEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch has silently disabled this topic, even for first-party moderator tokens.default PubSubSubscriptionlistenForFollows(OAuth2Credential credential, String userId) Deprecated.Event Listener: Your account follows or unfollows any channel.default PubSubSubscriptionlistenForFriendshipEvents(OAuth2Credential credential, String userId) Deprecated.Friends are being removed by Twitch on 2022-05-25default PubSubSubscriptionlistenForHypeTrainEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForHypeTrainRewardEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForLeaderboardAllTimeEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForLeaderboardEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForLeaderboardEvents(OAuth2Credential credential, String channelId, String timeAggregationUnit) Deprecated.default PubSubSubscriptionlistenForLeaderboardMonthlyEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForLowTrustUsersEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.default PubSubSubscriptionlistenForModerationEvents(OAuth2Credential credential, String channelId) Deprecated.in favor of listenForModerationEvents(OAuth2Credential, String, String)default PubSubSubscriptionlistenForModerationEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.default PubSubSubscriptionlistenForOnsiteNotificationEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForPinnedChatEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForPollEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForPresenceEvents(OAuth2Credential credential, String userId) Deprecated.Friends are being removed by Twitch on 2022-05-25default PubSubSubscriptionlistenForPublicBitEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForPublicCheerEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForRadioEvents(OAuth2Credential credential, String channelId) default PubSubSubscriptionlistenForRaidEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForSharedChatEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForShieldModeEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.default PubSubSubscriptionlistenForShoutoutEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForStreamChangeEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForStreamChatRoomEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForSubscriptionEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.default PubSubSubscriptionlistenForUserBitsUpdateEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForUserCampaignEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForUserChannelPointsEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForUserChatroomEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForUserDropEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForUserImageUpdateEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForUserModerationNotificationEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.default PubSubSubscriptionlistenForUserPredictionsEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForUserPropertiesUpdateEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForUserSubscribeEvents(OAuth2Credential credential, String userId) Deprecated.default PubSubSubscriptionlistenForUserUnbanRequestEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.default PubSubSubscriptionlistenForVideoPlaybackByNameEvents(OAuth2Credential credential, String channelName) Deprecated.default PubSubSubscriptionlistenForVideoPlaybackEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForWatchPartyEvents(OAuth2Credential credential, String channelId) Deprecated.default PubSubSubscriptionlistenForWhisperEvents(OAuth2Credential credential, String userId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.listenOnTopic(PubSubRequest request) Deprecated.Send WS Message to subscribe to a topicdefault PubSubSubscriptionlistenOnTopic(PubSubType type, OAuth2Credential credential, String topic) Deprecated.default PubSubSubscriptionlistenOnTopic(PubSubType type, OAuth2Credential credential, String... topics) Deprecated.default PubSubSubscriptionlistenOnTopic(PubSubType type, OAuth2Credential credential, Collection<String> topics) Deprecated.booleanunsubscribeFromTopic(PubSubSubscription subscription) Deprecated.Unsubscribe from a topic.
-
Method Details
-
getEventManager
EventManager getEventManager()Deprecated. -
listenOnTopic
Deprecated.Send WS Message to subscribe to a topic- Parameters:
request- Topic- Returns:
- PubSubSubscription to be listened to
-
unsubscribeFromTopic
Deprecated.Unsubscribe from a topic. Usage example:PubSubSubscription subscription = twitchPubSub.listenForCheerEvents(...); // ... twitchPubSub.unsubscribeFromTopic(subscription);- Parameters:
subscription- PubSubSubscription to be unlistened from- Returns:
- whether the subscription was previously subscribed to
-
close
void close()Deprecated.- Specified by:
closein interfaceAutoCloseable
-
listenOnTopic
default PubSubSubscription listenOnTopic(PubSubType type, OAuth2Credential credential, Collection<String> topics) Deprecated. -
listenOnTopic
default PubSubSubscription listenOnTopic(PubSubType type, OAuth2Credential credential, String topic) Deprecated. -
listenOnTopic
default PubSubSubscription listenOnTopic(PubSubType type, OAuth2Credential credential, String... topics) Deprecated. -
listenForAutomodQueueEvents
@Deprecated default PubSubSubscription listenForAutomodQueueEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.Event Listener: AutoMod flags a message as potentially inappropriate, and when a moderator takes action on a message.- Parameters:
credential- Credential (for userId, scope: channel:moderate)userId- The moderator's user id associated with the credentialchannelId- The user id associated with the target channel- Returns:
- PubSubSubscription
- See Also:
-
listenForBitsBadgeEvents
@Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForBitsBadgeEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.Event Listener: User earned a new Bits badge and shared the notification with chat- Parameters:
credential- Credential (for target channel id, scope: bits:read)channelId- Target Channel Id- Returns:
- PubSubSubscription
- See Also:
-
listenForCheerEvents
@Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForCheerEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.Event Listener: Anyone cheers on a specified channel.- Parameters:
credential- Credential (for target channel id, scope: bits:read)channelId- Target Channel Id- Returns:
- PubSubSubscription
- See Also:
-
listenForSubscriptionEvents
@Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForSubscriptionEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.Event Listener: Anyone subscribes (first month), resubscribes (subsequent months), or gifts a subscription to a channel.- Parameters:
credential- Credential (for targetChannelId, scope: channel_subscriptions)channelId- Target Channel Id- Returns:
- PubSubSubscription
- See Also:
-
listenForCommerceEvents
@Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForCommerceEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.Event Listener: Anyone makes a purchase on a channel.- Parameters:
credential- Credential (any)channelId- Target Channel Id- Returns:
- PubSubSubscription
- See Also:
-
listenForWhisperEvents
@Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForWhisperEvents(OAuth2Credential credential, String userId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.Event Listener: Anyone whispers the specified user.- Parameters:
credential- Credential (for targetUserId, scope: whispers:read)userId- Target User Id- Returns:
- PubSubSubscription
- See Also:
-
listenForLowTrustUsersEvents
@Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForLowTrustUsersEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.Event Listener: Suspicious user events.This includes when a chatter's treatment status changes (e.g., monitored or restricted), and when a treated user sends a chat message.
- Parameters:
credential- Moderator's user access token (scope: channel:moderate) associated with the specified user id.userId- The user id of the moderator.channelId- The channel id to monitor events from.- Returns:
- PubSubSubscription
- See Also:
-
listenForModerationEvents
@Deprecated @Unofficial @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForModerationEvents(OAuth2Credential credential, String channelId) Deprecated.in favor of listenForModerationEvents(OAuth2Credential, String, String)Event Listener: A moderator performs an action in the channel- Parameters:
credential- Credential (for channelId, scope: channel:moderate)channelId- Target Channel Id- Returns:
- PubSubSubscription
-
listenForModerationEvents
@Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForModerationEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.Event Listener: A moderator performs an action in the channel- Parameters:
credential- Credential (for userId, scope: channel:moderate)userId- The user id associated with the credentialchannelId- The user id associated with the target channel- Returns:
- PubSubSubscription
- See Also:
-
listenForUserModerationNotificationEvents
@Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForUserModerationNotificationEvents(OAuth2Credential credential, String userId, String channelId) Deprecated.Twitch will decommission all official PubSub topics on April 14, 2025.Event Listener: A user’s message held by AutoMod has been approved or denied.- Parameters:
credential- Credential (for userId, scope: chat:read)userId- The user id associated with the credentialchannelId- The user id associated with the target channel- Returns:
- PubSubSubscription
- See Also:
-
listenForChannelPointsRedemptionEvents
@Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForChannelPointsRedemptionEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch will decommission PubSub on April 14, 2025.Event Listener: Anyone makes a channel points redemption on a channel.- Parameters:
credential- Credential (with the channel:read:redemptions scope for maximum information)channelId- Target Channel Id- Returns:
- PubSubSubscription
-
listenForAdsEvents
@Unofficial default PubSubSubscription listenForAdsEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForAdsManagerEvents
@Unofficial default PubSubSubscription listenForAdsManagerEvents(OAuth2Credential credential, String userId, String channelId) Deprecated. -
listenForAdPropertyRefreshEvents
@Unofficial @Deprecated default PubSubSubscription listenForAdPropertyRefreshEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForAutomodLevelsModificationEvents
@Unofficial default PubSubSubscription listenForAutomodLevelsModificationEvents(OAuth2Credential credential, String userId, String channelId) Deprecated. -
listenForBountyBoardEvents
@Unofficial @Deprecated default PubSubSubscription listenForBountyBoardEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForDashboardActivityFeedEvents
@Unofficial @Deprecated default PubSubSubscription listenForDashboardActivityFeedEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForCommunityBoostEvents
@Unofficial default PubSubSubscription listenForCommunityBoostEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForCreatorGoalsEvents
@Unofficial default PubSubSubscription listenForCreatorGoalsEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForCrowdChantEvents
@Unofficial @Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForCrowdChantEvents(OAuth2Credential credential, String channelId) Deprecated.the crowd chant experiment was disabled by Twitch on 2022-02-02- Parameters:
credential-OAuth2CredentialchannelId- channel id- Returns:
- PubSubSubscription
-
listenForUserChannelPointsEvents
@Unofficial default PubSubSubscription listenForUserChannelPointsEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForChannelDropEvents
@Unofficial @Deprecated default PubSubSubscription listenForChannelDropEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelBitsLeaderboardEvents
@Unofficial default PubSubSubscription listenForChannelBitsLeaderboardEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelBitsLeaderboardMonthlyEvents
@Unofficial default PubSubSubscription listenForChannelBitsLeaderboardMonthlyEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelBitsLeaderboardAllTimeEvents
@Unofficial default PubSubSubscription listenForChannelBitsLeaderboardAllTimeEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelBitsLeaderboardEvents
@Unofficial default PubSubSubscription listenForChannelBitsLeaderboardEvents(OAuth2Credential credential, String channelId, String timeAggregationUnit) Deprecated. -
listenForChannelClipsLeaderboardEvents
@Unofficial @Experimental default PubSubSubscription listenForChannelClipsLeaderboardEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelPrimeGiftStatusEvents
@Unofficial @Deprecated default PubSubSubscription listenForChannelPrimeGiftStatusEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelSubLeaderboardEvents
@Unofficial default PubSubSubscription listenForChannelSubLeaderboardEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelSubLeaderboardMonthlyEvents
@Unofficial default PubSubSubscription listenForChannelSubLeaderboardMonthlyEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelSubLeaderboardAllTimeEvents
@Unofficial default PubSubSubscription listenForChannelSubLeaderboardAllTimeEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelSubLeaderboardEvents
@Unofficial default PubSubSubscription listenForChannelSubLeaderboardEvents(OAuth2Credential credential, String channelId, String timeAggregationUnit) Deprecated. -
listenForLeaderboardEvents
@Unofficial default PubSubSubscription listenForLeaderboardEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForLeaderboardMonthlyEvents
@Unofficial default PubSubSubscription listenForLeaderboardMonthlyEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForLeaderboardAllTimeEvents
@Unofficial default PubSubSubscription listenForLeaderboardAllTimeEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForLeaderboardEvents
@Unofficial default PubSubSubscription listenForLeaderboardEvents(OAuth2Credential credential, String channelId, String timeAggregationUnit) Deprecated. -
listenForPinnedChatEvents
@Unofficial default PubSubSubscription listenForPinnedChatEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelPredictionsEvents
@Unofficial default PubSubSubscription listenForChannelPredictionsEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForUserPredictionsEvents
@Unofficial default PubSubSubscription listenForUserPredictionsEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForChannelSubGiftsEvents
@Unofficial default PubSubSubscription listenForChannelSubGiftsEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelSquadEvents
@Unofficial @Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForChannelSquadEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForRaidEvents
@Unofficial default PubSubSubscription listenForRaidEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelUnbanRequestEvents
@Unofficial default PubSubSubscription listenForChannelUnbanRequestEvents(OAuth2Credential credential, String userId, String channelId) Deprecated. -
listenForUserUnbanRequestEvents
@Unofficial default PubSubSubscription listenForUserUnbanRequestEvents(OAuth2Credential credential, String userId, String channelId) Deprecated. -
listenForChannelExtensionEvents
@Unofficial @Deprecated default PubSubSubscription listenForChannelExtensionEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForCharityCampaignEvents
@Unofficial default PubSubSubscription listenForCharityCampaignEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForExtensionControlEvents
@Unofficial @Deprecated default PubSubSubscription listenForExtensionControlEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForHypeTrainEvents
@Unofficial default PubSubSubscription listenForHypeTrainEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForHypeTrainRewardEvents
@Unofficial @Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForHypeTrainRewardEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForBroadcastSettingUpdateEvents
@Unofficial default PubSubSubscription listenForBroadcastSettingUpdateEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForCelebrationEvents
@Unofficial @Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForCelebrationEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForPublicBitEvents
@Unofficial @Deprecated default PubSubSubscription listenForPublicBitEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChatHighlightEvents
@Unofficial default PubSubSubscription listenForChatHighlightEvents(OAuth2Credential credential, String userId, String channelId) Deprecated. -
listenForPublicCheerEvents
@Unofficial default PubSubSubscription listenForPublicCheerEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForStreamChangeEvents
@Unofficial @Deprecated default PubSubSubscription listenForStreamChangeEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForStreamChatRoomEvents
@Unofficial @Deprecated default PubSubSubscription listenForStreamChatRoomEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForChannelChatroomEvents
@Unofficial @Deprecated default PubSubSubscription listenForChannelChatroomEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForUserChatroomEvents
@Unofficial default PubSubSubscription listenForUserChatroomEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForUserBitsUpdateEvents
@Unofficial @Deprecated default PubSubSubscription listenForUserBitsUpdateEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForUserCampaignEvents
@Unofficial @Deprecated default PubSubSubscription listenForUserCampaignEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForUserDropEvents
@Unofficial @Deprecated default PubSubSubscription listenForUserDropEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForUserPropertiesUpdateEvents
@Unofficial @Deprecated default PubSubSubscription listenForUserPropertiesUpdateEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForUserSubscribeEvents
@Unofficial @Deprecated default PubSubSubscription listenForUserSubscribeEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForUserImageUpdateEvents
@Unofficial @Deprecated default PubSubSubscription listenForUserImageUpdateEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForFollowingEvents
@Unofficial @Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForFollowingEvents(OAuth2Credential credential, String channelId) Deprecated.Twitch has silently disabled this topic, even for first-party moderator tokens. You should migrate to eventsub (websocket) channel.follow v2 subscription type.Event Listener: Anyone follows the specified channel.- Parameters:
credential-OAuth2CredentialchannelId- the id for the channel- Returns:
- PubSubSubscription
-
listenForFollows
Deprecated.Event Listener: Your account follows or unfollows any channel.This is not a replacement for
listenForFollowingEvents(OAuth2Credential, String).Fires
OutboundFollowPubSubEventandOutboundUnfollowPubSubEvent.This is an unofficial topic that does not accept third-party tokens; it could stop working at any time.
- Parameters:
credential- first-party user tokenuserId- the id associated with the token for the user performing follows/unfollows- Returns:
- PubSubSubscription
-
listenForFriendshipEvents
@Unofficial @Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForFriendshipEvents(OAuth2Credential credential, String userId) Deprecated.Friends are being removed by Twitch on 2022-05-25- Parameters:
credential- user access tokenuserId- user id associated with the token- Returns:
- PubSubSubscription
-
listenForOnsiteNotificationEvents
@Unofficial default PubSubSubscription listenForOnsiteNotificationEvents(OAuth2Credential credential, String userId) Deprecated. -
listenForPollEvents
@Unofficial default PubSubSubscription listenForPollEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForPresenceEvents
@Unofficial @Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForPresenceEvents(OAuth2Credential credential, String userId) Deprecated.Friends are being removed by Twitch on 2022-05-25- Parameters:
credential- user access tokenuserId- user id associated with the token- Returns:
- PubSubSubscription
-
listenForRadioEvents
@Unofficial @Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForRadioEvents(OAuth2Credential credential, String channelId) Unofficial: Listen for soundtrack events- Parameters:
credential- User Access TokenchannelId- Target Channel Id- Returns:
- PubSubSubscription
-
listenForShieldModeEvents
@Unofficial default PubSubSubscription listenForShieldModeEvents(OAuth2Credential credential, String userId, String channelId) Deprecated. -
listenForShoutoutEvents
@Unofficial default PubSubSubscription listenForShoutoutEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForVideoPlaybackEvents
@Unofficial default PubSubSubscription listenForVideoPlaybackEvents(OAuth2Credential credential, String channelId) Deprecated. -
listenForVideoPlaybackByNameEvents
@Unofficial default PubSubSubscription listenForVideoPlaybackByNameEvents(OAuth2Credential credential, String channelName) Deprecated. -
listenForWatchPartyEvents
@Unofficial @Deprecated @ScheduledForRemoval(inVersion="2.0.0") default PubSubSubscription listenForWatchPartyEvents(OAuth2Credential credential, String channelId) Deprecated. -
getLatency
long getLatency()Deprecated.- Returns:
- the most recently measured round-trip latency for the socket(s) in milliseconds, or -1 if unknown
-