sx.blah.discord.util

Class RateLimitException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

sx.blah.discord.util.RateLimitException

All Implemented Interfaces:

Serializable

public class RateLimitException
extends RuntimeException

Thrown when performing an operation with Discord would result in being ratelimited.

This should always be preemptively thrown by Discord4J's request system. However, if the user somehow hits an actual HTTP 429 from Discord, it will also be reported through this exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RateLimitException(String message, long retryAfter, String method, boolean global)

Method Summary

Modifier and Type	Method and Description
String	getMethod() Gets the HTTP method the rate limit was in response to.
long	getRetryDelay() Gets the amount of time (in milliseconds) to wait until sending another request.
boolean	isGlobal() Gets whether this is a global rate limit or limited to a particular method.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitException

public RateLimitException(String message,
                          long retryAfter,
                          String method,
                          boolean global)

Method Detail

getRetryDelay

public long getRetryDelay()

Gets the amount of time (in milliseconds) to wait until sending another request.

Returns:

The amount of time (in milliseconds) to wait until sending another request.

getMethod

public String getMethod()

Gets the HTTP method the rate limit was in response to.

Returns:

The HTTP method the rate limit was in response to.

isGlobal

public boolean isGlobal()

Gets whether this is a global rate limit or limited to a particular method.

Returns:

Whether this is a global rate limit.