Package net.dv8tion.jda.internal.requests.restaction

Class CommandCreateActionImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<Command>

net.dv8tion.jda.internal.requests.restaction.CommandCreateActionImpl

All Implemented Interfaces:

CommandData, SlashCommandData, RestAction<Command>, CommandCreateAction, SerializableData

public class CommandCreateActionImpl
extends RestActionImpl<Command>
implements CommandCreateAction

Field Summary

Fields inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

LOG

Fields inherited from interface net.dv8tion.jda.api.interactions.commands.build.CommandData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH, MAX_OPTIONS

Constructor Summary

Constructors

Constructor	Description
CommandCreateActionImpl(Guild guild, CommandDataImpl command)
CommandCreateActionImpl(JDAImpl api, CommandDataImpl command)

Method Summary

Modifier and Type	Method	Description
CommandCreateAction	addCheck(BooleanSupplier checks)	Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).
CommandCreateAction	addOptions(OptionData... options)	Adds up to 25 options to this command.
CommandCreateAction	addSubcommandGroups(SubcommandGroupData... group)	Add up to 25 Subcommand-Groups to this command.
CommandCreateAction	addSubcommands(SubcommandData... subcommand)	Add up to 25 Subcommands to this command.
CommandCreateAction	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
okhttp3.RequestBody	finalizeData()
Set<InteractionContextType>	getContexts()	The contexts in which this command can be used.
DefaultMemberPermissions	getDefaultPermissions()	Gets the DefaultMemberPermissions of this command.
String	getDescription()	The configured description
LocalizationMap	getDescriptionLocalizations()	The localizations of this command's description for various languages.
Set<IntegrationType>	getIntegrationTypes()	Gets the integration types on which this command can be installed on.
String	getName()	The current command name
LocalizationMap	getNameLocalizations()	The localizations of this command's name for various languages.
List<OptionData>	getOptions()	The options for this command.
List<SubcommandGroupData>	getSubcommandGroups()	The Subcommand Groups in this command.
List<SubcommandData>	getSubcommands()	The Subcommands in this command.
Command.Type	getType()	The Command.Type
boolean	isNSFW()	Whether this command should only be usable in NSFW (age-restricted) channels
boolean	removeOptions(Predicate<? super OptionData> condition)	Removes all options that evaluate to true under the provided condition.
boolean	removeSubcommandGroups(Predicate<? super SubcommandGroupData> condition)	Removes all subcommand groups that evaluate to true under the provided condition.
boolean	removeSubcommands(Predicate<? super SubcommandData> condition)	Removes all subcommands that evaluate to true under the provided condition.
CommandCreateAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
CommandCreateAction	setContexts(Collection<InteractionContextType> contexts)	Sets the contexts in which this command can be used (Default: Guild and Bot DMs).
CommandCreateAction	setDefaultPermissions(DefaultMemberPermissions permission)	Sets the Permissions that a user must have in a specific channel to be able to use this command.
CommandCreateAction	setDescription(String description)	Configure the description
CommandCreateAction	setDescriptionLocalization(DiscordLocale locale, String description)	Sets a language-specific localizations of this command's description.
CommandCreateAction	setDescriptionLocalizations(Map<DiscordLocale,String> map)	Sets multiple language-specific localizations of this command's description.
CommandCreateAction	setIntegrationTypes(Collection<IntegrationType> integrationTypes)	Sets the integration types on which this command can be installed on (Default: Guilds).
CommandCreateAction	setLocalizationFunction(LocalizationFunction localizationFunction)	Sets the LocalizationFunction for this command This enables you to have the entirety of this command to be localized.
CommandCreateAction	setName(String name)	Configure the command name.
CommandCreateAction	setNameLocalization(DiscordLocale locale, String name)	Sets a language-specific localization of this command's name.
CommandCreateAction	setNameLocalizations(Map<DiscordLocale,String> map)	Sets multiple language-specific localizations of this command's name.
CommandCreateAction	setNSFW(boolean nsfw)	Sets whether this command should only be usable in NSFW (age-restricted) channels.
CommandCreateAction	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.
DataObject	toData()	Serialized DataObject for this object.

