net.dv8tion.jda.api.requests.restaction.CommandEditAction Maven / Gradle / Ivy
Show all versions of JDA Show documentation
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.requests.restaction;
import net.dv8tion.jda.api.interactions.commands.Command;
import net.dv8tion.jda.api.interactions.commands.DefaultMemberPermissions;
import net.dv8tion.jda.api.interactions.commands.OptionType;
import net.dv8tion.jda.api.interactions.commands.build.*;
import net.dv8tion.jda.api.requests.RestAction;
import net.dv8tion.jda.internal.utils.Checks;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Collection;
import java.util.concurrent.TimeUnit;
import java.util.function.BooleanSupplier;
/**
* Specialized {@link RestAction} used to edit an existing command.
*/
public interface CommandEditAction extends RestAction
{
@Nonnull
@Override
@CheckReturnValue
CommandEditAction setCheck(@Nullable BooleanSupplier checks);
@Nonnull
@Override
@CheckReturnValue
CommandEditAction addCheck(@Nonnull BooleanSupplier checks);
@Nonnull
@Override
@CheckReturnValue
CommandEditAction timeout(long timeout, @Nonnull TimeUnit unit);
@Nonnull
@Override
@CheckReturnValue
CommandEditAction deadline(long timestamp);
/**
* Replace the command with the provided {@link CommandData}.
*
* @param commandData
* The data for the command
*
* @throws IllegalArgumentException
* If null is provided
*
* @return The CommandEditAction instance, for chaining
*
* @see Commands
* @see CommandCreateAction
*/
@Nonnull
@CheckReturnValue
CommandEditAction apply(@Nonnull CommandData commandData);
/**
* Configure the name
*
* @param name
* The lowercase alphanumeric (with dash) name, 1-32 characters. Use null to keep the current name.
*
* @throws IllegalArgumentException
* If the name is not alphanumeric or not between 1-32 characters
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
CommandEditAction setName(@Nullable String name);
/**
* Sets whether this command is only usable in a guild (Default: false).
*
This only has an effect if this command is registered globally.
*
* @param guildOnly
* Whether to restrict this command to guilds
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
CommandEditAction setGuildOnly(boolean guildOnly);
/**
* 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.
*
* @param nsfw
* True, to make this command nsfw
*
* @return The CommandEditAction instance, for chaining
*
* @see Age-Restricted Commands FAQ
*/
@Nonnull
@CheckReturnValue
CommandEditAction setNSFW(boolean nsfw);
/**
* Sets the {@link net.dv8tion.jda.api.Permission Permissions} that a user must have in a specific channel to be able to use this command.
*
By default, everyone can use this command ({@link DefaultMemberPermissions#ENABLED}). Additionally, a command can be disabled for everyone but admins via {@link DefaultMemberPermissions#DISABLED}.
*
These configurations can be overwritten by moderators in each guild. See {@link Command#retrievePrivileges(net.dv8tion.jda.api.entities.Guild)} to get moderator defined overrides.
*
* @param permission
* {@link DefaultMemberPermissions} representing the default permissions of this command.
*
* @return The CommandEditAction instance, for chaining
*
* @see DefaultMemberPermissions#ENABLED
* @see DefaultMemberPermissions#DISABLED
*/
@Nonnull
@CheckReturnValue
CommandEditAction setDefaultPermissions(@Nonnull DefaultMemberPermissions permission);
/**
* Configure the description
*
* @param description
* The description, 1-100 characters. Use null to keep the current description.
*
* @throws IllegalArgumentException
* If the name is null or not between 1-100 characters
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
CommandEditAction setDescription(@Nullable String description);
/**
* Removes all existing options/subcommands/groups from this command.
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
CommandEditAction clearOptions();
/**
* 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!
*
* @param options
* The {@link OptionData Options} to add
*
* @throws IllegalArgumentException
*
* - If you try to mix subcommands/options/groups in one command.
* - If the option type is {@link OptionType#SUB_COMMAND} or {@link OptionType#SUB_COMMAND_GROUP}.
* - If this option is required and you already added a non-required option.
* - If more than 25 options are provided.
* - If null is provided
*
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
CommandEditAction addOptions(@Nonnull OptionData... options);
/**
* 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!
*
* @param options
* The {@link OptionData Options} to add
*
* @throws IllegalArgumentException
*
* - If you try to mix subcommands/options/groups in one command.
* - If the option type is {@link OptionType#SUB_COMMAND} or {@link OptionType#SUB_COMMAND_GROUP}.
* - If this option is required and you already added a non-required option.
* - If more than 25 options are provided.
* - If null is provided
*
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
default CommandEditAction addOptions(@Nonnull Collection options)
{
Checks.noneNull(options, "Options");
return addOptions(options.toArray(new OptionData[0]));
}
/**
* Adds an option to this command.
*
This will replace any existing options/subcommands/groups on the command.
*
* Required options must be added before non-required options!
*
* @param type
* The {@link OptionType}
* @param name
* The lowercase option name, 1-32 characters
* @param description
* The option description, 1-100 characters
* @param required
* Whether this option is required (See {@link OptionData#setRequired(boolean)})
*
* @throws IllegalArgumentException
*
* - If you try to mix subcommands/options/groups in one command.
* - If the option type is {@link OptionType#SUB_COMMAND} or {@link OptionType#SUB_COMMAND_GROUP}.
* - If this option is required and you already added a non-required option.
* - If more than 25 options are provided.
* - If null is provided
*
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
default CommandEditAction addOption(@Nonnull OptionType type, @Nonnull String name, @Nonnull String description, boolean required)
{
return addOptions(new OptionData(type, name, description).setRequired(required));
}
/**
* Adds an option to this command.
*
This will replace any existing options/subcommands/groups on the command.
*
* Required options must be added before non-required options!
*
* @param type
* The {@link OptionType}
* @param name
* The lowercase option name, 1-32 characters
* @param description
* The option description, 1-100 characters
*
* @throws IllegalArgumentException
*
* - If you try to mix subcommands/options/groups in one command.
* - If the option type is {@link OptionType#SUB_COMMAND} or {@link OptionType#SUB_COMMAND_GROUP}.
* - If this option is required and you already added a non-required option.
* - If more than 25 options are provided.
* - If null is provided
*
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
default CommandEditAction addOption(@Nonnull OptionType type, @Nonnull String name, @Nonnull String description)
{
return addOption(type, name, description, false);
}
/**
* Add up to 25 {@link SubcommandData Subcommands} to this command.
*
This will replace any existing options/subcommands/groups on the command.
*
* @param subcommands
* The subcommands to add
*
* @throws IllegalArgumentException
* If null is provided, or more than 25 subcommands are provided.
* Also throws if you try to mix subcommands/options/groups in one command.
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
CommandEditAction addSubcommands(@Nonnull SubcommandData... subcommands);
/**
* Add up to 25 {@link SubcommandData Subcommands} to this command.
*
This will replace any existing options/subcommands/groups on the command.
*
* @param subcommands
* The subcommands to add
*
* @throws IllegalArgumentException
* If null is provided, or more than 25 subcommands are provided.
* Also throws if you try to mix subcommands/options/groups in one command.
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
default CommandEditAction addSubcommands(@Nonnull Collection subcommands)
{
Checks.noneNull(subcommands, "Subcommands");
return addSubcommands(subcommands.toArray(new SubcommandData[0]));
}
/**
* Add up to 25 {@link SubcommandGroupData Subcommand-Groups} to this command.
*
This will replace any existing options/subcommands/groups on the command.
*
* @param groups
* The subcommand groups to add
*
* @throws IllegalArgumentException
* If null is provided, or more than 25 subcommand groups are provided.
* Also throws if you try to mix subcommands/options/groups in one command.
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
CommandEditAction addSubcommandGroups(@Nonnull SubcommandGroupData... groups);
/**
* Add up to 25 {@link SubcommandGroupData Subcommand-Groups} to this command.
*
This will replace any existing options/subcommands/groups on the command.
*
* @param groups
* The subcommand groups to add
*
* @throws IllegalArgumentException
* If null is provided, or more than 25 subcommand groups are provided.
* Also throws if you try to mix subcommands/options/groups in one command.
*
* @return The CommandEditAction instance, for chaining
*/
@Nonnull
@CheckReturnValue
default CommandEditAction addSubcommandGroups(@Nonnull Collection groups)
{
Checks.noneNull(groups, "SubcommandGroups");
return addSubcommandGroups(groups.toArray(new SubcommandGroupData[0]));
}
}