adb-helper - npm explorer

$3

`AppManagement`

Extends ADB

Opens an application using the package name.

This method executes an ADB command to open the specified application on the device using its package name.

#### Parameters

* packageName [string][320] The package name of the application to be opened.

#### Examples

`javascript // Example of opening an app by its package name const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.openApp('com.example.app'); console.log('App opened successfully.');`

* Throws [Error][322] If there is an issue opening the application.

Returns [Promise][321]\ A promise that resolves when the application is successfully opened.

`$3`

Opens a specific activity of an application using its package name and activity name.

This method executes an ADB command to open a specified activity within an application on the device using its package name and the activity name.

#### Parameters

* packageName[string][320] The package name of the application. *activityName [string][320] The fully qualified name of the activity to be opened.

#### Examples

`javascript // Example of opening a specific activity within an app const { ADBHelper } = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.openActivity('com.example.app', 'com.example.app.MainActivity'); console.log('Activity opened successfully.');`

* Throws [Error][322] If there is an issue opening the activity.

Returns [Promise][321]\ A promise that resolves when the activity is successfully opened.

`$3`

Lists installed applications on the device with optional filters.

This method executes an ADB command to list installed applications based on the specified filter.

#### Parameters

* filterType ("enabled" | "disabled" | "system" | "user" | [string][320])?The type of filter to apply: 'enabled' : enabled apps, 'disabled' : disabled apps, 'system' : system apps, 'user' : user-installed apps, or a specific package name to filter by.

#### Examples

`javascript // Example of listing user-installed apps const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); const apps = await adbHelper.appManagement.getInstalledApps('user'); console.log('User-installed apps:', apps);`

* Throws [Error][322] If there is an issue retrieving the list of installed apps.

Returns [Promise][321]<[Array][323]<[string][320]>> A promise that resolves to an array containing the package names of installed apps matching the filter.

Disables a specified app on the device.

This method executes an ADB command to disable an app, making it inactive but not uninstalling it.

#### Parameters

* packageName [string][320] The package name of the app to disable.

#### Examples

`javascript // Example of disabling an app const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.disableApp('com.example.app'); console.log('App disabled successfully.');`

* Throws [Error][322] If there is an issue disabling the app.

Returns [Promise][321]\ A promise that resolves when the app is disabled successfully.

`$3`

Enables a previously disabled app on the device.

This method executes an ADB command to enable an app that was previously disabled.

#### Parameters

* packageName [string][320] The package name of the app to enable.

#### Examples

`javascript // Example of enabling a disabled app const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.enableApp('com.example.app'); console.log('App enabled successfully.');`

* Throws [Error][322] If there is an issue enabling the app.

Returns [Promise][321]\ A promise that resolves when the app is enabled successfully.

`$3`

Retrieves the granted permissions of a specified app.

This method executes an ADB command to retrieve the list of permissions granted to a specified app.

#### Parameters

* packageName [string][320] The package name of the app whose granted permissions are to be retrieved.

#### Examples

`javascript // Example of retrieving granted permissions for an app const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); const grantedPermissions = await adbHelper.appManagement.getGrantedPermissions('com.example.app'); console.log('Granted permissions:', grantedPermissions);`

* Throws [Error][322] If there is an issue retrieving the granted permissions.

Returns [Promise][321]<[Array][323]<[string][320]>> A promise that resolves to an array containing granted permissions.

`$3`

Retrieves permissions of a specified app based on the specified status.

This method executes an ADB command to retrieve all, granted, or denied permissions for a specified app.

#### Parameters

* packageName[string][320] The package name of the app whose permissions are to be retrieved. *status ("all" | "granted" | "denied")The status of permissions to retrieve: 'all' : All permissions, 'granted' : Granted permissions, 'denied' : Denied permissions. (optional, default'all')

#### Examples

`javascript // Example of retrieving all permissions for an app const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); const allPermissions = await adbHelper.appManagement.getAppPermissions('com.example.app', 'all'); console.log('All permissions:', allPermissions);`

* Throws [Error][322] If there is an issue retrieving the permissions.

Returns [Promise][321]<[Array][323]<[string][320]>> A promise that resolves to an array containing the permissions matching the specified status.

`$3`

Grants a specified permission to an app.

This method executes an ADB command to grant a specified permission to an app.

#### Parameters

