ContextMenuCommandBuilder

export declare class ContextMenuCommandBuilder
export declare class ContextMenuCommandBuilder

No summary provided.

Readonly
default_member_permissions:Permissions | null | undefined
Set of permissions represented as a bit set for the command
DeprecatedReadonly
default_permission:boolean | undefined
This property is deprecated and will be removed in the future. You should use setDefaultMemberPermissions or setDMPermission instead.
Deprecated
Whether the command is enabled by default when the app is added to a guild
Readonly
dm_permission:boolean | undefined
Indicates whether the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.
Readonly
name_localizations?:LocalizationMap
The localized names for this command
Readonly
name:string
The name of this context menu command
The type of this context menu command
setDefaultMemberPermissions(permissions):this
Sets the default permissions a member should have in order to run the command.
Remarks
You can set this to '0' to disable the command by default.
See Also
https://discord.com/developers/docs/interactions/application-commands#permissions
NameTypeOptionalDescription
permissionsPermissions | 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.
See Also
https://discord.com/developers/docs/interactions/application-commands#permissions
NameTypeOptionalDescription
valuebooleanNoWhether or not to enable this command by default
setDMPermission(enabled):this
Sets if the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.
See Also
https://discord.com/developers/docs/interactions/application-commands#permissions
NameTypeOptionalDescription
enabledboolean | null | undefinedNoIf the command should be enabled in DMs
setName(name):this
Sets the name
NameTypeOptionalDescription
namestringNoThe name
setNameLocalization(locale, localizedName):this
Sets a name localization
NameTypeOptionalDescription
localeLocaleStringNoThe locale to set a description for
localizedNamestring | nullNoThe localized description for the given locale
setNameLocalizations(localizedNames):this
Sets the name localizations
NameTypeOptionalDescription
localizedNamesLocalizationMap | nullNoThe dictionary of localized descriptions to set
setType(type):this
Sets the type
NameTypeOptionalDescription
typeContextMenuCommandTypeNoThe type
Returns the final data that should be sent to Discord.
Remarks
This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.