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

  Edit this Doc Get All Contexts

Get all the contexts available to automate

Example Usage

Set<String> contextNames = driver.getContextHandles();

contexts = driver.contexts

// webdriver.io example
let contexts = driver.getContexts();

// wd example
let contexts = await driver.contexts();

# ruby_lib example
context = available_contexts

# ruby_lib_core example
context = @driver.available_contexts

List<string> AllContexts = new List<string>();
     foreach (var context in (driver.Contexts))
     {
         AllContexts.Add(context);
     }

Description

Retrieve all the contexts available to be automated. This will include, at least, the native context. There can also be zero or more web view contexts. For information on the format of the context names, see the get context documentation. mobile command mobile: getContexts is available on iOS (XCUITest) and Android (UIAutomator2 and Espresso) to get more detailed contexts. For information on contexts, see Appium's hybrid automation docs.

Support

Appium Server

Appium Clients

HTTP API Specifications

Endpoint

GET /session/:session_id/contexts

URL Parameters

JSON Parameters

None

Response

Array of the names of all available contexts (Array<String>)

See Also

• JSONWP Specification