このページは Cloud Translation API によって翻訳されました。

ネイティブデバイス

public class NativeDevice
extends Object implements IManagedTestDevice , IConfigurationReceiver , ITestLoggerReceiver

java.lang.オブジェクト
↳	com.android.tradefed.device.NativeDevice

既知の直接サブクラス

テストデバイス

テストデバイスフルスタック Android デバイス用のITestDeviceの実装

既知の間接サブクラス

LocalAndroidVirtualDevice 、 ManagedRemoteDevice 、 NestedRemoteDevice 、 RemoteAndroidDevice 、 RemoteAndroidVirtualDevice

ローカルAndroid仮想デバイス	TradeFed ホスト上で実行されるローカル仮想デバイスのクラス。
管理対象リモートデバイス	仮想マシン内で実行されるデバイス。VM 内の Tradefed インスタンスを介してリモートで管理されます。
ネストされたリモートデバイス	リモートの Cuttlefish VM 内で実行されているデバイスの表現。
リモートAndroidデバイス	adb connect 経由で接続されたフルスタック Android デバイス用の`ITestDevice`の実装。
リモートAndroid仮想デバイス	Google Compute Engine (Gce) で実行されるフルスタック Android デバイスの`RemoteAndroidDevice`動作を拡張します。

ITestDevice非フルスタック Android デバイスのデフォルト実装。

まとめ

入れ子になったクラス
`class`	`NativeDevice.AdbAction` OS の「adb ....」コマンドを実行すると、 `ERROR(DeviceAction/com.android.tradefed.device.NativeDevice.DeviceAction DeviceAction)` 。
`class`	`NativeDevice.AdbShellAction`
`class`	`NativeDevice.RebootDeviceAction` デバイスを再起動するための`ERROR(DeviceAction/com.android.tradefed.device.NativeDevice.DeviceAction DeviceAction)` 。

定数
`int`	`INVALID_USER_ID` 無効または見つからないユーザー ID に対して返される値: UserHandle は -10000 値を定義しました
`long`	`MAX_HOST_DEVICE_TIME_OFFSET`
`int`	`MAX_RETRY_ATTEMPTS` 実行するコマンド再試行のデフォルトの回数

田畑
`protected static final String`	`SD_CARD`
`protected static final String`	`STORAGE_EMULATED`
`protected TestDeviceOptions`	`mOptions`
`protected final IDeviceStateMonitor`	`mStateMonitor`

パブリックコンストラクター
`NativeDevice (IDevice device, IDeviceStateMonitor stateMonitor, IDeviceMonitor allocationMonitor)` `TestDevice`を作成します。

パブリックメソッド
`void`	`batchPrefetchStartupBuildProps ()` それぞれの props に対して「adb getprop」を呼び出すのではなく、必要なすべての props をプリフェッチすることによるマイクロ最適化 (約 400 ミリ)。
`boolean`	`canSwitchToHeadlessSystemUser ()` ヘッドレス SYSTEM ユーザーへの切り替えが許可されているかどうかを返します。
`boolean`	`checkApiLevelAgainstNextRelease (int strictMinLevel)` 最小限のサポートレベルを指定して、機能が現在サポートされているかどうかを確認します。
`boolean`	`checkConnectivity ()` デバイスがネットワークに接続されていることを確認します。
`boolean`	`clearErrorDialogs ()` デバイス UI に現在表示されているエラーダイアログを閉じてみます。
`void`	`clearLastConnectedWifiNetwork ()` 最後に接続した Wi-Fi ネットワークをクリアします。
`void`	`clearLogcat ()` 蓄積された logcat データを削除します。
`boolean`	`connectToWifiNetwork ( wifiSsidToPsk, boolean scanSsid)` `connectToWifiNetwork ( wifiSsidToPsk, boolean scanSsid)` Wi-Fi ネットワークに接続します。
`boolean`	`connectToWifiNetwork (String wifiSsid, String wifiPsk)` Wi-Fi ネットワークに接続します。
`boolean`	`connectToWifiNetwork ( wifiSsidToPsk)` `connectToWifiNetwork ( wifiSsidToPsk)` Wi-Fi ネットワークに接続します。f
`boolean`	`connectToWifiNetwork (String wifiSsid, String wifiPsk, boolean scanSsid)` Wi-Fi ネットワークに接続します。
`boolean`	`connectToWifiNetworkIfNeeded (String wifiSsid, String wifiPsk, boolean scanSsid)` デバイスが現在ネットワークに接続していない場合にのみ接続する`connectToWifiNetwork(String, String)`のバリアント。
`boolean`	`connectToWifiNetworkIfNeeded (String wifiSsid, String wifiPsk)` デバイスが現在ネットワークに接続していない場合にのみ接続する`connectToWifiNetwork(String, String)`のバリアント。
`int`	`createUser (String name, boolean guest, boolean ephemeral)` 指定された名前と指定されたフラグを使用してユーザーを作成します
`int`	`createUser (String name, boolean guest, boolean ephemeral, boolean forTesting)` 指定された名前と指定されたフラグを使用してユーザーを作成します
`int`	`createUser (String name)` 指定された名前とデフォルトのフラグ 0 を使用してユーザーを作成します。
`int`	`createUserNoThrow (String name)` 指定された名前とデフォルトのフラグ 0 を使用してユーザーを作成します。
`void`	`deleteFile (String deviceFilePath)` デバイス上のファイルまたはディレクトリを削除するヘルパーメソッド。
`void`	`deregisterDeviceActionReceiver ( IDeviceActionReceiver deviceActionReceiver)` 登録された`IDeviceActionReceiver`を削除します。
`boolean`	`deviceSoftRestarted ( ProcessInfo prevSystemServerProcess)` 現在の system_server と以前の system_server `ProcessInfo`を比較することで、デバイスがソフト再起動したかどうかを確認するヘルパーメソッド。
`boolean`	`deviceSoftRestartedSince (long utcEpochTime, TimeUnit timeUnit)` デバイスとその`ERROR(/TimeUnit)`からのエポック以降の UTC 時間以降にデバイスがソフト再起動したかどうかを確認するヘルパーメソッド。
`boolean`	`disableAdbRoot ()` adb root をオフにします。
`void`	`disableKeyguard ()` キーガードを無効にしようとします。
`boolean`	`disableNetworkMonitor ()` デバイス上のネットワーク監視を無効にします。
`boolean`	`disconnectFromWifi ()` Wi-Fi ネットワークから切断します。
`boolean`	`doesFileExist (String deviceFilePath, int userId)` デバイス上に特定のユーザーのファイルが存在するかどうかを判断するヘルパーメソッド。
`boolean`	`doesFileExist (String deviceFilePath)` デバイス上にファイルが存在するかどうかを判断するヘルパーメソッド。
`File`	`dumpHeap (String process, String devicePath)` system_server からヒープをダンプしてみます。
`boolean`	`enableAdbRoot ()` adb root をオンにします。
`boolean`	`enableNetworkMonitor ()` デバイス上のネットワーク監視を有効にします。
`String`	`executeAdbCommand (long timeout, String... cmdArgs)` 指定されたタイムアウトで adb コマンドをシステムコマンドとして実行するヘルパーメソッド。
`String`	`executeAdbCommand (long timeout, envMap, String... cmdArgs)` `executeAdbCommand (long timeout, envMap, String... cmdArgs)` 指定されたタイムアウトで adb コマンドをシステムコマンドとして実行するヘルパーメソッド。
`String`	`executeAdbCommand (String... cmdArgs)` adbコマンドをシステムコマンドとして実行するヘルパーメソッド。
`CommandResult`	`executeFastbootCommand (String... cmdArgs)` fastboot コマンドをデフォルトのタイムアウト 2 分でシステムコマンドとして実行するヘルパーメソッド。
`CommandResult`	`executeFastbootCommand (long timeout, String... cmdArgs)` fastboot コマンドをシステムコマンドとして実行するヘルパーメソッド。
`CommandResult`	`executeLongFastbootCommand (String... cmdArgs)` 長時間実行される fastboot コマンドをシステムコマンドとして実行するヘルパーメソッド。
`CommandResult`	`executeLongFastbootCommand ( envVarMap, String... cmdArgs)` `executeLongFastbootCommand ( envVarMap, String... cmdArgs)` システム環境変数を使用して、長時間実行される fastboot コマンドをシステムコマンドとして実行するヘルパーメソッド。
`String`	`executeShellCommand (String command)` adb シェルコマンドを実行し、出力を`String`として返すヘルパーメソッド。
`void`	`executeShellCommand (String command, IShellOutputReceiver receiver, long maxTimeToOutputShellResponse, TimeUnit timeUnit, int retryAttempts)` コマンドの動作を制御するためのパラメータをさらに指定して、adb シェルコマンドを実行します。
`void`	`executeShellCommand (String command, IShellOutputReceiver receiver, long maxTimeoutForCommand, long maxTimeToOutputShellResponse, TimeUnit timeUnit, int retryAttempts)` コマンドの動作を制御するためのパラメータをさらに指定して、adb シェルコマンドを実行します。
`void`	`executeShellCommand (String command, IShellOutputReceiver receiver)` 指定された adb シェルコマンドを実行し、コマンドが失敗した場合は複数回再試行します。
`CommandResult`	`executeShellV2Command (String cmd)` adb シェルコマンドを実行し、コマンドステータス出力、stdout および stderr が適切に設定された`CommandResult`として結果を返すヘルパーメソッド。
`CommandResult`	`executeShellV2Command (String cmd, OutputStream pipeToOutput)` adb シェルコマンドを実行し、コマンドステータス出力と標準エラー出力が適切に設定された`CommandResult`として結果を返すヘルパーメソッド。
`CommandResult`	`executeShellV2Command (String cmd, File pipeAsInput)` adb シェルコマンドを実行し、コマンドステータス出力、stdout および stderr が適切に設定された`CommandResult`として結果を返すヘルパーメソッド。
`CommandResult`	`executeShellV2Command (String cmd, long maxTimeoutForCommand, TimeUnit timeUnit, int retryAttempts)` コマンドの動作を制御するためのパラメータをさらに指定して、adb シェルコマンドを実行します。
`CommandResult`	`executeShellV2Command (String cmd, long maxTimeoutForCommand, TimeUnit timeUnit)` コマンドの動作を制御するためのパラメータをさらに指定して、adb シェルコマンドを実行します。
`CommandResult`	`executeShellV2Command (String cmd, File pipeAsInput, OutputStream pipeToOutput, long maxTimeoutForCommand, TimeUnit timeUnit, int retryAttempts)` コマンドの動作を制御するためのパラメータをさらに指定して、adb シェルコマンドを実行します。
`CommandResult`	`executeShellV2Command (String cmd, File pipeAsInput, OutputStream pipeToOutput, OutputStream pipeToError, long maxTimeoutForCommand, TimeUnit timeUnit, int retryAttempts)` コマンドの動作を制御するためのパラメータをさらに指定して、adb シェルコマンドを実行します。
`CommandResult`	`fastbootWipePartition (String partition)` デバイスのパーティションを消去するヘルパーメソッド。
	`getActiveApexes ()` デバイス上でアクティブ化された APEX に関する情報を取得します。
	`getAllSettings (String namespace)` 要求された名前空間のキーと値のペアを返します。
`DeviceAllocationState`	`getAllocationState ()` デバイスの現在の割り当て状態を返します
`String`	`getAndroidId (int userId)` userId に関連付けられた android-id を検索して返します。見つからない場合は null を返します。
	`getAndroidIds ()` ユーザー ID に一致する Android ID のマップを作成します。
`int`	`getApiLevel ()` デバイスの API レベルを取得します。
`PackageInfo`	`getAppPackageInfo (String packageName)` デバイスにインストールされているパッケージに関する情報を取得します。
	`getAppPackageInfos ()` デバイスにインストールされているパッケージの情報を取得します。
`String`	`getBasebandVersion ()` このデバイスのベースバンド (無線) バージョンを取得するための便利な方法。
`Integer`	`getBattery ()` デバイスの現在のバッテリーレベルを返すか、バッテリーレベルが利用できない場合は Null を返します。
`boolean`	`getBooleanProperty (String name, boolean defaultValue)` 指定されたプロパティのブール値を返します。
	`getBootHistory ()` ヘルパーメソッドは、起動時間と起動理由を含む起動履歴マップを収集します。
	`getBootHistorySince (long utcEpochTime, TimeUnit timeUnit)` ヘルパーメソッドは、デバイスからのエポックからの指定された時間以降のブート時刻とブート理由、および指定された時間単位を含むブート履歴マップを収集します。
`String`	`getBootloaderVersion ()` このデバイスのブートローダーのバージョンを取得するための便利なメソッド。
`InputStreamSource`	`getBugreport ()` デバイスからバグレポートを取得します。
`InputStreamSource`	`getBugreportz ()` デバイスからバグレポートを取得します。
`String`	`getBuildAlias ()` デバイスが現在実行しているビルドのエイリアスを取得します。
`String`	`getBuildFlavor ()` デバイスのビルドフレーバーを取得します。
`String`	`getBuildId ()` デバイスが現在実行しているビルドを取得します。
`String`	`getBuildSigningKeys ()` デバイスイメージの署名に使用されるキーのタイプを返します。通常、Android デバイスは、テストキー (AOSP など) またはリリースキー (個々のデバイスメーカーによって制御される) で署名されます。
`DeviceDescriptor`	`getCachedDeviceDescriptor ()` デバイスが割り当てられている場合はキャッシュされた`DeviceDescriptor`を返し、それ以外の場合は現在の`DeviceDescriptor`を返します。
`DeviceDescriptor`	`getCachedDeviceDescriptor (boolean shortDescriptor)` デバイスが割り当てられている場合はキャッシュされた`DeviceDescriptor`を返し、それ以外の場合は現在の`DeviceDescriptor`を返します。
`String[]`	`getChildren (String path)` アクセス許可が原因で機能しない場合がある`IFileEntry`を使用する代わりに。
`AbstractConnection`	`getConnection ()` デバイスに関連付けられている現在の接続。
`DeviceFoldableState`	`getCurrentFoldableState ()` デバイスの現在の折りたたみ可能な状態を返すか、何らかの問題が発生した場合は null を返します。
`int`	`getCurrentUser ()` 現在実行中のユーザーの ID を返します。
`String`	`getDeviceClass ()` デバイスクラスを取得します。
`long`	`getDeviceDate ()` デバイスの日付をエポックからのミリ秒単位で返します。
`DeviceDescriptor`	`getDeviceDescriptor ()` 実際のデバイスオブジェクトを渡さずにデバイス情報を取得するには、デバイス情報から`DeviceDescriptor`を返します。
`DeviceDescriptor`	`getDeviceDescriptor (boolean shortDescriptor)` 実際のデバイスオブジェクトを渡さずにデバイス情報を取得するには、デバイス情報から`DeviceDescriptor`を返します。
`TestDeviceState`	`getDeviceState ()` デバイスの状態を取得します。
`long`	`getDeviceTimeOffset (Date date)` デバイスと指定された`ERROR(/Date)`の間の時差を取得するヘルパー。
`InputStreamSource`	`getEmulatorOutput ()` エミュレータの標準出力と標準エラー出力のストリームを取得します。
`Process`	`getEmulatorProcess ()` このエミュレータに対応する`Process`を返します。
`final File`	`getExecuteShellCommandLog ()` すべての`executeShellCommand(String)`ログを含むログ。
`long`	`getExternalStoreFreeSpace ()` デバイスの外部ストレージ上の空き領域の量を決定するヘルパーメソッド。
`String`	`getFastbootPath ()` 使用されている fastboot バイナリのパスを返します。
`String`	`getFastbootProductType ()` 高速ブートモードのときにこのデバイスの製品タイプを取得する便利なメソッド。
`String`	`getFastbootProductVariant ()` 高速ブートモードのときにこのデバイスの製品タイプを取得する便利なメソッド。
`String`	`getFastbootSerialNumber ()` fastboot モードのシリアル番号を返します。
`String`	`getFastbootVariable (String variableName)` 指定された fastboot 変数値をデバイスから取得します。
`String`	`getFastbootVersion ()` 使用されている fastboot バイナリのバージョン文字列を返します。
`IFileEntry`	`getFileEntry (String path)` デバイス上のリモートファイルへの参照を取得します。
`IFileEntry`	`getFileEntry (FileListingService.FileEntry entry)` 非ルートパスから`FileEntry`を取得するための非公式ヘルパー。
	`getFoldableStates ()` デバイス上の折りたたみ可能な状態のリストを返します。
`IDevice`	`getIDevice ()` 関連付けられた ddmlib `IDevice`への参照を返します。
	`getInstalledPackageNames ()` デバイス上に存在するアプリケーションパッケージ名を取得します。
`long`	`getIntProperty (String name, long defaultValue)` デバイスから指定されたプロパティの整数値を返します。
`String`	`getIpAddress ()` デバイスのIPアドレスを取得します。
`KeyguardControllerState`	`getKeyguardState ()` キーガードの現在の状態を取得するオブジェクトを返すか、サポートされていない場合は null を返します。
`long`	`getLastExpectedRebootTimeMillis ()` `System.currentTimeMillis()`によって返される EPOCH 以降、Tradefed API が最後に再起動をトリガーした時間をミリ秒単位で返します。
`int`	`getLaunchApiLevel ()` デバイスの最初に起動された API レベルを取得します。
`InputStreamSource`	`getLogcat ()` logcat データのスナップショットストリームを取得します。
`InputStreamSource`	`getLogcat (int maxBytes)` キャプチャされた logcat データの最後の`maxBytes`のスナップショットストリームを取得します。
`InputStreamSource`	`getLogcatDump ()` デバイスの現在の logcat のダンプを取得します。
`InputStreamSource`	`getLogcatSince (long date)` 指定された日付から始まる、キャプチャされた logcat データのスナップショットストリームを取得します。
`String`	`getMacAddress ()` デバイスの MAC アドレスを返します。デバイスからのクエリに失敗した場合は null を返します。
`Integer`	`getMainUserId ()` メインのユーザー ID を返します。
	`getMainlineModuleInfo ()` デバイスにインストールされているメインラインモジュールに関する情報を取得します。
`int`	`getMaxNumberOfRunningUsersSupported ()` サポートされている同時実行ユーザーの最大数を取得します。
`int`	`getMaxNumberOfUsersSupported ()` サポートされているユーザーの最大数を取得します。
`Process`	`getMicrodroidProcess ()`
`IDeviceStateMonitor`	`getMonitor ()` デバイスに関連付けられた`IDeviceStateMonitor`を返します。
`String`	`getMountPoint (String mountName)` マウントポイントを返します。
`ITestDevice.MountPointInfo`	`getMountPointInfo (String mountpoint)` 指定されたマウントポイントパスに対応する`MountPointInfo`を返します。そのパスに何もマウントされていない場合、またはマウントポイントとして /proc/mounts に表示されない場合は`null`返します。
	`getMountPointInfo ()` デバイス上の /proc/mounts 内の情報の解析されたバージョンを返します。
`TestDeviceOptions`	`getOptions ()` デバイスのテストオプションを取得します。
`long`	`getPartitionFreeSpace (String partition)` デバイスパーティション上の空き領域の量を決定するヘルパーメソッド。
`Integer`	`getPrimaryUserId ()` プライマリユーザー ID を返します。
`ProcessInfo`	`getProcessByName (String processName)` ヘルパーメソッドは、「pidof」および「stat」コマンドを実行し、指定されたプロセスの PID とプロセス開始時間を含む`ProcessInfo`オブジェクトを返します。
`String`	`getProcessPid (String process)` サービスの PID を返すか、何か問題があった場合は null を返します。
`String`	`getProductType ()` このデバイスの製品タイプを取得するための便利なメソッド。
`String`	`getProductVariant ()` このデバイスの製品バリアントを取得するための便利な方法。
`String`	`getProperty (String name)` デバイスから指定されたプロパティ値を取得します。
`ITestDevice.RecoveryMode`	`getRecoveryMode ()` デバイスに使用されている現在の回復モードを取得します。
`InputStreamSource`	`getScreenshot (String format)` デバイスからスクリーンショットを取得します。
`InputStreamSource`	`getScreenshot (long displayId)` 指定されたディスプレイ ID でデバイスからスクリーンショットを取得します。
`InputStreamSource`	`getScreenshot (String format, boolean rescale)` デバイスからスクリーンショットを取得します。
`InputStreamSource`	`getScreenshot ()` デバイスからスクリーンショットを取得します。
`String`	`getSerialNumber ()` このデバイスのシリアル番号を取得するための便利なメソッド。
`String`	`getSetting (int userId, String namespace, String key)` 要求された設定の値を返します。
`String`	`getSetting (String namespace, String key)` `getSetting(int, String, String)`参照し、システムユーザーに対して実行されます。
`String`	`getSimOperator ()` SIM カードのオペレータを返すか、利用できない場合、またはデバイスが利用できない場合は null を返します。
`String`	`getSimState ()` SIM カードの状態を返します。利用できない場合、またはデバイスが利用できない場合は null を返します。
	`getTombstones ()` デバイスからトゥームストーンのリストを取得して返します。
`long`	`getTotalMemory ()` 物理メモリの合計サイズをバイト単位で返します。内部エラーの場合は -1 を返します。
	`getUninstallablePackageNames ()` アンインストールできるアプリケーションのパッケージ名を取得します。
`boolean`	`getUseFastbootErase ()` デバイス上のパーティションを消去するために fastboot 消去または fastboot フォーマットを使用するかどうかを取得します。
`int`	`getUserFlags (int userId)` 指定されたユーザーのフラグを検索して返します。
	`getUserInfos ()` デバイス上の useId から`UserInfo`へのマップを取得します。
`int`	`getUserSerialNumber (int userId)` userId が見つかった場合はそのシリアル番号を返し、それ以外の場合は -10000 を返します。
`IManagedTestDevice.DeviceEventResponse`	`handleAllocationEvent (DeviceEvent event)` 指定された DeviceEvent を処理します。 DeviceEvent を処理します。これにより、このデバイスが新しい割り当て状態に移行する場合と移行しない場合があります。
`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`	`installPackageForUser (File packageFile, boolean reinstall, int userId, String... extraArgs)` 特定のユーザーのデバイスに Android パッケージをインストールします。
`String`	`installPackageForUser (File packageFile, boolean reinstall, boolean grantPermissions, int userId, String... extraArgs)` 特定のユーザーのデバイスに Android パッケージをインストールします。
`void`	`invalidatePropertyCache ()`
`boolean`	`isAdbRoot ()`
`boolean`	`isAdbTcp ()`
`boolean`	`isAppEnumerationSupported ()` デバイス上のプラットフォームがアプリの列挙をサポートしているかどうかを確認する
`boolean`	`isBypassLowTargetSdkBlockSupported ()` デバイス上のプラットフォームがアプリのインストール時の低ターゲット SDK ブロックのバイパスをサポートしているかどうかを確認します
`boolean`	`isDeviceEncrypted ()` デバイスが暗号化されているかどうかを返します。
`boolean`	`isDirectory (String path)` デバイス上のパスがディレクトリの場合は True を返し、それ以外の場合は false を返します。
`boolean`	`isEnableAdbRoot ()`
`boolean`	`isEncryptionSupported ()` デバイスで暗号化がサポートされているかどうかを返します。
`boolean`	`isExecutable (String fullPath)` デバイス上のファイルパスが実行可能ファイルの場合は True を返し、それ以外の場合は false を返します。
`boolean`	`isFastbootEnabled ()` デバイスで fastboot が利用できる場合に返します。
`boolean`	`isHeadless ()` デバイスがヘッドレス (画面なし) の場合は true を返し、それ以外の場合は false を返します。
`boolean`	`isHeadlessSystemUserMode ()` デバイスがヘッドレスシステムユーザーモードを使用するかどうかを返します。
`boolean`	`isMainUserPermanentAdmin ()` メインユーザーが永続管理者であり、削除できないか、非管理者ステータスにダウングレードできないかどうかを返します。
`boolean`	`isMultiUserSupported ()` マルチユーザーがサポートされているかどうかを決定します。
`boolean`	`isPackageInstalled (String packageName, String userId)` 指定されたパッケージ名と指定されたユーザー ID をデバイスに照会して、そのユーザーに現在インストールされているかどうかを確認します。
`boolean`	`isPackageInstalled (String packageName)` 特定のパッケージ名をデバイスに問い合わせて、そのパッケージが現在インストールされているかどうかを確認します。
`boolean`	`isRuntimePermissionSupported ()` デバイス上のプラットフォームが実行時権限付与をサポートしているかどうかを確認する
`boolean`	`isStateBootloaderOrFastbootd ()` デバイスが`TestDeviceState#FASTBOOT`または`TestDeviceState.FASTBOOTD`にある場合は true を返します。
`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 ()` デバイスがユーザーをバックグラウンドで表示して起動できるかどうかを返します。
`boolean`	`isWifiEnabled ()` Wi-Fi が有効かどうかをテストします。
	`listDisplayIds ()` 「dumpsys SurfaceFlinger」によって報告された、デバイス上で使用可能なディスプレイ ID のリストを収集します。
	`listDisplayIdsForStartingVisibleBackgroundUsers ()` `start a user visible in the background`ために使用できるディスプレイのリストを取得します。
	`listUsers ()` デバイス上のユーザーのリストを取得します。