* packageName[string][320] The package name of the app to which the permission is to be granted. *permission [string][320] The permission to grant.

#### Examples

`javascript // Example of granting a permission to an app const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.grantPermission('com.example.app', 'android.permission.CAMERA'); console.log('Permission granted.');`

* Throws [Error][322] If there is an issue granting the permission.

Returns [Promise][321]\ A promise that resolves when the permission is granted.

`$3`

Revokes a specified permission from an app.

This method executes an ADB command to revoke a specified permission from an app.

#### Parameters

* packageName[string][320] The package name of the app from which the permission is to be revoked. *permission [string][320] The permission to revoke.

#### Examples

`javascript // Example of revoking a permission from an app const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.revokePermission('com.example.app', 'android.permission.CAMERA'); console.log('Permission revoked.');`

* Throws [Error][322] If there is an issue revoking the permission.

Returns [Promise][321]\ A promise that resolves when the permission is revoked.

`$3`

Checks if a specified app is installed on the device.

This method executes an ADB command to list installed packages and checks if the specified app's package name is present.

#### Parameters

* packageName [string][320] The package name of the app to check for installation.

#### Examples

`javascript // Example of checking if an app is installed const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); const isInstalled = await adbHelper.appManagement.isAppInstalled('com.example.app'); console.log('App installed:', isInstalled);`

* Throws [Error][322] If there is an issue checking the installation status.

Returns [Promise][321]<[boolean][325]> A promise that resolves to a boolean indicating if the app is installed.

`$3`

Force stops a specified app.

This method executes an ADB command to force stop an app using its package name.

#### Parameters

* packageName [string][320] The package name of the app to force stop.

#### Examples

`javascript // Example of force stopping an app const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.forceStopApp('com.example.app'); console.log('App force stopped.');`

* Throws [Error][322] If there is an issue stopping the app.

Returns [Promise][321]\ A promise that resolves when the app is successfully stopped.

`$3`

Launches a URL in the default browser or a specific app on the device.

This method executes an ADB command to open a specified URL on the device. It also allows specifying an app package to open the URL in that app.

#### Parameters

* url[string][320] The URL to open. *packageName [string][320]? The package name of the app to handle the URL (optional).

#### Examples

`javascript // Example of launching a URL in the default browser const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.launchURL('https://example.com'); console.log('URL launched.'); // Example of launching a URL in WhatsApp await adbHelper.appManagement.launchURL('https://web.whatsapp.com/send/?phone=221771370101&text=Hello', 'com.whatsapp');`

* Throws [Error][322] If there is an issue opening the URL.

Returns [Promise][321]\ A promise that resolves when the URL is successfully opened.

`$3`

Launches an app's activity with specified extras.

This method executes an ADB command to launch a specified activity within an app, passing additional key-value data.

#### Parameters

* packageName[string][320] The package name of the app. *activityName[string][320] The name of the activity to launch within the app. *extras {: any}

#### Examples

`javascript // Example of launching an activity with extras const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.launchActivityWithExtras('com.example.app', '.MainActivity', { key1: 'value1', key2: 'value2' }); console.log('Activity launched with extras.');`

* Throws [Error][322] If there is an issue launching the activity with extras.

Returns [Promise][321]\ A promise that resolves when the activity is launched.

`$3`

Disables notifications for a specified app.

This method executes an ADB command to disable notifications for an app.

#### Parameters

* packageName [string][320] The package name of the app for which to disable notifications.

#### Examples

`javascript // Example of disabling notifications for an app const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.disableAppNotifications('com.example.app'); console.log('Notifications disabled.');`

* Throws [Error][322] If there is an issue disabling notifications.

Returns [Promise][321]\ A promise that resolves when notifications are disabled.

`$3`

Enables notifications for a specified app.

This method executes an ADB command to enable notifications for an app.

#### Parameters

* packageName [string][320] The package name of the app for which to enable notifications.

#### Examples

`javascript // Example of enabling notifications for an app const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.appManagement.enableAppNotifications('com.example.app'); console.log('Notifications enabled.');`

* Throws [Error][322] If there is an issue enabling notifications.

Returns [Promise][321]\ A promise that resolves when notifications are enabled.

`$3`

Modify a parameter in the SharedPreferences of an application

#### Parameters

* packageName[string][320] The package name of the application *key[string][320] The key of the parameter to modify *value [string][320] The value to set for the parameter

Returns [Promise][321]\

