Class SlashCommandSubcommandBuilder

constructor

• new SlashCommandSubcommandBuilder(): SlashCommandSubcommandBuilder

  Returns SlashCommandSubcommandBuilder

Readonlydescription

Optional Readonlydescription_localizations

Readonlyname

Optional Readonlyname_localizations

Readonlyoptions

addAttachmentOption

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

  Adds an attachment option.

  Parameters

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

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

  Returns SlashCommandSubcommandBuilder

addBooleanOption

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

  Adds a boolean option.

  Parameters

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

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

  Returns SlashCommandSubcommandBuilder

addChannelOption

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

  Adds a channel option.

  Parameters

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

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

  Returns SlashCommandSubcommandBuilder

addIntegerOption

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

  Adds an integer option.

  Parameters

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

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

  Returns SlashCommandSubcommandBuilder

addMentionableOption

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

  Adds a mentionable option.

  Parameters

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

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

  Returns SlashCommandSubcommandBuilder

addNumberOption

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

  Adds a number option.

  Parameters

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

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

  Returns SlashCommandSubcommandBuilder

addRoleOption

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

  Adds a role option.

  Parameters

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

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

  Returns SlashCommandSubcommandBuilder

addStringOption

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

  Adds a string option.

  Parameters

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

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

  Returns SlashCommandSubcommandBuilder

addUserOption

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

  Adds a user option.

  Parameters

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

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

  Returns SlashCommandSubcommandBuilder

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

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

toJSON

• toJSON(): APIApplicationCommandSubcommandOption

  Serializes this builder to API-compatible JSON data.

  Returns APIApplicationCommandSubcommandOption

  Remarks

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