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

Class CommandEditActionImpl

java.lang.Object

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

net.dv8tion.jda.internal.requests.restaction.CommandEditActionImpl

All Implemented Interfaces:

RestAction<Command>, CommandEditAction

public class CommandEditActionImpl
extends RestActionImpl<Command>
implements CommandEditAction

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
CommandEditActionImpl(Guild guild, Command.Type type, String id)
CommandEditActionImpl(JDA api, Command.Type type, String id)

Method Summary

Modifier and Type	Method	Description
CommandEditAction	addCheck(BooleanSupplier checks)	Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).
CommandEditAction	addOptions(OptionData... options)	Adds up to 25 options to this command.
CommandEditAction	addSubcommandGroups(SubcommandGroupData... groups)	Add up to 25 Subcommand-Groups to this command.
CommandEditAction	addSubcommands(SubcommandData... subcommands)	Add up to 25 Subcommands to this command.
CommandEditAction	apply(CommandData commandData)	Replace the command with the provided CommandData.
CommandEditAction	clearOptions()	Removes all existing options/subcommands/groups from this command.
CommandEditAction	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
CommandEditAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
CommandEditAction	setContexts(Collection<InteractionContextType> contexts)	Sets the contexts in which this command can be executed (Default: Guild and Bot DMs).
CommandEditAction	setDefaultPermissions(DefaultMemberPermissions permission)	Sets the Permissions that a user must have in a specific channel to be able to use this command.
CommandEditAction	setDescription(String description)	Configure the description
CommandEditAction	setIntegrationTypes(Collection<IntegrationType> integrationTypes)	Sets the integration types on which this command can be installed on (Default: Guilds).
CommandEditAction	setName(String name)	Configure the name
CommandEditAction	setNSFW(boolean nsfw)	Sets whether this command should only be usable in NSFW (age-restricted) channels.
CommandEditAction	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

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.CommandEditAction

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

Constructor Details

CommandEditActionImpl

public CommandEditActionImpl(JDA api,
 Command.Type type,
 String id)

CommandEditActionImpl

public CommandEditActionImpl(Guild guild,
 Command.Type type,
 String id)

Method Details

setCheck

@Nonnull
public CommandEditAction 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 CommandEditAction

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 CommandEditAction 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 CommandEditAction

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)

apply

@Nonnull
public CommandEditAction apply(@Nonnull
 CommandData commandData)

Description copied from interface: CommandEditAction

Replace the command with the provided CommandData.

Specified by:

apply in interface CommandEditAction

Parameters:

commandData - The data for the command

Returns:

The CommandEditAction instance, for chaining

See Also:

• Commands
• CommandCreateAction

addCheck

@Nonnull
public CommandEditAction addCheck(@Nonnull
 BooleanSupplier checks)

Description copied from interface: RestAction

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

Specified by:

addCheck in interface CommandEditAction

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
public CommandEditAction 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 CommandEditAction

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 CommandEditAction setName(@Nullable
 String name)

Description copied from interface: CommandEditAction

Configure the name

Specified by:

setName in interface CommandEditAction

Parameters:

name - The lowercase alphanumeric (with dash) name, 1-32 characters. Use null to keep the current name.

Returns:

The CommandEditAction instance, for chaining

setContexts

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

Description copied from interface: CommandEditAction

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

Specified by:

setContexts in interface CommandEditAction

Parameters:

contexts - The contexts in which this command can be executed

Returns:

The builder instance, for chaining

setIntegrationTypes

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

Description copied from interface: CommandEditAction

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 CommandEditAction

Parameters:

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

Returns:

The builder instance, for chaining

setNSFW

@Nonnull
public CommandEditAction setNSFW(boolean nsfw)

Description copied from interface: CommandEditAction

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 CommandEditAction

Parameters:

nsfw - True, to make this command nsfw

Returns:

The CommandEditAction instance, for chaining

See Also:

• Age-Restricted Commands FAQ

setDefaultPermissions

@Nonnull
public CommandEditAction setDefaultPermissions(@Nonnull
 DefaultMemberPermissions permission)

Description copied from interface: CommandEditAction

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 CommandEditAction

Parameters:

permission - DefaultMemberPermissions representing the default permissions of this command.

Returns:

The CommandEditAction instance, for chaining

See Also:

• DefaultMemberPermissions.ENABLED
• DefaultMemberPermissions.DISABLED

setDescription

@Nonnull
public CommandEditAction setDescription(@Nullable
 String description)

Description copied from interface: CommandEditAction

Configure the description

Specified by:

setDescription in interface CommandEditAction

Parameters:

description - The description, 1-100 characters. Use null to keep the current description.

Returns:

The CommandEditAction instance, for chaining

clearOptions

@Nonnull
public CommandEditAction clearOptions()

Description copied from interface: CommandEditAction

Removes all existing options/subcommands/groups from this command.

Specified by:

clearOptions in interface CommandEditAction

Returns:

The CommandEditAction instance, for chaining

addOptions

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

Description copied from interface: CommandEditAction

Adds up to 25 options to this command.
This will replace any existing options/subcommands/groups on the command.

Required options must be added before non-required options!

Specified by:

addOptions in interface CommandEditAction

Parameters:

options - The Options to add

Returns:

The CommandEditAction instance, for chaining

addSubcommands

@Nonnull
public CommandEditAction addSubcommands(@Nonnull
 SubcommandData... subcommands)

Description copied from interface: CommandEditAction

Add up to 25 Subcommands to this command.
This will replace any existing options/subcommands/groups on the command.

Specified by:

addSubcommands in interface CommandEditAction

Parameters:

subcommands - The subcommands to add

Returns:

The CommandEditAction instance, for chaining

addSubcommandGroups

@Nonnull
public CommandEditAction addSubcommandGroups(@Nonnull
 SubcommandGroupData... groups)

Description copied from interface: CommandEditAction

Add up to 25 Subcommand-Groups to this command.
This will replace any existing options/subcommands/groups on the command.

Specified by:

addSubcommandGroups in interface CommandEditAction

Parameters:

groups - The subcommand groups to add

Returns:

The CommandEditAction instance, for chaining