DOM

class DOM(cdp: CDP) : Domain

This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object that has an id. This id can be used to get additional information on the Node, resolve it into the JavaScript object wrapper, etc. It is important that client receives DOM events only for the nodes that are known to the client. Backend keeps track of the nodes that were sent to the client and never sends the same node twice. It is client's responsibility to collect information about the nodes that were sent to the client. Note that iframe owner elements will return corresponding document elements as their child nodes.

Constructors

DOM

constructor(cdp: CDP)

Types

AttributeModifiedParameter

@Serializable

data class AttributeModifiedParameter(val nodeId: Int, val name: String, val value: String)

Fired when Element's attribute is modified.

AttributeRemovedParameter

@Serializable

data class AttributeRemovedParameter(val nodeId: Int, val name: String)

Fired when Element's attribute is removed.

BackendNode

@Serializable

data class BackendNode(val nodeType: Int, val nodeName: String, val backendNodeId: Int)

Backend node with a friendly name.

BoxModel

@Serializable

data class BoxModel(val content: List<Double>, val padding: List<Double>, val border: List<Double>, val margin: List<Double>, val width: Int, val height: Int, val shapeOutside: DOM.ShapeOutsideInfo? = null)

Box model.

CharacterDataModifiedParameter

@Serializable

data class CharacterDataModifiedParameter(val nodeId: Int, val characterData: String)

Mirrors DOMCharacterDataModified event.

ChildNodeCountUpdatedParameter

@Serializable

data class ChildNodeCountUpdatedParameter(val nodeId: Int, val childNodeCount: Int)

Fired when Container's child node count has changed.

ChildNodeInsertedParameter

@Serializable

data class ChildNodeInsertedParameter(val parentNodeId: Int, val previousNodeId: Int, val node: DOM.Node)

Mirrors DOMNodeInserted event.

ChildNodeRemovedParameter

@Serializable

data class ChildNodeRemovedParameter(val parentNodeId: Int, val nodeId: Int)

Mirrors DOMNodeRemoved event.

CollectClassNamesFromSubtreeParameter

@Serializable

data class CollectClassNamesFromSubtreeParameter(val nodeId: Int)

CollectClassNamesFromSubtreeReturn

@Serializable

data class CollectClassNamesFromSubtreeReturn(val classNames: List<String>)

CompatibilityMode

@Serializable

enum CompatibilityMode : Enum<DOM.CompatibilityMode>

Document compatibility mode.

CopyToParameter

@Serializable

data class CopyToParameter(val nodeId: Int, val targetNodeId: Int, val insertBeforeNodeId: Int? = null)

CopyToReturn

@Serializable

data class CopyToReturn(val nodeId: Int)

CSSComputedStyleProperty

@Serializable

data class CSSComputedStyleProperty(val name: String, val value: String)

DescribeNodeParameter

@Serializable

data class DescribeNodeParameter(val nodeId: Int? = null, val backendNodeId: Int? = null, val objectId: String? = null, val depth: Int? = null, val pierce: Boolean? = null)

DescribeNodeReturn

@Serializable

data class DescribeNodeReturn(val node: DOM.Node)

DetachedElementInfo

@Serializable

data class DetachedElementInfo(val treeNode: DOM.Node, val retainedNodeIds: List<Int>)

A structure to hold the top-level node of a detached tree and an array of its retained descendants.

DiscardSearchResultsParameter

@Serializable

data class DiscardSearchResultsParameter(val searchId: String)

DistributedNodesUpdatedParameter

@Serializable

data class DistributedNodesUpdatedParameter(val insertionPointId: Int, val distributedNodes: List<DOM.BackendNode>)

Called when distribution is changed.

EnableParameter

@Serializable

data class EnableParameter(val includeWhitespace: String? = null)

FocusParameter

@Serializable

data class FocusParameter(val nodeId: Int? = null, val backendNodeId: Int? = null, val objectId: String? = null)

GetAnchorElementParameter

@Serializable

data class GetAnchorElementParameter(val nodeId: Int, val anchorSpecifier: String? = null)

GetAnchorElementReturn

@Serializable

data class GetAnchorElementReturn(val nodeId: Int)

GetAttributesParameter

@Serializable

