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
// TODO PHP sample
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