NativeDevice

public class NativeDevice
extends Object implements IConfigurationReceiver, IManagedTestDevice, ITestLoggerReceiver

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


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 または見つからないユーザー ID に対して返される値: UserHandle は -10000 の値を定義しています

long MAX_HOST_DEVICE_TIME_OFFSET

int MAX_RETRY_ATTEMPTS

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

フィールド

public static final String DEBUGFS_PATH

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()

プロップごとに「adb getprop」を呼び出すのではなく、必要なすべてのプロパティをプリフェッチすることで、マイクロ最適化(約 400 ミリ秒)。

boolean canSwitchToHeadlessSystemUser()

ヘッドレス システム ユーザーに切り替えることが許可されているかどうかを返します。

boolean checkApiLevelAgainstNextRelease(int strictMinLevel)

最低限のサポートレベルに基づき、機能が現在サポートされているかどうかを確認します。

boolean checkConnectivity()

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

boolean clearErrorDialogs()

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

void clearLastConnectedWifiNetwork()

最後に接続した Wi-Fi ネットワークを消去します。

void clearLogcat()

蓄積されている logcat データをすべて削除します。

boolean connectToWifiNetwork( wifiSsidToPsk, boolean scanSsid)

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

boolean connectToWifiNetwork(String wifiSsid, String wifiPsk)

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

boolean connectToWifiNetwork( wifiSsidToPsk)

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

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, int userId)

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

void deleteFile(String deviceFilePath)

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

void deregisterDeviceActionReceiver(IDeviceActionReceiver deviceActionReceiver)

登録済みの IDeviceActionReceiver を削除します。

boolean deviceSoftRestarted(ProcessInfo prevSystemServerProcess)

現在の system_server と以前の system_server ProcessInfo を比較して、デバイスがソフトリブートされたかどうかを確認するヘルパー メソッド。

boolean deviceSoftRestartedSince(long utcEpochTime, TimeUnit timeUnit)

デバイスのエポックからの UTC 時刻とその ERROR(/TimeUnit) 以降にデバイスがソフトリブートされたかどうかを確認するヘルパー メソッド。

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)

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

String executeAdbCommand(String... cmdArgs)

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

CommandResult executeFastbootCommand(String... cmdArgs)

デフォルトのタイムアウトが 2 分間のシステム コマンドとして fastboot コマンドを実行するヘルパー メソッド。

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

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

CommandResult executeLongFastbootCommand(String... cmdArgs)

長時間実行される fastboot コマンドをシステム コマンドとして実行するヘルパー メソッドです。

CommandResult 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 シェルコマンドを実行し、コマンド ステータス出力と stderr が適切に入力された 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)

リクエストされた名前空間の Key-Value ペアを返します。

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()

デバイスに関連付けられている現在の接続。

ContentProviderHandler getContentProvider(int userId)

ContentProviderHandler を返します。利用できない場合は null を返します。

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()

エミュレータの stdout と stderr のストリームを取得します。

Process getEmulatorProcess()

このエミュレータに対応する Process を返します。

final File getExecuteShellCommandLog()

すべての executeShellCommand(String) ログを含むログ。

long getExternalStoreFreeSpace()

デバイスの外部ストレージの空き容量を判断するヘルパー メソッド。

String getFastbootPath()

使用されている fastboot バイナリのパスを返します。

String getFastbootProductType()

Fastboot モードでこのデバイスのプロダクト タイプを取得する便利なメソッドです。

String getFastbootProductVariant()

Fastboot モードでこのデバイスのプロダクト タイプを取得する便利なメソッドです。

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() が返す、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()

デバイスにインストールされている Mainline モジュールに関する情報を取得します。

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(long displayId)

指定されたディスプレイ ID のデバイスからスクリーンショットを取得します。

InputStreamSource getScreenshot(String format)

デバイスのスクリーンショットを取得します。

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 を返します。デバイスが利用できない場合は null を返します。

String getSimState()

SIM カードの状態を返します。利用できない場合は null を返します。デバイスが利用できない場合は null を返します。

getTombstones()

デバイスから墓石のリストを取得して返します。

long getTotalMemory()

物理メモリの合計サイズをバイト単位で返します。内部エラーの場合は -1 を返します。

String getTrackingSerial()

デバイス管理の目的で、デバイスの追跡に使用されるシリアル番号を取得します。

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 isDebugfsMounted()

debugfs がマウントされているかどうかを確認します。

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 mountDebugfs()

debugfs をマウントします。

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, int userId)

デバイスからディレクトリ コンテンツを再帰的に pull します。

boolean pullDir(String deviceFilePath, File localDir)

デバイスからディレクトリ コンテンツを再帰的に pull します。

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)

フィルタリングされた一部のディレクトリを除外しながら、ディレクトリの内容をデバイスに再帰的にプッシュします。

boolean pushDir(File localFileDir, String deviceFilePath)

ディレクトリの内容をデバイスに再帰的に push します。

boolean pushDir(File localFileDir, String deviceFilePath, int userId)

ディレクトリの内容をデバイスに再帰的に push します。

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

pushFile(File, String) のバリエーション。必要に応じて、コンテンツ プロバイダのニーズを評価できます。

boolean pushFile(File localFile, String remoteFilePath)

ファイルをデバイスにプッシュします。

boolean pushFile(File localFile, String remoteFilePath, int userId)

ファイルをデバイスにプッシュします。

boolean pushString(String contents, String remoteFilePath)

文字列から作成されたファイルをデバイスにプッシュする

void reboot(String reason)

指定された reason を使用してデバイスを adb モードに再起動します。この reason は再起動後も保持されます。

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)

インストルメンテーション テストを実行し、デバイスの復元を提供します。

boolean 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)

特定のユーザーの Namespace に設定値を追加します。

void setTestLogger(ITestLogger testLogger)

ITestLogger インスタンスを挿入します。

void setTrackingSerial(String trackingSerial)

デバイス管理の目的で、デバイスの参照に使用するシリアル番号を追跡します。

void setUseFastbootErase(boolean useFastbootErase)

fastboot erase と fastboot format のどちらを使用してデバイスのパーティションをワイプするかを設定します。

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()

デバイスを USB 経由の ADB モードに切り替えます。

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()

デバイスが暗号化されている場合は、デバイスのロックを解除します。

void unmountDebugfs()

debugfs のマウントを解除します。

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 sideload」状態になるのをブロックします

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 を microdroid としてマークし、その CID を設定します。

void setTestDeviceOptions( deviceOptions)
CommandResult 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 または見つからないユーザー 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)

フィールド

DEBUGFS_PATH

public static final String DEBUGFS_PATH

SD_CARD

protected static final String SD_CARD

STORAGE_EMULATED

protected static final String STORAGE_EMULATED

mOptions

protected TestDeviceOptions mOptions

mStateMonitor

protected final IDeviceStateMonitor mStateMonitor

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

NativeDevice

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

TestDevice を作成します。

パラメータ
device IDevice: 関連する IDevice

stateMonitor IDeviceStateMonitor: 使用する IDeviceStateMonitor メカニズム

allocationMonitor IDeviceMonitor: 割り当て状態の変化を通知する IDeviceMonitor。null の場合もあります

パブリック メソッド

batchPrefetchStartupBuildProps

public void batchPrefetchStartupBuildProps ()

各プロパティに対して「adb getprop」を呼び出すのではなく、必要なすべてのプロパティをプリフェッチすることで、マイクロ最適化(約 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

checkConnectivity

public boolean checkConnectivity ()

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

戻り値
boolean true: デバイスがネットワークに接続されている場合。false: それ以外の場合。

例外
DeviceNotAvailableException

clearErrorDialogs

public boolean clearErrorDialogs ()

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

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

例外
DeviceNotAvailableException

ClearLastConnectedWifiNetwork

public void clearLastConnectedWifiNetwork ()

最後に接続した Wi-Fi ネットワークを消去します。デバイスの再起動後に、前回のテストで使用した Wi-Fi ネットワークに接続しないように、新しい呼び出しを開始するときに呼び出す必要があります。

clearLogcat

public void clearLogcat ()

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

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

connectToWifiNetwork

public boolean connectToWifiNetwork ( wifiSsidToPsk, 
                boolean scanSsid)

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

Wi-Fi をオンにして、wifiSsidToPsk マップにある Wi-Fi ネットワークのいずれかに正常に接続されるまでブロックします。接続が確立されると、ITestDevice#disconnectFromWifi() または ITestDevice#clearLastConnectedWifiNetwork() が呼び出されるまで、インスタンスは再起動後に接続を復元しようとします。

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

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

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

例外
DeviceNotAvailableException

connectToWifiNetwork

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 true(Wi-Fi ネットワークに正常に接続された場合)。false それ以外の場合

例外
DeviceNotAvailableException

connectToWifiNetwork

public boolean connectToWifiNetwork ( wifiSsidToPsk)

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

Wi-Fi をオンにして、wifiSsidToPsk マップにある Wi-Fi ネットワークのいずれかに正常に接続されるまでブロックします。接続が確立されると、ITestDevice#disconnectFromWifi() または ITestDevice#clearLastConnectedWifiNetwork() が呼び出されるまで、インスタンスは再起動後に接続を復元しようとします。

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

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

例外
DeviceNotAvailableException

connectToWifiNetwork

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

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

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

パラメータ
wifiSsid String: 接続する Wi-Fi の SSID

wifiPsk String: PSK パスフレーズ。暗号化されていない場合は null

scanSsid boolean: このネットワークの非公開 SSID をスキャンするかどうか。

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

例外
DeviceNotAvailableException

connectToWifiNetworkIfNeeded

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

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

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

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

例外
DeviceNotAvailableException

connectToWifiNetworkIfNeeded

public boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk)

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

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

例外
DeviceNotAvailableException

createUser

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

指定された名前と指定されたフラグを持つユーザーを作成する

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

guest boolean: 作成時にユーザーフラグ --guest を有効にする

ephemeral boolean: 作成時にユーザーフラグ --ephemeral を有効にする

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

例外
DeviceNotAvailableException

createUser

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

createUser

public int createUser (String name)

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

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

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

例外
DeviceNotAvailableException

createUserNoThrow

public int createUserNoThrow (String name)

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

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

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

例外
DeviceNotAvailableException

deleteFile

public void deleteFile (String deviceFilePath, 
                int userId)

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

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

userId int: 削除するユーザー ID

例外
DeviceNotAvailableException

deleteFile

public void deleteFile (String deviceFilePath)

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

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

例外
DeviceNotAvailableException

deregisterDeviceActionReceiver

public void deregisterDeviceActionReceiver (IDeviceActionReceiver deviceActionReceiver)

登録済みの IDeviceActionReceiver を削除します。

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

deviceSoftRestarted

public boolean deviceSoftRestarted (ProcessInfo prevSystemServerProcess)

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

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

戻り値
boolean true: デバイスがソフトリブートした場合

例外
DeviceNotAvailableException

deviceSoftRestarted since

public boolean deviceSoftRestartedSince (long utcEpochTime, 
                TimeUnit timeUnit)

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

パラメータ
utcEpochTime long: エポックからのデバイス時間(秒単位)。

timeUnit TimeUnit: 指定された utcEpochTime の時間単位 TimeUnit

戻り値
boolean true: デバイスがソフトリブートした場合

例外
DeviceNotAvailableException

disableAdbRoot

public boolean disableAdbRoot ()

adb root をオフにします。

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

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

例外
DeviceNotAvailableException

disableKeyguard

public void disableKeyguard ()

キーガードの無効化を試みます。

まず、入力ディスパッチの準備が整うまで待機します。これは、現在のフレームワークの実装で時折競合状態が発生するため、デバイスが BOOT_COMPLETE を報告する頃に非同期で発生します。その後、キーガードを閉じるコマンドが送信されます(安全でないキーガードにのみ機能します)

例外
DeviceNotAvailableException

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

public boolean disableNetworkMonitor ()

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

戻り値
boolean モニタリングが正常に無効になった場合は true。失敗した場合は false

例外
DeviceNotAvailableException

disconnectFromWifi

public boolean disconnectFromWifi ()

Wi-Fi ネットワークから切断される。

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

戻り値
boolean Wi-Fi ネットワークから正常に切断された場合は truefalse (接続解除に失敗した場合)。

例外
DeviceNotAvailableException

doesFileExist

public boolean doesFileExist (String deviceFilePath, 
                int userId)

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

