Edit this Doc Get Window Handles

Retrieve the list of all window handles available to the session (Web context only)

Example Usage

Set<String> windowHandles = driver.getWindowHandles();

window_handles = self.driver.window_handles()

// webdriver.io example
let handles = driver.windowHandles();



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

@driver.window_handles

// TODO C# sample

// TODO PHP sample

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

HTTP API Specifications

Endpoint

GET /wd/hub/session/:session_id/window_handles

URL Parameters

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

JSON Parameters

None

Response

A list of window handles (array<string>)

See Also