Methods inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, queue, setDefaultFailure, setDefaultSuccess, setDefaultTimeout, setErrorMapper, setPassContext, submit

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.CommandCreateAction

addOption, addOption, addOption, addOptions, addSubcommandGroups, addSubcommands, setContexts, setIntegrationTypes

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Methods inherited from interface net.dv8tion.jda.api.interactions.commands.build.SlashCommandData

removeOptionByName, removeSubcommandByName, removeSubcommandGroupByName

Constructor Details

CommandCreateActionImpl

public CommandCreateActionImpl(JDAImpl api,
 CommandDataImpl command)

CommandCreateActionImpl

public CommandCreateActionImpl(Guild guild,
 CommandDataImpl command)

Method Details

addCheck

@Nonnull
public CommandCreateAction addCheck(@Nonnull
 BooleanSupplier checks)

Description copied from interface: RestAction

Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).

Specified by:

addCheck in interface CommandCreateAction

Specified by:

addCheck in interface RestAction<Command>

Parameters:

checks - Other checks to run

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.setCheck(BooleanSupplier)

setCheck

@Nonnull
public CommandCreateAction setCheck(BooleanSupplier checks)

Description copied from interface: RestAction

Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates to false or throws an exception this will not be finished. When an exception is thrown from the supplier it will be provided to the failure callback.

Specified by:

setCheck in interface CommandCreateAction

Specified by:

setCheck in interface RestAction<Command>

Overrides:

setCheck in class RestActionImpl<Command>

Parameters:

checks - The checks to run before executing the request, or null to run no checks

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.getCheck()
• RestAction.addCheck(BooleanSupplier)

deadline

@Nonnull
public CommandCreateAction deadline(long timestamp)

Description copied from interface: RestAction

Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
If the deadline is reached, the request will fail with a TimeoutException.

This does not mean that the request will immediately timeout when the deadline is reached. JDA will check the deadline right before executing the request or within intervals in a worker thread. This only means the request will timeout if the deadline has passed.

Example

 action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

deadline in interface CommandCreateAction

Specified by:

deadline in interface RestAction<Command>

Overrides:

deadline in class RestActionImpl<Command>

Parameters:

timestamp - Millisecond timestamp at which the request will timeout

Returns:

The same RestAction with the applied deadline

See Also:

• RestAction.timeout(long, TimeUnit)
• RestAction.setDefaultTimeout(long, TimeUnit)

setDefaultPermissions

@Nonnull
public CommandCreateAction setDefaultPermissions(@Nonnull
 DefaultMemberPermissions permission)

Description copied from interface: CommandData

Sets the Permissions that a user must have in a specific channel to be able to use this command.
By default, everyone can use this command (DefaultMemberPermissions.ENABLED). Additionally, a command can be disabled for everyone but admins via DefaultMemberPermissions.DISABLED.

These configurations can be overwritten by moderators in each guild. See Command.retrievePrivileges(net.dv8tion.jda.api.entities.Guild) to get moderator defined overrides.

Specified by:

setDefaultPermissions in interface CommandCreateAction

Specified by:

setDefaultPermissions in interface CommandData

Specified by:

setDefaultPermissions in interface SlashCommandData

Parameters:

permission - DefaultMemberPermissions representing the default permissions of this command.

Returns:

The builder instance, for chaining

See Also:

• DefaultMemberPermissions.ENABLED
• DefaultMemberPermissions.DISABLED

setContexts

@Nonnull
public CommandCreateAction setContexts(@Nonnull
 Collection<InteractionContextType> contexts)

Description copied from interface: CommandData

Sets the contexts in which this command can be used (Default: Guild and Bot DMs).
This only has an effect if this command is registered globally.

Specified by:

setContexts in interface CommandCreateAction

Specified by:

setContexts in interface CommandData

Specified by:

setContexts in interface SlashCommandData

Parameters:

contexts - The contexts in which this command can be used

Returns:

The builder instance, for chaining

setIntegrationTypes

