此页面由 Cloud Translation API 翻译。

TestDevice

public class TestDevice
extends NativeDevice

java.lang.Object 中
↳	com.android.tradefed.device.NativeDevice
	↳	com.android.tradefed.device.TestDevice

已知的直接子类

ManagedRemoteDevice、NestedRemoteDevice、RemoteAndroidDevice

ManagedRemoteDevice	一台在虚拟机内运行的设备，我们通过其中的 Tradefed 实例远程管理该设备虚拟机
NestedRemoteDevice	表示在远程 Cuttlefish 虚拟机内运行的设备。
RemoteAndroidDevice	针对通过以下链接连接的全栈 Android 设备的 `ITestDevice` 实现 adb connect。

已知的间接子类

LocalAndroidVirtualDevice、RemoteAndroidVirtualDevice

LocalAndroidVirtualDevice	用于在 TradeFed 主机上运行的本地虚拟设备的类。
RemoteAndroidVirtualDevice	针对在 Android Studio 中运行的全栈 Android 设备，扩展 `RemoteAndroidDevice` 行为 Google Compute Engine (Gce)。

针对全栈 Android 设备的 ITestDevice 实现

摘要

嵌套类
`class`	`TestDevice.MicrodroidBuilder` 用于创建 Microdroid TestDevice 的构建器。

字段
`public static final String`	`DISMISS_KEYGUARD_CMD` 可用于关闭键盘锁的命令。

公共构造函数
`TestDevice(IDevice device, IDeviceStateMonitor stateMonitor, IDeviceMonitor allocationMonitor)`

公共方法
`boolean`	`canSwitchToHeadlessSystemUser()` 返回是否允许切换到无头 SYSTEM 用户。
`boolean`	`clearErrorDialogs()` 尝试关闭设备界面上当前显示的任何错误对话框。
`int`	`createUser(String name)` 使用给定名称和默认标志 0 创建用户。
`int`	`createUser(String name, boolean guest, boolean ephemeral, boolean forTesting)` 使用给定名称和提供的标志创建用户
`int`	`createUser(String name, boolean guest, boolean ephemeral)` 使用给定名称和提供的标志创建用户
`int`	`createUserNoThrow(String name)` 使用给定名称和默认标志 0 创建用户。
`void`	`disableKeyguard()` 尝试停用键盘锁。
`boolean`	`doesFileExist(String deviceFilePath)` 用于确定设备上是否存在文件的辅助方法。
`boolean`	`doesFileExist(String deviceFilePath, int userId)` 用于确定设备上是否存在给定用户的文件的辅助方法。
`File`	`dumpHeap(String process, String devicePath)` 尝试从 system_server 转储堆。
	`getActiveApexes()` 提取设备上已激活的 APEX 的相关信息。
	`getAllSettings(String namespace)` 返回所请求命名空间的键值对。
`String`	`getAndroidId(int userId)` 查找并返回与 userId 关联的 android-id；如果未找到，则返回 null。
	`getAndroidIds()` 针对找到的 Android ID 创建与用户 ID 匹配的映射。
`PackageInfo`	`getAppPackageInfo(String packageName)` 提取设备上安装的软件包的相关信息。
	`getAppPackageInfos()` 提取设备上安装的软件包的相关信息。
`InputStreamSource`	`getBugreport()` 从设备中检索 bug 报告。
`InputStreamSource`	`getBugreportz()` 从设备中检索 bugreportz。
`DeviceFoldableState`	`getCurrentFoldableState()` 返回设备当前的可折叠状态；如果发生某些问题，则返回 null。
`int`	`getCurrentUser()` 返回当前正在运行的用户的 ID。
	`getFoldableStates()` 返回设备上的可折叠设备状态列表。
	`getInstalledPackageNames()` 提取设备上存在的应用软件包名称。
`KeyguardControllerState`	`getKeyguardState()` 返回一个对象以获取键盘锁的当前状态，如果不受支持，则返回 null。
`Integer`	`getMainUserId()` 返回主要用户 ID。
	`getMainlineModuleInfo()` 获取设备上安装的 Mainline 模块的相关信息。
`int`	`getMaxNumberOfRunningUsersSupported()` 获取支持同时运行的用户数量上限。
`int`	`getMaxNumberOfUsersSupported()` 获取支持的用户数上限。
`Integer`	`getPrimaryUserId()` 返回主要用户 ID。
`InputStreamSource`	`getScreenshot()` 从设备上抓取屏幕截图。
`InputStreamSource`	`getScreenshot(String format, boolean rescale)` 从设备上抓取屏幕截图。
`InputStreamSource`	`getScreenshot(String format)` 从设备上抓取屏幕截图。
`InputStreamSource`	`getScreenshot(long displayId)` 从指定显示屏 ID 的设备获取屏幕截图。
`String`	`getSetting(String namespace, String key)` 请参阅 `getSetting(int, String, String)` 并在系统用户上执行。
`String`	`getSetting(int userId, String namespace, String key)` 返回所请求设置的值。
	`getUninstallablePackageNames()` 获取可卸载的应用软件包名称。
`int`	`getUserFlags(int userId)` 查找并返回指定用户的标记。
	`getUserInfos()` 获取设备上的 useId 到 `UserInfo` 的映射。
