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

  Edit this Doc Set Timeouts

Configure the amount of time that a particular type of operation can execute for before they are aborted

Example Usage

driver.manage().timeouts().pageLoadTimeout(30, TimeUnit.SECONDS);


// example

// wd example
await driver.setPageLoadTimeout(5000);

# ruby_lib example
timeout('pageLoad', 5) # Ruby translates it to seconds

# ruby_lib_core example
@driver.timeout('pageLoad', 5) # Ruby translates it to seconds

driver.Manage().Timeouts().PageLoad = TimeSpan.FromSeconds(30);


The types of timeouts are 'page load', 'script' and 'implicit'. (The example usage is just 'page load')


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
Python All
Javascript (WebdriverIO) All
Javascript (WD) All
Ruby All
C# All

HTTP API Specifications


POST /session/:session_id/timeouts

URL Parameters

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

JSON Parameters

name type description
type string The type of operation to set the timeout for. Valid values are: 'script' for script timeouts, 'implicit' for modifying the implicit wait timeout and 'page load' for setting a page load timeout.
ms number The amount of time, in milliseconds, that time-limited commands are permitted to run



See Also