ContextMenuEvent (montoya-api 2024.11 API)

All Superinterfaces:: ComponentEvent, InvocationSource, ToolSource

public interface ContextMenuEvent extends ComponentEvent, ToolSource, InvocationSource

Provides useful information when generating context menu items from a ContextMenuItemsProvider.

Method Summary

Modifier and Type

Method

Description

Optional<MessageEditorHttpRequestResponse>

messageEditorRequestResponse()

This method can be used to retrieve details of the currently selected HTTP request/response when the context menu was invoked.

List<AuditIssue>

selectedIssues()

Deprecated.
Use ContextMenuItemsProvider.provideMenuItems(AuditIssueContextMenuEvent) instead.

List<HttpRequestResponse>

selectedRequestResponses()

This method can be used to retrieve details of the currently selected HTTP request/response pair that was selected by the user when the context menu was invoked.

Methods inherited from interface burp.api.montoya.ui.contextmenu.ComponentEvent
inputEvent

Methods inherited from interface burp.api.montoya.ui.contextmenu.InvocationSource
invocationType, isFrom

Methods inherited from interface burp.api.montoya.core.ToolSource
isFromTool, toolType

Method Details
- messageEditorRequestResponse
  
  Optional<MessageEditorHttpRequestResponse> messageEditorRequestResponse()
  
  This method can be used to retrieve details of the currently selected HTTP request/response when the context menu was invoked.
  
  Returns:
  
  an Optional describing the currently selected request response with selection metadata.
- selectedRequestResponses
  
  List<HttpRequestResponse> selectedRequestResponses()
  
  This method can be used to retrieve details of the currently selected HTTP request/response pair that was selected by the user when the context menu was invoked. This will return an empty list if the user has not made a selection.
  
  Returns:
  
  A list of request responses that have been selected by the user.
- selectedIssues
  
  @Deprecated List<AuditIssue> selectedIssues()
  
  Deprecated.
  Use ContextMenuItemsProvider.provideMenuItems(AuditIssueContextMenuEvent) instead.
  
  This method can be used to retrieve details of the Scanner issues that were selected by the user when the context menu was invoked. This will return an empty list if no issues are applicable to the invocation.
  
  Returns:
  
  a List of AuditIssue objects representing the items that were shown or selected by the user when the context menu was invoked.