WebDriver Bidi Protocol
These protocol commands are generated based on the current living
WebDriver Bidi specification. To enable the protocol
for your test make sure to have webSocketUrl: true
set in your capabilities.
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 Nov 20 2024 23:40:34 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 | { |
Returns
- <Object>
local.SessionNewResult
: Command return value with the following interface:{
sessionId: string;
capabilities: {
acceptInsecureCerts: boolean;
browserName: string;
browserVersion: string;
platformName: string;
setWindowRect: boolean;
userAgent: string;
proxy?: SessionProxyConfiguration;
webSocketUrl?: string;
};
}
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 | { |
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 | { |
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 | {} |
browserCreateUserContext
WebDriver Bidi command to send command method "browser.createUserContext" with parameters.
WebDriver Bidi Protocol command. More details can be found in the official protocol docs.
Usage
browser.browserCreateUserContext(params)
Parameters
Name | Type | Details |
---|---|---|
params | remote.EmptyParams | {} |
Returns
- <Object>
local.BrowserCreateUserContextResult
: Command return value with the following interface:;
browserGetUserContexts
WebDriver Bidi command to send command method "browser.getUserContexts" with parameters.
WebDriver Bidi Protocol command. More details can be found in the official protocol docs.
Usage
browser.browserGetUserContexts(params)
Parameters
Name | Type | Details |
---|---|---|
params | remote.EmptyParams | {} |
Returns
- <Object>
local.BrowserGetUserContextsResult
: Command return value with the following interface:{
userContexts: BrowserUserContextInfo[];
}