pl.wendigo.chrome.api.dom

Package pl.wendigo.chrome.api.dom

Contains DevTools Protocol DOM domain implementation accessible via DOMOperations class.

Types

AttributeModifiedEvent

data class AttributeModifiedEvent : Event

Fired when Element's attribute is modified.

AttributeRemovedEvent

data class AttributeRemovedEvent : Event

Fired when Element's attribute is removed.

BackendNode

data class BackendNode

Backend node with a friendly name.

BoxModel

data class BoxModel

Box model.

CharacterDataModifiedEvent

data class CharacterDataModifiedEvent : Event

Mirrors DOMCharacterDataModified event.

ChildNodeCountUpdatedEvent

data class ChildNodeCountUpdatedEvent : Event

Fired when Container's child node count has changed.

ChildNodeInsertedEvent

data class ChildNodeInsertedEvent : Event

Mirrors DOMNodeInserted event.

ChildNodeRemovedEvent

data class ChildNodeRemovedEvent : Event

Mirrors DOMNodeRemoved event.

CollectClassNamesFromSubtreeRequest

data class CollectClassNamesFromSubtreeRequest

Represents request frame that can be used with DOM#collectClassNamesFromSubtree operation call.

CollectClassNamesFromSubtreeResponse

data class CollectClassNamesFromSubtreeResponse

Represents response frame that is returned from DOM#collectClassNamesFromSubtree operation call. Collects class names for the node with given id and all of it's child nodes.

CopyToRequest

data class CopyToRequest

Represents request frame that can be used with DOM#copyTo operation call.

CopyToResponse

data class CopyToResponse

Represents response frame that is returned from DOM#copyTo operation call. Creates a deep copy of the specified node and places it into the target container before the given anchor.

DescribeNodeRequest

data class DescribeNodeRequest

Represents request frame that can be used with DOM#describeNode operation call.

DescribeNodeResponse

data class DescribeNodeResponse

Represents response frame that is returned from DOM#describeNode operation call. Describes node given its id, does not require domain to be enabled. Does not start tracking any objects, can be used for automation.

DiscardSearchResultsRequest

data class DiscardSearchResultsRequest

Represents request frame that can be used with DOM#discardSearchResults operation call.

DistributedNodesUpdatedEvent

data class DistributedNodesUpdatedEvent : Event

Called when distrubution is changed.

DOMOperations

class DOMOperations

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.

FocusRequest

data class FocusRequest

Represents request frame that can be used with DOM#focus operation call.

GetAttributesRequest

data class GetAttributesRequest

Represents request frame that can be used with DOM#getAttributes operation call.

GetAttributesResponse

data class GetAttributesResponse

Represents response frame that is returned from DOM#getAttributes operation call. Returns attributes for the specified node.

GetBoxModelRequest

data class GetBoxModelRequest

Represents request frame that can be used with DOM#getBoxModel operation call.

GetBoxModelResponse

data class GetBoxModelResponse

Represents response frame that is returned from DOM#getBoxModel operation call. Returns boxes for the given node.

GetContentQuadsRequest

data class GetContentQuadsRequest

Represents request frame that can be used with DOM#getContentQuads operation call.

GetContentQuadsResponse

data class GetContentQuadsResponse

Represents response frame that is returned from DOM#getContentQuads operation call. Returns quads that describe node position on the page. This method might return multiple quads for inline nodes.

GetDocumentRequest

data class GetDocumentRequest

Represents request frame that can be used with DOM#getDocument operation call.

GetDocumentResponse

data class GetDocumentResponse

Represents response frame that is returned from DOM#getDocument operation call. Returns the root DOM node (and optionally the subtree) to the caller.

GetFileInfoRequest

data class GetFileInfoRequest

Represents request frame that can be used with DOM#getFileInfo operation call.

GetFileInfoResponse

data class GetFileInfoResponse

Represents response frame that is returned from DOM#getFileInfo operation call. Returns file information for the given File wrapper.

GetFlattenedDocumentRequest

