io.github.freya022.botcommands.api.commands.builder.RateLimitBuilder.kt 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.builder

import io.github.freya022.botcommands.api.commands.ratelimit.RateLimiter
import io.github.freya022.botcommands.api.commands.ratelimit.declaration.RateLimitManager
import io.github.freya022.botcommands.api.core.IDeclarationSiteHolderBuilder
import io.github.freya022.botcommands.internal.commands.CommandDSL

/**
 * Builder interface for rate limits.
 *
 * You can set a declaration site different from the default location (where the rate limit was created in the code) here.
 *
 * @see CommandBuilder.rateLimit
 * @see RateLimitManager.rateLimit
 */
@CommandDSL
interface RateLimitBuilder : IDeclarationSiteHolderBuilder {
    val group: String
    val rateLimiter: RateLimiter
}