ICommand

All Known Implementing Classes:

Command, HelpCommand, LanguageCommand, PingCommandExample, PrefixCommand
```
public interface ICommand
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`anyUsage(net.dv8tion.jda.api.events.Event event)` Generates example usages of the command.
`String`	`checkPermissions(net.dv8tion.jda.api.events.Event event)` Check if the user has permission to run this command, and to run it in the current channel.
`List<String>`	`getAliases()` Get a list of alternative names to call this command.
`IArgument`	`getArgument(String name)` Get a specific argument by its name.
`List<IArgument>`	`getArguments()` Get a list of arguments expected by this command.
`List<net.dv8tion.jda.api.Permission>`	`getClientPermissions()` Get the list of Permission required by the bot in the server to execute this command.
`String`	`getDescription()` Get the command's short description.
`String`	`getDescription(net.dv8tion.jda.api.events.Event event)` Get the command's short description.
`String`	`getDetails()` Get the command's detailed description.
`String`	`getDetails(net.dv8tion.jda.api.events.Event event)` Get the command's detailed description.
`List<String>`	`getExamples()` Get a list of example usages.
`String`	`getGroup()` get the command group's name or category.
`String`	`getGroup(net.dv8tion.jda.api.events.Event event)` get the command group's name or category.
`List<net.dv8tion.jda.api.Permission>`	`getMemberPermissions()` Get the list of Permission required by the Discord member in the server to execute this command.
`String`	`getName()` get the command's name.
`String`	`getName(net.dv8tion.jda.api.events.Event event)` get the command's name.
`Throttling`	`getThrottling()` Get the Throttling configuration for this command.
`boolean`	`isGuildOnly()` Checks if the command should only be used inside a Discord server.
`boolean`	`isNsfw()` Checks if the command should only be used in channels marked as NSFW.
`boolean`	`isPrivateUseOnly()` Checks if the command should only be used in Direct Messages.
`boolean`	`isRunInThread()` Checks if the command should run inside a Discord Thread.
`boolean`	`isThreadOnly()` Checks if the command should only be used inside threads.
`void`	`onDirectMessageReceived(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)` Handles a command call from Direct Messages.
`void`	`onGuildMessageReceived(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)` Handles a command call from a Normal Server Channel.
`void`	`onGuildThreadMessageReceived(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)` Handles a command call from a Thread Server Channel.
`String`	`usage(String arg, net.dv8tion.jda.api.events.Event event)` Generates an example usage of the command.

- Method Detail
  - isNsfw
```
boolean isNsfw()
```
    Checks if the command should only be used in channels marked as NSFW.
    
    Returns:
    
    true if the command is marked as NSFW, false otherwise.
  - isGuildOnly
```
boolean isGuildOnly()
```
    Checks if the command should only be used inside a Discord server.
    
    Returns:
    
    true if the command is only usable in a Discord Server, false if compatible with Direct Message.
  - isRunInThread
```
boolean isRunInThread()
```
    Checks if the command should run inside a Discord Thread.
    
    Returns:
    
    true if the command can run inside a Discord Thread, false if it can only run in normal channels.
  - isThreadOnly
```
boolean isThreadOnly()
```
    Checks if the command should only be used inside threads.
    
    Returns:
    
    true if the command is only usable in threads, false otherwise.
  - isPrivateUseOnly
```
boolean isPrivateUseOnly()
```
    Checks if the command should only be used in Direct Messages.
    
    Returns:
    
    True if command should only be used inside Direct Messages.
  - getName
```
String getName()
```
    get the command's name.
    
    Returns:
    
    command's name.
  - getGroup
```
String getGroup()
```
    get the command group's name or category.
    
    Returns:
    
    command group's name.
  - getDescription
```
String getDescription()
```
    Get the command's short description.
    
    Returns:
    
    command's description.
  - getDetails
```
String getDetails()
```
    Get the command's detailed description.
    
    Returns:
    
    command's detailed description.
  - getName
```
String getName(net.dv8tion.jda.api.events.Event event)
```
    get the command's name.
    
    Parameters:
    
    event - Discord's event that triggered this function call.
    
    Returns:
    
    command's name.
  - getGroup
```
String getGroup(net.dv8tion.jda.api.events.Event event)
```
    get the command group's name or category.
    
    Parameters:
    
    event - Discord's event that triggered this function call.
    
    Returns:
    
    command group's name.
  - getDescription
```
String getDescription(net.dv8tion.jda.api.events.Event event)
```
    Get the command's short description.
    
    Parameters:
    
    event - Discord's event that triggered this function call.
    
    Returns:
    
    command's description.
  - getDetails
```
String getDetails(net.dv8tion.jda.api.events.Event event)
```
    Get the command's detailed description.
    
    Parameters:
    
    event - Discord's event that triggered this function call.
    
    Returns:
    
    command's detailed description.
  - anyUsage
```
String anyUsage(net.dv8tion.jda.api.events.Event event)
```
    Generates example usages of the command.
    
    Parameters:
    
    event - Discord's event that triggered this function call.
    
    Returns:
    
    Usage example for discord chat.
  - usage
```
String usage(String arg,
             net.dv8tion.jda.api.events.Event event)
