Package org.javacord.api.interaction

Class SlashCommandBuilder

java.lang.Object

org.javacord.api.interaction.SlashCommandBuilder

public class SlashCommandBuilder
extends Object

This class is used to create new slash commands.

Constructor Summary

Constructors

Constructor	Description
SlashCommandBuilder()	Creates a new slash command builder.

Method Summary

Modifier and Type	Method	Description
SlashCommandBuilder	addOption(SlashCommandOption option)	Adds an slash command option to the slash command.
CompletableFuture<SlashCommand>	createForServer(Server server)	Creates an slash command for a specific server.
CompletableFuture<SlashCommand>	createGlobal(DiscordApi api)	Creates a global slash command.
SlashCommandBuilderDelegate	getDelegate()	Gets the delegate used by the slash command builder internally.
SlashCommandBuilder	setDefaultPermission(Boolean defaultPermission)	Sets the default permission for the slash command whether the command is enabled by default when the app is added to a server.
SlashCommandBuilder	setDescription(String description)	Sets the description of the slash command.
SlashCommandBuilder	setName(String name)	Sets the name of the slash command.
SlashCommandBuilder	setOptions(List<SlashCommandOption> options)	Sets the slash commands for the slash command.

Methods inherited from class java.lang.Object

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

Constructor Detail

SlashCommandBuilder

public SlashCommandBuilder()

Creates a new slash command builder.

Method Detail

setName

public SlashCommandBuilder setName(String name)

Sets the name of the slash command.

Parameters:

name - The name.

Returns:

The current instance in order to chain call methods.

setDescription

public SlashCommandBuilder setDescription(String description)

Sets the description of the slash command.

Parameters:

description - The name.

Returns:

The current instance in order to chain call methods.

addOption

public SlashCommandBuilder addOption(SlashCommandOption option)

Adds an slash command option to the slash command.

Parameters:

option - The option.

Returns:

The current instance in order to chain call methods.

setOptions

public SlashCommandBuilder setOptions(List<SlashCommandOption> options)

Sets the slash commands for the slash command.

Parameters:

options - The options.

Returns:

The current instance in order to chain call methods.

setDefaultPermission

public SlashCommandBuilder setDefaultPermission(Boolean defaultPermission)

Sets the default permission for the slash command whether the command is enabled by default when the app is added to a server.

Parameters:

defaultPermission - The default permission.

Returns:

The current instance in order to chain call methods.

createGlobal

public CompletableFuture<SlashCommand> createGlobal(DiscordApi api)

Creates a global slash command. When used to update multiple global slash commands at once DiscordApi.bulkOverwriteGlobalSlashCommands(List) should be used instead.

Parameters:

api - The discord api instance.

Returns:

The built slash command.

createForServer

public CompletableFuture<SlashCommand> createForServer(Server server)

Creates an slash command for a specific server. When used to create multiple server slash commands at once DiscordApi.bulkOverwriteServerSlashCommands(Server, List) (List)} should be used instead.

Parameters:

server - The server.

Returns:

The built slash command.

getDelegate

public SlashCommandBuilderDelegate getDelegate()

Gets the delegate used by the slash command builder internally.

Returns:

The delegate used by this slash command builder internally.