This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.
Edit this Doc Activate App
Activate the given app onto the device
Example Usage
driver.activateApp('com.apple.Preferences');
driver.activateApp('io.appium.android.apis');
driver.activate_app('com.apple.Preferences')
driver.activate_app('io.appium.android.apis')
// webdriver.io example
driver.activateApp(null, 'com.apple.Preferences')
driver.activateApp('io.appium.android.apis')
// wd example
// Supports only `mobile: queryAppState` for iOS, XCUITest
# ruby_lib example
activate_app('com.apple.Preferences')
activate_app('io.appium.android.apis')
# ruby_lib_core example
@driver.activate_app('com.apple.Preferences')
@driver.activate_app('io.appium.android.apis')
driver.activateApp('com.apple.Preferences');
driver.activateApp('io.appium.android.apis');
Description
iOS tests with XCUITest can also use the mobile: activateApp method. See detailed documentation.
Support
Appium Server
| Platform | Driver | Platform Versions | Appium Version | Driver Version |
|---|---|---|---|---|
| iOS | XCUITest | 9.3+ | 1.6.0+ | All |
| UIAutomation | None | None | None | |
| 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 |
| C# | All | github.com |
HTTP API Specifications
Endpoint
POST /session/:session_id/appium/device/activate_app
URL Parameters
| name | description |
|---|---|
| session_id | ID of the session to route the command to |
JSON Parameters
| name | type | description |
|---|---|---|
| bundleId or appId | string |
BundleId for iOS. Package name for Android. |
Response
null