data class GetFlattenedDocumentRequest

Represents request frame that can be used with DOM#getFlattenedDocument operation call.

GetFlattenedDocumentResponse

data class GetFlattenedDocumentResponse

Represents response frame that is returned from DOM#getFlattenedDocument operation call. Returns the root DOM node (and optionally the subtree) to the caller.

GetFrameOwnerRequest

data class GetFrameOwnerRequest

Represents request frame that can be used with DOM#getFrameOwner operation call.

GetFrameOwnerResponse

data class GetFrameOwnerResponse

Represents response frame that is returned from DOM#getFrameOwner operation call. Returns iframe node that owns iframe with the given domain.

GetNodeForLocationRequest

data class GetNodeForLocationRequest

Represents request frame that can be used with DOM#getNodeForLocation operation call.

GetNodeForLocationResponse

data class GetNodeForLocationResponse

Represents response frame that is returned from DOM#getNodeForLocation operation call. Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is either returned or not.

GetNodeStackTracesRequest

data class GetNodeStackTracesRequest

Represents request frame that can be used with DOM#getNodeStackTraces operation call.

GetNodeStackTracesResponse

data class GetNodeStackTracesResponse

Represents response frame that is returned from DOM#getNodeStackTraces operation call. Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.

GetOuterHTMLRequest

data class GetOuterHTMLRequest

Represents request frame that can be used with DOM#getOuterHTML operation call.

GetOuterHTMLResponse

data class GetOuterHTMLResponse

Represents response frame that is returned from DOM#getOuterHTML operation call. Returns node's HTML markup.

GetRelayoutBoundaryRequest

data class GetRelayoutBoundaryRequest

Represents request frame that can be used with DOM#getRelayoutBoundary operation call.

GetRelayoutBoundaryResponse

data class GetRelayoutBoundaryResponse

Represents response frame that is returned from DOM#getRelayoutBoundary operation call. Returns the id of the nearest ancestor that is a relayout boundary.

GetSearchResultsRequest

data class GetSearchResultsRequest

Represents request frame that can be used with DOM#getSearchResults operation call.

GetSearchResultsResponse

data class GetSearchResultsResponse

Represents response frame that is returned from DOM#getSearchResults operation call. Returns search results from given fromIndex to given toIndex from the search with the given identifier.

InlineStyleInvalidatedEvent

data class InlineStyleInvalidatedEvent : Event

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

MoveToRequest

data class MoveToRequest

Represents request frame that can be used with DOM#moveTo operation call.

MoveToResponse

data class MoveToResponse

Represents response frame that is returned from DOM#moveTo operation call. Moves node into the new container, places it before the given anchor.

Node

data class Node

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

PerformSearchRequest

data class PerformSearchRequest

Represents request frame that can be used with DOM#performSearch operation call.

PerformSearchResponse

data class PerformSearchResponse

Represents response frame that is returned from DOM#performSearch operation call. Searches for a given string in the DOM tree. Use getSearchResults to access search results or cancelSearch to end this search session.

PseudoElementAddedEvent

data class PseudoElementAddedEvent : Event

Called when a pseudo element is added to an element.

PseudoElementRemovedEvent

data class PseudoElementRemovedEvent : Event

Called when a pseudo element is removed from an element.

PseudoType

enum class PseudoType

Pseudo element type.

PushNodeByPathToFrontendRequest

data class PushNodeByPathToFrontendRequest

Represents request frame that can be used with DOM#pushNodeByPathToFrontend operation call.

PushNodeByPathToFrontendResponse

data class PushNodeByPathToFrontendResponse

Represents response frame that is returned from DOM#pushNodeByPathToFrontend operation call. Requests that the node is sent to the caller given its path. // FIXME, use XPath

PushNodesByBackendIdsToFrontendRequest

data class PushNodesByBackendIdsToFrontendRequest

Represents request frame that can be used with DOM#pushNodesByBackendIdsToFrontend operation call.

PushNodesByBackendIdsToFrontendResponse