`int`	`getUserSerialNumber(int userId)` 如果找到，则返回与 userId 关联的序列号，在任何其他情况下返回 -10000。
`boolean`	`hasFeature(String feature)` 检查设备是否支持某项功能。
`String`	`installPackage(File packageFile, boolean reinstall, String... extraArgs)` 在设备上安装 Android 软件包。
`String`	`installPackage(File packageFile, boolean reinstall, boolean grantPermissions, String... extraArgs)` 在设备上安装 Android 软件包。
`String`	`installPackage(File packageFile, File certFile, boolean reinstall, String... extraArgs)` 在设备上安装 Android 软件包。
`String`	`installPackageForUser(File packageFile, boolean reinstall, boolean grantPermissions, int userId, String... extraArgs)` 在设备上安装给定用户的 Android 软件包。
`String`	`installPackageForUser(File packageFile, boolean reinstall, int userId, String... extraArgs)` 在设备上安装给定用户的 Android 软件包。
`String`	`installPackages( packageFiles, boolean reinstall, String... extraArgs)`
`String`	`installPackages( packageFiles, boolean reinstall, boolean grantPermissions, String... extraArgs)`
`String`	`installPackagesForUser( packageFiles, boolean reinstall, boolean grantPermissions, int userId, String... extraArgs)`
`String`	`installPackagesForUser( packageFiles, boolean reinstall, int userId, String... extraArgs)`
`String`	`installRemotePackages( remoteApkPaths, boolean reinstall, String... extraArgs)`
`String`	`installRemotePackages( remoteApkPaths, boolean reinstall, boolean grantPermissions, String... extraArgs)`
`boolean`	`isAppEnumerationSupported()` 检查设备上的平台是否支持应用枚举
`boolean`	`isHeadlessSystemUserMode()` 返回设备是否使用无头系统用户模式的指示值。
`boolean`	`isMainUserPermanentAdmin()` 返回主要用户是否为永久管理员且无法删除或降级为的信息非管理员状态。
`boolean`	`isMultiUserSupported()` 确定是否支持多用户。
`boolean`	`isPackageInstalled(String packageName)` 查询设备以获取给定的软件包名称，检查设备当前是否已安装。
`boolean`	`isPackageInstalled(String packageName, String userId)` 查询设备以获取指定的软件包名称和用户 ID，检查其当前是否位于安装或未安装。
`boolean`	`isUserRunning(int userId)` 检查指定用户是否正在运行。
`boolean`	`isUserSecondary(int userId)` 根据其标记返回指定用户是否为次要用户。
`boolean`	`isUserVisible(int userId)` 检查指定用户是否可见。
`boolean`	`isUserVisibleOnDisplay(int userId, int displayId)` 检查指定用户是否在给定显示屏中可见。
`boolean`	`isVisibleBackgroundUsersOnDefaultDisplaySupported()` 返回设备是否允许在 `ERROR(/java.android.view.Display#DEFAULT_DISPLAY)` 中在后台启动用户。
`boolean`	`isVisibleBackgroundUsersSupported()` 返回设备是否允许用户在后台启动。
	`listDisplayIds()` 收集设备上由“dumpsys”报告的可用屏幕 ID 的列表 SurfaceFlinger”。
	`listDisplayIdsForStartingVisibleBackgroundUsers()` 获取可用于 `start a user visible in the background` 的屏幕的列表。
	`listUsers()` 获取设备上的用户列表。
`boolean`	`logBugreport(String dataName, ITestLogger listener)` 用于生成 bug 报告并将其记录给报告者的辅助方法。
`void`	`notifySnapuserd(SnapuserdWaitPhase waitPhase)`
`void`	`postInvocationTearDown(Throwable exception)` 需要在调用后执行的设备特定清理的额外步骤已完成。
`boolean`	`removeAdmin(String componentName, int userId)` 移除指定用户的指定设备管理员，如果操作成功，则返回 `true`，否则返回 `false`。
`void`	`removeOwners()` 尽可能移除所有现有的设备配置文件所有者。
`boolean`	`removeUser(int userId)` 从设备中移除指定用户。
`boolean`	`setDeviceOwner(String componentName, int userId)` 将设备管理组件设为指定用户的设备所有者。
`void`	`setSetting(String namespace, String key, String value)` 请参阅 `setSetting(int, String, String, String)` 并在系统用户上执行。
`void`	`setSetting(int userId, String namespace, String key, String value)` 将设置值添加到指定用户的命名空间。
`void`	`shutdownMicrodroid(ITestDevice microdroidDevice)` 关闭 Microdroid 设备（如果有）。
`boolean`	`startUser(int userId)` 在后台启动指定用户（如果当前已停止）。
`boolean`	`startUser(int userId, boolean waitFlag)` 在后台启动指定用户（如果当前已停止）。
`boolean`	`startVisibleBackgroundUser(int userId, int displayId, boolean waitFlag)` 在后台启动指定用户，在指定的显示屏中处于可见状态（即允许用户以在该显示屏中启动 activity）。
`boolean`	`stopUser(int userId, boolean waitFlag, boolean forceFlag)` 停止指定用户。
`boolean`	`stopUser(int userId)` 停止指定用户。
`boolean`	`supportsMicrodroid()` 检查运行 Microdroid 的前提条件。
`boolean`	`supportsMicrodroid(boolean protectedVm)` 检查运行 Microdroid 的前提条件。
`boolean`	`switchUser(int userId)` 切换到具有默认超时的另一个 userId。
`boolean`	`switchUser(int userId, long timeout)` 切换到另一个以所提供的超时作为截止时间的用户 ID。
`Bugreport`	`takeBugreport()` 获取 bug 报告并在 `Bugreport` 对象内返回该报告进行处理。
`String`	`uninstallPackage(String packageName)` 从设备上卸载 Android 软件包。
`String`	`uninstallPackageForUser(String packageName, int userId)` 从设备中卸载指定用户的 Android 软件包。
`void`	`waitForSnapuserd(SnapuserdWaitPhase currentPhase)`

