Class ContextMenuCommandBuilder

constructor

• new ContextMenuCommandBuilder(): ContextMenuCommandBuilder

  Returns ContextMenuCommandBuilder

Optional Readonlycontexts

Readonlydefault_member_permissions

Readonlydefault_permission

Readonlydm_permission

Optional Readonlyintegration_types

Readonlyname

Optional Readonlyname_localizations

Readonlytype

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 this 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 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 ContextMenuCommandBuilder.setDefaultMemberPermissions or ContextMenuCommandBuilder.setDMPermission instead.

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 ContextMenuCommandBuilder.setContexts instead.

setIntegrationTypes

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

  Sets 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

setType

• setType(type: ContextMenuCommandType): this

  Sets the type of this command.

  Parameters

  • type: ContextMenuCommandType

    The type to use

  Returns this

toJSON

• toJSON(): RESTPostAPIContextMenuApplicationCommandsJSONBody

  Serializes this builder to API-compatible JSON data.

  Returns RESTPostAPIContextMenuApplicationCommandsJSONBody

  Remarks

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