Package com.github.twitch4j.chat.util

Class TwitchChatLimitHelper

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

  • Field Summary

    Fields
    Modifier and Type Field Description
    static io.github.bucket4j.Bandwidth KNOWN_MESSAGE_LIMIT
    Known bots
    static java.util.List<io.github.bucket4j.Bandwidth> KNOWN_WHISPER_LIMIT
    Known bots
    static io.github.bucket4j.Bandwidth MOD_MESSAGE_LIMIT
    Users sending commands or messages to channels in which they have Moderator or Operator status
    static io.github.bucket4j.Bandwidth USER_AUTH_LIMIT
    Authentication rate for users
    static io.github.bucket4j.Bandwidth USER_JOIN_LIMIT
    Join rate for users
    static io.github.bucket4j.Bandwidth USER_MESSAGE_LIMIT
    Users sending commands or messages to channels in which they do not have Moderator or Operator status
    static java.util.List<io.github.bucket4j.Bandwidth> USER_WHISPER_LIMIT
    Users (not bots)
    static io.github.bucket4j.Bandwidth VERIFIED_AUTH_LIMIT
    Authentication rate for verified bots
    static io.github.bucket4j.Bandwidth VERIFIED_JOIN_LIMIT
    Join rate for verified bots
    static io.github.bucket4j.Bandwidth VERIFIED_MESSAGE_LIMIT
    Verified bots
    static java.util.List<io.github.bucket4j.Bandwidth> VERIFIED_WHISPER_LIMIT
    Verified bots

  • Method Summary

    Modifier and Type Method Description
    static io.github.bucket4j.Bucket createBucket​(io.github.bucket4j.Bandwidth limit)  
    static io.github.bucket4j.Bucket createBucket​(io.github.bucket4j.Bandwidth... limits)  
    static io.github.bucket4j.Bucket createBucket​(java.lang.Iterable<io.github.bucket4j.Bandwidth> limits)  

    Methods inherited from class java.lang.Object

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

  • Field Details

    • 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 java.util.List<io.github.bucket4j.Bandwidth> USER_WHISPER_LIMIT
      Users (not bots)

    • KNOWN_WHISPER_LIMIT

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

    • VERIFIED_WHISPER_LIMIT

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

    • 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

      public static io.github.bucket4j.Bucket createBucket​(io.github.bucket4j.Bandwidth limit)

    • createBucket

      public static io.github.bucket4j.Bucket createBucket​(io.github.bucket4j.Bandwidth... limits)

    • createBucket

      public static io.github.bucket4j.Bucket createBucket​(java.lang.Iterable<io.github.bucket4j.Bandwidth> limits)