com.slack.api.methods

Enum MethodsRateLimitTier

java.lang.Object

java.lang.Enum<MethodsRateLimitTier>

com.slack.api.methods.MethodsRateLimitTier

All Implemented Interfaces:

Serializable, Comparable<MethodsRateLimitTier>

public enum MethodsRateLimitTier
extends Enum<MethodsRateLimitTier>

See Also:

Slack Rate Limits

Enum Constant Summary

Enum Constants

Enum Constant and Description
SpecialTier_auth_test This method allows hundreds of requests per minute.
SpecialTier_chat_getPermalink This method allows hundreds of requests per minute.
SpecialTier_chat_postMessage chat.postMessage has special rate limiting conditions.
Tier1 1+ per minute
Tier2 20+ per minute
Tier3 50+ per minute
Tier4 100+ per minute

Method Summary

Modifier and Type	Method and Description
static Integer	getAllowedRequestsPerMinute(MethodsRateLimitTier tier)
static MethodsRateLimitTier	valueOf(String name) Returns the enum constant of this type with the specified name.
static MethodsRateLimitTier[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Tier1

public static final MethodsRateLimitTier Tier1

1+ per minute

Access tier 1 methods infrequently. A small amount of burst behavior is tolerated.

Tier2

public static final MethodsRateLimitTier Tier2

20+ per minute

Most methods allow at least 20 requests per minute, while allowing for occasional bursts of more requests.

Tier3

public static final MethodsRateLimitTier Tier3

50+ per minute

Tier 3 methods allow a larger number of requests and are typically attached to methods with paginating collections of conversations or users. Sporadic bursts are welcome.

Tier4

public static final MethodsRateLimitTier Tier4

100+ per minute

Enjoy a large request quota for Tier 4 methods, including generous burst behavior.

SpecialTier_auth_test

public static final MethodsRateLimitTier SpecialTier_auth_test

This method allows hundreds of requests per minute. Use it as often as is reasonably required.

SpecialTier_chat_postMessage

public static final MethodsRateLimitTier SpecialTier_chat_postMessage

chat.postMessage has special rate limiting conditions. It will generally allow an app to post 1 message per second to a specific channel. There are limits governing your app's relationship with the entire workspace above that, limiting posting to several hundred messages per minute. Generous burst behavior is also granted.

SpecialTier_chat_getPermalink

public static final MethodsRateLimitTier SpecialTier_chat_getPermalink

This method allows hundreds of requests per minute. Use it as often as is reasonably required.

Method Detail

values

public static MethodsRateLimitTier[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MethodsRateLimitTier c : MethodsRateLimitTier.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MethodsRateLimitTier valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getAllowedRequestsPerMinute

public static Integer getAllowedRequestsPerMinute(MethodsRateLimitTier tier)