Interface HotKeyEvent

All Superinterfaces:

ComponentEvent, InvocationSource, ToolSource

public interface HotKeyEvent
extends ComponentEvent, ToolSource, InvocationSource

Provides useful contextual information from events triggered by hot keys HotKeyHandler.

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 hot key was invoked.
List<HttpRequestResponse>	selectedRequestResponses()	This method can be used to retrieve details of the currently selected HTTP request/response pairs when the hot key 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 hot key 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 pairs when the hot key was invoked. This will return an empty list if no selection has been made.

Returns:

A list of request responses that have been selected.