受保护的方法
`AaptParser`	`createParser(File appFile)`
`void`	`doAdbReboot(NativeDevice.RebootMode rebootMode, String reason)` 执行 adb 重新启动。
`InputStreamSource`	`getBugreportInternal()`
`File`	`getBugreportzInternal()` 用于以 `ERROR(/File)` 形式获取 bugreportz zip 文件的内部帮助程序方法。
`long`	`getCheckNewUserSleep()` 可供测试。
`long`	`getHostCurrentTime()` 可供测试
`void`	`prePostBootSetup()` 允许每种设备类型（AndroidNativeDevice、TestDevice）针对特定的启动后设置

字段

DISMISS_KEYGUARD_CMD 键

public static final String DISMISS_KEYGUARD_CMD

可用于关闭键盘锁的命令。

公共构造函数

TestDevice

public TestDevice (IDevice device, 
                IDeviceStateMonitor stateMonitor, 
                IDeviceMonitor allocationMonitor)

公共方法

canSwitchToHeadlessSystemUser

public boolean canSwitchToHeadlessSystemUser ()

返回是否允许切换到无头 SYSTEM 用户。

返回
`boolean`

抛出
`DeviceNotAvailableException`

ClearErrorDialogs

public boolean clearErrorDialogs ()

尝试关闭设备界面上当前显示的任何错误对话框。

返回
`boolean`	如果不存在对话框或对话框已成功清除，则为 `true`。否则为 `false`。

抛出
`DeviceNotAvailableException`

createUser

public int createUser (String name)

使用给定名称和默认标志 0 创建用户。

参数
`name`	`String`：在设备上创建的用户的级别

返回
`int`	创建的用户 ID 的整数

抛出
`DeviceNotAvailableException`

createUser

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

使用给定名称和提供的标志创建用户

参数
`name`	`String`：在设备上创建的用户的级别
`guest`	`boolean`：在创建期间启用用户标志 --guest
`ephemeral`	`boolean`：在创建期间启用用户标志 --Temporary
`forTesting`	`boolean`：在创建期间启用测试标志 --for-testing

返回
`int`	已创建用户的 ID

抛出
`DeviceNotAvailableException`

createUser

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

使用给定名称和提供的标志创建用户

参数
`name`	`String`：在设备上创建的用户的级别
`guest`	`boolean`：在创建期间启用用户标志 --guest
`ephemeral`	`boolean`：在创建期间启用用户标志 --Temporary

返回
`int`	已创建用户的 ID

抛出
`DeviceNotAvailableException`

createUserNoThrow

public int createUserNoThrow (String name)

使用给定名称和默认标志 0 创建用户。

参数
`name`	`String`：在设备上创建的用户的级别

返回
`int`	创建的用户 ID 的整数，或 -1 表示出错。

抛出
`DeviceNotAvailableException`

停用键盘锁

public void disableKeyguard ()

尝试停用键盘锁。

首先，等待输入调度准备就绪，设备报告 BOOT_COMPLETE，明显是异步的，因为当前的框架实现偶尔会出现竞态条件。然后发送命令以关闭键盘锁仅限非安全网站）

抛出
`DeviceNotAvailableException`

doFileExist

public boolean doesFileExist (String deviceFilePath)

用于确定设备上是否存在文件的辅助方法。

参数
`deviceFilePath`	`String`：要检查的设备上文件的绝对路径

返回
`boolean`	如果文件存在，则返回 `true`，否则返回 `false`。

抛出
`DeviceNotAvailableException`

doFileExist

public boolean doesFileExist (String deviceFilePath, 
                int userId)

用于确定设备上是否存在给定用户的文件的辅助方法。

参数
`deviceFilePath`	`String`：要检查的设备上文件的绝对路径
`userId`	`int`：用于检查文件是否存在的用户 ID

返回
`boolean`	如果文件存在，则返回 `true`，否则返回 `false`。

抛出
`DeviceNotAvailableException`

转储堆

public File dumpHeap (String process, 
                String devicePath)

尝试从 system_server 转储堆。调用方负责清理转储文件

参数
`process`	`String`：要转储堆的设备进程的名称。
`devicePath`	`String`：设备上的转储路径。此位置必须是没有权限限制它。

返回
`File`	包含报告的 `ERROR(/File)`。如果操作失败，则为 null。

抛出
`DeviceNotAvailableException`

getActiveApexes

public  getActiveApexes ()

提取设备上已激活的 APEX 的相关信息。

返回
	设备上目前已激活 `ERROR(/Set)` 个（共 `ApexInfo` 个）

抛出
`DeviceNotAvailableException`

getAllSettings

public  getAllSettings (String namespace)

返回所请求命名空间的键值对。

参数
`namespace`	`String`：必须是 {"system", "secure", "global"} 之一

