Package com.github.twitch4j.pubsub

Interface ITwitchPubSub

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TwitchPubSub, TwitchPubSubConnectionPool

public interface ITwitchPubSub
extends AutoCloseable

Method Summary

Modifier and Type	Method	Description
void	close()
EventManager	getEventManager()
long	getLatency()
default PubSubSubscription	listenForAdPropertyRefreshEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForAdsEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForAutomodLevelsModificationEvents(OAuth2Credential credential, String userId, String channelId)
default PubSubSubscription	listenForAutomodQueueEvents(OAuth2Credential credential, String userId, String channelId)	Event Listener: AutoMod flags a message as potentially inappropriate, and when a moderator takes action on a message.
default PubSubSubscription	listenForBitsBadgeEvents(OAuth2Credential credential, String channelId)	Event Listener: User earned a new Bits badge and shared the notification with chat
default PubSubSubscription	listenForBountyBoardEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForBroadcastSettingUpdateEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForCelebrationEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForChannelBitsLeaderboardAllTimeEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForChannelBitsLeaderboardEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForChannelBitsLeaderboardEvents(OAuth2Credential credential, String channelId, String timeAggregationUnit)
default PubSubSubscription	listenForChannelBitsLeaderboardMonthlyEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForChannelChatroomEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForChannelDropEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForChannelExtensionEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForChannelPointsRedemptionEvents(OAuth2Credential credential, String channelId)	Event Listener: Anyone makes a channel points redemption on a channel.
default PubSubSubscription	listenForChannelPredictionsEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForChannelPrimeGiftStatusEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForChannelSquadEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForChannelSubGiftsEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForChannelSubLeaderboardAllTimeEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForChannelSubLeaderboardEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForChannelSubLeaderboardEvents(OAuth2Credential credential, String channelId, String timeAggregationUnit)
default PubSubSubscription	listenForChannelSubLeaderboardMonthlyEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForChannelUnbanRequestEvents(OAuth2Credential credential, String userId, String channelId)
default PubSubSubscription	listenForCharityCampaignEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForCheerEvents(OAuth2Credential credential, String channelId)	Event Listener: Anyone cheers on a specified channel.
default PubSubSubscription	listenForCommerceEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForCommunityBoostEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForCreatorGoalsEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForCrowdChantEvents(OAuth2Credential credential, String channelId)	Deprecated. the crowd chant experiment was disabled by Twitch on 2022-02-02
default PubSubSubscription	listenForDashboardActivityFeedEvents(OAuth2Credential credential, String userId)	Deprecated.
default PubSubSubscription	listenForExtensionControlEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForFollowingEvents(OAuth2Credential credential, String channelId)	Event Listener: Anyone follows the specified channel.
default PubSubSubscription	listenForFriendshipEvents(OAuth2Credential credential, String userId)	Deprecated. Friends are being removed by Twitch on 2022-05-25
default PubSubSubscription	listenForHypeTrainEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForHypeTrainRewardEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForLeaderboardAllTimeEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForLeaderboardEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForLeaderboardEvents(OAuth2Credential credential, String channelId, String timeAggregationUnit)
default PubSubSubscription	listenForLeaderboardMonthlyEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForLowTrustUsersEvents(OAuth2Credential credential, String userId, String channelId)	Event Listener: Suspicious user events.
default PubSubSubscription	listenForModerationEvents(OAuth2Credential credential, String channelId)	Deprecated. in favor of listenForModerationEvents(OAuth2Credential, String, String)
default PubSubSubscription	listenForModerationEvents(OAuth2Credential credential, String userId, String channelId)	Event Listener: A moderator performs an action in the channel
default PubSubSubscription	listenForOnsiteNotificationEvents(OAuth2Credential credential, String userId)
default PubSubSubscription	listenForPinnedChatEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForPollEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForPresenceEvents(OAuth2Credential credential, String userId)	Deprecated. Friends are being removed by Twitch on 2022-05-25
default PubSubSubscription	listenForPublicBitEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForPublicCheerEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForRadioEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForRaidEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForShieldModeEvents(OAuth2Credential credential, String userId, String channelId)
default PubSubSubscription	listenForShoutoutEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForStreamChangeEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForStreamChatRoomEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForSubscriptionEvents(OAuth2Credential credential, String channelId)	Event Listener: Anyone subscribes (first month), resubscribes (subsequent months), or gifts a subscription to a channel.
default PubSubSubscription	listenForUserBitsUpdateEvents(OAuth2Credential credential, String userId)	Deprecated.
default PubSubSubscription	listenForUserCampaignEvents(OAuth2Credential credential, String userId)	Deprecated.
default PubSubSubscription	listenForUserChannelPointsEvents(OAuth2Credential credential, String userId)
default PubSubSubscription	listenForUserChatroomEvents(OAuth2Credential credential, String userId)
default PubSubSubscription	listenForUserDropEvents(OAuth2Credential credential, String userId)	Deprecated.
default PubSubSubscription	listenForUserImageUpdateEvents(OAuth2Credential credential, String userId)	Deprecated.
default PubSubSubscription	listenForUserModerationNotificationEvents(OAuth2Credential credential, String userId, String channelId)	Event Listener: A user’s message held by AutoMod has been approved or denied.
default PubSubSubscription	listenForUserPredictionsEvents(OAuth2Credential credential, String userId)
default PubSubSubscription	listenForUserPropertiesUpdateEvents(OAuth2Credential credential, String userId)	Deprecated.
default PubSubSubscription	listenForUserSubscribeEvents(OAuth2Credential credential, String userId)	Deprecated.
default PubSubSubscription	listenForUserUnbanRequestEvents(OAuth2Credential credential, String userId, String channelId)
default PubSubSubscription	listenForVideoPlaybackByNameEvents(OAuth2Credential credential, String channelName)
default PubSubSubscription	listenForVideoPlaybackEvents(OAuth2Credential credential, String channelId)
default PubSubSubscription	listenForWatchPartyEvents(OAuth2Credential credential, String channelId)	Deprecated.
default PubSubSubscription	listenForWhisperEvents(OAuth2Credential credential, String userId)	Event Listener: Anyone whispers the specified user.
PubSubSubscription	listenOnTopic(PubSubRequest request)	Send WS Message to subscribe to a topic
default PubSubSubscription	listenOnTopic(PubSubType type, OAuth2Credential credential, String topic)
default PubSubSubscription	listenOnTopic(PubSubType type, OAuth2Credential credential, String... topics)
default PubSubSubscription	listenOnTopic(PubSubType type, OAuth2Credential credential, Collection<String> topics)
boolean	unsubscribeFromTopic(PubSubSubscription subscription)	Unsubscribe from a topic.

