Package burp.api.montoya.ui.contextmenu

Interface WebSocketContextMenuEvent

All Superinterfaces:

ComponentEvent, ToolSource

public interface WebSocketContextMenuEvent
extends ComponentEvent, ToolSource

Method Summary

Modifier and Type	Method	Description
Optional<WebSocketEditorEvent>	messageEditorWebSocket()	This method can be used to retrieve details of the currently selected WebSocket message when the context menu was invoked from an editor.
List<WebSocketMessage>	selectedWebSocketMessages()	This method can be used to retrieve details of the currently selected WebSocket messages that are 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.core.ToolSource

isFromTool, toolType

Method Details

messageEditorWebSocket

Optional<WebSocketEditorEvent> messageEditorWebSocket()

This method can be used to retrieve details of the currently selected WebSocket message when the context menu was invoked from an editor.

Returns:

an Optional describing the currently selected WebSocket message with selection metadata.

selectedWebSocketMessages

List<WebSocketMessage> selectedWebSocketMessages()

This method can be used to retrieve details of the currently selected WebSocket messages that are 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 WebSocket messages that have been selected by the user.