All Superinterfaces:: CommandData, RestAction<Command>, SerializableData, SlashCommandData

public interface CommandCreateAction extends RestAction<Command>, SlashCommandData

Specialized RestAction used to create or update commands.
If a command with the specified name already exists, it will be replaced!

This operation is not idempotent! Commands will persist between restarts of your bot, you only have to create a command once.

Method Summary

Modifier and Type

Method

Description

CommandCreateAction

addCheck(BooleanSupplier checks)

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

default CommandCreateAction

addOption(OptionType type, String name, String description)

Adds an option to this command.

default CommandCreateAction

addOption(OptionType type, String name, String description, boolean required)

Adds an option to this command.

default CommandCreateAction

addOption(OptionType type, String name, String description, boolean required, boolean autoComplete)

Adds an option to this command.

default CommandCreateAction

addOptions(Collection<? extends OptionData> options)

Adds up to 25 options to this command.

CommandCreateAction

addOptions(OptionData... options)

Adds up to 25 options to this command.

default CommandCreateAction

addSubcommandGroups(Collection<? extends SubcommandGroupData> groups)

Add up to 25 Subcommand-Groups to this command.

CommandCreateAction

addSubcommandGroups(SubcommandGroupData... groups)

Add up to 25 Subcommand-Groups to this command.

default CommandCreateAction

addSubcommands(Collection<? extends SubcommandData> subcommands)

Add up to 25 Subcommands to this command.

CommandCreateAction

addSubcommands(SubcommandData... subcommands)

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.

CommandCreateAction

setCheck(BooleanSupplier checks)

Sets the last-second checks before finally executing the http request in the queue.

CommandCreateAction

setDefaultEnabled(boolean enabled)

Whether this command is available to everyone by default.

CommandCreateAction

setDescription(String description)

Configure the description

CommandCreateAction

setName(String name)

Configure the command name.

CommandCreateAction

timeout(long timeout, TimeUnit unit)

Timeout for this RestAction instance.

Methods inherited from interface net.dv8tion.jda.api.interactions.commands.build.CommandData
getName, getType, isDefaultEnabled

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, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Methods inherited from interface net.dv8tion.jda.api.utils.data.SerializableData
toData

Methods inherited from interface net.dv8tion.jda.api.interactions.commands.build.SlashCommandData
getDescription, getOptions, getSubcommandGroups, getSubcommands

Method Details
- setCheck
  
  @Nonnull CommandCreateAction setCheck(@Nullable 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 RestAction<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)
- addCheck
  
  @Nonnull CommandCreateAction addCheck(@Nonnull BooleanSupplier checks)
  
  Description copied from interface: RestAction
  
  Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).
  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)
- timeout
  
  @Nonnull 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 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)
- deadline
  
  @Nonnull @CheckReturnValue 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 RestAction<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)
- setDefaultEnabled
  
  @Nonnull @CheckReturnValue CommandCreateAction setDefaultEnabled(boolean enabled)
  
  Description copied from interface: CommandData
  
  Whether this command is available to everyone by default.
  If this is disabled, you need to explicitly whitelist users and roles per guild.
  You can use CommandPrivilege to enable or disable this command per guild for roles and members of the guild. See Command.updatePrivileges(Guild, CommandPrivilege...) and Guild.updateCommandPrivileges(Map).
  
  Specified by:
  
  setDefaultEnabled in interface CommandData
  
  Specified by:
  
  setDefaultEnabled in interface SlashCommandData
  
  Parameters:
  
  enabled - True, if this command is enabled by default for everyone. (Default: true)
  
  Returns:
  
  The builder instance, for chaining
- setName
  
  @Nonnull @CheckReturnValue CommandCreateAction setName(@Nonnull String name)
  
  Description copied from interface: CommandData
  
  Configure the command name.
  
  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
- setDescription
  
  @Nonnull @CheckReturnValue CommandCreateAction setDescription(@Nonnull String description)
  
  Description copied from interface: SlashCommandData
  
  Configure the description
  
  Specified by:
  
  setDescription in interface SlashCommandData
  
  Parameters:
  
  description - The description, 1-100 characters
  
  Returns:
  
  The builder, for chaining
- addOptions
  
  @Nonnull @CheckReturnValue 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 SlashCommandData
  
  Parameters:
  
  options - The Options to add
  
  Returns:
  
  The builder instance, for chaining