Method Details

getEventManager

EventManager getEventManager()

listenOnTopic

PubSubSubscription listenOnTopic(PubSubRequest request)

Send WS Message to subscribe to a topic

Parameters:

request - Topic

Returns:

PubSubSubscription to be listened to

unsubscribeFromTopic

boolean unsubscribeFromTopic(PubSubSubscription subscription)

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

Specified by:

close in interface AutoCloseable

listenOnTopic

default PubSubSubscription listenOnTopic(PubSubType type,
 OAuth2Credential credential,
 Collection<String> topics)

listenOnTopic

default PubSubSubscription listenOnTopic(PubSubType type,
 OAuth2Credential credential,
 String topic)

listenOnTopic

default PubSubSubscription listenOnTopic(PubSubType type,
 OAuth2Credential credential,
 String... topics)

listenForAutomodQueueEvents

default PubSubSubscription listenForAutomodQueueEvents(OAuth2Credential credential,
 String userId,
 String channelId)

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 credential

channelId - The user id associated with the target channel

Returns:

PubSubSubscription

listenForBitsBadgeEvents

default PubSubSubscription listenForBitsBadgeEvents(OAuth2Credential credential,
 String channelId)

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

listenForCheerEvents

default PubSubSubscription listenForCheerEvents(OAuth2Credential credential,
 String channelId)

Event Listener: Anyone cheers on a specified channel.

Parameters:

credential - Credential (for target channel id, scope: bits:read)

channelId - Target Channel Id

Returns:

PubSubSubscription

listenForSubscriptionEvents

default PubSubSubscription listenForSubscriptionEvents(OAuth2Credential credential,
 String channelId)

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

listenForCommerceEvents

@Deprecated
default PubSubSubscription listenForCommerceEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

Event Listener: Anyone makes a purchase on a channel.

Parameters:

credential - Credential (any)

channelId - Target Channel Id

Returns:

