appium/commands-yml/commands/session/timeouts/async-script.yml

Automation for Apps.

---
name: Set Script Timeout
short_description: Set the amount of time, in milliseconds, that asynchronous scripts executed by [execute async](/docs/en/commands/session/timeouts/async-script.md) 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_wd:
    |
    await driver.setAsyncScriptTimeout(5000);

  javascript_wdio:
    |
      driver.timeoutsAsyncScript(5000)
  ruby:
    |
      @driver.script_timeout(5) # Ruby translates it to seconds
  php:
    |
      // TODO PHP sample
  csharp:
    |
      // TODO C# sample

client_docs:
  java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/WebDriver.Timeouts.html#setScriptTimeout-long-java.util.concurrent.TimeUnit-"
  python: "http://selenium-python.readthedocs.io/api.html#selenium.webdriver.remote.webdriver.WebDriver.set_script_timeout"
  javascript_wdio: "http://webdriver.io/api/protocol/timeoutsAsyncScript.html"
  javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L699"
  ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Timeouts#script_timeout="
  php: "https://github.com/appium/php-client/" # TODO PHP documentation link
  csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

# Driver support by platform
driver_support:
  ios:
    xcuitest: false
    uiautomation: false
  android:
    uiautomator2: false
    uiautomator: false
  mac:
    mac: false
  windows:
    windows: false
client_support:
  java: true
  python: true
  ruby: true
  php: true
  csharp: true
  javascript_wd: true
  javascript_wdio: true
  

# Information about the HTTP endpoints
endpoint:
  url: /session/:session_id/timeouts/async_script
  method: POST
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
  json_parameters:
    - name: ms
      type: number
      description: The amount of time, in milliseconds, that time-limited commands are permitted to run

# Links to specifications. Should link to at least one specification
specifications:
  jsonwp: https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtimeoutsasync_script