Set Script Timeout

Set the amount of time, in milliseconds, that asynchronous scripts executed by execute async are permitted to run before they are aborted (Web context only)

Example Usage

// Java
driver.manage().timeouts().setScriptTimeout(30, TimeUnit.SECONDS);

# Python
self.driver.set_script_timeout(5000)

// Javascript
// webdriver.io example
driver.timeoutsAsyncScript(5000)



[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml)
// wd example
await driver.setAsyncScriptTimeout(5000);

# Ruby
# ruby_lib example
script_timeout(5) # Ruby translates it to seconds


[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/async-script.yml)
# ruby_lib_core example
@driver.script_timeout(5) # Ruby translates it to seconds

# PHP
// TODO PHP sample

// C#
// TODO C# 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

POST /session/:session_id/timeouts/async_script

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

See Also