data class GetAttributesParameter(val nodeId: Int)

GetAttributesReturn

@Serializable

data class GetAttributesReturn(val attributes: List<String>)

GetBoxModelParameter

@Serializable

data class GetBoxModelParameter(val nodeId: Int? = null, val backendNodeId: Int? = null, val objectId: String? = null)

GetBoxModelReturn

@Serializable

data class GetBoxModelReturn(val model: DOM.BoxModel)

GetContainerForNodeParameter

@Serializable

data class GetContainerForNodeParameter(val nodeId: Int, val containerName: String? = null, val physicalAxes: DOM.PhysicalAxes? = null, val logicalAxes: DOM.LogicalAxes? = null, val queriesScrollState: Boolean? = null)

GetContainerForNodeReturn

@Serializable

data class GetContainerForNodeReturn(val nodeId: Int?)

GetContentQuadsParameter

@Serializable

data class GetContentQuadsParameter(val nodeId: Int? = null, val backendNodeId: Int? = null, val objectId: String? = null)

GetContentQuadsReturn

@Serializable

data class GetContentQuadsReturn(val quads: List<List<Double>>)

GetDetachedDomNodesReturn

@Serializable

data class GetDetachedDomNodesReturn(val detachedNodes: List<DOM.DetachedElementInfo>)

GetDocumentParameter

@Serializable

data class GetDocumentParameter(val depth: Int? = null, val pierce: Boolean? = null)

GetDocumentReturn

@Serializable

data class GetDocumentReturn(val root: DOM.Node)

GetElementByRelationParameter

@Serializable

data class GetElementByRelationParameter(val nodeId: Int, val relation: String)

GetElementByRelationReturn

@Serializable

data class GetElementByRelationReturn(val nodeId: Int)

GetFileInfoParameter

@Serializable

data class GetFileInfoParameter(val objectId: String)

GetFileInfoReturn

@Serializable

data class GetFileInfoReturn(val path: String)

GetFlattenedDocumentParameter

@Serializable

data class GetFlattenedDocumentParameter(val depth: Int? = null, val pierce: Boolean? = null)

GetFlattenedDocumentReturn

@Serializable

data class GetFlattenedDocumentReturn(val nodes: List<DOM.Node>)

GetFrameOwnerParameter

@Serializable

data class GetFrameOwnerParameter(val frameId: String)

GetFrameOwnerReturn

@Serializable

data class GetFrameOwnerReturn(val backendNodeId: Int, val nodeId: Int?)

GetNodeForLocationParameter

@Serializable

data class GetNodeForLocationParameter(val x: Int, val y: Int, val includeUserAgentShadowDOM: Boolean? = null, val ignorePointerEventsNone: Boolean? = null)

GetNodeForLocationReturn

@Serializable

data class GetNodeForLocationReturn(val backendNodeId: Int, val frameId: String, val nodeId: Int?)

GetNodesForSubtreeByStyleParameter

@Serializable

data class GetNodesForSubtreeByStyleParameter(val nodeId: Int, val computedStyles: List<DOM.CSSComputedStyleProperty>, val pierce: Boolean? = null)

GetNodesForSubtreeByStyleReturn

@Serializable

data class GetNodesForSubtreeByStyleReturn(val nodeIds: List<Int>)

GetNodeStackTracesParameter

@Serializable

data class GetNodeStackTracesParameter(val nodeId: Int)

GetNodeStackTracesReturn

@Serializable

data class GetNodeStackTracesReturn(val creation: Runtime.StackTrace?)

GetOuterHTMLParameter

@Serializable

data class GetOuterHTMLParameter(val nodeId: Int? = null, val backendNodeId: Int? = null, val objectId: String? = null)

GetOuterHTMLReturn

@Serializable

data class GetOuterHTMLReturn(val outerHTML: String)

GetQueryingDescendantsForContainerParameter

@Serializable

data class GetQueryingDescendantsForContainerParameter(val nodeId: Int)

GetQueryingDescendantsForContainerReturn

@Serializable

data class GetQueryingDescendantsForContainerReturn(val nodeIds: List<Int>)

GetRelayoutBoundaryParameter

@Serializable

data class GetRelayoutBoundaryParameter(val nodeId: Int)