`$3`

Send an Intent to activate a feature in the app

#### Parameters

* intentAction [string][320] The action of the Intent to send

Returns [Promise][321]\

`$3`

List the activities of a given application via ADB

#### Parameters

* packageName [string][320] The package name of the application

Returns [Promise][321]<[Array][323]<[string][320]>>

`$3`

List the processes running on the Android device.

Returns [Promise][321]<([string][320] | null)>

`getCachedScreenHierarchyValue`

Getter for the screen hierarchy cache.

This method returns the cached screen hierarchy, which is a list of UIHierarchy objects.

Type: ([Array][323]\ | null)

Returns ([Array][323]\ | null) The cached screen hierarchy, or null if no data is cached.

`setCachedScreenHierarchyValue`

Setter for the screen hierarchy cache.

This method sets the cached screen hierarchy with a list of UIHierarchy objects.

Type: ([Array][323]\ | null)

`$3`

* value ([Array][323]\ | null) The new value to set for the cached screen hierarchy, or null to clear it.

`getCachedElementValue`

Getter for the cached element.

This method returns the cached element, which is a single UIHierarchy object.

Type: (UIHierarchy | null)

Returns (UIHierarchy | null) The cached UIHierarchy element, or null if no element is cached.

`setCachedElementValue`

Setter for the cached element.

This method sets the cached element with a UIHierarchy object.

Type: (UIHierarchy | null)

`$3`

* value (UIHierarchy | null) The new value to set for the cached element, or null to clear it.

`getCurrentActivityValue`

Getter for the current activity.

This method returns the current activity as a string.

Type: ([string][320] | null)

Returns ([string][320] | null) The current activity, or null if no activity is set.

`setCurrentActivityValue`

Setter for the current activity.

This method sets the current activity with a string value.

Type: [string][320]

`$3`

* value ([string][320] | null) The new value to set for the current activity, or null to clear it.

`getCachedScreenResolutionValue`

Getter for the current activity.

This method returns the current activity as a string.

Type: ({width: [number][326], height: [number][326]} | null)

Returns ([string][320] | null) The current activity, or null if no activity is set.

`setCachedScreenResolutionValue`

Setter for the current activity.

This method sets the current activity with a string value.

`$3`

Simulates pressing the "Back" button on the device.

This method sends a command to the device to simulate the action of pressing the physical or virtual "Back" button, typically used for navigating backward in the app or closing the current activity or screen.

* Throws [Error][322] If an error occurs while executing the command or interacting with the device.const {ADBHelper} = require('adb-helper'); const adbHelper = new ADBHelper("device123"); adbHelper.deviceControl.pressBack()

Returns [Promise][321]\ A promise that resolves when the "Back" button has been successfully pressed or rejects if an error occurs during execution.

`$3`

Simulates pressing the "Home" button on the device.

This method sends a command to the device to simulate the action of pressing the physical or virtual "Home" button, typically used to navigate to the home screen or return to the device's main launcher.

* Throws [Error][322] If an error occurs while executing the command or interacting with the device. const {ADBHelper} = require('adb-helper'); const adbHelper = new ADBHelper("device123"); adbHelper.deviceControl.pressHome()

Changes the device's screen brightness.

This method allows you to set the screen brightness of the connected device. The brightness value must be between 0 and 255 (0 to turn off the screen, 255 for maximum brightness).

#### Parameters

* brightness [number][326] The brightness value to set, between 0 and 255.

#### Examples

`javascript // Set the brightness to 255 (maximum brightness) const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.setBrightness(255);`

* Throws [Error][322] If the brightness value is outside the valid range (0 to 255) or if the command fails.

Returns [Promise][321]\ A promise that resolves when the command is executed successfully.

`$3`

Enables or disables the device's auto-rotation.

This method allows you to enable or disable the auto-rotation feature of the connected device. When enabled, the screen orientation will automatically adjust based on the device's position.

#### Parameters

* enable [boolean][325] true to enable auto-rotation, false to disable it.

#### Examples

`javascript // Enable auto-rotation const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.setAutoRotation(true);`

`javascript // Disable auto-rotation const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.setAutoRotation(false);`

* Throws [Error][322] If the command fails or the device cannot process the command.

Returns [Promise][321]\ A promise that resolves when the command is successfully executed.

`$3`

Enables USB debugging via ADB (part of the Developer Mode).