@Nonnull
public CommandCreateAction setIntegrationTypes(@Nonnull
 Collection<IntegrationType> integrationTypes)

Description copied from interface: CommandData

Sets the integration types on which this command can be installed on (Default: Guilds).
This only has an effect if this command is registered globally.

Specified by:

setIntegrationTypes in interface CommandCreateAction

Specified by:

setIntegrationTypes in interface CommandData

Specified by:

setIntegrationTypes in interface SlashCommandData

Parameters:

integrationTypes - The integration types on which this command can be installed on

Returns:

The builder instance, for chaining

setNSFW

@Nonnull
public CommandCreateAction setNSFW(boolean nsfw)

Description copied from interface: CommandData

Sets whether this command should only be usable in NSFW (age-restricted) channels.
Default: false

Note: Age-restricted commands will not show up in direct messages by default unless the user enables them in their settings.

Specified by:

setNSFW in interface CommandCreateAction

Specified by:

setNSFW in interface CommandData

Specified by:

setNSFW in interface SlashCommandData

Parameters:

nsfw - True, to make this command nsfw

Returns:

The builder instance, for chaining

See Also:

• Age-Restricted Commands FAQ

setLocalizationFunction

@Nonnull
public CommandCreateAction setLocalizationFunction(@Nonnull
 LocalizationFunction localizationFunction)

Description copied from interface: CommandData

Sets the LocalizationFunction for this command
This enables you to have the entirety of this command to be localized.

Specified by:

setLocalizationFunction in interface CommandCreateAction

Specified by:

setLocalizationFunction in interface CommandData

Specified by:

setLocalizationFunction in interface SlashCommandData

Parameters:

localizationFunction - The localization function

Returns:

The builder instance, for chaining

getName

@Nonnull
public String getName()

Description copied from interface: CommandData

The current command name

Specified by:

getName in interface CommandData

Returns:

The command name

getNameLocalizations

@Nonnull
public LocalizationMap getNameLocalizations()

Description copied from interface: CommandData

The localizations of this command's name for various languages.

Specified by:

getNameLocalizations in interface CommandData

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized name

getType

@Nonnull
public Command.Type getType()

Description copied from interface: CommandData

The Command.Type

Specified by:

getType in interface CommandData

Returns:

The Command.Type

getDefaultPermissions

@Nonnull
public DefaultMemberPermissions getDefaultPermissions()

Description copied from interface: CommandData

Gets the DefaultMemberPermissions of this command.
If no permissions have been set, this returns DefaultMemberPermissions.ENABLED.

Specified by:

getDefaultPermissions in interface CommandData

Returns:

DefaultMemberPermissions of this command.

See Also:

• DefaultMemberPermissions.ENABLED
• DefaultMemberPermissions.DISABLED

getContexts

@Nonnull
public Set<InteractionContextType> getContexts()

Description copied from interface: CommandData

The contexts in which this command can be used.

Specified by:

getContexts in interface CommandData

Returns:

The contexts in which this command can be used

getIntegrationTypes

@Nonnull
public Set<IntegrationType> getIntegrationTypes()

Description copied from interface: CommandData

Gets the integration types on which this command can be installed on.

Specified by:

getIntegrationTypes in interface CommandData

Returns:

The integration types on which this command can be installed on

isNSFW

public boolean isNSFW()

Description copied from interface: CommandData

Whether this command should only be usable in NSFW (age-restricted) channels

Specified by:

isNSFW in interface CommandData

Returns:

True, if this command is restricted to NSFW channels

See Also:

• Age-Restricted Commands FAQ

timeout

@Nonnull
public CommandCreateAction timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: RestAction

Timeout for this RestAction instance.
If the request doesn't get executed within the timeout it will fail.

When a RestAction times out, it will fail with a TimeoutException. This is the same as deadline(System.currentTimeMillis() + unit.toMillis(timeout)).

Example

 action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

timeout in interface CommandCreateAction

Specified by:

timeout in interface RestAction<Command>

Parameters:

timeout - The timeout to use

unit - Unit for the timeout value

Returns:

The same RestAction instance with the applied timeout

See Also:

• RestAction.setDefaultTimeout(long, TimeUnit)

setName

@Nonnull
public CommandCreateAction setName(@Nonnull
 String name)

Description copied from interface: CommandData

Configure the command name.

Specified by:

setName in interface CommandCreateAction

Specified by:

setName in interface CommandData

Specified by:

setName in interface SlashCommandData

Parameters:

name - The name, 1-32 characters (lowercase and alphanumeric for Command.Type.SLASH)

Returns:

The builder instance, for chaining

setNameLocalization

@Nonnull
public CommandCreateAction setNameLocalization(@Nonnull
 DiscordLocale locale,
 @Nonnull
 String name)

Description copied from interface: CommandData

Sets a language-specific localization of this command's name.

Specified by:

setNameLocalization in interface CommandCreateAction

Specified by:

setNameLocalization in interface CommandData

Specified by:

setNameLocalization in interface SlashCommandData

Parameters:

locale - The locale to associate the translated name with

name - The translated name to put

Returns:

This builder instance, for chaining

setNameLocalizations

@Nonnull
public CommandCreateAction setNameLocalizations(@Nonnull
 Map<DiscordLocale,String> map)

Description copied from interface: CommandData

Sets multiple language-specific localizations of this command's name.

Specified by:

setNameLocalizations in interface CommandCreateAction

Specified by:

setNameLocalizations in interface CommandData

Specified by:

setNameLocalizations in interface SlashCommandData

Parameters:

map - The map from which to transfer the translated names

Returns:

This builder instance, for chaining

setDescription

@Nonnull
public CommandCreateAction setDescription(@Nonnull
 String description)

Description copied from interface: SlashCommandData

Configure the description

Specified by:

setDescription in interface CommandCreateAction

Specified by:

setDescription in interface SlashCommandData

Parameters:

description - The description, 1-100 characters

Returns:

The builder, for chaining

setDescriptionLocalization

@Nonnull
public CommandCreateAction setDescriptionLocalization(@Nonnull
 DiscordLocale locale,
 @Nonnull
 String description)

Description copied from interface: SlashCommandData

Sets a language-specific localizations of this command's description.

Specified by:

setDescriptionLocalization in interface CommandCreateAction

Specified by:

setDescriptionLocalization in interface SlashCommandData

Parameters:

locale - The locale to associate the translated description with

description - The translated description to put

Returns:

This builder instance, for chaining

setDescriptionLocalizations

@Nonnull
public CommandCreateAction setDescriptionLocalizations(@Nonnull
 Map<DiscordLocale,String> map)

Description copied from interface: SlashCommandData

Sets multiple language-specific localizations of this command's description.

Specified by:

setDescriptionLocalizations in interface CommandCreateAction

Specified by:

setDescriptionLocalizations in interface SlashCommandData

Parameters:

map - The map from which to transfer the translated descriptions

Returns:

This builder instance, for chaining

getDescription

@Nonnull
public String getDescription()

Description copied from interface: SlashCommandData

The configured description

Specified by:

getDescription in interface SlashCommandData

Returns:

The description

getDescriptionLocalizations

@Nonnull
public LocalizationMap getDescriptionLocalizations()

Description copied from interface: SlashCommandData

The localizations of this command's description for various languages.

Specified by:

getDescriptionLocalizations in interface SlashCommandData

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized description

removeOptions

public boolean removeOptions(@Nonnull
 Predicate<? super OptionData> condition)

Description copied from interface: SlashCommandData

Removes all options that evaluate to true under the provided condition.
This will not affect options within subcommands. Use SubcommandData.removeOptions(Predicate) instead.

Example: Remove all options

 command.removeOptions(option -> true);
 

Example: Remove all options that are required

 command.removeOptions(option -> option.isRequired());
 

Specified by:

removeOptions in interface SlashCommandData

Parameters:

condition - The removal condition (must not throw)

Returns:

True, if any options were removed

removeSubcommands

public boolean removeSubcommands(@Nonnull
 Predicate<? super SubcommandData> condition)

Description copied from interface: SlashCommandData