パラメータ
deviceFilePath String: 確認するデバイス上のファイルの絶対パス

userId int: ファイルの存在を確認するユーザー ID

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

例外
DeviceNotAvailableException

doesFileExist

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

enableAdbRoot

public boolean enableAdbRoot ()

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

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

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

例外
DeviceNotAvailableException

enableNetworkMonitor

public boolean enableNetworkMonitor ()

デバイスでネットワーク モニタリングを有効にします。

戻り値
boolean モニタリングが正常に有効になっている場合は truefalse (失敗した場合)。

例外
DeviceNotAvailableException

executeAdbCommand

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

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

executeShellCommand(String) は、障害の検出とパフォーマンスが向上するため、可能な限り代わりに使用する必要があります。

パラメータ
timeout long: デバイスが応答していないと見なされるまでの時間(ミリ秒単位)。タイムアウトがない場合は 0L

cmdArgs String: 実行する adb コマンドと引数

戻り値
String コマンドの stdout。コマンドの実行が失敗した場合は null

例外
DeviceNotAvailableException

executeAdbCommand

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

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

可能な限り、障害の検出とパフォーマンスを向上させるため、executeShellCommand(String) を使用することをおすすめします。

パラメータ
timeout long: デバイスが応答していないと見なされるまでの時間(ミリ秒単位)。タイムアウトなしの場合は 0L

envMap : コマンドに設定する環境

cmdArgs String: 実行する adb コマンドと引数

戻り値
String コマンドの stdout。コマンドの実行が失敗した場合は null

例外
DeviceNotAvailableException

executeAdbCommand

public String executeAdbCommand (String... cmdArgs)

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

executeShellCommand(String) は、障害の検出とパフォーマンスが向上するため、可能な限り代わりに使用する必要があります。

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

戻り値
String コマンドの stdout。コマンドの実行が失敗した場合は null

例外
DeviceNotAvailableException

executeFastbootCommand

public CommandResult executeFastbootCommand (String... cmdArgs)

デフォルトのタイムアウトが 2 分間のシステム コマンドとして fastboot コマンドを実行するヘルパー メソッド。

デバイスがすでに fastboot モードになっている場合に使用されることが想定されています。

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

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException

executeFastbootCommand

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

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

デバイスがすでに fastboot モードになっている場合に使用されることが想定されています。

パラメータ
timeout long: コマンドが期限切れになるまでの時間(ミリ秒単位)

cmdArgs String: 実行する fastboot コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException

executeLongFastbootCommand

public CommandResult executeLongFastbootCommand (String... cmdArgs)

長時間実行される fastboot コマンドをシステム コマンドとして実行するヘルパー メソッド。

executeFastbootCommand(String) と同じですが、タイムアウトが長くなります。

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

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException

executeLongFastbootCommand

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

長時間実行される fastboot コマンドを、システム環境変数を使用してシステム コマンドとして実行するヘルパー メソッド。

executeFastbootCommand(String) と同じですが、タイムアウトが長くなります。

パラメータ
envVarMap : fastboot コマンドが実行されるシステム環境変数

cmdArgs String: 実行する fastboot コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException

executeShellCommand

public String executeShellCommand (String command)

adb シェルコマンドを実行し、出力を String として返すヘルパー メソッド。

パラメータ
command String: 実行する adb シェルコマンド

戻り値
String シェルの出力が

例外
DeviceNotAvailableException

runShellCommand

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

コマンドの動作を制御する追加のパラメータを指定して、adb シェルコマンドを実行します。

パラメータ
command String: 実行する adb シェルコマンド

receiver IShellOutputReceiver: シェルの出力を転送する IShellOutputReceiver

maxTimeToOutputShellResponse long: コマンドが応答を出力しなくてもよい最大時間(timeUnit で指定された単位)。

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因で失敗した場合にコマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合、DeviceNotResponsiveException がスローされます。

例外
DeviceNotAvailableException

runShellCommand

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

コマンドの動作を制御する追加のパラメータを指定して、adb シェルコマンドを実行します。

パラメータ
command String: 実行する adb シェルコマンド

receiver IShellOutputReceiver: シェル出力の転送先の IShellOutputReceiver

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定します。

maxTimeToOutputShellResponse long: コマンドが応答を出力しなくてもよい最大時間(timeUnit で指定された単位)。

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外によりコマンドが失敗した場合に再試行する最大回数。retryAttempts が成功せずに実行された場合は、DeviceNotRespondException がスローされます。

例外
DeviceNotAvailableException

executeShellCommand

public void executeShellCommand (String command, 
                IShellOutputReceiver receiver)

指定された adb シェルコマンドを実行します。コマンドが失敗した場合は再試行が複数回行われます。

デフォルト値を持つ executeShellCommand(String, com.android.ddmlib.IShellOutputReceiver, long, TimeUnit, int) の簡素な形式。

パラメータ
command String: 実行する adb シェルコマンド

receiver IShellOutputReceiver: シェルの出力を転送する IShellOutputReceiver

例外
DeviceNotAvailableException

runShellV2Command

public CommandResult executeShellV2Command (String cmd)

adb シェルコマンドを実行し、コマンド ステータス出力、stdout、stderr が適切に入力された CommandResult として結果を返すヘルパー メソッド。

パラメータ
cmd String: 実行するコマンド。

戻り値
CommandResult 結果は CommandResult になります。

例外
DeviceNotAvailableException

runShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                OutputStream pipeToOutput)

adb シェルコマンドを実行し、コマンド ステータス出力と stderr が適切に入力された CommandResult として結果を返すヘルパー メソッド。stdout は指定されたストリームに転送されます。

パラメータ
cmd String: 実行するコマンド。

pipeToOutput OutputStream: 標準出力がリダイレクトされる ERROR(/OutputStream) または null。

戻り値
CommandResult 結果は CommandResult になります。

例外
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                File pipeAsInput)

adb シェルコマンドを実行し、コマンド ステータス出力、stdout、stderr が適切に入力された CommandResult として結果を返すヘルパー メソッド。

パラメータ
cmd String: 実行するコマンド。

pipeAsInput File: コマンドへの入力としてパイプされる ERROR(/File) または null。

戻り値
CommandResult 結果は CommandResult になります。

例外
DeviceNotAvailableException

runShellV2Command

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

コマンドの動作を制御するための追加のパラメータを使用して、adb シェルコマンドを実行します。

パラメータ
cmd String: 実行する adb シェルコマンド

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定します。

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因で失敗した場合にコマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合、DeviceNotResponsiveException がスローされます。

戻り値
CommandResult

例外
DeviceNotAvailableException

runShellV2Command

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

コマンドの動作を制御するための追加のパラメータを使用して、adb シェルコマンドを実行します。

パラメータ
cmd String: 実行する adb シェルコマンド

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定します。

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

戻り値
CommandResult

例外
DeviceNotAvailableException

runShellV2Command

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

コマンドの動作を制御するための追加のパラメータを使用して、adb シェルコマンドを実行します。

パラメータ
cmd String: 実行する adb シェルコマンド

pipeAsInput File: コマンドへの入力としてパイプされる ERROR(/File) または null。

pipeToOutput OutputStream: 標準出力がリダイレクトされる ERROR(/OutputStream) または null。

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定します。

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因で失敗した場合にコマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合、DeviceNotResponsiveException がスローされます。

戻り値
CommandResult

例外
DeviceNotAvailableException

runShellV2Command

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

コマンドの動作を制御するための追加のパラメータを使用して、adb シェルコマンドを実行します。

パラメータ
cmd String: 実行する adb シェルコマンド

pipeAsInput File: コマンドへの入力としてパイプされる ERROR(/File) または null。

pipeToOutput OutputStream: 標準出力がリダイレクトされる ERROR(/OutputStream) または null。

pipeToError OutputStream: 標準エラーのリダイレクト先の ERROR(/OutputStream)、または null。

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト(timeUnit で指定された単位)

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因で失敗した場合にコマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合、DeviceNotResponsiveException がスローされます。

戻り値
CommandResult

例外
DeviceNotAvailableException

fastbootWipePartition

public CommandResult fastbootWipePartition (String partition)

デバイスのパーティションをワイプするヘルパー メソッド。

getUseFastbootErase()true の場合、fastboot erase を使用してパーティションがワイプされます。次回デバイスが起動したときに、デバイスがファイルシステムを作成する必要があります。それ以外の場合は、fastboot フォーマットが使用され、デバイスに新しいファイルシステムが作成されます。

デバイスがすでに fastboot モードになっている場合に使用されることが想定されています。

パラメータ
partition String: ワイプするパーティション

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException

getActiveApexes

public  getActiveApexes ()

デバイスで有効になっている APEX に関する情報を取得します。

戻り値
デバイスで現在有効になっているプロモーション コード: ERROR(/Set) / ApexInfo

例外
DeviceNotAvailableException

getAllSettings

public  getAllSettings (String namespace)

リクエストされた名前空間の Key-Value ペアを返します。

パラメータ
namespace String: {"system"、"secure"、"global"} のいずれか

戻り値
Key-Value ペアのマップ。Namespace がサポートされていない場合は null。

例外
DeviceNotAvailableException

getAllocationState

public DeviceAllocationState getAllocationState ()

デバイスの現在の割り当て状態を返す

戻り値
DeviceAllocationState

getAndroidId

public String getAndroidId (int userId)

userId に関連付けられている android-id を検索して返します。見つからない場合は null を返します。

パラメータ
userId int

戻り値
String

例外
DeviceNotAvailableException

getAndroidIds

public  getAndroidIds ()

ユーザー ID と一致する Android ID のマップを作成します。この関数に関連付けられた Android ID が各ユーザー ID で見つかる保証がないため、一部のユーザー ID が null と一致する可能性があります。

戻り値
一致するユーザー ID が見つかった Android ID のマップ。

例外
DeviceNotAvailableException

getApiLevel

public int getApiLevel ()

デバイスの API レベルを取得します。デフォルトは UNKNOWN_API_LEVEL です。

戻り値
int デバイスの API レベルを示す整数

例外
DeviceNotAvailableException

getAppPackageInfo

public PackageInfo getAppPackageInfo (String packageName)

デバイスにインストールされているパッケージに関する情報を取得します。

パラメータ
packageName String

戻り値
PackageInfo 情報を取得できなかった場合は PackageInfo または null

例外
DeviceNotAvailableException

getAppPackageInfos

public  getAppPackageInfos ()

デバイスにインストールされているパッケージの情報を取得します。

戻り値
PackageInfoERROR(/List) がこのデバイスにインストールされています。

例外
DeviceNotAvailableException

getBasebandVersion

public String getBasebandVersion ()

このデバイスのベースバンド(無線)バージョンを取得する便利なメソッド。無線バージョンの取得はデバイス固有であるため、すべてのデバイスで正しい情報が返されない場合があります。このメソッドは、gsm.version.baseband プロパティを使用して正しいバージョン情報を返します。これは一部の CDMA デバイスでは正確ではなく、ここで返されるバージョンは fastboot から報告されたバージョンと一致しない可能性があり、CDMA 無線のバージョンが返されない可能性があります。要約すると、このメソッドは、gsm.version.baseband プロパティが fastboot getvar version-baseband によって返されたバージョンと同じである場合にのみ、正確なバージョンを報告します。

戻り値
String String ベースバンド バージョン、または特定できない場合は null(デバイスに無線通信がない場合、またはバージョン文字列を読み取れない場合)

例外
DeviceNotAvailableException

getBattery

public Integer getBattery ()

デバイスの現在のバッテリー残量を返します。バッテリー残量が取得できない場合は null を返します。

戻り値
Integer

getBooleanProperty

public boolean getBooleanProperty (String name, 
                boolean defaultValue)

指定されたプロパティのブール値を返します。

パラメータ
name String: プロパティ名

defaultValue boolean: プロパティが空または存在しない場合に返されるデフォルト値。

戻り値
boolean プロパティの値が "1""y""yes""on""true" の場合は true、プロパティの値が "0""n""no""off""false" の場合は false、それ以外の場合は defaultValue

例外
DeviceNotAvailableException

getBootHistory

public  getBootHistory ()

ヘルパー メソッドは、起動時間と起動理由を含む起動履歴マップを収集します。

戻り値
起動時間(エポックからの経過秒数(UTC))と起動理由のマップ

例外
DeviceNotAvailableException

getBootHistorySince

public  getBootHistorySince (long utcEpochTime, 
                TimeUnit timeUnit)

