This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.
Edit this Doc Set Implicit Wait Timeout
Set the amount of time the driver should wait when searching for elements
Example Usage
driver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS);
self.driver.implicitly_wait(5) # waits 5 seconds
// webdriver.io example
driver.setImplicitTimeout(5000)
// wd example
await driver.setImplicitWaitTimeout(5000);
# ruby_lib example
manage.timeouts.implicit_wait = 5 # Ruby translates it to seconds
# ruby_lib_core example
@driver.manage.timeouts.implicit_wait = 5 # Ruby translates it to seconds
driver.Manage().Timeouts().ImplicitWait = TimeSpan.FromSeconds(30);
Description
When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list.
If this command is never sent, the driver should default to an implicit wait of 0ms
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.3+ | 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 |
C# | All | github.com |
HTTP API Specifications
Endpoint
POST /session/:session_id/timeouts/implicit_wait
URL Parameters
name | description |
---|---|
session_id | ID of the session to route the command to |
JSON Parameters
name | type | description |
---|---|---|
ms | number |
The amount of time, in milliseconds, that time-limited commands are permitted to run |
Response
null