返回
	键值对的映射。如果不支持命名空间，则为 null。

抛出
`DeviceNotAvailableException`

获取 Android ID

public String getAndroidId (int userId)

查找并返回与 userId 关联的 android-id；如果未找到，则返回 null。

参数
`userId`	`int`

返回
`String`

抛出
`DeviceNotAvailableException`

getAndroidId

public  getAndroidIds ()

针对找到的 Android ID 创建与用户 ID 匹配的映射。每个用户都没有保险 id 将在此函数中找到一个关联的 Android ID，因此某些用户 ID 可能与 null 匹配。

返回
	找到了与用户 ID 匹配的 Android ID 映射。

抛出
`DeviceNotAvailableException`

getAppPackageInfo

public PackageInfo getAppPackageInfo (String packageName)

提取设备上安装的软件包的相关信息。

参数
`packageName`	`String`

返回
`PackageInfo`	`PackageInfo` 或 `null`（如果无法检索信息）

抛出
`DeviceNotAvailableException`

getAppPackageInfos

public  getAppPackageInfos ()

提取设备上安装的软件包的相关信息。

返回
	设备上已安装 `ERROR(/List)` 个（共 `PackageInfo` 个）。

抛出
`DeviceNotAvailableException`

获取错误报告

public InputStreamSource getBugreport ()

从设备中检索 bug 报告。

此实现可以保证在没有 SD 卡的设备上继续正常运行（或尚未装载 SD 卡）。

返回
`InputStreamSource`	一个 `InputStreamSource`，用于按需生成 bug 报告内容。在如果失败，`InputStreamSource` 将生成一个空的 `ERROR(/InputStream)`。

getBugreportz

public InputStreamSource getBugreportz ()

从设备中检索 bugreportz。Zip 格式的错误报告包含主要错误报告和对调试有用的其他日志文件。

仅适用于“adb 版本”>1.0.36

返回
`InputStreamSource`	包含 bugreportz 的 ZIP 文件的 `InputStreamSource`，在发生故障的情况

getCurrentFoldableState

public DeviceFoldableState getCurrentFoldableState ()

返回设备当前的可折叠状态；如果发生某些问题，则返回 null。

返回
`DeviceFoldableState`

抛出
`DeviceNotAvailableException`

获取当前用户

public int getCurrentUser ()

返回当前正在运行的用户的 ID。如果发生错误，则返回 -10000。

返回
`int`

抛出
`DeviceNotAvailableException`

getFoldableStates

public  getFoldableStates ()

返回设备上的可折叠设备状态列表。可通过“cmd device_state”获取 print-states”。

返回

抛出
`DeviceNotAvailableException`

getInstallPackageNames

public  getInstalledPackageNames ()

提取设备上存在的应用软件包名称。

返回
	设备上目前安装的软件包名称为 `ERROR(/Set)` 个（共 `String` 个）。

抛出
`DeviceNotAvailableException`

getKeyguardState

public KeyguardControllerState getKeyguardState ()

返回一个对象以获取键盘锁的当前状态，如果不受支持，则返回 null。

返回
`KeyguardControllerState`	包含锁屏状态快照的 `KeyguardControllerState` 如果不支持键盘锁查询，则返回 Null。

抛出
`DeviceNotAvailableException`

getMainUserId

public Integer getMainUserId ()

返回主要用户 ID。

返回
`Integer`	主要用户的 userId（如果有）；如果没有主要用户，则返回 null。

抛出
`DeviceNotAvailableException`

getMainlineModuleInfo

public  getMainlineModuleInfo ()

获取设备上安装的 Mainline 模块的相关信息。

返回
	设备上目前已安装 `ERROR(/Set)` 个 Mainline 模块（共 `String` 个）。

抛出
`DeviceNotAvailableException`

支持运行的用户数达到上限

public int getMaxNumberOfRunningUsersSupported ()

获取支持同时运行的用户数量上限。默认设置为 0。

返回
`int`	一个整数，表示同时运行的用户数

抛出
`DeviceNotAvailableException`

支持的最大用户数

public int getMaxNumberOfUsersSupported ()

获取支持的用户数上限。默认设置为 0。

返回
`int`	一个整数，表示支持的用户数

抛出
`DeviceNotAvailableException`

getPrimaryUserId

public Integer getPrimaryUserId ()

返回主要用户 ID。

返回
`Integer`	主要用户的 userId（如果有）；如果没有主要用户，则返回 null。

抛出
`DeviceNotAvailableException`

获取屏幕截图

public InputStreamSource getScreenshot ()

从设备上抓取屏幕截图。

返回
`InputStreamSource`	屏幕截图的 `InputStreamSource`（采用 png 格式），或者 `null` 屏幕截图失败了。

抛出
`DeviceNotAvailableException`

获取屏幕截图

public InputStreamSource getScreenshot (String format, 
                boolean rescale)

从设备上抓取屏幕截图。建议改用 getScreenshot(String) 并采用 JPEG 编码格式进行压缩。

参数
`format`	`String`：支持的 PNG、JPEG
`rescale`	`boolean`：是否应重新缩放屏幕截图以减小所生成图片的大小

返回
`InputStreamSource`	`InputStreamSource`屏幕截图的格式，`null`如果屏幕截图失败。

抛出
`DeviceNotAvailableException`

获取屏幕截图

public InputStreamSource getScreenshot (String format)

