Table of Contents

Namespace WebDriverBiDi.Script

Classes

AddPreloadScriptCommandParameters

Provides parameters for the script.addPreloadScript command.

AddPreloadScriptCommandResult

Result for adding a preload script using the script.addPreloadScript command.

AudioWorkletRealmInfo

Object representing an audio worklet realm for executing script.

BigIntegerRemoteValue

Represents a remote value for a BigInteger, providing type-safe access to the value and the ability to convert to a local value for use as an argument for script execution on the remote end.

BooleanRemoteValue

Represents a remote value for a boolean, providing type-safe access to the value and the ability to convert to a local value for use as an argument for script execution on the remote end.

CallFunctionCommandParameters

Provides parameters for the script.callFunction command.

ChannelProperties

Properties of a channel used to pass information back from the browser to the client. A channel reaches the browser either in a preload script or as a script.callFunction argument.

ChannelValue

A channel, used as an argument to a script. Because a channel is a LocalValue, it can be passed to script.callFunction as well as to a preload script.

CollectionRemoteValue

Represents a remote value for a list-like object, providing type-safe access to the value and the ability to convert to a local value for use as an argument for script execution on the remote end.

ContextTarget

Object representing a script target that is a browsing context.

DateRemoteValue

Represents a remote value for a date object from the remote end, providing type-safe access to the value and the ability to convert to a local value for use as an argument for script execution on the remote end.

DedicatedWorkerRealmInfo

Object representing a dedicated worker realm for executing script.

DisownCommandParameters

Provides parameters for the script.disown command.

DisownCommandResult

Result for disowning script data using the script.disown command.

EvaluateCommandParameters

Provides parameters for the script.evaluate command.

EvaluateResult

Base class for the result of a script evaluation.

EvaluateResultException

Object representing the evaluation of a script that throws an exception.

EvaluateResultSuccess

Object representing the successful evaluation of a script.

ExceptionDetails

Object containing the details of an exception thrown by a script.

GetRealmsCommandParameters

Provides parameters for the script.getRealms command.

GetRealmsCommandResult

Result for getting realms using the script.getRealms command.

KeyValuePairCollectionRemoteValue

Represents a remote value for a key-value pair object from the remote end, providing type-safe access to the dictionary containing the values and the ability to convert to a local value for use as an argument for script execution on the remote end.

LocalArgumentValue

Represents a LocalValue for use as an argument in script execution, in particular, one built from local .NET data to be serialized to JSON according to the WebDriver BiDi protocol. Every such value has a type, but not every one has a value: Undefined and Null are represented by this class and carry no value. References to objects that already exist on the remote end, and channels, are represented by RemoteReference and ChannelValue.

LocalValue

Object representing a local value for use as an argument in script execution.

MessageEventArgs

Object containing event data for the event raised when a script sends a message to the client over a channel. The script may be a preload script or one passed a channel as a script.callFunction argument.

NodeAttributes

Provides a read-only dictionary of attributes for a node.

NodeProperties

Object containing information about a Node object.

NodeRemoteValue

Represents a remote value for a DOM node, providing type-safe access to the NodeProperties value and the ability to convert to a local value for use as an argument for script execution on the remote end.

NullRemoteValue

Represents a remote value for a null value from the remote end, providing the ability to convert to a local value for use as an argument for script execution on the remote end.

NumberRemoteValue

Represents a remote value for a number, providing type-safe access to the value and the ability to convert to a local value for use as an argument for script execution on the remote end.

ObjectReferenceRemoteValue

Represents a remote value for an object reference from the remote end, providing the ability to convert to a local value for use as an argument for script execution on the remote end.

PaintWorkletRealmInfo

Object representing a paint worklet realm for executing script.

RealmCreatedEventArgs

Object containing event data for the event raised when a script realm is created.

RealmDestroyedEventArgs

Object containing event data for the event raised when a script realm is destroyed.

RealmInfo

Object containing information about a script realm.

RealmTarget

A script target for a realm.

RegExpRemoteValue

Represents a remote value for a regular expression object from the remote end, providing type-safe access to the RegularExpressionValue value and the ability to convert to a local value for use as an argument for script execution on the remote end.

RemoteObjectReference

Object containing a remote reference to an existing ECMAScript object in the browser.

RemoteReference

Object containing a remote reference.

RemoteValue

Object representing a remote value in the browser.

RemoteValueDictionary

A read-only dictionary of RemoteValue objects.

RemoteValueList

A read-only list of RemoteValue objects.

RemovePreloadScriptCommandParameters

Provides parameters for the script.removePreloadScript command.

RemovePreloadScriptCommandResult

Result for removing a preload script using the script.removePreloadScript command.

ScriptException

Thrown when a script run through the Script module's extension methods throws a JavaScript exception.

ScriptModule

The Script module contains commands and events relating to script realms and execution.

ScriptModuleExtensions

Provides extension methods for the Script module.

SerializationOptions

Options for serialization of script objects.

ServiceWorkerRealmInfo

Object representing a service worker realm for executing script.

SharedReference

Object containing a remote reference to an object in the browser containing a shared ID, such as a node.

SharedReferenceInfo

Provides information about a received reference to a remote object identified by a shared ID, such as a node. Use ToSharedReference() to obtain a mutable SharedReference that can be passed as an argument to subsequent commands.

SharedWorkerRealmInfo

Object representing a shared worker realm for executing script.

Source

Object representing the source for a script.

StackFrame

Represents a frame within a stack trace for a script.

StackTrace

Object representing a stack trace from a script.

StringRemoteValue

Represents a remote value for a string from the remote end, providing type-safe access to the string value and the ability to convert to a local value for use as an argument for script execution on the remote end.

Target

Abstract base class for script targets.

UndefinedRemoteValue

Represents a remote value for an undefined value, providing the ability to convert to a local value for use as an argument for script execution on the remote end.

ValueHoldingRemoteValue

Abstract base record for a remote value providing access to the underlying .NET value of the remote value.

ValueHoldingRemoteValue<T>

Abstract base record for a remote value for a specific type, providing type-safe access to the value and the ability to convert to a local value for use as an argument for script execution on the remote end.

WindowProxyRemoteValue

Represents a remote value for a window proxy representing the JavaScript window object. It also provides the ability to convert to a local value for use as an argument for script execution on the remote end.

WindowRealmInfo

Object representing a window realm for executing script.

WorkerRealmInfo

Object representing a worker realm for executing script.

WorkletRealmInfo

Object representing a worklet realm for executing script.

Structs

RegularExpressionValue

Object representing a regular expression.

WindowProxyProperties

Object representing the properties of a window proxy object.

Interfaces

IObjectReferenceRemoteValue

Interface for a remote value that represents an object reference, providing access to the handle and internal ID of the remote value, which can be used to reference the object on the remote end.

ITypeSafeRemoteValue<T>

Interface for a remote value for a specific type, providing type-safe access to the value and the ability to convert to a local value for use as an argument for script execution on the remote end.

Enums

EvaluateResultType

The result type of a script evaluation.

IncludeShadowTreeSerializationOption

Values for the serialization of shadow trees when serializing nodes.

RealmType

The type of realm.

RemoteValueType

Enumeration of the types of remote values that can be returned from the browser.

ResultOwnership

Value of the ownership model of values returned from script execution.

ShadowRootMode

Represents the mode of the shadow root for a node.