data class PushNodesByBackendIdsToFrontendResponse

Represents response frame that is returned from DOM#pushNodesByBackendIdsToFrontend operation call. Requests that a batch of nodes is sent to the caller given their backend node ids.

QuerySelectorAllRequest

data class QuerySelectorAllRequest

Represents request frame that can be used with DOM#querySelectorAll operation call.

QuerySelectorAllResponse

data class QuerySelectorAllResponse

Represents response frame that is returned from DOM#querySelectorAll operation call. Executes querySelectorAll on a given node.

QuerySelectorRequest

data class QuerySelectorRequest

Represents request frame that can be used with DOM#querySelector operation call.

QuerySelectorResponse

data class QuerySelectorResponse

Represents response frame that is returned from DOM#querySelector operation call. Executes querySelector on a given node.

Rect

data class Rect

Rectangle.

RemoveAttributeRequest

data class RemoveAttributeRequest

Represents request frame that can be used with DOM#removeAttribute operation call.

RemoveNodeRequest

data class RemoveNodeRequest

Represents request frame that can be used with DOM#removeNode operation call.

RequestChildNodesRequest

data class RequestChildNodesRequest

Represents request frame that can be used with DOM#requestChildNodes operation call.

RequestNodeRequest

data class RequestNodeRequest

Represents request frame that can be used with DOM#requestNode operation call.

RequestNodeResponse

data class RequestNodeResponse

Represents response frame that is returned from DOM#requestNode operation call. 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.

ResolveNodeRequest

data class ResolveNodeRequest

Represents request frame that can be used with DOM#resolveNode operation call.

ResolveNodeResponse

data class ResolveNodeResponse

Represents response frame that is returned from DOM#resolveNode operation call. Resolves the JavaScript node object for a given NodeId or BackendNodeId.

RGBA

data class RGBA

A structure holding an RGBA color.

SetAttributesAsTextRequest

data class SetAttributesAsTextRequest

Represents request frame that can be used with DOM#setAttributesAsText operation call.

SetAttributeValueRequest

data class SetAttributeValueRequest

Represents request frame that can be used with DOM#setAttributeValue operation call.

SetChildNodesEvent

data class SetChildNodesEvent : Event

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

SetFileInputFilesRequest

data class SetFileInputFilesRequest

Represents request frame that can be used with DOM#setFileInputFiles operation call.

SetInspectedNodeRequest

data class SetInspectedNodeRequest

Represents request frame that can be used with DOM#setInspectedNode operation call.

SetNodeNameRequest

data class SetNodeNameRequest

Represents request frame that can be used with DOM#setNodeName operation call.

SetNodeNameResponse

data class SetNodeNameResponse

Represents response frame that is returned from DOM#setNodeName operation call. Sets node name for a node with given id.

SetNodeStackTracesEnabledRequest

data class SetNodeStackTracesEnabledRequest

Represents request frame that can be used with DOM#setNodeStackTracesEnabled operation call.

SetNodeValueRequest

data class SetNodeValueRequest

Represents request frame that can be used with DOM#setNodeValue operation call.

SetOuterHTMLRequest

data class SetOuterHTMLRequest

Represents request frame that can be used with DOM#setOuterHTML operation call.

ShadowRootPoppedEvent

data class ShadowRootPoppedEvent : Event

Called when shadow root is popped from the element.

ShadowRootPushedEvent

data class ShadowRootPushedEvent : Event

Called when shadow root is pushed into the element.

ShadowRootType

enum class ShadowRootType

Shadow root type.

ShapeOutsideInfo

data class ShapeOutsideInfo

CSS Shape Outside details.

Type Aliases

BackendNodeId

typealias BackendNodeId = Int

Unique DOM node identifier used to reference a node that may not have been pushed to the front-end.

NodeId

typealias NodeId = Int

Unique DOM node identifier.

Quad

typealias Quad = List<Double>

An array of quad vertices, x immediately followed by y for each point, points clock-wise.