org.openqa.selenium.devtools.v84.runtime.Runtime Maven / Gradle / Ivy
package org.openqa.selenium.devtools.v84.runtime;
import org.openqa.selenium.Beta;
import org.openqa.selenium.devtools.Command;
import org.openqa.selenium.devtools.Event;
import org.openqa.selenium.devtools.ConverterFunctions;
import com.google.common.collect.ImmutableMap;
import org.openqa.selenium.json.JsonInput;
/**
* Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects.
* Evaluation results are returned as mirror object that expose object type, string representation
* and unique identifier that can be used for further object reference. Original objects are
* maintained in memory unless they are either explicitly released or are released along with the
* other objects in their object group.
*/
public class Runtime {
public static class AwaitPromiseResponse {
private final org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result;
private final java.util.Optional exceptionDetails;
public AwaitPromiseResponse(org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result, java.util.Optional exceptionDetails) {
this.result = java.util.Objects.requireNonNull(result, "result is required");
this.exceptionDetails = exceptionDetails;
}
/**
* Promise result. Will contain rejected value if promise was rejected.
*/
public org.openqa.selenium.devtools.v84.runtime.model.RemoteObject getResult() {
return result;
}
/**
* Exception details if stack strace is available.
*/
public java.util.Optional getExceptionDetails() {
return exceptionDetails;
}
private static AwaitPromiseResponse fromJson(JsonInput input) {
org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result = null;
java.util.Optional exceptionDetails = java.util.Optional.empty();
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "result":
result = input.read(org.openqa.selenium.devtools.v84.runtime.model.RemoteObject.class);
break;
case "exceptionDetails":
exceptionDetails = java.util.Optional.ofNullable(input.read(org.openqa.selenium.devtools.v84.runtime.model.ExceptionDetails.class));
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new AwaitPromiseResponse(result, exceptionDetails);
}
}
/**
* Add handler to promise with given promise object id.
*/
public static Command awaitPromise(org.openqa.selenium.devtools.v84.runtime.model.RemoteObjectId promiseObjectId, java.util.Optional returnByValue, java.util.Optional generatePreview) {
java.util.Objects.requireNonNull(promiseObjectId, "promiseObjectId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("promiseObjectId", promiseObjectId);
returnByValue.ifPresent(p -> params.put("returnByValue", p));
generatePreview.ifPresent(p -> params.put("generatePreview", p));
return new Command<>("Runtime.awaitPromise", params.build(), input -> input.read(org.openqa.selenium.devtools.v84.runtime.Runtime.AwaitPromiseResponse.class));
}
public static class CallFunctionOnResponse {
private final org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result;
private final java.util.Optional exceptionDetails;
public CallFunctionOnResponse(org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result, java.util.Optional exceptionDetails) {
this.result = java.util.Objects.requireNonNull(result, "result is required");
this.exceptionDetails = exceptionDetails;
}
/**
* Call result.
*/
public org.openqa.selenium.devtools.v84.runtime.model.RemoteObject getResult() {
return result;
}
/**
* Exception details.
*/
public java.util.Optional getExceptionDetails() {
return exceptionDetails;
}
private static CallFunctionOnResponse fromJson(JsonInput input) {
org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result = null;
java.util.Optional exceptionDetails = java.util.Optional.empty();
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "result":
result = input.read(org.openqa.selenium.devtools.v84.runtime.model.RemoteObject.class);
break;
case "exceptionDetails":
exceptionDetails = java.util.Optional.ofNullable(input.read(org.openqa.selenium.devtools.v84.runtime.model.ExceptionDetails.class));
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new CallFunctionOnResponse(result, exceptionDetails);
}
}
/**
* Calls function with given declaration on the given object. Object group of the result is
* inherited from the target object.
*/
public static Command callFunctionOn(java.lang.String functionDeclaration, java.util.Optional objectId, java.util.Optional> arguments, java.util.Optional silent, java.util.Optional returnByValue, java.util.Optional generatePreview, java.util.Optional userGesture, java.util.Optional awaitPromise, java.util.Optional executionContextId, java.util.Optional objectGroup) {
java.util.Objects.requireNonNull(functionDeclaration, "functionDeclaration is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("functionDeclaration", functionDeclaration);
objectId.ifPresent(p -> params.put("objectId", p));
arguments.ifPresent(p -> params.put("arguments", p));
silent.ifPresent(p -> params.put("silent", p));
returnByValue.ifPresent(p -> params.put("returnByValue", p));
generatePreview.ifPresent(p -> params.put("generatePreview", p));
userGesture.ifPresent(p -> params.put("userGesture", p));
awaitPromise.ifPresent(p -> params.put("awaitPromise", p));
executionContextId.ifPresent(p -> params.put("executionContextId", p));
objectGroup.ifPresent(p -> params.put("objectGroup", p));
return new Command<>("Runtime.callFunctionOn", params.build(), input -> input.read(org.openqa.selenium.devtools.v84.runtime.Runtime.CallFunctionOnResponse.class));
}
public static class CompileScriptResponse {
private final java.util.Optional scriptId;
private final java.util.Optional exceptionDetails;
public CompileScriptResponse(java.util.Optional scriptId, java.util.Optional exceptionDetails) {
this.scriptId = scriptId;
this.exceptionDetails = exceptionDetails;
}
/**
* Id of the script.
*/
public java.util.Optional getScriptId() {
return scriptId;
}
/**
* Exception details.
*/
public java.util.Optional getExceptionDetails() {
return exceptionDetails;
}
private static CompileScriptResponse fromJson(JsonInput input) {
java.util.Optional scriptId = java.util.Optional.empty();
java.util.Optional exceptionDetails = java.util.Optional.empty();
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "scriptId":
scriptId = java.util.Optional.ofNullable(input.read(org.openqa.selenium.devtools.v84.runtime.model.ScriptId.class));
break;
case "exceptionDetails":
exceptionDetails = java.util.Optional.ofNullable(input.read(org.openqa.selenium.devtools.v84.runtime.model.ExceptionDetails.class));
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new CompileScriptResponse(scriptId, exceptionDetails);
}
}
/**
* Compiles expression.
*/
public static Command compileScript(java.lang.String expression, java.lang.String sourceURL, java.lang.Boolean persistScript, java.util.Optional executionContextId) {
java.util.Objects.requireNonNull(expression, "expression is required");
java.util.Objects.requireNonNull(sourceURL, "sourceURL is required");
java.util.Objects.requireNonNull(persistScript, "persistScript is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("expression", expression);
params.put("sourceURL", sourceURL);
params.put("persistScript", persistScript);
executionContextId.ifPresent(p -> params.put("executionContextId", p));
return new Command<>("Runtime.compileScript", params.build(), input -> input.read(org.openqa.selenium.devtools.v84.runtime.Runtime.CompileScriptResponse.class));
}
/**
* Disables reporting of execution contexts creation.
*/
public static Command disable() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Runtime.disable", params.build());
}
/**
* Discards collected exceptions and console API calls.
*/
public static Command discardConsoleEntries() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Runtime.discardConsoleEntries", params.build());
}
/**
* Enables reporting of execution contexts creation by means of `executionContextCreated` event.
* When the reporting gets enabled the event will be sent immediately for each existing execution
* context.
*/
public static Command enable() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Runtime.enable", params.build());
}
public static class EvaluateResponse {
private final org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result;
private final java.util.Optional exceptionDetails;
public EvaluateResponse(org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result, java.util.Optional exceptionDetails) {
this.result = java.util.Objects.requireNonNull(result, "result is required");
this.exceptionDetails = exceptionDetails;
}
/**
* Evaluation result.
*/
public org.openqa.selenium.devtools.v84.runtime.model.RemoteObject getResult() {
return result;
}
/**
* Exception details.
*/
public java.util.Optional getExceptionDetails() {
return exceptionDetails;
}
private static EvaluateResponse fromJson(JsonInput input) {
org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result = null;
java.util.Optional exceptionDetails = java.util.Optional.empty();
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "result":
result = input.read(org.openqa.selenium.devtools.v84.runtime.model.RemoteObject.class);
break;
case "exceptionDetails":
exceptionDetails = java.util.Optional.ofNullable(input.read(org.openqa.selenium.devtools.v84.runtime.model.ExceptionDetails.class));
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new EvaluateResponse(result, exceptionDetails);
}
}
/**
* Evaluates expression on global object.
*/
public static Command evaluate(java.lang.String expression, java.util.Optional objectGroup, java.util.Optional includeCommandLineAPI, java.util.Optional silent, java.util.Optional contextId, java.util.Optional returnByValue, java.util.Optional generatePreview, java.util.Optional userGesture, java.util.Optional awaitPromise, java.util.Optional throwOnSideEffect, java.util.Optional timeout, java.util.Optional disableBreaks, java.util.Optional replMode) {
java.util.Objects.requireNonNull(expression, "expression is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("expression", expression);
objectGroup.ifPresent(p -> params.put("objectGroup", p));
includeCommandLineAPI.ifPresent(p -> params.put("includeCommandLineAPI", p));
silent.ifPresent(p -> params.put("silent", p));
contextId.ifPresent(p -> params.put("contextId", p));
returnByValue.ifPresent(p -> params.put("returnByValue", p));
generatePreview.ifPresent(p -> params.put("generatePreview", p));
userGesture.ifPresent(p -> params.put("userGesture", p));
awaitPromise.ifPresent(p -> params.put("awaitPromise", p));
throwOnSideEffect.ifPresent(p -> params.put("throwOnSideEffect", p));
timeout.ifPresent(p -> params.put("timeout", p));
disableBreaks.ifPresent(p -> params.put("disableBreaks", p));
replMode.ifPresent(p -> params.put("replMode", p));
return new Command<>("Runtime.evaluate", params.build(), input -> input.read(org.openqa.selenium.devtools.v84.runtime.Runtime.EvaluateResponse.class));
}
/**
* Returns the isolate id.
*/
@Beta()
public static Command getIsolateId() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Runtime.getIsolateId", params.build(), ConverterFunctions.map("id", java.lang.String.class));
}
public static class GetHeapUsageResponse {
private final java.lang.Number usedSize;
private final java.lang.Number totalSize;
public GetHeapUsageResponse(java.lang.Number usedSize, java.lang.Number totalSize) {
this.usedSize = java.util.Objects.requireNonNull(usedSize, "usedSize is required");
this.totalSize = java.util.Objects.requireNonNull(totalSize, "totalSize is required");
}
/**
* Used heap size in bytes.
*/
public java.lang.Number getUsedSize() {
return usedSize;
}
/**
* Allocated heap size in bytes.
*/
public java.lang.Number getTotalSize() {
return totalSize;
}
private static GetHeapUsageResponse fromJson(JsonInput input) {
java.lang.Number usedSize = 0;
java.lang.Number totalSize = 0;
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "usedSize":
usedSize = input.nextNumber();
break;
case "totalSize":
totalSize = input.nextNumber();
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new GetHeapUsageResponse(usedSize, totalSize);
}
}
/**
* Returns the JavaScript heap usage.
* It is the total usage of the corresponding isolate not scoped to a particular Runtime.
*/
@Beta()
public static Command getHeapUsage() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Runtime.getHeapUsage", params.build(), input -> input.read(org.openqa.selenium.devtools.v84.runtime.Runtime.GetHeapUsageResponse.class));
}
public static class GetPropertiesResponse {
private final java.util.List result;
private final java.util.Optional> internalProperties;
private final java.util.Optional> privateProperties;
private final java.util.Optional exceptionDetails;
public GetPropertiesResponse(java.util.List result, java.util.Optional> internalProperties, java.util.Optional> privateProperties, java.util.Optional exceptionDetails) {
this.result = java.util.Objects.requireNonNull(result, "result is required");
this.internalProperties = internalProperties;
this.privateProperties = privateProperties;
this.exceptionDetails = exceptionDetails;
}
/**
* Object properties.
*/
public java.util.List getResult() {
return result;
}
/**
* Internal object properties (only of the element itself).
*/
public java.util.Optional> getInternalProperties() {
return internalProperties;
}
/**
* Object private properties.
*/
public java.util.Optional> getPrivateProperties() {
return privateProperties;
}
/**
* Exception details.
*/
public java.util.Optional getExceptionDetails() {
return exceptionDetails;
}
private static GetPropertiesResponse fromJson(JsonInput input) {
java.util.List result = null;
java.util.Optional> internalProperties = java.util.Optional.empty();
java.util.Optional> privateProperties = java.util.Optional.empty();
java.util.Optional exceptionDetails = java.util.Optional.empty();
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "result":
result = input.read(new com.google.common.reflect.TypeToken>() {
}.getType());
break;
case "internalProperties":
internalProperties = java.util.Optional.ofNullable(input.read(new com.google.common.reflect.TypeToken>() {
}.getType()));
break;
case "privateProperties":
privateProperties = java.util.Optional.ofNullable(input.read(new com.google.common.reflect.TypeToken>() {
}.getType()));
break;
case "exceptionDetails":
exceptionDetails = java.util.Optional.ofNullable(input.read(org.openqa.selenium.devtools.v84.runtime.model.ExceptionDetails.class));
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new GetPropertiesResponse(result, internalProperties, privateProperties, exceptionDetails);
}
}
/**
* Returns properties of a given object. Object group of the result is inherited from the target
* object.
*/
public static Command getProperties(org.openqa.selenium.devtools.v84.runtime.model.RemoteObjectId objectId, java.util.Optional ownProperties, java.util.Optional accessorPropertiesOnly, java.util.Optional generatePreview) {
java.util.Objects.requireNonNull(objectId, "objectId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("objectId", objectId);
ownProperties.ifPresent(p -> params.put("ownProperties", p));
accessorPropertiesOnly.ifPresent(p -> params.put("accessorPropertiesOnly", p));
generatePreview.ifPresent(p -> params.put("generatePreview", p));
return new Command<>("Runtime.getProperties", params.build(), input -> input.read(org.openqa.selenium.devtools.v84.runtime.Runtime.GetPropertiesResponse.class));
}
/**
* Returns all let, const and class variables from global scope.
*/
public static Command> globalLexicalScopeNames(java.util.Optional executionContextId) {
ImmutableMap.Builder params = ImmutableMap.builder();
executionContextId.ifPresent(p -> params.put("executionContextId", p));
return new Command<>("Runtime.globalLexicalScopeNames", params.build(), ConverterFunctions.map("names", new com.google.common.reflect.TypeToken>() {
}.getType()));
}
public static Command queryObjects(org.openqa.selenium.devtools.v84.runtime.model.RemoteObjectId prototypeObjectId, java.util.Optional objectGroup) {
java.util.Objects.requireNonNull(prototypeObjectId, "prototypeObjectId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("prototypeObjectId", prototypeObjectId);
objectGroup.ifPresent(p -> params.put("objectGroup", p));
return new Command<>("Runtime.queryObjects", params.build(), ConverterFunctions.map("objects", org.openqa.selenium.devtools.v84.runtime.model.RemoteObject.class));
}
/**
* Releases remote object with given id.
*/
public static Command releaseObject(org.openqa.selenium.devtools.v84.runtime.model.RemoteObjectId objectId) {
java.util.Objects.requireNonNull(objectId, "objectId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("objectId", objectId);
return new Command<>("Runtime.releaseObject", params.build());
}
/**
* Releases all remote objects that belong to a given group.
*/
public static Command releaseObjectGroup(java.lang.String objectGroup) {
java.util.Objects.requireNonNull(objectGroup, "objectGroup is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("objectGroup", objectGroup);
return new Command<>("Runtime.releaseObjectGroup", params.build());
}
/**
* Tells inspected instance to run if it was waiting for debugger to attach.
*/
public static Command runIfWaitingForDebugger() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Runtime.runIfWaitingForDebugger", params.build());
}
public static class RunScriptResponse {
private final org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result;
private final java.util.Optional exceptionDetails;
public RunScriptResponse(org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result, java.util.Optional exceptionDetails) {
this.result = java.util.Objects.requireNonNull(result, "result is required");
this.exceptionDetails = exceptionDetails;
}
/**
* Run result.
*/
public org.openqa.selenium.devtools.v84.runtime.model.RemoteObject getResult() {
return result;
}
/**
* Exception details.
*/
public java.util.Optional getExceptionDetails() {
return exceptionDetails;
}
private static RunScriptResponse fromJson(JsonInput input) {
org.openqa.selenium.devtools.v84.runtime.model.RemoteObject result = null;
java.util.Optional exceptionDetails = java.util.Optional.empty();
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "result":
result = input.read(org.openqa.selenium.devtools.v84.runtime.model.RemoteObject.class);
break;
case "exceptionDetails":
exceptionDetails = java.util.Optional.ofNullable(input.read(org.openqa.selenium.devtools.v84.runtime.model.ExceptionDetails.class));
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new RunScriptResponse(result, exceptionDetails);
}
}
/**
* Runs script with given id in a given context.
*/
public static Command runScript(org.openqa.selenium.devtools.v84.runtime.model.ScriptId scriptId, java.util.Optional executionContextId, java.util.Optional objectGroup, java.util.Optional silent, java.util.Optional includeCommandLineAPI, java.util.Optional returnByValue, java.util.Optional generatePreview, java.util.Optional awaitPromise) {
java.util.Objects.requireNonNull(scriptId, "scriptId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("scriptId", scriptId);
executionContextId.ifPresent(p -> params.put("executionContextId", p));
objectGroup.ifPresent(p -> params.put("objectGroup", p));
silent.ifPresent(p -> params.put("silent", p));
includeCommandLineAPI.ifPresent(p -> params.put("includeCommandLineAPI", p));
returnByValue.ifPresent(p -> params.put("returnByValue", p));
generatePreview.ifPresent(p -> params.put("generatePreview", p));
awaitPromise.ifPresent(p -> params.put("awaitPromise", p));
return new Command<>("Runtime.runScript", params.build(), input -> input.read(org.openqa.selenium.devtools.v84.runtime.Runtime.RunScriptResponse.class));
}
/**
* Enables or disables async call stacks tracking.
*/
public static Command setAsyncCallStackDepth(java.lang.Integer maxDepth) {
java.util.Objects.requireNonNull(maxDepth, "maxDepth is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("maxDepth", maxDepth);
return new Command<>("Runtime.setAsyncCallStackDepth", params.build());
}
@Beta()
public static Command setCustomObjectFormatterEnabled(java.lang.Boolean enabled) {
java.util.Objects.requireNonNull(enabled, "enabled is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("enabled", enabled);
return new Command<>("Runtime.setCustomObjectFormatterEnabled", params.build());
}
@Beta()
public static Command setMaxCallStackSizeToCapture(java.lang.Integer size) {
java.util.Objects.requireNonNull(size, "size is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("size", size);
return new Command<>("Runtime.setMaxCallStackSizeToCapture", params.build());
}
/**
* Terminate current or next JavaScript execution.
* Will cancel the termination when the outer-most script execution ends.
*/
@Beta()
public static Command terminateExecution() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Runtime.terminateExecution", params.build());
}
/**
* If executionContextId is empty, adds binding with the given name on the
* global objects of all inspected contexts, including those created later,
* bindings survive reloads.
* If executionContextId is specified, adds binding only on global object of
* given execution context.
* Binding function takes exactly one argument, this argument should be string,
* in case of any other input, function throws an exception.
* Each binding function call produces Runtime.bindingCalled notification.
*/
@Beta()
public static Command addBinding(java.lang.String name, java.util.Optional executionContextId) {
java.util.Objects.requireNonNull(name, "name is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("name", name);
executionContextId.ifPresent(p -> params.put("executionContextId", p));
return new Command<>("Runtime.addBinding", params.build());
}
/**
* This method does not remove binding function from global object but
* unsubscribes current runtime agent from Runtime.bindingCalled notifications.
*/
@Beta()
public static Command removeBinding(java.lang.String name) {
java.util.Objects.requireNonNull(name, "name is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("name", name);
return new Command<>("Runtime.removeBinding", params.build());
}
public static Event bindingCalled() {
return new Event<>("Runtime.bindingCalled", input -> input.read(org.openqa.selenium.devtools.v84.runtime.model.BindingCalled.class));
}
public static Event consoleAPICalled() {
return new Event<>("Runtime.consoleAPICalled", input -> input.read(org.openqa.selenium.devtools.v84.runtime.model.ConsoleAPICalled.class));
}
public static Event exceptionRevoked() {
return new Event<>("Runtime.exceptionRevoked", input -> input.read(org.openqa.selenium.devtools.v84.runtime.model.ExceptionRevoked.class));
}
public static Event exceptionThrown() {
return new Event<>("Runtime.exceptionThrown", input -> input.read(org.openqa.selenium.devtools.v84.runtime.model.ExceptionThrown.class));
}
public static Event executionContextCreated() {
return new Event<>("Runtime.executionContextCreated", ConverterFunctions.map("context", org.openqa.selenium.devtools.v84.runtime.model.ExecutionContextDescription.class));
}
public static Event executionContextDestroyed() {
return new Event<>("Runtime.executionContextDestroyed", ConverterFunctions.map("executionContextId", org.openqa.selenium.devtools.v84.runtime.model.ExecutionContextId.class));
}
public static Event executionContextsCleared() {
return new Event<>("Runtime.executionContextsCleared", input -> null);
}
public static Event inspectRequested() {
return new Event<>("Runtime.inspectRequested", input -> input.read(org.openqa.selenium.devtools.v84.runtime.model.InspectRequested.class));
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy