Get Orientation
Get the current device/browser orientation
Example Usage
// Java
ScreenOrientation orientation = driver.getOrientation();
# Python
orientation = self.driver.orientation()
// Javascript
// webdriver.io example
let orientation = driver.orientation();
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml)
// wd example
let orientation = await driver.getOrientation();
# Ruby
# ruby_lib example
orientation
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/orientation/get-orientation.yml)
# ruby_lib_core example
@driver.orientation
# PHP
// TODO PHP sample
// C#
ScreenOrientation orientation = driver.Orientation;
Support
Appium Server
| Platform | Driver | Platform Versions | Appium Version | Driver Version |
|---|---|---|---|---|
| iOS | XCUITest | 9.3+ | 1.6.0+ | All |
| UIAutomation | 8.0 to 9.3 | All | All | |
| Android | Espresso | ?+ | 1.9.0+ | All |
| UiAutomator2 | ?+ | 1.6.0+ | All | |
| UiAutomator | 4.2+ | All | All | |
| Mac | Mac | ?+ | 1.6.4+ | All |
| Windows | Windows | 10+ | 1.6.0+ | All |
Appium Clients
| Language | Support | Documentation |
|---|---|---|
| Java | All | seleniumhq.github.io |
| Python | All | selenium-python.readthedocs.io |
| Javascript (WebdriverIO) | All | |
| Javascript (WD) | All | github.com |
| Ruby | All | www.rubydoc.info |
| PHP | All | github.com |
| C# | All | github.com |
HTTP API Specifications
Endpoint
GET /session/:session_id/orientation
URL Parameters
| name | description |
|---|---|
| session_id | ID of the session to route the command to |
JSON Parameters
None
Response
The current browser orientation {LANDSCAPE|PORTRAIT} (string)