Class ContextMenuCommandBuilder

constructor

• new ContextMenuCommandBuilder(): ContextMenuCommandBuilder

• Returns ContextMenuCommandBuilder

Optional Readonly contexts

Readonly default_member_permissions

Readonly default_permission

Readonly dm_permission

Optional Readonly integration_types

Readonly name

Optional Readonly name_localizations

Readonly type

setContexts

• setContexts(...contexts): ContextMenuCommandBuilder

• Sets the contexts of this command.

  Parameters

  • Rest ...contexts: RestOrArray<InteractionContextType>

    The contexts

  Returns ContextMenuCommandBuilder

setDMPermission

• setDMPermission(enabled): ContextMenuCommandBuilder

• 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 ContextMenuCommandBuilder

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

setDefaultMemberPermissions

• setDefaultMemberPermissions(permissions): ContextMenuCommandBuilder

• 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 ContextMenuCommandBuilder

  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): ContextMenuCommandBuilder

• 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 ContextMenuCommandBuilder

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

setIntegrationTypes

• setIntegrationTypes(...integrationTypes): ContextMenuCommandBuilder

• Sets integration types of this command.

  Parameters

  • Rest ...integrationTypes: RestOrArray<ApplicationIntegrationType>

    The integration types

  Returns ContextMenuCommandBuilder

setName

• setName(name): ContextMenuCommandBuilder

• Sets the name of this command.

  Parameters

  • name: string

    The name to use

  Returns ContextMenuCommandBuilder

setNameLocalization

• setNameLocalization(locale, localizedName): ContextMenuCommandBuilder

• 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 ContextMenuCommandBuilder

setNameLocalizations

• setNameLocalizations(localizedNames): ContextMenuCommandBuilder

• Sets the name localizations for this command.

  Parameters

  • localizedNames: null | Partial<Record<"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", null | string>>

    The object of localized names to set

  Returns ContextMenuCommandBuilder

setType

• setType(type): ContextMenuCommandBuilder

• Sets the type of this command.

  Parameters

  • type: ContextMenuCommandType

    The type to use

  Returns ContextMenuCommandBuilder

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.