`boolean`	`logAnrs ( ITestLogger logger)` デバイスから ANR を収集して記録します。
`boolean`	`logBugreport (String dataName, ITestLogger listener)` バグレポートを取得して報告者に記録するためのヘルパーメソッド。
`void`	`logOnDevice (String tag, Log.LogLevel level, String format, Object... args)` デバイスの logcat にメッセージを記録します。
`void`	`nonBlockingReboot ()` デバイスを再起動するコマンドを発行し、コマンドが完了し、デバイスが adb に認識されなくなったときに戻ります。
`void`	`postAdbRootAction ()` adb root の後、デバイスがオンラインに戻る前に、デバイスで特定のアクションを実行する必要がある場合は、オーバーライドします。
`void`	`postAdbUnrootAction ()` adb unroot 後、デバイスがオンラインに戻る前に、デバイスで特定のアクションを実行する必要がある場合は、オーバーライドします。
`void`	`postBootSetup ()` 毎回の起動後にテスト用にデバイスを構成する手順を実行します。
`void`	`postInvocationTearDown (Throwable exception)` デバイス固有の必要なクリーンアップの追加手順は、呼び出しの完了後に実行されます。
`void`	`preInvocationSetup ( IBuildInfo info, MultiMap <String, String> attributes)` 呼び出しフローの前にデバイス上で実行される、デバイス固有の必要なセットアップのための追加の手順。
`boolean`	`pullDir (String deviceFilePath, File localDir)` デバイスからディレクトリの内容を再帰的にプルします。
`boolean`	`pullFile (String remoteFilePath, File localFile)` デバイスからファイルを取得します。
`File`	`pullFile (String remoteFilePath, int userId)` デバイスからファイルを取得し、それをローカルの一時`ERROR(/File)`に保存し、その`File`を返します。
`File`	`pullFile (String remoteFilePath)` デバイスからファイルを取得し、それをローカルの一時`ERROR(/File)`に保存し、その`File`を返します。
`boolean`	`pullFile (String remoteFilePath, File localFile, int userId)` デバイスからファイルを取得します。
`String`	`pullFileContents (String remoteFilePath)` デバイスからファイルを取得し、その内容を返します。
`File`	`pullFileFromExternal (String remoteFilePath)` デバイスの外部ストレージからファイルを取得し、それをローカルの一時`ERROR(/File)`に保存し、その`File`への参照を返す便利なメソッド。
`boolean`	`pushDir (File localFileDir, String deviceFilePath, excludedDirectories)` `pushDir (File localFileDir, String deviceFilePath, excludedDirectories)` フィルタリングされた一部のディレクトリを除外しながら、ディレクトリの内容をデバイスに再帰的にプッシュします。
`boolean`	`pushDir (File localFileDir, String deviceFilePath)` ディレクトリの内容をデバイスに再帰的にプッシュします。
`boolean`	`pushFile (File localFile, String remoteFilePath, boolean evaluateContentProviderNeeded)` `pushFile(File, String)`のバリアント。オプションでコンテンツプロバイダーの必要性の評価を検討できます。
`boolean`	`pushFile (File localFile, String remoteFilePath)` ファイルをデバイスにプッシュします。
`boolean`	`pushString (String contents, String remoteFilePath)` 文字列から作成されたファイルをデバイスにプッシュします
`void`	`reboot (String reason)` デバイスを再起動して、再起動後も保持されるように指定された`reason`を付けて adb モードにします。
`void`	`reboot ()` デバイスを adb モードで再起動します。
`void`	`rebootIntoBootloader ()` デバイスをブートローダーモードで再起動します。
`void`	`rebootIntoFastbootd ()` デバイスを fastbootd モードで再起動します。
`void`	`rebootIntoRecovery ()` デバイスを adb リカバリモードで再起動します。
`void`	`rebootIntoSideload ()` デバイスを adb サイドロードモードで再起動します (これは回復中の特別なモードであることに注意してください) デバイスがサイドロードモードに入るまでブロックします
`void`	`rebootIntoSideload (boolean autoReboot)` デバイスを adb サイドロードモードで再起動します (これは回復中の特別なモードであることに注意してください) デバイスがサイドロードモードに入るまでブロックします
`void`	`rebootUntilOnline ()` `reboot()`の代替手段で、デバイスがオンラインになるまで、つまり adb に認識されるまでブロックするだけです。
`void`	`rebootUntilOnline (String reason)` `reboot()`の代替手段で、デバイスがオンラインになるまで、つまり adb に認識されるまでブロックするだけです。
`void`	`rebootUserspace ()` デバイスのユーザースペース部分のみを再起動します。
`void`	`rebootUserspaceUntilOnline ()` `rebootUserspace()` ()} の代替で、デバイスがオンラインになるまで、つまり adb に表示されるまでブロックするだけです。
`boolean`	`recoverDevice ()` デバイスの通信の回復を試みます。
`void`	`registerDeviceActionReceiver ( IDeviceActionReceiver deviceActionReceiver)` このデバイスの`IDeviceActionReceiver`を登録します。
`void`	`remountSystemReadOnly ()` デバイス上のシステムパーティションを読み取り専用にします。
`void`	`remountSystemWritable ()` デバイス上のシステムパーティションを書き込み可能にします。
`void`	`remountVendorReadOnly ()` デバイス上のベンダーパーティションを読み取り専用にします。
`void`	`remountVendorWritable ()` デバイス上のベンダーパーティションを書き込み可能にします。
`boolean`	`removeAdmin (String componentName, int userId)` 指定されたユーザーの指定されたデバイス管理者を削除し、成功した場合は`true`を返し、そうでない場合は`false`返します。
`void`	`removeOwners ()` ベストエフォートで既存のデバイスプロファイル所有者をすべて削除します。
`boolean`	`removeUser (int userId)` 特定のユーザーをデバイスから削除します。
`void`	`resetContentProviderSetup ()` 再度トリガーするには、コンテンツプロバイダーのセットアップのフラグをリセットします。
`boolean`	`runInstrumentationTests (IRemoteAndroidTestRunner runner, ITestLifeCycleReceiver... listeners)` パラメーターとして渡された 1 つ以上のリスナーを`ERROR(/#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection))`実行するための便利なメソッド。
`boolean`	`runInstrumentationTests (IRemoteAndroidTestRunner runner, listeners)` `runInstrumentationTests (IRemoteAndroidTestRunner runner, listeners)` インストルメンテーションテストを実行し、デバイスのリカバリを提供します。
`boolean`	`runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, int userId, listeners)` `runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, int userId, listeners)` `ERROR(ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection)/com.android.tradefed.device.ITestDevice#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection) ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection))`テストを実行します。指定されたユーザー向け。
`boolean`	`runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, int userId, ITestLifeCycleReceiver... listeners)` `ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, ITestLifeCycleReceiver...)`と同じですが、指定されたユーザーに対してテストを実行します。
`void`	`setConfiguration ( IConfiguration configuration)` 使用中の`IConfiguration`を挿入します。
`final void`	`setConnectionAvdInfo ( GceAvdInfo avdInfo)`
`void`	`setDate (Date date)` デバイスに日付を設定します注: デバイスの日付を設定するには root が必要です
`boolean`	`setDeviceOwner (String componentName, int userId)` デバイス管理コンポーネントを特定のユーザーのデバイス所有者として設定します。
`void`	`setDeviceState ( TestDeviceState deviceState)` デバイスの状態を更新します。
`void`	`setEmulatorOutputStream ( SizeLimitedOutputStream output)` エミュレータの場合、ログ出力に`SizeLimitedOutputStream`を設定します。
`void`	`setEmulatorProcess (Process p)` このデバイスがエミュレータの場合、 `Process`を設定します。
`void`	`setFastbootEnabled (boolean fastbootEnabled)` デバイスの fastboot オプションを設定します。
`void`	`setFastbootPath (String fastbootPath)` 使用する必要がある fastboot バイナリへのパスを設定します。
`void`	`setIDevice (IDevice newDevice)` この ITestDevice に関連付けられている IDevice を更新します。
`void`	`setLogStartDelay (int delay)` オンラインデバイスの logcat キャプチャを開始するまでの待機時間をミリ秒単位で設定します。
`void`	`setOptions ( TestDeviceOptions options)` デバイスの`TestDeviceOptions`を設定する
`boolean`	`setProperty (String propKey, String propValue)` 指定されたプロパティ値をデバイスに設定します。
`void`	`setRecovery ( IDeviceRecovery recovery)` このデバイスに使用する`IDeviceRecovery`を設定します。
`void`	`setRecoveryMode ( ITestDevice.RecoveryMode mode)` デバイスに使用する現在の回復モードを設定します。
`void`	`setSetting (String namespace, String key, String value)` `setSetting(int, String, String, String)`参照し、システムユーザーに対して実行されます。
`void`	`setSetting (int userId, String namespace, String key, String value)` 指定されたユーザーの名前空間に設定値を追加します。
`void`	`setTestLogger ( ITestLogger testLogger)` `ITestLogger`インスタンスを挿入します
`void`	`setUseFastbootErase (boolean useFastbootErase)` デバイス上のパーティションを消去するために fastboot 消去または fastboot フォーマットを使用するかどうかを設定します。
`void`	`startLogcat ()` バックグラウンドでデバイスからの logcat 出力のキャプチャを開始します。
`boolean`	`startUser (int userId)` 指定されたユーザーが現在停止している場合は、バックグラウンドで開始します。
`boolean`	`startUser (int userId, boolean waitFlag)` 指定されたユーザーが現在停止している場合は、バックグラウンドで開始します。
`boolean`	`startVisibleBackgroundUser (int userId, int displayId, boolean waitFlag)` 指定されたユーザーをバックグラウンドで開始し、指定されたディスプレイに表示されます (つまり、ユーザーがそのディスプレイでアクティビティを起動できるようになります)。
`void`	`stopEmulatorOutput ()` エミュレータ出力を閉じて削除します。
`void`	`stopLogcat ()` デバイスからの logcat 出力のキャプチャを停止し、現在保存されている logcat データを破棄します。
`boolean`	`stopUser (int userId)` 指定されたユーザーを停止します。
`boolean`	`stopUser (int userId, boolean waitFlag, boolean forceFlag)` 特定のユーザーを停止します。
`String`	`switchToAdbTcp ()` デバイスを adb-over-tcp モードに切り替えます。
`boolean`	`switchToAdbUsb ()` デバイスを adb over USB モードに切り替えます。
`boolean`	`switchUser (int userId)` デフォルトのタイムアウトを持つ別の userId に切り替えます。
`boolean`	`switchUser (int userId, long timeout)` 指定されたタイムアウトを期限として別の userId に切り替えます。
`boolean`	`syncFiles (File localFileDir, String deviceFilePath)` ローカルファイルディレクトリの内容をデバイスに増分同期します。
`Bugreport`	`takeBugreport ()` バグレポートを取得し、バグレポートを処理するために`Bugreport`オブジェクト内に返します。
`String`	`uninstallPackage (String packageName)` デバイスから Android パッケージをアンインストールします。
`String`	`uninstallPackageForUser (String packageName, int userId)` 特定のユーザーのデバイスから Android パッケージをアンインストールします。
`boolean`	`unlockDevice ()` デバイスが暗号化状態にある場合、デバイスのロックを解除します。
`boolean`	`waitForBootComplete (long timeOut)` デバイスのブート完了フラグが設定されるまでブロックします。
`boolean`	`waitForDeviceAvailable ()` デバイスが応答し、テストできるようになるまで待ちます。
`boolean`	`waitForDeviceAvailable (long waitTime)` デバイスが応答し、テストできるようになるまで待ちます。
`boolean`	`waitForDeviceAvailableInRecoverPath (long waitTime)` 回復パスを考慮せずに、デバイスが応答して使用可能になるまで待機します。
`void`	`waitForDeviceBootloader ()` fastboot 経由でデバイスが表示されるまでブロックします。
`boolean`	`waitForDeviceInRecovery (long waitTime)` デバイスが「adb Recovery」状態になることをブロックします (これは`IDeviceRecovery`とは異なることに注意してください)。
`boolean`	`waitForDeviceInSideload (long waitTime)` デバイスが「adb サイドロード」状態になるためのブロック
`boolean`	`waitForDeviceNotAvailable (long waitTime)` デバイスが利用できないようにブロックします。つまり、adb から欠落しています。
`void`	`waitForDeviceOnline ()` デバイスが adb 経由で表示されるまでブロックします。
`void`	`waitForDeviceOnline (long waitTime)` デバイスが adb 経由で表示されるまでブロックします。
`boolean`	`waitForDeviceShell (long waitTime)` デバイスが基本的な adb シェルコマンドに応答するまで待機します。

保護されたメソッド
`void`	`addExtraConnectionBuilderArgs ( DefaultConnection.ConnectionBuilder builder)`
`String[]`	`buildAdbShellCommand (String command, boolean forceExitStatusDetection)` 指定された adb シェルコマンドセッションと引数の OS コマンドを構築します
`void`	`checkApiLevelAgainst (String feature, int strictMinLevel)`
`NativeDevice.RebootDeviceAction`	`createRebootDeviceAction ( NativeDevice.RebootMode rebootMode, String reason)` 再起動アクションを実行するときに使用する`RebootDeviceAction`を作成します。
`IRunUtil`	`createRunUtil ()`
`void`	`doAdbReboot ( NativeDevice.RebootMode rebootMode, String reason)` adb の再起動を実行します。
`void`	`ensureRuntimePermissionSupported ()` 実行時権限がサポートされていない場合に例外をスローするヘルパーメソッド
`int`	`getApiLevelSafe ()`
`ITestLogger`	`getLogger ()`
`IRunUtil`	`getRunUtil ()` 使用する`RunUtil`インスタンスを取得します。
`void`	`initializeConnection ( IBuildInfo info, MultiMap <String, String> attributes)`
`String`	`internalGetProperty (String propName, String fastbootVar, String description)` デフォルトで ddmlib キャッシュからデバイスプロパティをフェッチし、デバイスが Fastboot であるかどうかに応じて `adb shell getprop` または `fastboot getvar` のいずれかにフォールバックします。
`boolean`	`isInRebootCallback ()` 再起動コールバックが現在実行されているかどうかを返します。
`boolean`	`isNewer (File localFile, IFileEntry entry)` ローカルファイルがリモートファイルより新しい場合は`true`を返します。
`void`	`notifyRebootEnded ()` 再起動終了イベントをすべての`IDeviceActionReceiver`に通知します。
`void`	`notifyRebootStarted ()` 再起動開始イベントをすべての`IDeviceActionReceiver`に通知します。
`boolean`	`performDeviceAction (String actionDescription, NativeDevice.DeviceAction action, int retryAttempts)` このデバイス上でアクションを実行します。
`void`	`postAdbReboot ()` 再起動後に実行できる追加のアクション。
`void`	`prePostBootSetup ()` 各デバイスタイプ (AndroidNativeDevice、TestDevice) が特定の起動後のセットアップ用にこのメソッドをオーバーライドできるようにします。
`boolean`	`pullFileInternal (String remoteFilePath, File localFile)`
`void`	`setClock (Clock clock)` 使用する Clock インスタンスを設定します。
`void`	`setMicrodroidProcess (Process process)` TestDevice をマイクロドロイドとしてマークし、その CID を設定します。
`void`	`setTestDeviceOptions ( deviceOptions)` `setTestDeviceOptions ( deviceOptions)`
`CommandResult`	`simpleFastbootCommand (long timeout, envVarMap, String[] fullCmd)` `simpleFastbootCommand (long timeout, envVarMap, String[] fullCmd)` 環境変数を使用して単純な fastboot コマンドを実行し、コマンドのステータスを報告します。
`CommandResult`	`simpleFastbootCommand (long timeout, String[] fullCmd)` 単純な fastboot コマンドを実行し、コマンドのステータスを報告します。
`boolean`	`waitForDeviceNotAvailable (String operationDesc, long time)` デバイスが使用できなくなるまで待ちます (adb へのレポートを停止します)。

定数

INVALID_USER_ID

public static final int INVALID_USER_ID

無効または見つからないユーザー ID に対して返される値: UserHandle は -10000 値を定義しました

定数値: -10000 (0xffffd8f0)

MAX_HOST_DEVICE_TIME_OFFSET

protected static final long MAX_HOST_DEVICE_TIME_OFFSET

定数値: 5000 (0x0000000000001388)

MAX_RETRY_ATTEMPTS

protected static final int MAX_RETRY_ATTEMPTS

実行するコマンド再試行のデフォルトの回数

定数値: 2 (0x00000002)

田畑

SDカード

protected static final String SD_CARD

STORAGE_EMULATED

protected static final String STORAGE_EMULATED

mオプション

protected TestDeviceOptions mOptions

mStateMonitor

protected final IDeviceStateMonitor mStateMonitor

パブリックコンストラクター

ネイティブデバイス

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

TestDeviceを作成します。

パラメーター
`device`	`IDevice` : 関連付けられた`IDevice`
`stateMonitor`	`IDeviceStateMonitor` : 使用する`IDeviceStateMonitor`メカニズム
`allocationMonitor`	`IDeviceMonitor` : 割り当て状態の変更を通知する`IDeviceMonitor` 。 null も可能

パブリックメソッド

バッチPrefetchStartupBuildProps

public void batchPrefetchStartupBuildProps ()

それぞれの props に対して「adb getprop」を呼び出すのではなく、必要なすべての props をプリフェッチすることによるマイクロ最適化 (約 400 ミリ)。つまり、すべてのプロパティをフェッチするのは、1 つのプロパティをフェッチするのと同じくらい高速です。 device.getApiLevel()、checkApiLevelAgainstNextRelease、getBuildAlias などはすべて内部で「adb getprop」を呼び出します。これらを 1 回の呼び出しでフェッチし、NativeDevice.setProperty を呼び出します。これを行わなくても、NativeDevice 自体が setProperty を呼び出し、将来の呼び出しに備えて結果をキャッシュします。我々はそれを少し早めにやっているだけです。デバイスが回復中である場合、またはプロパティの取得中に他のエラーが発生した場合は、それらを無視します。

canSwitchToHeadlessSystemUser

public boolean canSwitchToHeadlessSystemUser ()

ヘッドレス SYSTEM ユーザーへの切り替えが許可されているかどうかを返します。

戻り値
`boolean`

投げる
`DeviceNotAvailableException`

checkApiLevelAgainstNextRelease

public boolean checkApiLevelAgainstNextRelease (int strictMinLevel)

最小限のサポートレベルを指定して、機能が現在サポートされているかどうかを確認します。この方法では、API レベルが上がる前に、まだリリースされていない機能が考慮されます。

パラメーター
`strictMinLevel`	`int` : 機能をサポートする厳密な最小可能レベル。

戻り値
`boolean`	レベルがサポートされている場合は True。それ以外の場合は false。

投げる
`DeviceNotAvailableException`

接続を確認する

public boolean checkConnectivity ()

デバイスがネットワークに接続されていることを確認します。

戻り値
`boolean`	デバイスに正常なネットワーク接続がある場合は`true` 、それ以外の場合は`false` 。

投げる
`DeviceNotAvailableException`

クリアエラーダイアログ

public boolean clearErrorDialogs ()

デバイス UI に現在表示されているエラーダイアログを閉じてみます。

戻り値
`boolean`	ダイアログが存在しないか、ダイアログが正常にクリアされた場合は`true` 。それ以外の場合は`false` 。