GetRelayoutBoundaryReturn

@Serializable

data class GetRelayoutBoundaryReturn(val nodeId: Int)

GetSearchResultsParameter

@Serializable

data class GetSearchResultsParameter(val searchId: String, val fromIndex: Int, val toIndex: Int)

GetSearchResultsReturn

@Serializable

data class GetSearchResultsReturn(val nodeIds: List<Int>)

GetTopLayerElementsReturn

@Serializable

data class GetTopLayerElementsReturn(val nodeIds: List<Int>)

InlineStyleInvalidatedParameter

@Serializable

data class InlineStyleInvalidatedParameter(val nodeIds: List<Int>)

Fired when Element's inline style is modified via a CSS property modification.

LogicalAxes

@Serializable

enum LogicalAxes : Enum<DOM.LogicalAxes>

ContainerSelector logical axes

MoveToParameter

@Serializable

data class MoveToParameter(val nodeId: Int, val targetNodeId: Int, val insertBeforeNodeId: Int? = null)

MoveToReturn

@Serializable

data class MoveToReturn(val nodeId: Int)

Node

@Serializable

data class Node(val nodeId: Int, val parentId: Int? = null, val backendNodeId: Int, val nodeType: Int, val nodeName: String, val localName: String, val nodeValue: String, val childNodeCount: Int? = null, val children: List<DOM.Node>? = null, val attributes: List<String>? = null, val documentURL: String? = null, val baseURL: String? = null, val publicId: String? = null, val systemId: String? = null, val internalSubset: String? = null, val xmlVersion: String? = null, val name: String? = null, val value: String? = null, val pseudoType: DOM.PseudoType? = null, val pseudoIdentifier: String? = null, val shadowRootType: DOM.ShadowRootType? = null, val frameId: String? = null, val contentDocument: DOM.Node? = null, val shadowRoots: List<DOM.Node>? = null, val templateContent: DOM.Node? = null, val pseudoElements: List<DOM.Node>? = null, val importedDocument: DOM.Node? = null, val distributedNodes: List<DOM.BackendNode>? = null, val isSVG: Boolean? = null, val compatibilityMode: DOM.CompatibilityMode? = null, val assignedSlot: DOM.BackendNode? = null, val isScrollable: Boolean? = null)

DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes. DOMNode is a base node mirror type.

PerformSearchParameter

@Serializable

data class PerformSearchParameter(val query: String, val includeUserAgentShadowDOM: Boolean? = null)

PerformSearchReturn

@Serializable

data class PerformSearchReturn(val searchId: String, val resultCount: Int)

PhysicalAxes

@Serializable

enum PhysicalAxes : Enum<DOM.PhysicalAxes>

ContainerSelector physical axes

PseudoElementAddedParameter

@Serializable

data class PseudoElementAddedParameter(val parentId: Int, val pseudoElement: DOM.Node)

Called when a pseudo element is added to an element.

PseudoElementRemovedParameter

@Serializable

data class PseudoElementRemovedParameter(val parentId: Int, val pseudoElementId: Int)

Called when a pseudo element is removed from an element.

PseudoType

@Serializable

enum PseudoType : Enum<DOM.PseudoType>

Pseudo element type.

PushNodeByPathToFrontendParameter

@Serializable

data class PushNodeByPathToFrontendParameter(val path: String)

PushNodeByPathToFrontendReturn

@Serializable

data class PushNodeByPathToFrontendReturn(val nodeId: Int)

PushNodesByBackendIdsToFrontendParameter

@Serializable

data class PushNodesByBackendIdsToFrontendParameter(val backendNodeIds: List<Int>)

PushNodesByBackendIdsToFrontendReturn

@Serializable

data class PushNodesByBackendIdsToFrontendReturn(val nodeIds: List<Int>)

QuerySelectorAllParameter

@Serializable

data class QuerySelectorAllParameter(val nodeId: Int, val selector: String)

QuerySelectorAllReturn

@Serializable

data class QuerySelectorAllReturn(val nodeIds: List<Int>)

QuerySelectorParameter

@Serializable

data class QuerySelectorParameter(val nodeId: Int, val selector: String)

QuerySelectorReturn

