Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

ITestDevice

public interface ITestDevice
implements INativeDevice

com.android.tradefed.device.ITestDevice

Known indirect subclasses

IManagedTestDevice, LocalAndroidVirtualDevice, ManagedRemoteDevice, NativeDevice, NestedRemoteDevice, RemoteAndroidDevice, RemoteAndroidVirtualDevice, TestDevice

IManagedTestDevice	A ITestDevice whose lifecycle is managed.
LocalAndroidVirtualDevice	The class for local virtual devices running on TradeFed host.
ManagedRemoteDevice	A device running inside a virtual machine that we manage remotely via a Tradefed instance inside the VM.
NativeDevice	Default implementation of a `ITestDevice` Non-full stack android devices.
NestedRemoteDevice	Representation of the device running inside a remote Cuttlefish VM.
RemoteAndroidDevice	Implementation of a `ITestDevice` for a full stack android device connected via adb connect.
RemoteAndroidVirtualDevice	Extends `RemoteAndroidDevice` behavior for a full stack android device running in the Google Compute Engine (Gce).
TestDevice	Implementation of a `ITestDevice` for a full stack android device

Provides an reliable and slightly higher level API to a ddmlib IDevice.

Retries device commands for a configurable amount, and provides a device recovery interface for devices which are unresponsive.

Summary

Nested classes
`class`	`ITestDevice.ApexInfo` A simple struct class to store information about a single APEX
`class`	`ITestDevice.MountPointInfo` A simple struct class to store information about a single mountpoint

