chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.runtime

Package-level declarations

Types

@Serializable

data class AddBindingRequest(val name: String, val executionContextId: ExecutionContextId? = null, val executionContextName: String? = null)

Request object containing input parameters for the RuntimeDomain.addBinding command.

AddBindingResponse

@Serializable

object AddBindingResponse

A dummy response object for the RuntimeDomain.addBinding command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

AwaitPromiseRequest

@Serializable

data class AwaitPromiseRequest(val promiseObjectId: RemoteObjectId, val returnByValue: Boolean? = null, val generatePreview: Boolean? = null)

Request object containing input parameters for the RuntimeDomain.awaitPromise command.

AwaitPromiseResponse

@Serializable

data class AwaitPromiseResponse(val result: RemoteObject, val exceptionDetails: ExceptionDetails? = null)

Response type for the RuntimeDomain.awaitPromise command.

CallArgument

@Serializable

data class CallArgument(val value: JsonElement? = null, val unserializableValue: UnserializableValue? = null, val objectId: RemoteObjectId? = null)

Represents function call argument. Either remote object id objectId, primitive value, unserializable primitive value or neither of (for undefined) them should be specified.

CallFrame

@Serializable

data class CallFrame(val functionName: String, val scriptId: ScriptId, val url: String, val lineNumber: Int, val columnNumber: Int)

Stack entry for runtime errors and assertions.

CallFunctionOnRequest

@Serializable

data class CallFunctionOnRequest(val functionDeclaration: String, val objectId: RemoteObjectId? = null, val arguments: List<CallArgument>? = null, val silent: Boolean? = null, val returnByValue: Boolean? = null, val generatePreview: Boolean? = null, val userGesture: Boolean? = null, val awaitPromise: Boolean? = null, val executionContextId: ExecutionContextId? = null, val objectGroup: String? = null, val throwOnSideEffect: Boolean? = null, val uniqueContextId: String? = null, val serializationOptions: SerializationOptions? = null)

Request object containing input parameters for the RuntimeDomain.callFunctionOn command.

CallFunctionOnResponse

@Serializable

data class CallFunctionOnResponse(val result: RemoteObject, val exceptionDetails: ExceptionDetails? = null)

Response type for the RuntimeDomain.callFunctionOn command.

CompileScriptRequest

@Serializable

data class CompileScriptRequest(val expression: String, val sourceURL: String, val persistScript: Boolean, val executionContextId: ExecutionContextId? = null)

Request object containing input parameters for the RuntimeDomain.compileScript command.

CompileScriptResponse

@Serializable

data class CompileScriptResponse(val scriptId: ScriptId? = null, val exceptionDetails: ExceptionDetails? = null)

Response type for the RuntimeDomain.compileScript command.

ConsoleAPICalledType

@Serializable

enum ConsoleAPICalledType : Enum<ConsoleAPICalledType>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

CustomPreview

@Serializable

data class CustomPreview(val header: String, val bodyGetterId: RemoteObjectId? = null)

(undocumented in the protocol definition)

DeepSerializedValue

@Serializable

data class DeepSerializedValue(val type: DeepSerializedValueType, val value: JsonElement? = null, val objectId: String? = null, val weakLocalObjectReference: Int? = null)

Represents deep serialized value.

DeepSerializedValueType

@Serializable

enum DeepSerializedValueType : Enum<DeepSerializedValueType>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

DisableResponse

@Serializable

object DisableResponse

A dummy response object for the RuntimeDomain.disable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

DiscardConsoleEntriesResponse

@Serializable

object DiscardConsoleEntriesResponse

A dummy response object for the RuntimeDomain.discardConsoleEntries command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

EnableResponse

@Serializable

object EnableResponse

A dummy response object for the RuntimeDomain.enable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

EntryPreview

@Serializable

data class EntryPreview(val key: ObjectPreview? = null, val value: ObjectPreview)

(undocumented in the protocol definition)

EvaluateRequest

@Serializable