This method enables the USB debugging feature on the connected device. It is required for establishing a connection between the device and ADB for debugging purposes.

#### Examples

`javascript // Example of enabling USB debugging const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.enableUSBDebugging();`

* Throws [Error][322] If the command fails or the device cannot process the command.

Returns [Promise][321]\ A promise that resolves when USB debugging is successfully enabled.

`$3`

Disables Developer Mode options such as USB debugging.

This method disables USB debugging and other developer options on the connected device. It is used to turn off the developer settings once they are no longer needed.

#### Examples

`javascript // Example of disabling developer mode const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.disableDeveloperMode();`

* Throws [Error][322] If the command fails or the device cannot process the command.

Returns [Promise][321]\ A promise that resolves when USB debugging is successfully disabled.

`$3`

Checks the currently running Android version on the device.

This method retrieves the Android version of the connected device using ADB. It returns the version string which can be used to determine the device's OS version.

#### Examples

`javascript // Example of checking Android version const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); const androidVersion = await adbHelper.deviceControl.checkAndroidVersion(); console.log(Android Version: ${androidVersion});`

* Throws [Error][322] If the command fails or the device cannot provide the version.

Performs a factory reset on the device, erasing all data.

This method resets the device to its factory settings, effectively wiping all data. It uses the ADBMASTER_CLEAR intent to trigger the factory reset process.

#### Examples

`javascript // Example of performing a factory reset const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.factoryReset(); // Perform factory reset`

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when the device is reset to factory settings.

`$3`

Wipes the user data on the device.

This method erases the user data on the device using the ADB recovery command. It only clears the user data without affecting system settings or installed apps.

#### Examples

`javascript // Example of wiping user data const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.wipeUserData(); // Wipe user data`

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when the user data is wiped.

`$3`

Reboots the device into recovery mode.

This method reboots the device into recovery mode, which is typically used for maintenance tasks like updating the device or performing factory resets. It uses the ADBreboot recovery command to restart the device in recovery mode.

#### Examples

`javascript // Example of rebooting into recovery mode const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.rebootIntoRecovery(); // Reboot into recovery mode`

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when the device has successfully rebooted into recovery mode.

`$3`

Changes the system language and region on the device.

This method sets the system language and region (locale) using the ADB setpropcommand for language and country. After the properties are set, it broadcasts theLOCALE_CHANGED intent to apply the changes.

#### Parameters

* language[string][320] The language code (e.g., "en", "fr") to set on the device. *region [string][320] The region code (e.g., "US", "FR") to set on the device.

#### Examples

`javascript // Example of changing language and region const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.changeLanguage('fr', 'FR'); // Change language to French and region to France`

* Throws [Error][322] If any of the ADB commands fail to execute.

Enables silent mode on the device.

This method activates silent mode on the device using the ADB command. It broadcasts the intent to mute audio.

#### Examples

`javascript // Example of enabling silent mode const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.enableSilentMode(); // Enable silent mode`

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when silent mode is successfully activated.

`$3`

Disables silent mode on the device.

This method deactivates silent mode on the device using the ADB command. It broadcasts the intent to unmute audio.

#### Examples

`javascript // Example of disabling silent mode const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.disableSilentMode(); // Disable silent mode`

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when silent mode is successfully deactivated.

`$3`

Enables the "Do Not Disturb" mode on the device.

This method activates the "Do Not Disturb" mode by setting the global zen_mode to 1 using the ADB command.

#### Examples

`javascript // Example of enabling Do Not Disturb mode const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.enableDoNotDisturb(); // Enable Do Not Disturb mode`

* Throws [Error][322] If the ADB command fails to execute.

Enables automatic time synchronization on the device.

This method enables the automatic synchronization of time from an NTP server.

#### Examples

`javascript // Example of enabling auto time sync const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.enableAutoTimeSync(); // Enable automatic time sync`

#### Parameters

* path [string][320] The absolute path to the directory you want to delete.

#### Examples

``javascript`ts await fileManager.deleteDirectory('/sdcard/TestFolder'); console.log('Directory deleted successfully');```

* Throws any Will throw an error if the directory cannot be deleted.

Returns [Promise][321]\ Promise

`$3`

Reads and returns the content of a text file from the Android device.

#### Parameters

* filePath [string][320] The absolute path to the file to be read.

#### Examples