Public methods
`abstract boolean`	`canSwitchToHeadlessSystemUser()` Returns whether it's allowed to switch to the headless SYSTEM user.
`abstract boolean`	`checkConnectivity()` Check that device has network connectivity.
`abstract boolean`	`clearErrorDialogs()` Attempt to dismiss any error dialogs currently displayed on device UI.
`abstract void`	`clearLastConnectedWifiNetwork()` Clears the last connected wifi network.
`abstract boolean`	`connectToWifiNetwork( wifiSsidToPsk)` Connects to a wifi network.
`abstract boolean`	`connectToWifiNetwork( wifiSsidToPsk, boolean scanSsid)` Connects to a wifi network.
`abstract boolean`	`connectToWifiNetwork(String wifiSsid, String wifiPsk)` Connects to a wifi network.
`abstract boolean`	`connectToWifiNetwork(String wifiSsid, String wifiPsk, boolean scanSsid)` Connects to a wifi network.
`abstract boolean`	`connectToWifiNetworkIfNeeded(String wifiSsid, String wifiPsk, boolean scanSsid)` A variant of `connectToWifiNetwork(String, String)` that only connects if device currently does not have network connectivity.
`abstract boolean`	`connectToWifiNetworkIfNeeded(String wifiSsid, String wifiPsk)` A variant of `connectToWifiNetwork(String, String)` that only connects if device currently does not have network connectivity.
`abstract int`	`createUser(String name)` Create a user with a given name and default flags 0.
`abstract int`	`createUser(String name, boolean guest, boolean ephemeral)` Create a user with a given name and the provided flags
`abstract int`	`createUser(String name, boolean guest, boolean ephemeral, boolean forTesting)` Create a user with a given name and the provided flags
`abstract int`	`createUserNoThrow(String name)` Create a user with a given name and default flags 0.
`abstract void`	`deregisterDeviceActionReceiver(IDeviceActionReceiver deviceActionReceiver)` Removes the registered `IDeviceActionReceiver`.
`abstract void`	`disableKeyguard()` Attempts to disable the keyguard.
`abstract boolean`	`disableNetworkMonitor()` Disables network monitoring on device.
`abstract boolean`	`disconnectFromWifi()` Disconnects from a wifi network.
`abstract boolean`	`doesFileExist(String deviceFilePath, int userId)` Helper method to determine if file on device exists for a given user.
`abstract File`	`dumpHeap(String process, String devicePath)` Attempt to dump the heap from the system_server.
`abstract boolean`	`enableNetworkMonitor()` Enables network monitoring on device.
`abstract`	`getActiveApexes()` Fetch the information about APEXes activated on the device.
`abstract`	`getAllSettings(String namespace)` Return key value pairs of requested namespace.
`abstract String`	`getAndroidId(int userId)` Find and return the android-id associated to a userId, null if not found.
`abstract`	`getAndroidIds()` Create a Map of android ids found matching user ids.
`abstract PackageInfo`	`getAppPackageInfo(String packageName)` Fetch information about a package installed on device.
`abstract`	`getAppPackageInfos()` Fetch information of packages installed on the device.
`abstract InputStreamSource`	`getBugreport()` Retrieves a bugreport from the device.
`abstract InputStreamSource`	`getBugreportz()` Retrieves a bugreportz from the device.
`abstract DeviceFoldableState`	`getCurrentFoldableState()` Returns the current foldable state of the device or null if some issues occurred.
`abstract int`	`getCurrentUser()` Return the id of the current running user.
`abstract`	`getFoldableStates()` Returns the list of foldable states on the device.
`abstract`	`getInstalledPackageNames()` Fetch the application package names present on the device.
`abstract String`	`getIpAddress()` Gets the device's IP address.
`abstract KeyguardControllerState`	`getKeyguardState()` Return an object to get the current state of the keyguard or null if not supported.
`abstract Integer`	`getMainUserId()` Returns the main user id.
`abstract`	`getMainlineModuleInfo()` Get the information about the mainline modules installed on the device.
`abstract int`	`getMaxNumberOfRunningUsersSupported()` Get the maximum number of supported simultaneously running users.
`abstract int`	`getMaxNumberOfUsersSupported()` Get the maximum number of supported users.
`abstract TestDeviceOptions`	`getOptions()` Fetch the test options for the device.
`abstract Integer`	`getPrimaryUserId()` This method is deprecated. getPrimaryUser was deprecated from UserManager service, use `ERROR(/android.os.UserManager#getMainUserId())` to get first full user or 0 for system. Note that for headless system it is not a full user.
`abstract InputStreamSource`	`getScreenshot(String format, boolean rescale)` Grabs a screenshot from the device.
`abstract InputStreamSource`	`getScreenshot(long displayId)` Grabs a screenshot from the device given display id.
`abstract InputStreamSource`	`getScreenshot(String format)` Grabs a screenshot from the device.
`abstract InputStreamSource`	`getScreenshot()` Grabs a screenshot from the device.
`abstract String`	`getSetting(int userId, String namespace, String key)` Return the value of the requested setting.
`abstract String`	`getSetting(String namespace, String key)` See `getSetting(int, String, String)` and performed on system user.
`abstract`	`getUninstallablePackageNames()` Fetch the application package names that can be uninstalled.
`abstract int`	`getUserFlags(int userId)` Find and return the flags of a given user.
`abstract`	`getUserInfos()` Gets the Map of useId to `UserInfo` on the device.
`abstract int`	`getUserSerialNumber(int userId)` Return the serial number associated to the userId if found, -10000 in any other cases.
`abstract boolean`	`hasFeature(String feature)` Check if a feature is available on a device.
`abstract String`	`installPackage(File packageFile, boolean reinstall, String... extraArgs)` Install an Android package on device.
`abstract String`	`installPackage(File packageFile, boolean reinstall, boolean grantPermissions, String... extraArgs)` Install an Android package on device.
`abstract String`	`installPackageForUser(File packageFile, boolean reinstall, int userId, String... extraArgs)` Install an Android package on device for a given user.
`abstract String`	`installPackageForUser(File packageFile, boolean reinstall, boolean grantPermissions, int userId, String... extraArgs)` Install an Android package on device for a given user.
`default String`	`installPackages( packageFiles, boolean reinstall, String... extraArgs)` Install an Android application made of several APK files (one main and extra split packages).
`default String`	`installPackages( packageFiles, boolean reinstall, boolean grantPermissions, String... extraArgs)` Install an Android application made of several APK files (one main and extra split packages) that are sitting on the android device.
`default String`	`installPackagesForUser( packageFiles, boolean reinstall, int userId, String... extraArgs)` Install an Android application made of several APK files (one main and extra split packages) for a given user.
`default String`	`installPackagesForUser( packageFiles, boolean reinstall, boolean grantPermissions, int userId, String... extraArgs)` Install an Android application made of several APK files (one main and extra split packages) for a given user.
`default String`	`installRemotePackages( remoteApkPaths, boolean reinstall, String... extraArgs)` Install an Android application made of several APK files (one main and extra split packages) that are sitting on the android device.
`default String`	`installRemotePackages( remoteApkPaths, boolean reinstall, boolean grantPermissions, String... extraArgs)` Install an Android application made of several APK files (one main and extra split packages) that are sitting on the android device.
`abstract boolean`	`isHeadlessSystemUserMode()` Returns whether the device uses headless system user mode.
`abstract boolean`	`isMainUserPermanentAdmin()` Returns whether the main user is a permanent admin and can't be deleted or downgraded to non-admin status.
`abstract boolean`	`isMultiUserSupported()` Determines if multi user is supported.
`abstract boolean`	`isPackageInstalled(String packageName, String userId)` Query the device for a given package name and given user id to check if it's currently installed or not for that user.
`abstract boolean`	`isPackageInstalled(String packageName)` Query the device for a given package name to check if it's currently installed or not.
`abstract boolean`	`isUserRunning(int userId)` Check if a given user is running.
`abstract boolean`	`isUserSecondary(int userId)` Return whether the specified user is a secondary user according to it's flags.
`abstract boolean`	`isUserVisible(int userId)` Checks if the given user is visible.
`abstract boolean`	`isUserVisibleOnDisplay(int userId, int displayId)` Checks if the given user is visible in the given display.
`abstract boolean`	`isVisibleBackgroundUsersOnDefaultDisplaySupported()` Returns whether the device allow users to be started visible in the background in the `ERROR(/java.android.view.Display#DEFAULT_DISPLAY)`.
`abstract boolean`	`isVisibleBackgroundUsersSupported()` Returns whether the device allow users to be started visible in the background.
`abstract boolean`	`isWifiEnabled()` Test if wifi is enabled.
`abstract`	`listDisplayIds()` Collect the list of available displays id on the device as reported by "dumpsys SurfaceFlinger".
`abstract`	`listDisplayIdsForStartingVisibleBackgroundUsers()` Gets the list of displays that can be used to `start a user visible in the background`.
`abstract`	`listUsers()` Gets the list of users on the device.
`abstract boolean`	`logBugreport(String dataName, ITestLogger listener)` Helper method to take a bugreport and log it to the reporters.
`default void`	`notifySnapuserd(SnapuserdWaitPhase waitPhase)` Notify the device to wait for snapuserd completion.
`abstract void`	`registerDeviceActionReceiver(IDeviceActionReceiver deviceActionReceiver)` Registers a `IDeviceActionReceiver` for this device.
`abstract boolean`	`removeAdmin(String componentName, int userId)` Remove given device admin in given user and return `true` if it is successful, `false` otherwise.
`abstract void`	`removeOwners()` Remove all existing device profile owners with the best effort.
`abstract boolean`	`removeUser(int userId)` Remove a given user from the device.
`abstract boolean`	`setDeviceOwner(String componentName, int userId)` Set a device admin component as device owner in given user.
`abstract void`	`setSetting(String namespace, String key, String value)` See `setSetting(int, String, String, String)` and performed on system user.
`abstract void`	`setSetting(int userId, String namespace, String key, String value)` Add a setting value to the namespace of a given user.
`abstract boolean`	`startUser(int userId)` Starts a given user in the background if it is currently stopped.
`abstract boolean`	`startUser(int userId, boolean waitFlag)` Starts a given user in the background if it is currently stopped.
`abstract boolean`	`startVisibleBackgroundUser(int userId, int displayId, boolean waitFlag)` Starts a given user in the background, visible in the given display (i.e., allowing the user to launch activities in that display).
`abstract boolean`	`stopUser(int userId)` Stops a given user.
`abstract boolean`	`stopUser(int userId, boolean waitFlag, boolean forceFlag)` Stop a given user.
`abstract boolean`	`switchUser(int userId)` Switch to another userId with a default timeout.
`abstract boolean`	`switchUser(int userId, long timeout)` Switch to another userId with the provided timeout as deadline.
`abstract Bugreport`	`takeBugreport()` Take a bugreport and returns it inside a `Bugreport` object to handle it.
`abstract String`	`uninstallPackage(String packageName)` Uninstall an Android package from device.
`abstract String`	`uninstallPackageForUser(String packageName, int userId)` Uninstall an Android package from device for a given user.
`default void`	`waitForSnapuserd(SnapuserdWaitPhase currentPhase)` If expected, wait for snapuserd to complete.

