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

  Edit this Doc Execute Script

Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context). Run a native mobile command (Native Context).

Example Usage

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

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

// webdriver.io example
var result = browser.execute(function(a, b, c, d) {
  // browser context - you may not access client or console
  return a + b + c + d;
}, 1, 2, 3, 4)

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

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

# ruby_lib example
execute_script("document.title")

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

// TODO C# sample

Description

The executed script is assumed to be synchronous and the result of evaluating the script is returned to the client.

The script argument defines the script to execute in the form of a function body. The value returned by that function will be returned to the client. The function will be invoked with the provided args array and the values may be accessed via the arguments object in the order specified.

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.

For execute in the native context, see Mobile Commands.

Support

Appium Server

Appium Clients

HTTP API Specifications

Endpoint

POST /session/:session_id/execute

URL Parameters

JSON Parameters

Response

The script result (any)

See Also

• W3C Specification
• JSONWP Specification