io.webfolder.cdp.command

Interface DOMDebugger

public interface DOMDebugger

DOM debugging allows setting breakpoints on particular DOM operations and events JavaScript execution will stop on these operations as if there was a regular breakpoint set

Method Summary

Modifier and Type	Method and Description
List<EventListener>	getEventListeners(String objectId) Returns event listeners of the given object.
List<EventListener>	getEventListeners(String objectId, Integer depth, Boolean pierce) Returns event listeners of the given object.
void	removeDOMBreakpoint(Integer nodeId, DOMBreakpointType type) Removes DOM breakpoint that was set using setDOMBreakpoint.
void	removeEventListenerBreakpoint(String eventName) Removes breakpoint on particular DOM event.
void	removeEventListenerBreakpoint(String eventName, String targetName) Removes breakpoint on particular DOM event.
void	removeInstrumentationBreakpoint(String eventName) Removes breakpoint on particular native event.
void	removeXHRBreakpoint(String url) Removes breakpoint from XMLHttpRequest.
void	setDOMBreakpoint(Integer nodeId, DOMBreakpointType type) Sets breakpoint on particular operation with DOM.
void	setEventListenerBreakpoint(String eventName) Sets breakpoint on particular DOM event.
void	setEventListenerBreakpoint(String eventName, String targetName) Sets breakpoint on particular DOM event.
void	setInstrumentationBreakpoint(String eventName) Sets breakpoint on particular native event.
void	setXHRBreakpoint(String url) Sets breakpoint on XMLHttpRequest.

Method Detail

setDOMBreakpoint

void setDOMBreakpoint(Integer nodeId,
                      DOMBreakpointType type)

Sets breakpoint on particular operation with DOM.

Parameters:

nodeId - Identifier of the node to set breakpoint on.

type - Type of the operation to stop upon.

removeDOMBreakpoint

void removeDOMBreakpoint(Integer nodeId,
                         DOMBreakpointType type)

Removes DOM breakpoint that was set using setDOMBreakpoint.

Parameters:

nodeId - Identifier of the node to remove breakpoint from.

type - Type of the breakpoint to remove.

setEventListenerBreakpoint

void setEventListenerBreakpoint(String eventName,
                                String targetName)

Sets breakpoint on particular DOM event.

Parameters:

eventName - DOM Event name to stop on (any DOM event will do).

targetName - EventTarget interface name to stop on. If equal to "*" or not provided, will stop on any EventTarget.

removeEventListenerBreakpoint

void removeEventListenerBreakpoint(String eventName,
                                   String targetName)

Removes breakpoint on particular DOM event.

Parameters:

eventName - Event name.

targetName - EventTarget interface name.

setInstrumentationBreakpoint

void setInstrumentationBreakpoint(String eventName)

Sets breakpoint on particular native event.

Parameters:

eventName - Instrumentation name to stop on.

removeInstrumentationBreakpoint

void removeInstrumentationBreakpoint(String eventName)

Removes breakpoint on particular native event.

Parameters:

eventName - Instrumentation name to stop on.

setXHRBreakpoint

void setXHRBreakpoint(String url)

Sets breakpoint on XMLHttpRequest.

Parameters:

url - Resource URL substring. All XHRs having this substring in the URL will get stopped upon.

removeXHRBreakpoint

void removeXHRBreakpoint(String url)

Removes breakpoint from XMLHttpRequest.

Parameters:

url - Resource URL substring.

getEventListeners

List<EventListener> getEventListeners(String objectId,
                                      Integer depth,
                                      Boolean pierce)

Returns event listeners of the given object.

Parameters:

objectId - Identifier of the object to return listeners for.

depth - The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.

pierce - Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false). Reports listeners for all contexts if pierce is enabled.

Returns:

Array of relevant listeners.

setEventListenerBreakpoint

void setEventListenerBreakpoint(String eventName)

Sets breakpoint on particular DOM event.

Parameters:

eventName - DOM Event name to stop on (any DOM event will do).

removeEventListenerBreakpoint

void removeEventListenerBreakpoint(String eventName)

Removes breakpoint on particular DOM event.

Parameters:

eventName - Event name.

getEventListeners

List<EventListener> getEventListeners(String objectId)

Returns event listeners of the given object.

Parameters:

objectId - Identifier of the object to return listeners for.

Returns:

Array of relevant listeners.