io.github.freya022.botcommands.api.commands.ratelimit.RateLimitScope Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of BotCommands Show documentation

A Kotlin-first (and Java) framework that makes creating Discord bots a piece of cake, using the JDA library.

There is a newer version: 3.0.0-alpha.18

package io.github.freya022.botcommands.api.commands.ratelimit;

/**
 * Provides rate limit scopes for the {@link DefaultRateLimiter default rate limit implementation}.
 */
public enum RateLimitScope {
    /** Limits the usage rate by the users, regardless of the execution guild/channel. */
    USER,
    /** Limits the usage rate by the users, per guild (i.e., the rate limit is local to the guild). */
    USER_PER_GUILD,
    /** Limits the usage rate by the users, per channel (i.e., the rate limit is local to the channel). */
    USER_PER_CHANNEL,
    /** Limits the usage rate by the guild. */
    GUILD,
    /** Limits the usage rate by the channel. */
    CHANNEL
}