Class SlashCommandBuilder

constructor

• new SlashCommandBuilder(): SlashCommandBuilder

  Returns SlashCommandBuilder

Optional Readonlycontexts

Readonlydefault_member_permissions

Readonlydefault_permission

Readonlydescription

Optional Readonlydescription_localizations

Readonlydm_permission

Optional Readonlyintegration_types

Readonlyname

Optional Readonlyname_localizations

Readonlynsfw

Readonlyoptions

addAttachmentOption

• addAttachmentOption(
      input:
          | SlashCommandAttachmentOption
          | (
              (
                  builder: SlashCommandAttachmentOption,
              ) => SlashCommandAttachmentOption
          ),
  ): SlashCommandOptionsOnlyBuilder

  Adds an attachment option.

  Parameters

  • input:
        | SlashCommandAttachmentOption
        | ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption)

    A function that returns an option builder or an already built builder

  Returns SlashCommandOptionsOnlyBuilder

addBooleanOption

• addBooleanOption(
      input:
          | SlashCommandBooleanOption
          | ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption),
  ): SlashCommandOptionsOnlyBuilder

  Adds a boolean option.

  Parameters

  • input:
        | SlashCommandBooleanOption
        | ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption)

    A function that returns an option builder or an already built builder

  Returns SlashCommandOptionsOnlyBuilder

addChannelOption

• addChannelOption(
      input:
          | SlashCommandChannelOption
          | ((builder: SlashCommandChannelOption) => SlashCommandChannelOption),
  ): SlashCommandOptionsOnlyBuilder

  Adds a channel option.

  Parameters

  • input:
        | SlashCommandChannelOption
        | ((builder: SlashCommandChannelOption) => SlashCommandChannelOption)

    A function that returns an option builder or an already built builder

  Returns SlashCommandOptionsOnlyBuilder

addIntegerOption

• addIntegerOption(
      input:
          | SlashCommandIntegerOption
          | ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption),
  ): SlashCommandOptionsOnlyBuilder

  Adds an integer option.

  Parameters

  • input:
        | SlashCommandIntegerOption
        | ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption)

    A function that returns an option builder or an already built builder

  Returns SlashCommandOptionsOnlyBuilder

addMentionableOption

• addMentionableOption(
      input:
          | SlashCommandMentionableOption
          | (
              (
                  builder: SlashCommandMentionableOption,
              ) => SlashCommandMentionableOption
          ),
  ): SlashCommandOptionsOnlyBuilder

  Adds a mentionable option.

  Parameters

  • input:
        | SlashCommandMentionableOption
        | (
            (
                builder: SlashCommandMentionableOption,
            ) => SlashCommandMentionableOption
        )

    A function that returns an option builder or an already built builder

  Returns SlashCommandOptionsOnlyBuilder

addNumberOption

• addNumberOption(
      input:
          | SlashCommandNumberOption
          | ((builder: SlashCommandNumberOption) => SlashCommandNumberOption),
  ): SlashCommandOptionsOnlyBuilder

  Adds a number option.

  Parameters

  • input:
        | SlashCommandNumberOption
        | ((builder: SlashCommandNumberOption) => SlashCommandNumberOption)

    A function that returns an option builder or an already built builder

  Returns SlashCommandOptionsOnlyBuilder

addRoleOption

• addRoleOption(
      input:
          | SlashCommandRoleOption
          | ((builder: SlashCommandRoleOption) => SlashCommandRoleOption),
  ): SlashCommandOptionsOnlyBuilder

  Adds a role option.

  Parameters

  • input:
        | SlashCommandRoleOption
        | ((builder: SlashCommandRoleOption) => SlashCommandRoleOption)

    A function that returns an option builder or an already built builder

  Returns SlashCommandOptionsOnlyBuilder

addStringOption