Public methods

canSwitchToHeadlessSystemUser

public abstract boolean canSwitchToHeadlessSystemUser ()

Returns whether it's allowed to switch to the headless SYSTEM user.

Returns
`boolean`

Throws
`DeviceNotAvailableException`

checkConnectivity

public abstract boolean checkConnectivity ()

Check that device has network connectivity.

Returns
`boolean`	`true` if device has a working network connection, `false` overwise.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

clearErrorDialogs

public abstract boolean clearErrorDialogs ()

Attempt to dismiss any error dialogs currently displayed on device UI.

Returns
`boolean`	`true` if no dialogs were present or dialogs were successfully cleared. `false` otherwise.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

clearLastConnectedWifiNetwork

public abstract void clearLastConnectedWifiNetwork ()

Clears the last connected wifi network. This should be called when starting a new invocation to avoid connecting to the wifi network used in the previous test after device reboots.

connectToWifiNetwork

public abstract boolean connectToWifiNetwork ( wifiSsidToPsk)

Connects to a wifi network.

Turns on wifi and blocks until a successful connection is made with one of the wifi networks given in the wifiSsidToPsk map. Once a connection is made, the instance will try to restore the connection after every reboot until ITestDevice.disconnectFromWifi() or ITestDevice.clearLastConnectedWifiNetwork() is called.

Parameters
`wifiSsidToPsk`	: A map of wifi SSIDs to passwords.

Returns
`boolean`	`true` if connected to wifi network successfully. `false` otherwise

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

connectToWifiNetwork

public abstract boolean connectToWifiNetwork ( wifiSsidToPsk, 
                boolean scanSsid)

Connects to a wifi network.

Parameters
`wifiSsidToPsk`	: A map of wifi SSIDs to passwords.
`scanSsid`	`boolean`: whether to scan for hidden SSIDs for this network.

Returns
`boolean`	`true` if connected to wifi network successfully. `false` otherwise

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

connectToWifiNetwork

public abstract boolean connectToWifiNetwork (String wifiSsid, 
                String wifiPsk)

Connects to a wifi network.

Turns on wifi and blocks until a successful connection is made to the specified wifi network. Once a connection is made, the instance will try to restore the connection after every reboot until ITestDevice.disconnectFromWifi() or ITestDevice.clearLastConnectedWifiNetwork() is called.

Parameters
`wifiSsid`	`String`: the wifi ssid to connect to
`wifiPsk`	`String`: PSK passphrase or null if unencrypted

Returns
`boolean`	`true` if connected to wifi network successfully. `false` otherwise

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

connectToWifiNetwork

public abstract boolean connectToWifiNetwork (String wifiSsid, 
                String wifiPsk, 
                boolean scanSsid)

Connects to a wifi network.

Parameters
`wifiSsid`	`String`: the wifi ssid to connect to
`wifiPsk`	`String`: PSK passphrase or null if unencrypted
`scanSsid`	`boolean`: whether to scan for hidden SSID for this network.

Returns
`boolean`	`true` if connected to wifi network successfully. `false` otherwise

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

connectToWifiNetworkIfNeeded

public abstract boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk, 
                boolean scanSsid)

A variant of connectToWifiNetwork(String, String) that only connects if device currently does not have network connectivity.

Parameters
`scanSsid`	`boolean`: whether to scan for hidden SSID for this network

Returns
`boolean`	`true` if connected to wifi network successfully. `false` otherwise

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

connectToWifiNetworkIfNeeded

public abstract boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk)

A variant of connectToWifiNetwork(String, String) that only connects if device currently does not have network connectivity.

Returns
`boolean`	`true` if connected to wifi network successfully. `false` otherwise

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

createUser

public abstract int createUser (String name)

Create a user with a given name and default flags 0.

Parameters
`name`	`String`: of the user to create on the device

Returns
`int`	the integer for the user id created

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

createUser

public abstract int createUser (String name, 
                boolean guest, 
                boolean ephemeral)