@Serializable

data class QuerySelectorReturn(val nodeId: Int)

Rect

@Serializable

data class Rect(val x: Double, val y: Double, val width: Double, val height: Double)

Rectangle.

RemoveAttributeParameter

@Serializable

data class RemoveAttributeParameter(val nodeId: Int, val name: String)

RemoveNodeParameter

@Serializable

data class RemoveNodeParameter(val nodeId: Int)

RequestChildNodesParameter

@Serializable

data class RequestChildNodesParameter(val nodeId: Int, val depth: Int? = null, val pierce: Boolean? = null)

RequestNodeParameter

@Serializable

data class RequestNodeParameter(val objectId: String)

RequestNodeReturn

@Serializable

data class RequestNodeReturn(val nodeId: Int)

ResolveNodeParameter

@Serializable

data class ResolveNodeParameter(val nodeId: Int? = null, val backendNodeId: Int? = null, val objectGroup: String? = null, val executionContextId: Int? = null)

ResolveNodeReturn

@Serializable

data class ResolveNodeReturn(val object: Runtime.RemoteObject)

RGBA

@Serializable

data class RGBA(val r: Int, val g: Int, val b: Int, val a: Double? = null)

A structure holding an RGBA color.

ScrollableFlagUpdatedParameter

@Serializable

data class ScrollableFlagUpdatedParameter(val nodeId: Int, val isScrollable: Boolean)

Fired when a node's scrollability state changes.

ScrollIntoViewIfNeededParameter

@Serializable

data class ScrollIntoViewIfNeededParameter(val nodeId: Int? = null, val backendNodeId: Int? = null, val objectId: String? = null, val rect: DOM.Rect? = null)

ScrollOrientation

@Serializable

enum ScrollOrientation : Enum<DOM.ScrollOrientation>

Physical scroll orientation

SetAttributesAsTextParameter

@Serializable

data class SetAttributesAsTextParameter(val nodeId: Int, val text: String, val name: String? = null)

SetAttributeValueParameter

@Serializable

data class SetAttributeValueParameter(val nodeId: Int, val name: String, val value: String)

SetChildNodesParameter

@Serializable

data class SetChildNodesParameter(val parentId: Int, val nodes: List<DOM.Node>)

Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids.

SetFileInputFilesParameter

@Serializable

data class SetFileInputFilesParameter(val files: List<String>, val nodeId: Int? = null, val backendNodeId: Int? = null, val objectId: String? = null)

SetInspectedNodeParameter

@Serializable

data class SetInspectedNodeParameter(val nodeId: Int)

SetNodeNameParameter

@Serializable

data class SetNodeNameParameter(val nodeId: Int, val name: String)

SetNodeNameReturn

@Serializable

data class SetNodeNameReturn(val nodeId: Int)

SetNodeStackTracesEnabledParameter

@Serializable

data class SetNodeStackTracesEnabledParameter(val enable: Boolean)

SetNodeValueParameter

@Serializable

data class SetNodeValueParameter(val nodeId: Int, val value: String)

SetOuterHTMLParameter

@Serializable

data class SetOuterHTMLParameter(val nodeId: Int, val outerHTML: String)

ShadowRootPoppedParameter

@Serializable

data class ShadowRootPoppedParameter(val hostId: Int, val rootId: Int)

Called when shadow root is popped from the element.

ShadowRootPushedParameter

@Serializable

data class ShadowRootPushedParameter(val hostId: Int, val root: DOM.Node)

Called when shadow root is pushed into the element.

ShadowRootType

@Serializable

enum ShadowRootType : Enum<DOM.ShadowRootType>

Shadow root type.

ShapeOutsideInfo

@Serializable

data class ShapeOutsideInfo(val bounds: List<Double>, val shape: List<JsonElement>, val marginShape: List<JsonElement>)

CSS Shape Outside details.

Properties

attributeModified

val attributeModified: Flow<DOM.AttributeModifiedParameter>

Fired when Element's attribute is modified.

attributeRemoved

val attributeRemoved: Flow<DOM.AttributeRemovedParameter>

Fired when Element's attribute is removed.

characterDataModified

val characterDataModified: Flow<DOM.CharacterDataModifiedParameter>

