BotCommands/io.github.freya022.botcommands.api.commands.application.builder/ApplicationCommandBuilder

ApplicationCommandBuilder

interface ApplicationCommandBuilder<T : ApplicationCommandOptionAggregateBuilder<T>> : ExecutableCommandBuilder<T> , ApplicationOptionRegistry<T> (source)

Inheritors

TopLevelApplicationCommandBuilder

SlashCommandBuilder

Properties

abstract var botPermissions: EnumSet<Permission>

The permissions required for the bot to run this command.

abstract val context: BContext

The main context.

declarationSite

abstract override var declarationSite: DeclarationSite

Purely for debugging purposes, will be shown in exceptions.

abstract val filters: MutableList<ApplicationCommandFilter<*>>

Set of filters preventing this command from executing.

abstract val name: String

The name of this command.

abstract val parentInstance: INamedCommand?

The parent of this command, null for top-level commands.

abstract val path: CommandPath

The complete path that leads to this command.

topLevelBuilder

abstract val topLevelBuilder: TopLevelApplicationCommandBuilder<T>

userPermissions

abstract var userPermissions: EnumSet<Permission>

The permissions required for the caller to use this command.

Functions

abstract fun aggregate(declaredName: String, aggregator: KFunction<*>, block: T.() -> Unit = {})

Declares multiple options aggregated in a single parameter.

fun CommandBuilder.cooldown(duration: Duration, scope: RateLimitScope = RateLimitScope.USER, deleteOnRefill: Boolean = true, block: RateLimitBuilder.() -> Unit = {})

Sets an anonymous rate limit-based cooldown on this command. This cooldown cannot be referenced anywhere else as it is not registered.

abstract fun customOption(declaredName: String)

Declares a custom option, such as an TextLocalizationContext (with @LocalizationBundle).

inline fun <T : ApplicationCommandFilter<*>> ApplicationCommandBuilder<*>.filter(): T

Convenience extension to load an ApplicationCommandFilter service.

generatedOption

abstract fun generatedOption(declaredName: String, generatedValueSupplier: ApplicationGeneratedValueSupplier)

Declares a generated option, the supplier gets called on each command execution.

inlineClassAggregate

fun <T : OptionAggregateBuilder<T>> OptionAggregateBuilderContainer<T>.inlineClassAggregate(declaredName: String, clazz: KClass<*>, block: T.(valueName: String) -> Unit = {})

abstract fun rateLimit(bucketFactory: BucketFactory, limiterFactory: RateLimiterFactory = RateLimiter.defaultFactory(RateLimitScope.USER), block: RateLimitBuilder.() -> Unit = {})

Sets an anonymous rate limiter on this command. This rate limiter cannot be referenced anywhere else as it is not registered.

rateLimitReference

abstract fun rateLimitReference(group: String)

Sets the rate limiter of this command to one declared by a RateLimitProvider.

abstract fun serviceOption(declaredName: String)

Declares a service option, allowing injection of services, which must be available.