Package io.webfolder.cdp.command

Interface Runtime

public interface Runtime

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

Method Summary

Modifier and Type	Method	Description
void	addBinding(String name)	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.
void	addBinding(String name, Integer executionContextId)	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.
AwaitPromiseResult	awaitPromise(String promiseObjectId)	Add handler to promise with given promise object id.
AwaitPromiseResult	awaitPromise(String promiseObjectId, Boolean returnByValue, Boolean generatePreview)	Add handler to promise with given promise object id.
CallFunctionOnResult	callFunctionOn(String functionDeclaration)	Calls function with given declaration on the given object.
CallFunctionOnResult	callFunctionOn(String functionDeclaration, String objectId, List<CallArgument> arguments, Boolean silent, Boolean returnByValue, Boolean generatePreview, Boolean userGesture, Boolean awaitPromise, Integer executionContextId, String objectGroup)	Calls function with given declaration on the given object.
CompileScriptResult	compileScript(String expression, String sourceURL, Boolean persistScript)	Compiles expression.
CompileScriptResult	compileScript(String expression, String sourceURL, Boolean persistScript, Integer executionContextId)	Compiles expression.
void	disable()	Disables reporting of execution contexts creation.
void	discardConsoleEntries()	Discards collected exceptions and console API calls.
void	enable()	Enables reporting of execution contexts creation by means of executionContextCreated event.
EvaluateResult	evaluate(String expression)	Evaluates expression on global object.
EvaluateResult	evaluate(String expression, String objectGroup, Boolean includeCommandLineAPI, Boolean silent, Integer contextId, Boolean returnByValue, Boolean generatePreview, Boolean userGesture, Boolean awaitPromise, Boolean throwOnSideEffect, Double timeout)	Evaluates expression on global object.
GetHeapUsageResult	getHeapUsage()	Returns the JavaScript heap usage.
String	getIsolateId()	Returns the isolate id.
GetPropertiesResult	getProperties(String objectId)	Returns properties of a given object.
GetPropertiesResult	getProperties(String objectId, Boolean ownProperties, Boolean accessorPropertiesOnly, Boolean generatePreview)	Returns properties of a given object.
List<String>	globalLexicalScopeNames()	Returns all let, const and class variables from global scope.
List<String>	globalLexicalScopeNames(Integer executionContextId)	Returns all let, const and class variables from global scope.
RemoteObject	queryObjects(String prototypeObjectId)
RemoteObject	queryObjects(String prototypeObjectId, String objectGroup)
void	releaseObject(String objectId)	Releases remote object with given id.
void	releaseObjectGroup(String objectGroup)	Releases all remote objects that belong to a given group.
void	removeBinding(String name)	This method does not remove binding function from global object but unsubscribes current runtime agent from Runtime.bindingCalled notifications.
void	runIfWaitingForDebugger()	Tells inspected instance to run if it was waiting for debugger to attach.
RunScriptResult	runScript(String scriptId)	Runs script with given id in a given context.
RunScriptResult	runScript(String scriptId, Integer executionContextId, String objectGroup, Boolean silent, Boolean includeCommandLineAPI, Boolean returnByValue, Boolean generatePreview, Boolean awaitPromise)	Runs script with given id in a given context.
void	setAsyncCallStackDepth(Integer maxDepth)	Enables or disables async call stacks tracking.
void	setCustomObjectFormatterEnabled(Boolean enabled)
void	setMaxCallStackSizeToCapture(Integer size)
void	terminateExecution()	Terminate current or next JavaScript execution.

Method Detail

awaitPromise

AwaitPromiseResult awaitPromise(String promiseObjectId,
                                Boolean returnByValue,
                                Boolean generatePreview)

Add handler to promise with given promise object id.

Parameters:

promiseObjectId - Identifier of the promise.

returnByValue - Whether the result is expected to be a JSON object that should be sent by value.

generatePreview - Whether preview should be generated for the result.

