Table of Contents

WebDriver BiDi Protocol Reference

This page provides a comprehensive cross-reference between the W3C WebDriver BiDi specification protocol methods and their implementation in WebDriverBiDi.NET.

For each protocol method, this reference links to:

  • The API documentation for command parameters and result types
  • The module guide with usage examples and best practices

How to Use This Reference

  1. Find a protocol method from the W3C spec (e.g., browsingContext.navigate)
  2. Look up the row in the appropriate module table below
  3. Click the API link to see the command parameters, result type, and method signature
  4. Click the Guide link to see usage examples and patterns

Module List

Session Module

Commands for managing WebDriver BiDi sessions and event subscriptions.

Protocol Method Command API Result API Module Guide
session.end EndCommandParameters EndCommandResult Session Guide
session.new NewCommandParameters NewCommandResult Session Guide
session.status StatusCommandParameters StatusCommandResult Session Guide
session.subscribe SubscribeCommandParameters SubscribeCommandResult Session Guide
session.unsubscribe UnsubscribeCommandParameters UnsubscribeCommandResult Session Guide

Browser Module

Commands for browser-level operations including user contexts and client windows.

Protocol Method Command API Result API Module Guide
browser.close CloseCommandParameters CloseCommandResult Browser Guide
browser.createUserContext CreateUserContextCommandParameters CreateUserContextCommandResult Browser Guide
browser.getClientWindows GetClientWindowsCommandParameters GetClientWindowsCommandResult Browser Guide
browser.getUserContexts GetUserContextsCommandParameters GetUserContextsCommandResult Browser Guide
browser.removeUserContext RemoveUserContextCommandParameters RemoveUserContextCommandResult Browser Guide
browser.setClientWindowState SetClientWindowStateCommandParameters SetClientWindowStateCommandResult Browser Guide
browser.setDownloadBehavior SetDownloadBehaviorCommandParameters SetDownloadBehaviorCommandResult Browser Guide

Browsing Context Module

Commands for managing browsing contexts (tabs/windows), navigation, and capturing content.

Protocol Method Command API Result API Module Guide
browsingContext.activate ActivateCommandParameters ActivateCommandResult Browsing Context Guide
browsingContext.captureScreenshot CaptureScreenshotCommandParameters CaptureScreenshotCommandResult Browsing Context Guide
browsingContext.close CloseCommandParameters CloseCommandResult Browsing Context Guide
browsingContext.create CreateCommandParameters CreateCommandResult Browsing Context Guide
browsingContext.getTree GetTreeCommandParameters GetTreeCommandResult Browsing Context Guide
browsingContext.handleUserPrompt HandleUserPromptCommandParameters HandleUserPromptCommandResult Browsing Context Guide
browsingContext.locateNodes LocateNodesCommandParameters LocateNodesCommandResult Browsing Context Guide
browsingContext.navigate NavigateCommandParameters NavigateCommandResult Browsing Context Guide
browsingContext.print PrintCommandParameters PrintCommandResult Browsing Context Guide
browsingContext.reload ReloadCommandParameters ReloadCommandResult Browsing Context Guide
browsingContext.setBypassCSP SetBypassCSPCommandParameters SetBypassCSPCommandResult Browsing Context Guide
browsingContext.setViewport SetViewportCommandParameters SetViewportCommandResult Browsing Context Guide
browsingContext.startScreencast StartScreencastCommandParameters StartScreencastCommandResult Browsing Context Guide
browsingContext.stopScreencast StopScreencastCommandParameters StopScreencastCommandResult Browsing Context Guide
browsingContext.traverseHistory TraverseHistoryCommandParameters TraverseHistoryCommandResult Browsing Context Guide

Browsing Context Events

Protocol Event EventArgs API Module Guide
browsingContext.contextCreated ContextCreatedEventArgs Browsing Context Guide
browsingContext.contextDestroyed ContextDestroyedEventArgs Browsing Context Guide
browsingContext.domContentLoaded NavigationEventArgs Browsing Context Guide
browsingContext.downloadEnd DownloadEndEventArgs Browsing Context Guide
browsingContext.downloadWillBegin DownloadWillBeginEventArgs Browsing Context Guide
browsingContext.fragmentNavigated NavigationEventArgs Browsing Context Guide
browsingContext.historyUpdated HistoryUpdatedEventArgs Browsing Context Guide
browsingContext.load NavigationEventArgs Browsing Context Guide
browsingContext.navigationAborted NavigationEventArgs Browsing Context Guide
browsingContext.navigationCommitted NavigationEventArgs Browsing Context Guide
browsingContext.navigationFailed NavigationEventArgs Browsing Context Guide
browsingContext.navigationStarted NavigationEventArgs Browsing Context Guide
browsingContext.userPromptClosed UserPromptClosedEventArgs Browsing Context Guide
browsingContext.userPromptOpened UserPromptOpenedEventArgs Browsing Context Guide

Network Module

Commands for intercepting, modifying, and monitoring network traffic.

Protocol Method Command API Result API Module Guide
network.addDataCollector AddDataCollectorCommandParameters AddDataCollectorCommandResult Network Guide
network.addIntercept AddInterceptCommandParameters AddInterceptCommandResult Network Guide
network.continueRequest ContinueRequestCommandParameters ContinueRequestCommandResult Network Guide
network.continueResponse ContinueResponseCommandParameters ContinueResponseCommandResult Network Guide
network.continueWithAuth ContinueWithAuthCommandParameters ContinueWithAuthCommandResult Network Guide
network.disownData DisownDataCommandParameters DisownDataCommandResult Network Guide
network.failRequest FailRequestCommandParameters FailRequestCommandResult Network Guide
network.getData GetDataCommandParameters GetDataCommandResult Network Guide
network.provideResponse ProvideResponseCommandParameters ProvideResponseCommandResult Network Guide
network.removeDataCollector RemoveDataCollectorCommandParameters RemoveDataCollectorCommandResult Network Guide
network.removeIntercept RemoveInterceptCommandParameters RemoveInterceptCommandResult Network Guide
network.setCacheBehavior SetCacheBehaviorCommandParameters SetCacheBehaviorCommandResult Network Guide
network.setExtraHeaders SetExtraHeadersCommandParameters SetExtraHeadersCommandResult Network Guide

Network Events

Protocol Event EventArgs API Module Guide
network.authRequired AuthRequiredEventArgs Network Guide
network.beforeRequestSent BeforeRequestSentEventArgs Network Guide
network.fetchError FetchErrorEventArgs Network Guide
network.responseCompleted ResponseCompletedEventArgs Network Guide
network.responseStarted ResponseStartedEventArgs Network Guide

Script Module

Commands for script evaluation, realm management, and preload scripts.

Protocol Method Command API Result API Module Guide
script.addPreloadScript AddPreloadScriptCommandParameters AddPreloadScriptCommandResult Script Guide
script.callFunction CallFunctionCommandParameters EvaluateResult Script Guide
script.disown DisownCommandParameters DisownCommandResult Script Guide
script.evaluate EvaluateCommandParameters EvaluateResult Script Guide
script.getRealms GetRealmsCommandParameters GetRealmsCommandResult Script Guide
script.removePreloadScript RemovePreloadScriptCommandParameters RemovePreloadScriptCommandResult Script Guide

Script Events

Protocol Event EventArgs API Module Guide
script.message MessageEventArgs Script Guide
script.realmCreated RealmCreatedEventArgs Script Guide
script.realmDestroyed RealmDestroyedEventArgs Script Guide

Input Module

Commands for simulating user input actions.

Protocol Method Command API Result API Module Guide
input.performActions PerformActionsCommandParameters PerformActionsCommandResult Input Guide
input.releaseActions ReleaseActionsCommandParameters ReleaseActionsCommandResult Input Guide
input.setFiles SetFilesCommandParameters SetFilesCommandResult Input Guide

Input Events

Protocol Event EventArgs API Module Guide
input.fileDialogOpened FileDialogOpenedEventArgs Input Guide

Storage Module

Commands for managing cookies and other storage mechanisms.

Protocol Method Command API Result API Module Guide
storage.deleteCookies DeleteCookiesCommandParameters DeleteCookiesCommandResult Storage Guide
storage.getCookies GetCookiesCommandParameters GetCookiesCommandResult Storage Guide
storage.setCookie SetCookieCommandParameters SetCookieCommandResult Storage Guide

Log Module

Monitoring console log entries.

Log Events

Protocol Event EventArgs API Module Guide
log.entryAdded EntryAddedEventArgs Log Guide

Bluetooth Module

Commands for simulating Bluetooth adapter and device behavior.

Protocol Method Command API Result API Module Guide
bluetooth.disableSimulation DisableSimulationCommandParameters DisableSimulationCommandResult Bluetooth Guide
bluetooth.handleRequestDevicePrompt HandleRequestDevicePromptCommandParameters HandleRequestDevicePromptCommandResult Bluetooth Guide
bluetooth.simulateAdapter SimulateAdapterCommandParameters SimulateAdapterCommandResult Bluetooth Guide
bluetooth.simulateAdvertisement SimulateAdvertisementCommandParameters SimulateAdvertisementCommandResult Bluetooth Guide
bluetooth.simulateCharacteristic SimulateCharacteristicCommandParameters SimulateCharacteristicCommandResult Bluetooth Guide
bluetooth.simulateCharacteristicResponse SimulateCharacteristicResponseCommandParameters SimulateCharacteristicResponseCommandResult Bluetooth Guide
bluetooth.simulateDescriptor SimulateDescriptorCommandParameters SimulateDescriptorCommandResult Bluetooth Guide
bluetooth.simulateDescriptorResponse SimulateDescriptorResponseCommandParameters SimulateDescriptorResponseCommandResult Bluetooth Guide
bluetooth.simulateGattConnectionResponse SimulateGattConnectionResponseCommandParameters SimulateGattConnectionResponseCommandResult Bluetooth Guide
bluetooth.simulateGattDisconnection SimulateGattDisconnectionCommandParameters SimulateGattDisconnectionCommandResult Bluetooth Guide
bluetooth.simulatePreconnectedPeripheral SimulatePreconnectedPeripheralCommandParameters SimulatePreconnectedPeripheralCommandResult Bluetooth Guide
bluetooth.simulateService SimulateServiceCommandParameters SimulateServiceCommandResult Bluetooth Guide

Bluetooth Events

Protocol Event EventArgs API Module Guide
bluetooth.characteristicEventGenerated CharacteristicEventGeneratedEventArgs Bluetooth Guide
bluetooth.descriptorEventGenerated DescriptorEventGeneratedEventArgs Bluetooth Guide
bluetooth.gattConnectionAttempted GattConnectionAttemptedEventArgs Bluetooth Guide
bluetooth.requestDevicePromptUpdated RequestDevicePromptUpdatedEventArgs Bluetooth Guide

Emulation Module

Commands for device emulation and environment overrides.

Protocol Method Command API Result API Module Guide
emulation.setForcedColorsModeThemeOverride SetForcedColorsModeThemeOverrideCommandParameters SetForcedColorsModeThemeOverrideCommandResult Emulation Guide
emulation.setGeolocationOverride SetGeolocationOverrideCommandParameters SetGeolocationOverrideCommandResult Emulation Guide
emulation.setLocaleOverride SetLocaleOverrideCommandParameters SetLocaleOverrideCommandResult Emulation Guide
emulation.setMediaFeaturesOverride SetMediaFeaturesOverrideCommandParameters SetMediaFeaturesOverrideCommandResult Emulation Guide
emulation.setNetworkConditions SetNetworkConditionsCommandParameters SetNetworkConditionsCommandResult Emulation Guide
emulation.setScreenOrientationOverride SetScreenOrientationOverrideCommandParameters SetScreenOrientationOverrideCommandResult Emulation Guide
emulation.setScreenSettingsOverride SetScreenSettingsOverrideCommandParameters SetScreenSettingsOverrideCommandResult Emulation Guide
emulation.setScriptingEnabled SetScriptingEnabledCommandParameters SetScriptingEnabledCommandResult Emulation Guide
emulation.setScrollbarTypeOverride SetScrollbarTypeOverrideCommandParameters SetScrollbarTypeOverrideCommandResult Emulation Guide
emulation.setTextLayoutModeOverride SetTextLayoutModeOverrideCommandParameters SetTextLayoutModeOverrideCommandResult Emulation Guide
emulation.setTimezoneOverride SetTimeZoneOverrideCommandParameters SetTimeZoneOverrideCommandResult Emulation Guide
emulation.setTouchOverride SetTouchOverrideCommandParameters SetTouchOverrideCommandResult Emulation Guide
emulation.setUserAgentOverride SetUserAgentOverrideCommandParameters SetUserAgentOverrideCommandResult Emulation Guide
emulation.setViewportMetaOverride SetViewportMetaOverrideCommandParameters SetViewportMetaOverrideCommandResult Emulation Guide

Permissions Module

Commands for simulating permission grants and denials.

Protocol Method Command API Result API Module Guide
permissions.setPermission SetPermissionCommandParameters SetPermissionCommandResult Permissions Guide

Speculation Module

Monitoring speculative navigation (prefetch) status. The WebDriver BiDi Speculation module defines no commands; it is event-only.

Speculation Events

Protocol Event EventArgs API Module Guide
speculation.prefetchStatusUpdated PrefetchStatusUpdatedEventArgs Speculation Guide

User Agent Client Hints Module

Commands for overriding User-Agent Client Hints.

Protocol Method Command API Result API Module Guide
userAgentClientHints.setClientHintsOverride SetClientHintsOverrideCommandParameters SetClientHintsOverrideCommandResult User Agent Client Hints Guide

Web Extension Module

Commands for managing browser extensions.

Protocol Method Command API Result API Module Guide
webExtension.install InstallCommandParameters InstallCommandResult Web Extension Guide
webExtension.uninstall UninstallCommandParameters UninstallCommandResult Web Extension Guide

Digital Credentials Module

Commands for simulating a virtual digital wallet during credential presentation testing.

Protocol Method Command API Result API Module Guide
digitalCredentials.setVirtualWalletBehavior SetVirtualWalletBehaviorCommandParameters SetVirtualWalletBehaviorCommandResult Digital Credentials Guide

See Also

Edit this page