投げる
`DeviceNotAvailableException`

ClearLastConnectedWifiネットワーク

public void clearLastConnectedWifiNetwork ()

最後に接続した Wi-Fi ネットワークをクリアします。これは、デバイスの再起動後に前のテストで使用された Wi-Fi ネットワークに接続するのを避けるために、新しい呼び出しを開始するときに呼び出す必要があります。

クリアログキャット

public void clearLogcat ()

蓄積された logcat データを削除します。

これは、 ITestDevice#getLogcat()が特定の時点 (新しいデバイスビルドをフラッシュした後など) 以降に生成されたログデータのみを返すようにする場合に便利です。

Wifiネットワークに接続する

public boolean connectToWifiNetwork ( wifiSsidToPsk, 
                boolean scanSsid)

Wi-Fi ネットワークに接続します。

Wi-Fi をオンにし、wifiSsidToPsk マップで指定された Wi-Fi ネットワークの 1 つとの接続が成功するまでブロックします。接続が確立されると、インスタンスはITestDevice#disconnectFromWifi()またはITestDevice#clearLastConnectedWifiNetwork()が呼び出されるまで、再起動のたびに接続の復元を試みます。

パラメーター
`wifiSsidToPsk`	: Wi-Fi SSID とパスワードのマップ。
`scanSsid`	`boolean` : このネットワークの非表示の SSID をスキャンするかどうか。

戻り値
`boolean`	Wi-Fi ネットワークに正常に接続された場合は`true` 。それ以外の場合は`false`

投げる
`DeviceNotAvailableException`

Wifiネットワークに接続する

public boolean connectToWifiNetwork (String wifiSsid, 
                String wifiPsk)

Wi-Fi ネットワークに接続します。

Wi-Fi をオンにし、指定された Wi-Fi ネットワークへの接続が成功するまでブロックします。接続が確立されると、インスタンスはITestDevice#disconnectFromWifi()またはITestDevice#clearLastConnectedWifiNetwork()が呼び出されるまで、再起動のたびに接続の復元を試みます。

パラメーター
`wifiSsid`	`String` : 接続する Wi-Fi ssid
`wifiPsk`	`String` : PSK パスフレーズ、または暗号化されていない場合は null

戻り値
`boolean`	Wi-Fi ネットワークに正常に接続された場合は`true` 。それ以外の場合は`false`

投げる
`DeviceNotAvailableException`

Wifiネットワークに接続する

public boolean connectToWifiNetwork ( wifiSsidToPsk)

Wi-Fi ネットワークに接続します。

パラメーター
`wifiSsidToPsk`	: Wi-Fi SSID とパスワードのマップ。

戻り値
`boolean`	Wi-Fi ネットワークに正常に接続された場合は`true` 。それ以外の場合は`false`

投げる
`DeviceNotAvailableException`

Wifiネットワークに接続する

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

Wi-Fi ネットワークに接続します。

パラメーター
`wifiSsid`	`String` : 接続する Wi-Fi ssid
`wifiPsk`	`String` : PSK パスフレーズ、または暗号化されていない場合は null
`scanSsid`	`boolean` : このネットワークの非表示の SSID をスキャンするかどうか。

戻り値
`boolean`	Wi-Fi ネットワークに正常に接続された場合は`true` 。それ以外の場合は`false`

投げる
`DeviceNotAvailableException`

必要に応じて Wifi ネットワークに接続します

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

デバイスが現在ネットワークに接続していない場合にのみ接続するconnectToWifiNetwork(String, String)のバリアント。

パラメーター
`scanSsid`	`boolean` : このネットワークの非表示の SSID をスキャンするかどうか

戻り値
`boolean`	Wi-Fi ネットワークに正常に接続された場合は`true` 。それ以外の場合は`false`

投げる
`DeviceNotAvailableException`

必要に応じて Wifi ネットワークに接続します

public boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk)

デバイスが現在ネットワークに接続していない場合にのみ接続するconnectToWifiNetwork(String, String)のバリアント。

戻り値
`boolean`	Wi-Fi ネットワークに正常に接続された場合は`true` 。それ以外の場合は`false`

投げる
`DeviceNotAvailableException`

ユーザーを作成

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

指定された名前と指定されたフラグを使用してユーザーを作成します

パラメーター
`name`	`String` : デバイス上に作成するユーザーの
`guest`	`boolean` : 作成時にユーザーフラグ --guest を有効にします
`ephemeral`	`boolean` : 作成中にユーザーフラグ --ephemeral を有効にします

戻り値
`int`	作成したユーザーのID

投げる
`DeviceNotAvailableException`

ユーザーを作成

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

指定された名前と指定されたフラグを使用してユーザーを作成します

パラメーター
`name`	`String` : デバイス上に作成するユーザーの
`guest`	`boolean` : 作成時にユーザーフラグ --guest を有効にします
`ephemeral`	`boolean` : 作成中にユーザーフラグ --ephemeral を有効にします
`forTesting`	`boolean` : 作成時にテストフラグ --for-testing を有効にします

戻り値
`int`	作成したユーザーのID

投げる
`DeviceNotAvailableException`

ユーザーを作成

public int createUser (String name)

指定された名前とデフォルトのフラグ 0 を使用してユーザーを作成します。

パラメーター
`name`	`String` : デバイス上に作成するユーザーの

戻り値
`int`	作成されたユーザー ID の整数

投げる
`DeviceNotAvailableException`

createUserNoThrow

public int createUserNoThrow (String name)

指定された名前とデフォルトのフラグ 0 を使用してユーザーを作成します。

パラメーター
`name`	`String` : デバイス上に作成するユーザーの

戻り値
`int`	作成されたユーザー ID の整数、またはエラーの場合は -1。

投げる
`DeviceNotAvailableException`

ファイルを削除する

public void deleteFile (String deviceFilePath)

デバイス上のファイルまたはディレクトリを削除するヘルパーメソッド。

パラメーター
`deviceFilePath`	`String` : デバイス上のファイルの絶対パス。

投げる
`DeviceNotAvailableException`

DeviceActionReceiver の登録を解除する

public void deregisterDeviceActionReceiver (IDeviceActionReceiver deviceActionReceiver)

登録されたIDeviceActionReceiverを削除します。

パラメーター
`deviceActionReceiver`	`IDeviceActionReceiver` : 削除される`IDeviceActionReceiver` 。

デバイスソフト再起動

public boolean deviceSoftRestarted (ProcessInfo prevSystemServerProcess)

現在の system_server と以前の system_server ProcessInfoを比較することで、デバイスがソフト再起動したかどうかを確認するヘルパーメソッド。 getProcessByName(String)を使用してProcessInfoを取得します。

パラメーター
`prevSystemServerProcess`	`ProcessInfo` : 以前の system_server プロセス`ProcessInfo` 。

戻り値
`boolean`	デバイスがソフト再起動された場合は`true`

投げる
`DeviceNotAvailableException`

デバイスソフト再起動以来

public boolean deviceSoftRestartedSince (long utcEpochTime, 
                TimeUnit timeUnit)

デバイスとそのERROR(/TimeUnit)からのエポック以降の UTC 時間以降にデバイスがソフト再起動したかどうかを確認するヘルパーメソッド。ソフト再起動とは、デバイスのハードリブート (例: 要求された再起動) 以外で再起動された system_server を指します。現在のデバイスの utcEpochTime (ミリ秒単位) はgetDeviceDate()メソッドで取得できます。

パラメーター
`utcEpochTime`	`long` : エポックからの秒単位のデバイス時間。
`timeUnit`	`TimeUnit` : 指定された utcEpochTime の時間単位`TimeUnit` 。

戻り値
`boolean`	デバイスがソフト再起動された場合は`true`

投げる
`DeviceNotAvailableException`

AdbRootを無効にする

public boolean disableAdbRoot ()

adb root をオフにします。

adb root を無効にすると、デバイスが adb から切断される可能性があります。このメソッドは、デバイスが使用可能になるまでブロックされます。

戻り値
`boolean`	成功した場合は`true` 。

投げる
`DeviceNotAvailableException`

キーガードを無効にする

public void disableKeyguard ()

キーガードを無効にしようとします。

まず、入力ディスパッチの準備ができるまで待ちます。これは、デバイスが BOOT_COMPLETE を報告するのとほぼ同時に発生します。これは、現在のフレームワーク実装では時折競合状態が発生するため、明らかに非同期的に行われます。次に、キーガードを解除するコマンドが送信されます（安全でないキーガードでのみ機能します）

投げる
`DeviceNotAvailableException`

ネットワークモニターを無効にする

public boolean disableNetworkMonitor ()

デバイス上のネットワーク監視を無効にします。

戻り値
`boolean`	監視が正常に無効化された場合は`true` 。失敗した場合は`false` 。

投げる
`DeviceNotAvailableException`

Wifiから切断する

public boolean disconnectFromWifi ()

Wi-Fi ネットワークから切断します。

既知のネットワークのリストからすべてのネットワークを削除し、Wi-Fi を無効にします。

戻り値
`boolean`	Wi-Fi ネットワークから正常に切断された場合は`true` 。切断に失敗した場合は`false` 。

投げる
`DeviceNotAvailableException`

ファイルが存在しますか

public boolean doesFileExist (String deviceFilePath, 
                int userId)

デバイス上に特定のユーザーのファイルが存在するかどうかを判断するヘルパーメソッド。

パラメーター
`deviceFilePath`	`String` : チェックするデバイス上のファイルの絶対パス
`userId`	`int` : ファイルの存在をチェックするユーザー ID

戻り値
`boolean`	ファイルが存在する場合は`true` 、存在しない場合は`false` 。

投げる
`DeviceNotAvailableException`

ファイルが存在しますか

public boolean doesFileExist (String deviceFilePath)

デバイス上にファイルが存在するかどうかを判断するヘルパーメソッド。

パラメーター
`deviceFilePath`	`String` : チェックするデバイス上のファイルの絶対パス

戻り値
`boolean`	ファイルが存在する場合は`true` 、存在しない場合は`false` 。

投げる
`DeviceNotAvailableException`

ダンプヒープ

public File dumpHeap (String process, 
                String devicePath)

system_server からヒープをダンプしてみます。ダンプされたファイルをクリーンアップするのは呼び出し側の責任です。

パラメーター
`process`	`String` : ダンプヒープを作成するデバイスプロセスの名前。
`devicePath`	`String` : ダンプを配置するデバイス上のパス。これは権限で許可されている場所である必要があります。

戻り値
`File`	レポートを含む`ERROR(/File)` 。何かが失敗した場合は null。

投げる
`DeviceNotAvailableException`

AdbRoot を有効にする

public boolean enableAdbRoot ()

adb root をオンにします。「enable-root」設定が「false」の場合、メッセージをログに記録し、root を有効にせずに戻ります。

adb root を有効にすると、デバイスが adb から切断される可能性があります。このメソッドは、デバイスが使用可能になるまでブロックされます。

戻り値
`boolean`	成功した場合は`true` 。

投げる
`DeviceNotAvailableException`

ネットワークモニターを有効にする

public boolean enableNetworkMonitor ()

デバイス上のネットワーク監視を有効にします。

戻り値
`boolean`	監視が正常に有効化された場合は`true` 。失敗した場合は`false` 。

投げる
`DeviceNotAvailableException`

実行Adbコマンド

public String executeAdbCommand (long timeout, 
                String... cmdArgs)

指定されたタイムアウトで adb コマンドをシステムコマンドとして実行するヘルパーメソッド。

代わりに、可能な限り、 executeShellCommand(String)を使用してください。このメソッドの方が障害検出とパフォーマンスが向上します。

パラメーター
`timeout`	`long` : デバイスが応答なしとみなされるまでの時間 (ミリ秒)、タイムアウトなしの場合は 0L
`cmdArgs`	`String` : 実行する adb コマンドと引数

戻り値
`String`	コマンドからの標準出力。コマンドの実行に失敗した場合は`null` 。

投げる
`DeviceNotAvailableException`

実行Adbコマンド

public String executeAdbCommand (long timeout, 
                 envMap, 
                String... cmdArgs)

指定されたタイムアウトで adb コマンドをシステムコマンドとして実行するヘルパーメソッド。

代わりに、可能な限り、 executeShellCommand(String)を使用してください。このメソッドの方が障害検出とパフォーマンスが向上します。

パラメーター
`timeout`	`long` : デバイスが応答なしとみなされるまでの時間 (ミリ秒)、タイムアウトなしの場合は 0L
`envMap`	: コマンドに設定する環境
`cmdArgs`	`String` : 実行する adb コマンドと引数

戻り値
`String`	コマンドからの標準出力。コマンドの実行に失敗した場合は`null` 。

投げる
`DeviceNotAvailableException`

実行Adbコマンド

public String executeAdbCommand (String... cmdArgs)

adbコマンドをシステムコマンドとして実行するヘルパーメソッド。

代わりに、可能な限り、 executeShellCommand(String)を使用してください。このメソッドの方が障害検出とパフォーマンスが向上します。

パラメーター
`cmdArgs`	`String` : 実行する adb コマンドと引数

戻り値
`String`	コマンドからの標準出力。コマンドの実行に失敗した場合は`null` 。

投げる
`DeviceNotAvailableException`

高速起動コマンドの実行

public CommandResult executeFastbootCommand (String... cmdArgs)

Helper method which executes a fastboot command as a system command with a default timeout of 2 minutes.

Expected to be used when device is already in fastboot mode.

Parameters
`cmdArgs`	`String` : the fastboot command and arguments to run

Returns
`CommandResult`	the CommandResult containing output of command

Throws
`DeviceNotAvailableException`

executeFastbootCommand

public CommandResult executeFastbootCommand (long timeout, 
                String... cmdArgs)

Helper method which executes a fastboot command as a system command.

Expected to be used when device is already in fastboot mode.

Parameters
`timeout`	`long` : the time in milliseconds before the command expire
`cmdArgs`	`String` : the fastboot command and arguments to run

Returns
`CommandResult`	the CommandResult containing output of command

Throws
`DeviceNotAvailableException`

executeLongFastbootCommand

public CommandResult executeLongFastbootCommand (String... cmdArgs)

Helper method which executes a long running fastboot command as a system command.

Identical to executeFastbootCommand(String) except uses a longer timeout.

Parameters
`cmdArgs`	`String` : the fastboot command and arguments to run

Returns
`CommandResult`	the CommandResult containing output of command

Throws
`DeviceNotAvailableException`

executeLongFastbootCommand

public CommandResult executeLongFastbootCommand ( envVarMap, 
                String... cmdArgs)

Helper method which executes a long running fastboot command as a system command with system environment variables.

Identical to executeFastbootCommand(String) except uses a longer timeout.

Parameters
`envVarMap`	: the system environment variables that the fastboot command run with
`cmdArgs`	`String` : the fastboot command and arguments to run

Returns
`CommandResult`	the CommandResult containing output of command

Throws
`DeviceNotAvailableException`