Returns:

AwaitPromiseResult

callFunctionOn

CallFunctionOnResult callFunctionOn(String functionDeclaration,
                                    String objectId,
                                    List<CallArgument> arguments,
                                    Boolean silent,
                                    Boolean returnByValue,
                                    Boolean generatePreview,
                                    Boolean userGesture,
                                    Boolean awaitPromise,
                                    Integer executionContextId,
                                    String objectGroup)

Calls function with given declaration on the given object. Object group of the result is inherited from the target object.

Parameters:

functionDeclaration - Declaration of the function to call.

objectId - Identifier of the object to call function on. Either objectId or executionContextId should be specified.

arguments - Call arguments. All call arguments must belong to the same JavaScript world as the target object.

silent - In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.

returnByValue - Whether the result is expected to be a JSON object which should be sent by value.

generatePreview - Whether preview should be generated for the result.

userGesture - Whether execution should be treated as initiated by user in the UI.

awaitPromise - Whether execution should await for resulting value and return once awaited promise is resolved.

executionContextId - Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified.

objectGroup - Symbolic group name that can be used to release multiple objects. If objectGroup is not specified and objectId is, objectGroup will be inherited from object.

Returns:

CallFunctionOnResult

compileScript

CompileScriptResult compileScript(String expression,
                                  String sourceURL,
                                  Boolean persistScript,
                                  Integer executionContextId)

Compiles expression.

Parameters:

expression - Expression to compile.

sourceURL - Source url to be set for the script.

persistScript - Specifies whether the compiled script should be persisted.

executionContextId - Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.

Returns:

CompileScriptResult

disable

void disable()

Disables reporting of execution contexts creation.

discardConsoleEntries

void discardConsoleEntries()

Discards collected exceptions and console API calls.

enable

void enable()

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.

evaluate

EvaluateResult evaluate(String expression,
                        String objectGroup,
                        Boolean includeCommandLineAPI,
                        Boolean silent,
                        Integer contextId,
                        Boolean returnByValue,
                        Boolean generatePreview,
                        Boolean userGesture,
                        Boolean awaitPromise,
                        Boolean throwOnSideEffect,
                        Double timeout)

Evaluates expression on global object.

Parameters:

expression - Expression to evaluate.

objectGroup - Symbolic group name that can be used to release multiple objects.

includeCommandLineAPI - Determines whether Command Line API should be available during the evaluation.

silent - In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.

contextId - Specifies in which execution context to perform evaluation. If the parameter is omitted the evaluation will be performed in the context of the inspected page.

returnByValue - Whether the result is expected to be a JSON object that should be sent by value.

generatePreview - Whether preview should be generated for the result.

userGesture - Whether execution should be treated as initiated by user in the UI.

awaitPromise - Whether execution should await for resulting value and return once awaited promise is resolved.

throwOnSideEffect - Whether to throw an exception if side effect cannot be ruled out during evaluation.

timeout - Terminate execution after timing out (number of milliseconds).

Returns:

EvaluateResult

getIsolateId

String getIsolateId()

Returns the isolate id.

Returns:

The isolate id.

getHeapUsage

GetHeapUsageResult getHeapUsage()

Returns the JavaScript heap usage. It is the total usage of the corresponding isolate not scoped to a particular Runtime.

Returns:

GetHeapUsageResult

getProperties

GetPropertiesResult getProperties(String objectId,
                                  Boolean ownProperties,
                                  Boolean accessorPropertiesOnly,
                                  Boolean generatePreview)

Returns properties of a given object. Object group of the result is inherited from the target object.

Parameters:

objectId - Identifier of the object to return properties for.

ownProperties - If true, returns properties belonging only to the element itself, not to its prototype chain.

accessorPropertiesOnly - If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.

generatePreview - Whether preview should be generated for the results.

Returns:

GetPropertiesResult

globalLexicalScopeNames

List<String> globalLexicalScopeNames(Integer executionContextId)

