This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Get Window Handle

Retrieve the current window handle (Web context only)

Example Usage

String windowHandle = driver.getWindowHandle();


window_handle = self.driver.current_window_handle


// webdriver.io example
let handle = driver.getWindowHandle();

// wd example
let windowHandle = await driver.windowHandle();


# ruby_lib example
window_handle

# ruby_lib_core example
@driver.window_handle


string windowHandle = driver.CurrentWindowHandle;

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest None None None
UIAutomation None None None
Android UiAutomator2 None None None
Espresso None None None
UiAutomator None None None
Mac Mac None None None
Windows Windows None None None

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
C# All github.com

HTTP API Specifications

Endpoint

GET /session/:session_id/window_handle

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

None

Response

null

See Also