Create a user with a given name and the provided flags

Parameters
`name`	`String`: of the user to create on the device
`guest`	`boolean`: enable the user flag --guest during creation
`ephemeral`	`boolean`: enable the user flag --ephemeral during creation

Returns
`int`	id of the created user

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

createUser

public abstract int createUser (String name, 
                boolean guest, 
                boolean ephemeral, 
                boolean forTesting)

Create a user with a given name and the provided flags

Parameters
`name`	`String`: of the user to create on the device
`guest`	`boolean`: enable the user flag --guest during creation
`ephemeral`	`boolean`: enable the user flag --ephemeral during creation
`forTesting`	`boolean`: enable the test flag --for-testing during creation

Returns
`int`	id of the created user

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

createUserNoThrow

public abstract int createUserNoThrow (String name)

Create a user with a given name and default flags 0.

Parameters
`name`	`String`: of the user to create on the device

Returns
`int`	the integer for the user id created or -1 for error.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

deregisterDeviceActionReceiver

public abstract void deregisterDeviceActionReceiver (IDeviceActionReceiver deviceActionReceiver)

Removes the registered IDeviceActionReceiver.

Parameters
`deviceActionReceiver`	`IDeviceActionReceiver`: A `IDeviceActionReceiver` which will be removed.

disableKeyguard

public abstract void disableKeyguard ()

Attempts to disable the keyguard.

First wait for the input dispatch to become ready, this happens around the same time when the device reports BOOT_COMPLETE, apparently asynchronously, because current framework implementation has occasional race condition. Then command is sent to dismiss keyguard (works on non-secure ones only)

Throws
`DeviceNotAvailableException`

disableNetworkMonitor

public abstract boolean disableNetworkMonitor ()

Disables network monitoring on device.

Returns
`boolean`	`true` if monitoring is disabled successfully. `false` if it failed.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

disconnectFromWifi

public abstract boolean disconnectFromWifi ()

Disconnects from a wifi network.

Removes all networks from known networks list and disables wifi.

Returns
`boolean`	`true` if disconnected from wifi network successfully. `false` if disconnect failed.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

doesFileExist

public abstract boolean doesFileExist (String deviceFilePath, 
                int userId)

Helper method to determine if file on device exists for a given user.

Parameters
`deviceFilePath`	`String`: the absolute path of file on device to check
`userId`	`int`: The user id against which to check file existence

Returns
`boolean`	`true` if file exists, `false` otherwise.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

dumpHeap

public abstract File dumpHeap (String process, 
                String devicePath)

Attempt to dump the heap from the system_server. It is the caller responsibility to clean up the dumped file.

Parameters
`process`	`String`: the name of the device process to dumpheap on.
`devicePath`	`String`: the path on the device where to put the dump. This must be a location where permissions allow it.

Returns
`File`	the `ERROR(/File)` containing the report. Null if something failed.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

enableNetworkMonitor

public abstract boolean enableNetworkMonitor ()

Enables network monitoring on device.

Returns
`boolean`	`true` if monitoring is enabled successfully. `false` if it failed.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

getActiveApexes

public abstract  getActiveApexes ()

Fetch the information about APEXes activated on the device.

Returns
	`ERROR(/Set)` of `ApexInfo` currently activated on the device

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getAllSettings

public abstract  getAllSettings (String namespace)

Return key value pairs of requested namespace.

Parameters
`namespace`	`String`: must be one of {"system", "secure", "global"}

Returns
	the map of key value pairs. Null if namespace is not supported.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getAndroidId

public abstract String getAndroidId (int userId)

Find and return the android-id associated to a userId, null if not found.

Parameters
`userId`	`int`

Returns
`String`

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getAndroidIds

public abstract  getAndroidIds ()

Create a Map of android ids found matching user ids. There is no insurance that each user id will found an android id associated in this function so some user ids may match null.

Returns
	Map of android ids found matching user ids.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getAppPackageInfo

public abstract PackageInfo getAppPackageInfo (String packageName)

Fetch information about a package installed on device.

Parameters
`packageName`	`String`

Returns
`PackageInfo`	the `PackageInfo` or `null` if information could not be retrieved

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getAppPackageInfos

public abstract  getAppPackageInfos ()

Fetch information of packages installed on the device.

Returns
	`ERROR(/List)` of `PackageInfo`s installed on the device.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getBugreport

public abstract InputStreamSource getBugreport ()

Retrieves a bugreport from the device.

The implementation of this is guaranteed to continue to work on a device without an sdcard (or where the sdcard is not yet mounted).

Returns
`InputStreamSource`	An `InputStreamSource` which will produce the bugreport contents on demand. In case of failure, the `InputStreamSource` will produce an empty `ERROR(/InputStream)`.

getBugreportz

public abstract InputStreamSource getBugreportz ()

Retrieves a bugreportz from the device. Zip format bugreport contains the main bugreport and other log files that are useful for debugging.

Only supported for 'adb version' > 1.0.36

Returns
`InputStreamSource`	a `InputStreamSource` of the zip file containing the bugreportz, return null in case of failure.

getCurrentFoldableState

public abstract DeviceFoldableState getCurrentFoldableState ()

Returns the current foldable state of the device or null if some issues occurred.

Returns
`DeviceFoldableState`

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getCurrentUser

public abstract int getCurrentUser ()

Return the id of the current running user. In case of error, return -10000.

Returns
`int`

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getFoldableStates

public abstract  getFoldableStates ()

Returns the list of foldable states on the device. Can be obtained with "cmd device_state print-states".

Returns

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getInstalledPackageNames

public abstract  getInstalledPackageNames ()