Returns all let, const and class variables from global scope.

Parameters:

executionContextId - Specifies in which execution context to lookup global scope variables.

queryObjects

RemoteObject queryObjects(String prototypeObjectId,
                          String objectGroup)

releaseObject

void releaseObject(String objectId)

Releases remote object with given id.

Parameters:

objectId - Identifier of the object to release.

releaseObjectGroup

void releaseObjectGroup(String objectGroup)

Releases all remote objects that belong to a given group.

Parameters:

objectGroup - Symbolic object group name.

runIfWaitingForDebugger

void runIfWaitingForDebugger()

Tells inspected instance to run if it was waiting for debugger to attach.

runScript

RunScriptResult runScript(String scriptId,
                          Integer executionContextId,
                          String objectGroup,
                          Boolean silent,
                          Boolean includeCommandLineAPI,
                          Boolean returnByValue,
                          Boolean generatePreview,
                          Boolean awaitPromise)

Runs script with given id in a given context.

Parameters:

scriptId - Id of the script to run.

executionContextId - Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.

objectGroup - Symbolic group name that can be used to release multiple objects.

silent - In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.

includeCommandLineAPI - Determines whether Command Line API should be available during the evaluation.

returnByValue - Whether the result is expected to be a JSON object which should be sent by value.

generatePreview - Whether preview should be generated for the result.

awaitPromise - Whether execution should await for resulting value and return once awaited promise is resolved.

Returns:

RunScriptResult

setAsyncCallStackDepth

void setAsyncCallStackDepth(Integer maxDepth)

Enables or disables async call stacks tracking.

Parameters:

maxDepth - Maximum depth of async call stacks. Setting to 0 will effectively disable collecting async call stacks (default).

setCustomObjectFormatterEnabled

void setCustomObjectFormatterEnabled(Boolean enabled)

setMaxCallStackSizeToCapture

void setMaxCallStackSizeToCapture(Integer size)

terminateExecution

void terminateExecution()

Terminate current or next JavaScript execution. Will cancel the termination when the outer-most script execution ends.

addBinding

void addBinding(String name,
                Integer executionContextId)

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.

removeBinding

void removeBinding(String name)

This method does not remove binding function from global object but unsubscribes current runtime agent from Runtime.bindingCalled notifications.

awaitPromise

AwaitPromiseResult awaitPromise(String promiseObjectId)

Add handler to promise with given promise object id.

Parameters:

promiseObjectId - Identifier of the promise.

Returns:

AwaitPromiseResult

callFunctionOn

CallFunctionOnResult callFunctionOn(String functionDeclaration)

Calls function with given declaration on the given object. Object group of the result is inherited from the target object.

Parameters:

functionDeclaration - Declaration of the function to call.

Returns:

CallFunctionOnResult

compileScript

CompileScriptResult compileScript(String expression,
                                  String sourceURL,
                                  Boolean persistScript)

Compiles expression.

Parameters:

expression - Expression to compile.

sourceURL - Source url to be set for the script.

persistScript - Specifies whether the compiled script should be persisted.

Returns:

CompileScriptResult

evaluate

EvaluateResult evaluate(String expression)

Evaluates expression on global object.

Parameters:

expression - Expression to evaluate.

Returns:

EvaluateResult

getProperties

GetPropertiesResult getProperties(String objectId)

Returns properties of a given object. Object group of the result is inherited from the target object.

Parameters:

objectId - Identifier of the object to return properties for.

Returns:

GetPropertiesResult

globalLexicalScopeNames

List<String> globalLexicalScopeNames()

Returns all let, const and class variables from global scope.

queryObjects

RemoteObject queryObjects(String prototypeObjectId)

runScript

RunScriptResult runScript(String scriptId)

Runs script with given id in a given context.

Parameters:

scriptId - Id of the script to run.

Returns:

RunScriptResult

addBinding

void addBinding(String name)

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.