WebDriver BiDi Protocol
The following is a list of W3C WebDriver BiDi protocol commands supported in Appium.
Unlike other protocols that specify URL endpoints, the WebDriver BiDi protocol specifies commands sent as a websocket event, that both drivers and clients can emit or listen to.
bidiStatus¶
WebDriver BiDi documentation: session.status
Retrieves the current status of the Appium server.
Response¶
bidiSubscribe¶
WebDriver BiDi documentation: session.subscribe
Subscribes to one or more BiDi events.
Parameters¶
| Name | Description | Type | Default |
|---|---|---|---|
contexts? |
Contexts in which to subscribe to the specified events. By default, the global context scope is applied. | string[] | [''] |
events |
Names of events to subscribe to | string[] |
Response¶
{subscription: string} — a unique subscription ID that can be passed to session.unsubscribe.
bidiUnsubscribe¶
WebDriver BiDi documentation: session.unsubscribe
Unsubscribes using either previously returned subscription IDs or event names. Removing a subscription ID preserves any overlapping subscriptions.
Parameters¶
| Name | Description | Type | Default |
|---|---|---|---|
subscriptions? |
Non-empty list of subscription IDs returned by session.subscribe. Cannot be combined with events or contexts. |
string[] | |
contexts? |
Non-standard, only together with events: contexts in which to unsubscribe from the specified events. By default, the global scope is applied. |
string[] | [''] |
events? |
Non-empty list of event names to unsubscribe from. Required when subscriptions is omitted. |
string[] |
All subscription IDs must be known to the current session. An unknown ID causes an invalid argument
error without removing any subscriptions. Subscription IDs are cleared when the session is deleted.
Response¶
{}