org.openqa.selenium.devtools.v126.dom.DOM Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of selenium-devtools-v126 Show documentation
Show all versions of selenium-devtools-v126 Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
package org.openqa.selenium.devtools.v126.dom;
import org.openqa.selenium.Beta;
import org.openqa.selenium.devtools.Command;
import org.openqa.selenium.devtools.Event;
import org.openqa.selenium.devtools.ConverterFunctions;
import java.util.Map;
import java.util.LinkedHashMap;
import org.openqa.selenium.json.JsonInput;
/**
* 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.
*/
public class DOM {
/**
* Collects class names for the node with given id and all of it's child nodes.
*/
@Beta()
public static Command> collectClassNamesFromSubtree(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
return new Command<>("DOM.collectClassNamesFromSubtree", Map.copyOf(params), ConverterFunctions.map("classNames", input -> input.readArray(java.lang.String.class)));
}
/**
* Creates a deep copy of the specified node and places it into the target container before the
* given anchor.
*/
@Beta()
public static Command copyTo(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, org.openqa.selenium.devtools.v126.dom.model.NodeId targetNodeId, java.util.Optional insertBeforeNodeId) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(targetNodeId, "targetNodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("targetNodeId", targetNodeId);
insertBeforeNodeId.ifPresent(p -> params.put("insertBeforeNodeId", p));
return new Command<>("DOM.copyTo", Map.copyOf(params), ConverterFunctions.map("nodeId", org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
}
/**
* Describes node given its id, does not require domain to be enabled. Does not start tracking any
* objects, can be used for automation.
*/
public static Command describeNode(java.util.Optional nodeId, java.util.Optional backendNodeId, java.util.Optional objectId, java.util.Optional depth, java.util.Optional pierce) {
LinkedHashMap params = new LinkedHashMap<>();
nodeId.ifPresent(p -> params.put("nodeId", p));
backendNodeId.ifPresent(p -> params.put("backendNodeId", p));
objectId.ifPresent(p -> params.put("objectId", p));
depth.ifPresent(p -> params.put("depth", p));
pierce.ifPresent(p -> params.put("pierce", p));
return new Command<>("DOM.describeNode", Map.copyOf(params), ConverterFunctions.map("node", org.openqa.selenium.devtools.v126.dom.model.Node.class));
}
/**
* 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.
*/
public static Command scrollIntoViewIfNeeded(java.util.Optional nodeId, java.util.Optional backendNodeId, java.util.Optional objectId, java.util.Optional rect) {
LinkedHashMap params = new LinkedHashMap<>();
nodeId.ifPresent(p -> params.put("nodeId", p));
backendNodeId.ifPresent(p -> params.put("backendNodeId", p));
objectId.ifPresent(p -> params.put("objectId", p));
rect.ifPresent(p -> params.put("rect", p));
return new Command<>("DOM.scrollIntoViewIfNeeded", Map.copyOf(params));
}
/**
* Disables DOM agent for the given page.
*/
public static Command disable() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOM.disable", Map.copyOf(params));
}
/**
* Discards search results from the session with the given id. `getSearchResults` should no longer
* be called for that search.
*/
@Beta()
public static Command discardSearchResults(java.lang.String searchId) {
java.util.Objects.requireNonNull(searchId, "searchId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("searchId", searchId);
return new Command<>("DOM.discardSearchResults", Map.copyOf(params));
}
public enum EnableIncludeWhitespace {
NONE("none"), ALL("all");
private String value;
EnableIncludeWhitespace(String value) {
this.value = value;
}
public static EnableIncludeWhitespace fromString(String s) {
return java.util.Arrays.stream(EnableIncludeWhitespace.values()).filter(rs -> rs.value.equalsIgnoreCase(s)).findFirst().orElseThrow(() -> new org.openqa.selenium.devtools.DevToolsException("Given value " + s + " is not found within EnableIncludeWhitespace "));
}
public String toString() {
return value;
}
public String toJson() {
return value;
}
private static EnableIncludeWhitespace fromJson(JsonInput input) {
return fromString(input.nextString());
}
}
/**
* Enables DOM agent for the given page.
*/
public static Command enable(java.util.Optional includeWhitespace) {
LinkedHashMap params = new LinkedHashMap<>();
includeWhitespace.ifPresent(p -> params.put("includeWhitespace", p));
return new Command<>("DOM.enable", Map.copyOf(params));
}
/**
* Focuses the given element.
*/
public static Command focus(java.util.Optional nodeId, java.util.Optional backendNodeId, java.util.Optional objectId) {
LinkedHashMap params = new LinkedHashMap<>();
nodeId.ifPresent(p -> params.put("nodeId", p));
backendNodeId.ifPresent(p -> params.put("backendNodeId", p));
objectId.ifPresent(p -> params.put("objectId", p));
return new Command<>("DOM.focus", Map.copyOf(params));
}
/**
* Returns attributes for the specified node.
*/
public static Command> getAttributes(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
return new Command<>("DOM.getAttributes", Map.copyOf(params), ConverterFunctions.map("attributes", input -> input.readArray(java.lang.String.class)));
}
/**
* Returns boxes for the given node.
*/
public static Command getBoxModel(java.util.Optional nodeId, java.util.Optional backendNodeId, java.util.Optional objectId) {
LinkedHashMap params = new LinkedHashMap<>();
nodeId.ifPresent(p -> params.put("nodeId", p));
backendNodeId.ifPresent(p -> params.put("backendNodeId", p));
objectId.ifPresent(p -> params.put("objectId", p));
return new Command<>("DOM.getBoxModel", Map.copyOf(params), ConverterFunctions.map("model", org.openqa.selenium.devtools.v126.dom.model.BoxModel.class));
}
/**
* Returns quads that describe node position on the page. This method
* might return multiple quads for inline nodes.
*/
@Beta()
public static Command> getContentQuads(java.util.Optional nodeId, java.util.Optional backendNodeId, java.util.Optional objectId) {
LinkedHashMap params = new LinkedHashMap<>();
nodeId.ifPresent(p -> params.put("nodeId", p));
backendNodeId.ifPresent(p -> params.put("backendNodeId", p));
objectId.ifPresent(p -> params.put("objectId", p));
return new Command<>("DOM.getContentQuads", Map.copyOf(params), ConverterFunctions.map("quads", input -> input.readArray(org.openqa.selenium.devtools.v126.dom.model.Quad.class)));
}
/**
* Returns the root DOM node (and optionally the subtree) to the caller.
* Implicitly enables the DOM domain events for the current target.
*/
public static Command getDocument(java.util.Optional depth, java.util.Optional pierce) {
LinkedHashMap params = new LinkedHashMap<>();
depth.ifPresent(p -> params.put("depth", p));
pierce.ifPresent(p -> params.put("pierce", p));
return new Command<>("DOM.getDocument", Map.copyOf(params), ConverterFunctions.map("root", org.openqa.selenium.devtools.v126.dom.model.Node.class));
}
/**
* 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.
*/
@Deprecated()
public static Command> getFlattenedDocument(java.util.Optional depth, java.util.Optional pierce) {
LinkedHashMap params = new LinkedHashMap<>();
depth.ifPresent(p -> params.put("depth", p));
pierce.ifPresent(p -> params.put("pierce", p));
return new Command<>("DOM.getFlattenedDocument", Map.copyOf(params), ConverterFunctions.map("nodes", input -> input.readArray(org.openqa.selenium.devtools.v126.dom.model.Node.class)));
}
/**
* Finds nodes with a given computed style in a subtree.
*/
@Beta()
public static Command> getNodesForSubtreeByStyle(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.util.List computedStyles, java.util.Optional pierce) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(computedStyles, "computedStyles is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("computedStyles", computedStyles);
pierce.ifPresent(p -> params.put("pierce", p));
return new Command<>("DOM.getNodesForSubtreeByStyle", Map.copyOf(params), ConverterFunctions.map("nodeIds", input -> input.readArray(org.openqa.selenium.devtools.v126.dom.model.NodeId.class)));
}
public static class GetNodeForLocationResponse {
private final org.openqa.selenium.devtools.v126.dom.model.BackendNodeId backendNodeId;
private final org.openqa.selenium.devtools.v126.page.model.FrameId frameId;
private final java.util.Optional nodeId;
public GetNodeForLocationResponse(org.openqa.selenium.devtools.v126.dom.model.BackendNodeId backendNodeId, org.openqa.selenium.devtools.v126.page.model.FrameId frameId, java.util.Optional nodeId) {
this.backendNodeId = java.util.Objects.requireNonNull(backendNodeId, "backendNodeId is required");
this.frameId = java.util.Objects.requireNonNull(frameId, "frameId is required");
this.nodeId = nodeId;
}
/**
* Resulting node.
*/
public org.openqa.selenium.devtools.v126.dom.model.BackendNodeId getBackendNodeId() {
return backendNodeId;
}
/**
* Frame this node belongs to.
*/
public org.openqa.selenium.devtools.v126.page.model.FrameId getFrameId() {
return frameId;
}
/**
* Id of the node at given coordinates, only when enabled and requested document.
*/
public java.util.Optional getNodeId() {
return nodeId;
}
private static GetNodeForLocationResponse fromJson(JsonInput input) {
org.openqa.selenium.devtools.v126.dom.model.BackendNodeId backendNodeId = null;
org.openqa.selenium.devtools.v126.page.model.FrameId frameId = null;
java.util.Optional nodeId = java.util.Optional.empty();
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "backendNodeId":
backendNodeId = input.read(org.openqa.selenium.devtools.v126.dom.model.BackendNodeId.class);
break;
case "frameId":
frameId = input.read(org.openqa.selenium.devtools.v126.page.model.FrameId.class);
break;
case "nodeId":
nodeId = java.util.Optional.ofNullable(input.read(org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new GetNodeForLocationResponse(backendNodeId, frameId, nodeId);
}
}
/**
* Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is
* either returned or not.
*/
public static Command getNodeForLocation(java.lang.Integer x, java.lang.Integer y, java.util.Optional includeUserAgentShadowDOM, java.util.Optional ignorePointerEventsNone) {
java.util.Objects.requireNonNull(x, "x is required");
java.util.Objects.requireNonNull(y, "y is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("x", x);
params.put("y", y);
includeUserAgentShadowDOM.ifPresent(p -> params.put("includeUserAgentShadowDOM", p));
ignorePointerEventsNone.ifPresent(p -> params.put("ignorePointerEventsNone", p));
return new Command<>("DOM.getNodeForLocation", Map.copyOf(params), input -> input.read(org.openqa.selenium.devtools.v126.dom.DOM.GetNodeForLocationResponse.class));
}
/**
* Returns node's HTML markup.
*/
public static Command getOuterHTML(java.util.Optional nodeId, java.util.Optional backendNodeId, java.util.Optional objectId) {
LinkedHashMap params = new LinkedHashMap<>();
nodeId.ifPresent(p -> params.put("nodeId", p));
backendNodeId.ifPresent(p -> params.put("backendNodeId", p));
objectId.ifPresent(p -> params.put("objectId", p));
return new Command<>("DOM.getOuterHTML", Map.copyOf(params), ConverterFunctions.map("outerHTML", java.lang.String.class));
}
/**
* Returns the id of the nearest ancestor that is a relayout boundary.
*/
@Beta()
public static Command getRelayoutBoundary(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
return new Command<>("DOM.getRelayoutBoundary", Map.copyOf(params), ConverterFunctions.map("nodeId", org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
}
/**
* Returns search results from given `fromIndex` to given `toIndex` from the search with the given
* identifier.
*/
@Beta()
public static Command> getSearchResults(java.lang.String searchId, java.lang.Integer fromIndex, java.lang.Integer toIndex) {
java.util.Objects.requireNonNull(searchId, "searchId is required");
java.util.Objects.requireNonNull(fromIndex, "fromIndex is required");
java.util.Objects.requireNonNull(toIndex, "toIndex is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("searchId", searchId);
params.put("fromIndex", fromIndex);
params.put("toIndex", toIndex);
return new Command<>("DOM.getSearchResults", Map.copyOf(params), ConverterFunctions.map("nodeIds", input -> input.readArray(org.openqa.selenium.devtools.v126.dom.model.NodeId.class)));
}
/**
* Hides any highlight.
*/
public static Command hideHighlight() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOM.hideHighlight", Map.copyOf(params));
}
/**
* Highlights DOM node.
*/
public static Command highlightNode() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOM.highlightNode", Map.copyOf(params));
}
/**
* Highlights given rectangle.
*/
public static Command highlightRect() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOM.highlightRect", Map.copyOf(params));
}
/**
* Marks last undoable state.
*/
@Beta()
public static Command markUndoableState() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOM.markUndoableState", Map.copyOf(params));
}
/**
* Moves node into the new container, places it before the given anchor.
*/
public static Command moveTo(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, org.openqa.selenium.devtools.v126.dom.model.NodeId targetNodeId, java.util.Optional insertBeforeNodeId) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(targetNodeId, "targetNodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("targetNodeId", targetNodeId);
insertBeforeNodeId.ifPresent(p -> params.put("insertBeforeNodeId", p));
return new Command<>("DOM.moveTo", Map.copyOf(params), ConverterFunctions.map("nodeId", org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
}
public static class PerformSearchResponse {
private final java.lang.String searchId;
private final java.lang.Integer resultCount;
public PerformSearchResponse(java.lang.String searchId, java.lang.Integer resultCount) {
this.searchId = java.util.Objects.requireNonNull(searchId, "searchId is required");
this.resultCount = java.util.Objects.requireNonNull(resultCount, "resultCount is required");
}
/**
* Unique search session identifier.
*/
public java.lang.String getSearchId() {
return searchId;
}
/**
* Number of search results.
*/
public java.lang.Integer getResultCount() {
return resultCount;
}
private static PerformSearchResponse fromJson(JsonInput input) {
java.lang.String searchId = null;
java.lang.Integer resultCount = 0;
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "searchId":
searchId = input.nextString();
break;
case "resultCount":
resultCount = input.nextNumber().intValue();
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new PerformSearchResponse(searchId, resultCount);
}
}
/**
* Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or
* `cancelSearch` to end this search session.
*/
@Beta()
public static Command performSearch(java.lang.String query, java.util.Optional includeUserAgentShadowDOM) {
java.util.Objects.requireNonNull(query, "query is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("query", query);
includeUserAgentShadowDOM.ifPresent(p -> params.put("includeUserAgentShadowDOM", p));
return new Command<>("DOM.performSearch", Map.copyOf(params), input -> input.read(org.openqa.selenium.devtools.v126.dom.DOM.PerformSearchResponse.class));
}
/**
* Requests that the node is sent to the caller given its path. // FIXME, use XPath
*/
@Beta()
public static Command pushNodeByPathToFrontend(java.lang.String path) {
java.util.Objects.requireNonNull(path, "path is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("path", path);
return new Command<>("DOM.pushNodeByPathToFrontend", Map.copyOf(params), ConverterFunctions.map("nodeId", org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
}
/**
* Requests that a batch of nodes is sent to the caller given their backend node ids.
*/
@Beta()
public static Command> pushNodesByBackendIdsToFrontend(java.util.List backendNodeIds) {
java.util.Objects.requireNonNull(backendNodeIds, "backendNodeIds is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("backendNodeIds", backendNodeIds);
return new Command<>("DOM.pushNodesByBackendIdsToFrontend", Map.copyOf(params), ConverterFunctions.map("nodeIds", input -> input.readArray(org.openqa.selenium.devtools.v126.dom.model.NodeId.class)));
}
/**
* Executes `querySelector` on a given node.
*/
public static Command querySelector(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.lang.String selector) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(selector, "selector is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("selector", selector);
return new Command<>("DOM.querySelector", Map.copyOf(params), ConverterFunctions.map("nodeId", org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
}
/**
* Executes `querySelectorAll` on a given node.
*/
public static Command> querySelectorAll(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.lang.String selector) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(selector, "selector is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("selector", selector);
return new Command<>("DOM.querySelectorAll", Map.copyOf(params), ConverterFunctions.map("nodeIds", input -> input.readArray(org.openqa.selenium.devtools.v126.dom.model.NodeId.class)));
}
/**
* 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.
*/
@Beta()
public static Command> getTopLayerElements() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOM.getTopLayerElements", Map.copyOf(params), ConverterFunctions.map("nodeIds", input -> input.readArray(org.openqa.selenium.devtools.v126.dom.model.NodeId.class)));
}
public enum GetElementByRelationRelation {
POPOVERTARGET("PopoverTarget");
private String value;
GetElementByRelationRelation(String value) {
this.value = value;
}
public static GetElementByRelationRelation fromString(String s) {
return java.util.Arrays.stream(GetElementByRelationRelation.values()).filter(rs -> rs.value.equalsIgnoreCase(s)).findFirst().orElseThrow(() -> new org.openqa.selenium.devtools.DevToolsException("Given value " + s + " is not found within GetElementByRelationRelation "));
}
public String toString() {
return value;
}
public String toJson() {
return value;
}
private static GetElementByRelationRelation fromJson(JsonInput input) {
return fromString(input.nextString());
}
}
/**
* Returns the NodeId of the matched element according to certain relations.
*/
@Beta()
public static Command getElementByRelation(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, GetElementByRelationRelation relation) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(relation, "relation is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("relation", relation);
return new Command<>("DOM.getElementByRelation", Map.copyOf(params), ConverterFunctions.map("nodeId", org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
}
/**
* Re-does the last undone action.
*/
@Beta()
public static Command redo() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOM.redo", Map.copyOf(params));
}
/**
* Removes attribute with given name from an element with given id.
*/
public static Command removeAttribute(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.lang.String name) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(name, "name is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("name", name);
return new Command<>("DOM.removeAttribute", Map.copyOf(params));
}
/**
* Removes node with given id.
*/
public static Command removeNode(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
return new Command<>("DOM.removeNode", Map.copyOf(params));
}
/**
* 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.
*/
public static Command requestChildNodes(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.util.Optional depth, java.util.Optional pierce) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
depth.ifPresent(p -> params.put("depth", p));
pierce.ifPresent(p -> params.put("pierce", p));
return new Command<>("DOM.requestChildNodes", Map.copyOf(params));
}
/**
* 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.
*/
public static Command requestNode(org.openqa.selenium.devtools.v126.runtime.model.RemoteObjectId objectId) {
java.util.Objects.requireNonNull(objectId, "objectId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("objectId", objectId);
return new Command<>("DOM.requestNode", Map.copyOf(params), ConverterFunctions.map("nodeId", org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
}
/**
* Resolves the JavaScript node object for a given NodeId or BackendNodeId.
*/
public static Command resolveNode(java.util.Optional nodeId, java.util.Optional backendNodeId, java.util.Optional objectGroup, java.util.Optional executionContextId) {
LinkedHashMap params = new LinkedHashMap<>();
nodeId.ifPresent(p -> params.put("nodeId", p));
backendNodeId.ifPresent(p -> params.put("backendNodeId", p));
objectGroup.ifPresent(p -> params.put("objectGroup", p));
executionContextId.ifPresent(p -> params.put("executionContextId", p));
return new Command<>("DOM.resolveNode", Map.copyOf(params), ConverterFunctions.map("object", org.openqa.selenium.devtools.v126.runtime.model.RemoteObject.class));
}
/**
* Sets attribute for an element with given id.
*/
public static Command setAttributeValue(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.lang.String name, java.lang.String value) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(name, "name is required");
java.util.Objects.requireNonNull(value, "value is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("name", name);
params.put("value", value);
return new Command<>("DOM.setAttributeValue", Map.copyOf(params));
}
/**
* 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.
*/
public static Command setAttributesAsText(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.lang.String text, java.util.Optional name) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(text, "text is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("text", text);
name.ifPresent(p -> params.put("name", p));
return new Command<>("DOM.setAttributesAsText", Map.copyOf(params));
}
/**
* Sets files for the given file input element.
*/
public static Command setFileInputFiles(java.util.List files, java.util.Optional nodeId, java.util.Optional backendNodeId, java.util.Optional objectId) {
java.util.Objects.requireNonNull(files, "files is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("files", files);
nodeId.ifPresent(p -> params.put("nodeId", p));
backendNodeId.ifPresent(p -> params.put("backendNodeId", p));
objectId.ifPresent(p -> params.put("objectId", p));
return new Command<>("DOM.setFileInputFiles", Map.copyOf(params));
}
/**
* Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
*/
@Beta()
public static Command setNodeStackTracesEnabled(java.lang.Boolean enable) {
java.util.Objects.requireNonNull(enable, "enable is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("enable", enable);
return new Command<>("DOM.setNodeStackTracesEnabled", Map.copyOf(params));
}
/**
* Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
*/
@Beta()
public static Command getNodeStackTraces(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
return new Command<>("DOM.getNodeStackTraces", Map.copyOf(params), ConverterFunctions.map("creation", org.openqa.selenium.devtools.v126.runtime.model.StackTrace.class));
}
/**
* Returns file information for the given
* File wrapper.
*/
@Beta()
public static Command getFileInfo(org.openqa.selenium.devtools.v126.runtime.model.RemoteObjectId objectId) {
java.util.Objects.requireNonNull(objectId, "objectId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("objectId", objectId);
return new Command<>("DOM.getFileInfo", Map.copyOf(params), ConverterFunctions.map("path", java.lang.String.class));
}
/**
* Enables console to refer to the node with given id via $x (see Command Line API for more details
* $x functions).
*/
@Beta()
public static Command setInspectedNode(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
return new Command<>("DOM.setInspectedNode", Map.copyOf(params));
}
/**
* Sets node name for a node with given id.
*/
public static Command setNodeName(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.lang.String name) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(name, "name is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("name", name);
return new Command<>("DOM.setNodeName", Map.copyOf(params), ConverterFunctions.map("nodeId", org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
}
/**
* Sets node value for a node with given id.
*/
public static Command setNodeValue(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.lang.String value) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(value, "value is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("value", value);
return new Command<>("DOM.setNodeValue", Map.copyOf(params));
}
/**
* Sets node HTML markup, returns new node id.
*/
public static Command setOuterHTML(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.lang.String outerHTML) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
java.util.Objects.requireNonNull(outerHTML, "outerHTML is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
params.put("outerHTML", outerHTML);
return new Command<>("DOM.setOuterHTML", Map.copyOf(params));
}
/**
* Undoes the last performed action.
*/
@Beta()
public static Command undo() {
LinkedHashMap params = new LinkedHashMap<>();
return new Command<>("DOM.undo", Map.copyOf(params));
}
public static class GetFrameOwnerResponse {
private final org.openqa.selenium.devtools.v126.dom.model.BackendNodeId backendNodeId;
private final java.util.Optional nodeId;
public GetFrameOwnerResponse(org.openqa.selenium.devtools.v126.dom.model.BackendNodeId backendNodeId, java.util.Optional nodeId) {
this.backendNodeId = java.util.Objects.requireNonNull(backendNodeId, "backendNodeId is required");
this.nodeId = nodeId;
}
/**
* Resulting node.
*/
public org.openqa.selenium.devtools.v126.dom.model.BackendNodeId getBackendNodeId() {
return backendNodeId;
}
/**
* Id of the node at given coordinates, only when enabled and requested document.
*/
public java.util.Optional getNodeId() {
return nodeId;
}
private static GetFrameOwnerResponse fromJson(JsonInput input) {
org.openqa.selenium.devtools.v126.dom.model.BackendNodeId backendNodeId = null;
java.util.Optional nodeId = java.util.Optional.empty();
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "backendNodeId":
backendNodeId = input.read(org.openqa.selenium.devtools.v126.dom.model.BackendNodeId.class);
break;
case "nodeId":
nodeId = java.util.Optional.ofNullable(input.read(org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new GetFrameOwnerResponse(backendNodeId, nodeId);
}
}
/**
* Returns iframe node that owns iframe with the given domain.
*/
@Beta()
public static Command getFrameOwner(org.openqa.selenium.devtools.v126.page.model.FrameId frameId) {
java.util.Objects.requireNonNull(frameId, "frameId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("frameId", frameId);
return new Command<>("DOM.getFrameOwner", Map.copyOf(params), input -> input.read(org.openqa.selenium.devtools.v126.dom.DOM.GetFrameOwnerResponse.class));
}
/**
* Returns the query container of the given node based on container query
* conditions: containerName, physical, and logical axes. If no axes are
* provided, the style container is returned, which is the direct parent or the
* closest element with a matching container-name.
*/
@Beta()
public static Command getContainerForNode(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId, java.util.Optional containerName, java.util.Optional physicalAxes, java.util.Optional logicalAxes) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
containerName.ifPresent(p -> params.put("containerName", p));
physicalAxes.ifPresent(p -> params.put("physicalAxes", p));
logicalAxes.ifPresent(p -> params.put("logicalAxes", p));
return new Command<>("DOM.getContainerForNode", Map.copyOf(params), ConverterFunctions.map("nodeId", org.openqa.selenium.devtools.v126.dom.model.NodeId.class));
}
/**
* Returns the descendants of a container query container that have
* container queries against this container.
*/
@Beta()
public static Command> getQueryingDescendantsForContainer(org.openqa.selenium.devtools.v126.dom.model.NodeId nodeId) {
java.util.Objects.requireNonNull(nodeId, "nodeId is required");
LinkedHashMap params = new LinkedHashMap<>();
params.put("nodeId", nodeId);
return new Command<>("DOM.getQueryingDescendantsForContainer", Map.copyOf(params), ConverterFunctions.map("nodeIds", input -> input.readArray(org.openqa.selenium.devtools.v126.dom.model.NodeId.class)));
}
public static Event attributeModified() {
return new Event<>("DOM.attributeModified", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.AttributeModified.class));
}
public static Event attributeRemoved() {
return new Event<>("DOM.attributeRemoved", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.AttributeRemoved.class));
}
public static Event characterDataModified() {
return new Event<>("DOM.characterDataModified", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.CharacterDataModified.class));
}
public static Event childNodeCountUpdated() {
return new Event<>("DOM.childNodeCountUpdated", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.ChildNodeCountUpdated.class));
}
public static Event childNodeInserted() {
return new Event<>("DOM.childNodeInserted", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.ChildNodeInserted.class));
}
public static Event childNodeRemoved() {
return new Event<>("DOM.childNodeRemoved", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.ChildNodeRemoved.class));
}
public static Event distributedNodesUpdated() {
return new Event<>("DOM.distributedNodesUpdated", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.DistributedNodesUpdated.class));
}
public static Event documentUpdated() {
return new Event<>("DOM.documentUpdated", ConverterFunctions.empty());
}
public static Event> inlineStyleInvalidated() {
return new Event<>("DOM.inlineStyleInvalidated", ConverterFunctions.map("nodeIds", input -> input.readArray(org.openqa.selenium.devtools.v126.dom.model.NodeId.class)));
}
public static Event pseudoElementAdded() {
return new Event<>("DOM.pseudoElementAdded", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.PseudoElementAdded.class));
}
public static Event topLayerElementsUpdated() {
return new Event<>("DOM.topLayerElementsUpdated", ConverterFunctions.empty());
}
public static Event pseudoElementRemoved() {
return new Event<>("DOM.pseudoElementRemoved", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.PseudoElementRemoved.class));
}
public static Event setChildNodes() {
return new Event<>("DOM.setChildNodes", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.SetChildNodes.class));
}
public static Event shadowRootPopped() {
return new Event<>("DOM.shadowRootPopped", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.ShadowRootPopped.class));
}
public static Event shadowRootPushed() {
return new Event<>("DOM.shadowRootPushed", input -> input.read(org.openqa.selenium.devtools.v126.dom.model.ShadowRootPushed.class));
}
}