从设备上抓取屏幕截图。建议在尺寸较小时使用 getScreenshot(format) 并采用 JPEG 编码

参数
`format`	`String`：支持的 PNG、JPEG

返回
`InputStreamSource`	屏幕截图的 `InputStreamSource`（采用格式），或者 `null` 屏幕截图失败了。

抛出
`DeviceNotAvailableException`

获取屏幕截图

public InputStreamSource getScreenshot (long displayId)

从指定显示屏 ID 的设备获取屏幕截图。格式为 PNG。

TODO：扩展上述实现以支持“format”和“重新扩缩”

参数
`displayId`	`long`：要从中获取屏幕截图的屏幕的显示 ID。

返回
`InputStreamSource`	`InputStreamSource`屏幕截图的格式，`null`如果屏幕截图失败。

抛出
`DeviceNotAvailableException`

getSetting

public String getSetting (String namespace, 
                String key)

请参阅 getSetting(int, String, String) 并在系统用户上执行。

参数
`namespace`	`String`
`key`	`String`

返回
`String`

抛出
`DeviceNotAvailableException`

getSetting

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

返回所请求设置的值。命名空间必须为以下项之一：{"system", "secure", "global"}

参数
`userId`	`int`
`namespace`	`String`
`key`	`String`

返回
`String`	与用户的 namespace:key 相关联的值。如果未找到，则为 Null。

抛出
`DeviceNotAvailableException`

getUninstallablePackageNames

public  getUninstallablePackageNames ()

获取可卸载的应用软件包名称。目前定义为非系统软件包和更新后的系统软件包

返回
	当前安装的`ERROR(/Set)`可卸载`String`软件包名称设备。

抛出
`DeviceNotAvailableException`

getUserFlags

public int getUserFlags (int userId)

查找并返回指定用户的标记。标志在“android.content.pm.UserInfo”中定义类。

参数
`userId`	`int`

返回
`int`	与提供的 userId 关联的标记（如果找到），在任何其他情况下为 -10000。

抛出
`DeviceNotAvailableException`

getUserInfo

public  getUserInfos ()

获取设备上的 useId 到 UserInfo 的映射。如果设备的输出不符合预期，则会抛出 DeviceRuntimeException。

返回
	UserInfo 对象的列表。

抛出
`DeviceNotAvailableException`

getUserSerialNumber

public int getUserSerialNumber (int userId)

如果找到，则返回与 userId 关联的序列号，在任何其他情况下返回 -10000。

参数
`userId`	`int`

返回
`int`

抛出
`DeviceNotAvailableException`

hasFeature

public boolean hasFeature (String feature)

检查设备是否支持某项功能。

参数
`feature`	`String`：格式应为“feature:”或“”。

返回
`boolean`	如果找到特征，则为 true，否则为 false。

抛出
`DeviceNotAvailableException`

installPackage

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

在设备上安装 Android 软件包。

参数
`packageFile`	`File`：要安装的 APK 文件
`reinstall`	`boolean`：如果应执行重新安装，则为 `true`
`extraArgs`	`String`：要传递的额外参数（可选）。请参阅“adb shell pm -h”用于选项。

返回
`String`	包含错误代码的 `String`，如果成功，则为 `null`。

抛出
`DeviceNotAvailableException`

installPackage

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

在设备上安装 Android 软件包。

注意：仅适用于需要明确控制在安装时应调用此函数。

参数
`packageFile`	`File`：要安装的 APK 文件
`reinstall`	`boolean`：如果应执行重新安装，则为 `true`
`grantPermissions`	`boolean`：如果应在安装时授予所有运行时权限
`extraArgs`	`String`：要传递的额外参数（可选）。请参阅“adb shell pm -h”用于选项。

返回
`String`	包含错误代码的 `String`，如果成功，则为 `null`。

抛出
`DeviceNotAvailableException`

installPackage

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

在设备上安装 Android 软件包。

注意：仅适用于需要明确控制在安装时应调用此函数。

参数
`packageFile`	`File`：要安装的 APK 文件
`certFile`	`File`：如果应执行重新安装，则为 `true`
`reinstall`	`boolean`：如果应在安装时授予所有运行时权限
`extraArgs`	`String`：要传递的额外参数（可选）。请参阅“adb shell pm -h”用于选项。

返回
`String`	包含错误代码的 `String`，如果成功，则为 `null`。

抛出
`DeviceNotAvailableException`

installPackageForUser

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

在设备上安装给定用户的 Android 软件包。

注意：仅适用于需要明确控制在安装时应调用此函数。

参数
`packageFile`	`File`：要安装的 APK 文件
`reinstall`	`boolean`：如果应执行重新安装，则为 `true`
`grantPermissions`	`boolean`：如果应在安装时授予所有运行时权限
`userId`	`int`：要安装的整数用户 ID。
`extraArgs`	`String`：要传递的额外参数（可选）。请参阅“adb shell pm -h”用于选项。

返回
`String`	包含错误代码的 `String`，如果成功，则为 `null`。

抛出
`DeviceNotAvailableException`

installPackageForUser

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

在设备上安装给定用户的 Android 软件包。

参数
`packageFile`	`File`：要安装的 APK 文件
`reinstall`	`boolean`：如果应执行重新安装，则为 `true`
`userId`	`int`：要安装的整数用户 ID。
`extraArgs`	`String`：要传递的额外参数（可选）。请参阅“adb shell pm -h”用于选项。

