net.dv8tion.jda.api.requests.restaction.CommandListUpdateAction 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.build.CommandData;
import net.dv8tion.jda.api.interactions.commands.build.Commands;
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.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.function.BooleanSupplier;
/**
* Specialized {@link RestAction} used to replace existing commands of a guild or globally.
*
Any commands that currently exist and are not listed through {@link #addCommands(CommandData...)} will be DELETED!
*
* This operation is idempotent. Commands will persist between restarts of your bot, you only have to create a command once.
*/
public interface CommandListUpdateAction extends RestAction>
{
@Nonnull
@Override
CommandListUpdateAction timeout(long timeout, @Nonnull TimeUnit unit);
@Nonnull
@Override
CommandListUpdateAction deadline(long timestamp);
@Nonnull
@Override
CommandListUpdateAction setCheck(@Nullable BooleanSupplier checks);
@Nonnull
@Override
CommandListUpdateAction addCheck(@Nonnull BooleanSupplier checks);
/**
* Adds up to
* {@value Commands#MAX_SLASH_COMMANDS} slash commands,
* {@value Commands#MAX_USER_COMMANDS} user context commands, and
* {@value Commands#MAX_MESSAGE_COMMANDS} message context commands.
*
* When a command is not listed in this request, it will be deleted.
*
* @param commands
* The {@link CommandData commands} to add
*
* @throws IllegalArgumentException
* If null or more than
* {@value Commands#MAX_SLASH_COMMANDS} slash commands,
* {@value Commands#MAX_USER_COMMANDS} user context commands, or
* {@value Commands#MAX_MESSAGE_COMMANDS} message context commands, are provided
*
* @return The CommandUpdateAction instance, for chaining
*
* @see Commands#slash(String, String) Commands.slash(...)
* @see Commands#message(String) Commands.message(...)
* @see Commands#user(String) Commands.user(...)
*/
@Nonnull
@CheckReturnValue
CommandListUpdateAction addCommands(@Nonnull Collection commands);
/**
* Adds up to
* {@value Commands#MAX_SLASH_COMMANDS} slash commands,
* {@value Commands#MAX_USER_COMMANDS} user context commands, and
* {@value Commands#MAX_MESSAGE_COMMANDS} message context commands.
*
*
When a command is not listed in this request, it will be deleted.
*
* @param commands
* The {@link CommandData commands} to add
*
* @throws IllegalArgumentException
* If null or more than
* {@value Commands#MAX_SLASH_COMMANDS} slash commands,
* {@value Commands#MAX_USER_COMMANDS} user context commands, or
* {@value Commands#MAX_MESSAGE_COMMANDS} message context commands, are provided
*
* @return The CommandUpdateAction instance, for chaining
*
* @see Commands#slash(String, String) Commands.slash(...)
* @see Commands#message(String) Commands.message(...)
* @see Commands#user(String) Commands.user(...)
*/
@Nonnull
@CheckReturnValue
default CommandListUpdateAction addCommands(@Nonnull CommandData... commands)
{
Checks.noneNull(commands, "Command");
return addCommands(Arrays.asList(commands));
}
}