Background App

Send the currently running app for this session to the background

Example Usage

driver.runAppInBackground(Duration.ofSeconds(10));

self.driver.background_app(10)

// webdriver.io example
driver.background(10);



// wd example
await driver.backgroundApp(10);

@driver.background_app(10)

// TODO C# sample

$driver->backgroundApp(10);

Description

Send the currently active app to the background, and either return after a certain amount of time, or leave the app deactivated. There are 3 types of parameters which may be passed to this method:

  1. An object that looks like {"timeout": secs}, where secs is an integer designating how long, in seconds, to background the app for. -1 means to deactivate the app entirely.

  2. null, which means to deactivate the app entirely.

  3. Deprecated An integer: how long, in seconds, to background the app for. -1 means to deactivate the app entirely.

iOS tests with XCUITest can also use the mobile: terminateApp method to terminate the current app (see detailed documentation), and the mobile: activateApp to activate an existing application on the device under test and moves it to the foreground (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 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 webdriver.io
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/background

URL Parameters

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

JSON Parameters

name type description
seconds number How long to run app in background.

Response

null

See Also