Fetch the application package names present on the device.

Returns
	`ERROR(/Set)` of `String` package names currently installed on the device.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getIpAddress

public abstract String getIpAddress ()

Gets the device's IP address.

Returns
`String`	the device's IP address, or `null` if device has no IP address

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

getKeyguardState

public abstract KeyguardControllerState getKeyguardState ()

Return an object to get the current state of the keyguard or null if not supported.

Returns
`KeyguardControllerState`	a `KeyguardControllerState` containing a snapshot of the state of the keyguard and returns Null if the Keyguard query is not supported.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

getMainUserId

public abstract Integer getMainUserId ()

Returns the main user id.

Returns
`Integer`	the userId of the main user if there is one, and null if there is no main user.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceRuntimeException`	if the output from the device is not as expected.
`DeviceNotAvailableException`

getMainlineModuleInfo

public abstract  getMainlineModuleInfo ()

Get the information about the mainline modules installed on the device.

Returns
	`ERROR(/Set)` of `String` mainline modules currently installed on the device.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getMaxNumberOfRunningUsersSupported

public abstract int getMaxNumberOfRunningUsersSupported ()

Get the maximum number of supported simultaneously running users. Defaults to 0.

Returns
`int`	an integer indicating the number of simultaneously running users

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getMaxNumberOfUsersSupported

public abstract int getMaxNumberOfUsersSupported ()

Get the maximum number of supported users. Defaults to 0.

Returns
`int`	an integer indicating the number of supported users

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getOptions

public abstract TestDeviceOptions getOptions ()

Fetch the test options for the device.

Returns
`TestDeviceOptions`	`TestDeviceOptions` related to the device under test.

getPrimaryUserId

public abstract Integer getPrimaryUserId ()

This method is deprecated.
getPrimaryUser was deprecated from UserManager service, use ERROR(/android.os.UserManager#getMainUserId()) to get first full user or 0 for system. Note that for headless system it is not a full user.

Returns the primary user id.

Returns
`Integer`	the userId of the primary user if there is one, and null if there is no primary user.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceRuntimeException`	if the output from the device is not as expected.
`DeviceNotAvailableException`

getScreenshot

public abstract InputStreamSource getScreenshot (String format, 
                boolean rescale)

Grabs a screenshot from the device. Recommended to use getScreenshot(String) instead with JPEG encoding for smaller size.

Parameters
`format`	`String`: supported PNG, JPEG
`rescale`	`boolean`: if screenshot should be rescaled to reduce the size of resulting image

Returns
`InputStreamSource`	a `InputStreamSource` of the screenshot in format, or `null` if the screenshot was not successful.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getScreenshot

public abstract InputStreamSource getScreenshot (long displayId)

Grabs a screenshot from the device given display id. Format is PNG.

TODO: extend the implementations above to support 'format' and 'rescale'

Parameters
`displayId`	`long`: the display id of the screen to get screenshot from.

Returns
`InputStreamSource`	a `InputStreamSource` of the screenshot in format, or `null` if the screenshot was not successful.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getScreenshot

public abstract InputStreamSource getScreenshot (String format)

Grabs a screenshot from the device. Recommended to use getScreenshot(format) instead with JPEG encoding for smaller size

Parameters
`format`	`String`: supported PNG, JPEG

Returns
`InputStreamSource`	a `InputStreamSource` of the screenshot in format, or `null` if the screenshot was not successful.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getScreenshot

public abstract InputStreamSource getScreenshot ()

Grabs a screenshot from the device.

Returns
`InputStreamSource`	a `InputStreamSource` of the screenshot in png format, or `null` if the screenshot was not successful.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getSetting

public abstract String getSetting (int userId, 
                String namespace, 
                String key)

Return the value of the requested setting. namespace must be one of: {"system", "secure", "global"}

Parameters
`userId`	`int`
`namespace`	`String`
`key`	`String`

Returns
`String`	the value associated with the namespace:key of a user. Null if not found.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getSetting

public abstract String getSetting (String namespace, 
                String key)

See getSetting(int, String, String) and performed on system user.

Parameters
`namespace`	`String`
`key`	`String`

Returns
`String`

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getUninstallablePackageNames

public abstract  getUninstallablePackageNames ()

Fetch the application package names that can be uninstalled. This is presently defined as non-system packages, and updated system packages.

Returns
	`ERROR(/Set)` of uninstallable `String` package names currently installed on the device.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getUserFlags

public abstract int getUserFlags (int userId)

Find and return the flags of a given user. Flags are defined in "android.content.pm.UserInfo" class in Android Open Source Project.

Parameters
`userId`	`int`

Returns
`int`	the flags associated with the userId provided if found, -10000 in any other cases.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getUserInfos

public abstract  getUserInfos ()

Gets the Map of useId to UserInfo on the device. Will throw DeviceRuntimeException if output from device is not as expected.

Returns
	the list of UserInfo objects.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
	com.android.tradefed.device.DeviceRuntimeException
`DeviceNotAvailableException`

getUserSerialNumber

public abstract int getUserSerialNumber (int userId)

Return the serial number associated to the userId if found, -10000 in any other cases.

Parameters
`userId`	`int`

Returns
`int`

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

hasFeature

public abstract boolean hasFeature (String feature)

Check if a feature is available on a device.

Parameters
`feature`	`String`: which format should be "feature:" or "" directly.

Returns
`boolean`	True if feature is found, false otherwise.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

installPackage

public abstract String installPackage (File packageFile, 
                boolean reinstall, 
                String... extraArgs)

Install an Android package on device.

Parameters
`packageFile`	`File`: the apk file to install
`reinstall`	`boolean`: `true` if a reinstall should be performed
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