ヘルパー メソッドは、指定されたエポックからの時刻と指定された時間単位に基づいて、デバイスから起動時間と起動理由を含む起動履歴マップを収集します。現在のデバイスの utcEpochTime(ミリ秒単位)は、メソッド getDeviceDate() で取得できます。

パラメータ
utcEpochTime long: エポックからのデバイス時間。

timeUnit TimeUnit: 時間単位 TimeUnit

戻り値
起動時間(エポックからの経過秒数(UTC))と起動理由のマップ

例外
DeviceNotAvailableException

getBootloaderVersion

public String getBootloaderVersion ()

このデバイスのブートローダーのバージョンを取得する便利なメソッドです。

デバイスの現在の状態からブートローダのバージョンを取得しようとします。(デバイスが Fastboot モードの場合、Fastboot からバージョンの取得を試みます)。

戻り値
String String ブートローダーのバージョン、または見つからない場合は null

例外
DeviceNotAvailableException

getBugreport

public InputStreamSource getBugreport ()

デバイスからバグレポートを取得します。

この実装は、sdcard のないデバイス(または sdcard がまだマウントされていないデバイス)でも引き続き機能することが保証されています。

戻り値
InputStreamSource バグレポートの内容をオンデマンドで生成する InputStreamSource。エラーが発生した場合、InputStreamSource は空の ERROR(/InputStream) を生成します。

getBugreportz

public InputStreamSource getBugreportz ()

デバイスからバグレポートを取得します。ZIP 形式のバグレポートには、メインのバグレポートと、デバッグに役立つその他のログファイルが含まれています。

「adb version」> 1.0.36 の場合にのみサポート

戻り値
InputStreamSource bugreportz を含む ZIP ファイルの InputStreamSource。失敗した場合は null を返します。

getBuildAlias

public String getBuildAlias ()

デバイスで現在実行されているビルドのエイリアスを取得します。

ビルド エイリアスは通常、ビルド ID よりも読みやすい文字列(Nexus ビルドの場合は通常は数字)です。たとえば、Android 4.2 の最終リリースのビルド エイリアスは JDQ39、ビルド ID は 573038 です。

戻り値
String ビルド エイリアス(取得できなかった場合はビルド ID にフォールバック)

例外
DeviceNotAvailableException

getBuildFlavor

public String getBuildFlavor ()

デバイスのビルド フレーバーを取得します。

戻り値
String ビルド フレーバー、または取得できなかった場合は null

例外
DeviceNotAvailableException

getBuildId

public String getBuildId ()

デバイスで現在実行されているビルドを取得します。

戻り値
String ビルド ID、または取得できなかった場合は IBuildInfo#UNKNOWN_BUILD_ID

例外
DeviceNotAvailableException

getBuildSigningKeys

public String getBuildSigningKeys ()

デバイス イメージの署名に使用される鍵の種類を返します。

通常、Android デバイスはテストキー(AOSP など)またはリリースキー(個々のデバイス メーカーが管理)で署名されます。

戻り値
String 署名鍵(見つかった場合)。見つからない場合は null。

例外
DeviceNotAvailableException

getCachedDeviceDescriptor

public DeviceDescriptor getCachedDeviceDescriptor ()

デバイスが割り当てられている場合はキャッシュに保存された DeviceDescriptor を返し、そうでない場合は現在の DeviceDescriptor を返します。

戻り値
DeviceDescriptor

getCachedDeviceDescriptor

public DeviceDescriptor getCachedDeviceDescriptor (boolean shortDescriptor)

デバイスが割り当てられている場合は、キャッシュに保存された DeviceDescriptor を返します。割り当てられていない場合は、現在の DeviceDescriptor を返します。

パラメータ
shortDescriptor boolean: 記述子を最小限の情報に制限するかどうか

戻り値
DeviceDescriptor

getChildren

public String[] getChildren (String path)

権限が原因で機能しないことがある IFileEntry の代替手段。

パラメータ
path String: 検索を行うデバイス上のパス

戻り値
String[] デバイス上のパス内のすべてのファイルを含む文字列の配列。

例外
DeviceNotAvailableException

getConnection

public AbstractConnection getConnection ()

デバイスに関連付けられている現在の接続。

戻り値
AbstractConnection

getContentProvider

public ContentProviderHandler getContentProvider (int userId)

ContentProviderHandler を返します。検出されない場合は null を返します。

コンテンツ プロバイダは、同じ userId で以前に作成されたものであれば再利用できます。

パラメータ
userId int: コンテンツ プロバイダの初期化に使用するユーザー ID。

戻り値
ContentProviderHandler

例外
DeviceNotAvailableException

getCurrentFoldableState

public DeviceFoldableState getCurrentFoldableState ()

デバイスの現在の折りたたみ状態を返します。問題が発生した場合は null を返します。

戻り値
DeviceFoldableState

例外
DeviceNotAvailableException

getCurrentUser

public int getCurrentUser ()

現在実行中のユーザーの ID を返します。エラーの場合は -10000 を返します。

戻り値
int

例外
DeviceNotAvailableException

getDeviceClass

public String getDeviceClass ()

デバイスクラスを取得します。

戻り値
String String デバイス クラス。

getDeviceDate

public long getDeviceDate ()

デバイスの日付をエポックからのミリ秒単位で返します。

戻り値
long デバイスの日付(エポック形式)。

例外
DeviceNotAvailableException

getDeviceDescriptor

public DeviceDescriptor getDeviceDescriptor ()

デバイス情報から DeviceDescriptor を返して、実際のデバイス オブジェクトを渡さずにデバイスに関する情報を取得します。

戻り値
DeviceDescriptor

getDeviceDescriptor

public DeviceDescriptor getDeviceDescriptor (boolean shortDescriptor)

デバイス情報から DeviceDescriptor を返して、実際のデバイス オブジェクトを渡さずにデバイスに関する情報を取得します。

パラメータ
shortDescriptor boolean: 記述子を最小限の情報に制限するかどうか

戻り値
DeviceDescriptor

getDeviceState

public TestDeviceState getDeviceState ()

デバイスの状態を取得します。

戻り値
TestDeviceState

getDeviceTimeOffset

public long getDeviceTimeOffset (Date date)

デバイスと指定された ERROR(/Date) の時差を取得するヘルパー。内部でエポック時間を使用します。

パラメータ
date Date

戻り値
long ミリ秒単位の差

例外
DeviceNotAvailableException

getEmulatorOutput

public InputStreamSource getEmulatorOutput ()

エミュレータの stdout と stderr のストリームを取得する

戻り値
InputStreamSource エミュレータの出力

getEmulatorProcess

public Process getEmulatorProcess ()

このエミュレータに対応する Process を返します。

戻り値
Process Process または null

getExecuteShellCommandLog

public final File getExecuteShellCommandLog ()

すべての executeShellCommand(String) ログを含むログ。

戻り値
File

getExternalStoreFreeSpace

public long getExternalStoreFreeSpace ()

デバイスの外部ストレージの空き容量を判断するヘルパー メソッド。

戻り値
long 空き容量(KB)

例外
DeviceNotAvailableException

getFastbootPath

public String getFastbootPath ()

使用されている fastboot バイナリのパスを返します。fastboot 機能を有効にするには、isFastbootEnabled() を true にする必要があります。

戻り値
String

getFastbootProductType

public String getFastbootProductType ()

デバイスが Fastboot モードのときにデバイスの製品タイプを取得するためのコンビニエンス メソッド。

この方法は、デバイスを Fastboot モードにする必要がある場合にのみ使用してください。この場合、ITestDevice は、デバイスが不適切な状態であるか、応答しない場合に、デバイスを fastboot に復元することを認識するため、汎用の getProductType() メソッドよりも少し安全なバリアントです。

