Package com.github.twitch4j.helix.interceptor

Class TwitchHelixRateLimitTracker

java.lang.Object

com.github.twitch4j.helix.interceptor.TwitchHelixRateLimitTracker

public final class TwitchHelixRateLimitTracker
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final List<io.github.bucket4j.Bandwidth>	AUTOMOD_STATUS_AFFILIATE_BANDWIDTH
static final List<io.github.bucket4j.Bandwidth>	AUTOMOD_STATUS_NORMAL_BANDWIDTH
static final List<io.github.bucket4j.Bandwidth>	AUTOMOD_STATUS_PARTNER_BANDWIDTH

Constructor Summary

Constructors

Constructor	Description
TwitchHelixRateLimitTracker(io.github.bucket4j.Bandwidth apiRateLimit, TwitchHelixTokenManager tokenManager)	Creates a new TwitchHelixRateLimitTracker instance.

Method Summary

Modifier and Type	Method	Description
void	markDepletedBanBucket(@NotNull String channelId)
void	updateRemaining(@NotNull String token, int remaining)
void	updateRemainingCreateClip(@NotNull String token, int remaining)
void	updateRemainingExtensionChat(@NotNull String clientId, @NotNull String channelId, int remaining)
void	updateRemainingExtensionPubSub(@NotNull String clientId, @NotNull String target, int remaining)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AUTOMOD_STATUS_NORMAL_BANDWIDTH

public static final List<io.github.bucket4j.Bandwidth> AUTOMOD_STATUS_NORMAL_BANDWIDTH

See Also:

• TwitchLimitType.HELIX_AUTOMOD_STATUS_LIMIT

AUTOMOD_STATUS_AFFILIATE_BANDWIDTH

public static final List<io.github.bucket4j.Bandwidth> AUTOMOD_STATUS_AFFILIATE_BANDWIDTH

See Also:

• TwitchLimitType.HELIX_AUTOMOD_STATUS_LIMIT

AUTOMOD_STATUS_PARTNER_BANDWIDTH

public static final List<io.github.bucket4j.Bandwidth> AUTOMOD_STATUS_PARTNER_BANDWIDTH

See Also:

• TwitchLimitType.HELIX_AUTOMOD_STATUS_LIMIT

Constructor Details

TwitchHelixRateLimitTracker

public TwitchHelixRateLimitTracker(io.github.bucket4j.Bandwidth apiRateLimit,
 TwitchHelixTokenManager tokenManager)

Creates a new TwitchHelixRateLimitTracker instance.

Parameters:

apiRateLimit - The primary (global helix) rate limit bandwidth to use

tokenManager - Twitch Helix Token Manager

Method Details

updateRemaining

public void updateRemaining(@NotNull
 @NotNull String token,
 int remaining)

updateRemainingExtensionChat

public void updateRemainingExtensionChat(@NotNull
 @NotNull String clientId,
 @NotNull
 @NotNull String channelId,
 int remaining)

updateRemainingExtensionPubSub

public void updateRemainingExtensionPubSub(@NotNull
 @NotNull String clientId,
 @NotNull
 @NotNull String target,
 int remaining)

updateRemainingCreateClip

public void updateRemainingCreateClip(@NotNull
 @NotNull String token,
 int remaining)

markDepletedBanBucket

@Unofficial
public void markDepletedBanBucket(@NotNull
 @NotNull String channelId)