Removes all subcommands that evaluate to true under the provided condition.
This will not apply to subcommands within subcommand groups. Use SubcommandGroupData.removeSubcommand(Predicate) instead.

Example: Remove all subcommands

 command.removeSubcommands(subcommand -> true);
 

Specified by:

removeSubcommands in interface SlashCommandData

Parameters:

condition - The removal condition (must not throw)

Returns:

True, if any subcommands were removed

removeSubcommandGroups

public boolean removeSubcommandGroups(@Nonnull
 Predicate<? super SubcommandGroupData> condition)

Description copied from interface: SlashCommandData

Removes all subcommand groups that evaluate to true under the provided condition.

Example: Remove all subcommand groups

 command.removeSubcommandGroups(group -> true);
 

Specified by:

removeSubcommandGroups in interface SlashCommandData

Parameters:

condition - The removal condition (must not throw)

Returns:

True, if any subcommand groups were removed

getSubcommands

@Nonnull
public List<SubcommandData> getSubcommands()

Description copied from interface: SlashCommandData

The Subcommands in this command.

Specified by:

getSubcommands in interface SlashCommandData

Returns:

Immutable list of SubcommandData

getSubcommandGroups

@Nonnull
public List<SubcommandGroupData> getSubcommandGroups()

Description copied from interface: SlashCommandData

The Subcommand Groups in this command.

Specified by:

getSubcommandGroups in interface SlashCommandData

Returns:

Immutable list of SubcommandGroupData

getOptions

@Nonnull
public List<OptionData> getOptions()

Description copied from interface: SlashCommandData

The options for this command.

Specified by:

getOptions in interface SlashCommandData

Returns:

Immutable list of OptionData

addOptions

@Nonnull
public CommandCreateAction addOptions(@Nonnull
 OptionData... options)

Description copied from interface: SlashCommandData

Adds up to 25 options to this command.

Required options must be added before non-required options!

Specified by:

addOptions in interface CommandCreateAction

Specified by:

addOptions in interface SlashCommandData

Parameters:

options - The Options to add

Returns:

The builder instance, for chaining

addSubcommands

@Nonnull
public CommandCreateAction addSubcommands(@Nonnull
 SubcommandData... subcommand)

Description copied from interface: SlashCommandData

Add up to 25 Subcommands to this command.
When a subcommand or subcommand group is added, the base command itself cannot be used. Thus using SlashCommandData.addOptions(OptionData...) and SlashCommandData.addSubcommands(SubcommandData...) / SlashCommandData.addSubcommandGroups(SubcommandGroupData...) for the same command, is not supported.

Valid command layouts are as follows:

 command
 |-- subcommand
 |__ subcommand group
     |__ subcommand

 command
 |__ subcommand group
     |__ subcommand

 command
 |-- option
 |__ option
 

Having an option and subcommand simultaneously is not allowed.

Specified by:

addSubcommands in interface CommandCreateAction

Specified by:

addSubcommands in interface SlashCommandData

Parameters:

subcommand - The subcommands to add

Returns:

The builder instance, for chaining

addSubcommandGroups

@Nonnull
public CommandCreateAction addSubcommandGroups(@Nonnull
 SubcommandGroupData... group)

Description copied from interface: SlashCommandData

Add up to 25 Subcommand-Groups to this command.
When a subcommand or subcommand group is added, the base command itself cannot be used. Thus using SlashCommandData.addOptions(OptionData...) and SlashCommandData.addSubcommands(SubcommandData...) / SlashCommandData.addSubcommandGroups(SubcommandGroupData...) for the same command, is not supported.

Valid command layouts are as follows:

 command
 |-- subcommand
 |__ subcommand group
     |__ subcommand

 command
 |__ subcommand group
     |__ subcommand

 command
 |-- option
 |__ option
 

Having an option and subcommand simultaneously is not allowed.

Specified by:

addSubcommandGroups in interface CommandCreateAction

Specified by:

addSubcommandGroups in interface SlashCommandData

Parameters:

group - The subcommand groups to add

Returns:

The builder instance, for chaining

finalizeData

public okhttp3.RequestBody finalizeData()

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject