webdriver-precore
Safe HaskellNone
LanguageHaskell2010

WebDriverPreCore.BiDi.API

Synopsis

Documentation

Type definitions for commands and subscriptions to events defined in the WebDriver BiDi specification.

Not all commands and subscriptions will be supported by all BiDi drivers yet, as the specification is still evolving rapidly.

See the demos in the demos for how this module can be used to develop a WebDriver client.

Session Commands

sessionNew :: Capabilities -> Command SessionNewResult Source #

Specification Entry: session.new

This function is not supported by many Bidi drivers yet. To start a BiDi session you need to create an HTTP session with a web socket port specified. Creating a new BiDi session via this command may result in a driver error.

First added to Spec: 21 November 2024 - First Public Working Draft

sessionEnd :: Command () Source #

Specification Entry: session.end

Only sessions created via sessionNew can be ended via this command. If the BiDi session was created by other means (e.g. during HTTP session creation with a web socket port), it needs to be ended by ending the HTTP session.

First added to Spec: 21 November 2024 - First Public Working Draft

BrowsingContext Commands

Browser Commands

Emulation Commands

Input Commands

Network Commands

networkDisownData :: DisownData -> Command () Source #

Specification Entry: network.disownData

First added to Spec: 20 June 2025

networkGetData :: GetData -> Command GetDataResult Source #

Specification Entry: network.getData

First added to Spec: 20 June 2025

Script Commands

Storage Commands

WebExtension Commands

Subscriptions

Fallback Subscriptions

subscribeOffSpecMany :: [OffSpecSubscriptionType] -> [BrowsingContext] -> [UserContext] -> (Value -> m ()) -> Subscription m Source #

Subscribe to off-specification event types.

Use this only as a fallback when a driver supports events not covered by this library. Prefer using the standard subscription functions when available.