Edit this Doc Launch App

Launch the app-under-test on the device

Example Usage

driver.launchApp();

self.driver.launch_app()

// webdriver.io example
driver.launchApp();

// wd example
await driver.launchApp();

# ruby_lib example
launch_app

# ruby_lib_core example
@driver.launch_app

// TODO C# sample

$driver->launchApp();

Description

If the app-under-test (AUT) is closed, or backgrounded, it will launch it. If the AUT is already open, it will background it and re-launch it. iOS tests with XCUITest can also use the mobile: launchApp method. See detailed documentation.

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.2+ All All
Mac Mac None None None
Windows Windows None None None

Appium Clients

Language Support Documentation
Java All appium.github.io
Python All github.com
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

POST /session/:session_id/appium/app/launch

URL Parameters

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

JSON Parameters

None

Response

null

See Also