Package net.dv8tion.jda.internal.interactions.command

Interface CommandInteractionPayloadMixin

All Superinterfaces:

CommandInteractionPayload, Interaction, ISnowflake

All Known Implementing Classes:

CommandAutoCompleteInteractionImpl, CommandInteractionImpl, ContextInteractionImpl, MessageContextInteractionImpl, SlashCommandInteractionImpl, UserContextInteractionImpl

public interface CommandInteractionPayloadMixin
extends CommandInteractionPayload

Method Summary

Modifier and Type	Method	Description
default long	getCommandIdLong()	The command id.
CommandInteractionPayload	getCommandPayload()
default Command.Type	getCommandType()	The Type of command this interaction is for.
default String	getName()	The command name.
default List<OptionMapping>	getOptions()	The options provided by the user when this command was executed.
default String	getSubcommandGroup()	The subcommand group name.
default String	getSubcommandName()	The subcommand name.
default boolean	isGuildCommand()	Whether the used command is a guild command.

Methods inherited from interface net.dv8tion.jda.api.interactions.commands.CommandInteractionPayload

getCommandId, getCommandString, getFullCommandName, getOption, getOption, getOption, getOption, getOptionsByName, getOptionsByType, isGlobalCommand

Methods inherited from interface net.dv8tion.jda.api.interactions.Interaction

getChannel, getChannelId, getChannelIdLong, getChannelType, getContext, getEntitlements, getGuild, getGuildChannel, getGuildLocale, getIntegrationOwners, getJDA, getMember, getMessageChannel, getToken, getType, getTypeRaw, getUser, getUserLocale, isAcknowledged, isFromAttachedGuild, isFromGuild

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Details

getCommandPayload

CommandInteractionPayload getCommandPayload()

getCommandType

@Nonnull
default Command.Type getCommandType()

Description copied from interface: CommandInteractionPayload

The Type of command this interaction is for.

Specified by:

getCommandType in interface CommandInteractionPayload

Returns:

The command type

getName

@Nonnull
default String getName()

Description copied from interface: CommandInteractionPayload

The command name.
This can be useful for abstractions.

Note that commands can have these following structures:

• /name subcommandGroup subcommandName
• /name subcommandName
• /name

You can use CommandInteractionPayload.getFullCommandName() to simplify your checks.

Specified by:

getName in interface CommandInteractionPayload

Returns:

The command name

getSubcommandName

@Nullable
default String getSubcommandName()

Description copied from interface: CommandInteractionPayload

The subcommand name.
This can be useful for abstractions.

Note that commands can have these following structures:

• /name subcommandGroup subcommandName
• /name subcommandName
• /name

You can use CommandInteractionPayload.getFullCommandName() to simplify your checks.

Specified by:

getSubcommandName in interface CommandInteractionPayload

Returns:

The subcommand name, or null if this is not a subcommand

getSubcommandGroup

@Nullable
default String getSubcommandGroup()

Description copied from interface: CommandInteractionPayload

The subcommand group name.
This can be useful for abstractions.

Note that commands can have these following structures:

• /name subcommandGroup subcommandName
• /name subcommandName
• /name

You can use CommandInteractionPayload.getFullCommandName() to simplify your checks.

Specified by:

getSubcommandGroup in interface CommandInteractionPayload

Returns:

The subcommand group name, or null if this is not a subcommand group

getCommandIdLong

default long getCommandIdLong()

Description copied from interface: CommandInteractionPayload

The command id.
This is the id generated when a command is created via Guild.updateCommands() or similar.

It is usually preferred to discriminate commands by the command names instead.

Specified by:

getCommandIdLong in interface CommandInteractionPayload

Returns:

The command id

getOptions

@Nonnull
default List<OptionMapping> getOptions()

Description copied from interface: CommandInteractionPayload

The options provided by the user when this command was executed.
Each option has a name and value.

For CommandAutoCompleteInteraction, this might be incomplete and unvalidated. Auto-complete interactions happen on incomplete command inputs and are not validated.

Specified by:

getOptions in interface CommandInteractionPayload

Returns:

The options passed for this command

See Also:

• CommandInteractionPayload.getOption(String)

isGuildCommand

default boolean isGuildCommand()

Description copied from interface: CommandInteractionPayload

Whether the used command is a guild command.

Guild commands can be created with Guild.upsertCommand(CommandData).

Specified by:

isGuildCommand in interface CommandInteractionPayload

Returns:

True, if the used command is a guild command