SlashCommandBuilder
export declare class SlashCommandBuilder export declare class SlashCommandBuilder No summary provided.
Readonly
default_member_permissions
:
Permissions | null | undefined
Set of permissions represented as a bit set for the command
Deprecated
Readonly
default_permission
:
boolean | undefined
This property is deprecated and will be removed in the future. You should use setDefaultMemberPermissions or setDMPermission instead.
Deprecated
Readonly
Optional
description_localizations?
:
LocalizationMap
The localized descriptions for this command
Readonly
description
:
string
The description of this slash command
Readonly
dm_permission
:
boolean | undefined
Indicates whether the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.
Readonly
Optional
name_localizations?
:
LocalizationMap
The localized names for this command
Readonly
name
:
string
The name of this slash command
Readonly
The options of this slash command
Adds a new subcommand to this command
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandSubcommandBuilder | ((subcommandGroup: SlashCommandSubcommandBuilder) => SlashCommandSubcommandBuilder) | No | A function that returns a subcommand builder, or an already built builder |
Adds a new subcommand group to this command
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandSubcommandGroupBuilder | ((subcommandGroup: SlashCommandSubcommandGroupBuilder) => SlashCommandSubcommandGroupBuilder) | No | A function that returns a subcommand group builder, or an already built builder |
setDefaultMemberPermissions(permissions)
:
this
Sets the default permissions a member should have in order to run the command.**Note:** You can set this to
'0' to disable the command by default.See Also
https://discord.com/developers/docs/interactions/application-commands#permissions| Name | Type | Optional | Description |
|---|---|---|---|
| permissions | Permissions | bigint | number | null | undefined | No | The permissions bit field to set |
Deprecated
setDefaultPermission(value)
:
this
Use setDefaultMemberPermissions or setDMPermission instead.
Deprecated
false, you will have to later PUT the permissions for this command.See Also
https://discord.com/developers/docs/interactions/application-commands#permissions| Name | Type | Optional | Description |
|---|---|---|---|
| value | boolean | No | Whether or not to enable this command by default |
setDMPermission(enabled)
:
this
Sets if the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.
See Also
https://discord.com/developers/docs/interactions/application-commands#permissions| Name | Type | Optional | Description |
|---|---|---|---|
| enabled | boolean | null | undefined | No | If the command should be enabled in DMs |
toJSON()
:
RESTPostAPIApplicationCommandsJSONBody
Returns the final data that should be sent to Discord.**Note:** Calling this function will validate required properties based on their conditions.
addAttachmentOption(input)
:
ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this
Adds an attachment option
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandAttachmentOption | ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption) | No | A function that returns an option builder, or an already built builder |
addBooleanOption(input)
:
ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this
Adds a boolean option
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandBooleanOption | ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption) | No | A function that returns an option builder, or an already built builder |
addChannelOption(input)
:
ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this
Adds a channel option
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandChannelOption | ((builder: SlashCommandChannelOption) => SlashCommandChannelOption) | No | A function that returns an option builder, or an already built builder |
addIntegerOption(input)
:
ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this
Adds an integer option
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandIntegerOption | Omit<SlashCommandIntegerOption, 'setAutocomplete'> | Omit<SlashCommandIntegerOption, 'addChoices'> | ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption | Omit<SlashCommandIntegerOption, 'setAutocomplete'> | Omit<SlashCommandIntegerOption, 'addChoices'>) | No | A function that returns an option builder, or an already built builder |
addMentionableOption(input)
:
ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this
Adds a mentionable option
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandMentionableOption | ((builder: SlashCommandMentionableOption) => SlashCommandMentionableOption) | No | A function that returns an option builder, or an already built builder |
addNumberOption(input)
:
ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this
Adds a number option
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandNumberOption | Omit<SlashCommandNumberOption, 'setAutocomplete'> | Omit<SlashCommandNumberOption, 'addChoices'> | ((builder: SlashCommandNumberOption) => SlashCommandNumberOption | Omit<SlashCommandNumberOption, 'setAutocomplete'> | Omit<SlashCommandNumberOption, 'addChoices'>) | No | A function that returns an option builder, or an already built builder |
addRoleOption(input)
:
ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this
Adds a role option
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandRoleOption | ((builder: SlashCommandRoleOption) => SlashCommandRoleOption) | No | A function that returns an option builder, or an already built builder |
addStringOption(input)
:
ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this
Adds a string option
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandStringOption | Omit<SlashCommandStringOption, 'setAutocomplete'> | Omit<SlashCommandStringOption, 'addChoices'> | ((builder: SlashCommandStringOption) => SlashCommandStringOption | Omit<SlashCommandStringOption, 'setAutocomplete'> | Omit<SlashCommandStringOption, 'addChoices'>) | No | A function that returns an option builder, or an already built builder |
addUserOption(input)
:
ShouldOmitSubcommandFunctions extends true ? Omit<this, "addSubcommand" | "addSubcommandGroup"> : this
Adds a user option
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandUserOption | ((builder: SlashCommandUserOption) => SlashCommandUserOption) | No | A function that returns an option builder, or an already built builder |
setDescription(description)
:
this
Sets the description
| Name | Type | Optional | Description |
|---|---|---|---|
| description | string | No | The description |
setDescriptionLocalization(locale, localizedDescription)
:
this
Sets a description localization
| Name | Type | Optional | Description |
|---|---|---|---|
| locale | LocaleString | No | The locale to set a description for |
| localizedDescription | string | null | No | The localized description for the given locale |
setDescriptionLocalizations(localizedDescriptions)
:
this
Sets the description localizations
| Name | Type | Optional | Description |
|---|---|---|---|
| localizedDescriptions | LocalizationMap | null | No | The dictionary of localized descriptions to set |
setName(name)
:
this
setNameLocalization(locale, localizedName)
:
this
Sets a name localization
| Name | Type | Optional | Description |
|---|---|---|---|
| locale | LocaleString | No | The locale to set a description for |
| localizedName | string | null | No | The localized description for the given locale |
setNameLocalizations(localizedNames)
:
this
Sets the name localizations
| Name | Type | Optional | Description |
|---|---|---|---|
| localizedNames | LocalizationMap | null | No | The dictionary of localized descriptions to set |