installPackage

public abstract String installPackage (File packageFile, 
                boolean reinstall, 
                boolean grantPermissions, 
                String... extraArgs)

Install an Android package on device.

Note: Only use cases that requires explicit control of granting runtime permission at install time should call this function.

Parameters
`packageFile`	`File`: the apk file to install
`reinstall`	`boolean`: `true` if a reinstall should be performed
`grantPermissions`	`boolean`: if all runtime permissions should be granted at install time
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.
`UnsupportedOperationException`	if runtime permission is not supported by the platform on device.

installPackageForUser

public abstract String installPackageForUser (File packageFile, 
                boolean reinstall, 
                int userId, 
                String... extraArgs)

Install an Android package on device for a given user.

Parameters
`packageFile`	`File`: the apk file to install
`reinstall`	`boolean`: `true` if a reinstall should be performed
`userId`	`int`: the integer user id to install for.
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

installPackageForUser

public abstract String installPackageForUser (File packageFile, 
                boolean reinstall, 
                boolean grantPermissions, 
                int userId, 
                String... extraArgs)

Install an Android package on device for a given user.

Note: Only use cases that requires explicit control of granting runtime permission at install time should call this function.

Parameters
`packageFile`	`File`: the apk file to install
`reinstall`	`boolean`: `true` if a reinstall should be performed
`grantPermissions`	`boolean`: if all runtime permissions should be granted at install time
`userId`	`int`: the integer user id to install for.
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.
`UnsupportedOperationException`	if runtime permission is not supported by the platform on device.

installPackages

public String installPackages ( packageFiles, 
                boolean reinstall, 
                String... extraArgs)

Install an Android application made of several APK files (one main and extra split packages). See "https://developer.android.com/studio/build/configure-apk-splits" on how to split apk to several files.

Parameters
`packageFiles`	: the local apk files
`reinstall`	`boolean`: `true` if a reinstall should be performed
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.
`UnsupportedOperationException`	if runtime permission is not supported by the platform on device.

installPackages

public String installPackages ( packageFiles, 
                boolean reinstall, 
                boolean grantPermissions, 
                String... extraArgs)

Install an Android application made of several APK files (one main and extra split packages) that are sitting on the android device. See "https://developer.android.com/studio/build/configure-apk-splits" on how to split apk to several files.

Note: Only use cases that requires explicit control of granting runtime permission at install time should call this function.

Parameters
`packageFiles`	: the remote apk file paths to install
`reinstall`	`boolean`: `true` if a reinstall should be performed
`grantPermissions`	`boolean`: if all runtime permissions should be granted at install time
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.
`UnsupportedOperationException`	if runtime permission is not supported by the platform on device.

installPackagesForUser

public String installPackagesForUser ( packageFiles, 
                boolean reinstall, 
                int userId, 
                String... extraArgs)

Install an Android application made of several APK files (one main and extra split packages) for a given user. See "https://developer.android.com/studio/build/configure-apk-splits" on how to split apk to several files.

Parameters
`packageFiles`	: the local apk files
`reinstall`	`boolean`: `true` if a reinstall should be performed
`userId`	`int`: the integer user id to install for.
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.
`UnsupportedOperationException`	if runtime permission is not supported by the platform on device.

installPackagesForUser

public String installPackagesForUser ( packageFiles, 
                boolean reinstall, 
                boolean grantPermissions, 
                int userId, 
                String... extraArgs)

Note: Only use cases that requires explicit control of granting runtime permission at install time should call this function.

Parameters
`packageFiles`	: the local apk files
`reinstall`	`boolean`: `true` if a reinstall should be performed
`grantPermissions`	`boolean`: if all runtime permissions should be granted at install time
`userId`	`int`: the integer user id to install for.
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.
`UnsupportedOperationException`	if runtime permission is not supported by the platform on device.

installRemotePackages

public String installRemotePackages ( remoteApkPaths, 
                boolean reinstall, 
                String... extraArgs)

Parameters
`remoteApkPaths`	: the remote apk file paths
`reinstall`	`boolean`: `true` if a reinstall should be performed
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.
`UnsupportedOperationException`	if runtime permission is not supported by the platform on device.

installRemotePackages

public String installRemotePackages ( remoteApkPaths, 
                boolean reinstall, 
                boolean grantPermissions, 
                String... extraArgs)

Note: Only use cases that requires explicit control of granting runtime permission at install time should call this function.

Parameters
`remoteApkPaths`	: the remote apk file paths
`reinstall`	`boolean`: `true` if a reinstall should be performed
`grantPermissions`	`boolean`: if all runtime permissions should be granted at install time
`extraArgs`	`String`: optional extra arguments to pass. See 'adb shell pm -h' for available options.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.
`UnsupportedOperationException`	if runtime permission is not supported by the platform on device.

isHeadlessSystemUserMode

public abstract boolean isHeadlessSystemUserMode ()

Returns whether the device uses headless system user mode.

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isMainUserPermanentAdmin

public abstract boolean isMainUserPermanentAdmin ()

Returns whether the main user is a permanent admin and can't be deleted or downgraded to non-admin status.

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isMultiUserSupported

public abstract boolean isMultiUserSupported ()

Determines if multi user is supported.

Returns
`boolean`	true if multi user is supported, false otherwise

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

isPackageInstalled

public abstract boolean isPackageInstalled (String packageName, 
                String userId)

Query the device for a given package name and given user id to check if it's currently installed or not for that user.

Parameters
`packageName`	`String`: the package we are checking if it's installed.
`userId`	`String`: The user id we are checking the package is installed for. If null, primary user zero will be used.