``javascript`ts const content = await fileManager.readFile('/sdcard/Download/myfile.txt'); console.log('File content:', content);```

* Throws any Will throw an error if the file cannot be read.

Returns [Promise][321]<[string][320]> Promise - The contents of the file as a string.

`$3`

Writes string content to a file on the Android device.

If the file already exists, it will be overwritten. If it doesn't exist, it will be created. This method supports writing small text content directly via ADB.

#### Parameters

* remotePath[string][320] The absolute path to the target file on the device. *content [string][320] The text content to be written into the file.

#### Examples

``javascript`ts await fileManager.writeFile('/sdcard/Download/note.txt', 'Hello from ADB!'); console.log('File written successfully');````

* Throws any Will throw an error if the write operation fails.

Returns [Promise][321]\ Promise

$3

ADB

ADB class to execute ADB shell commands.

$3

Executes an ADB shell command.

Opens an application using the package name.

This method executes an ADB command to open the specified application on the device using its package name.

#### Parameters

* packageName [string][320] The package name of the application to be opened.

#### Examples

* Throws [Error][322] If there is an issue opening the application.

Returns [Promise][321]\ A promise that resolves when the application is successfully opened.

`$3`

Opens a specific activity of an application using its package name and activity name.

This method executes an ADB command to open a specified activity within an application on the device using its package name and the activity name.

#### Parameters

* packageName[string][320] The package name of the application. *activityName [string][320] The fully qualified name of the activity to be opened.

#### Examples

* Throws [Error][322] If there is an issue opening the activity.

Returns [Promise][321]\ A promise that resolves when the activity is successfully opened.

Uninstalls a specified app from the device with optional data retention.

This method executes an ADB command to uninstall an app, and optionally keep its data.

#### Parameters

* packageName[string][320] The package name of the app to uninstall. *options [Object][324] Optional configuration for the uninstallation.

* options.keepData [boolean][325]? Whether to retain app data after uninstallation (default is false).

#### Examples

* Throws [Error][322] If there is an issue uninstalling the app.

Returns [Promise][321]\ A promise that resolves when the app is uninstalled successfully.

`$3`

Disables a specified app on the device.

This method executes an ADB command to disable an app, making it inactive but not uninstalling it.

#### Parameters

* packageName [string][320] The package name of the app to disable.

#### Examples

* Throws [Error][322] If there is an issue disabling the app.

Returns [Promise][321]\ A promise that resolves when the app is disabled successfully.

`$3`

Enables a previously disabled app on the device.

This method executes an ADB command to enable an app that was previously disabled.

#### Parameters

* packageName [string][320] The package name of the app to enable.

#### Examples

* Throws [Error][322] If there is an issue enabling the app.

Returns [Promise][321]\ A promise that resolves when the app is enabled successfully.

`$3`

Retrieves the granted permissions of a specified app.

This method executes an ADB command to retrieve the list of permissions granted to a specified app.

#### Parameters

* packageName [string][320] The package name of the app whose granted permissions are to be retrieved.

#### Examples

* Throws [Error][322] If there is an issue retrieving the granted permissions.

Returns [Promise][321]<[Array][323]<[string][320]>> A promise that resolves to an array containing granted permissions.

Modify a parameter in the SharedPreferences of an application

#### Parameters

* packageName[string][320] The package name of the application *key[string][320] The key of the parameter to modify *value [string][320] The value to set for the parameter

Returns [Promise][321]\

`$3`

Send an Intent to activate a feature in the app

#### Parameters

* intentAction [string][320] The action of the Intent to send

Returns [Promise][321]\

`$3`

List the activities of a given application via ADB

#### Parameters

* packageName [string][320] The package name of the application

Returns [Promise][321]<[Array][323]<[string][320]>>

`$3`

List the processes running on the Android device.

Returns [Promise][321]<([string][320] | null)>

`getCachedScreenHierarchyValue`

Getter for the screen hierarchy cache.

This method returns the cached screen hierarchy, which is a list of UIHierarchy objects.

Type: ([Array][323]\ | null)

Returns ([Array][323]\ | null) The cached screen hierarchy, or null if no data is cached.

`setCachedScreenHierarchyValue`

Setter for the screen hierarchy cache.

This method sets the cached screen hierarchy with a list of UIHierarchy objects.

Type: ([Array][323]\ | null)

`$3`

* value ([Array][323]\ | null) The new value to set for the cached screen hierarchy, or null to clear it.

`getCachedElementValue`

Getter for the cached element.

This method returns the cached element, which is a single UIHierarchy object.

Type: (UIHierarchy | null)

Returns (UIHierarchy | null) The cached UIHierarchy element, or null if no element is cached.

`setCachedElementValue`

Setter for the cached element.

This method sets the cached element with a UIHierarchy object.

Type: (UIHierarchy | null)

`$3`

* value (UIHierarchy | null) The new value to set for the cached element, or null to clear it.

`getCurrentActivityValue`

Getter for the current activity.

This method returns the current activity as a string.

Type: ([string][320] | null)

Returns ([string][320] | null) The current activity, or null if no activity is set.

`setCurrentActivityValue`

Setter for the current activity.

This method sets the current activity with a string value.

Type: [string][320]

`$3`

* value ([string][320] | null) The new value to set for the current activity, or null to clear it.

`getCachedScreenResolutionValue`

Getter for the current activity.

This method returns the current activity as a string.

Type: ({width: [number][326], height: [number][326]} | null)

Returns ([string][320] | null) The current activity, or null if no activity is set.

`setCachedScreenResolutionValue`

Setter for the current activity.

This method sets the current activity with a string value.

Type: {width: [number][326], height: [number][326]}

`$3`

* value ([string][320] | null) The new value to set for the current activity, or null to clear it.

`DeviceControl`

Extends ADB

Class to manage various device operations via ADB commands.

`$3`

* deviceId [string][320] The unique identifier for the Android device.

Checks the status of the connected device.

#### Examples

`javascript const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('deviceIdOrAnyValue'); adbHelper.deviceControl.checkDevice()`

* Throws [Error][322] If there is an issue executing the command or if the device is not detected.

Returns [Promise][321]<[string][320]> A promise that resolves with a string message indicating the device status (e.g., "Device detected") or throws an error if the device is not detected.

`$3`

Restarts the connected device.

This method sends a reboot command to the connected device identified by the deviceId. It uses theadb reboot command to restart the device.

#### Examples

`javascript const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('deviceId'); adbHelper.deviceControl.rebootDevice()`

* Throws [Error][322] If there is an issue executing the command or if the device cannot be rebooted.

Returns [Promise][321]\ A promise that resolves when the reboot command is successfully executed.

`$3`

Changes the device's screen brightness.

This method allows you to set the screen brightness of the connected device. The brightness value must be between 0 and 255 (0 to turn off the screen, 255 for maximum brightness).

#### Parameters

* brightness [number][326] The brightness value to set, between 0 and 255.

#### Examples

* Throws [Error][322] If the brightness value is outside the valid range (0 to 255) or if the command fails.

Returns [Promise][321]\ A promise that resolves when the command is executed successfully.

`$3`

Enables or disables the device's auto-rotation.

This method allows you to enable or disable the auto-rotation feature of the connected device. When enabled, the screen orientation will automatically adjust based on the device's position.

#### Parameters

* enable [boolean][325] true to enable auto-rotation, false to disable it.

#### Examples

`javascript // Enable auto-rotation const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.setAutoRotation(true);`

