com.ericramirezs.commando4j.command.util

Class HelpCommand

java.lang.Object

com.ericramirezs.commando4j.command.Command

com.ericramirezs.commando4j.command.util.HelpCommand

All Implemented Interfaces:

ICommand, PermissionsName, Slash

public class HelpCommand
extends Command
implements Slash

Field Summary

Fields inherited from interface com.ericramirezs.commando4j.command.PermissionsName

NAME

Constructor Summary

Constructors

Constructor and Description
HelpCommand()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the command's short description.
String	getDescription(net.dv8tion.jda.api.events.Event event) Get the command's short description.
void	run(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event, @NotNull Map<String,IArgument> args) Command execution after all validations has been passed.
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.
HelpCommand	useSimpleCommandList()

Methods inherited from class com.ericramirezs.commando4j.command.Command

addAliases, addClientPermissions, addExample, addExamples, addMemberPermissions, anyUsage, checkClientPermissions, checkMemberPermissions, checkPermissions, getAliases, getArgument, getArguments, getClientPermissions, getDetails, getDetails, getExamples, getGroup, getGroup, getMemberPermissions, getName, getName, getThrottling, hasPermission, hasPermission, hasPermission, isGuildOnly, isNsfw, isPrivateUseOnly, isRunInThread, isThreadOnly, onDirectMessageReceived, onGuildMessageReceived, onGuildThreadMessageReceived, sendReply, sendReply, sendReply, sendReply, sendReply, sendReply, sendReply, sendReply, sendReply, setDetails, setGuildOnly, setNotRunInThreads, setNsfw, setPrivateUseOnly, setThreadOnly, setThrottling, shouldRun, toString, usage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ericramirezs.commando4j.Slash

sendReply, sendReply, sendReply, sendReply, sendReply, sendReply, shouldRun

Constructor Detail

HelpCommand

public HelpCommand()
            throws DuplicatedArgumentNameException

Throws:

DuplicatedArgumentNameException

Method Detail

getDescription

public String getDescription()

Description copied from interface: ICommand

Get the command's short description.

Specified by:

getDescription in interface ICommand

Overrides:

getDescription in class Command

Returns:

command's description.

getDescription

public String getDescription(net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommand

Get the command's short description.

Specified by:

getDescription in interface ICommand

Overrides:

getDescription in class Command

Parameters:

event - Discord's event that triggered this function call.

Returns:

command's description.

useSimpleCommandList

public HelpCommand useSimpleCommandList()

run

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

Description copied from interface: Slash

Command execution after all validations has been passed.

Specified by:

run in interface Slash

Parameters:

event - Discord event that triggered this command call

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

run

public void run(@NotNull
                @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                @NotNull
                @NotNull Map<String,IArgument> args)

Description copied from class: Command

Command execution after all validations has been passed.

Specified by:

run in class Command

Parameters:

event - Discord event that triggered this command call

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