An interface specifically for slash command options.
Extends
SharedNameAndDescriptionExtends
SharedSlashCommandInherited from SharedSlashCommand
Inherited from SharedSlashCommand
Use setDefaultMemberPermissions or setDMPermission instead.
Deprecated
The description localizations of this command.
Inherited from SharedNameAndDescriptionThe description of this command.
Inherited from SharedNameAndDescriptionUse contexts instead.
Deprecated
Inherited from SharedSlashCommand
The name localizations of this command.
Inherited from SharedNameAndDescriptionThe name of this command.
Inherited from SharedNameAndDescriptionInherited from SharedSlashCommand
Inherited from SharedSlashCommand
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 |
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 |
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 |
Adds an integer option.
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandIntegerOption | ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption) | No | A function that returns an option builder or an already built builder |
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 |
Adds a number option.
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandNumberOption | ((builder: SlashCommandNumberOption) => SlashCommandNumberOption) | No | A function that returns an option builder or an already built builder |
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 |
Adds a string option.
| Name | Type | Optional | Description |
|---|---|---|---|
| input | SlashCommandStringOption | ((builder: SlashCommandStringOption) => SlashCommandStringOption) | No | A function that returns an option builder or an already built builder |
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 |
Sets the contexts of this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| ...contexts | RestOrArray<InteractionContextType> | No | The contexts |
Sets the default permissions a member should have in order to run the command.
Remarks
You can set this to'0' to disable the command by default.| Name | Type | Optional | Description |
|---|---|---|---|
| permissions | Permissions | bigint | number | null | undefined | No | The permissions bit field to set |
Use setDefaultMemberPermissions or setDMPermission instead.
Deprecated
Remarks
If set tofalse, you will have to later PUT the permissions for this command.| Name | Type | Optional | Description |
|---|---|---|---|
| value | boolean | No | Whether or not to enable this command by default |
Sets the description of this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| description | string | No | The description to use |
Sets a description localization for this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| locale | LocaleString | No | The locale to set |
| localizedDescription | string | null | No | The localized description for the given locale |
Sets the description localizations for this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| localizedDescriptions | LocalizationMap | null | No | The object of localized descriptions to set |
Use setContexts instead.
Deprecated
Remarks
By default, commands are visible. This method is only for global commands.| Name | Type | Optional | Description |
|---|---|---|---|
| enabled | boolean | null | undefined | No | Whether the command should be enabled in direct messages |
Sets the integration types of this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| ...integrationTypes | RestOrArray<ApplicationIntegrationType> | No | The integration types |
Sets the name of this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| name | string | No | The name to use |
Sets a name localization for this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| locale | LocaleString | No | The locale to set |
| localizedName | string | null | No | The localized name for the given locale |
Sets the name localizations for this command.
| Name | Type | Optional | Description |
|---|---|---|---|
| localizedNames | LocalizationMap | null | No | The object of localized names to set |
Sets whether this command is NSFW.
| Name | Type | Optional | Description |
|---|---|---|---|
| nsfw | boolean | Yes | Whether this command is NSFW |
Serializes this builder to API-compatible JSON data.
Inherited from SharedSlashCommand