返回
`String`	包含错误代码的 `String`，如果成功，则为 `null`。

抛出
`DeviceNotAvailableException`

installPackages

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

参数
`packageFiles`
`reinstall`	`boolean`
`extraArgs`	`String`

返回
`String`

抛出
`DeviceNotAvailableException`

installPackages

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

参数
`packageFiles`
`reinstall`	`boolean`
`grantPermissions`	`boolean`
`extraArgs`	`String`

返回
`String`

抛出
`DeviceNotAvailableException`

installPackagesForUser

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

参数
`packageFiles`
`reinstall`	`boolean`
`grantPermissions`	`boolean`
`userId`	`int`
`extraArgs`	`String`

返回
`String`

抛出
`DeviceNotAvailableException`

installPackagesForUser

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

参数
`packageFiles`
`reinstall`	`boolean`
`userId`	`int`
`extraArgs`	`String`

返回
`String`

抛出
`DeviceNotAvailableException`

installRemotePackages

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

参数
`remoteApkPaths`
`reinstall`	`boolean`
`extraArgs`	`String`

返回
`String`

抛出
`DeviceNotAvailableException`

installRemotePackages

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

参数
`remoteApkPaths`
`reinstall`	`boolean`
`grantPermissions`	`boolean`
`extraArgs`	`String`

返回
`String`

抛出
`DeviceNotAvailableException`

isAppEnumerationSupported

public boolean isAppEnumerationSupported ()

检查设备上的平台是否支持应用枚举

返回
`boolean`	如果支持应用枚举，则为 true，否则为 false

抛出
`DeviceNotAvailableException`

isHeadlessSystemUserMode

public boolean isHeadlessSystemUserMode ()

返回设备是否使用无头系统用户模式的指示值。

返回
`boolean`

抛出
`DeviceNotAvailableException`

isMainUserPermanentAdmin

public boolean isMainUserPermanentAdmin ()

返回主要用户是否为永久管理员且无法删除或降级为的信息非管理员状态。

返回
`boolean`

抛出
`DeviceNotAvailableException`

支持多用户

public boolean isMultiUserSupported ()

确定是否支持多用户。

返回
`boolean`	如果支持多用户，则为 true，否则为 false

抛出
`DeviceNotAvailableException`

isPackageInstall

public boolean isPackageInstalled (String packageName)

查询设备以获取给定的软件包名称，检查设备当前是否已安装。

参数
`packageName`	`String`

返回
`boolean`	如果软件包报告为已安装，则为 true。否则为 false。

抛出
`DeviceNotAvailableException`

isPackageInstall

public boolean isPackageInstalled (String packageName, 
                String userId)

查询设备以获取指定的软件包名称和用户 ID，检查其当前是否位于安装或未安装。

参数
`packageName`	`String`：要检查其是否已安装的软件包。
`userId`	`String`：我们正在检查软件包的安装情况的用户 ID。如果为 null，则是主要用户使用的都是 0

返回
`boolean`	如果软件包报告为已安装，则为 true。否则为 false。

抛出
`DeviceNotAvailableException`

isUserRunning

public boolean isUserRunning (int userId)

检查指定用户是否正在运行。

参数
`userId`	`int`

返回
`boolean`	如果用户正在运行，则为 true；在所有其他情况下，则为 false。

抛出
`DeviceNotAvailableException`

是次要用户

public boolean isUserSecondary (int userId)

根据其标记返回指定用户是否为次要用户。

参数
`userId`	`int`

返回
`boolean`	如果用户为次要用户，则为 true，否则为 false。

抛出
`DeviceNotAvailableException`

isUserVisible（用户可见）

public boolean isUserVisible (int userId)

检查指定用户是否可见。

“可见的”用户是指正在与“人类”用户也因此能够启动启动 activity（通常默认显示）。

参数
`userId`	`int`

返回
`boolean`

抛出
`DeviceNotAvailableException`

isUserVisibleOnDisplay

public boolean isUserVisibleOnDisplay (int userId, 
                int displayId)

检查指定用户是否在给定显示屏中可见。

“可见的”用户是指正在与“人类”用户也因此能够启动 activity。

参数
`userId`	`int`
`displayId`	`int`

返回
`boolean`

抛出
`DeviceNotAvailableException`

isVisibleBackgroundUsersOnDefaultDisplaySupported

public boolean isVisibleBackgroundUsersOnDefaultDisplaySupported ()

