Skip to content

Commit f226ad6

Browse files
docs: Document suported BiDi events (#826)
1 parent fddb236 commit f226ad6

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,11 @@ xpath | For elements lookup Xpath strategy the driver uses the same XML tree tha
243243
> using them or plan to use them in the future.
244244
245245

246+
# BiDi Protocol Support
247+
248+
UIAutomator2 driver has partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 3.7.10. Check the [Supported BiDi Commands And Events](./docs/bidi.md) document for more details.
249+
250+
246251
## Parallel Tests
247252

248253
It is possible to execute tests in parallel using UiAutomator2 driver.

docs/bidi.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Supported BiDi Commands And Events
2+
3+
Only events and commands mentioned below are supported.
4+
All other entities described in the spec throw not implemented errors.
5+
6+
# Supported Events
7+
8+
## log.entryAdded
9+
10+
This event is emitted if the driver retrieves a new entry for any of the below log types.
11+
12+
### syslog
13+
14+
Events are emitted for both emulator and real devices. Each event contains a single device logcat line.
15+
Events are always emitted with the `NATIVE_APP` context.
16+
These events might be disabled if the `appium:skipLogcatCapture` capability is enabled.
17+
18+
### server
19+
20+
Events are emitted for both emulator and real devices. Each event contains a single Appium server log line.
21+
Events are always emitted with the `NATIVE_APP` context.
22+
Events are only emitted if the `get_server_logs` server security feature is enabled.

0 commit comments

Comments
 (0)