Mirrors DOMCharacterDataModified event.

childNodeCountUpdated

val childNodeCountUpdated: Flow<DOM.ChildNodeCountUpdatedParameter>

Fired when Container's child node count has changed.

childNodeInserted

val childNodeInserted: Flow<DOM.ChildNodeInsertedParameter>

Mirrors DOMNodeInserted event.

childNodeRemoved

val childNodeRemoved: Flow<DOM.ChildNodeRemovedParameter>

Mirrors DOMNodeRemoved event.

distributedNodesUpdated

val distributedNodesUpdated: Flow<DOM.DistributedNodesUpdatedParameter>

Called when distribution is changed.

documentUpdated

val documentUpdated: Flow<Unit>

Fired when Document has been totally updated. Node ids are no longer valid.

inlineStyleInvalidated

val inlineStyleInvalidated: Flow<DOM.InlineStyleInvalidatedParameter>

Fired when Element's inline style is modified via a CSS property modification.

pseudoElementAdded

val pseudoElementAdded: Flow<DOM.PseudoElementAddedParameter>

Called when a pseudo element is added to an element.

pseudoElementRemoved

val pseudoElementRemoved: Flow<DOM.PseudoElementRemovedParameter>

Called when a pseudo element is removed from an element.

scrollableFlagUpdated

val scrollableFlagUpdated: Flow<DOM.ScrollableFlagUpdatedParameter>

Fired when a node's scrollability state changes.

setChildNodes

val setChildNodes: Flow<DOM.SetChildNodesParameter>

Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids.

shadowRootPopped

val shadowRootPopped: Flow<DOM.ShadowRootPoppedParameter>

Called when shadow root is popped from the element.

shadowRootPushed

val shadowRootPushed: Flow<DOM.ShadowRootPushedParameter>

Called when shadow root is pushed into the element.

topLayerElementsUpdated

val topLayerElementsUpdated: Flow<Unit>

Called when top layer elements are changed.

Functions

collectClassNamesFromSubtree

suspend fun collectClassNamesFromSubtree(nodeId: Int): DOM.CollectClassNamesFromSubtreeReturn