executeShellCommand

public String executeShellCommand (String command)

Helper method which executes a adb shell command and returns output as a String .

Parameters
`command`	`String` : the adb shell command to run

Returns
`String`	the shell output

Throws
`DeviceNotAvailableException`

executeShellCommand

public void executeShellCommand (String command, 
                IShellOutputReceiver receiver, 
                long maxTimeToOutputShellResponse, 
                TimeUnit timeUnit, 
                int retryAttempts)

Executes a adb shell command, with more parameters to control command behavior.

Parameters
`command`	`String` : the adb shell command to run
`receiver`	`IShellOutputReceiver` : the `IShellOutputReceiver` to direct shell output to.
`maxTimeToOutputShellResponse`	`long` : the maximum amount of time during which the command is allowed to not output any response; unit as specified in `timeUnit`
`timeUnit`	`TimeUnit` : unit for `maxTimeToOutputShellResponse`
`retryAttempts`	`int` : the maximum number of times to retry command if it fails due to a exception. DeviceNotResponsiveException will be thrown if `retryAttempts` are performed without success.

Throws
`DeviceNotAvailableException`

executeShellCommand

public void executeShellCommand (String command, 
                IShellOutputReceiver receiver, 
                long maxTimeoutForCommand, 
                long maxTimeToOutputShellResponse, 
                TimeUnit timeUnit, 
                int retryAttempts)

Executes a adb shell command, with more parameters to control command behavior.

Parameters
`command`	`String` : the adb shell command to run
`receiver`	`IShellOutputReceiver` : the `IShellOutputReceiver` to direct shell output to.
`maxTimeoutForCommand`	`long` : the maximum timeout for the command to complete; unit as specified in `timeUnit`
`maxTimeToOutputShellResponse`	`long` : the maximum amount of time during which the command is allowed to not output any response; unit as specified in `timeUnit`
`timeUnit`	`TimeUnit` : unit for `maxTimeToOutputShellResponse`
`retryAttempts`	`int` : the maximum number of times to retry command if it fails due to a exception. DeviceNotResponsiveException will be thrown if `retryAttempts` are performed without success.

Throws
`DeviceNotAvailableException`

executeShellCommand

public void executeShellCommand (String command, 
                IShellOutputReceiver receiver)

Executes the given adb shell command, retrying multiple times if command fails.

A simpler form of executeShellCommand(String, com.android.ddmlib.IShellOutputReceiver, long, TimeUnit, int) with default values.

Parameters
`command`	`String` : the adb shell command to run
`receiver`	`IShellOutputReceiver` : the `IShellOutputReceiver` to direct shell output to.

Throws
`DeviceNotAvailableException`

executeShellV2Command

public CommandResult executeShellV2Command (String cmd)

Helper method which executes a adb shell command and returns the results as a CommandResult properly populated with the command status output, stdout and stderr.

Parameters
`cmd`	`String` : The command that should be run.

Returns
`CommandResult`	The result in `CommandResult` .

Throws
`DeviceNotAvailableException`

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                OutputStream pipeToOutput)

Helper method which executes an adb shell command and returns the results as a CommandResult properly populated with the command status output and stderr. stdout is directed to the specified stream.

Parameters
`cmd`	`String` : The command that should be run.
`pipeToOutput`	`OutputStream` : `ERROR(/OutputStream)` where the std output will be redirected, or null.

Returns
`CommandResult`	The result in `CommandResult` .

Throws
`DeviceNotAvailableException`

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                File pipeAsInput)

Helper method which executes an adb shell command and returns the results as a CommandResult properly populated with the command status output, stdout and stderr.

Parameters
`cmd`	`String` : The command that should be run.
`pipeAsInput`	`File` : A `ERROR(/File)` that will be piped as input to the command, or null.

Returns
`CommandResult`	The result in `CommandResult` .

Throws
`DeviceNotAvailableException`

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit, 
                int retryAttempts)

Executes a adb shell command, with more parameters to control command behavior.

Parameters
`cmd`	`String` : the adb shell command to run
`maxTimeoutForCommand`	`long` : the maximum timeout for the command to complete; unit as specified in `timeUnit`
`timeUnit`	`TimeUnit` : unit for `maxTimeToOutputShellResponse`
`retryAttempts`	`int` : the maximum number of times to retry command if it fails due to a exception. DeviceNotResponsiveException will be thrown if `retryAttempts` are performed without success.

Returns
`CommandResult`

Throws
`DeviceNotAvailableException`

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit)

Executes a adb shell command, with more parameters to control command behavior.

Parameters
`cmd`	`String` : the adb shell command to run
`maxTimeoutForCommand`	`long` : the maximum timeout for the command to complete; unit as specified in `timeUnit`
`timeUnit`	`TimeUnit` : unit for `maxTimeToOutputShellResponse`

Returns
`CommandResult`

Throws
`DeviceNotAvailableException`

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                File pipeAsInput, 
                OutputStream pipeToOutput, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit, 
                int retryAttempts)

Executes a adb shell command, with more parameters to control command behavior.

Parameters
`cmd`	`String` : the adb shell command to run
`pipeAsInput`	`File` : A `ERROR(/File)` that will be piped as input to the command, or null.
`pipeToOutput`	`OutputStream` : `ERROR(/OutputStream)` where the std output will be redirected, or null.
`maxTimeoutForCommand`	`long` : the maximum timeout for the command to complete; unit as specified in `timeUnit`
`timeUnit`	`TimeUnit` : unit for `maxTimeToOutputShellResponse`
`retryAttempts`	`int` : the maximum number of times to retry command if it fails due to a exception. DeviceNotResponsiveException will be thrown if `retryAttempts` are performed without success.

Returns
`CommandResult`

Throws
`DeviceNotAvailableException`

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                File pipeAsInput, 
                OutputStream pipeToOutput, 
                OutputStream pipeToError, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit, 
                int retryAttempts)

Executes a adb shell command, with more parameters to control command behavior.

Parameters
`cmd`	`String` : the adb shell command to run
`pipeAsInput`	`File` : A `ERROR(/File)` that will be piped as input to the command, or null.
`pipeToOutput`	`OutputStream` : `ERROR(/OutputStream)` where the std output will be redirected, or null.
`pipeToError`	`OutputStream` : `ERROR(/OutputStream)` where the std error will be redirected, or null.
`maxTimeoutForCommand`	`long` : the maximum timeout for the command to complete; unit as specified in `timeUnit`
`timeUnit`	`TimeUnit` : unit for `maxTimeToOutputShellResponse`
`retryAttempts`	`int` : the maximum number of times to retry command if it fails due to a exception. DeviceNotResponsiveException will be thrown if `retryAttempts` are performed without success.

Returns
`CommandResult`

Throws
`DeviceNotAvailableException`

fastbootWipePartition

public CommandResult fastbootWipePartition (String partition)

Helper method which wipes a partition for the device.

If getUseFastbootErase() is true , then fastboot erase will be used to wipe the partition. The device must then create a filesystem the next time the device boots. Otherwise, fastboot format is used which will create a new filesystem on the device.

Expected to be used when device is already in fastboot mode.

Parameters
`partition`	`String` : the partition to wipe

Returns
`CommandResult`	the CommandResult containing output of command

Throws
`DeviceNotAvailableException`

getActiveApexes

public  getActiveApexes ()

Fetch the information about APEXes activated on the device.

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

Throws
`DeviceNotAvailableException`

getAllSettings

public  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
`DeviceNotAvailableException`

getAllocationState

public DeviceAllocationState getAllocationState ()

Return the current allocation state of device

Returns
`DeviceAllocationState`

getAndroidId

public String getAndroidId (int userId)

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

Parameters
`userId`	`int`

Returns
`String`

Throws
`DeviceNotAvailableException`

getAndroidIds

public  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
`DeviceNotAvailableException`

getApiLevel

public int getApiLevel ()

Get the device API Level. Defaults to UNKNOWN_API_LEVEL .

Returns
`int`	an integer indicating the API Level of device

Throws
`DeviceNotAvailableException`

getAppPackageInfo

public 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
`DeviceNotAvailableException`

getAppPackageInfos

public  getAppPackageInfos ()

Fetch information of packages installed on the device.

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

Throws
`DeviceNotAvailableException`

getBasebandVersion

public String getBasebandVersion ()

Convenience method to get baseband (radio) version of this device. Getting the radio version is device specific, so it might not return the correct information for all devices. This method relies on the gsm.version.baseband propery to return the correct version information. This is not accurate for some CDMA devices and the version returned here might not match the version reported from fastboot and might not return the version for the CDMA radio. TL;DR this method only reports accurate version if the gsm.version.baseband property is the same as the version returned by fastboot getvar version-baseband .

Returns
`String`	the `String` baseband version or `null` if it cannot be determined (device has no radio or version string cannot be read)

Throws
`DeviceNotAvailableException`

getBattery

public Integer getBattery ()

Returns the current battery level of a device or Null if battery level unavailable.

Returns
`Integer`

getBooleanProperty

public boolean getBooleanProperty (String name, 
                boolean defaultValue)

Returns boolean value of the given property.

Parameters
`name`	`String` : the property name
`defaultValue`	`boolean` : default value to return if property is empty or doesn't exist.

Returns
`boolean`	`true` if the property has value `"1"` , `"y"` , `"yes"` , `"on"` , or `"true"` , `false` if the property has value of `"0"` , `"n"` , `"no"` , `"off"` , `"false"` , or `defaultValue` otherwise.

Throws
`DeviceNotAvailableException`

getBootHistory

public  getBootHistory ()

Helper method collects the boot history map with boot time and boot reason.

Returns
	Map of boot time (UTC time in second since Epoch) and boot reason

Throws
`DeviceNotAvailableException`

getBootHistorySince

public  getBootHistorySince (long utcEpochTime, 
                TimeUnit timeUnit)

Helper method collects the boot history map with boot time and boot reason since the given time since epoch from device and the time unit specified. The current device utcEpochTime in Millisecond can be obtained by method getDeviceDate() .

Parameters
`utcEpochTime`	`long` : the device time since Epoch.
`timeUnit`	`TimeUnit` : the time unit `TimeUnit` .

Returns
	Map of boot time (UTC time in second since Epoch) and boot reason

Throws
`DeviceNotAvailableException`

getBootloaderVersion

public String getBootloaderVersion ()

Convenience method to get the bootloader version of this device.

Will attempt to retrieve bootloader version from the device's current state. (ie if device is in fastboot mode, it will attempt to retrieve version from fastboot)

Returns
`String`	the `String` bootloader version or `null` if it cannot be found

Throws
`DeviceNotAvailableException`

getBugreport

public 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 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.

getBuildAlias

public String getBuildAlias ()

Retrieve the alias of the build that the device is currently running.

Build alias is usually a more readable string than build id (typically a number for Nexus builds). For example, final Android 4.2 release has build alias JDQ39, and build id 573038

Returns
`String`	the build alias or fall back to build id if it could not be retrieved

Throws
`DeviceNotAvailableException`

getBuildFlavor

public String getBuildFlavor ()

Retrieve the build flavor for the device.

Returns
`String`	the build flavor or null if it could not be retrieved

Throws
`DeviceNotAvailableException`

getBuildId

public String getBuildId ()

Retrieve the build the device is currently running.

Returns
`String`	the build id or `IBuildInfo#UNKNOWN_BUILD_ID` if it could not be retrieved

Throws
`DeviceNotAvailableException`

getBuildSigningKeys

public String getBuildSigningKeys ()

Returns the key type used to sign the device image

Typically Android devices may be signed with test-keys (like in AOSP) or release-keys (controlled by individual device manufacturers)

Returns
`String`	The signing key if found, null otherwise.

Throws
`DeviceNotAvailableException`

getCachedDeviceDescriptor

public DeviceDescriptor getCachedDeviceDescriptor ()

Returns a cached DeviceDescriptor if the device is allocated, otherwise returns the current DeviceDescriptor .

Returns
`DeviceDescriptor`

getCachedDeviceDescriptor

public DeviceDescriptor getCachedDeviceDescriptor (boolean shortDescriptor)

Returns a cached DeviceDescriptor if the device is allocated, otherwise returns the current DeviceDescriptor .

Parameters
`shortDescriptor`	`boolean` : Whether or not to limit descriptor to bare minimum info

Returns
`DeviceDescriptor`

getChildren

public String[] getChildren (String path)

Alternative to using IFileEntry that sometimes won't work because of permissions.

Parameters
`path`	`String` : is the path on the device where to do the search

Returns
`String[]`	Array of string containing all the file in a path on the device.

Throws
`DeviceNotAvailableException`

getConnection

public AbstractConnection getConnection ()

The current connection associated with the device.

Returns
`AbstractConnection`

getCurrentFoldableState

public DeviceFoldableState getCurrentFoldableState ()

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

Returns
`DeviceFoldableState`

Throws
`DeviceNotAvailableException`

getCurrentUser

public int getCurrentUser ()

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

Returns
`int`

Throws
`DeviceNotAvailableException`

getDeviceClass

public String getDeviceClass ()

Get the device class.

Returns
`String`	the `String` device class.

getDeviceDate

public long getDeviceDate ()

Return the date of the device in millisecond since epoch.

Returns
`long`	the date of the device in epoch format.

Throws
`DeviceNotAvailableException`

getDeviceDescriptor

public DeviceDescriptor getDeviceDescriptor ()

Return a DeviceDescriptor from the device information to get info on it without passing the actual device object.

Returns
`DeviceDescriptor`

getDeviceDescriptor

public DeviceDescriptor getDeviceDescriptor (boolean shortDescriptor)

Return a DeviceDescriptor from the device information to get info on it without passing the actual device object.

Parameters
`shortDescriptor`	`boolean` : Whether or not to limit descriptor to bare minimum info

Returns
`DeviceDescriptor`

getDeviceState

public TestDeviceState getDeviceState ()

Get the device's state.

Returns
`TestDeviceState`

getDeviceTimeOffset

public long getDeviceTimeOffset (Date date)

Helper to get the time difference between the device and a given ERROR(/Date) . Use Epoch time internally.

Parameters
`date`	`Date`

Returns
`long`	the difference in milliseconds

Throws
`DeviceNotAvailableException`

getEmulatorOutput

public InputStreamSource getEmulatorOutput ()

Get the stream of emulator stdout and stderr

Returns
`InputStreamSource`	emulator output

getEmulatorProcess

public Process getEmulatorProcess ()

Return the Process corresponding to this emulator.

Returns
`Process`	the `Process` or `null`

getExecuteShellCommandLog

public final File getExecuteShellCommandLog ()

The log that contains all the executeShellCommand(String) logs.

Returns
`File`

getExternalStoreFreeSpace

public long getExternalStoreFreeSpace ()

Helper method to determine amount of free space on device external storage.

Returns
`long`	the amount of free space in KB

Throws
`DeviceNotAvailableException`

getFastbootPath

public String getFastbootPath ()

Returns the path of the fastboot binary being used. Still requires isFastbootEnabled() to be true, to have fastboot functions enabled.

