This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.
Edit this Doc Get events
Get events stored in appium server
Example Usage
driver.getEvents();
driver.get_events()
driver.get_events(['event1', 'event2'])
// webdriver.io example
browser.getEvents(['event'])
// wd example
// WD code here
# ruby_lib example
driver.log_events
driver.log_events('event')
driver.log_events(['event1', 'event2'])
# ruby_lib_core example
@driver.logs.events
@driver.logs.events('event')
@driver.logs.events(['event1', 'event2'])
// csharp code here
Support
Appium Server
| Platform | Driver | Platform Versions | Appium Version | Driver Version |
|---|---|---|---|---|
| iOS | XCUITest | 9.3+ | 1.16.0+ | All |
| UIAutomation | 8.0 to 9.3 | 1.16.0+ | All | |
| Android | Espresso | ?+ | 1.16.0+ | All |
| UiAutomator2 | ?+ | 1.16.0+ | All | |
| UiAutomator | 4.3+ | 1.16.0+ | All | |
| Mac | Mac | ?+ | 1.16.0+ | All |
| Windows | Windows | 10+ | 1.16.0+ | All |
Appium Clients
| Language | Support | Documentation |
|---|---|---|
| Java | All | seleniumhq.github.io |
| Python | All | appium.github.io |
| Javascript (WebdriverIO) | None | |
| Javascript (WD) | None | github.com |
| Ruby | All | www.rubydoc.info |
| C# | None | github.com |
HTTP API Specifications
Endpoint
POST /session/:session_id/appium/events
URL Parameters
None
JSON Parameters
| name | type | description |
|---|---|---|
| type | string|array<string> |
(Option) Get events which are filtered with the type if the type is provided |
Response
A JSON hash of events like {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }. A filtered by type item if it is provided. (object)