WebDriver Bidi Protocol

These protocol commands are generated based on the current living WebDriver Bidi specification.

Use with Caution!

Browser support is not guaranteed and interfaces can change in the future. The standard is currently under development and browser vendors will add these capabilities based on their own timelines.

Last Updated: Wed Dec 06 2023 23:04:20 GMT+0000 (Coordinated Universal Time)

send

Send socket commands via WebDriver Bidi

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.send(params)

Parameters

Name	Type	Details
`params`	CommandData	socket payload

Returns

<Object> CommandResponse: WebDriver Bidi response

sendAsync

Send asynchronous socket commands via WebDriver Bidi

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.sendAsync(params)

Parameters

Name	Type	Details
`params`	CommandData	socket payload

Returns

<Number> id: id of WebDriver Bidi request

sessionStatus

WebDriver Bidi command to send command method "session.status" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.sessionStatus(params)

Parameters

Name	Type	Details
`params`	`remote.EmptyParams`	{}

Returns

<Object> local.SessionStatusResult: Command return value with the following interface:
```
{
  ready: boolean;
  message: string;
}
```

sessionNew

WebDriver Bidi command to send command method "session.new" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.sessionNew(params)

Parameters

Name	Type	Details
`params`	`remote.SessionNewParameters`	{ capabilities: SessionCapabilitiesRequest; }

Returns

<Object> local.SessionNewResult: Command return value with the following interface:

{
  sessionId: string;
  capabilities: {
    acceptInsecureCerts: boolean;
    browserName: string;
    browserVersion: string;
    platformName: string;
    proxy: {
      proxyType?: "pac" | "direct" | "autodetect" | "system" | "manual";
      proxyAutoconfigUrl?: string;
      ftpProxy?: string;
      httpProxy?: string;
      noProxy?: string[];
      sslProxy?: string;
      socksProxy?: string;
      socksVersion?: number;
    };
    setWindowRect: boolean;
  };
}

sessionEnd

WebDriver Bidi command to send command method "session.end" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.sessionEnd(params)

Parameters

Name	Type	Details
`params`	`remote.EmptyParams`	{}

sessionSubscribe

WebDriver Bidi command to send command method "session.subscribe" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.sessionSubscribe(params)

Parameters

Name	Type	Details
`params`	`remote.SessionSubscriptionRequest`	{ events: string[]; contexts?: BrowsingContextBrowsingContext[]; }

sessionUnsubscribe

WebDriver Bidi command to send command method "session.unsubscribe" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.sessionUnsubscribe(params)

Parameters

Name	Type	Details
`params`	`remote.SessionSubscriptionRequest`	{ events: string[]; contexts?: BrowsingContextBrowsingContext[]; }

browserClose

WebDriver Bidi command to send command method "browser.close" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browserClose(params)

Parameters

Name	Type	Details
`params`	`remote.EmptyParams`	{}

browsingContextActivate

WebDriver Bidi command to send command method "browsingContext.activate" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextActivate(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextActivateParameters`	{ context: BrowsingContextBrowsingContext; }

browsingContextCaptureScreenshot

WebDriver Bidi command to send command method "browsingContext.captureScreenshot" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextCaptureScreenshot(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextCaptureScreenshotParameters`	{ context: BrowsingContextBrowsingContext; /** * @default 'viewport' */ origin?: "viewport" \| "document"; format?: BrowsingContextImageFormat; clip?: BrowsingContextClipRectangle; }

Returns

<Object> local.BrowsingContextCaptureScreenshotResult: Command return value with the following interface:
```
{
  data: string;
}
```

browsingContextClose

WebDriver Bidi command to send command method "browsingContext.close" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextClose(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextCloseParameters`	{ context: BrowsingContextBrowsingContext; promptUnload?: boolean; }

browsingContextCreate

WebDriver Bidi command to send command method "browsingContext.create" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextCreate(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextCreateParameters`	{ type: BrowsingContextCreateType; referenceContext?: BrowsingContextBrowsingContext; background?: boolean; }

Returns

<Object> local.BrowsingContextCreateResult: Command return value with the following interface:
```
{
  context: BrowsingContextBrowsingContext;
}
```

browsingContextGetTree

WebDriver Bidi command to send command method "browsingContext.getTree" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextGetTree(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextGetTreeParameters`	{ maxDepth?: JsUint; root?: BrowsingContextBrowsingContext; }

Returns

<Object> local.BrowsingContextGetTreeResult: Command return value with the following interface:
```
{
  contexts: BrowsingContextInfoList;
}
```

browsingContextHandleUserPrompt

WebDriver Bidi command to send command method "browsingContext.handleUserPrompt" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextHandleUserPrompt(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextHandleUserPromptParameters`	{ context: BrowsingContextBrowsingContext; accept?: boolean; userText?: string; }

browsingContextLocateNodes

WebDriver Bidi command to send command method "browsingContext.locateNodes" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextLocateNodes(params)

Parameters

Name Type Details

Name	Type	Details
`params`	`remote.BrowsingContextLocateNodesParameters`	{ context: BrowsingContextBrowsingContext; locator: BrowsingContextLocator; maxNodeCount?: JsUint; ownership?: ScriptResultOwnership; sandbox?: string; serializationOptions?: ScriptSerializationOptions; startNodes?: ScriptSharedReference[]; }

params

remote.BrowsingContextLocateNodesParameters

{
  context: BrowsingContextBrowsingContext;
  locator: BrowsingContextLocator;
  maxNodeCount?: JsUint;
  ownership?: ScriptResultOwnership;
  sandbox?: string;
  serializationOptions?: ScriptSerializationOptions;
  startNodes?: ScriptSharedReference[];
}

Returns

<Object> local.BrowsingContextLocateNodesResult: Command return value with the following interface:
```
{
  nodes: ScriptNodeRemoteValue[];
}
```

browsingContextNavigate

WebDriver Bidi command to send command method "browsingContext.navigate" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextNavigate(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextNavigateParameters`	{ context: BrowsingContextBrowsingContext; url: string; wait?: BrowsingContextReadinessState; }

Returns

<Object> local.BrowsingContextNavigateResult: Command return value with the following interface:
```
{
  navigation: BrowsingContextNavigation | null;
  url: string;
}
```

browsingContextPrint

WebDriver Bidi command to send command method "browsingContext.print" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextPrint(params)

Parameters

Name Type Details

Name	Type	Details
`params`	`remote.BrowsingContextPrintParameters`	{ context: BrowsingContextBrowsingContext; background?: boolean; margin?: BrowsingContextPrintMarginParameters; /** * @default 'portrait' / orientation?: "portrait" \| "landscape"; page?: BrowsingContextPrintPageParameters; pageRanges?: (JsUint \| string)[]; /* * @default 1 / scale?: number; /* * @default true */ shrinkToFit?: boolean; }

params

remote.BrowsingContextPrintParameters

{
  context: BrowsingContextBrowsingContext;
  background?: boolean;
  margin?: BrowsingContextPrintMarginParameters;
  /**
   * @default 'portrait'
   */
  orientation?: "portrait" | "landscape";
  page?: BrowsingContextPrintPageParameters;
  pageRanges?: (JsUint | string)[];
  /**
   * @default 1
   */
  scale?: number;
  /**
   * @default true
   */
  shrinkToFit?: boolean;
}

Returns

<Object> local.BrowsingContextPrintResult: Command return value with the following interface:
```
{
  data: string;
}
```

browsingContextReload

WebDriver Bidi command to send command method "browsingContext.reload" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextReload(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextReloadParameters`	{ context: BrowsingContextBrowsingContext; ignoreCache?: boolean; wait?: BrowsingContextReadinessState; }

browsingContextSetViewport

WebDriver Bidi command to send command method "browsingContext.setViewport" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextSetViewport(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextSetViewportParameters`	{ context: BrowsingContextBrowsingContext; viewport?: BrowsingContextViewport \| null; devicePixelRatio?: number \| null; }

browsingContextTraverseHistory

WebDriver Bidi command to send command method "browsingContext.traverseHistory" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.browsingContextTraverseHistory(params)

Parameters

Name	Type	Details
`params`	`remote.BrowsingContextTraverseHistoryParameters`	{ context: BrowsingContextBrowsingContext; delta: JsInt; }

networkAddIntercept

WebDriver Bidi command to send command method "network.addIntercept" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.networkAddIntercept(params)

Parameters

Name	Type	Details
`params`	`remote.NetworkAddInterceptParameters`	{ phases: NetworkInterceptPhase[]; urlPatterns?: NetworkUrlPattern[]; }

Returns

<Object> local.NetworkAddInterceptResult: Command return value with the following interface:
```
{
  intercept: NetworkIntercept;
}
```

networkContinueRequest

WebDriver Bidi command to send command method "network.continueRequest" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.networkContinueRequest(params)

Parameters

Name	Type	Details
`params`	`remote.NetworkContinueRequestParameters`	{ request: NetworkRequest; body?: NetworkBytesValue; cookies?: NetworkCookieHeader[]; headers?: NetworkHeader[]; method?: string; url?: string; }

networkContinueResponse

WebDriver Bidi command to send command method "network.continueResponse" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.networkContinueResponse(params)

Parameters

Name	Type	Details
`params`	`remote.NetworkContinueResponseParameters`	{ request: NetworkRequest; cookies?: NetworkSetCookieHeader[]; credentials?: NetworkAuthCredentials; headers?: NetworkHeader[]; reasonPhrase?: string; statusCode?: JsUint; }

networkContinueWithAuth

WebDriver Bidi command to send command method "network.continueWithAuth" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.networkContinueWithAuth(params)

Parameters

Name	Type	Details
`params`	`remote.NetworkContinueWithAuthParameters`	{ request: NetworkRequest; }

networkFailRequest

WebDriver Bidi command to send command method "network.failRequest" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.networkFailRequest(params)

Parameters

Name	Type	Details
`params`	`remote.NetworkFailRequestParameters`	{ request: NetworkRequest; }

networkProvideResponse

WebDriver Bidi command to send command method "network.provideResponse" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.networkProvideResponse(params)

Parameters

Name	Type	Details
`params`	`remote.NetworkProvideResponseParameters`	{ request: NetworkRequest; body?: NetworkBytesValue; cookies?: NetworkSetCookieHeader[]; headers?: NetworkHeader[]; reasonPhrase?: string; statusCode?: JsUint; }

networkRemoveIntercept

WebDriver Bidi command to send command method "network.removeIntercept" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.networkRemoveIntercept(params)

Parameters

Name	Type	Details
`params`	`remote.NetworkRemoveInterceptParameters`	{ intercept: NetworkIntercept; }

scriptAddPreloadScript

WebDriver Bidi command to send command method "script.addPreloadScript" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.scriptAddPreloadScript(params)

Parameters

Name	Type	Details
`params`	`remote.ScriptAddPreloadScriptParameters`	{ functionDeclaration: string; arguments?: ScriptChannelValue[]; contexts?: BrowsingContextBrowsingContext[]; sandbox?: string; }

Returns

<Object> local.ScriptAddPreloadScriptResult: Command return value with the following interface:
```
{
  script: ScriptPreloadScript;
}
```

scriptDisown

WebDriver Bidi command to send command method "script.disown" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.scriptDisown(params)

Parameters

Name	Type	Details
`params`	`remote.ScriptDisownParameters`	{ handles: ScriptHandle[]; target: ScriptTarget; }

scriptCallFunction

WebDriver Bidi command to send command method "script.callFunction" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.scriptCallFunction(params)

Parameters

Name Type Details

Name	Type	Details
`params`	`remote.ScriptCallFunctionParameters`	{ functionDeclaration: string; awaitPromise: boolean; target: ScriptTarget; arguments?: ScriptLocalValue[]; resultOwnership?: ScriptResultOwnership; serializationOptions?: ScriptSerializationOptions; this?: ScriptLocalValue; userActivation?: boolean; }

params

remote.ScriptCallFunctionParameters

{
  functionDeclaration: string;
  awaitPromise: boolean;
  target: ScriptTarget;
  arguments?: ScriptLocalValue[];
  resultOwnership?: ScriptResultOwnership;
  serializationOptions?: ScriptSerializationOptions;
  this?: ScriptLocalValue;
  userActivation?: boolean;
}

scriptEvaluate

WebDriver Bidi command to send command method "script.evaluate" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.scriptEvaluate(params)

Parameters

Name	Type	Details
`params`	`remote.ScriptEvaluateParameters`	{ expression: string; target: ScriptTarget; awaitPromise: boolean; resultOwnership?: ScriptResultOwnership; serializationOptions?: ScriptSerializationOptions; userActivation?: boolean; }

Returns

<Object> local.ScriptEvaluateResult: Command return value with the following interface:
```
;
```

scriptGetRealms

WebDriver Bidi command to send command method "script.getRealms" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.scriptGetRealms(params)

Parameters

Name	Type	Details
`params`	`remote.ScriptGetRealmsParameters`	{ context?: BrowsingContextBrowsingContext; type?: ScriptRealmType; }

Returns

<Object> local.ScriptGetRealmsResult: Command return value with the following interface:
```
{
  realms: ScriptRealmInfo[];
}
```

scriptRemovePreloadScript

WebDriver Bidi command to send command method "script.removePreloadScript" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.scriptRemovePreloadScript(params)

Parameters

Name	Type	Details
`params`	`remote.ScriptRemovePreloadScriptParameters`	{ script: ScriptPreloadScript; }

inputPerformActions

WebDriver Bidi command to send command method "input.performActions" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.inputPerformActions(params)

Parameters

Name	Type	Details
`params`	`remote.InputPerformActionsParameters`	{ context: BrowsingContextBrowsingContext; actions: InputSourceActions[]; }

inputReleaseActions

WebDriver Bidi command to send command method "input.releaseActions" with parameters.

WebDriver Bidi Protocol command. More details can be found in the official protocol docs.

Usage

browser.inputReleaseActions(params)

Parameters

Name	Type	Details
`params`	`remote.InputReleaseActionsParameters`	{ context: BrowsingContextBrowsingContext; }

send​

Usage​

Parameters​

Returns​

sendAsync​

Usage​

Parameters​

Returns​

sessionStatus​

Usage​

Parameters​

Returns​

sessionNew​

Usage​

Parameters​

Returns​

sessionEnd​

Usage​

Parameters​

sessionSubscribe​

Usage​

Parameters​

sessionUnsubscribe​

Usage​

Parameters​

browserClose​

Usage​

Parameters​

browsingContextActivate​

Usage​

Parameters​

browsingContextCaptureScreenshot​

Usage​

Parameters​

Returns​

browsingContextClose​

Usage​

Parameters​

browsingContextCreate​

Usage​

Parameters​

Returns​

browsingContextGetTree​

Usage​

Parameters​

Returns​

browsingContextHandleUserPrompt​

Usage​

Parameters​

browsingContextLocateNodes​

Usage​

Parameters​

Returns​

browsingContextNavigate​

Usage​

Parameters​

Returns​

browsingContextPrint​

Usage​

Parameters​

Returns​

browsingContextReload​

Usage​

Parameters​

browsingContextSetViewport​

Usage​

Parameters​

browsingContextTraverseHistory​

Usage​

Parameters​

networkAddIntercept​

Usage​

Parameters​

Returns​

networkContinueRequest​

Usage​

Parameters​

networkContinueResponse​

Usage​

Parameters​

send

Usage

Parameters

Returns

sendAsync

Usage

Parameters

Returns

sessionStatus

Usage

Parameters

Returns

sessionNew

Usage

Parameters

Returns

sessionEnd

Usage

Parameters

sessionSubscribe

Usage

Parameters

sessionUnsubscribe

Usage

Parameters

browserClose

Usage

Parameters

browsingContextActivate

Usage

Parameters

browsingContextCaptureScreenshot

Usage

Parameters

Returns

browsingContextClose

Usage

Parameters

browsingContextCreate

Usage

Parameters

Returns

browsingContextGetTree

Usage

Parameters

Returns

browsingContextHandleUserPrompt

Usage

Parameters

browsingContextLocateNodes

Usage

Parameters

Returns

browsingContextNavigate

Usage

Parameters

Returns

browsingContextPrint

Usage

Parameters

Returns

browsingContextReload

Usage

Parameters

browsingContextSetViewport

Usage

Parameters

browsingContextTraverseHistory

Usage

Parameters

networkAddIntercept

Usage

Parameters

Returns

networkContinueRequest

Usage

Parameters

networkContinueResponse

Usage

Parameters