Returns
`String`

getFastbootProductType

public String getFastbootProductType ()

Convenience method to get the product type of this device when its in fastboot mode.

This method should only be used if device should be in fastboot. Its a bit safer variant than the generic getProductType() method in this case, because ITestDevice will know to recover device into fastboot if device is in incorrect state or is unresponsive.

Returns
`String`	the `String` product type name or `null` if it cannot be determined

Throws
`DeviceNotAvailableException`

getFastbootProductVariant

public String getFastbootProductVariant ()

Convenience method to get the product type of this device when its in fastboot mode.

Returns
`String`	the `String` product type name or `null` if it cannot be determined

Throws
`DeviceNotAvailableException`

getFastbootSerialNumber

public String getFastbootSerialNumber ()

Returns the fastboot mode serial number.

Returns
`String`

getFastbootVariable

public String getFastbootVariable (String variableName)

Retrieve the given fastboot variable value from the device.

Parameters
`variableName`	`String` : the variable name

Returns
`String`	the property value or `null` if it does not exist

Throws
`DeviceNotAvailableException`

getFastbootVersion

public String getFastbootVersion ()

Returns the version string of the fastboot binary being used. Or null if something goes wrong.

Returns
`String`

getFileEntry

public IFileEntry getFileEntry (String path)

Retrieve a reference to a remote file on device.

Parameters
`path`	`String` : the file path to retrieve. Can be an absolute path or path relative to '/'. (ie both "/system" and "system" syntax is supported)

Returns
`IFileEntry`	the `IFileEntry` or `null` if file at given `path` cannot be found

Throws
`DeviceNotAvailableException`

getFileEntry

public IFileEntry getFileEntry (FileListingService.FileEntry entry)

Unofficial helper to get a FileEntry from a non-root path. FIXME: Refactor the FileEntry system to have it available from any path. (even non root).

Parameters
`entry`	`FileListingService.FileEntry` : a `FileEntry` not necessarily root as Ddmlib requires.

Returns
`IFileEntry`	a FileEntryWrapper representing the FileEntry.

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

getFoldableStates

public  getFoldableStates ()

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

Returns

Throws
`DeviceNotAvailableException`

getIDevice

public IDevice getIDevice ()

Returns a reference to the associated ddmlib IDevice .

A new IDevice may be allocated by DDMS each time the device disconnects and reconnects from adb. Thus callers should not keep a reference to the IDevice , because that reference may become stale.

Returns
`IDevice`	the `IDevice`

getInstalledPackageNames

public  getInstalledPackageNames ()

Fetch the application package names present on the device.

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

Throws
`DeviceNotAvailableException`

getIntProperty

public long getIntProperty (String name, 
                long defaultValue)

Returns integer value of the given property from the device.

Parameters
`name`	`String` : the property name
`defaultValue`	`long` : default value to return if property is empty or doesn't exist.

Returns
`long`	the property value or `defaultValue` if the property is empty, doesn't exist, or doesn't have an integer value.

Throws
`DeviceNotAvailableException`

getIpAddress

public 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`

getKeyguardState

public 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`

getLastExpectedRebootTimeMillis

public long getLastExpectedRebootTimeMillis ()

Returns the last time Tradefed APIs triggered a reboot in milliseconds since EPOCH as returned by System.currentTimeMillis() .

Returns
`long`

getLaunchApiLevel

public int getLaunchApiLevel ()

Get the device's first launched API Level. Defaults to UNKNOWN_API_LEVEL .

Returns
`int`	an integer indicating the first launched API Level of device

Throws
`DeviceNotAvailableException`

getLogcat

public InputStreamSource getLogcat ()

Grabs a snapshot stream of the logcat data.

Works in two modes:

If the logcat is currently being captured in the background, will return up to TestDeviceOptions.getMaxLogcatDataSize() bytes of the current contents of the background logcat capture

Otherwise, will return a static dump of the logcat data if device is currently responding

Returns
`InputStreamSource`

getLogcat

public InputStreamSource getLogcat (int maxBytes)

Grabs a snapshot stream of the last maxBytes of captured logcat data.

Useful for cases when you want to capture frequent snapshots of the captured logcat data without incurring the potentially big disk space penalty of getting the entire getLogcat() snapshot.

Parameters
`maxBytes`	`int` : the maximum amount of data to return. Should be an amount that can comfortably fit in memory

Returns
`InputStreamSource`

getLogcatDump

public InputStreamSource getLogcatDump ()

Get a dump of the current logcat for device. Unlike getLogcat() , this method will always return a static dump of the logcat.

Has the disadvantage that nothing will be returned if device is not reachable.

Returns
`InputStreamSource`	a `InputStreamSource` of the logcat data. An empty stream is returned if fail to capture logcat data.

getLogcatSince

public InputStreamSource getLogcatSince (long date)

Grabs a snapshot stream of captured logcat data starting the date provided. The time on the device should be used getDeviceDate() .

Parameters
`date`	`long` : in millisecond since epoch format of when to start the snapshot until present. (can be be obtained using 'date +%s')

Returns
`InputStreamSource`

getMacAddress

public String getMacAddress ()

Returns the MAC address of the device, null if it fails to query from the device.

Returns
`String`

getMainUserId

public 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
`DeviceNotAvailableException`

getMainlineModuleInfo

public  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
`DeviceNotAvailableException`

getMaxNumberOfRunningUsersSupported

public 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
`DeviceNotAvailableException`

getMaxNumberOfUsersSupported

public int getMaxNumberOfUsersSupported ()

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

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

Throws
`DeviceNotAvailableException`

getMicrodroidProcess

public Process getMicrodroidProcess ()

Returns
`Process`	Returns the Process of the Microdroid VM. If TestDevice is not a Microdroid, returns null.

getMonitor

public IDeviceStateMonitor getMonitor ()

Return the IDeviceStateMonitor associated with device.

Returns
`IDeviceStateMonitor`

getMountPoint

public String getMountPoint (String mountName)

Returns a mount point.

Queries the device directly if the cached info in IDevice is not available.

TODO: move this behavior to IDevice#getMountPoint(String)

Parameters
`mountName`	`String` : the name of the mount point

Returns
`String`	the mount point or `null`

getMountPointInfo

public ITestDevice.MountPointInfo getMountPointInfo (String mountpoint)

Returns a MountPointInfo corresponding to the specified mountpoint path, or null if that path has nothing mounted or otherwise does not appear in /proc/mounts as a mountpoint.

Parameters
`mountpoint`	`String`

Returns
`ITestDevice.MountPointInfo`	A `ERROR(/List)` of `MountPointInfo` containing the information in "/proc/mounts"

Throws
`DeviceNotAvailableException`

getMountPointInfo

public  getMountPointInfo ()

Returns a parsed version of the information in /proc/mounts on the device

Returns
	A `ERROR(/List)` of `MountPointInfo` containing the information in "/proc/mounts"

Throws
`DeviceNotAvailableException`

getOptions

public TestDeviceOptions getOptions ()

Fetch the test options for the device.

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

getPartitionFreeSpace

public long getPartitionFreeSpace (String partition)

Helper method to determine amount of free space on device partition.

Parameters
`partition`	`String`

Returns
`long`	the amount of free space in KB

Throws
`DeviceNotAvailableException`

getPrimaryUserId

public Integer getPrimaryUserId ()

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
`DeviceNotAvailableException`

getProcessByName

public ProcessInfo getProcessByName (String processName)

Helper method runs the "pidof" and "stat" command and returns ProcessInfo object with PID and process start time of the given process.

Parameters
`processName`	`String` : the proces name String.

Returns
`ProcessInfo`	ProcessInfo of given processName

Throws
`DeviceNotAvailableException`

getProcessPid

public String getProcessPid (String process)

Returns the pid of the service or null if something went wrong.

Parameters
`process`	`String` : The proces name String.

Returns
`String`

Throws
`DeviceNotAvailableException`

getProductType

public String getProductType ()

Convenience method to get the product type of this device.

This method will work if device is in either adb or fastboot mode.

Returns
`String`	the `String` product type name. Will not be null

Throws
`DeviceNotAvailableException`

getProductVariant

public String getProductVariant ()

Convenience method to get the product variant of this device.

This method will work if device is in either adb or fastboot mode.

Returns
`String`	the `String` product variant name or `null` if it cannot be determined

Throws
`DeviceNotAvailableException`

getProperty

public String getProperty (String name)

Retrieve the given property value from the device.

Parameters
`name`	`String` : the property name

Returns
`String`	the property value or `null` if it does not exist

Throws
`DeviceNotAvailableException`

getRecoveryMode

public ITestDevice.RecoveryMode getRecoveryMode ()

Get the current recovery mode used for the device.

Returns
`ITestDevice.RecoveryMode`	the current recovery mode used for the device.

getScreenshot

public 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
`DeviceNotAvailableException`

getScreenshot

public 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
`DeviceNotAvailableException`

getScreenshot

public 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
`DeviceNotAvailableException`

getScreenshot

public 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
`DeviceNotAvailableException`

getSerialNumber

public String getSerialNumber ()

Convenience method to get serial number of this device.

Returns
`String`	the `String` serial number

getSetting

public 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
`DeviceNotAvailableException`

getSetting

public String getSetting (String namespace, 
                String key)

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

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

Returns
`String`

Throws
`DeviceNotAvailableException`

getSimOperator

public String getSimOperator ()

Return the SIM card operator or null if not available or if device is not available.

Returns
`String`

getSimState

public String getSimState ()

Return the SIM card state or null if not available or device is not available.

Returns
`String`

getTombstones

public  getTombstones ()

Fetch and return the list of tombstones from the devices. Requires root.

method is best-effort so if one tombstone fails to be pulled for any reason it will be missing from the list. Only a DeviceNotAvailableException will terminate the method early.

Returns
	A list of tombstone files, empty if no tombstone.

Throws
`DeviceNotAvailableException`

getTotalMemory

public long getTotalMemory ()

Returns total physical memory size in bytes or -1 in case of internal error

Returns
`long`

getUninstallablePackageNames

public  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
`DeviceNotAvailableException`

getUseFastbootErase

public boolean getUseFastbootErase ()

Get whether to use fastboot erase or fastboot format to wipe a partition on the device.

Returns
`boolean`	`true` if fastboot erase will be used or `false` if fastboot format will be used.

getUserFlags

public 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
`DeviceNotAvailableException`

getUserInfos

public  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
`DeviceNotAvailableException`

getUserSerialNumber

public 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
`DeviceNotAvailableException`

handleAllocationEvent

public IManagedTestDevice.DeviceEventResponse handleAllocationEvent (DeviceEvent event)

Process the given DeviceEvent. May transition device to new state. Will inform the IDeviceMonitor of any state transitions.

Process the DeviceEvent, which may or may not transition this device to a new allocation state.

Parameters
`event`	`DeviceEvent`

Returns
`IManagedTestDevice.DeviceEventResponse`

hasFeature

public 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
`DeviceNotAvailableException`

installPackage

public 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`

installPackage

public 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`

installPackageForUser

public 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`

installPackageForUser

public 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`

invalidatePropertyCache

public void invalidatePropertyCache ()

isAdbRoot

public boolean isAdbRoot ()

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isAdbTcp

public boolean isAdbTcp ()

Returns
`boolean`

isAppEnumerationSupported

public boolean isAppEnumerationSupported ()

Check whether platform on device supports app enumeration

Returns
`boolean`	True if app enumeration is supported, false otherwise

Throws
`DeviceNotAvailableException`

isBypassLowTargetSdkBlockSupported

public boolean isBypassLowTargetSdkBlockSupported ()

Check whether platform on device supports bypassing low target sdk block on app installs

Returns
`boolean`	True if bypass low target sdk block is supported, false otherwise

Throws
`DeviceNotAvailableException`

isDeviceEncrypted

public boolean isDeviceEncrypted ()

Returns if the device is encrypted.

Returns
`boolean`	`true` if the device is encrypted.

Throws
`DeviceNotAvailableException`

isDirectory

public boolean isDirectory (String path)

Return True if the path on the device is a directory, false otherwise.

Parameters
`path`	`String`

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isEnableAdbRoot

public boolean isEnableAdbRoot ()

Returns
`boolean`	`true` if adb root should be enabled on device

isEncryptionSupported

public boolean isEncryptionSupported ()

Returns if encryption is supported on the device.

Returns
`boolean`	`true` if the device supports encryption.

Throws
`DeviceNotAvailableException`

isExecutable

public boolean isExecutable (String fullPath)

Returns True if the file path on the device is an executable file, false otherwise.

Parameters
`fullPath`	`String`

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isFastbootEnabled

public boolean isFastbootEnabled ()

Return if fastboot is available for the device.

Returns
`boolean`

isHeadless

public boolean isHeadless ()

Return true if the device is headless (no screen), false otherwise.

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isHeadlessSystemUserMode

public boolean isHeadlessSystemUserMode ()

Returns whether the device uses headless system user mode.

Returns
`boolean`

Throws
`DeviceNotAvailableException`

isMainUserPermanentAdmin

public 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 boolean isMultiUserSupported ()

Determines if multi user is supported.

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

Throws
`DeviceNotAvailableException`

isPackageInstalled

public 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
`DeviceNotAvailableException`

isPackageInstalled

public 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
`DeviceNotAvailableException`

isRuntimePermissionSupported

public boolean isRuntimePermissionSupported ()

Check whether platform on device supports runtime permission granting

Returns
`boolean`	True if runtime permission are supported, false otherwise.

Throws
`DeviceNotAvailableException`

isStateBootloaderOrFastbootd

public boolean isStateBootloaderOrFastbootd ()

Returns true if device is in TestDeviceState#FASTBOOT or TestDeviceState.FASTBOOTD .

Returns
`boolean`

isUserRunning

public 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
`DeviceNotAvailableException`

isUserSecondary

public 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
`DeviceNotAvailableException`

isUserVisible

public 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 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 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 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 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, eg mobile data tests.

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

Throws
`DeviceNotAvailableException`

listDisplayIds

public  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
`DeviceNotAvailableException`

listDisplayIdsForStartingVisibleBackgroundUsers

public  listDisplayIdsForStartingVisibleBackgroundUsers ()

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

Returns

Throws
`DeviceNotAvailableException`

listUsers

public  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
`DeviceNotAvailableException`

logAnrs

public boolean logAnrs (ITestLogger logger)

Collects and log ANRs from the device.

Parameters
`logger`	`ITestLogger` : an `ITestLogger` to log the ANRs.

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

Throws
`DeviceNotAvailableException`

logBugreport

public 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.

logOnDevice

public void logOnDevice (String tag, 
                Log.LogLevel level, 
                String format, 
                Object... args)

Log a message in the logcat of the device. This is a safe call that will not throw even if the logging fails.

Parameters
`tag`	`String` : The tag under which we log our message in the logcat.
`level`	`Log.LogLevel` : The debug level of the message in the logcat.
`format`	`String` : The message format.
`args`	`Object` : the args to be replaced via String.format().

