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

  Edit this Doc Execute Async Script

Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context only)

Example Usage

((JavascriptExecutor) driver).executeAsyncScript("window.setTimeout(arguments[arguments.length - 1], 500);");

self.driver.execute_async_script(‘document.title’)

// webdriver.io example
driver.setAsyncTimeout(5000)
var result = browser.executeAsync(function(a, b, c, d, done) {
    // browser context - you may access neither client nor console
    setTimeout(function() {
        done(a + b + c + d);
    }, 3000);
}, 1, 2, 3, 4)

// node.js context - client and console are available
console.log(result); // outputs: 10

// wd example
await driver.safeExecuteAsync('document.title');

# ruby_lib example
execute_async_script("document.title")

# ruby_lib_core example
@driver.execute_async_script("document.title")

// TODO C# sample

Description

The executed script is assumed to be asynchronous and must signal that is done by invoking the provided callback, which is always provided as the final argument to the function. The value to this callback will be returned to the client.

Asynchronous script commands may not span page loads. If an unload event is fired while waiting for a script result, an error should be returned to the client.

The script argument defines the script to execute in the form of a function body. The function will be invoked with the provided args array and the values may be accessed via the arguments object in the order specified. The final argument will always be a callback function that must be invoked to signal that the script has finished.

Arguments may be any JSON-primitive, array, or JSON object. JSON objects that define a WebElement reference will be converted to the corresponding DOM element. Likewise, any WebElements in the script result will be returned to the client as WebElement JSON objects.

Support

Appium Server

Appium Clients

HTTP API Specifications

Endpoint

POST /session/:session_id/execute_async

URL Parameters

JSON Parameters

Response

The script result (any)

See Also

• W3C Specification
• JSONWP Specification