Skip to content

Latest commit

 

History

History
123 lines (86 loc) · 4.89 KB

get-context.md

File metadata and controls

123 lines (86 loc) · 4.89 KB
Raw

Get Current Context

Get the current context in which Appium is running //: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/context/get-context.yml)

Example Usage

// Java
String context = driver.getContext();
# Python
context = driver.current_context
# or
context = driver.context
// Javascript
// webdriver.io example
let context = driver.getContext();

// wd example
let context = await driver.currentContext();
# Ruby
# ruby_lib example
context = current_context

# ruby_lib_core example
context = @driver.current_context
# PHP
$context = $driver->context();
// C#
string Context = driver.Context;

Description

Retrieve the current context. This can be either NATIVE_APP for the native context, or a web view context, which will be:

  • iOS - WEBVIEW_<id>
  • Android - WEBVIEW_<package name>

For information on contexts, see Appium's hybrid automation docs.

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation 8.0 to 9.3 All All
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.3+ All All
Mac Mac None None None
Windows Windows None None None

Appium Clients

Language Support Documentation
Java All appium.github.io
Python All appium.github.io
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
PHP All github.com
C# All github.com

HTTP API Specifications

Endpoint

GET /session/:session_id/context

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

None

Response

The name of the current context (String)

See Also