Package net.essentialsx.api.v2.services.discord

Class InteractionCommandArgument

java.lang.Object

net.essentialsx.api.v2.services.discord.InteractionCommandArgument

public class InteractionCommandArgument
extends Object

Represents an argument for a command to be shown to Discord users.

Constructor Summary

Constructors

Constructor	Description
InteractionCommandArgument(String name, String description, InteractionCommandArgumentType type, boolean required)	Builds a command argument.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description of this argument.
String	getName()	Gets the name of this argument.
InteractionCommandArgumentType	getType()	Gets the type of this argument.
boolean	isRequired()	Whether or not this argument is required or not.

Methods inherited from class java.lang.Object

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

Constructor Details

InteractionCommandArgument

public InteractionCommandArgument(String name,
 String description,
 InteractionCommandArgumentType type,
 boolean required)

Builds a command argument.

Parameters:

name - The name of the argument to be shown to the Discord client.

description - A brief description of the argument to be shown to the Discord client.

type - The type of argument.

required - Whether or not the argument is required in order to send the command in the Discord client.

Method Details

getName

public String getName()

Gets the name of this argument.

Returns:

the name of the argument.

getDescription

public String getDescription()

Gets the description of this argument.

Returns:

the description of the argument.

getType

public InteractionCommandArgumentType getType()

Gets the type of this argument.

Returns:

the argument type.

isRequired

public boolean isRequired()

Whether or not this argument is required or not.

Returns:

true if the argument is required.