data class EvaluateRequest(val expression: String, val objectGroup: String? = null, val includeCommandLineAPI: Boolean? = null, val silent: Boolean? = null, val contextId: ExecutionContextId? = null, val returnByValue: Boolean? = null, val generatePreview: Boolean? = null, val userGesture: Boolean? = null, val awaitPromise: Boolean? = null, val throwOnSideEffect: Boolean? = null, val timeout: TimeDelta? = null, val disableBreaks: Boolean? = null, val replMode: Boolean? = null, val allowUnsafeEvalBlockedByCSP: Boolean? = null, val uniqueContextId: String? = null, val serializationOptions: SerializationOptions? = null)

Request object containing input parameters for the RuntimeDomain.evaluate command.

EvaluateResponse

@Serializable

data class EvaluateResponse(val result: RemoteObject, val exceptionDetails: ExceptionDetails? = null)

Response type for the RuntimeDomain.evaluate command.

ExceptionDetails

@Serializable

data class ExceptionDetails(val exceptionId: Int, val text: String, val lineNumber: Int, val columnNumber: Int, val scriptId: ScriptId? = null, val url: String? = null, val stackTrace: StackTrace? = null, val exception: RemoteObject? = null, val executionContextId: ExecutionContextId? = null, val exceptionMetaData: JsonObject? = null)

Detailed information about exception (or error) that was thrown during script compilation or execution.

ExecutionContextDescription

@Serializable

data class ExecutionContextDescription(val id: ExecutionContextId, val origin: String, val name: String, val uniqueId: String? = null, val auxData: JsonObject? = null)

Description of an isolated world.

ExecutionContextId

typealias ExecutionContextId = Int

Id of an execution context.

GetExceptionDetailsRequest

@Serializable

data class GetExceptionDetailsRequest(val errorObjectId: RemoteObjectId)

Request object containing input parameters for the RuntimeDomain.getExceptionDetails command.

GetExceptionDetailsResponse

@Serializable

data class GetExceptionDetailsResponse(val exceptionDetails: ExceptionDetails? = null)

Response type for the RuntimeDomain.getExceptionDetails command.

GetHeapUsageResponse

@Serializable

data class GetHeapUsageResponse(val usedSize: Double, val totalSize: Double)

Response type for the RuntimeDomain.getHeapUsage command.

GetIsolateIdResponse

@Serializable

data class GetIsolateIdResponse(val id: String)

Response type for the RuntimeDomain.getIsolateId command.

GetPropertiesRequest

@Serializable

data class GetPropertiesRequest(val objectId: RemoteObjectId, val ownProperties: Boolean? = null, val accessorPropertiesOnly: Boolean? = null, val generatePreview: Boolean? = null, val nonIndexedPropertiesOnly: Boolean? = null)

Request object containing input parameters for the RuntimeDomain.getProperties command.

GetPropertiesResponse

@Serializable

data class GetPropertiesResponse(val result: List<PropertyDescriptor>, val internalProperties: List<InternalPropertyDescriptor>? = null, val privateProperties: List<PrivatePropertyDescriptor>? = null, val exceptionDetails: ExceptionDetails? = null)

Response type for the RuntimeDomain.getProperties command.

GlobalLexicalScopeNamesRequest

@Serializable

data class GlobalLexicalScopeNamesRequest(val executionContextId: ExecutionContextId? = null)

Request object containing input parameters for the RuntimeDomain.globalLexicalScopeNames command.

GlobalLexicalScopeNamesResponse

@Serializable

data class GlobalLexicalScopeNamesResponse(val names: List<String>)

Response type for the RuntimeDomain.globalLexicalScopeNames command.

InternalPropertyDescriptor

@Serializable

data class InternalPropertyDescriptor(val name: String, val value: RemoteObject? = null)

Object internal property descriptor. This property isn't normally visible in JavaScript code.

ObjectPreview

@Serializable

data class ObjectPreview(val type: ObjectPreviewType, val subtype: ObjectPreviewSubtype? = null, val description: String? = null, val overflow: Boolean, val properties: List<PropertyPreview>, val entries: List<EntryPreview>? = null)

