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

CommandInfo

interface CommandInfo : INamedCommand, IDeclarationSiteHolder, IRateLimitHolder(source)

Represents a text/application command.

Inheritors

Properties

Link copied to clipboard
abstract val botPermissions: EnumSet<Permission>

The permissions required for the bot to run this command.

Link copied to clipboard
abstract val context: BContext

The main context.

Link copied to clipboard
abstract val declarationSite: DeclarationSite

Purely for debugging purposes, will be shown in exceptions.

Link copied to clipboard
abstract val name: String

The name of this command.

Link copied to clipboard
abstract val parentInstance: INamedCommand?

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

Link copied to clipboard
abstract val path: CommandPath

The complete path that leads to this command.

Link copied to clipboard
abstract val userPermissions: EnumSet<Permission>

The permissions required for the caller to use this command.

Functions

Link copied to clipboard
abstract fun hasRateLimiter(): Boolean

Return true if this has a rate limiter.