Switch to Frame
Change focus to another frame on the page (Web context only)
Example Usage
// Java
driver.switchTo().frame(3);
# Python
self.driver.switch_to.frame(3)
// Javascript
// webdriver.io example
driver.frame(3);
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml)
// wd example
await driver.frame(3);
# Ruby
# ruby_lib example
switch_to.frame(3)
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/web/frame/switch.yml)
# ruby_lib_core example
@driver.switch_to.frame(3)
# PHP
// TODO PHP sample
// C#
// TODO C# sample
Description
If the frame id is null, the server should switch to the page's default content
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
POST /wd/hub/session/:session_id/frame
URL Parameters
name | description |
---|---|
session_id | ID of the session to route the command to |
JSON Parameters
name | type | description |
---|---|---|
id | string|number|null|WebElement JSON Object |
Identifier for the frame to change focus to. |
Response
null