```
    Generates an example usage of the command.
    
    Parameters:
    
    arg - Arguments in the example.
    
    event - Discord event that triggered this function call.
    
    Returns:
    
    example usage of the command.
  - checkPermissions
```
String checkPermissions(net.dv8tion.jda.api.events.Event event)
```
    Check if the user has permission to run this command, and to run it in the current channel.
    
    Parameters:
    
    event - Discord event that triggered this function call.
    
    Returns:
    
    Error message explaining why the command cannot be executed.
  - onGuildThreadMessageReceived
```
void onGuildThreadMessageReceived(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)
```
    Handles a command call from a Thread Server Channel.
    
    Parameters:
    
    event - Discord event that triggered this function call.
  - onGuildMessageReceived
```
void onGuildMessageReceived(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)
```
    Handles a command call from a Normal Server Channel.
    
    Parameters:
    
    event - Discord event that triggered this function call.
  - onDirectMessageReceived
```
void onDirectMessageReceived(net.dv8tion.jda.api.events.message.MessageReceivedEvent event)
```
    Handles a command call from Direct Messages.
    
    Parameters:
    
    event - Discord event that triggered this function call.
  - getArgument
```
IArgument getArgument(String name)
```
    Get a specific argument by its name.
    
    Parameters:
    
    name - Argument's name.
    
    Returns:
    
    Argument's object.
  - getThrottling
```
Throttling getThrottling()
```
    Get the Throttling configuration for this command.
    
    Returns:
    
    Throttling configuration.
  - getArguments
```
List<IArgument> getArguments()
```
    Get a list of arguments expected by this command.
    
    Returns:
    
    list of arguments.
  - getExamples
```
List<String> getExamples()
```
    Get a list of example usages.
    
    Returns:
    
    list of example usages.
  - getAliases
```
List<String> getAliases()
```
    Get a list of alternative names to call this command.
    
    Returns:
    
    list of alternative names.
  - getClientPermissions
```
List<net.dv8tion.jda.api.Permission> getClientPermissions()
```
    Get the list of Permission required by the bot in the server to execute this command.
    
    Returns:
    
    list of Permission.
  - getMemberPermissions
```
List<net.dv8tion.jda.api.Permission> getMemberPermissions()
```
    Get the list of Permission required by the Discord member in the server to execute this command.
    
    Returns:
    
    list of Permission.

Interface ICommand

Method Summary

Method Detail

isNsfw

isGuildOnly

isRunInThread

isThreadOnly

isPrivateUseOnly

getName

getGroup

getDescription

getDetails

getName

getGroup

getDescription

getDetails

anyUsage

usage

checkPermissions

onGuildThreadMessageReceived

onGuildMessageReceived

onDirectMessageReceived

getArgument

getThrottling

getArguments

getExamples

getAliases

getClientPermissions

getMemberPermissions