nonBlockingReboot

public void nonBlockingReboot ()

Issues a command to reboot device and returns on command complete and when device is no longer visible to adb.

Throws
`DeviceNotAvailableException`

postAdbRootAction

public void postAdbRootAction ()

Override if the device needs some specific actions to be taken after adb root and before the device is back online. Default implementation doesn't include any addition actions. adb root is not guaranteed to be enabled at this stage.

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

postAdbUnrootAction

public void postAdbUnrootAction ()

Override if the device needs some specific actions to be taken after adb unroot and before the device is back online. Default implementation doesn't include any additional actions. adb root is not guaranteed to be disabled at this stage.

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

postBootSetup

public void postBootSetup ()

Perform instructions to configure device for testing that after every boot.

Should be called after device is fully booted/available

In normal circumstances this method doesn't need to be called explicitly, as implementations should perform these steps automatically when performing a reboot.

Where it may need to be called is when device reboots due to other events (eg when a fastboot update command has completed)

Throws
`DeviceNotAvailableException`

postInvocationTearDown

public void postInvocationTearDown (Throwable exception)

Extra steps for device specific required clean up that will be executed after the invocation is done.

Parameters
`exception`	`Throwable` : if any, the final exception raised by the invocation failure.

preInvocationSetup

public void preInvocationSetup (IBuildInfo info, 
                MultiMap<String, String> attributes)

Extra steps for device specific required setup that will be executed on the device prior to the invocation flow.

Parameters
`info`	`IBuildInfo` : The `IBuildInfo` of the device.
`attributes`	`MultiMap` : The attributes stored in the invocation context

Throws
`DeviceNotAvailableException`
`TargetSetupError`

pullDir

public boolean pullDir (String deviceFilePath, 
                File localDir)

Recursively pull directory contents from device.

Parameters
`deviceFilePath`	`String` : the absolute file path of the remote source
`localDir`	`File` : the local directory to pull files into

Returns
`boolean`	`true` if file was pulled successfully. `false` otherwise.

Throws
`DeviceNotAvailableException`

pullFile

public boolean pullFile (String remoteFilePath, 
                File localFile)

Retrieves a file off device.

Parameters
`remoteFilePath`	`String` : the absolute path to file on device.
`localFile`	`File` : the local file to store contents in. If non-empty, contents will be replaced.

Returns
`boolean`	`true` if file was retrieved successfully. `false` otherwise.

Throws
`DeviceNotAvailableException`

pullFile

public File pullFile (String remoteFilePath, 
                int userId)

Retrieves a file off device, stores it in a local temporary ERROR(/File) , and returns that File .

Parameters
`remoteFilePath`	`String` : the absolute path to file on device.
`userId`	`int` : The user id to pull from

Returns
`File`	A `ERROR(/File)` containing the contents of the device file, or `null` if the copy failed for any reason (including problems with the host filesystem)

Throws
`DeviceNotAvailableException`

pullFile

public File pullFile (String remoteFilePath)

Retrieves a file off device, stores it in a local temporary ERROR(/File) , and returns that File .

Parameters
`remoteFilePath`	`String` : the absolute path to file on device.

Returns
`File`	A `ERROR(/File)` containing the contents of the device file, or `null` if the copy failed for any reason (including problems with the host filesystem)

Throws
`DeviceNotAvailableException`

pullFile

public boolean pullFile (String remoteFilePath, 
                File localFile, 
                int userId)

Retrieves a file off device.

Parameters
`remoteFilePath`	`String` : the absolute path to file on device.
`localFile`	`File` : the local file to store contents in. If non-empty, contents will be replaced.
`userId`	`int` : The user id to pull from

Returns
`boolean`	`true` if file was retrieved successfully. `false` otherwise.

Throws
`DeviceNotAvailableException`

pullFileContents

public String pullFileContents (String remoteFilePath)

Retrieves a file off device, and returns the contents.

Parameters
`remoteFilePath`	`String` : the absolute path to file on device.

Returns
`String`	A `String` containing the contents of the device file, or `null` if the copy failed for any reason (including problems with the host filesystem)

Throws
`DeviceNotAvailableException`

pullFileFromExternal

public File pullFileFromExternal (String remoteFilePath)

A convenience method to retrieve a file from the device's external storage, stores it in a local temporary ERROR(/File) , and return a reference to that File .

Parameters
`remoteFilePath`	`String` : the path to file on device, relative to the device's external storage mountpoint

Returns
`File`	A `ERROR(/File)` containing the contents of the device file, or `null` if the copy failed for any reason (including problems with the host filesystem)

Throws
`DeviceNotAvailableException`

pushDir

public boolean pushDir (File localFileDir, 
                String deviceFilePath, 
                 excludedDirectories)

Recursively push directory contents to device while excluding some directories that are filtered.

Parameters
`localFileDir`	`File` : the local directory to push
`deviceFilePath`	`String` : the absolute file path of the remote destination
`excludedDirectories`	: Set of excluded directories names that shouldn't be pushed.

Returns
`boolean`	`true` if file was pushed successfully. `false` otherwise.

Throws
`DeviceNotAvailableException`

pushDir

public boolean pushDir (File localFileDir, 
                String deviceFilePath)

Recursively push directory contents to device.

Parameters
`localFileDir`	`File` : the local directory to push
`deviceFilePath`	`String` : the absolute file path of the remote destination

Returns
`boolean`	`true` if file was pushed successfully. `false` otherwise.

Throws
`DeviceNotAvailableException`

pushFile

public boolean pushFile (File localFile, 
                String remoteFilePath, 
                boolean evaluateContentProviderNeeded)

Variant of pushFile(File, String) which can optionally consider evaluating the need for the content provider.

Parameters
`localFile`	`File` : the local file to push
`remoteFilePath`	`String` : the remote destination absolute file path
`evaluateContentProviderNeeded`	`boolean` : whether to check if we need the content provider

Returns
`boolean`	`true` if file was pushed successfully. `false` otherwise.

Throws
`DeviceNotAvailableException`

pushFile

public boolean pushFile (File localFile, 
                String remoteFilePath)

Push a file to device. By default using a content provider.

Parameters
`localFile`	`File` : the local file to push
`remoteFilePath`	`String` : the remote destination absolute file path

Returns
`boolean`	`true` if file was pushed successfully. `false` otherwise.

Throws
`DeviceNotAvailableException`

pushString

public boolean pushString (String contents, 
                String remoteFilePath)

Push file created from a string to device

Parameters
`contents`	`String` : the contents of the file to push
`remoteFilePath`	`String` : the remote destination absolute file path

Returns
`boolean`	`true` if string was pushed successfully. `false` otherwise.

Throws
`DeviceNotAvailableException`

reboot

public void reboot (String reason)

Reboots the device into adb mode with given reason to be persisted across reboot.

Blocks until device becomes available.

Last reboot reason can be obtained by querying sys.boot.reason propety.

Parameters
`reason`	`String` : a reason for this reboot, or `null` if no reason is specified.

Throws
`DeviceNotAvailableException`

reboot

public void reboot ()

Reboots the device into adb mode.

Blocks until device becomes available.

Throws
`DeviceNotAvailableException`

rebootIntoBootloader

public void rebootIntoBootloader ()

Reboots the device into bootloader mode.

Blocks until device is in bootloader mode.

Throws
`DeviceNotAvailableException`

rebootIntoFastbootd

public void rebootIntoFastbootd ()

Reboots the device into fastbootd mode.

Blocks until device is in fastbootd mode.

Throws
`DeviceNotAvailableException`

rebootIntoRecovery

public void rebootIntoRecovery ()

Reboots the device into adb recovery mode.

Blocks until device enters recovery

Throws
`DeviceNotAvailableException`

rebootIntoSideload

public void rebootIntoSideload ()

Reboots the device into adb sideload mode (note that this is a special mode under recovery)

Blocks until device enters sideload mode

Throws
`DeviceNotAvailableException`

rebootIntoSideload

public void rebootIntoSideload (boolean autoReboot)

Reboots the device into adb sideload mode (note that this is a special mode under recovery)

Blocks until device enters sideload mode

Parameters
`autoReboot`	`boolean` : whether to automatically reboot the device after sideload

Throws
`DeviceNotAvailableException`

rebootUntilOnline

public void rebootUntilOnline ()

An alternate to reboot() that only blocks until device is online ie visible to adb.

Throws
`DeviceNotAvailableException`

rebootUntilOnline

public void rebootUntilOnline (String reason)

An alternate to reboot() that only blocks until device is online ie visible to adb.

Parameters
`reason`	`String` : a reason for this reboot, or `null` if no reason is specified.

Throws
`DeviceNotAvailableException`

rebootUserspace

public void rebootUserspace ()

Reboots only userspace part of device.

Blocks until device becomes available.

WARNING. Userspace reboot is currently under active development, use it on your own risk.

Throws
`DeviceNotAvailableException`

rebootUserspaceUntilOnline

public void rebootUserspaceUntilOnline ()

An alternate to rebootUserspace() ()} that only blocks until device is online ie visible to adb.

Throws
`DeviceNotAvailableException`

recoverDevice

public boolean recoverDevice ()

Attempts to recover device communication.

Returns
`boolean`	True if recovery attempted and successful, returns False if recovery was skipped

Throws
`DeviceNotAvailableException`	if device is no longer available

registerDeviceActionReceiver

public void registerDeviceActionReceiver (IDeviceActionReceiver deviceActionReceiver)

Registers a IDeviceActionReceiver for this device.

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

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

remountSystemReadOnly

public void remountSystemReadOnly ()

Make the system partition on the device read-only. May reboot the device.

Throws
`DeviceNotAvailableException`

remountSystemWritable

public void remountSystemWritable ()

Make the system partition on the device writable. May reboot the device.

Throws
`DeviceNotAvailableException`

remountVendorReadOnly

public void remountVendorReadOnly ()

Make the vendor partition on the device read-only. May reboot the device.

Throws
`DeviceNotAvailableException`

remountVendorWritable

public void remountVendorWritable ()

Make the vendor partition on the device writable. May reboot the device.

Throws
`DeviceNotAvailableException`

removeAdmin

public 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
`DeviceNotAvailableException`

removeOwners

public void removeOwners ()

Remove all existing device profile owners with the best effort.

Throws
`DeviceNotAvailableException`

removeUser

public 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
`DeviceNotAvailableException`

resetContentProviderSetup

public void resetContentProviderSetup ()

Reset the flag for content provider setup in order to trigger it again.

runInstrumentationTests

public boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, 
                ITestLifeCycleReceiver... listeners)

Convenience method for performing ERROR(/#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection)) with one or more listeners passed as parameters.

Parameters
`runner`	`IRemoteAndroidTestRunner` : the `IRemoteAndroidTestRunner` which runs the tests
`listeners`	`ITestLifeCycleReceiver` : the test result listener(s)

Returns
`boolean`	`true` if test command completed. `false` if it failed to complete, but recovery succeeded

Throws
`DeviceNotAvailableException`

runInstrumentationTests

public boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, 
                 listeners)

Runs instrumentation tests, and provides device recovery.

If connection with device is lost before test run completes, and recovery succeeds, all listeners will be informed of testRunFailed and "false" will be returned. The test command will not be rerun. It is left to callers to retry if necessary.

If connection with device is lost before test run completes, and recovery fails, all listeners will be informed of testRunFailed and DeviceNotAvailableException will be thrown.

Parameters
`runner`	`IRemoteAndroidTestRunner` : the `IRemoteAndroidTestRunner` which runs the tests
`listeners`	: the test result listeners

Returns
`boolean`	`true` if test command completed. `false` if it failed to complete due to device communication exception, but recovery succeeded

Throws
`DeviceNotAvailableException`

runInstrumentationTestsAsUser

public boolean runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, 
                int userId, 
                 listeners)

Same as ERROR(ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection)/com.android.tradefed.device.ITestDevice#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection) ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection)) but runs the test for the given user.

Parameters
`runner`	`IRemoteAndroidTestRunner`
`userId`	`int`
`listeners`

Returns
`boolean`

Throws
`DeviceNotAvailableException`

runInstrumentationTestsAsUser

public boolean runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, 
                int userId, 
                ITestLifeCycleReceiver... listeners)

Same as ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, ITestLifeCycleReceiver...) but runs the test for a given user.

Parameters
`runner`	`IRemoteAndroidTestRunner`
`userId`	`int`
`listeners`	`ITestLifeCycleReceiver`

Returns
`boolean`

Throws
`DeviceNotAvailableException`

setConfiguration

public void setConfiguration (IConfiguration configuration)

Injects the IConfiguration in use.

Parameters
`configuration`	`IConfiguration`

setConnectionAvdInfo

public final void setConnectionAvdInfo (GceAvdInfo avdInfo)

Parameters
`avdInfo`	`GceAvdInfo`

setDate

public void setDate (Date date)

Sets the date on device

Note: setting date on device requires root

Parameters
`date`	`Date` : specify a particular date; will use host date if `null`

Throws
`DeviceNotAvailableException`

setDeviceOwner

public 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
`DeviceNotAvailableException`

setDeviceState

public void setDeviceState (TestDeviceState deviceState)

Update the device's state.

Parameters
`deviceState`	`TestDeviceState` : the `TestDeviceState`

setEmulatorOutputStream

public void setEmulatorOutputStream (SizeLimitedOutputStream output)

For emulator set SizeLimitedOutputStream to log output

Parameters
`output`	`SizeLimitedOutputStream` : to log the output

setEmulatorProcess

public void setEmulatorProcess (Process p)

Sets the Process , when this device is an emulator.

Parameters
`p`	`Process`

setFastbootEnabled

public void setFastbootEnabled (boolean fastbootEnabled)

Set the fastboot option for the device. Should be set when device is first allocated.

Parameters
`fastbootEnabled`	`boolean` : whether fastboot is available for the device or not

setFastbootPath

public void setFastbootPath (String fastbootPath)

Sets the path to the fastboot binary that should be used. Still requires isFastbootEnabled() to be true, to have fastboot functions enabled.

Parameters
`fastbootPath`	`String`

setIDevice

public void setIDevice (IDevice newDevice)

Update the IDevice associated with this ITestDevice.

The new IDevice must refer the same physical device as the current reference. This method will be called if DDMS has allocated a new IDevice

Parameters
`newDevice`	`IDevice` : the `IDevice`

setLogStartDelay

public void setLogStartDelay (int delay)

Sets the time in ms to wait before starting logcat capture for a online device.

Parameters
`delay`	`int` : the delay in ms

setOptions

public void setOptions (TestDeviceOptions options)

Set the TestDeviceOptions for the device

Parameters
`options`	`TestDeviceOptions`

setProperty

public boolean setProperty (String propKey, 
                String propValue)

Sets the given property value on the device. Requires adb root is true.

Parameters
`propKey`	`String` : The key targeted to be set.
`propValue`	`String` : The property value to be set.

Returns
`boolean`	returns `True` if the setprop command was successful, False otherwise.