• addStringOption(
      input:
          | SlashCommandStringOption
          | ((builder: SlashCommandStringOption) => SlashCommandStringOption),
  ): SlashCommandOptionsOnlyBuilder

  Adds a string option.

  Parameters

  • input:
        | SlashCommandStringOption
        | ((builder: SlashCommandStringOption) => SlashCommandStringOption)

    A function that returns an option builder or an already built builder

  Returns SlashCommandOptionsOnlyBuilder

addSubcommand

• addSubcommand(
      input:
          | SlashCommandSubcommandBuilder
          | (
              (
                  subcommandGroup: SlashCommandSubcommandBuilder,
              ) => SlashCommandSubcommandBuilder
          ),
  ): SlashCommandSubcommandsOnlyBuilder

  Adds a new subcommand to this command.

  Parameters

  • input:
        | SlashCommandSubcommandBuilder
        | (
            (
                subcommandGroup: SlashCommandSubcommandBuilder,
            ) => SlashCommandSubcommandBuilder
        )

    A function that returns a subcommand builder or an already built builder

  Returns SlashCommandSubcommandsOnlyBuilder

addSubcommandGroup

• addSubcommandGroup(
      input:
          | SlashCommandSubcommandGroupBuilder
          | (
              (
                  subcommandGroup: SlashCommandSubcommandGroupBuilder,
              ) => SlashCommandSubcommandGroupBuilder
          ),
  ): SlashCommandSubcommandsOnlyBuilder

  Adds a new subcommand group to this command.

  Parameters

  • input:
        | SlashCommandSubcommandGroupBuilder
        | (
            (
                subcommandGroup: SlashCommandSubcommandGroupBuilder,
            ) => SlashCommandSubcommandGroupBuilder
        )

    A function that returns a subcommand group builder or an already built builder

  Returns SlashCommandSubcommandsOnlyBuilder

addUserOption

• addUserOption(
      input:
          | SlashCommandUserOption
          | ((builder: SlashCommandUserOption) => SlashCommandUserOption),
  ): SlashCommandOptionsOnlyBuilder

  Adds a user option.

  Parameters

  • input:
        | SlashCommandUserOption
        | ((builder: SlashCommandUserOption) => SlashCommandUserOption)

    A function that returns an option builder or an already built builder

  Returns SlashCommandOptionsOnlyBuilder

setContexts

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

  Sets the contexts of this command.

  Parameters

  • ...contexts: RestOrArray<InteractionContextType>

    The contexts

  Returns this

setDefaultMemberPermissions

• setDefaultMemberPermissions(
      permissions: undefined | null | string | number | bigint,
  ): this

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

  Parameters

  • permissions: undefined | null | string | number | bigint

    The permissions bit field to set

  Returns this

  Remarks

  You can set this to '0' to disable the command by default.

  See

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

setDefaultPermission

• setDefaultPermission(value: boolean): this

  Sets whether the command is enabled by default when the application is added to a guild.

  Parameters

  • value: boolean

    Whether or not to enable this command by default

  Returns this

  Remarks

  If set to false, you will have to later PUT the permissions for this command.

  See

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

  Deprecated

  Use SharedSlashCommand.setDefaultMemberPermissions or SharedSlashCommand.setDMPermission instead.

setDescription

• setDescription(description: string): this

  Sets the description of this command.

  Parameters

  • description: string

    The description to use

  Returns this

setDescriptionLocalization

