MessageContextMenu

java.lang.Object

com.jagrosh.jdautilities.command.Interaction

com.jagrosh.jdautilities.command.ContextMenu

com.jagrosh.jdautilities.command.MessageContextMenu

public abstract class MessageContextMenu extends ContextMenu

Field Summary

Fields inherited from class com.jagrosh.jdautilities.command.ContextMenu
name, nameLocalization

Fields inherited from class com.jagrosh.jdautilities.command.Interaction
botMissingPermMessage, botPermissions, cooldown, cooldownScope, guildOnly, nsfwOnly, ownerCommand, userMissingPermMessage, userPermissions
Constructor Summary

Constructors

Constructor

Description

MessageContextMenu()
Method Summary

Modifier and Type

Method

Description

net.dv8tion.jda.api.interactions.commands.build.CommandData

buildCommandData()

Builds CommandData for the ContextMenu upsert.

protected abstract void

execute(MessageContextMenuEvent event)

The main body method of a MessageContextMenu.

final void

run(MessageContextMenuEvent event)

Runs checks for the MessageContextMenu with the given MessageContextMenuEvent that called it.

Methods inherited from class com.jagrosh.jdautilities.command.ContextMenu
getCooldownError, getCooldownKey, getName, getNameLocalization, getType

Methods inherited from class com.jagrosh.jdautilities.command.Interaction
getBotPermissions, getCooldown, getCooldownScope, getUserPermissions, isOwnerCommand

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- MessageContextMenu
  
  public MessageContextMenu()
Method Details
- run
  
  public final void run(MessageContextMenuEvent event)
  
  Runs checks for the MessageContextMenu with the given MessageContextMenuEvent that called it.
  Will terminate, and possibly respond with a failure message, if any checks fail.
  
  Parameters:
  
  event - The MessageContextMenuEvent that triggered this menu
- execute
  
  protected abstract void execute(MessageContextMenuEvent event)
  
  The main body method of a MessageContextMenu.
  This is the "response" for a successful run(MessageContextMenuEvent)
  
  Parameters:
  
  event - The MessageContextMenuEvent that triggered this menu.
- buildCommandData
  
  public net.dv8tion.jda.api.interactions.commands.build.CommandData buildCommandData()
  
  Description copied from class: ContextMenu
  
  Builds CommandData for the ContextMenu upsert. This code is executed when we need to upsert the menu. Useful for manual upserting.
  
  Overrides:
  
  buildCommandData in class ContextMenu
  
  Returns:
  
  the built command data