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

  Edit this Doc Terminate App

Terminate the given app on the device

Example Usage

driver.terminateApp('com.apple.Preferences');
driver.terminateApp('io.appium.android.apis');

driver.terminate_app('com.apple.Preferences')
driver.terminate_app('io.appium.android.apis')

// webdriver.io example
driver.terminateApp(null, 'com.apple.Preferences')
driver.terminateApp('io.appium.android.apis')

// wd example
// Supports only `mobile: queryAppState` for iOS, XCUITest

# ruby_lib example
terminate_app('com.apple.Preferences')
terminate_app('io.appium.android.apis')

# ruby_lib_core example
@driver.terminate_app('com.apple.Preferences')
@driver.terminate_app('io.appium.android.apis')

// Supports only `mobile: queryAppState` for iOS, XCUITest

Description

iOS tests with XCUITest can also use the mobile: terminateApp 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/terminate_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.
options.timeout number (Only Android) Timeout to retry terminate the app.

Response

null

See Also