Context Menus
Context Menus are application commands which appear on right clicking or tapping a user or a message.
TIP
This page is a follow-up to the interactions (slash commands) page. Please carefully read that section first, so that you can understand the methods used in this section.
Registering context menu commands
To create a context menu you construct a new ContextMenuCommandBuilder
. You can then set the type of the context menu (user or message) using the setType()
method.
const { ContextMenuCommandBuilder } = require('@discordjs/builders');
const data = new ContextMenuCommandBuilder()
.setName('echo')
.setType('USER');
2
3
4
5
Receiving context menu command interactions
Context Menus are received via an interaction. You can check if a given interaction is a context menu by invoking the isContextMenu()
method, you can use the isMessageContextMenu()
and isUserContextMenu()
methods to check for the specific type of context menu interaction:
client.on('interactionCreate', interaction => {
if (!interaction.isUserContextMenu()) return;
console.log(interaction);
});
2
3
4
Extracting data from context menus
You can get the targeted user by accessing the targetUser
or targetMember
property from the UserContextMenuInteraction
open in new window. You can get the message by accessing the targetMessage
property from the MessageContextMenuInteraction
open in new window.
client.on('interactionCreate', interaction => {
if (!interaction.isUserContextMenu()) return;
// Get the User's username from context menu
const name = interaction.targetUser.username;
console.log(name);
});
2
3
4
5
6