`javascript // Disable auto-rotation const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.setAutoRotation(false);`

* Throws [Error][322] If the command fails or the device cannot process the command.

Returns [Promise][321]\ A promise that resolves when the command is successfully executed.

`$3`

Enables USB debugging via ADB (part of the Developer Mode).

This method enables the USB debugging feature on the connected device. It is required for establishing a connection between the device and ADB for debugging purposes.

#### Examples

`javascript // Example of enabling USB debugging const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.enableUSBDebugging();`

* Throws [Error][322] If the command fails or the device cannot process the command.

Returns [Promise][321]\ A promise that resolves when USB debugging is successfully enabled.

`$3`

Disables Developer Mode options such as USB debugging.

This method disables USB debugging and other developer options on the connected device. It is used to turn off the developer settings once they are no longer needed.

#### Examples

`javascript // Example of disabling developer mode const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.disableDeveloperMode();`

* Throws [Error][322] If the command fails or the device cannot process the command.

Returns [Promise][321]\ A promise that resolves when USB debugging is successfully disabled.

`$3`

Checks the currently running Android version on the device.

This method retrieves the Android version of the connected device using ADB. It returns the version string which can be used to determine the device's OS version.

#### Examples

Performs a factory reset on the device, erasing all data.

This method resets the device to its factory settings, effectively wiping all data. It uses the ADBMASTER_CLEAR intent to trigger the factory reset process.

