class ChatInputCommandBuilder

extends

ChatInputCommandBuilder_base
export declare class ChatInputCommandBuilder extends ChatInputCommandBuilder_base

A builder that creates API-compatible JSON data for chat input commands.

protectedreadonly
data : CommandData

Inherited from: CommandBuilder

readonly
options : readonly ApplicationCommandOptionBase[]

Inherited from: SharedChatInputCommandOptions

addAttachmentOptions(
...options: RestOrArray<ChatInputCommandAttachmentOption | ((builder: ChatInputCommandAttachmentOption) => ChatInputCommandAttachmentOption)>
) : this

Adds attachment options.

Inherited from: SharedChatInputCommandOptions

addBooleanOptions(
...options: RestOrArray<ChatInputCommandBooleanOption | ((builder: ChatInputCommandBooleanOption) => ChatInputCommandBooleanOption)>
) : this

Adds boolean options.

Inherited from: SharedChatInputCommandOptions

addChannelOptions(
...options: RestOrArray<ChatInputCommandChannelOption | ((builder: ChatInputCommandChannelOption) => ChatInputCommandChannelOption)>
) : this

Adds channel options.

Inherited from: SharedChatInputCommandOptions

addIntegerOptions(
...options: RestOrArray<ChatInputCommandIntegerOption | ((builder: ChatInputCommandIntegerOption) => ChatInputCommandIntegerOption)>
) : this

Adds integer options.

Inherited from: SharedChatInputCommandOptions

addMentionableOptions(
...options: RestOrArray<ChatInputCommandMentionableOption | ((builder: ChatInputCommandMentionableOption) => ChatInputCommandMentionableOption)>
) : this

Adds mentionable options.

Inherited from: SharedChatInputCommandOptions

addNumberOptions(
...options: RestOrArray<ChatInputCommandNumberOption | ((builder: ChatInputCommandNumberOption) => ChatInputCommandNumberOption)>
) : this

Adds number options.

Inherited from: SharedChatInputCommandOptions

addRoleOptions(
...options: RestOrArray<ChatInputCommandRoleOption | ((builder: ChatInputCommandRoleOption) => ChatInputCommandRoleOption)>
) : this

Adds role options.

Inherited from: SharedChatInputCommandOptions

addStringOptions(
...options: RestOrArray<ChatInputCommandStringOption | ((builder: ChatInputCommandStringOption) => ChatInputCommandStringOption)>
) : this

Adds string options.

Inherited from: SharedChatInputCommandOptions

addSubcommandGroups(
...input: RestOrArray<ChatInputCommandSubcommandGroupBuilder | ((subcommandGroup: ChatInputCommandSubcommandGroupBuilder) => ChatInputCommandSubcommandGroupBuilder)>
) : this

Adds subcommand groups to this command.

Inherited from: SharedChatInputCommandSubcommands

addSubcommands(
...input: RestOrArray<ChatInputCommandSubcommandBuilder | ((subcommandGroup: ChatInputCommandSubcommandBuilder) => ChatInputCommandSubcommandBuilder)>
) : this

Adds subcommands to this command.

Inherited from: SharedChatInputCommandSubcommands

addUserOptions(
...options: RestOrArray<ChatInputCommandUserOption | ((builder: ChatInputCommandUserOption) => ChatInputCommandUserOption)>
) : this

Adds user options.

Inherited from: SharedChatInputCommandOptions

clearDefaultMemberPermissions() : this

Clears the default permissions a member should have in order to run the command.

Inherited from: CommandBuilder

clearDescriptionLocalization(
locale: LocaleString
) : this

Clears a description localization for this command.

Inherited from: SharedNameAndDescription

clearDescriptionLocalizations() : this

Clears all description localizations for this command.

Inherited from: SharedNameAndDescription

clearNameLocalization(
locale: LocaleString
) : this

Clears a name localization for this command.

Inherited from: SharedName

clearNameLocalizations() : this

Clears all name localizations for this command.

Inherited from: SharedName

setContexts(
...contexts: RestOrArray<InteractionContextType>
) : this

Sets the contexts of this command.

Inherited from: CommandBuilder

setDefaultMemberPermissions(
permissions: Permissions | bigint | number
) : this

Sets the default permissions a member should have in order to run the command.

Inherited from: CommandBuilder

See also: https://discord.com/developers/docs/interactions/application-commands#permissions

setDescription(
description: string
) : this

Sets the description of this command.

Inherited from: SharedNameAndDescription

setDescriptionLocalization(
locale: LocaleString
localizedDescription: string
) : this

Sets a description localization for this command.

Inherited from: SharedNameAndDescription

setDescriptionLocalizations(
localizedDescriptions: Partial<Record<LocaleString, string>>
) : this

Sets the description localizations for this command.

Inherited from: SharedNameAndDescription

setIntegrationTypes(
...integrationTypes: RestOrArray<ApplicationIntegrationType>
) : this

Sets the integration types of this command.

Inherited from: CommandBuilder

setName(
name: string
) : this

Sets the name of this command.

Inherited from: SharedName

setNameLocalization(
locale: LocaleString
localizedName: string
) : this

Sets a name localization for this command.

Inherited from: SharedName

setNameLocalizations(
localizedNames: Partial<Record<LocaleString, string>>
) : this

Sets the name localizations for this command.

Inherited from: SharedName

setNSFW(
nsfw?: boolean
) : this

Sets whether this command is NSFW.

Inherited from: CommandBuilder

spliceOptions(
index: number
deleteCount: number
...options: ApplicationCommandOptionBase[]
) : this

Removes, replaces, or inserts options for this command.

Examples:Remove the first option:
actionRow.spliceOptions(0, 1);
Remove the first n options:
const n = 4;
actionRow.spliceOptions(0, n);
Remove the last option:
actionRow.spliceOptions(-1, 1);

Inherited from: SharedChatInputCommandOptions

toJSON(
validationOverride?: boolean
) : RESTPostAPIChatInputApplicationCommandsJSONBody

Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.