Package com.jagrosh.jdautilities.examples.command

Class GuildlistCommand

java.lang.Object

com.jagrosh.jdautilities.command.Interaction

com.jagrosh.jdautilities.command.Command

com.jagrosh.jdautilities.examples.command.GuildlistCommand

@CommandInfo(name="Guildlist",
             description="Gets a paginated list of the guilds the bot is on.",
             requirements={"The bot has all necessary permissions.","The user is the bot\'s owner."})
@Error(value="If arguments are provided, but they are not an integer.",
       response="[PageNumber] is not a valid integer!")
@RequiredPermissions({MESSAGE_EMBED_LINKS,MESSAGE_ADD_REACTION})
@Author("John Grosh (jagrosh)")
public class GuildlistCommand
extends Command

Author:

John Grosh (jagrosh)

Nested Class Summary

Nested classes/interfaces inherited from class com.jagrosh.jdautilities.command.Command

Command.Category

Field Summary

Fields inherited from class com.jagrosh.jdautilities.command.Command

aliases, arguments, category, children, help, helpBiConsumer, hidden, name, requiredRole, usesTopicTags

Fields inherited from class com.jagrosh.jdautilities.command.Interaction

botMissingPermMessage, botPermissions, cooldown, cooldownScope, guildOnly, nsfwOnly, ownerCommand, userMissingPermMessage, userPermissions

Constructor Summary

Constructors

Constructor	Description
GuildlistCommand(EventWaiter waiter)

Method Summary

Modifier and Type	Method	Description
protected void	execute(CommandEvent event)	The main body method of a Command.

Methods inherited from class com.jagrosh.jdautilities.command.Command

getAliases, getArguments, getCategory, getChildren, getCooldownError, getCooldownKey, getHelp, getName, getRequiredRole, isAllowed, isCommandFor, isGuildOnly, isHidden, run

Methods inherited from class com.jagrosh.jdautilities.command.Interaction

getBotPermissions, getCooldown, getCooldownScope, getUserPermissions, isOwnerCommand

Methods inherited from class java.lang.Object

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

Constructor Details

GuildlistCommand

public GuildlistCommand(EventWaiter waiter)

Method Details

execute

protected void execute(CommandEvent event)

Description copied from class: Command

The main body method of a Command.
This is the "response" for a successful #run(CommandEvent).

Specified by:

execute in class Command

Parameters:

event - The CommandEvent that triggered this Command