Object containing abbreviated remote object value.

ObjectPreviewSubtype

@Serializable

enum ObjectPreviewSubtype : Enum<ObjectPreviewSubtype>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

ObjectPreviewType

@Serializable

enum ObjectPreviewType : Enum<ObjectPreviewType>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

PrivatePropertyDescriptor

@Serializable

data class PrivatePropertyDescriptor(val name: String, val value: RemoteObject? = null, val get: RemoteObject? = null, val set: RemoteObject? = null)

Object private field descriptor.

PropertyDescriptor

@Serializable

data class PropertyDescriptor(val name: String, val value: RemoteObject? = null, val writable: Boolean? = null, val get: RemoteObject? = null, val set: RemoteObject? = null, val configurable: Boolean, val enumerable: Boolean, val wasThrown: Boolean? = null, val isOwn: Boolean? = null, val symbol: RemoteObject? = null)

Object property descriptor.

PropertyPreview

@Serializable

data class PropertyPreview(val name: String, val type: PropertyPreviewType, val value: String? = null, val valuePreview: ObjectPreview? = null, val subtype: PropertyPreviewSubtype? = null)

(undocumented in the protocol definition)

PropertyPreviewSubtype

@Serializable

enum PropertyPreviewSubtype : Enum<PropertyPreviewSubtype>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

PropertyPreviewType

@Serializable

enum PropertyPreviewType : Enum<PropertyPreviewType>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

QueryObjectsRequest

@Serializable

data class QueryObjectsRequest(val prototypeObjectId: RemoteObjectId, val objectGroup: String? = null)

Request object containing input parameters for the RuntimeDomain.queryObjects command.

QueryObjectsResponse

@Serializable

data class QueryObjectsResponse(val objects: RemoteObject)

Response type for the RuntimeDomain.queryObjects command.

ReleaseObjectGroupRequest

@Serializable

data class ReleaseObjectGroupRequest(val objectGroup: String)

Request object containing input parameters for the RuntimeDomain.releaseObjectGroup command.

ReleaseObjectGroupResponse

@Serializable

object ReleaseObjectGroupResponse

A dummy response object for the RuntimeDomain.releaseObjectGroup command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

ReleaseObjectRequest

@Serializable

data class ReleaseObjectRequest(val objectId: RemoteObjectId)

Request object containing input parameters for the RuntimeDomain.releaseObject command.

ReleaseObjectResponse

@Serializable

object ReleaseObjectResponse

A dummy response object for the RuntimeDomain.releaseObject command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

RemoteObject

@Serializable

data class RemoteObject(val type: RemoteObjectType, val subtype: RemoteObjectSubtype? = null, val className: String? = null, val value: JsonElement? = null, val unserializableValue: UnserializableValue? = null, val description: String? = null, val deepSerializedValue: DeepSerializedValue? = null, val objectId: RemoteObjectId? = null, val preview: ObjectPreview? = null, val customPreview: CustomPreview? = null)

Mirror object referencing original JavaScript object.

RemoteObjectId

typealias RemoteObjectId = String

Unique object identifier.

RemoteObjectSubtype

@Serializable

enum RemoteObjectSubtype : Enum<RemoteObjectSubtype>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

RemoteObjectType

@Serializable

enum RemoteObjectType : Enum<RemoteObjectType>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

RemoveBindingRequest

@Serializable

data class RemoveBindingRequest(val name: String)

Request object containing input parameters for the RuntimeDomain.removeBinding command.

RemoveBindingResponse

@Serializable

object RemoveBindingResponse

A dummy response object for the RuntimeDomain.removeBinding command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

RunIfWaitingForDebuggerResponse

@Serializable

object RunIfWaitingForDebuggerResponse

A dummy response object for the RuntimeDomain.runIfWaitingForDebugger command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

RunScriptRequest

@Serializable