Returns
`boolean`	True if the package is reported as installed. False otherwise.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

isPackageInstalled

public abstract boolean isPackageInstalled (String packageName)

Query the device for a given package name to check if it's currently installed or not.

Parameters
`packageName`	`String`

Returns
`boolean`	True if the package is reported as installed. False otherwise.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

isUserRunning

public abstract boolean isUserRunning (int userId)

Check if a given user is running.

Parameters
`userId`	`int`

Returns
`boolean`	True if the user is running, false in every other cases.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

isUserSecondary

public abstract boolean isUserSecondary (int userId)

Return whether the specified user is a secondary user according to it's flags.

Parameters
`userId`	`int`

Returns
`boolean`	true if the user is secondary, false otherwise.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

isUserVisible

public abstract boolean isUserVisible (int userId)

Checks if the given user is visible.

A "visible" user is a user that is interacting with the "human" user and hence is able to launch launch activities (typically in the default display).

Parameters
`userId`	`int`

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isUserVisibleOnDisplay

public abstract boolean isUserVisibleOnDisplay (int userId, 
                int displayId)

Checks if the given user is visible in the given display.

A "visible" user is a user that is interacting with the "human" user and hence is able to launch launch activities in that display.

Parameters
`userId`	`int`
`displayId`	`int`

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isVisibleBackgroundUsersOnDefaultDisplaySupported

public abstract boolean isVisibleBackgroundUsersOnDefaultDisplaySupported ()

