Preview environment

class SlashCommandSubcommandBuilder

external
declare class SlashCommandSubcommandBuilder implements ToAPIApplicationCommandOptions

A builder that creates API-compatible JSON data for slash command subcommands.

See also: https://discord.com/developers/docs/interactions/application-commands#subcommands-and-subcommand-groups

readonlyexternal
description : string

The description of this subcommand.

readonlyexternal
name : string

The name of this subcommand.

readonlyexternal
options : ApplicationCommandOptionBase[]

The options within this subcommand.

readonlyoptionalexternal
description_localizations? : LocalizationMap

The description localizations of this command.

Inherited from: SharedNameAndDescription

readonlyoptionalexternal
name_localizations? : LocalizationMap

The name localizations of this command.

Inherited from: SharedNameAndDescription

external
toJSON() : APIApplicationCommandSubcommandOption

Serializes this builder to API-compatible JSON data.

external
addAttachmentOption(
input: SlashCommandAttachmentOption | ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption)
) : TypeAfterAddingOptions

Adds an attachment option.

Inherited from: SharedSlashCommandOptions

external
addBooleanOption(
input: SlashCommandBooleanOption | ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption)
) : TypeAfterAddingOptions

Adds a boolean option.

Inherited from: SharedSlashCommandOptions

external
addChannelOption(
input: SlashCommandChannelOption | ((builder: SlashCommandChannelOption) => SlashCommandChannelOption)
) : TypeAfterAddingOptions

Adds a channel option.

Inherited from: SharedSlashCommandOptions

external
addIntegerOption(
input: SlashCommandIntegerOption | ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption)
) : TypeAfterAddingOptions

Adds an integer option.

Inherited from: SharedSlashCommandOptions

external
addMentionableOption(
input: SlashCommandMentionableOption | ((builder: SlashCommandMentionableOption) => SlashCommandMentionableOption)
) : TypeAfterAddingOptions

Adds a mentionable option.

Inherited from: SharedSlashCommandOptions

external
addNumberOption(
input: SlashCommandNumberOption | ((builder: SlashCommandNumberOption) => SlashCommandNumberOption)
) : TypeAfterAddingOptions

Adds a number option.

Inherited from: SharedSlashCommandOptions

external
addRoleOption(
input: SlashCommandRoleOption | ((builder: SlashCommandRoleOption) => SlashCommandRoleOption)
) : TypeAfterAddingOptions

Adds a role option.

Inherited from: SharedSlashCommandOptions

external
addStringOption(
input: SlashCommandStringOption | ((builder: SlashCommandStringOption) => SlashCommandStringOption)
) : TypeAfterAddingOptions

Adds a string option.

Inherited from: SharedSlashCommandOptions

external
addUserOption(
input: SlashCommandUserOption | ((builder: SlashCommandUserOption) => SlashCommandUserOption)
) : TypeAfterAddingOptions

Adds a user option.

Inherited from: SharedSlashCommandOptions

external
setDescription(
description: string
) : this

Sets the description of this command.

Inherited from: SharedNameAndDescription

external
setDescriptionLocalization(
locale: LocaleString
localizedDescription: string | null
) : this

Sets a description localization for this command.

Inherited from: SharedNameAndDescription

external
setDescriptionLocalizations(
localizedDescriptions: LocalizationMap | null
) : this

Sets the description localizations for this command.

Inherited from: SharedNameAndDescription

external
setName(
name: string
) : this

Sets the name of this command.

Inherited from: SharedNameAndDescription

external
setNameLocalization(
locale: LocaleString
localizedName: string | null
) : this

Sets a name localization for this command.

Inherited from: SharedNameAndDescription

external
setNameLocalizations(
localizedNames: LocalizationMap | null
) : this

Sets the name localizations for this command.

Inherited from: SharedNameAndDescription