Package com.github.johnnyjayjay.discord.commandapi

Class CommandEvent

java.lang.Object

net.dv8tion.jda.core.events.Event

net.dv8tion.jda.core.events.guild.GenericGuildEvent

net.dv8tion.jda.core.events.message.guild.GenericGuildMessageEvent

net.dv8tion.jda.core.events.message.guild.GuildMessageReceivedEvent

com.github.johnnyjayjay.discord.commandapi.CommandEvent

public class CommandEvent
extends net.dv8tion.jda.core.events.message.guild.GuildMessageReceivedEvent

Represents a command event. This is not much different from a GuildMessageReceivedEvent, though it gives access to the called command and provides several utilities to work with, such as the getFirstMention-methods

Version:

3.2

Author:

Johnny_JayJay

See Also:

GuildMessageReceivedEvent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandEvent.Command	Describes an executed Command.

Field Summary

Fields inherited from class net.dv8tion.jda.core.events.Event

api, responseNumber

Fields inherited from class net.dv8tion.jda.core.events.guild.GenericGuildEvent

guild

Fields inherited from class net.dv8tion.jda.core.events.message.guild.GenericGuildMessageEvent

channel, messageId

Constructor Summary

Constructors

Constructor	Description
CommandEvent(net.dv8tion.jda.core.JDA api, long responseNumber, net.dv8tion.jda.core.entities.Message message, CommandEvent.Command command, CommandSettings settings)

Method Summary

Modifier and Type	Method	Description
boolean	checkBotPermissions(net.dv8tion.jda.core.Permission... permissions)	Returns whether the self member has the given permissions in the event channel.
boolean	checkMemberPermissions(net.dv8tion.jda.core.Permission... permissions)	Returns whether the Member who executed the command has the given permissions in the event channel.
String[]	getArgs()	Returns the arguments of the command.
CommandEvent.Command	getCommand()
CommandSettings	getCommandSettings()	Returns the CommandSettings instance this command was called for.
Optional<net.dv8tion.jda.core.entities.TextChannel>	getFirstChannelMention()	Returns the first channel mention in the event message as an Optional.
Optional<? extends net.dv8tion.jda.core.entities.IMentionable>	getFirstMention(net.dv8tion.jda.core.entities.Message.MentionType... mentionTypes)	Returns the first mention in the event message as an Optional.
Optional<net.dv8tion.jda.core.entities.Role>	getFirstRoleMention()	Returns the first role mention in the event message as an Optional.
Optional<net.dv8tion.jda.core.entities.User>	getFirstUserMention()	Returns the first member mention in the event message as an Optional.
protected static CommandEvent.Command	parseCommand(String raw, String prefix, CommandSettings settings)
void	respond(String msg)	Sends a message to the event channel.
void	respond(net.dv8tion.jda.core.entities.Message msg)	Sends a message to the event channel.
void	respond(net.dv8tion.jda.core.entities.MessageEmbed msg)	Sends a message to the event channel.

Methods inherited from class net.dv8tion.jda.core.events.Event

getJDA, getResponseNumber

Methods inherited from class net.dv8tion.jda.core.events.guild.GenericGuildEvent

getGuild

Methods inherited from class net.dv8tion.jda.core.events.message.guild.GenericGuildMessageEvent

getChannel, getMessageId, getMessageIdLong

Methods inherited from class net.dv8tion.jda.core.events.message.guild.GuildMessageReceivedEvent

getAuthor, getMember, getMessage, isWebhookMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandEvent

public CommandEvent(net.dv8tion.jda.core.JDA api,
                    long responseNumber,
                    net.dv8tion.jda.core.entities.Message message,
                    CommandEvent.Command command,
                    CommandSettings settings)

Method Detail

respond

public void respond(String msg)

Sends a message to the event channel. This only sends a message if the self member has permission to do so.

Parameters:

msg - The message to respond with as a String.

respond

public void respond(net.dv8tion.jda.core.entities.MessageEmbed msg)

Sends a message to the event channel. This only sends a message if the self member has permission to do so.

Parameters:

msg - The message to respond with as a MessageEmbed.

respond

public void respond(net.dv8tion.jda.core.entities.Message msg)

Sends a message to the event channel. This only sends a message if the self member has permission to do so.

Parameters:

msg - The message to respond with as a Message object.

getCommand

public CommandEvent.Command getCommand()

Returns:

the CommandEvent.Command instance of this event. This instance works like a container with further information and utility methods about the command that was executed.

getCommandSettings

public CommandSettings getCommandSettings()

Returns the CommandSettings instance this command was called for.

Returns:

an instance of CommandSettings.

See Also:

CommandSettings

getArgs

public String[] getArgs()

Returns the arguments of the command.

Returns:

the arguments of the command that has been executed.

getFirstMention

public Optional<? extends net.dv8tion.jda.core.entities.IMentionable> getFirstMention(net.dv8tion.jda.core.entities.Message.MentionType... mentionTypes)

Returns the first mention in the event message as an Optional.

Parameters:

mentionTypes - The MentionTypes to look for.

Returns:

An Optional of the first mentioned entity in the event message.

See Also:

Optional

getFirstUserMention

public Optional<net.dv8tion.jda.core.entities.User> getFirstUserMention()

Returns the first member mention in the event message as an Optional.

Returns:

An Optional of the first mentioned Member in the event message.

See Also:

Optional

getFirstRoleMention

public Optional<net.dv8tion.jda.core.entities.Role> getFirstRoleMention()

Returns the first role mention in the event message as an Optional.

Returns:

An Optional of the first mentioned Role in the event message.

See Also:

Optional

getFirstChannelMention

public Optional<net.dv8tion.jda.core.entities.TextChannel> getFirstChannelMention()

Returns the first channel mention in the event message as an Optional.

Returns:

An Optional of the first mentioned TextChannel in the event message.

See Also:

Optional

checkMemberPermissions

public boolean checkMemberPermissions(net.dv8tion.jda.core.Permission... permissions)

Returns whether the Member who executed the command has the given permissions in the event channel.

Parameters:

permissions - One or more Checks to check for.

Returns:

true: Member has the permissions in this channel, false: they have not

checkBotPermissions

public boolean checkBotPermissions(net.dv8tion.jda.core.Permission... permissions)

Returns whether the self member has the given permissions in the event channel.

Parameters:

permissions - One or more Checks to check for.

Returns:

true: self member has the permissions in this channel, false: it has not

parseCommand

protected static CommandEvent.Command parseCommand(String raw,
                                                   String prefix,
                                                   CommandSettings settings)