返回设备是否允许在 ERROR(/java.android.view.Display#DEFAULT_DISPLAY) 中在后台启动用户。

如果支持，您可以调用 startVisibleBackgroundUser(int, int, boolean)，并传递 listDisplayIdsForStartingVisibleBackgroundUsers() 返回的一个屏幕，应包含 ERROR(/java.android.view.Display#DEFAULT_DISPLAY)）。

返回
`boolean`

抛出
`DeviceNotAvailableException`

isVisibleBackgroundUsersSupported 支持

public boolean isVisibleBackgroundUsersSupported ()

返回设备是否允许用户在后台启动。

如果支持，您可以调用 startVisibleBackgroundUser(int, int, boolean)，并传递 listDisplayIdsForStartingVisibleBackgroundUsers() 返回的屏幕。

返回
`boolean`

抛出
`DeviceNotAvailableException`

listDisplayIds

public  listDisplayIds ()

收集设备上由“dumpsys”报告的可用屏幕 ID 的列表 SurfaceFlinger”。

返回
	显示设备列表。Default 始终返回默认显示屏 0。

抛出
`DeviceNotAvailableException`

listDisplayIdsForStartingVisibleBackgroundUsers

public  listDisplayIdsForStartingVisibleBackgroundUsers ()

获取可用于 start a user visible in the background 的屏幕的列表。

返回

抛出
`DeviceNotAvailableException`

listUsers

public  listUsers ()

获取设备上的用户列表。如果输出，则会抛出 DeviceRuntimeException 与预期不符。

返回
	用户 ID 的列表。

抛出
`DeviceNotAvailableException`

logBugreport

public boolean logBugreport (String dataName, 
                ITestLogger listener)

用于生成 bug 报告并将其记录给报告者的辅助方法。

参数
`dataName`	`String`：用于报告 bug 报告的名称。
`listener`	`ITestLogger`：用于记录 bug 报告的 `ITestLogger`。

返回
`boolean`	如果记录成功，则为 true，否则为 false。

通知 Snapuserd

public void notifySnapuserd (SnapuserdWaitPhase waitPhase)

参数
`waitPhase`	`SnapuserdWaitPhase`

postInvocationTearDown

public void postInvocationTearDown (Throwable exception)

需要在调用后执行的设备特定清理的额外步骤已完成。

参数
`exception`	`Throwable`：如果有，则为调用失败引发的最终异常。

移除管理员

public boolean removeAdmin (String componentName, 
                int userId)

移除指定用户的指定设备管理员，如果操作成功，则返回 true，否则返回 false。

参数
`componentName`	`String`：要移除的设备管理员。
`userId`	`int`：设备管理员所在用户的用户。

返回
`boolean`	如果成功则为 true，否则为 false。

抛出
`DeviceNotAvailableException`

移除所有者

public void removeOwners ()

尽可能移除所有现有的设备配置文件所有者。

抛出
`DeviceNotAvailableException`

移除用户

public boolean removeUser (int userId)

从设备中移除指定用户。

参数
`userId`	`int`：要移除的用户

返回
`boolean`	如果成功移除了用户，则为 true，否则为 false。

抛出
`DeviceNotAvailableException`

setDeviceOwner

public boolean setDeviceOwner (String componentName, 
                int userId)

将设备管理组件设为指定用户的设备所有者。

参数
`componentName`	`String`：由设备管理员担任设备所有者。
`userId`	`int`：设备所有者所在用户的名称。

返回
`boolean`	如果成功则为 true，否则为 false。

抛出
`DeviceNotAvailableException`

setSetting

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

请参阅 setSetting(int, String, String, String) 并在系统用户上执行。

参数
`namespace`	`String`
`key`	`String`
`value`	`String`

抛出
`DeviceNotAvailableException`

setSetting

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

将设置值添加到指定用户的命名空间。部分设置将不可用。命名空间必须为以下项之一：{"system", "secure", "global"}

参数
`userId`	`int`
`namespace`	`String`
`key`	`String`
`value`	`String`

抛出
`DeviceNotAvailableException`

关闭 Microdroid

public void shutdownMicrodroid (ITestDevice microdroidDevice)

关闭 Microdroid 设备（如果有）。

参数
`microdroidDevice`	`ITestDevice`

抛出
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

startUser

public boolean startUser (int userId)

在后台启动指定用户（如果当前已停止）。如果用户已经则此方法为 NOOP。

参数
`userId`	`int`：要在后台启动的用户

返回
`boolean`	如果用户在后台成功启动，则为 true。

抛出
`DeviceNotAvailableException`

startUser

public boolean startUser (int userId, 
                boolean waitFlag)

在后台启动指定用户（如果当前已停止）。如果用户已经则此方法为 NOOP。可以提供额外的标志来等待才能使操作生效。

参数
`userId`	`int`：要在后台启动的用户
`waitFlag`	`boolean`：会使该命令等待用户启动并解锁。

返回
`boolean`	如果用户在后台成功启动，则为 true。

抛出
`DeviceNotAvailableException`

startVisibleBackgroundUser

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

在后台启动指定用户，在指定的显示屏中处于可见状态（即允许用户以在该显示屏中启动 activity）。

注意：此命令不会检查用户是否存在、显示可用、device supports such feature 等。

参数
`userId`	`int`：要在后台启动的用户
`displayId`	`int`：用于启动用户可见的显示屏
`waitFlag`	`boolean`：会使该命令等待用户启动并解锁。

返回
`boolean`	如果用户成功启动，则在后台可见，值为 `true`。

抛出
`DeviceNotAvailableException`

stopUser

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

停止指定用户。可以提供额外的标志以等待操作生效，并强制终止用户无法停止当前用户和系统用户。

参数
`userId`	`int`：要停止的用户。
`waitFlag`	`boolean`：会使该命令等待用户停止。
`forceFlag`	`boolean`：会强行停止用户。

返回
`boolean`	如果用户被成功停止，则为 true。

抛出
`DeviceNotAvailableException`

stopUser

public boolean stopUser (int userId)

停止指定用户。如果用户已停止，则此方法为 NOOP。无法停止当前用户和系统用户。

参数
`userId`	`int`：要停止的用户。

返回
`boolean`	如果用户被成功停止，则为 true。

抛出
`DeviceNotAvailableException`

SupportMicrodroid

public boolean supportsMicrodroid ()

检查运行 Microdroid 的前提条件。

返回
`boolean`	如果满足前提条件，则返回 true，否则返回 false。

SupportMicrodroid

public boolean supportsMicrodroid (boolean protectedVm)

检查运行 Microdroid 的前提条件。

参数
`protectedVm`	`boolean`：如果 Microdroid 旨在于受保护的虚拟机上运行，则为 true。

返回
`boolean`	如果满足前提条件，则返回 true，否则返回 false。

切换用户

public boolean switchUser (int userId)

切换到具有默认超时的另一个 userId。switchUser(int, long)。

参数
`userId`	`int`

返回
`boolean`	如果新的 userId 与 userId 提供方匹配，则返回 true。否则为 false。

抛出
`DeviceNotAvailableException`

切换用户

public boolean switchUser (int userId, 
                long timeout)

切换到另一个以所提供的超时作为截止时间的用户 ID。更改用户成功后尝试停用键盘锁。

参数
`userId`	`int`
`timeout`	`long`：在切换用户失败后返回 false。

返回
`boolean`	如果新的 userId 与 userId 提供方匹配，则返回 true。否则为 false。

抛出
`DeviceNotAvailableException`

takeBugreport

public Bugreport takeBugreport ()

获取 bug 报告并在 Bugreport 对象内返回该报告进行处理。返回 null 出现任何问题。Bugreport 对象中引用的文件需要通过 Bugreport.close() 进行清理。

返回
`Bugreport`

removePackage

public String uninstallPackage (String packageName)

从设备上卸载 Android 软件包。

参数
`packageName`	`String`：要卸载的 Android 软件包

返回
`String`	包含错误代码的 `String`，如果成功，则为 `null`。

抛出
`DeviceNotAvailableException`

downloadPackageForUser

public String uninstallPackageForUser (String packageName, 
                int userId)

从设备中卸载指定用户的 Android 软件包。

参数
`packageName`	`String`：要卸载的 Android 软件包
`userId`	`int`：要卸载的整数用户 ID。

返回
`String`	包含错误代码的 `String`，如果成功，则为 `null`。

抛出
`DeviceNotAvailableException`

waitForSnapuserd

public void waitForSnapuserd (SnapuserdWaitPhase currentPhase)

参数
`currentPhase`	`SnapuserdWaitPhase`

抛出
`DeviceNotAvailableException`

受保护的方法

createParser

protected AaptParser createParser (File appFile)

参数
`appFile`	`File`

返回
`AaptParser`

doAdb 重新启动

protected void doAdbReboot (NativeDevice.RebootMode rebootMode, 
                String reason)

执行 adb 重新启动。

参数
`rebootMode`	`NativeDevice.RebootMode`：此重新启动的一种模式。
`reason`	`String`：用于此次重新启动。

抛出
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

getBugreportInternal

protected InputStreamSource getBugreportInternal ()

返回
`InputStreamSource`

getBugreportzInternal

protected File getBugreportzInternal ()

用于以 ERROR(/File) 形式获取 bugreportz zip 文件的内部帮助程序方法。

返回
`File`

getCheckNewUserSleep

protected long getCheckNewUserSleep ()

可供测试。

返回
`long`

获取主机当前时间

protected long getHostCurrentTime ()

可供测试

返回
`long`

prePostBootSetup

protected void prePostBootSetup ()

允许每种设备类型（AndroidNativeDevice、TestDevice）针对特定的启动后设置

抛出
`DeviceNotAvailableException`

TestDevice

摘要

嵌套类

字段

公共构造函数

公共方法

受保护的方法

字段

DISMISS_KEYGUARD_CMD 键

公共构造函数

TestDevice

公共方法

canSwitchToHeadlessSystemUser

ClearErrorDialogs

createUser

createUser

createUser

createUserNoThrow

停用键盘锁

doFileExist

doFileExist

转储堆

getActiveApexes

getAllSettings

获取 Android ID

getAndroidId

getAppPackageInfo

getAppPackageInfos

获取错误报告

getBugreportz

getCurrentFoldableState

获取当前用户

getFoldableStates

getInstallPackageNames

getKeyguardState

getMainUserId

getMainlineModuleInfo

支持运行的用户数达到上限

支持的最大用户数

getPrimaryUserId

获取屏幕截图

获取屏幕截图

获取屏幕截图

获取屏幕截图

getSetting

getSetting

getUninstallablePackageNames

getUserFlags

getUserInfo

getUserSerialNumber

hasFeature

installPackage

installPackage

installPackage

installPackageForUser

installPackageForUser

installPackages

installPackages

installPackagesForUser

installPackagesForUser

installRemotePackages

installRemotePackages

isAppEnumerationSupported

isHeadlessSystemUserMode

isMainUserPermanentAdmin

支持多用户

isPackageInstall

isPackageInstall

isUserRunning

是次要用户

isUserVisible（用户可见）

isUserVisibleOnDisplay

isVisibleBackgroundUsersOnDefaultDisplaySupported

isVisibleBackgroundUsersSupported 支持

listDisplayIds

listDisplayIdsForStartingVisibleBackgroundUsers

listUsers

logBugreport

通知 Snapuserd

postInvocationTearDown