#### Examples

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when the device is reset to factory settings.

`$3`

Wipes the user data on the device.

This method erases the user data on the device using the ADB recovery command. It only clears the user data without affecting system settings or installed apps.

#### Examples

`javascript // Example of wiping user data const {ADBHelper} = require('adb-helper'); let adbHelper = new ADBHelper('XXXXXXXXX'); await adbHelper.deviceControl.wipeUserData(); // Wipe user data`

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when the user data is wiped.

`$3`

Reboots the device into recovery mode.

#### Examples

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when the device has successfully rebooted into recovery mode.

`$3`

Changes the system language and region on the device.

#### Parameters

* language[string][320] The language code (e.g., "en", "fr") to set on the device. *region [string][320] The region code (e.g., "US", "FR") to set on the device.

#### Examples

* Throws [Error][322] If any of the ADB commands fail to execute.

Enables silent mode on the device.

This method activates silent mode on the device using the ADB command. It broadcasts the intent to mute audio.

#### Examples

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when silent mode is successfully activated.

`$3`

Disables silent mode on the device.

This method deactivates silent mode on the device using the ADB command. It broadcasts the intent to unmute audio.

#### Examples

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when silent mode is successfully deactivated.

`$3`

Enables the "Do Not Disturb" mode on the device.

This method activates the "Do Not Disturb" mode by setting the global zen_mode to 1 using the ADB command.

#### Examples

* Throws [Error][322] If the ADB command fails to execute.

Enables automatic time synchronization on the device.

This method enables the automatic synchronization of time from an NTP server.

#### Examples

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]\ A promise that resolves when auto time sync is successfully enabled.

`$3`

Checks if developer options are enabled on the device.

This method executes an ADB command to retrieve the value of the development_settings_enabledglobal setting. It returnstrue if developer options are enabled, otherwise it returns false.

#### Examples

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]<[boolean][325]> A promise that resolves to true if developer options are enabled, otherwise false.

`$3`

Checks if USB debugging is enabled on the device.

This method executes an ADB command to retrieve the value of the adb_enabledglobal setting. It returnstrue if USB debugging is enabled, otherwise it returns false.

#### Examples

* Throws [Error][322] If the ADB command fails to execute.

Returns [Promise][321]<[boolean][325]> A promise that resolves to true if USB debugging is enabled, otherwise false.

##

Executes an ADB shell command.

This method sends the given command to the ADB shell and returns the response.

`$3`

* command [string][320] The ADB shell command to execute.

Returns [Promise][321]\ A promise that resolves with the response from the ADB shell.

`FileManager`

Extends ADB

FileManager class provides high-level ADB-based file system operations on an Android device.

`$3`

* remotePath [string][320] The path to check disk usage (e.g. "/sdcard").

#### Examples

Returns [Promise][321]<[string][320]> Promise - The raw output of the 'df' command on the device.

`$3`

Checks if a file or directory exists on the Android device.

#### Parameters

* remotePath [string][320] Absolute path to the file or directory.

#### Examples

``javascript`ts const doesExist = await fileManager.exists('/sdcard/Download/photo.jpg'); console.log(doesExist); // true or false```

Returns [Promise][321]<[boolean][325]> Promise - True if it exists, false otherwise.

`$3`

Renames or moves a file or directory on the Android device.

#### Parameters

* oldPath[string][320] The current absolute path of the file or directory. *newPath [string][320] The new absolute path (new name or location).

#### Examples

``javascript`ts await fileManager.renameFile('/sdcard/Download/oldname.txt', '/sdcard/Download/newname.txt'); console.log('File renamed successfully');```

Returns [Promise][321]\ Promise

Writes string content to a file on the Android device.

If the file already exists, it will be overwritten. If it doesn't exist, it will be created. This method supports writing small text content directly via ADB.

#### Parameters

* remotePath[string][320] The absolute path to the target file on the device. *content [string][320] The text content to be written into the file.

#### Examples

``javascript`ts await fileManager.writeFile('/sdcard/Download/note.txt', 'Hello from ADB!'); console.log('File written successfully');````

* Throws any Will throw an error if the write operation fails.

Returns [Promise][321]\ Promise