Package com.github.twitch4j.chat.util

Class TwitchChatLimitHelper

java.lang.Object
com.github.twitch4j.chat.util.TwitchChatLimitHelper
public final class TwitchChatLimitHelper extends Object
Utility class for retrieving standard rate limits for TwitchChat
See Also:

  • Field Details

    • MESSAGE_BANDWIDTH_ID

      public static final String MESSAGE_BANDWIDTH_ID

    • JOIN_BANDWIDTH_ID

      public static final String JOIN_BANDWIDTH_ID

    • AUTH_BANDWIDTH_ID

      public static final String AUTH_BANDWIDTH_ID

    • WHISPER_MINUTE_BANDWIDTH_ID

      public static final String WHISPER_MINUTE_BANDWIDTH_ID

    • WHISPER_SECOND_BANDWIDTH_ID

      public static final String WHISPER_SECOND_BANDWIDTH_ID

    • USER_MESSAGE_LIMIT

      public static final io.github.bucket4j.Bandwidth USER_MESSAGE_LIMIT
      Users sending commands or messages to channels in which they do not have Moderator or Operator status

    • MOD_MESSAGE_LIMIT

      public static final io.github.bucket4j.Bandwidth MOD_MESSAGE_LIMIT
      Users sending commands or messages to channels in which they have Moderator or Operator status

    • KNOWN_MESSAGE_LIMIT

      public static final io.github.bucket4j.Bandwidth KNOWN_MESSAGE_LIMIT
      Known bots

    • VERIFIED_MESSAGE_LIMIT

      public static final io.github.bucket4j.Bandwidth VERIFIED_MESSAGE_LIMIT
      Verified bots

    • USER_WHISPER_LIMIT

      public static final List<io.github.bucket4j.Bandwidth> USER_WHISPER_LIMIT
      Users (not bots)

      Note: this does not implement the target user count restriction.

    • KNOWN_WHISPER_LIMIT

      public static final List<io.github.bucket4j.Bandwidth> KNOWN_WHISPER_LIMIT
      Known bots

      Note: this does not implement the target user count restriction.

    • VERIFIED_WHISPER_LIMIT

      public static final List<io.github.bucket4j.Bandwidth> VERIFIED_WHISPER_LIMIT
      Verified bots

      Note: this does not implement the target user count restriction.

      Note: this only applies to legacy verified bots (pre July 2021)

    • USER_JOIN_LIMIT

      public static final io.github.bucket4j.Bandwidth USER_JOIN_LIMIT
      Join rate for users

    • VERIFIED_JOIN_LIMIT

      public static final io.github.bucket4j.Bandwidth VERIFIED_JOIN_LIMIT
      Join rate for verified bots

    • USER_AUTH_LIMIT

      public static final io.github.bucket4j.Bandwidth USER_AUTH_LIMIT
      Authentication rate for users

    • VERIFIED_AUTH_LIMIT

      public static final io.github.bucket4j.Bandwidth VERIFIED_AUTH_LIMIT
      Authentication rate for verified bots

  • Method Details

    • createBucket

      @Deprecated @ScheduledForRemoval(inVersion="2.0.0") public static io.github.bucket4j.Bucket createBucket(io.github.bucket4j.Bandwidth limit)
      Deprecated.
      in favor of BucketUtils
      Parameters:
      limit - bandwidth
      Returns:
      bucket

    • createBucket

      @Deprecated @ScheduledForRemoval(inVersion="2.0.0") public static io.github.bucket4j.Bucket createBucket(io.github.bucket4j.Bandwidth... limits)
      Deprecated.
      in favor of BucketUtils
      Parameters:
      limits - bandwidths
      Returns:
      bucket

    • createBucket

      @Deprecated @ScheduledForRemoval(inVersion="2.0.0") public static io.github.bucket4j.Bucket createBucket(Iterable<io.github.bucket4j.Bandwidth> limits)
      Deprecated.
      in favor of BucketUtils
      Parameters:
      limits - bandwidths
      Returns:
      bucket