BotCommands/io.github.freya022.botcommands.api.commands.annotations

Package-level declarations

Types

Bandwidth

@Target(allowedTargets = [])

annotation class Bandwidth(val capacity: Long, val refill: Refill)

Represents one of the limits of a rate limit bucket.

BotPermissions

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class BotPermissions(val permissions: Permission = [], val append: Boolean = false)

Sets the required bot permissions to use this text / application command.

Command

@Target(allowedTargets = [AnnotationTarget.CLASS])

@Bean

@Component

annotation class Command

Enables this class to be scanned for one or more commands.
This is a specialization of @BService for commands.

Cooldown

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class Cooldown(val cooldown: Long = 0, val unit: ChronoUnit = ChronoUnit.MILLIS, val rateLimitScope: RateLimitScope = RateLimitScope.USER, val deleteOnRefill: Boolean = true)

Add a simple rate limit-based cooldown of this text / application command and components.

Filter

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class Filter(val classes: KClass<out Filter>)

References an interaction filtering service.

GeneratedOption

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class GeneratedOption

Marks a parameter as being a generated option.

Optional

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Optional

Marks an option (@SlashOption or @TextOption) as being optional.

RateLimit

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class RateLimit(val scope: RateLimitScope, val deleteOnRefill: Boolean = true, val bandwidths: Bandwidth)

Defines a rate limit for a command / component handler.

RateLimitReference

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class RateLimitReference(val group: String)

Uses an existing rate limiter for this command / component handler.

Refill

@Target(allowedTargets = [])

annotation class Refill(val type: RefillType, val tokens: Long, val period: Long, val periodUnit: ChronoUnit)

Defines how the tokens are refilled on each bandwidth.

RefillType

enum RefillType : Enum<RefillType>

Refill type of bandwidths.

UserPermissions

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class UserPermissions(val permissions: Permission = [], val append: Boolean = false)

Sets the required user permissions to use this text / application command.

VarArgs

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class VarArgs(val value: Int, val numRequired: Int = 1)

Generates N command options from the specified @SlashOption or @TextOption.