Interface IDOMDebugger

Namespace

Selenium.WebDriver.BiDi.Cdp.DOMDebugger

Assembly

Selenium.WebDriver.BiDi.Cdp.dll

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.

public interface IDOMDebugger

Methods

GetEventListenersAsync(RemoteObjectId, long?, bool?, string?, CancellationToken)

Returns event listeners of the given object.

Task<GetEventListenersResult> GetEventListenersAsync(RemoteObjectId objectId, long? depth = null, bool? pierce = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

objectId RemoteObjectId

Identifier of the object to return listeners for.

depth long?

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 bool?

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.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<GetEventListenersResult>

A task representing the asynchronous operation, containing a GetEventListenersResult.

RemoveDOMBreakpointAsync(NodeId, DOMBreakpointType, string?, CancellationToken)

Removes DOM breakpoint that was set using setDOMBreakpoint.

Task<RemoveDOMBreakpointResult> RemoveDOMBreakpointAsync(NodeId nodeId, DOMBreakpointType type, string? session = null, CancellationToken cancellationToken = default)

Parameters

nodeId NodeId

Identifier of the node to remove breakpoint from.

type DOMBreakpointType

Type of the breakpoint to remove.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<RemoveDOMBreakpointResult>

A task representing the asynchronous operation, containing a RemoveDOMBreakpointResult.

RemoveEventListenerBreakpointAsync(string, string?, string?, CancellationToken)

Removes breakpoint on particular DOM event.

Task<RemoveEventListenerBreakpointResult> RemoveEventListenerBreakpointAsync(string eventName, string? targetName = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

eventName string

Event name.

targetName string

EventTarget interface name.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<RemoveEventListenerBreakpointResult>

A task representing the asynchronous operation, containing a RemoveEventListenerBreakpointResult.

RemoveInstrumentationBreakpointAsync(string, string?, CancellationToken)

Removes breakpoint on particular native event.

[Experimental("BIDICDP001")]
[Obsolete]
Task<RemoveInstrumentationBreakpointResult> RemoveInstrumentationBreakpointAsync(string eventName, string? session = null, CancellationToken cancellationToken = default)

Parameters

eventName string

Instrumentation name to stop on.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<RemoveInstrumentationBreakpointResult>

A task representing the asynchronous operation, containing a RemoveInstrumentationBreakpointResult.

RemoveXHRBreakpointAsync(string, string?, CancellationToken)

Removes breakpoint from XMLHttpRequest.

Task<RemoveXHRBreakpointResult> RemoveXHRBreakpointAsync(string url, string? session = null, CancellationToken cancellationToken = default)

Parameters

url string

Resource URL substring.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<RemoveXHRBreakpointResult>

A task representing the asynchronous operation, containing a RemoveXHRBreakpointResult.

SetBreakOnCSPViolationAsync(ImmutableArray<CSPViolationType>, string?, CancellationToken)

Sets breakpoint on particular CSP violations.

[Experimental("BIDICDP001")]
Task<SetBreakOnCSPViolationResult> SetBreakOnCSPViolationAsync(ImmutableArray<CSPViolationType> violationTypes, string? session = null, CancellationToken cancellationToken = default)

Parameters

violationTypes ImmutableArray<CSPViolationType>

CSP Violations to stop upon.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetBreakOnCSPViolationResult>

A task representing the asynchronous operation, containing a SetBreakOnCSPViolationResult.

SetDOMBreakpointAsync(NodeId, DOMBreakpointType, string?, CancellationToken)

Sets breakpoint on particular operation with DOM.

Task<SetDOMBreakpointResult> SetDOMBreakpointAsync(NodeId nodeId, DOMBreakpointType type, string? session = null, CancellationToken cancellationToken = default)

Parameters

nodeId NodeId

Identifier of the node to set breakpoint on.

type DOMBreakpointType

Type of the operation to stop upon.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetDOMBreakpointResult>

A task representing the asynchronous operation, containing a SetDOMBreakpointResult.

SetEventListenerBreakpointAsync(string, string?, string?, CancellationToken)

Sets breakpoint on particular DOM event.

Task<SetEventListenerBreakpointResult> SetEventListenerBreakpointAsync(string eventName, string? targetName = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

eventName string

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

targetName string

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

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetEventListenerBreakpointResult>

A task representing the asynchronous operation, containing a SetEventListenerBreakpointResult.

SetInstrumentationBreakpointAsync(string, string?, CancellationToken)

Sets breakpoint on particular native event.

[Experimental("BIDICDP001")]
[Obsolete]
Task<SetInstrumentationBreakpointResult> SetInstrumentationBreakpointAsync(string eventName, string? session = null, CancellationToken cancellationToken = default)

Parameters

eventName string

Instrumentation name to stop on.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetInstrumentationBreakpointResult>

A task representing the asynchronous operation, containing a SetInstrumentationBreakpointResult.

SetXHRBreakpointAsync(string, string?, CancellationToken)

Sets breakpoint on XMLHttpRequest.

Task<SetXHRBreakpointResult> SetXHRBreakpointAsync(string url, string? session = null, CancellationToken cancellationToken = default)

Parameters

url string

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

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetXHRBreakpointResult>

A task representing the asynchronous operation, containing a SetXHRBreakpointResult.