• setDescriptionLocalization(
      locale:
          | "id"
          | "en-US"
          | "en-GB"
          | "bg"
          | "zh-CN"
          | "zh-TW"
          | "hr"
          | "cs"
          | "da"
          | "nl"
          | "fi"
          | "fr"
          | "de"
          | "el"
          | "hi"
          | "hu"
          | "it"
          | "ja"
          | "ko"
          | "lt"
          | "no"
          | "pl"
          | "pt-BR"
          | "ro"
          | "ru"
          | "es-ES"
          | "es-419"
          | "sv-SE"
          | "th"
          | "tr"
          | "uk"
          | "vi",
      localizedDescription: null | string,
  ): this

  Sets a description localization for this command.

  Parameters

  • locale:
        | "id"
        | "en-US"
        | "en-GB"
        | "bg"
        | "zh-CN"
        | "zh-TW"
        | "hr"
        | "cs"
        | "da"
        | "nl"
        | "fi"
        | "fr"
        | "de"
        | "el"
        | "hi"
        | "hu"
        | "it"
        | "ja"
        | "ko"
        | "lt"
        | "no"
        | "pl"
        | "pt-BR"
        | "ro"
        | "ru"
        | "es-ES"
        | "es-419"
        | "sv-SE"
        | "th"
        | "tr"
        | "uk"
        | "vi"

    The locale to set

  • localizedDescription: null | string

    The localized description for the given locale

  Returns this

setDescriptionLocalizations

• setDescriptionLocalizations(
      localizedDescriptions: null | Partial<Record<Locale, null | string>>,
  ): this

  Sets the description localizations for this command.

  Parameters

  • localizedDescriptions: null | Partial<Record<Locale, null | string>>

    The object of localized descriptions to set

  Returns this

setDMPermission

• setDMPermission(enabled: undefined | null | boolean): this

  Sets if the command is available in direct messages with the application.

  Parameters

  • enabled: undefined | null | boolean

    Whether the command should be enabled in direct messages

  Returns this

  Remarks

  By default, commands are visible. This method is only for global commands.

  See

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

  Deprecated

  Use SharedSlashCommand.setContexts instead.

setIntegrationTypes

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

  Sets the integration types of this command.

  Parameters

  • ...integrationTypes: RestOrArray<ApplicationIntegrationType>

    The integration types

  Returns this

setName

• setName(name: string): this

  Sets the name of this command.

  Parameters

  • name: string

    The name to use

  Returns this

setNameLocalization

• setNameLocalization(
      locale:
          | "id"
          | "en-US"
          | "en-GB"
          | "bg"
          | "zh-CN"
          | "zh-TW"
          | "hr"
          | "cs"
          | "da"
          | "nl"
          | "fi"
          | "fr"
          | "de"
          | "el"
          | "hi"
          | "hu"
          | "it"
          | "ja"
          | "ko"
          | "lt"
          | "no"
          | "pl"
          | "pt-BR"
          | "ro"
          | "ru"
          | "es-ES"
          | "es-419"
          | "sv-SE"
          | "th"
          | "tr"
          | "uk"
          | "vi",
      localizedName: null | string,
  ): this

  Sets a name localization for this command.

  Parameters

  • locale:
        | "id"
        | "en-US"
        | "en-GB"
        | "bg"
        | "zh-CN"
        | "zh-TW"
        | "hr"
        | "cs"
        | "da"
        | "nl"
        | "fi"
        | "fr"
        | "de"
        | "el"
        | "hi"
        | "hu"
        | "it"
        | "ja"
        | "ko"
        | "lt"
        | "no"
        | "pl"
        | "pt-BR"
        | "ro"
        | "ru"
        | "es-ES"
        | "es-419"
        | "sv-SE"
        | "th"
        | "tr"
        | "uk"
        | "vi"

    The locale to set

  • localizedName: null | string

    The localized name for the given locale

  Returns this

setNameLocalizations

• setNameLocalizations(
      localizedNames: null | Partial<Record<Locale, null | string>>,
  ): this

  Sets the name localizations for this command.

  Parameters

  • localizedNames: null | Partial<Record<Locale, null | string>>

    The object of localized names to set

  Returns this

setNSFW

• setNSFW(nsfw?: boolean): this

  Sets whether this command is NSFW.

  Parameters

  • Optionalnsfw: boolean

    Whether this command is NSFW

  Returns this

toJSON

• toJSON(): RESTPostAPIChatInputApplicationCommandsJSONBody

  Serializes this builder to API-compatible JSON data.

  Returns RESTPostAPIChatInputApplicationCommandsJSONBody

  Remarks

  This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.