appium-android-driver - npm Package Compare versions

Comparing version 10.2.2 to 10.2.3

build/lib/commands/app-management.d.ts

@@ -117,3 +117,13 @@ /**
 /**
+ * Puts the app to background and waits the given number of seconds then restores the app
+ * if necessary. The call is blocking.
+ *
  * @this {AndroidDriver}
+ * @param {number} [seconds=-1] The amount of seconds to wait between putting the app to background and restoring it.
+ * Any negative value means to not restore the app after putting it to background.
+ * @returns {Promise<void>}
+ */
+export function mobileBackgroundApp(this: import("../driver").AndroidDriver, seconds?: number): Promise<void>;
+/**
+ * @this {AndroidDriver}
  * @param {import('../driver').AndroidDriverOpts?} [opts=null]
@@ -120,0 +130,0 @@ * @returns {Promise<void>}

build/lib/commands/app-management.js

@@ -21,2 +21,3 @@ "use strict";
 exports.background = background;
+exports.mobileBackgroundApp = mobileBackgroundApp;
 exports.resetAUT = resetAUT;
@@ -338,3 +339,15 @@ exports.installAUT = installAUT;
 /**
+ * Puts the app to background and waits the given number of seconds then restores the app
+ * if necessary. The call is blocking.
+ *
  * @this {AndroidDriver}
+ * @param {number} [seconds=-1] The amount of seconds to wait between putting the app to background and restoring it.
+ * Any negative value means to not restore the app after putting it to background.
+ * @returns {Promise<void>}
+ */
+async function mobileBackgroundApp(seconds = -1) {
+    await this.background(seconds);
+}
+/**
+ * @this {AndroidDriver}
  * @param {import('../driver').AndroidDriverOpts?} [opts=null]
@@ -341,0 +354,0 @@ * @returns {Promise<void>}

build/lib/driver.d.ts

@@ -12,3 +12,3 @@ import type { DriverCaps, DriverOpts, ExternalDriver, InitialOpts, RouteMatcher, StringRecord, W3CDriverCaps } from '@appium/types';
 import { mobileExecEmuConsoleCommand } from './commands/device/emulator-console';
-import { getThirdPartyPackages, uninstallOtherPackages, installOtherApks, installAUT, resetAUT, background, getCurrentActivity, getCurrentPackage, mobileClearApp, mobileInstallApp, installApp, mobileIsAppInstalled, mobileRemoveApp, mobileTerminateApp, terminateApp, removeApp, activateApp, queryAppState, isAppInstalled } from './commands/app-management';
+import { getThirdPartyPackages, uninstallOtherPackages, installOtherApks, installAUT, resetAUT, background, mobileBackgroundApp, getCurrentActivity, getCurrentPackage, mobileClearApp, mobileInstallApp, installApp, mobileIsAppInstalled, mobileRemoveApp, mobileTerminateApp, terminateApp, removeApp, activateApp, queryAppState, isAppInstalled } from './commands/app-management';
 import { mobileGetUiMode, mobileSetUiMode } from './commands/appearance';
@@ -478,2 +478,8 @@ import { mobileDeviceidle } from './commands/deviceidle';
         };
+        readonly 'mobile: backgroundApp': {
+            readonly command: "mobileBackgroundApp";
+            readonly params: {
+                readonly optional: readonly ["seconds"];
+            };
+        };
         readonly 'mobile: startService': {
@@ -799,2 +805,3 @@ readonly command: "mobileStartService";
     isAppInstalled: typeof isAppInstalled;
+    mobileBackgroundApp: typeof mobileBackgroundApp;
     mobileGetUiMode: typeof mobileGetUiMode;
@@ -801,0 +808,0 @@ mobileSetUiMode: typeof mobileSetUiMode;

build/lib/driver.js

@@ -113,2 +113,3 @@ "use strict";
         this.isAppInstalled = app_management_1.isAppInstalled;
+        this.mobileBackgroundApp = app_management_1.mobileBackgroundApp;
         this.mobileGetUiMode = appearance_1.mobileGetUiMode;
@@ -115,0 +116,0 @@ this.mobileSetUiMode = appearance_1.mobileSetUiMode;

build/lib/execute-method-map.d.ts

@@ -132,2 +132,8 @@ export declare const executeMethodMap: {
     };
+    readonly 'mobile: backgroundApp': {
+        readonly command: "mobileBackgroundApp";
+        readonly params: {
+            readonly optional: readonly ["seconds"];
+        };
+    };
     readonly 'mobile: startService': {
@@ -134,0 +140,0 @@ readonly command: "mobileStartService";

build/lib/execute-method-map.js

@@ -167,2 +167,8 @@ "use strict";
     },
+    'mobile: backgroundApp': {
+        command: 'mobileBackgroundApp',
+        params: {
+            optional: ['seconds'],
+        }
+    },
     'mobile: startService': {
@@ -169,0 +175,0 @@ command: 'mobileStartService',

CHANGELOG.md

@@ -0,1 +1,7 @@
+## [10.2.3](https://github.com/appium/appium-android-driver/compare/v10.2.2...v10.2.3) (2025-03-17)
+
+### Bug Fixes
+
+* add backgroundApp ([#988](https://github.com/appium/appium-android-driver/issues/988)) ([a6424cc](https://github.com/appium/appium-android-driver/commit/a6424cc81fa962d54a4c8c45ff4b91378f8f524f))
+
 ## [10.2.2](https://github.com/appium/appium-android-driver/compare/v10.2.1...v10.2.2) (2025-03-14)
@@ -2,0 +8,0 @@

lib/commands/app-management.js

@@ -349,3 +349,16 @@ import {util} from '@appium/support';
 /**
+ * Puts the app to background and waits the given number of seconds then restores the app
+ * if necessary. The call is blocking.
+ *
  * @this {AndroidDriver}
+ * @param {number} [seconds=-1] The amount of seconds to wait between putting the app to background and restoring it.
+ * Any negative value means to not restore the app after putting it to background.
+ * @returns {Promise<void>}
+ */
+export async function mobileBackgroundApp (seconds = -1) {
+  await this.background(seconds);
+}
+
+/**
+ * @this {AndroidDriver}
  * @param {import('../driver').AndroidDriverOpts?} [opts=null]
@@ -352,0 +365,0 @@ * @returns {Promise<void>}

lib/driver.ts

@@ -74,2 +74,3 @@ import type {
   background,
+  mobileBackgroundApp,
   getCurrentActivity,
@@ -417,2 +418,3 @@ getCurrentPackage,
   isAppInstalled = isAppInstalled;
+  mobileBackgroundApp = mobileBackgroundApp;
 
@@ -419,0 +421,0 @@ mobileGetUiMode = mobileGetUiMode;

lib/execute-method-map.ts

@@ -177,3 +177,8 @@ import {ExecuteMethodMap} from '@appium/types';
   },
-
+  'mobile: backgroundApp': {
+    command: 'mobileBackgroundApp',
+    params: {
+      optional: ['seconds'],
+    }
+  },
   'mobile: startService': {
@@ -180,0 +185,0 @@ command: 'mobileStartService',

package.json

 {
   "name": "appium-android-driver",
-  "version": "10.2.2",
+  "version": "10.2.3",
   "description": "Android UiAutomator and Chrome support for Appium",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

1176500

0.26%

Lines of code

22872

0.28%

No dependency changes