com.ericramirezs.commando4j

Interface Slash

All Known Implementing Classes:

HelpCommand, LanguageCommand, PingCommandExample, PrefixCommand

public interface Slash

Interface to handle command as Discord's slash commands. It tells the ICommandEngine that an implementation of ICommand should be also treated as a Slash command.

Note: Implementing this in a class that doesn't implements ICommand will make this implementation meaningless.

See Also:

ICommand

Method Summary

Modifier and Type	Method and Description
void	run(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @UnmodifiableView @NotNull Map<String,IArgument> args) Command execution after all validations has been passed.
static void	sendReply(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull net.dv8tion.jda.api.EmbedBuilder message) Sends an ephemeral reply to a Slash command request.
static void	sendReply(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull net.dv8tion.jda.api.EmbedBuilder message, boolean ephemeral)
static void	sendReply(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull net.dv8tion.jda.api.entities.MessageEmbed message) Sends an ephemeral reply to a Slash command request.
static void	sendReply(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull net.dv8tion.jda.api.entities.MessageEmbed message, boolean ephemeral)
static void	sendReply(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull String message) Sends an ephemeral reply to a Slash command request.
static void	sendReply(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull String message, boolean ephemeral) Sends a reply to a Slash command request.
static boolean	shouldRun(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, @NotNull ICommand command) Check if the command should be run in the current Message Channel.

Method Detail

sendReply

static void sendReply(@NotNull
                      @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                      @NotNull
                      @NotNull String message)

Sends an ephemeral reply to a Slash command request.

Parameters:

event - The event that triggered this response.

message - The response message for the user.

sendReply

static void sendReply(@NotNull
                      @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                      @NotNull
                      @NotNull String message,
                      boolean ephemeral)

Sends a reply to a Slash command request.

Parameters:

event - The event that triggered this response.

message - The response message for the user.

ephemeral - True, if this message should be invisible for other users.

sendReply

static void sendReply(@NotNull
                      @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                      @NotNull
                      @NotNull net.dv8tion.jda.api.EmbedBuilder message)

Sends an ephemeral reply to a Slash command request.

Parameters:

event - Discord event that triggered this function call

message - EmbedBuilder message

See Also:

EmbedBuilder

sendReply

static void sendReply(@NotNull
                      @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                      @NotNull
                      @NotNull net.dv8tion.jda.api.entities.MessageEmbed message)

Sends an ephemeral reply to a Slash command request.

Parameters:

event - Discord event that triggered this function call

message - MessageEmbed

See Also:

MessageEmbed

sendReply

static void sendReply(@NotNull
                      @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                      @NotNull
                      @NotNull net.dv8tion.jda.api.EmbedBuilder message,
                      boolean ephemeral)

Parameters:

event - Discord Event that triggered this function call.

message - EmbedBuilder message

ephemeral - True, if this message should be invisible for other users.

See Also:

EmbedBuilder

sendReply

static void sendReply(@NotNull
                      @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                      @NotNull
                      @NotNull net.dv8tion.jda.api.entities.MessageEmbed message,
                      boolean ephemeral)

Parameters:

event - Discord Event that triggered this function call.

message - MessageEmbed

ephemeral - True, if this message should be invisible for other users.

See Also:

MessageEmbed

shouldRun

static boolean shouldRun(@NotNull
                         @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                         @NotNull
                         @NotNull ICommand command)

Check if the command should be run in the current Message Channel.

Parameters:

event - Discord Event that triggered this function call.

command - Representation of a Slash Command as a ICommand.

Returns:

true if the command is compatible with the current Message Channel.

run

void run(@NotNull
         @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
         @NotNull
         @UnmodifiableView @NotNull Map<String,IArgument> args)

Command execution after all validations has been passed.

Parameters:

event - Discord event that triggered this command call

args - Already parsed arguments, Map's keys are the argument's name