戻り値
String String プロダクト タイプ名(特定できない場合は null

例外
DeviceNotAvailableException

getFastbootProductVariant

public String getFastbootProductVariant ()

Fastboot モードでこのデバイスのプロダクト タイプを取得する便利なメソッドです。

この方法は、デバイスを Fastboot モードにする必要がある場合にのみ使用してください。この場合、ITestDevice はデバイスが正しくない状態であるか、応答しない場合、デバイスを fastboot に復元することを認識するため、汎用の getProductType() メソッドよりも安全なバリエーションです。

戻り値
String String プロダクト タイプ名(特定できない場合は null

例外
DeviceNotAvailableException

getFastbootSerialNumber

public String getFastbootSerialNumber ()

Fastboot モードのシリアル番号を返します。

戻り値
String

getFastbootVariable

public String getFastbootVariable (String variableName)

デバイスから指定された fastboot 変数の値を取得します。

パラメータ
variableName String: 変数名

戻り値
String プロパティ値、または存在しない場合は null

例外
DeviceNotAvailableException

getFastbootVersion

public String getFastbootVersion ()

使用されている fastboot バイナリのバージョン文字列を返します。問題が発生した場合は null です。

戻り値
String

getFileEntry

public IFileEntry getFileEntry (String path)

デバイス上のリモート ファイルへの参照を取得します。

パラメータ
path String: 取得するファイルパス。絶対パス、または「/」に対する相対パスを指定できます(「/system」と「system」の両方の構文がサポートされています)。

戻り値
IFileEntry 指定された path のファイルが見つからない場合は IFileEntry または null

例外
DeviceNotAvailableException

getFileEntry

public IFileEntry getFileEntry (FileListingService.FileEntry entry)

ルート以外のパスから FileEntry を取得する非公式のヘルパー。FIXME: 任意のパスから使用できるように FileEntry システムをリファクタリングします。(root でなくても)。

パラメータ
entry FileListingService.FileEntry: Ddmlib で必要とされる root とは限らない FileEntry

戻り値
IFileEntry FileEntry を表す FileEntryWrapper。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getFoldableStates

public  getFoldableStates ()

デバイスの折りたたみ状態のリストを返します。「cmd device_state print-states」で取得できます。

戻り値

例外
DeviceNotAvailableException

getIDevice

public IDevice getIDevice ()

関連する ddmlib IDevice への参照を返します。

デバイスが adb から切断されて再接続されるたびに、DDMS によって新しい IDevice が割り振られることがあります。そのため、呼び出し元は IDevice への参照を保持しないでください。この参照が古くなる可能性があります。

戻り値
IDevice IDevice

getInstalledPackageNames

public  getInstalledPackageNames ()

デバイスに存在するアプリのパッケージ名を取得します。

戻り値
デバイスに現在インストールされている String パッケージ名の ERROR(/Set)

例外
DeviceNotAvailableException

getIntProperty

public long getIntProperty (String name, 
                long defaultValue)

デバイスから指定されたプロパティの整数値を返します。

パラメータ
name String: プロパティ名

defaultValue long: プロパティが空の場合や存在しない場合に返されるデフォルト値。

戻り値
long プロパティ値。またはプロパティが空、存在しない、または整数値を持たない場合は、defaultValue

例外
DeviceNotAvailableException

getIpAddress

public String getIpAddress ()

デバイスの IP アドレスを取得します。

戻り値
String デバイスの IP アドレス(デバイスに IP アドレスがない場合は null

例外
DeviceNotAvailableException

getKeyguardState

public KeyguardControllerState getKeyguardState ()

キーガードの現在の状態を取得するオブジェクトを返します。サポートされていない場合は null を返します。

戻り値
KeyguardControllerState キーガード状態のスナップショットを含む KeyguardControllerState。キーガード クエリがサポートされていない場合は Null を返します。

例外
DeviceNotAvailableException

getLastExpectedRebootTimeMillis

public long getLastExpectedRebootTimeMillis ()

Tradefed API が最後に再起動をトリガーした時刻(System.currentTimeMillis() によって返されるエポックからのミリ秒単位)を返します。

戻り値
long

getLaunchApiLevel

public int getLaunchApiLevel ()

デバイスが最初にリリースされた API レベルを取得します。デフォルトは UNKNOWN_API_LEVEL です。

戻り値
int デバイスで最初に起動された API レベルを示す整数

例外
DeviceNotAvailableException

getLogcat

public InputStreamSource getLogcat ()

logcat データのスナップショット ストリームを取得します。

次の 2 つのモードで動作します。

  • 現在バックグラウンドで logcat がキャプチャされている場合は、バックグラウンド logcat キャプチャの現在の内容を最大 TestDeviceOptions.getMaxLogcatDataSize() バイト返します。
  • それ以外の場合は、デバイスが現在応答している場合は、logcat データの静的ダンプが返されます。

    戻り値
    InputStreamSource

  • getLogcat

    public InputStreamSource getLogcat (int maxBytes)

    キャプチャされた logcat データの最後の maxBytes のスナップショット ストリームを取得します。

    キャプチャされた logcat データのスナップショットを頻繁にキャプチャする必要がある場合に便利です。getLogcat() スナップショット全体を取得すると、ディスク容量が大幅に消費される可能性があります。

    パラメータ
    maxBytes int: 返されるデータの最大量。メモリに無理なく収まる量

    戻り値
    InputStreamSource

    getLogcatDump

    public InputStreamSource getLogcatDump ()

    デバイスの現在の logcat ダンプを取得します。getLogcat() とは異なり、このメソッドは常に logcat の静的ダンプが返されます。

    デバイスにアクセスできない場合は何も返されないというデメリットがあります。

    戻り値
    InputStreamSource logcat データの InputStreamSource。logcat データのキャプチャに失敗した場合は、空のストリームが返されます。

    getLogcatSince

    public InputStreamSource getLogcatSince (long date)

    指定された日付以降にキャプチャされた logcat データのスナップショット ストリームを取得します。デバイスの時刻は getDeviceDate() にする必要があります。

    パラメータ
    date long: スナップショットの開始時間から現在までのエポックからのミリ秒数。(「date +%s」を使用して取得できます)

    戻り値
    InputStreamSource

    getMacAddress

    public String getMacAddress ()

    デバイスの MAC アドレスを返します。デバイスからのクエリに失敗した場合は null を返します。

    戻り値
    String

    getMainUserId

    public Integer getMainUserId ()

    メインのユーザー ID を返します。

    戻り値
    Integer メインユーザーの userId(メインユーザーが存在する場合)。メインユーザーが存在しない場合、null。

    例外
    DeviceNotAvailableException

    getMainlineModuleInfo

    public  getMainlineModuleInfo ()

    デバイスにインストールされている Mainline モジュールに関する情報を取得します。

    戻り値
    デバイスに現在インストールされている String Mainline モジュールの ERROR(/Set)

    例外
    DeviceNotAvailableException

    getMaxNumberOfRunningUsersSupported

    public int getMaxNumberOfRunningUsersSupported ()

    同時に実行できるユーザーの最大数を取得します。デフォルトは 0 です。

    戻り値
    int 同時に実行しているユーザー数を示す整数

    例外
    DeviceNotAvailableException

    getMaxNumberOfUsersSupported

    public int getMaxNumberOfUsersSupported ()

    サポートされている最大ユーザー数を取得します。デフォルトは 0 です。

    戻り値
    int サポートされているユーザー数を示す整数

    例外
    DeviceNotAvailableException

    getMicrodroidProcess

    public Process getMicrodroidProcess ()

    戻り値
    Process Microdroid VM のプロセスを返します。TestDevice が Microdroid でない場合、null を返します。

    getMonitor

    public IDeviceStateMonitor getMonitor ()

    デバイスに関連付けられている IDeviceStateMonitor を返します。

    戻り値
    IDeviceStateMonitor

    getMountPoint

    public String getMountPoint (String mountName)

    マウント ポイントを返します。

    IDevice のキャッシュに保存された情報が利用できない場合は、デバイスに直接クエリを実行します。

    TODO: この動作を IDevice#getMountPoint(String) に移動

    パラメータ
    mountName String: マウント ポイントの名前

    戻り値
    String マウント ポイントまたは null

    getMountPointInfo

    public ITestDevice.MountPointInfo getMountPointInfo (String mountpoint)

    指定されたマウントポイント パスに対応する MountPointInfo を返します。そのパスにマウントされたものがない場合、または /proc/mounts にマウントポイントとして表示されない場合は null を返します。

    パラメータ
    mountpoint String

    戻り値
    ITestDevice.MountPointInfo 「/proc/mounts」の情報を含む MountPointInfoERROR(/List)

    例外
    DeviceNotAvailableException

    getMountPointInfo

    public  getMountPointInfo ()

    デバイスの /proc/mounts にある情報を解析して返します。

    戻り値
    「/proc/mounts」の情報を含む MountPointInfoERROR(/List)

    例外
    DeviceNotAvailableException

    getOptions

    public TestDeviceOptions getOptions ()

    デバイスのテストオプションを取得します。

    戻り値
    TestDeviceOptions テスト対象デバイスに関連する TestDeviceOptions

    getPartitionFreeSpace

    public long getPartitionFreeSpace (String partition)

    デバイス パーティションの空き容量を判断するヘルパー メソッド。

    パラメータ
    partition String

    戻り値
    long 空き容量(KB)

    例外
    DeviceNotAvailableException

    getPrimaryUserId

    public Integer getPrimaryUserId ()

    プライマリ ユーザー ID を返します。

    戻り値
    Integer メインユーザーの userId(存在する場合)。メインユーザーが存在しない場合、null。

    例外
    DeviceNotAvailableException

    getProcessByName

    public ProcessInfo getProcessByName (String processName)

    ヘルパー メソッドは「pidof」コマンドと「stat」コマンドを実行し、指定されたプロセスの PID とプロセス開始時刻を含む ProcessInfo オブジェクトを返します。

    パラメータ
    processName String: プロセス名の文字列。

    戻り値
    ProcessInfo 指定された processName の ProcessInfo

    例外
    DeviceNotAvailableException

    getProcessPid

    public String getProcessPid (String process)

    サービスの pid を返します。エラーが発生した場合は null を返します。

    パラメータ
    process String: プロセス名の文字列。

    戻り値
    String

    例外
    DeviceNotAvailableException

    getProductType

    public String getProductType ()

    このデバイスの製品タイプを取得するためのコンビニエンス メソッド。

    この方法は、デバイスが adb モードまたは fastboot モードの場合に利用できます。

    戻り値
    String String 商品タイプ名。null にならない

    例外
    DeviceNotAvailableException

    getProductVariant

    public String getProductVariant ()

    このデバイスの商品バリエーションを取得する便利なメソッド。

    この方法は、デバイスが adb モードまたは fastboot モードの場合に機能します。

    戻り値
    String String 商品バリエーション名、または特定できない場合は null

    例外
    DeviceNotAvailableException

    getProperty

    public String getProperty (String name)

    デバイスから指定されたプロパティ値を取得します。

    パラメータ
    name String: プロパティ名

    戻り値
    String プロパティ値、または存在しない場合は null

    例外
    DeviceNotAvailableException

    getRecoveryMode

    public ITestDevice.RecoveryMode getRecoveryMode ()

    デバイスで使用されている現在のリカバリモードを取得します。

    戻り値
    ITestDevice.RecoveryMode デバイスで使用されている現在のリカバリモード。

    getScreenshot

    public InputStreamSource getScreenshot (long displayId)

    指定されたディスプレイ ID のデバイスからスクリーンショットを取得します。形式は PNG です。

    TODO: 上記の実装を拡張して、「format」と「rescale」をサポートする

    パラメータ
    displayId long: スクリーンショットを取得する画面のディスプレイ ID。

    戻り値
    InputStreamSource スクリーンショットの InputStreamSource(形式)、またはスクリーンショットが成功しなかった場合は null

    例外
    DeviceNotAvailableException

    getScreenshot

    public InputStreamSource getScreenshot (String format)

    デバイスのスクリーンショットを取得します。 サイズを小さくするには、代わりに getScreenshot(format) を使用して JPEG エンコードを使用することをおすすめします

    パラメータ
    format String: サポートされている PNG、JPEG

    戻り値
    InputStreamSource スクリーンショットの InputStreamSource(形式)、またはスクリーンショットが正常に取得されなかった場合は null

    例外
    DeviceNotAvailableException

    getScreenshot

    public InputStreamSource getScreenshot (String format, 
                    boolean rescale)

    デバイスのスクリーンショットを取得します。サイズを小さくするには、代わりに getScreenshot(String) を使用して JPEG エンコードすることをおすすめします。

    パラメータ
    format String: サポートされている PNG、JPEG

    rescale boolean: 結果の画像のサイズを小さくするためにスクリーンショットのサイズを変更するかどうか

    戻り値
    InputStreamSource スクリーンショットの InputStreamSource(形式)、またはスクリーンショットが成功しなかった場合は null

    例外
    DeviceNotAvailableException

    getScreenshot

    public InputStreamSource getScreenshot ()

    デバイスからスクリーンショットを取得します。

    戻り値
    InputStreamSource png 形式のスクリーンショットの InputStreamSource。スクリーンショットが成功しなかった場合は null

    例外
    DeviceNotAvailableException

    getSerialNumber

    public String getSerialNumber ()

    このデバイスのシリアル番号を取得する便利なメソッド。

    戻り値
    String String シリアル番号

    getSetting

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

    リクエストされた設定の値を返します。namespace は {"system"、"secure"、"global"} のいずれかにする必要があります。

    パラメータ
    userId int

    namespace String

    key String

    戻り値
    String ユーザーの namespace:key に関連付けられた値。見つからない場合は null。

    例外
    DeviceNotAvailableException

    getSetting

    public String getSetting (String namespace, 
                    String key)

    getSetting(int, String, String) を参照し、システム ユーザーで実行します。

    パラメータ
    namespace String

    key String

    戻り値
    String

    例外
    DeviceNotAvailableException

    getSimOperator

    public String getSimOperator ()

    SIM カード事業者を返します。利用できない場合は null を返します。デバイスが利用できない場合は null を返します。

    戻り値
    String

    getSimState

    public String getSimState ()

    SIM カードの状態を返します。利用できない場合は null を返します。デバイスが利用できない場合は null を返します。

    戻り値
    String

    getTombstone

    public  getTombstones ()

    デバイスから墓石のリストを取得して返します。root が必要です。

    メソッドはベスト エフォートであるため、なんらかの理由で 1 つの墓石が pull に失敗すると、リストから除外されます。メソッドが早期に終了するのは DeviceNotAvailableException の場合のみです。

    戻り値
    墓石ファイルのリスト。墓石がない場合、空になります。

    例外
    DeviceNotAvailableException

    getTotalMemory

    public long getTotalMemory ()

    物理メモリの合計サイズをバイト単位で返します。内部エラーの場合は -1 を返します。

    戻り値
    long

    getTrackingSerial

    public String getTrackingSerial ()

    デバイス管理の目的で、デバイスの追跡に使用されるシリアル番号を取得します。

    戻り値
    String

    getUninstallablePackageNames

    public  getUninstallablePackageNames ()

    アンインストール可能なアプリのパッケージ名を取得します。現在、これはシステム以外のパッケージと更新されたシステム パッケージとして定義されています。

    戻り値
    デバイスに現在インストールされている、アンインストール不可の String パッケージ名の ERROR(/Set)

    例外
    DeviceNotAvailableException

    getUseFastbootErase

    public boolean getUseFastbootErase ()

    fastboot erase と fastboot format のどちらを使用してデバイスのパーティションをワイプするかを取得します。

    戻り値
    boolean fastboot erase を使用する場合は true、fastboot format を使用する場合は false

    getUserFlags

    public int getUserFlags (int userId)

    指定したユーザーのフラグを検索して返します。フラグは、Android オープンソース プロジェクトの「android.content.pm.UserInfo」クラスで定義されます。

    パラメータ
    userId int

    戻り値
    int 指定された userId に関連付けられているフラグ(見つかった場合)、それ以外の場合は -10000。

    例外
    DeviceNotAvailableException

    getUserInfos

    public  getUserInfos ()

    デバイス上の useId と UserInfo のマップを取得します。デバイスからの出力が想定どおりでない場合、DeviceRuntimeException をスローします。

    戻り値
    UserInfo オブジェクトのリスト。

    例外
    DeviceNotAvailableException

    getUserSerialNumber

    public int getUserSerialNumber (int userId)

    userId に関連付けられているシリアル番号が見つかった場合はその番号を、見つからなかった場合は -10000 を返します。

    パラメータ
    userId int

    戻り値
    int

    例外
    DeviceNotAvailableException

    handleAllocationEvent

    public IManagedTestDevice.DeviceEventResponse handleAllocationEvent (DeviceEvent event)

    指定された DeviceEvent を処理します。デバイスを新しい状態に移行する場合があります。状態遷移を IDeviceMonitor に通知します。

    DeviceEvent を処理します。これにより、このデバイスを新しい割り当て状態に移行する場合とできない場合があります。

    パラメータ
    event DeviceEvent

    戻り値
    IManagedTestDevice.DeviceEventResponse

    hasFeature

    public boolean hasFeature (String feature)

    デバイスで利用できる機能を確認する。

    パラメータ
    feature String: 形式は「feature:」または「」にする必要があります。

    戻り値
    boolean 特徴が見つかった場合は true、見つからなかった場合は false。

    例外
    DeviceNotAvailableException

    installPackage

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

    デバイスに Android パッケージをインストールします。

    パラメータ
    packageFile File: インストールする APK ファイル

    reinstall boolean: 再インストールが必要な場合は true

    extraArgs String: 渡すオプションの追加引数。使用可能なオプションについては、「adb shell pm -h」をご覧ください。

    戻り値
    String エラーコードを含む String。成功した場合は null

    例外
    DeviceNotAvailableException

    installPackage

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

    デバイスに Android パッケージをインストールします。

    注: この関数を呼び出すのは、インストール時に実行時の権限の付与を明示的に制御する必要があるユースケースに限られます。

    パラメータ
    packageFile File: インストールする APK ファイル

    reinstall boolean: 再インストールが必要な場合は true

    grantPermissions boolean: すべてのランタイム パーミッションをインストール時に付与する必要があるかどうか

    extraArgs String: 渡す追加の引数(省略可)。使用可能なオプションについては、「adb shell pm -h」をご覧ください。

    戻り値
    String エラーコードを含む String、または成功した場合は null

    例外
    DeviceNotAvailableException

    installPackageForUser

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

    特定のユーザーの Android パッケージをデバイスにインストールします。

    パラメータ
    packageFile File: インストールする APK ファイル

    reinstall boolean: 再インストールを実行する必要がある場合は true

    userId int: インストールするユーザー ID(整数)。

    extraArgs String: 渡す追加の引数(省略可)。使用可能なオプションについては、「adb shell pm -h」をご覧ください。

    戻り値
    String エラーコードを含む String、または成功した場合は null

    例外
    DeviceNotAvailableException

    installPackageForUser

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

    特定のユーザーのデバイスに Android パッケージをインストールします。

    注: この関数を呼び出すのは、インストール時に実行時の権限の付与を明示的に制御する必要があるユースケースに限られます。

    パラメータ
    packageFile File: インストールする APK ファイル

    reinstall boolean: 再インストールが必要な場合は true

    grantPermissions boolean: すべてのランタイム パーミッションをインストール時に付与する必要があるかどうか

    userId int: インストール対象のユーザー ID(整数)。

    extraArgs String: 渡す追加の引数(省略可)。使用可能なオプションについては、「adb shell pm -h」をご覧ください。

    戻り値
    String エラーコードを含む String、または成功した場合は null

    例外
    DeviceNotAvailableException

    invalidatePropertyCache

    public void invalidatePropertyCache ()

    isAdbRoot

    public boolean isAdbRoot ()

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isAdbTcp

    public boolean isAdbTcp ()

    戻り値
    boolean

    isAppEnumerationSupported

    public boolean isAppEnumerationSupported ()

    デバイス上のプラットフォームがアプリの列挙をサポートしているかどうかを確認する

    戻り値
    boolean アプリの列挙がサポートされている場合は true、それ以外の場合は false

    例外
    DeviceNotAvailableException

    isBypassLowTargetSdkBlockSupported

    public boolean isBypassLowTargetSdkBlockSupported ()

    デバイス上のプラットフォームが、アプリのインストール時に低いターゲット SDK のブロックをバイパスすることをサポートしているかどうかを確認する

    戻り値
    boolean 低いターゲット SDK ブロックのバイパスがサポートされている場合は true、それ以外の場合は false

    例外
    DeviceNotAvailableException

    isDebugfsMounted

    public boolean isDebugfsMounted ()

    debugfs がマウントされているかどうかを確認します。

    戻り値
    boolean debugfs がマウントされている場合は true

    例外
    DeviceNotAvailableException

    isDeviceEncrypted

    public boolean isDeviceEncrypted ()

    デバイスが暗号化されているかどうかを返します。

    戻り値
    boolean true(デバイスが暗号化されている場合)。

    例外
    DeviceNotAvailableException

    isDirectory

    public boolean isDirectory (String path)

    デバイス上のパスがディレクトリである場合は true を返し、それ以外の場合は false を返します。

    パラメータ
    path String

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isEnableAdbRoot

    public boolean isEnableAdbRoot ()

    戻り値
    boolean true: デバイスで adb ルートを有効にする必要があるかどうか

    isEncryptionSupported

    public boolean isEncryptionSupported ()

    デバイスで暗号化がサポートされているかどうかを返します。

    戻り値
    boolean true: デバイスが暗号化をサポートしている場合。

    例外
    DeviceNotAvailableException

    isExecutable

    public boolean isExecutable (String fullPath)

    デバイス上のファイルパスが実行可能ファイルである場合は true を返し、それ以外の場合は false を返します。

    パラメータ
    fullPath String

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isFastbootEnabled

    public boolean isFastbootEnabled ()

    デバイスで Fastboot を使用できるかどうかを返します。

    戻り値
    boolean

    isHeadless

    public boolean isHeadless ()

    デバイスがヘッドレス(画面なし)の場合は true、それ以外の場合は false を返します。

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isHeadlessSystemUserMode

    public boolean isHeadlessSystemUserMode ()

    デバイスがヘッドレス システム ユーザー モードを使用しているかどうかを返します。

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isMainUserPermanentAdmin

    public boolean isMainUserPermanentAdmin ()

    メインユーザーが永続的な管理者であり、削除または管理者以外のステータスにダウングレードできないかどうかを返します。

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isMultiUserSupported

    public boolean isMultiUserSupported ()

    マルチユーザーに対応しているかどうかを判別します。

    戻り値
    boolean マルチユーザーがサポートされている場合は true、それ以外の場合は false

    例外
    DeviceNotAvailableException

    isPackageInstalled

    public boolean isPackageInstalled (String packageName, 
                    String userId)

    デバイスに特定のパッケージ名とユーザー ID を照会して、そのユーザーが現在インストールされているかどうかを確認します。

    パラメータ
    packageName String: インストールされているかどうかを確認するパッケージ。

    userId String: パッケージがインストールされているユーザー ID。null の場合、メインユーザー 0 が使用されます。

    戻り値
    boolean パッケージがインストール済みとして報告されている場合は true です。それ以外の場合は False です。

    例外
    DeviceNotAvailableException

    isPackageInstalled

    public boolean isPackageInstalled (String packageName)

    特定のパッケージ名についてデバイスにクエリを実行し、現在インストールされているかどうかを確認します。

    パラメータ
    packageName String

    戻り値
    boolean パッケージがインストール済みとして報告されている場合は true です。それ以外の場合は False です。

    例外
    DeviceNotAvailableException

    isRuntimePermissionSupported

    public boolean isRuntimePermissionSupported ()

    デバイス上のプラットフォームがランタイム権限の付与をサポートしているかどうかを確認する

    戻り値
    boolean ランタイム権限がサポートされている場合は true、それ以外の場合は false。

    例外
    DeviceNotAvailableException

    isStateBootloaderOrFastbootd

    public boolean isStateBootloaderOrFastbootd ()

    デバイスが TestDeviceState#FASTBOOT または TestDeviceState.FASTBOOTD にある場合、true を返します。

    戻り値
    boolean

    isUserRunning

    public boolean isUserRunning (int userId)

    特定のユーザーが実行されているかどうかを確認します。

    パラメータ
    userId int

    戻り値
    boolean ユーザーが実行中の場合は true、それ以外の場合は false。

    例外
    DeviceNotAvailableException

    isUserSecondary

    public boolean isUserSecondary (int userId)

    指定されたユーザーがフラグに基づいてセカンダリ ユーザーかどうかを返します。

    パラメータ
    userId int

    戻り値
    boolean ユーザーがセカンダリである場合は true、そうでない場合は false。

    例外
    DeviceNotAvailableException

    isUserVisible

    public boolean isUserVisible (int userId)

    指定したユーザーが表示されているかどうかを確認します。

    「可視」ユーザーとは、「人間」ユーザーとやり取りしているユーザーであり、そのため(通常はデフォルト ディスプレイで)起動アクティビティを起動できます。

    パラメータ
    userId int

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isUserVisibleOnDisplay

    public boolean isUserVisibleOnDisplay (int userId, 
                    int displayId)

    指定されたユーザーが指定されたディスプレイに表示されているかどうかを確認します。

    「可視」ユーザーとは、「人間」ユーザーとやり取りしているユーザーであり、そのディスプレイでアクティビティを起動できます。

    パラメータ
    userId int

    displayId int

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isVisibleBackgroundUsersOnDefaultDisplaySupported

    public boolean isVisibleBackgroundUsersOnDefaultDisplaySupported ()

    デバイスでユーザーが ERROR(/java.android.view.Display#DEFAULT_DISPLAY) でバックグラウンドで開始され、表示されるかどうかを返します。

    含まれている場合は、startVisibleBackgroundUser(int, int, boolean) を呼び出して、listDisplayIdsForStartingVisibleBackgroundUsers() から返されたディスプレイ(ERROR(/java.android.view.Display#DEFAULT_DISPLAY) を含む)を渡すことができます。

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isVisibleBackgroundUsersSupported

    public boolean isVisibleBackgroundUsersSupported ()

    デバイスでユーザーがバックグラウンドで開始されたことを表示できるかどうかを返します。

    存在する場合は、listDisplayIdsForStartingVisibleBackgroundUsers() によって返されたディスプレイを渡して startVisibleBackgroundUser(int, int, boolean) を呼び出すことができます。

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isWifiEnabled

    public boolean isWifiEnabled ()

    Wi-Fi が有効になっているかどうかをテストします。

    デバイスで Wi-Fi が有効になっているかどうかを確認します。Wi-Fi で実行すべきでないテスト(モバイルデータ テストなど)の前に Wi-Fi ステータスをアサートする場合に便利です。

    戻り値
    boolean Wi-Fi が有効になっている場合は true。無効の場合は false

    例外
    DeviceNotAvailableException

    listDisplayIds

    public  listDisplayIds ()

    「dumpsys SurfaceFlinger」によって報告された、デバイスで使用可能なディスプレイ ID のリストを収集します。

    戻り値
    ディスプレイのリスト。デフォルトでは、常にデフォルトの表示 0 が返されます。

    例外
    DeviceNotAvailableException

    listDisplayIdsForStartingVisibleBackgroundUsers

    public  listDisplayIdsForStartingVisibleBackgroundUsers ()

    start a user visible in the background で使用できるディスプレイのリストを取得します。

    戻り値

    例外
    DeviceNotAvailableException

    listUsers

    public  listUsers ()

    デバイス上のユーザーのリストを取得します。デバイスからの出力が想定どおりでない場合、DeviceRuntimeException をスローします。

    戻り値
    ユーザー ID のリスト。

    例外
    DeviceNotAvailableException

    logAnrs

    public boolean logAnrs (ITestLogger logger)

    デバイスから ANR を収集してログに記録します。

    パラメータ
    logger ITestLogger: ANR をログに記録する ITestLogger

    戻り値
    boolean ロギングが成功した場合は true、それ以外の場合は false。

    例外
    DeviceNotAvailableException

    ログバグレポート

    public boolean logBugreport (String dataName, 
                    ITestLogger listener)

    バグレポートを取得してレポーターにログを記録するヘルパー メソッド。

    パラメータ
    dataName String: バグレポートが報告される名前。

    listener ITestLogger: バグレポートをログに記録する ITestLogger

    戻り値
    boolean ロギングが成功した場合は true、それ以外の場合は false。

    logOnDevice

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

    デバイスの logcat にメッセージを記録します。これは、ロギングが失敗してもスローしない安全な呼び出しです。

    パラメータ
    tag String: Logcat でメッセージをログに記録するタグ。

    level Log.LogLevel: logcat 内のメッセージのデバッグレベル。

    format String: メッセージ形式。

    args Object: String.format() で置換される引数。

    mountDebugfs

    public void mountDebugfs ()

    debugfs をマウントします。

    例外
    DeviceNotAvailableException

    nonBlockingReboot

    public void nonBlockingReboot ()

    デバイスを再起動するためのコマンドを送信し、コマンドが完了したとき、またはデバイスが adb に表示されなくなったときに返します。

    例外
    DeviceNotAvailableException

    postAdbRootAction

    public void postAdbRootAction ()

    adb root の後、デバイスがオンラインに戻る前に、デバイスで特定のアクションを実行する必要がある場合は、オーバーライドします。デフォルトの実装には追加アクションは含まれません。この段階で adb root が有効になっているとは限りません。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    postAdbUnrootAction

    public void postAdbUnrootAction ()

    adb unroot の後、デバイスがオンラインに戻る前に、デバイスで特定のアクションを実行する必要がある場合はオーバーライドします。 デフォルトの実装には追加のアクションは含まれません。この段階で adb root が無効になるとは限りません。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    postBootSetup

    public void postBootSetup ()

    手順に沿ってデバイスを構成し、起動後にテストします。

    デバイスの起動が完了した後、またはデバイスが使用可能になった後に呼び出す必要があります。

    通常、再起動時に実装はこれらのステップを自動的に実行するため、このメソッドを明示的に呼び出す必要はありません。

    呼び出す必要があるのは、他のイベント(fastboot update コマンドが完了したときなど)によってデバイスが再起動された場合です。

    例外
    DeviceNotAvailableException

    postInvocationTearDown

    public void postInvocationTearDown (Throwable exception)

    呼び出しが完了した後に実行される、デバイス固有の必要なクリーンアップの追加手順。

    パラメータ
    exception Throwable: 呼び出しの失敗によってスローされた最終的な例外(存在する場合)。

    preInvocationSetup

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

    呼び出しフローの前にデバイス上で実行される、デバイス固有の必要な設定の追加手順。

    パラメータ
    info IBuildInfo: デバイスの IBuildInfo

    attributes MultiMap: 呼び出しコンテキストに保存されている属性

    例外
    DeviceNotAvailableException
    TargetSetupError

    pullDir

    public boolean pullDir (String deviceFilePath, 
                    File localDir, 
                    int userId)

    デバイスからディレクトリ コンテンツを再帰的に pull します。

    パラメータ
    deviceFilePath String: リモートソースの絶対ファイルパス

    localDir File: ファイルを pull するローカル ディレクトリ

    userId int: pull 元のユーザー ID

    戻り値
    boolean ファイルが正常に pull された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pullDir

    public boolean pullDir (String deviceFilePath, 
                    File localDir)

    デバイスからディレクトリ コンテンツを再帰的に pull します。

    パラメータ
    deviceFilePath String: リモートソースの絶対ファイルパス

    localDir File: ファイルを pull するローカル ディレクトリ

    戻り値
    boolean ファイルが正常に pull された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pullFile

    public boolean pullFile (String remoteFilePath, 
                    File localFile)

    デバイスからファイルを取得します。

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

    localFile File: コンテンツを保存するローカル ファイル。空でない場合、コンテンツが置き換えられます。

    戻り値
    boolean ファイルが正常に取得された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pullFile

    public File pullFile (String remoteFilePath, 
                    int userId)

    デバイスからファイルを取得し、ローカルの一時 ERROR(/File) に保存して、その File を返します。

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

    userId int: プル元のユーザー ID

    戻り値
    File デバイス ファイルの内容を含む ERROR(/File)。コピーがなんらかの理由(ホスト ファイルシステムの問題など)で失敗した場合は null

    例外
    DeviceNotAvailableException

    pullFile

    public File pullFile (String remoteFilePath)

    デバイスからファイルを取得し、ローカルの一時 ERROR(/File) に保存して、その File を返します。

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

    戻り値
    File デバイス ファイルの内容を含む ERROR(/File)。コピーがなんらかの理由(ホスト ファイルシステムの問題など)で失敗した場合は null

    例外
    DeviceNotAvailableException

    pullFile

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

    デバイスからファイルを取得します。

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

    localFile File: コンテンツを保存するローカル ファイル。空でない場合、コンテンツが置き換えられます。

    userId int: プル元のユーザー ID

    戻り値
    boolean ファイルが正常に取得された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pullFileContents

    public String pullFileContents (String remoteFilePath)

    デバイスからファイルを取得し、コンテンツを返します。

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

    戻り値
    String デバイス ファイルの内容を含む String。コピーがなんらかの理由(ホスト ファイルシステムの問題など)で失敗した場合は null

    例外
    DeviceNotAvailableException

    pullFileFromExternal

    public File pullFileFromExternal (String remoteFilePath)

    デバイスの外部ストレージからファイルを取得し、ローカルの一時 ERROR(/File) に保存し、その File への参照を返す便利なメソッド。

    パラメータ
    remoteFilePath String: デバイス上のファイルのパス(デバイスの外部ストレージのマウントポイントを基準とする)

    戻り値
    File デバイス ファイルの内容を含む ERROR(/File)。コピーがなんらかの理由(ホスト ファイルシステムの問題など)で失敗した場合は null

    例外
    DeviceNotAvailableException

    pushDir

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

    フィルタされた一部のディレクトリを除外しながら、ディレクトリの内容をデバイスに再帰的にプッシュします。

    パラメータ
    localFileDir File: push するローカル ディレクトリ

    deviceFilePath String: リモート デスティネーションの絶対ファイルパス

    excludedDirectories : プッシュしないディレクトリ名の除外セット。

    戻り値
    boolean ファイルが正常に push された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pushDir

    public boolean pushDir (File localFileDir, 
                    String deviceFilePath)

    ディレクトリの内容をデバイスに再帰的にプッシュします。

    パラメータ
    localFileDir File: push するローカル ディレクトリ

    deviceFilePath String: リモート デスティネーションの絶対ファイルパス

    戻り値
    boolean ファイルが正常に push された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pushDir

    public boolean pushDir (File localFileDir, 
                    String deviceFilePath, 
                    int userId)

    ディレクトリの内容をデバイスに再帰的にプッシュします。

    パラメータ
    localFileDir File: push するローカル ディレクトリ

    deviceFilePath String: リモート デスティネーションの絶対ファイルパス

    userId int: プッシュするユーザー ID

    戻り値
    boolean ファイルが正常に push された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pushFile

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

    pushFile(File, String) のバリエーション。コンテンツ プロバイダのニーズを評価することもできます。

    パラメータ
    localFile File: プッシュするローカル ファイル

    remoteFilePath String: リモート デスティネーションの絶対ファイルパス

    evaluateContentProviderNeeded boolean: コンテンツ プロバイダが必要かどうかをチェックする

    戻り値
    boolean ファイルが正常に push された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pushFile

    public boolean pushFile (File localFile, 
                    String remoteFilePath)

    ファイルをデバイスにプッシュします。デフォルトではコンテンツ プロバイダを使用します。

    パラメータ
    localFile File: プッシュするローカル ファイル

    remoteFilePath String: リモート デスティネーションの絶対ファイルパス

    戻り値
    boolean ファイルが正常に push された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pushFile

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

    ファイルをデバイスにプッシュします。デフォルトではコンテンツ プロバイダを使用します。

    パラメータ
    localFile File: プッシュするローカル ファイル

    remoteFilePath String: リモート デスティネーションの絶対ファイルパス

    userId int: プッシュする userId

    戻り値
    boolean ファイルが正常に push された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    pushString

    public boolean pushString (String contents, 
                    String remoteFilePath)

    文字列から作成されたファイルをデバイスにプッシュする

    パラメータ
    contents String: push するファイルの内容

    remoteFilePath String: リモート デスティネーションの絶対ファイルパス

    戻り値
    boolean true: 文字列が正常に push された場合。それ以外の場合は false

    例外
    DeviceNotAvailableException

    再起動

    public void reboot (String reason)

    指定された reason を使用してデバイスを adb モードに再起動します。この reason は再起動後も保持されます。

    デバイスが使用可能になるまでブロックします。

    最終再起動の理由を取得するには、sys.boot.reason プロパティをクエリします。

    パラメータ
    reason String: この再起動の理由。理由が指定されていない場合は null

    例外
    DeviceNotAvailableException

    再起動

    public void reboot ()

    デバイスを再起動して adb モードに入ります。

    デバイスが利用可能になるまでブロックします。

    例外
    DeviceNotAvailableException

    rebootIntoBootloader

    public void rebootIntoBootloader ()

    デバイスを再起動してブートローダー モードに入ります。

    デバイスがブートローダー モードになるまでブロックします。

    例外
    DeviceNotAvailableException

    rebootIntoFastbootd

    public void rebootIntoFastbootd ()

    デバイスを再起動して fastbootd モードに入ります。

    デバイスが fastbootd モードになるまでブロックします。

    例外
    DeviceNotAvailableException

    rebootIntoRecovery

    public void rebootIntoRecovery ()

    デバイスを再起動して adb リカバリ モードに入ります。

    デバイスがリカバリ状態になるまでブロックする

    例外
    DeviceNotAvailableException

    returnIntoSideload

    public void rebootIntoSideload ()

    デバイスを adb サイドロード モードで再起動します(これはリカバリ時の特殊なモードです)

    デバイスがサイドロード モードに入るまでブロックする

    例外
    DeviceNotAvailableException

    returnIntoSideload

    public void rebootIntoSideload (boolean autoReboot)

    デバイスを adb サイドロード モードで再起動します(これはリカバリ時の特殊なモードです)

    デバイスがサイドロード モードに入るまでブロックする

    パラメータ
    autoReboot boolean: サイドロード後にデバイスを自動的に再起動するかどうか

    例外
    DeviceNotAvailableException

    rebootUntilOnline

    public void rebootUntilOnline ()

    reboot() の代替手段。デバイスがオンラインになるまで(つまり adb に表示されるまで)のみブロックします。

    例外
    DeviceNotAvailableException

    rebootUntilOnline

    public void rebootUntilOnline (String reason)

    reboot() の代替手段。デバイスがオンラインになるまで(つまり adb に表示されるまで)のみブロックします。

    パラメータ
    reason String: この再起動の理由。理由が指定されていない場合は null

    例外
    DeviceNotAvailableException

    rebootUserspace

    public void rebootUserspace ()

    デバイスのユーザー空間部分のみを再起動します。

    デバイスが使用可能になるまでブロックします。

    警告。ユーザー空間の再起動は現在開発中です。ご自身の責任で使用してください。

    例外
    DeviceNotAvailableException

    rebootUserspaceUntilOnline

    public void rebootUserspaceUntilOnline ()

    rebootUserspace() ()} の代替手段。デバイスがオンラインになるまで(つまり、adb に表示される)までのみブロックします。

    例外
    DeviceNotAvailableException

    recoverDevice

    public boolean recoverDevice ()

    デバイスの通信を復元しようとします。

    戻り値
    boolean 復元が試行され、成功した場合は true、復元がスキップされた場合は false を返します。

    例外
    DeviceNotAvailableException デバイスが利用できなくなった場合

    registerDeviceActionReceiver

    public void registerDeviceActionReceiver (IDeviceActionReceiver deviceActionReceiver)

    このデバイスの IDeviceActionReceiver を登録します。

    登録されたすべての IDeviceActionReceiver には、デバイス アクションの開始前とデバイス アクションの終了後に通知されます。

    パラメータ
    deviceActionReceiver IDeviceActionReceiver: 登録される IDeviceActionReceiver

    remountSystemReadOnly

    public void remountSystemReadOnly ()

    デバイスのシステム パーティションを読み取り専用にします。デバイスが再起動される場合があります。

    例外
    DeviceNotAvailableException

    remountSystemWritable

    public void remountSystemWritable ()

    デバイスのシステム パーティションを書き込み可能にします。デバイスが再起動される場合があります。

    例外
    DeviceNotAvailableException

    remountVendorReadOnly

    public void remountVendorReadOnly ()

    デバイス上のベンダー パーティションを読み取り専用にします。デバイスが再起動される場合があります。

    例外
    DeviceNotAvailableException

    remountVendorWritable

    public void remountVendorWritable ()

    デバイスのベンダー パーティションを書き込み可能にします。デバイスが再起動される場合があります。

    例外
    DeviceNotAvailableException

    removeAdmin

    public boolean removeAdmin (String componentName, 
                    int userId)

    指定されたユーザーの指定されたデバイス管理者を削除し、成功した場合は true、失敗した場合は false を返します。

    パラメータ
    componentName 削除するデバイス管理の String

    userId int: デバイス管理者が存在するユーザー。

    戻り値
    boolean 成功した場合は true、それ以外の場合は false。

    例外
    DeviceNotAvailableException

    removeOwners

    public void removeOwners ()

    既存のデバイス プロファイルのオーナーをすべて削除します。

    例外
    DeviceNotAvailableException

    removeUser

    public boolean removeUser (int userId)

    デバイスから特定のユーザーを削除する。

    パラメータ
    userId int: 削除するユーザーの

    戻り値
    boolean ユーザーの削除に成功した場合は true、それ以外の場合は false。

    例外
    DeviceNotAvailableException

    resetContentProviderSetup

    public void resetContentProviderSetup ()

    再度トリガーするには、コンテンツ プロバイダ設定用のフラグをリセットしてください。

    runInstrumentationTests

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

    パラメータとして渡される 1 つ以上のリスナーを使用して ERROR(/#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection)) を実行するためのコンビニエンス メソッド。

    パラメータ
    runner IRemoteAndroidTestRunner: テストを実行する IRemoteAndroidTestRunner

    listeners ITestLifeCycleReceiver: テスト結果リスナー

    戻り値
    boolean テストコマンドが完了した場合は true。完了しなかったが復元に成功した場合は false

    例外
    DeviceNotAvailableException

    runInstrumentationTests

    public boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, 
                     listeners)

    インストルメンテーション テストを実行し、デバイスの復元を提供します。

    テスト実行が完了する前にデバイスとの接続が失われ、復元が成功すると、すべてのリスナーに testRunFailed が通知され、「false」が返されます。テストコマンドは再実行されません。必要に応じて再試行するのは呼び出し元の責任です。

    テスト実行が完了する前にデバイスとの接続が失われ、復元に失敗した場合、すべてのリスナーに testRunFailed が通知され、DeviceNotAvailableException がスローされます。

    パラメータ
    runner IRemoteAndroidTestRunner: テストを実行する IRemoteAndroidTestRunner

    listeners : テスト結果リスナー

    戻り値
    boolean テストコマンドが完了した場合は truefalse: デバイス通信例外が原因で完了できなかったが、復元は成功した場合

    例外
    DeviceNotAvailableException

    runInstrumentationTestsAsUser

    public boolean 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)) と同じですが、指定されたユーザーに対してテストを実行します。

    パラメータ
    runner IRemoteAndroidTestRunner

    userId int

    listeners

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    runInstrumentationTestsAsUser

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

    ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, ITestLifeCycleReceiver...) と同じですが、特定のユーザーに対してテストを実行します。

    パラメータ
    runner IRemoteAndroidTestRunner

    userId int

    listeners ITestLifeCycleReceiver

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    setConfiguration

    public void setConfiguration (IConfiguration configuration)

    使用中の IConfiguration を注入します。

    パラメータ
    configuration IConfiguration

    setConnectionAvdInfo

    public final void setConnectionAvdInfo (GceAvdInfo avdInfo)

    パラメータ
    avdInfo GceAvdInfo

    setDate

    public void setDate (Date date)

    デバイスの日付を設定します。

    注: デバイスの日付を設定するには、root 権限が必要です。

    パラメータ
    date Date: 特定の日付を指定します。null の場合はホスト日付が使用されます。

    例外
    DeviceNotAvailableException

    setDeviceOwner

    public boolean setDeviceOwner (String componentName, 
                    int userId)

    特定のユーザーのデバイス オーナーとしてデバイス管理コンポーネントを設定します。

    パラメータ
    componentName String: デバイス管理者がデバイスのオーナーになる。

    userId int: デバイス所有者が居住している国または地域のユーザー。

    戻り値
    boolean 成功した場合は true、それ以外の場合は false。

    例外
    DeviceNotAvailableException

    setDeviceState

    public void setDeviceState (TestDeviceState deviceState)

    デバイスの状態を更新します。

    パラメータ
    deviceState TestDeviceState: TestDeviceState

    setEmulatorOutputStream

    public void setEmulatorOutputStream (SizeLimitedOutputStream output)

    エミュレータの場合は、SizeLimitedOutputStream を設定して出力をロギングします。

    パラメータ
    output SizeLimitedOutputStream: 出力をログに記録します

    setEmulatorProcess

    public void setEmulatorProcess (Process p)

    このデバイスがエミュレータの場合に Process を設定します。

    パラメータ
    p Process

    setFastbootEnabled

    public void setFastbootEnabled (boolean fastbootEnabled)

    デバイスの fastboot オプションを設定します。デバイスが最初に割り振られるときに設定する必要があります。

    パラメータ
    fastbootEnabled boolean: デバイスで fastboot を使用できるかどうか

    setFastbootPath

    public void setFastbootPath (String fastbootPath)

    使用する fastboot バイナリへのパスを設定します。fastboot 機能を有効にするには、isFastbootEnabled() を true にする必要があります。

    パラメータ
    fastbootPath String

    setIDevice

    public void setIDevice (IDevice newDevice)

    この ITestDevice に関連付けられている IDevice を更新します。

    新しい IDevice は、現在の参照と同じ物理デバイスを参照する必要があります。このメソッドは、DDMS が新しい IDevice を割り当てた場合に呼び出されます。

    パラメータ
    newDevice IDevice: IDevice

    setLogStartDelay

    public void setLogStartDelay (int delay)

    オンライン デバイスの logcat キャプチャを開始する前に待機する時間をミリ秒単位で設定します。

    パラメータ
    delay int: 遅延(ミリ秒)

    setOptions

    public void setOptions (TestDeviceOptions options)

    デバイスの TestDeviceOptions を設定する

    パラメータ
    options TestDeviceOptions

    setProperty

    public boolean setProperty (String propKey, 
                    String propValue)

    デバイスで指定されたプロパティ値を設定します。adb root が true である必要があります。

    パラメータ
    propKey String: 設定対象のキー。

    propValue String: 設定するプロパティ値。

    戻り値
    boolean setprop コマンドが成功した場合は True を返し、成功した場合は False を返します。

    例外
    DeviceNotAvailableException

    setRecovery

    public void setRecovery (IDeviceRecovery recovery)

    このデバイスに使用する IDeviceRecovery を設定します。デバイスが最初に割り振られるときに設定する必要があります。

    パラメータ
    recovery IDeviceRecovery: IDeviceRecovery

    setRecoveryMode

    public void setRecoveryMode (ITestDevice.RecoveryMode mode)

    デバイスに使用する現在のリカバリモードを設定します。

    デバイスの通信に関する問題が発生したときに使用する復元方法を制御するために使用されます。この方法は、必要な場合にのみ使用することをおすすめします(フレームワークが停止している場合など)。

    パラメータ
    mode ITestDevice.RecoveryMode: 「オンラインになるまで復元」モードをオンにするかどうか。

    setSetting

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

    setSetting(int, String, String, String) を参照し、システム ユーザーで実行します。

    パラメータ
    namespace String

    key String

    value String

    例外
    DeviceNotAvailableException

    setSetting

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

    特定のユーザーの Namespace に設定値を追加します。一部の設定は、再起動後にのみ利用できます。Namespace は、{"system"、"secure"、"global"} のいずれかである必要があります

    パラメータ
    userId int

    namespace String

    key String

    value String

    例外
    DeviceNotAvailableException

    setTestLogger

    public void setTestLogger (ITestLogger testLogger)

    ITestLogger インスタンスを注入する

    パラメータ
    testLogger ITestLogger

    setTrackingSerial

    public void setTrackingSerial (String trackingSerial)

    デバイス管理のため、デバイスの参照に使用しているシリアル番号を追跡します。

    パラメータ
    trackingSerial String

    setUseFastbootErase

    public void setUseFastbootErase (boolean useFastbootErase)

    fastboot erase と fastboot format のどちらを使用してデバイスのパーティションをワイプするかを設定します。

    パラメータ
    useFastbootErase boolean: fastboot 消去を使用する場合は true、fastboot フォーマットを使用する場合は false

    startLogcat

    public void startLogcat ()

    バックグラウンドでデバイスから logcat の出力をキャプチャします。

    logcat の出力がすでにキャプチャされている場合、効果はありません。データは後で getLogcat を使用して取得できます。

    デバイスが使用されなくなったら、stopLogcat() を呼び出す必要があります。

    通常、TF フレームワークが logcat を開始および停止するため、TF 呼び出しコンテキスト内では startLogcat()stopLogcat() を呼び出す必要はありません。

    startUser

    public boolean startUser (int userId)

    指定したユーザーが現在停止している場合は、バックグラウンドでそのユーザーを開始します。ユーザーがすでにバックグラウンドで実行されている場合、このメソッドは NOOP です。

    パラメータ
    userId int: バックグラウンドで起動するユーザー

    戻り値
    boolean ユーザーがバックグラウンドで正常に開始された場合は true。

    例外
    DeviceNotAvailableException

    startUser

    public boolean startUser (int userId, 
                    boolean waitFlag)

    指定したユーザーが現在停止している場合は、バックグラウンドでそのユーザーを開始します。ユーザーがすでにバックグラウンドで実行されている場合、このメソッドは NOOP です。オペレーションが有効になるまで待機するための追加フラグを指定できます。

    パラメータ
    userId int: バックグラウンドで起動するユーザー

    waitFlag boolean: ユーザーが起動してロックが解除されるまでコマンドを待機させます。

    戻り値
    boolean ユーザーがバックグラウンドで正常に開始された場合は true。

    例外
    DeviceNotAvailableException

    startVisibleBackgroundUser

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

    特定のユーザーをバックグラウンドで開始し、特定のディスプレイに表示します(つまり、ユーザーはそのディスプレイでアクティビティを起動できます)。

    注: このコマンドは、ユーザーが存在するかどうか、ディスプレイが使用可能かどうか、device supports such feature などを確認しません。

    パラメータ
    userId int: バックグラウンドで起動するユーザー

    displayId int: ユーザーに表示するディスプレイ

    waitFlag boolean: ユーザーが起動してロックが解除されるまでコマンドを待機させます。

    戻り値
    boolean true: ユーザーのバックグラウンドでの表示が正常に開始された場合。

    例外
    DeviceNotAvailableException

    stopEmulatorOutput

    public void stopEmulatorOutput ()

    エミュレータの出力を閉じて削除します。

    stopLogcat

    public void stopLogcat ()

    デバイスからの logcat 出力の取得を停止し、現在保存されている logcat データを破棄します。

    logcat 出力をキャプチャしていない場合には影響はありません。

    stopUser

    public boolean stopUser (int userId)

    特定のユーザーを停止します。ユーザーがすでに停止している場合、このメソッドは NOOP です。現在のユーザーとシステム ユーザーを停止することはできません。

    パラメータ
    userId int: 停止するユーザー。

    戻り値
    boolean ユーザーが正常に停止された場合は true を返します。

    例外
    DeviceNotAvailableException

    stopUser

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

    特定のユーザーを停止します。追加のフラグを指定して、オペレーションが有効になるまで待機し、ユーザーを強制的に終了できます。現在のユーザーとシステム ユーザーを停止することはできません。

    パラメータ
    userId int: 停止するユーザー。

    waitFlag boolean: ユーザーが停止するまでコマンドを待機します。

    forceFlag boolean: ユーザーを強制停止します。

    戻り値
    boolean ユーザーが正常に停止された場合は true を返します。

    例外
    DeviceNotAvailableException

    switchToAdbTcp

    public String switchToAdbTcp ()

    デバイスを adb-over-tcp モードに切り替えます。

    戻り値
    String tcp シリアル番号、またはデバイスを切り替えられなかった場合は null

    例外
    DeviceNotAvailableException

    switchToAdbUsb

    public boolean switchToAdbUsb ()

    デバイスを USB 経由の ADB モードに切り替えます。

    戻り値
    boolean 切り替えが成功した場合は true、そうでない場合は false

    例外
    DeviceNotAvailableException

    switchUser

    public boolean switchUser (int userId)

    デフォルトのタイムアウトで別の userId に切り替えます。switchUser(int, long)

    パラメータ
    userId int

    戻り値
    boolean 新しい userId が userId プロバイダと一致する場合は true。それ以外の場合は False です。

    例外
    DeviceNotAvailableException

    switchUser

    public boolean switchUser (int userId, 
                    long timeout)

    指定されたタイムアウトを期限として、別の userId に切り替えます。ユーザーの変更が正常に完了した後にキーガードを無効にしようとします。

    パラメータ
    userId int

    timeout long: ユーザー切り替えに失敗した場合に false を返す前に待機します。

    戻り値
    boolean 新しい userId が userId プロバイダと一致する場合は true。それ以外の場合は False です。

    例外
    DeviceNotAvailableException

    syncFiles

    public boolean syncFiles (File localFileDir, 
                    String deviceFilePath)

    ローカル ファイル ディレクトリの内容をデバイスに増分同期します。

    ローカル ファイルのタイムスタンプとリモートの同等のタイムスタンプを比較して、プッシュするファイルを決定します。デバイスにプッシュされるのは、「新しい」ファイルまたは存在しないファイルのみです。したがって、デバイス上のファイルセットがすでに最新の状態であれば、オーバーヘッドは比較的小さくなります。

    隠しファイル(名前が「.」で始まるファイル)は無視されます。

    使用例: syncFiles("/tmp/files", "/sdcard") は、/sdcard/files ディレクトリが存在しない場合、そのディレクトリを作成して、/tmp/files の内容を /sdcard/files に再帰的に push します。

    パラメータ
    localFileDir File: 再帰的に push するファイルを含むローカル ファイル ディレクトリ。

    deviceFilePath String: リモート デスティネーションの絶対ファイルパスのルート。このファイルパス内のすべてのディレクトリは読み取り可能である必要があります。たとえば、adb が root でない場合、/data/local/tmp に push すると失敗します。

    戻り値
    boolean ファイルが正常に同期された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException

    takeBugreport

    public Bugreport takeBugreport ()

    バグレポートを受け取り、Bugreport オブジェクト内に返して処理します。問題が発生した場合は null を返します。Bugreport オブジェクトで参照されているファイルは、Bugreport.close() でクリーンアップする必要があります。

    戻り値
    Bugreport

    uninstallPackage

    public String uninstallPackage (String packageName)

    デバイスから Android パッケージをアンインストールする。

    パラメータ
    packageName String: アンインストールする Android パッケージ

    戻り値
    String エラーコードを含む String、または成功した場合は null

    例外
    DeviceNotAvailableException

    uninstallPackageForUser

    public String uninstallPackageForUser (String packageName, 
                    int userId)

    特定のユーザーのデバイスから Android パッケージをアンインストールします。

    パラメータ
    packageName String: アンインストールする Android パッケージ

    userId int: アンインストールするユーザー ID(整数)。

    戻り値
    String エラーコードを含む String、または成功した場合は null

    例外
    DeviceNotAvailableException

    unlockDevice

    public boolean unlockDevice ()

    デバイスが暗号化されている場合は、デバイスのロックを解除します。

    このメソッドはフレームワークを再起動する可能性がありますが、postBootSetup() は呼び出されません。したがって、このメソッドが返されたときに、デバイスがテストの準備が完全に整っていない場合があります。

    戻り値
    boolean 成功したか、デバイスが暗号化されていない場合は true

    例外
    DeviceNotAvailableException

    unmountDebugfs

    public void unmountDebugfs ()

    debugfs のマウントを解除します。

    例外
    DeviceNotAvailableException

    waitForBootComplete

    public boolean waitForBootComplete (long timeOut)

    デバイスの起動完了フラグが設定されるまでブロックします。

    パラメータ
    timeOut long: フラグの設定を待機する時間(ミリ秒単位)

    戻り値
    boolean タイムアウト内にデバイスの起動完了フラグが設定されている場合は true

    例外
    DeviceNotAvailableException

    waitForDeviceAvailable

    public boolean waitForDeviceAvailable ()

    デバイスが応答してテストに使用可能になるまで待機します。デフォルトのタイムアウトを使用します。

    戻り値
    boolean デバイスが使用可能な場合は true、復元が無効で使用できない場合は false。

    例外
    DeviceNotAvailableException

    waitForDeviceAvailable

    public boolean waitForDeviceAvailable (long waitTime)

    デバイスが応答し、テストの準備が整うまで待ちます。

    パラメータ
    waitTime long: 待機時間(ミリ秒)

    戻り値
    boolean デバイスが使用可能な場合は true、復元が無効で使用できない場合は false。

    例外
    DeviceNotAvailableException

    waitForDeviceAvailableInRecoverPath

    public boolean waitForDeviceAvailableInRecoverPath (long waitTime)

    復元パスを検討せずに、デバイスが応答して使用可能になるまで待ちます。

    パラメータ
    waitTime long

    戻り値
    boolean デバイスが利用可能な場合は true、利用できない場合は False です。

    例外
    DeviceNotAvailableException

    waitForDeviceBootloader

    public void waitForDeviceBootloader ()

    デバイスが fastboot で認識されるまでブロックします。デフォルトのタイムアウトを使用します。

    例外
    DeviceNotAvailableException

    waitForDeviceInRecovery

    public boolean waitForDeviceInRecovery (long waitTime)

    デバイスが「adb recovery」状態になるのをブロックします(これは IDeviceRecovery とは異なります)。

    パラメータ
    waitTime long: 待機時間(ミリ秒)

    戻り値
    boolean 期限が切れる前にデバイスがリカバリに起動する場合は true。 それ以外の場合は false

    waitForDeviceInSideload

    public boolean waitForDeviceInSideload (long waitTime)

    デバイスが「adb sideload」状態になるのをブロックします

    パラメータ
    waitTime long: 待機時間(ミリ秒)

    戻り値
    boolean true: 時間切れになる前にデバイスがサイドロードに起動した場合。それ以外の場合は false

    waitForDeviceNotAvailable

    public boolean waitForDeviceNotAvailable (long waitTime)

    デバイスが使用できないようにブロックする(adb にないなど)

    パラメータ
    waitTime long: 待機時間(ミリ秒)

    戻り値
    boolean true: 期限が切れる前にデバイスが使用できなくなった場合。 それ以外の場合は false

    waitForDeviceOnline

    public void waitForDeviceOnline ()

    デバイスが adb 経由で検出されるまでブロックします。デフォルトのタイムアウトを使用

    ただし、完了後にデバイスがコマンドに応答するとは限りません。代わりに waitForDeviceAvailable() を使用してください。

    例外
    DeviceNotAvailableException

    waitForDeviceOnline

    public void waitForDeviceOnline (long waitTime)

    デバイスが adb 経由で検出されるまでブロックします。

    完了時にデバイスが必ずしもコマンドに反応するとは限りません。代わりに waitForDeviceAvailable() を使用してください。

    パラメータ
    waitTime long: 待機時間(ミリ秒)

    例外
    DeviceNotAvailableException

    waitForDeviceShell

    public boolean waitForDeviceShell (long waitTime)

    デバイスが基本的な adb shell コマンドに応答するまで待ちます。

    パラメータ
    waitTime long: 待機時間(ミリ秒)

    戻り値
    boolean waitTime が経過する前にデバイスが応答した場合は true

    保護されたメソッド

    addExtraConnectionBuilderArgs

    protected void addExtraConnectionBuilderArgs (DefaultConnection.ConnectionBuilder builder)

    パラメータ
    builder DefaultConnection.ConnectionBuilder

    buildAdbShellCommand

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

    指定された adb シェルコマンド セッションと引数用の OS コマンドをビルドします。

    パラメータ
    command String

    forceExitStatusDetection boolean

    戻り値
    String[]

    checkApiLevelAgainst

    protected void checkApiLevelAgainst (String feature, 
                    int strictMinLevel)

    パラメータ
    feature String

    strictMinLevel int

    createRebootDeviceAction

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

    再起動アクションの実行時に使用する RebootDeviceAction を作成します。

    パラメータ
    rebootMode NativeDevice.RebootMode: この再起動のモード。

    reason String: この再起動用。

    戻り値
    NativeDevice.RebootDeviceAction 作成された RebootDeviceAction

    createRunUtil

    protected IRunUtil createRunUtil ()

    戻り値
    IRunUtil

    doAdbReboot

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

    adb で再起動します。

    パラメータ
    rebootMode NativeDevice.RebootMode: この再起動のモード。

    reason String: この再起動用。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    ensureRuntimePermissionSupported

    protected void ensureRuntimePermissionSupported ()

    実行時の権限がサポートされていない場合に例外をスローするヘルパー メソッド

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    getApiLevelSafe

    protected int getApiLevelSafe ()

    戻り値
    int

    getLogger

    protected ITestLogger getLogger ()

    戻り値
    ITestLogger

    getRunUtil

    protected IRunUtil getRunUtil ()

    使用する RunUtil インスタンスを取得します。

    戻り値
    IRunUtil

    initializeConnection

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

    パラメータ
    info IBuildInfo

    attributes MultiMap

    例外
    DeviceNotAvailableException
    TargetSetupError

    internalGetProperty

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

    デフォルトでは ddmlib キャッシュからデバイス プロパティを取得し、デバイスが Fastboot モードかどうかに応じて「adb shell getprop」または「fastboot getvar」にフォールバックします。

    パラメータ
    propName String: 「adb shell getprop」によって返されるデバイス プロパティの名前

    fastbootVar String: クエリする同等の fastboot 変数の名前。null の場合、fastboot クエリは試行されません。

    description String: 変数の簡単な説明。最初の文字は大文字にする必要があります。

    戻り値
    String 指定されたプロパティの値を含む文字列(null または空の文字列を含む)

    例外
    DeviceNotAvailableException

    isInRebootCallback

    protected boolean isInRebootCallback ()

    現在再起動コールバックが実行されているかどうかを返します。true の場合、再起動用のすべての公開 API を無効にする必要があります。

    戻り値
    boolean

    isNewer

    protected boolean isNewer (File localFile, 
                    IFileEntry entry)

    ローカル ファイルがリモート ファイルより新しい場合は true を返します。IFileEntry は分単位で正確です。複数の時刻が同じ場合、ファイルは新しいファイルとみなされます。

    パラメータ
    localFile File

    entry IFileEntry

    戻り値
    boolean

    notifyRebootEnded

    protected void notifyRebootEnded ()

    再起動終了イベントをすべての IDeviceActionReceiver に通知します。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    notifyRebootStarted

    protected void notifyRebootStarted ()

    再起動開始イベントをすべての IDeviceActionReceiver に通知します。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    performDeviceAction

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

    このデバイスでアクションを実行します。デバイスの復元を試行し、アクションが失敗した場合は必要に応じてコマンドを再試行します。

    パラメータ
    actionDescription String: 実行されるアクションの簡単な説明。ロギング目的でのみ使用されます。

    action NativeDevice.DeviceAction: 実行するアクション

    retryAttempts int: 操作が失敗したが復元に成功した場合に、操作を再試行する回数

    戻り値
    boolean true: アクションが正常に完了した場合

    例外
    DeviceNotAvailableException 復元の試行が失敗した場合、または最大回数の試行を行ったにもかかわらず成功しなかった場合

    postAdbReboot

    protected void postAdbReboot ()

    再起動後に実行できる追加のアクション。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    prePostBootSetup

    protected void prePostBootSetup ()

    各デバイスタイプ(AndroidNativeDevice、TestDevice)が、起動後の特定の設定のためにこのメソッドをオーバーライドできるようにします。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    pullFileInternal

    protected boolean pullFileInternal (String remoteFilePath, 
                    File localFile)

    パラメータ
    remoteFilePath String

    localFile File

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    setClock

    protected void setClock (Clock clock)

    使用する Clock インスタンスを設定します。

    パラメータ
    clock Clock

    setMicrodroidProcess

    protected void setMicrodroidProcess (Process process)

    TestDevice を microdroid としてマークし、その CID を設定します。

    パラメータ
    process Process: Microdroid VM のプロセス。

    setTestDeviceOptions

    protected void setTestDeviceOptions ( deviceOptions)

    パラメータ
    deviceOptions

    simpleFastbootCommand

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

    環境変数を使用して単純な fastboot コマンドを実行し、コマンドのステータスを報告します。

    パラメータ
    timeout long

    envVarMap

    fullCmd String

    戻り値
    CommandResult

    simpleFastbootCommand

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

    シンプルな fastboot コマンドを実行し、コマンドのステータスを報告します。

    パラメータ
    timeout long

    fullCmd String

    戻り値
    CommandResult

    waitForDeviceNotAvailable

    protected boolean waitForDeviceNotAvailable (String operationDesc, 
                    long time)

    デバイスが使用できなくなるまで待ちます(adb への報告を停止します)。

    パラメータ
    operationDesc String: 使用不可を待機しているオペレーションの名前。

    time long: 使用不可になるまで待機する時間。

    戻り値
    boolean デバイスが使用できなくなった場合は true。