- addOptions
  
  @Nonnull @CheckReturnValue default CommandCreateAction addOptions(@Nonnull Collection<? extends 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 SlashCommandData
  
  Parameters:
  
  options - The Options to add
  
  Returns:
  
  The builder instance, for chaining
- addOption
  
  @Nonnull @CheckReturnValue default CommandCreateAction addOption(@Nonnull OptionType type, @Nonnull String name, @Nonnull String description, boolean required, boolean autoComplete)
  
  Description copied from interface: SlashCommandData
  
  Adds an option to this command.
  Required options must be added before non-required options!
  
  Specified by:
  
  addOption in interface SlashCommandData
  
  Parameters:
  
  type - The OptionType
  
  name - The lowercase option name, 1-32 characters
  
  description - The option description, 1-100 characters
  
  required - Whether this option is required (See OptionData.setRequired(boolean))
  
  autoComplete - Whether this option supports auto-complete via CommandAutoCompleteInteractionEvent, only supported for option types which support choices
  
  Returns:
  
  The builder instance, for chaining
- addOption
  
  @Nonnull @CheckReturnValue default CommandCreateAction addOption(@Nonnull OptionType type, @Nonnull String name, @Nonnull String description, boolean required)
  
  Description copied from interface: SlashCommandData
  
  Adds an option to this command.
  Required options must be added before non-required options!
  
  Specified by:
  
  addOption in interface SlashCommandData
  
  Parameters:
  
  type - The OptionType
  
  name - The lowercase option name, 1-32 characters
  
  description - The option description, 1-100 characters
  
  required - Whether this option is required (See OptionData.setRequired(boolean))
  
  Returns:
  
  The builder instance, for chaining
- addOption
  
  @Nonnull @CheckReturnValue default CommandCreateAction addOption(@Nonnull OptionType type, @Nonnull String name, @Nonnull String description)
  
  Description copied from interface: SlashCommandData
  
  Adds an option to this command.
  The option is set to be non-required! You can use SlashCommandData.addOption(OptionType, String, String, boolean) to add a required option instead.
  Required options must be added before non-required options!
  
  Specified by:
  
  addOption in interface SlashCommandData
  
  Parameters:
  
  type - The OptionType
  
  name - The lowercase option name, 1-32 characters
  
  description - The option description, 1-100 characters
  
  Returns:
  
  The builder instance, for chaining
- addSubcommands
  
  @Nonnull @CheckReturnValue CommandCreateAction addSubcommands(@Nonnull SubcommandData... subcommands)
  
  Description copied from interface: SlashCommandData
  
  Add up to 25 Subcommands to this command.
  
  Specified by:
  
  addSubcommands in interface SlashCommandData
  
  Parameters:
  
  subcommands - The subcommands to add
  
  Returns:
  
  The builder instance, for chaining
- addSubcommands
  
  @Nonnull @CheckReturnValue default CommandCreateAction addSubcommands(@Nonnull Collection<? extends SubcommandData> subcommands)
  
  Description copied from interface: SlashCommandData
  
  Add up to 25 Subcommands to this command.
  
  Specified by:
  
  addSubcommands in interface SlashCommandData
  
  Parameters:
  
  subcommands - The subcommands to add
  
  Returns:
  
  The builder instance, for chaining
- addSubcommandGroups
  
  @Nonnull @CheckReturnValue CommandCreateAction addSubcommandGroups(@Nonnull SubcommandGroupData... groups)
  
  Description copied from interface: SlashCommandData
  
  Add up to 25 Subcommand-Groups to this command.
  
  Specified by:
  
  addSubcommandGroups in interface SlashCommandData
  
  Parameters:
  
  groups - The subcommand groups to add
  
  Returns:
  
  The builder instance, for chaining
- addSubcommandGroups
  
  @Nonnull @CheckReturnValue default CommandCreateAction addSubcommandGroups(@Nonnull Collection<? extends SubcommandGroupData> groups)
  
  Description copied from interface: SlashCommandData
  
  Add up to 25 Subcommand-Groups to this command.
  
  Specified by:
  
  addSubcommandGroups in interface SlashCommandData
  
  Parameters:
  
  groups - The subcommand groups to add
  
  Returns:
  
  The builder instance, for chaining

Interface CommandCreateAction

Method Summary

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

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

Methods inherited from interface net.dv8tion.jda.api.utils.data.SerializableData

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

Method Details

setCheck

addCheck

timeout

Example

deadline

Example

setDefaultEnabled

setName

setDescription

addOptions

addOptions

addOption

addOption

addOption

addSubcommands

addSubcommands

addSubcommandGroups

addSubcommandGroups