PubSubSubscription

listenForWhisperEvents

default PubSubSubscription listenForWhisperEvents(OAuth2Credential credential,
 String userId)

Event Listener: Anyone whispers the specified user.

Parameters:

credential - Credential (for targetUserId, scope: whispers:read)

userId - Target User Id

Returns:

PubSubSubscription

listenForLowTrustUsersEvents

default PubSubSubscription listenForLowTrustUsersEvents(OAuth2Credential credential,
 String userId,
 String channelId)

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:

• TwitchScopes.CHAT_CHANNEL_MODERATE

listenForModerationEvents

@Deprecated
@Unofficial
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

default PubSubSubscription listenForModerationEvents(OAuth2Credential credential,
 String userId,
 String channelId)

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 credential

channelId - The user id associated with the target channel

Returns:

PubSubSubscription

listenForUserModerationNotificationEvents

default PubSubSubscription listenForUserModerationNotificationEvents(OAuth2Credential credential,
 String userId,
 String channelId)

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 credential

channelId - The user id associated with the target channel

Returns:

PubSubSubscription

listenForChannelPointsRedemptionEvents

default PubSubSubscription listenForChannelPointsRedemptionEvents(OAuth2Credential credential,
 String channelId)

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
@Deprecated
default PubSubSubscription listenForAdsEvents(OAuth2Credential credential,
 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)

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)

listenForCreatorGoalsEvents

@Unofficial
default PubSubSubscription listenForCreatorGoalsEvents(OAuth2Credential credential,
 String channelId)

listenForCrowdChantEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForCrowdChantEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

the crowd chant experiment was disabled by Twitch on 2022-02-02

Parameters:

credential - OAuth2Credential

channelId - channel id

Returns:

PubSubSubscription

listenForUserChannelPointsEvents

@Unofficial
default PubSubSubscription listenForUserChannelPointsEvents(OAuth2Credential credential,
 String userId)

listenForChannelDropEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForChannelDropEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

listenForChannelBitsLeaderboardEvents

@Unofficial
default PubSubSubscription listenForChannelBitsLeaderboardEvents(OAuth2Credential credential,
 String channelId)

listenForChannelBitsLeaderboardMonthlyEvents

@Unofficial
default PubSubSubscription listenForChannelBitsLeaderboardMonthlyEvents(OAuth2Credential credential,
 String channelId)

listenForChannelBitsLeaderboardAllTimeEvents

@Unofficial
default PubSubSubscription listenForChannelBitsLeaderboardAllTimeEvents(OAuth2Credential credential,
 String channelId)

listenForChannelBitsLeaderboardEvents

@Unofficial
default PubSubSubscription listenForChannelBitsLeaderboardEvents(OAuth2Credential credential,
 String channelId,
 String timeAggregationUnit)

listenForChannelPrimeGiftStatusEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForChannelPrimeGiftStatusEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

listenForChannelSubLeaderboardEvents

@Unofficial
default PubSubSubscription listenForChannelSubLeaderboardEvents(OAuth2Credential credential,
 String channelId)

listenForChannelSubLeaderboardMonthlyEvents

@Unofficial
default PubSubSubscription listenForChannelSubLeaderboardMonthlyEvents(OAuth2Credential credential,
 String channelId)

listenForChannelSubLeaderboardAllTimeEvents

@Unofficial
default PubSubSubscription listenForChannelSubLeaderboardAllTimeEvents(OAuth2Credential credential,
 String channelId)

listenForChannelSubLeaderboardEvents

@Unofficial
default PubSubSubscription listenForChannelSubLeaderboardEvents(OAuth2Credential credential,
 String channelId,
 String timeAggregationUnit)

listenForLeaderboardEvents

@Unofficial
default PubSubSubscription listenForLeaderboardEvents(OAuth2Credential credential,
 String channelId)

listenForLeaderboardMonthlyEvents

@Unofficial
default PubSubSubscription listenForLeaderboardMonthlyEvents(OAuth2Credential credential,
 String channelId)

listenForLeaderboardAllTimeEvents

@Unofficial
default PubSubSubscription listenForLeaderboardAllTimeEvents(OAuth2Credential credential,
 String channelId)

listenForLeaderboardEvents

@Unofficial
default PubSubSubscription listenForLeaderboardEvents(OAuth2Credential credential,
 String channelId,
 String timeAggregationUnit)

listenForPinnedChatEvents

@Unofficial
default PubSubSubscription listenForPinnedChatEvents(OAuth2Credential credential,
 String channelId)

listenForChannelPredictionsEvents

@Unofficial
default PubSubSubscription listenForChannelPredictionsEvents(OAuth2Credential credential,
 String channelId)

listenForUserPredictionsEvents

@Unofficial
default PubSubSubscription listenForUserPredictionsEvents(OAuth2Credential credential,
 String userId)

listenForChannelSubGiftsEvents

@Unofficial
default PubSubSubscription listenForChannelSubGiftsEvents(OAuth2Credential credential,
 String channelId)

listenForChannelSquadEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForChannelSquadEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

listenForRaidEvents

@Unofficial
default PubSubSubscription listenForRaidEvents(OAuth2Credential credential,
 String channelId)

listenForChannelUnbanRequestEvents

@Unofficial
default PubSubSubscription listenForChannelUnbanRequestEvents(OAuth2Credential credential,
 String userId,
 String channelId)

listenForUserUnbanRequestEvents

@Unofficial
default PubSubSubscription listenForUserUnbanRequestEvents(OAuth2Credential credential,
 String userId,
 String channelId)

listenForChannelExtensionEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForChannelExtensionEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

listenForCharityCampaignEvents

@Unofficial
default PubSubSubscription listenForCharityCampaignEvents(OAuth2Credential credential,
 String channelId)

listenForExtensionControlEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForExtensionControlEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

listenForHypeTrainEvents

@Unofficial
default PubSubSubscription listenForHypeTrainEvents(OAuth2Credential credential,
 String channelId)

listenForHypeTrainRewardEvents

@Unofficial
default PubSubSubscription listenForHypeTrainRewardEvents(OAuth2Credential credential,
 String channelId)

listenForBroadcastSettingUpdateEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForBroadcastSettingUpdateEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

listenForCelebrationEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForCelebrationEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

listenForPublicBitEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForPublicBitEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

listenForPublicCheerEvents

@Unofficial
default PubSubSubscription listenForPublicCheerEvents(OAuth2Credential credential,
 String channelId)

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)

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
default PubSubSubscription listenForFollowingEvents(OAuth2Credential credential,
 String channelId)

Event Listener: Anyone follows the specified channel.

Parameters:

credential - OAuth2Credential

channelId - the id for the channel

Returns:

PubSubSubscription

listenForFriendshipEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForFriendshipEvents(OAuth2Credential credential,
 String userId)

Deprecated.

Friends are being removed by Twitch on 2022-05-25

Parameters:

credential - user access token

userId - user id associated with the token

Returns:

PubSubSubscription

listenForOnsiteNotificationEvents

@Unofficial
default PubSubSubscription listenForOnsiteNotificationEvents(OAuth2Credential credential,
 String userId)

listenForPollEvents

@Unofficial
default PubSubSubscription listenForPollEvents(OAuth2Credential credential,
 String channelId)

listenForPresenceEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForPresenceEvents(OAuth2Credential credential,
 String userId)

Deprecated.

Friends are being removed by Twitch on 2022-05-25

Parameters:

credential - user access token

userId - user id associated with the token

Returns:

PubSubSubscription

listenForRadioEvents

@Unofficial
default PubSubSubscription listenForRadioEvents(OAuth2Credential credential,
 String channelId)

listenForShieldModeEvents

@Unofficial
default PubSubSubscription listenForShieldModeEvents(OAuth2Credential credential,
 String userId,
 String channelId)

listenForShoutoutEvents

@Unofficial
default PubSubSubscription listenForShoutoutEvents(OAuth2Credential credential,
 String channelId)

listenForVideoPlaybackEvents

@Unofficial
default PubSubSubscription listenForVideoPlaybackEvents(OAuth2Credential credential,
 String channelId)

listenForVideoPlaybackByNameEvents

@Unofficial
default PubSubSubscription listenForVideoPlaybackByNameEvents(OAuth2Credential credential,
 String channelName)

listenForWatchPartyEvents

@Unofficial
@Deprecated
default PubSubSubscription listenForWatchPartyEvents(OAuth2Credential credential,
 String channelId)

Deprecated.

getLatency

long getLatency()

Returns:

the most recently measured round-trip latency for the socket(s) in milliseconds, or -1 if unknown