Topic - Leaderboard Events

Description

This topic can be used to monitor weekly/monthly leaderboard events of a specified channel in terms of bits used and subs gifted.

With all undocumented topics, use at your own risk.

Method Definition

Name	Type	Description
credential	OAuth2Credential	Auth Token (may not necessarily be required)
channelId	String	Target Channel Id

Code-Snippets

Subscribe: Weekly Leaderboard Events

Java

// One can subscribe to one or both of these:
twitchClient.getPubSub().listenForChannelBitsLeaderboardEvents(credential, "149223493");
twitchClient.getPubSub().listenForChannelSubLeaderboardEvents(credential, "149223493");

// Alternatively, this helper method can be used to subscribe to the above two topics in one line:
twitchClient.getPubSub().listenForLeaderboardEvents(credential, "149223493");

Kotlin

// One can subscribe to one or both of these:
twitchClient.pubSub.listenForChannelBitsLeaderboardEvents(credential, "149223493");
twitchClient.pubSub.listenForChannelSubLeaderboardEvents(credential, "149223493");

// Alternatively, this helper method can be used to subscribe to the above two topics in one line:
twitchClient.pubSub.listenForLeaderboardEvents(credential, "149223493");

Groovy

// One can subscribe to one or both of these:
twitchClient.pubSub.listenForChannelBitsLeaderboardEvents(credential, "149223493");
twitchClient.pubSub.listenForChannelSubLeaderboardEvents(credential, "149223493");

// Alternatively, this helper method can be used to subscribe to the above two topics in one line:
twitchClient.pubSub.listenForLeaderboardEvents(credential, "149223493");

Subscribe: Monthly Leaderboard Events

Java

// One can subscribe to one or both of these:
twitchClient.getPubSub().listenForChannelBitsLeaderboardMonthlyEvents(credential, "149223493");
twitchClient.getPubSub().listenForChannelSubLeaderboardMonthlyEvents(credential, "149223493");

// Alternatively, this helper method can be used to subscribe to the above two topics in one line:
twitchClient.getPubSub().listenForLeaderboardMonthlyEvents(credential, "149223493");

Kotlin

// One can subscribe to one or both of these:
twitchClient.pubSub.listenForChannelBitsLeaderboardMonthlyEvents(credential, "149223493");
twitchClient.pubSub.listenForChannelSubLeaderboardMonthlyEvents(credential, "149223493");

// Alternatively, this helper method can be used to subscribe to the above two topics in one line:
twitchClient.pubSub.listenForLeaderboardMonthlyEvents(credential, "149223493");

Groovy

// One can subscribe to one or both of these:
twitchClient.pubSub.listenForChannelBitsLeaderboardMonthlyEvents(credential, "149223493");
twitchClient.pubSub.listenForChannelSubLeaderboardMonthlyEvents(credential, "149223493");

// Alternatively, this helper method can be used to subscribe to the above two topics in one line:
twitchClient.pubSub.listenForLeaderboardMonthlyEvents(credential, "149223493");

Listen: Bits Leaderboard Update

Java

twitchClient.getEventManager().onEvent(BitsLeaderboardEvent.class, System.out::println);

Kotlin

twitchClient.eventManager.onEvent(BitsLeaderboardEvent::class.java, System.out::println)

Groovy

twitchClient.eventManager.onEvent(BitsLeaderboardEvent, System.out::println)

Listen: Sub Gifts Leaderboard Update

Java

twitchClient.getEventManager().onEvent(SubLeaderboardEvent.class, System.out::println);

Kotlin

twitchClient.eventManager.onEvent(SubLeaderboardEvent::class.java, System.out::println)

Groovy

twitchClient.eventManager.onEvent(SubLeaderboardEvent, System.out::println)