data class RunScriptRequest(val scriptId: ScriptId, val executionContextId: ExecutionContextId? = null, val objectGroup: String? = null, val silent: Boolean? = null, val includeCommandLineAPI: Boolean? = null, val returnByValue: Boolean? = null, val generatePreview: Boolean? = null, val awaitPromise: Boolean? = null)

Request object containing input parameters for the RuntimeDomain.runScript command.

RunScriptResponse

@Serializable

data class RunScriptResponse(val result: RemoteObject, val exceptionDetails: ExceptionDetails? = null)

Response type for the RuntimeDomain.runScript command.

RuntimeDomain

class RuntimeDomain

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.

RuntimeJSEvaluationException

class RuntimeJSEvaluationException(val jsExpression: String, val details: ExceptionDetails) : Exception

Thrown when the evaluation of some JS expression went wrong.

ScriptId

typealias ScriptId = String

Unique script identifier.

SerializationOptions

@Serializable

data class SerializationOptions(val serialization: SerializationOptionsSerialization, val maxDepth: Int? = null, val additionalParameters: JsonObject? = null)

Represents options for serialization. Overrides generatePreview and returnByValue.

SerializationOptionsSerialization

@Serializable

enum SerializationOptionsSerialization : Enum<SerializationOptionsSerialization>

This enum doesn't have a proper description because it was generated from an inline declaration. Its name was inferred based on the place where it is used:

SetAsyncCallStackDepthRequest

@Serializable

data class SetAsyncCallStackDepthRequest(val maxDepth: Int)

Request object containing input parameters for the RuntimeDomain.setAsyncCallStackDepth command.

SetAsyncCallStackDepthResponse

@Serializable

object SetAsyncCallStackDepthResponse

A dummy response object for the RuntimeDomain.setAsyncCallStackDepth command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetCustomObjectFormatterEnabledRequest

@Serializable

data class SetCustomObjectFormatterEnabledRequest(val enabled: Boolean)

Request object containing input parameters for the RuntimeDomain.setCustomObjectFormatterEnabled command.

SetCustomObjectFormatterEnabledResponse

@Serializable

object SetCustomObjectFormatterEnabledResponse

A dummy response object for the RuntimeDomain.setCustomObjectFormatterEnabled command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

SetMaxCallStackSizeToCaptureRequest

@Serializable

data class SetMaxCallStackSizeToCaptureRequest(val size: Int)

Request object containing input parameters for the RuntimeDomain.setMaxCallStackSizeToCapture command.

SetMaxCallStackSizeToCaptureResponse

@Serializable

object SetMaxCallStackSizeToCaptureResponse

A dummy response object for the RuntimeDomain.setMaxCallStackSizeToCapture command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

StackTrace

@Serializable

data class StackTrace(val description: String? = null, val callFrames: List<CallFrame>, val parent: StackTrace? = null, val parentId: StackTraceId? = null)

Call frames for assertions or error messages.

StackTraceId

@Serializable

data class StackTraceId(val id: String, val debuggerId: UniqueDebuggerId? = null)

If debuggerId is set stack trace comes from another debugger and can be resolved there. This allows to track cross-debugger calls. See Runtime.StackTrace and Debugger.paused for usages.

TerminateExecutionResponse

@Serializable

object TerminateExecutionResponse

A dummy response object for the RuntimeDomain.terminateExecution command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

TimeDelta

typealias TimeDelta = Double

Number of milliseconds.

Timestamp

typealias Timestamp = Double

Number of milliseconds since epoch.

UniqueDebuggerId

typealias UniqueDebuggerId = String

Unique identifier of current debugger.

UnserializableValue

typealias UnserializableValue = String

Primitive value which cannot be JSON-stringified. Includes values -0, NaN, Infinity, -Infinity, and bigint literals.

Functions

evaluateJs

inline suspend fun <T> RuntimeDomain.evaluateJs(js: String): T?

Evaluates the given js expression, and returns the result as a value of type T.

suspend fun <T> RuntimeDomain.evaluateJs(js: String, deserializer: DeserializationStrategy<T>): T?

Evaluates the given js expression, and returns the result as a value of type T using the provided deserializer.