Search...

ContextMenuCommandBuilder

export declare class ContextMenuCommandBuilder 
export declare class ContextMenuCommandBuilder 
A builder that creates API-compatible JSON data for context menu commands.
Readonly

default_member_permissions

:

Permissions_2 | null | undefined

The set of permissions represented as a bit set for the command.
Deprecated
Readonly

default_permission

:

boolean | undefined

Whether this command is enabled by default when the application is added to a guild.
Readonly

dm_permission

:

boolean | undefined

Indicates whether the command is available in direct messages with the application.
Remarks
By default, commands are visible. This property is only for global commands.
Readonly
Optional

name_localizations?

:

LocalizationMap

The name localizations of this command.
Readonly

name

:

string

The name of this command.
The type of this command.

setDefaultMemberPermissions(permissions)

:

this

Sets the default permissions a member should have in order to run this command.
Remarks
You can set this to '0' to disable the command by default.
NameTypeOptionalDescription
permissionsPermissions_2 | bigint | number | null | undefinedNoThe permissions bit field to set
Deprecated

setDefaultPermission(value)

:

this

Sets whether the command is enabled by default when the application is added to a guild.
Remarks
If set to false, you will have to later PUT the permissions for this command.
NameTypeOptionalDescription
valuebooleanNoWhether to enable this command by default

setDMPermission(enabled)

:

this

Sets if the command is available in direct messages with the application.
Remarks
By default, commands are visible. This method is only for global commands.
NameTypeOptionalDescription
enabledboolean | null | undefinedNoWhether the command should be enabled in direct messages

setName(name)

:

this

Sets the name of this command.
NameTypeOptionalDescription
namestringNoThe name to use

setNameLocalization(locale, localizedName)

:

this

Sets a name localization for this command.
NameTypeOptionalDescription
localeLocaleStringNoThe locale to set
localizedNamestring | nullNoThe localized name for the given locale

setNameLocalizations(localizedNames)

:

this

Sets the name localizations for this command.
NameTypeOptionalDescription
localizedNamesLocalizationMap | nullNoThe object of localized names to set

setType(type)

:

this

Sets the type of this command.
NameTypeOptionalDescription
typeContextMenuCommandTypeNoThe type to use

toJSON()

:

RESTPostAPIContextMenuApplicationCommandsJSONBody

Serializes this builder to API-compatible JSON data.
Remarks
This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.