Edit this Doc 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);

# ruby_lib example
background_app(10)

# ruby_lib_core example
@driver.background_app(10)

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 {"seconds": 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

Appium Clients

HTTP API Specifications

Endpoint

POST /session/:session_id/appium/app/background

URL Parameters

JSON Parameters

Response

null

See Also

• JSONWP Specification