suspend fun collectClassNamesFromSubtree(args: DOM.CollectClassNamesFromSubtreeParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.CollectClassNamesFromSubtreeReturn

Collects class names for the node with given id and all of it's child nodes.

copyTo

suspend fun copyTo(args: DOM.CopyToParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.CopyToReturn

suspend fun copyTo(nodeId: Int, targetNodeId: Int, insertBeforeNodeId: Int? = null): DOM.CopyToReturn

Creates a deep copy of the specified node and places it into the target container before the given anchor.

describeNode

suspend fun describeNode(args: DOM.DescribeNodeParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.DescribeNodeReturn

suspend fun describeNode(nodeId: Int? = null, backendNodeId: Int? = null, objectId: String? = null, depth: Int? = null, pierce: Boolean? = null): DOM.DescribeNodeReturn

Describes node given its id, does not require domain to be enabled. Does not start tracking any objects, can be used for automation.

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disables DOM agent for the given page.

discardSearchResults

suspend fun discardSearchResults(searchId: String)

suspend fun discardSearchResults(args: DOM.DiscardSearchResultsParameter, mode: CommandMode = CommandMode.DEFAULT)

Discards search results from the session with the given id. getSearchResults should no longer be called for that search.

enable

suspend fun enable(includeWhitespace: String? = null)

suspend fun enable(args: DOM.EnableParameter, mode: CommandMode = CommandMode.DEFAULT)

Enables DOM agent for the given page.

focus

suspend fun focus(args: DOM.FocusParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun focus(nodeId: Int? = null, backendNodeId: Int? = null, objectId: String? = null)

Focuses the given element.

getAnchorElement

suspend fun getAnchorElement(args: DOM.GetAnchorElementParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetAnchorElementReturn

suspend fun getAnchorElement(nodeId: Int, anchorSpecifier: String? = null): DOM.GetAnchorElementReturn

Returns the target anchor element of the given anchor query according to https://www.w3.org/TR/css-anchor-position-1/#target.

getAttributes

suspend fun getAttributes(nodeId: Int): DOM.GetAttributesReturn

suspend fun getAttributes(args: DOM.GetAttributesParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetAttributesReturn

Returns attributes for the specified node.

getBoxModel

suspend fun getBoxModel(args: DOM.GetBoxModelParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetBoxModelReturn

suspend fun getBoxModel(nodeId: Int? = null, backendNodeId: Int? = null, objectId: String? = null): DOM.GetBoxModelReturn

Returns boxes for the given node.

getContainerForNode

suspend fun getContainerForNode(args: DOM.GetContainerForNodeParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetContainerForNodeReturn

suspend fun getContainerForNode(nodeId: Int, containerName: String? = null, physicalAxes: DOM.PhysicalAxes? = null, logicalAxes: DOM.LogicalAxes? = null, queriesScrollState: Boolean? = null): DOM.GetContainerForNodeReturn

Returns the query container of the given node based on container query conditions: containerName, physical and logical axes, and whether it queries scroll-state. If no axes are provided and queriesScrollState is false, the style container is returned, which is the direct parent or the closest element with a matching container-name.

getContentQuads

suspend fun getContentQuads(args: DOM.GetContentQuadsParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetContentQuadsReturn

suspend fun getContentQuads(nodeId: Int? = null, backendNodeId: Int? = null, objectId: String? = null): DOM.GetContentQuadsReturn

Returns quads that describe node position on the page. This method might return multiple quads for inline nodes.

getDetachedDomNodes

suspend fun getDetachedDomNodes(mode: CommandMode = CommandMode.DEFAULT): DOM.GetDetachedDomNodesReturn

Returns list of detached nodes

getDocument

suspend fun getDocument(args: DOM.GetDocumentParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetDocumentReturn

suspend fun getDocument(depth: Int? = null, pierce: Boolean? = null): DOM.GetDocumentReturn

Returns the root DOM node (and optionally the subtree) to the caller. Implicitly enables the DOM domain events for the current target.

getElementByRelation

suspend fun getElementByRelation(args: DOM.GetElementByRelationParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetElementByRelationReturn

suspend fun getElementByRelation(nodeId: Int, relation: String): DOM.GetElementByRelationReturn

Returns the NodeId of the matched element according to certain relations.

getFileInfo

suspend fun getFileInfo(objectId: String): DOM.GetFileInfoReturn

suspend fun getFileInfo(args: DOM.GetFileInfoParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetFileInfoReturn

Returns file information for the given File wrapper.

getFlattenedDocument

suspend fun ~~getFlattenedDocument~~(args: DOM.GetFlattenedDocumentParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetFlattenedDocumentReturn

suspend fun ~~getFlattenedDocument~~(depth: Int? = null, pierce: Boolean? = null): DOM.GetFlattenedDocumentReturn

Returns the root DOM node (and optionally the subtree) to the caller. Deprecated, as it is not designed to work well with the rest of the DOM agent. Use DOMSnapshot.captureSnapshot instead.

getFrameOwner

suspend fun getFrameOwner(frameId: String): DOM.GetFrameOwnerReturn

suspend fun getFrameOwner(args: DOM.GetFrameOwnerParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetFrameOwnerReturn

Returns iframe node that owns iframe with the given domain.

getNodeForLocation

suspend fun getNodeForLocation(args: DOM.GetNodeForLocationParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetNodeForLocationReturn

suspend fun getNodeForLocation(x: Int, y: Int, includeUserAgentShadowDOM: Boolean? = null, ignorePointerEventsNone: Boolean? = null): DOM.GetNodeForLocationReturn

Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is either returned or not.

getNodesForSubtreeByStyle

suspend fun getNodesForSubtreeByStyle(args: DOM.GetNodesForSubtreeByStyleParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetNodesForSubtreeByStyleReturn

suspend fun getNodesForSubtreeByStyle(nodeId: Int, computedStyles: List<DOM.CSSComputedStyleProperty>, pierce: Boolean? = null): DOM.GetNodesForSubtreeByStyleReturn

Finds nodes with a given computed style in a subtree.

getNodeStackTraces

suspend fun getNodeStackTraces(nodeId: Int): DOM.GetNodeStackTracesReturn

suspend fun getNodeStackTraces(args: DOM.GetNodeStackTracesParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetNodeStackTracesReturn

Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.

getOuterHTML

suspend fun getOuterHTML(args: DOM.GetOuterHTMLParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetOuterHTMLReturn

suspend fun getOuterHTML(nodeId: Int? = null, backendNodeId: Int? = null, objectId: String? = null): DOM.GetOuterHTMLReturn

Returns node's HTML markup.

getQueryingDescendantsForContainer

suspend fun getQueryingDescendantsForContainer(nodeId: Int): DOM.GetQueryingDescendantsForContainerReturn

suspend fun getQueryingDescendantsForContainer(args: DOM.GetQueryingDescendantsForContainerParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetQueryingDescendantsForContainerReturn

Returns the descendants of a container query container that have container queries against this container.

getRelayoutBoundary

suspend fun getRelayoutBoundary(nodeId: Int): DOM.GetRelayoutBoundaryReturn

suspend fun getRelayoutBoundary(args: DOM.GetRelayoutBoundaryParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetRelayoutBoundaryReturn

Returns the id of the nearest ancestor that is a relayout boundary.

getSearchResults

suspend fun getSearchResults(args: DOM.GetSearchResultsParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.GetSearchResultsReturn

suspend fun getSearchResults(searchId: String, fromIndex: Int, toIndex: Int): DOM.GetSearchResultsReturn

Returns search results from given fromIndex to given toIndex from the search with the given identifier.

getTopLayerElements

suspend fun getTopLayerElements(mode: CommandMode = CommandMode.DEFAULT): DOM.GetTopLayerElementsReturn

Returns NodeIds of current top layer elements. Top layer is rendered closest to the user within a viewport, therefore its elements always appear on top of all other content.

hideHighlight

suspend fun hideHighlight(mode: CommandMode = CommandMode.DEFAULT)

Hides any highlight.

highlightNode

suspend fun highlightNode(mode: CommandMode = CommandMode.DEFAULT)

Highlights DOM node.

highlightRect

suspend fun highlightRect(mode: CommandMode = CommandMode.DEFAULT)

Highlights given rectangle.

markUndoableState

suspend fun markUndoableState(mode: CommandMode = CommandMode.DEFAULT)

Marks last undoable state.

moveTo

suspend fun moveTo(args: DOM.MoveToParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.MoveToReturn

suspend fun moveTo(nodeId: Int, targetNodeId: Int, insertBeforeNodeId: Int? = null): DOM.MoveToReturn

Moves node into the new container, places it before the given anchor.

performSearch

suspend fun performSearch(args: DOM.PerformSearchParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.PerformSearchReturn

suspend fun performSearch(query: String, includeUserAgentShadowDOM: Boolean? = null): DOM.PerformSearchReturn

Searches for a given string in the DOM tree. Use getSearchResults to access search results or cancelSearch to end this search session.

pushNodeByPathToFrontend

suspend fun pushNodeByPathToFrontend(path: String): DOM.PushNodeByPathToFrontendReturn

suspend fun pushNodeByPathToFrontend(args: DOM.PushNodeByPathToFrontendParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.PushNodeByPathToFrontendReturn

Requests that the node is sent to the caller given its path. // FIXME, use XPath

pushNodesByBackendIdsToFrontend

suspend fun pushNodesByBackendIdsToFrontend(backendNodeIds: List<Int>): DOM.PushNodesByBackendIdsToFrontendReturn

suspend fun pushNodesByBackendIdsToFrontend(args: DOM.PushNodesByBackendIdsToFrontendParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.PushNodesByBackendIdsToFrontendReturn

Requests that a batch of nodes is sent to the caller given their backend node ids.

querySelector

suspend fun querySelector(args: DOM.QuerySelectorParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.QuerySelectorReturn

suspend fun querySelector(nodeId: Int, selector: String): DOM.QuerySelectorReturn

Executes querySelector on a given node.

querySelectorAll

suspend fun querySelectorAll(args: DOM.QuerySelectorAllParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.QuerySelectorAllReturn

suspend fun querySelectorAll(nodeId: Int, selector: String): DOM.QuerySelectorAllReturn

Executes querySelectorAll on a given node.

redo

suspend fun redo(mode: CommandMode = CommandMode.DEFAULT)

Re-does the last undone action.

removeAttribute

suspend fun removeAttribute(args: DOM.RemoveAttributeParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun removeAttribute(nodeId: Int, name: String)

Removes attribute with given name from an element with given id.

removeNode

suspend fun removeNode(nodeId: Int)

suspend fun removeNode(args: DOM.RemoveNodeParameter, mode: CommandMode = CommandMode.DEFAULT)

Removes node with given id.

requestChildNodes

suspend fun requestChildNodes(args: DOM.RequestChildNodesParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun requestChildNodes(nodeId: Int, depth: Int? = null, pierce: Boolean? = null)

Requests that children of the node with given id are returned to the caller in form of setChildNodes events where not only immediate children are retrieved, but all children down to the specified depth.

requestNode

suspend fun requestNode(objectId: String): DOM.RequestNodeReturn

suspend fun requestNode(args: DOM.RequestNodeParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.RequestNodeReturn

Requests that the node is sent to the caller given the JavaScript node object reference. All nodes that form the path from the node to the root are also sent to the client as a series of setChildNodes notifications.

resolveNode

suspend fun resolveNode(args: DOM.ResolveNodeParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.ResolveNodeReturn

suspend fun resolveNode(nodeId: Int? = null, backendNodeId: Int? = null, objectGroup: String? = null, executionContextId: Int? = null): DOM.ResolveNodeReturn

Resolves the JavaScript node object for a given NodeId or BackendNodeId.

scrollIntoViewIfNeeded

suspend fun scrollIntoViewIfNeeded(args: DOM.ScrollIntoViewIfNeededParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun scrollIntoViewIfNeeded(nodeId: Int? = null, backendNodeId: Int? = null, objectId: String? = null, rect: DOM.Rect? = null)

Scrolls the specified rect of the given node into view if not already visible. Note: exactly one between nodeId, backendNodeId and objectId should be passed to identify the node.

setAttributesAsText

suspend fun setAttributesAsText(args: DOM.SetAttributesAsTextParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setAttributesAsText(nodeId: Int, text: String, name: String? = null)

Sets attributes on element with given id. This method is useful when user edits some existing attribute value and types in several attribute name/value pairs.

setAttributeValue

suspend fun setAttributeValue(args: DOM.SetAttributeValueParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setAttributeValue(nodeId: Int, name: String, value: String)

Sets attribute for an element with given id.

setFileInputFiles

suspend fun setFileInputFiles(args: DOM.SetFileInputFilesParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setFileInputFiles(files: List<String>, nodeId: Int? = null, backendNodeId: Int? = null, objectId: String? = null)

Sets files for the given file input element.

setInspectedNode

suspend fun setInspectedNode(nodeId: Int)

suspend fun setInspectedNode(args: DOM.SetInspectedNodeParameter, mode: CommandMode = CommandMode.DEFAULT)

Enables console to refer to the node with given id via

$x (see Command Line API for more details $

x functions).

setNodeName

suspend fun setNodeName(args: DOM.SetNodeNameParameter, mode: CommandMode = CommandMode.DEFAULT): DOM.SetNodeNameReturn

suspend fun setNodeName(nodeId: Int, name: String): DOM.SetNodeNameReturn

Sets node name for a node with given id.

setNodeStackTracesEnabled

suspend fun setNodeStackTracesEnabled(enable: Boolean)

suspend fun setNodeStackTracesEnabled(args: DOM.SetNodeStackTracesEnabledParameter, mode: CommandMode = CommandMode.DEFAULT)

Sets if stack traces should be captured for Nodes. See Node.getNodeStackTraces. Default is disabled.

setNodeValue

suspend fun setNodeValue(args: DOM.SetNodeValueParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setNodeValue(nodeId: Int, value: String)

Sets node value for a node with given id.

setOuterHTML

suspend fun setOuterHTML(args: DOM.SetOuterHTMLParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun setOuterHTML(nodeId: Int, outerHTML: String)

Sets node HTML markup, returns new node id.

undo

suspend fun undo(mode: CommandMode = CommandMode.DEFAULT)

Undoes the last performed action.