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

  Edit this Doc Get Page Source

Get the current application hierarchy XML (app) or page source (web)

Example Usage

String pageSource = driver.getPageSource();

source = self.driver.page_source

// webdriver.io example
let source = driver.getPageSource();

// wd example
let pageSource = await driver.source();

# ruby_lib example
page_source

# ruby_lib_core example
@driver.page_source

string pageSource = driver.PageSource;

Description

In a web context, the source returns the source HTML of the current window. In a native context (iOS, Android, etc...) it will return the application hierarchy XML.

This method is useful for inspecting your application hierarchy and using that to write selectors

(NOTE: iOS and Android don't have standard ways of defining their application source, so on calls to 'Get Page Source' Appium traverses the app hierarchy and creates an XML document. Thus, getting the source can often be an expensive and time-consuming operation)

Support

Appium Server

Appium Clients

HTTP API Specifications

Endpoint

GET /session/:session_id/source

URL Parameters

JSON Parameters

None

Response

The sources of current context. (string)

See Also

• W3C Specification
• JSONWP Specification