ContextMenuCommandBuilder

export declare class ContextMenuCommandBuilder 
export declare class ContextMenuCommandBuilder
A builder that creates API-compatible JSON data for context menu commands.
Readonly
contexts?:InteractionContextType[]
The contexts for this command.
Readonly
default_member_permissions:Permissions | null | undefined
The set of permissions represented as a bit set for the command.
DeprecatedReadonly
default_permission:boolean | undefined
Use setDefaultMemberPermissions or setDMPermission instead.
Deprecated
Whether this command is enabled by default when the application is added to a guild.
DeprecatedReadonly
dm_permission:boolean | undefined
Use contexts instead.
Deprecated
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
integration_types?:ApplicationIntegrationType[]
The integration types for this command.
Readonly
name_localizations?:LocalizationMap
The name localizations of this command.
Readonly
name:string
The name of this command.
Readonly
type:ContextMenuCommandType
The type of this command.
setContexts(...contexts):this
Sets the contexts of this command.
NameTypeOptionalDescription
...contextsRestOrArray<InteractionContextType>NoThe contexts
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.
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
Use setDefaultMemberPermissions or setDMPermission instead.
Deprecated
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 to enable this command by default
Deprecated
setDMPermission(enabled):this
Use setContexts instead.
Deprecated
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.
See Also
https://discord.com/developers/docs/interactions/application-commands#permissions
NameTypeOptionalDescription
enabledboolean | null | undefinedNoWhether the command should be enabled in direct messages
setIntegrationTypes(...integrationTypes):this
Sets integration types of this command.
NameTypeOptionalDescription
...integrationTypesRestOrArray<ApplicationIntegrationType>NoThe integration types
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
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.