Returns whether the device allow users to be started visible in the background in the ERROR(/java.android.view.Display#DEFAULT_DISPLAY).

If it does, you could call startVisibleBackgroundUser(int, int, boolean), passing a display returned by listDisplayIdsForStartingVisibleBackgroundUsers() (which should include ERROR(/java.android.view.Display#DEFAULT_DISPLAY)).

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isVisibleBackgroundUsersSupported

public abstract boolean isVisibleBackgroundUsersSupported ()

Returns whether the device allow users to be started visible in the background.

If it does, you could call startVisibleBackgroundUser(int, int, boolean), passing a display returned by listDisplayIdsForStartingVisibleBackgroundUsers().

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isWifiEnabled

public abstract boolean isWifiEnabled ()

Test if wifi is enabled.

Checks if wifi is enabled on device. Useful for asserting wifi status before tests that shouldn't run with wifi, e.g. mobile data tests.

Returns
`boolean`	`true` if wifi is enabled. `false` if disabled

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

listDisplayIds

public abstract  listDisplayIds ()

Collect the list of available displays id on the device as reported by "dumpsys SurfaceFlinger".

Returns
	The list of displays. Default always returns the default display 0.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

listDisplayIdsForStartingVisibleBackgroundUsers

public abstract  listDisplayIdsForStartingVisibleBackgroundUsers ()

Gets the list of displays that can be used to start a user visible in the background.

Returns

Throws
`DeviceNotAvailableException`

listUsers

public abstract  listUsers ()

Gets the list of users on the device. Will throw DeviceRuntimeException if output from device is not as expected.

Returns
	the list of user ids.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
	com.android.tradefed.device.DeviceRuntimeException
`DeviceNotAvailableException`

logBugreport

public abstract boolean logBugreport (String dataName, 
                ITestLogger listener)

Helper method to take a bugreport and log it to the reporters.

Parameters
`dataName`	`String`: name under which the bugreport will be reported.
`listener`	`ITestLogger`: an `ITestLogger` to log the bugreport.

Returns
`boolean`	True if the logging was successful, false otherwise.

notifySnapuserd

public void notifySnapuserd (SnapuserdWaitPhase waitPhase)

Notify the device to wait for snapuserd completion.

Parameters
`waitPhase`	`SnapuserdWaitPhase`

registerDeviceActionReceiver

public abstract void registerDeviceActionReceiver (IDeviceActionReceiver deviceActionReceiver)

Registers a IDeviceActionReceiver for this device.

All registered IDeviceActionReceivers will be notified before a device action starts and after the device action ends.

Parameters
`deviceActionReceiver`	`IDeviceActionReceiver`: A `IDeviceActionReceiver` which will be registered.

removeAdmin

public abstract boolean removeAdmin (String componentName, 
                int userId)

Remove given device admin in given user and return true if it is successful, false otherwise.

Parameters
`componentName`	`String`: of device admin to be removed.
`userId`	`int`: of user that the device admin lives in.

Returns
`boolean`	True if it is successful, false otherwise.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

removeOwners

public abstract void removeOwners ()

Remove all existing device profile owners with the best effort.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

removeUser

public abstract boolean removeUser (int userId)

Remove a given user from the device.

Parameters
`userId`	`int`: of the user to remove

Returns
`boolean`	true if we were successful in removing the user, false otherwise.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

setDeviceOwner

public abstract boolean setDeviceOwner (String componentName, 
                int userId)

Set a device admin component as device owner in given user.

Parameters
`componentName`	`String`: of device admin to be device owner.
`userId`	`int`: of the user that the device owner lives in.

Returns
`boolean`	True if it is successful, false otherwise.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

setSetting

public abstract void setSetting (String namespace, 
                String key, 
                String value)

See setSetting(int, String, String, String) and performed on system user.

Parameters
`namespace`	`String`
`key`	`String`
`value`	`String`

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

setSetting

public abstract void setSetting (int userId, 
                String namespace, 
                String key, 
                String value)

Add a setting value to the namespace of a given user. Some settings will only be available after a reboot. namespace must be one of: {"system", "secure", "global"}

Parameters
`userId`	`int`
`namespace`	`String`
`key`	`String`
`value`	`String`

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

startUser

public abstract boolean startUser (int userId)

Starts a given user in the background if it is currently stopped. If the user is already running in the background, this method is a NOOP.

Parameters
`userId`	`int`: of the user to start in the background

Returns
`boolean`	true if the user was successfully started in the background.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

startUser

public abstract boolean startUser (int userId, 
                boolean waitFlag)

Starts a given user in the background if it is currently stopped. If the user is already running in the background, this method is a NOOP. Possible to provide extra flag to wait for the operation to have effect.

Parameters
`userId`	`int`: of the user to start in the background
`waitFlag`	`boolean`: will make the command wait until user is started and unlocked.

Returns
`boolean`	true if the user was successfully started in the background.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

startVisibleBackgroundUser

public abstract boolean startVisibleBackgroundUser (int userId, 
                int displayId, 
                boolean waitFlag)

Starts a given user in the background, visible in the given display (i.e., allowing the user to launch activities in that display).

NOTE: this command doesn't check if the user exists, display is available, device supports such feature, etc.

Parameters
`userId`	`int`: of the user to start in the background
`displayId`	`int`: display to start user visible on
`waitFlag`	`boolean`: will make the command wait until user is started and unlocked.

Returns
`boolean`	`true` if the user was successfully started visible in the background.

Throws
`DeviceNotAvailableException`

stopUser

public abstract boolean stopUser (int userId)

Stops a given user. If the user is already stopped, this method is a NOOP. Cannot stop current and system user.

Parameters
`userId`	`int`: of the user to stop.

Returns
`boolean`	true if the user was successfully stopped.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

stopUser

public abstract boolean stopUser (int userId, 
                boolean waitFlag, 
                boolean forceFlag)

Stop a given user. Possible to provide extra flags to wait for the operation to have effect, and force terminate the user. Cannot stop current and system user.

Parameters
`userId`	`int`: of the user to stop.
`waitFlag`	`boolean`: will make the command wait until user is stopped.
`forceFlag`	`boolean`: will force stop the user.

Returns
`boolean`	true if the user was successfully stopped.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

switchUser

public abstract boolean switchUser (int userId)

Switch to another userId with a default timeout. switchUser(int, long).

Parameters
`userId`	`int`

Returns
`boolean`	True if the new userId matches the userId provider. False otherwise.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

switchUser

public abstract boolean switchUser (int userId, 
                long timeout)

Switch to another userId with the provided timeout as deadline. Attempt to disable keyguard after user change is successful.

Parameters
`userId`	`int`
`timeout`	`long`: to wait before returning false for switch-user failed.

Returns
`boolean`	True if the new userId matches the userId provider. False otherwise.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

takeBugreport

public abstract Bugreport takeBugreport ()

Take a bugreport and returns it inside a Bugreport object to handle it. Return null in case of issue. File referenced in the Bugreport object need to be cleaned via Bugreport.close().

Returns
`Bugreport`

uninstallPackage

public abstract String uninstallPackage (String packageName)

Uninstall an Android package from device.

Parameters
`packageName`	`String`: the Android package to uninstall

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

uninstallPackageForUser

public abstract String uninstallPackageForUser (String packageName, 
                int userId)

Uninstall an Android package from device for a given user.

Parameters
`packageName`	`String`: the Android package to uninstall
`userId`	`int`: the integer user id to uninstall for.

Returns
`String`	a `String` with an error code, or `null` if success.

Throws
`DeviceNotAvailableException`	if connection with device is lost and cannot be recovered.

waitForSnapuserd

public void waitForSnapuserd (SnapuserdWaitPhase currentPhase)

If expected, wait for snapuserd to complete.

Parameters
`currentPhase`	`SnapuserdWaitPhase`

Throws
`DeviceNotAvailableException`

ITestDevice

Summary

Nested classes

Public methods

Public methods

canSwitchToHeadlessSystemUser

checkConnectivity

clearErrorDialogs

clearLastConnectedWifiNetwork

connectToWifiNetwork

connectToWifiNetwork

connectToWifiNetwork

connectToWifiNetwork

connectToWifiNetworkIfNeeded

connectToWifiNetworkIfNeeded

createUser

createUser

createUser

createUserNoThrow

deregisterDeviceActionReceiver

disableKeyguard

disableNetworkMonitor

disconnectFromWifi

doesFileExist

dumpHeap

enableNetworkMonitor

getActiveApexes

getAllSettings

getAndroidId

getAndroidIds

getAppPackageInfo

getAppPackageInfos

getBugreport

getBugreportz

getCurrentFoldableState

getCurrentUser

getFoldableStates

getInstalledPackageNames

getIpAddress

getKeyguardState

getMainUserId

getMainlineModuleInfo

getMaxNumberOfRunningUsersSupported

getMaxNumberOfUsersSupported

getOptions

getPrimaryUserId

getScreenshot

getScreenshot

getScreenshot

getScreenshot

getSetting

getSetting

getUninstallablePackageNames

getUserFlags

getUserInfos

getUserSerialNumber

hasFeature

installPackage

installPackage

installPackageForUser

installPackageForUser

installPackages

installPackages

installPackagesForUser

installPackagesForUser

installRemotePackages

installRemotePackages

isHeadlessSystemUserMode

isMainUserPermanentAdmin

isMultiUserSupported

isPackageInstalled

isPackageInstalled

isUserRunning

isUserSecondary

isUserVisible

isUserVisibleOnDisplay

isVisibleBackgroundUsersOnDefaultDisplaySupported

isVisibleBackgroundUsersSupported

isWifiEnabled

listDisplayIds