BotCommands/io.github.freya022.botcommands.api.commands.application.context.annotations/JDAMessageCommand

JDAMessageCommand

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class JDAMessageCommand(val scope: CommandScope = CommandScope.GLOBAL, val contexts: Array<InteractionContextType> = [], val integrationTypes: Array<IntegrationType> = [], val defaultLocked: Boolean = false, val nsfw: Boolean = false, val name: String)(source)

Declares this function as a message context command.

See the Discord docs for more details.

Requirements

The declaring class must be annotated with @Command and extend ApplicationCommand.

The first parameter must be:

GuildMessageEvent if the interaction context only contains InteractionContextType.GUILD.
GlobalMessageEvent in other cases.

Option types

Input options: Uses @ContextOption, supported types and modifiers are in ParameterResolver, but only the targeted Message is supported by default, additional types can be added by implementing MessageContextParameterResolver.
AppLocalizationContext: Uses @LocalizationBundle.
Custom options: No annotation, additional types can be added by implementing ICustomResolver.
Service options: No annotation, however, I recommend injecting the service in the class instead.

Properties

contexts

val contexts: Array<InteractionContextType>

Represents where a command can be used.

defaultLocked

val defaultLocked: Boolean = false

Specifies whether the application command is disabled for everyone but administrators by default, so that administrators can further configure the command.

integrationTypes

val integrationTypes: Array<IntegrationType>

The integration types in which this command can be installed in.

name

val name: String

Primary name of the command, which can contain spaces and upper cases.

nsfw

val nsfw: Boolean = false

Specifies whether the application command is usable in NSFW channels.

scope

val scope: CommandScope

Specifies the application command scope for this command, where the command will be pushed to.

JDAMessageCommand

Requirements

Option types

See also

Properties