Throws
`DeviceNotAvailableException`

setRecovery

public void setRecovery (IDeviceRecovery recovery)

Set the IDeviceRecovery to use for this device. Should be set when device is first allocated.

Parameters
`recovery`	`IDeviceRecovery` : the `IDeviceRecovery`

setRecoveryMode

public void setRecoveryMode (ITestDevice.RecoveryMode mode)

Set the current recovery mode to use for the device.

Used to control what recovery method to use when a device communication problem is encountered. Its recommended to only use this method sparingly when needed (for example, when framework is down, etc

Parameters
`mode`	`ITestDevice.RecoveryMode` : whether 'recover till online only' mode should be on or not.

setSetting

public 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
`DeviceNotAvailableException`

setSetting

public 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
`DeviceNotAvailableException`

setTestLogger

public void setTestLogger (ITestLogger testLogger)

Injects the ITestLogger instance

Parameters
`testLogger`	`ITestLogger`

setUseFastbootErase

public void setUseFastbootErase (boolean useFastbootErase)

Set whether to use fastboot erase or fastboot format to wipe a partition on the device.

Parameters
`useFastbootErase`	`boolean` : `true` if fastboot erase should be used or `false` if fastboot format should be used.

startLogcat

public void startLogcat ()

Start capturing logcat output from device in the background.

Will have no effect if logcat output is already being captured. Data can be later retrieved via getLogcat.

When the device is no longer in use, stopLogcat() must be called.

startLogcat() and stopLogcat() do not normally need to be called when within a TF invocation context, as the TF framework will start and stop logcat.

startUser

public 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
`DeviceNotAvailableException`

startUser

public 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
`DeviceNotAvailableException`

startVisibleBackgroundUser

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

Starts a given user in the background, visible in the given display (ie, 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`

stopEmulatorOutput

public void stopEmulatorOutput ()

Close and delete the emulator output.

stopLogcat

public void stopLogcat ()

Stop capturing logcat output from device, and discard currently saved logcat data.

Will have no effect if logcat output is not being captured.

stopUser

public 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
`DeviceNotAvailableException`

stopUser

public 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
`DeviceNotAvailableException`

switchToAdbTcp

public String switchToAdbTcp ()

Switch device to adb-over-tcp mode.

Returns
`String`	the tcp serial number or `null` if device could not be switched

Throws
`DeviceNotAvailableException`

switchToAdbUsb

public boolean switchToAdbUsb ()

Switch device to adb over usb mode.

Returns
`boolean`	`true` if switch was successful, `false` otherwise.

Throws
`DeviceNotAvailableException`

switchUser

public 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
`DeviceNotAvailableException`

switchUser

public 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
`DeviceNotAvailableException`

syncFiles

public boolean syncFiles (File localFileDir, 
                String deviceFilePath)

Incrementally syncs the contents of a local file directory to device.

Decides which files to push by comparing timestamps of local files with their remote equivalents. Only 'newer' or non-existent files will be pushed to device. Thus overhead should be relatively small if file set on device is already up to date.

Hidden files (with names starting with ".") will be ignored.

Example usage: syncFiles("/tmp/files", "/sdcard") will created a /sdcard/files directory if it doesn't already exist, and recursively push the /tmp/files contents to /sdcard/files.

Parameters
`localFileDir`	`File` : the local file directory containing files to recursively push.
`deviceFilePath`	`String` : the remote destination absolute file path root. All directories in thos file path must be readable. ie pushing to /data/local/tmp when adb is not root will fail

Returns
`boolean`	`true` if files were synced successfully. `false` otherwise.

Throws
`DeviceNotAvailableException`

takeBugreport

public 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 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`

uninstallPackageForUser

public 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`

unlockDevice

public boolean unlockDevice ()

Unlocks the device if the device is in an encrypted state.

This method may restart the framework but will not call postBootSetup() . Therefore, the device might not be fully ready to be tested when this method returns.

Returns
`boolean`	`true` if successful or if the device is unencrypted.

Throws
`DeviceNotAvailableException`

waitForBootComplete

public boolean waitForBootComplete (long timeOut)

Blocks until the device's boot complete flag is set.

Parameters
`timeOut`	`long` : time in msecs to wait for the flag to be set

Returns
`boolean`	true if device's boot complete flag is set within the timeout

Throws
`DeviceNotAvailableException`

waitForDeviceAvailable

public boolean waitForDeviceAvailable ()

Waits for the device to be responsive and available for testing. Uses default timeout.

Returns
`boolean`	True if device is available, False if recovery is disabled and unavailable.

Throws
`DeviceNotAvailableException`

waitForDeviceAvailable

public boolean waitForDeviceAvailable (long waitTime)

Waits for the device to be responsive and available for testing.

Parameters
`waitTime`	`long` : the time in ms to wait

Returns
`boolean`	True if device is available, False if recovery is disabled and unavailable.

Throws
`DeviceNotAvailableException`

waitForDeviceAvailableInRecoverPath

public boolean waitForDeviceAvailableInRecoverPath (long waitTime)

Waits for the device to be responsive and available without considering recovery path.

Parameters
`waitTime`	`long`

Returns
`boolean`	True if device is available, False if unavailable.

Throws
`DeviceNotAvailableException`

waitForDeviceBootloader

public void waitForDeviceBootloader ()

Blocks until device is visible via fastboot. Use default timeout.

Throws
`DeviceNotAvailableException`

waitForDeviceInRecovery

public boolean waitForDeviceInRecovery (long waitTime)

Blocks for the device to be in the 'adb recovery' state (note this is distinct from IDeviceRecovery ).

Parameters
`waitTime`	`long` : the time in ms to wait

Returns
`boolean`	`true` if device boots into recovery before time expires. `false` otherwise

waitForDeviceInSideload

public boolean waitForDeviceInSideload (long waitTime)

Blocks for the device to be in the 'adb sideload' state

Parameters
`waitTime`	`long` : the time in ms to wait

Returns
`boolean`	`true` if device boots into sideload before time expires. `false` otherwise

waitForDeviceNotAvailable

public boolean waitForDeviceNotAvailable (long waitTime)

Blocks for the device to be not available ie missing from adb

Parameters
`waitTime`	`long` : the time in ms to wait

Returns
`boolean`	`true` if device becomes not available before time expires. `false` otherwise

waitForDeviceOnline

public void waitForDeviceOnline ()

Blocks until device is visible via adb. Uses default timeout

Note the device may not necessarily be responsive to commands on completion. Use waitForDeviceAvailable() instead.

Throws
`DeviceNotAvailableException`

waitForDeviceOnline

public void waitForDeviceOnline (long waitTime)

Blocks until device is visible via adb.

Note the device may not necessarily be responsive to commands on completion. Use waitForDeviceAvailable() instead.

Parameters
`waitTime`	`long` : the time in ms to wait

Throws
`DeviceNotAvailableException`

waitForDeviceShell

public boolean waitForDeviceShell (long waitTime)

Waits for device to be responsive to a basic adb shell command.

Parameters
`waitTime`	`long` : the time in ms to wait

Returns
`boolean`	`true` if device becomes responsive before `waitTime` elapses.

Protected methods

addExtraConnectionBuilderArgs

protected void addExtraConnectionBuilderArgs (DefaultConnection.ConnectionBuilder builder)

Parameters
`builder`	`DefaultConnection.ConnectionBuilder`

buildAdbShellCommand

protected String[] buildAdbShellCommand (String command, 
                boolean forceExitStatusDetection)

Builds the OS command for the given adb shell command session and args

Parameters
`command`	`String`
`forceExitStatusDetection`	`boolean`

Returns
`String[]`

checkApiLevelAgainst

protected void checkApiLevelAgainst (String feature, 
                int strictMinLevel)

Parameters
`feature`	`String`
`strictMinLevel`	`int`

createRebootDeviceAction

protected NativeDevice.RebootDeviceAction createRebootDeviceAction (NativeDevice.RebootMode rebootMode, 
                String reason)

Create a RebootDeviceAction to be used when performing a reboot action.

Parameters
`rebootMode`	`NativeDevice.RebootMode` : a mode of this reboot.
`reason`	`String` : for this reboot.

Returns
`NativeDevice.RebootDeviceAction`	the created `RebootDeviceAction` .

createRunUtil

protected IRunUtil createRunUtil ()

Returns
`IRunUtil`

doAdbReboot

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

Perform a adb reboot.

Parameters
`rebootMode`	`NativeDevice.RebootMode` : a mode of this reboot.
`reason`	`String` : for this reboot.

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

ensureRuntimePermissionSupported

protected void ensureRuntimePermissionSupported ()

helper method to throw exception if runtime permission isn't supported

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

getApiLevelSafe

protected int getApiLevelSafe ()

Returns
`int`

getLogger

protected ITestLogger getLogger ()

Returns
`ITestLogger`

getRunUtil

protected IRunUtil getRunUtil ()

Get the RunUtil instance to use.

Returns
`IRunUtil`

initializeConnection

protected void initializeConnection (IBuildInfo info, 
                MultiMap<String, String> attributes)

Parameters
`info`	`IBuildInfo`
`attributes`	`MultiMap`

Throws
`DeviceNotAvailableException`
`TargetSetupError`

internalGetProperty

protected String internalGetProperty (String propName, 
                String fastbootVar, 
                String description)

Fetch a device property, from the ddmlib cache by default, and falling back to either `adb shell getprop` or `fastboot getvar` depending on whether the device is in Fastboot or not.

Parameters
`propName`	`String` : The name of the device property as returned by `adb shell getprop`
`fastbootVar`	`String` : The name of the equivalent fastboot variable to query. if `null` , fastboot query will not be attempted
`description`	`String` : A simple description of the variable. First letter should be capitalized.

Returns
`String`	A string, possibly `null` or empty, containing the value of the given property

Throws
`DeviceNotAvailableException`

isInRebootCallback

protected boolean isInRebootCallback ()

Returns whether reboot callbacks is currently being executed or not. All public api's for reboot should be disabled if true.

Returns
`boolean`

isNewer

protected boolean isNewer (File localFile, 
                IFileEntry entry)

Return true if local file is newer than remote file. IFileEntry being accurate to the minute, in case of equal times, the file will be considered newer.

Parameters
`localFile`	`File`
`entry`	`IFileEntry`

Returns
`boolean`

notifyRebootEnded

protected void notifyRebootEnded ()

Notifies all IDeviceActionReceiver about reboot end event.

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

notifyRebootStarted

protected void notifyRebootStarted ()

Notifies all IDeviceActionReceiver about reboot start event.

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

performDeviceAction

protected boolean performDeviceAction (String actionDescription, 
                NativeDevice.DeviceAction action, 
                int retryAttempts)

Performs an action on this device. Attempts to recover device and optionally retry command if action fails.

Parameters
`actionDescription`	`String` : a short description of action to be performed. Used for logging purposes only.
`action`	`NativeDevice.DeviceAction` : the action to be performed
`retryAttempts`	`int` : the retry attempts to make for action if it fails but recovery succeeds

Returns
`boolean`	`true` if action was performed successfully

Throws
`DeviceNotAvailableException`	if recovery attempt fails or max attempts done without success

postAdbReboot

protected void postAdbReboot ()

Possible extra actions that can be taken after a reboot.

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

prePostBootSetup

protected void prePostBootSetup ()

Allows each device type (AndroidNativeDevice, TestDevice) to override this method for specific post boot setup.

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

pullFileInternal

protected boolean pullFileInternal (String remoteFilePath, 
                File localFile)

Parameters
`remoteFilePath`	`String`
`localFile`	`File`

Returns
`boolean`

Throws
`DeviceNotAvailableException`

setClock

protected void setClock (Clock clock)

Set the Clock instance to use.

Parameters
`clock`	`Clock`

setMicrodroidProcess

protected void setMicrodroidProcess (Process process)

Marks the TestDevice as microdroid and sets its CID.

Parameters
`process`	`Process` : Process of the Microdroid VM.

setTestDeviceOptions

protected void setTestDeviceOptions ( deviceOptions)

Parameters
`deviceOptions`

simpleFastbootCommand

protected CommandResult simpleFastbootCommand (long timeout, 
                 envVarMap, 
                String[] fullCmd)

Executes a simple fastboot command with environment variables and report the status of the command.

Parameters
`timeout`	`long`
`envVarMap`
`fullCmd`	`String`

Returns
`CommandResult`

simpleFastbootCommand

protected CommandResult simpleFastbootCommand (long timeout, 
                String[] fullCmd)

Executes a simple fastboot command and report the status of the command.

Parameters
`timeout`	`long`
`fullCmd`	`String`

Returns
`CommandResult`

waitForDeviceNotAvailable

protected boolean waitForDeviceNotAvailable (String operationDesc, 
                long time)

Wait to see the device going unavailable (stop reporting to adb).

Parameters
`operationDesc`	`String` : The name of the operation that is waiting for unavailable.
`time`	`long` : The time to wait for unavailable to occur.

Returns
`boolean`	True if device did become unavailable.

ネイティブデバイス

まとめ

入れ子になったクラス

定数

田畑

パブリックコンストラクター

パブリックメソッド

保護されたメソッド

定数

INVALID_USER_ID

MAX_HOST_DEVICE_TIME_OFFSET

MAX_RETRY_ATTEMPTS

田畑

SDカード

STORAGE_EMULATED

mオプション

mStateMonitor

パブリックコンストラクター

ネイティブデバイス

パブリックメソッド

バッチPrefetchStartupBuildProps

canSwitchToHeadlessSystemUser

checkApiLevelAgainstNextRelease

接続を確認する

クリアエラーダイアログ

ClearLastConnectedWifiネットワーク

クリアログキャット

Wifiネットワークに接続する

Wifiネットワークに接続する

Wifiネットワークに接続する

Wifiネットワークに接続する

必要に応じて Wifi ネットワークに接続します

必要に応じて Wifi ネットワークに接続します

ユーザーを作成

ユーザーを作成

ユーザーを作成

createUserNoThrow

ファイルを削除する

DeviceActionReceiver の登録を解除する

デバイスソフト再起動

デバイスソフト再起動以来

AdbRootを無効にする

キーガードを無効にする

ネットワークモニターを無効にする

Wifiから切断する

ファイルが存在しますか

ファイルが存在しますか

ダンプヒープ

AdbRoot を有効にする

ネットワークモニターを有効にする

実行Adbコマンド

実行Adbコマンド

実行Adbコマンド

高速起動コマンドの実行

executeFastbootCommand

executeLongFastbootCommand

executeLongFastbootCommand

executeShellCommand

executeShellCommand

executeShellCommand

executeShellCommand

executeShellV2Command

executeShellV2Command

executeShellV2Command

executeShellV2Command

executeShellV2Command

executeShellV2Command

executeShellV2Command

fastbootWipePartition

getActiveApexes

getAllSettings

getAllocationState

getAndroidId

getAndroidIds

getApiLevel

getAppPackageInfo

getAppPackageInfos

getBasebandVersion

getBattery

getBooleanProperty