ITestDevice

public interface ITestDevice
implements INativeDevice

com.android.tradefed.device.ITestDevice

ddmlib IDevice に信頼性が高く、少し高レベルの API を提供します。

設定可能な回数だけデバイス コマンドを再試行し、応答しないデバイスにデバイス復元インターフェースを提供します。

概要

ネストされたクラス

class ITestDevice.ApexInfo

単一の APEX に関する情報を保存するシンプルな構造体クラス
class ITestDevice.MountPointInfo

単一のマウントポイントに関する情報を格納するシンプルな構造体クラス

パブリック メソッド

abstract boolean canSwitchToHeadlessSystemUser()

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

abstract boolean checkConnectivity()

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

abstract boolean clearErrorDialogs()

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

abstract void clearLastConnectedWifiNetwork()

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

abstract boolean connectToWifiNetwork( wifiSsidToPsk)

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

abstract boolean connectToWifiNetwork( wifiSsidToPsk, boolean scanSsid)

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

abstract boolean connectToWifiNetwork(String wifiSsid, String wifiPsk)

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

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

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

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

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

abstract boolean connectToWifiNetworkIfNeeded(String wifiSsid, String wifiPsk)

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

abstract int createUser(String name)

指定された名前とデフォルトのフラグ 0 を持つユーザーを作成します。
abstract int createUser(String name, boolean guest, boolean ephemeral)

指定の名前と指定されたフラグを使用してユーザーを作成する
abstract int createUser(String name, boolean guest, boolean ephemeral, boolean forTesting)

指定された名前と指定されたフラグを持つユーザーを作成します。
abstract int createUserNoThrow(String name)

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

登録済みの IDeviceActionReceiver を削除します。
abstract void disableKeyguard()

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

abstract boolean disableNetworkMonitor()

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

abstract boolean disconnectFromWifi()

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

abstract boolean doesFileExist(String deviceFilePath, int userId)

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

abstract File dumpHeap(String process, String devicePath)

system_server からヒープダンプを試みます。

abstract boolean enableNetworkMonitor()

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

abstract getActiveApexes()

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

abstract getAllSettings(String namespace)

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

abstract String getAndroidId(int userId)

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

abstract getAndroidIds()

一致するユーザー ID が見つかった Android ID のマップを作成します。

abstract PackageInfo getAppPackageInfo(String packageName)

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

abstract getAppPackageInfos()

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

abstract InputStreamSource getBugreport()

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

abstract InputStreamSource getBugreportz()

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

abstract DeviceFoldableState getCurrentFoldableState()

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

abstract int getCurrentUser()

現在実行中のユーザーの ID を返します。

abstract getFoldableStates()

デバイス上の折りたたみ式デバイスの状態のリストを返します。

abstract getInstalledPackageNames()

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

abstract String getIpAddress()

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

abstract KeyguardControllerState getKeyguardState()

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

abstract Integer getMainUserId()

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

abstract getMainlineModuleInfo()

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

abstract int getMaxNumberOfRunningUsersSupported()

同時に実行できるユーザーの最大数を取得します。

abstract int getMaxNumberOfUsersSupported()

サポートされているユーザーの最大数を取得します。
abstract TestDeviceOptions getOptions()

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

abstract Integer getPrimaryUserId()

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

abstract InputStreamSource getScreenshot(String format, boolean rescale)

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

abstract InputStreamSource getScreenshot(long displayId)

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

abstract InputStreamSource getScreenshot(String format)

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

abstract InputStreamSource getScreenshot()

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

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

リクエストされた設定の値を返します。

abstract String getSetting(String namespace, String key)

getSetting(int, String, String) を参照し、システム ユーザーに対して実行されます。

abstract getUninstallablePackageNames()

アンインストール可能なアプリのパッケージ名を取得します。

abstract int getUserFlags(int userId)

指定したユーザーのフラグを検索して返します。

abstract getUserInfos()

デバイス上の useId と UserInfo のマップを取得します。

abstract int getUserSerialNumber(int userId)

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

abstract boolean hasFeature(String feature)

機能がデバイスで利用できるかどうかを確認します。

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

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

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

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

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

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

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

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

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

複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。

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

Android デバイスに存在する複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。

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

特定のユーザーに対して、複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。

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

特定のユーザーに対して、複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。

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

Android デバイス上にある複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。

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

Android デバイスに存在する複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。

abstract boolean isHeadlessSystemUserMode()

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

abstract boolean isMainUserPermanentAdmin()

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

abstract boolean isMultiUserSupported()

マルチユーザーがサポートされているかどうかを判断します。

abstract boolean isPackageInstalled(String packageName, String userId)

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

abstract boolean isPackageInstalled(String packageName)

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

abstract boolean isUserRunning(int userId)

特定のユーザーが実行中かどうかを確認します。

abstract boolean isUserSecondary(int userId)

フラグに従って、指定したユーザーがセカンダリ ユーザーかどうかを返します。

abstract boolean isUserVisible(int userId)

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

abstract boolean isUserVisibleOnDisplay(int userId, int displayId)

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

abstract boolean isVisibleBackgroundUsersOnDefaultDisplaySupported()

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

abstract boolean isVisibleBackgroundUsersSupported()

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

abstract boolean isWifiEnabled()

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

abstract listDisplayIds()

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

abstract listDisplayIdsForStartingVisibleBackgroundUsers()

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

abstract listUsers()

デバイス上のユーザーのリストを取得します。

abstract boolean logBugreport(String dataName, ITestLogger listener)

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

default void notifySnapuserd(SnapuserdWaitPhase waitPhase)

snapuserd の完了を待つようデバイスに通知します。

abstract void registerDeviceActionReceiver(IDeviceActionReceiver deviceActionReceiver)

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

abstract boolean removeAdmin(String componentName, int userId)

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

abstract void removeOwners()

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

abstract boolean removeUser(int userId)

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

abstract boolean setDeviceOwner(String componentName, int userId)

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

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

setSetting(int, String, String, String) を参照し、システム ユーザーに対して実行されます。

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

特定のユーザーの Namespace に設定値を追加します。
abstract boolean startUser(int userId)

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

abstract boolean startUser(int userId, boolean waitFlag)

特定のユーザーが現在停止している場合に、バックグラウンドで起動します。

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

特定のディスプレイに表示されているバックグラウンドで特定のユーザーを開始します（つまり、ユーザーがそのディスプレイでアクティビティを起動できるようにします）。

abstract boolean stopUser(int userId)

特定のユーザーを停止します。

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

特定のユーザーを停止します。

abstract boolean switchUser(int userId)

デフォルトのタイムアウトで別の userId に切り替えます。

abstract boolean switchUser(int userId, long timeout)

指定されたタイムアウトを期限として、別の userId に切り替えます。

abstract Bugreport takeBugreport()

バグレポートを受け取り、Bugreport オブジェクト内に返して処理します。

abstract String uninstallPackage(String packageName)

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

abstract String uninstallPackageForUser(String packageName, int userId)

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

default void waitForSnapuserd(SnapuserdWaitPhase currentPhase)

予想される場合は、snapuserd が完了するまで待ちます。

パブリック メソッド

canSwitchToHeadlessSystemUser

public abstract boolean canSwitchToHeadlessSystemUser ()

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

戻り値
boolean

例外
DeviceNotAvailableException

checkConnectivity

public abstract boolean checkConnectivity ()

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

戻り値
boolean true: デバイスがネットワークに接続されている場合。false: それ以外の場合。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

clearErrorDialogs

public abstract boolean clearErrorDialogs ()

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

戻り値
boolean ダイアログが存在しないか、ダイアログが正常に消去された場合は true。それ以外の場合は false。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

clearLastConnectedWifiNetwork

public abstract void clearLastConnectedWifiNetwork ()

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

connectToWifiNetwork

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk, 
                boolean scanSsid)

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

パラメータ
scanSsid boolean: このネットワークの非表示の SSID をスキャンするかどうか
戻り値
boolean true: Wi-Fi ネットワークに正常に接続した場合。それ以外の場合は false
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

connectToWifiNetworkIfNeeded

public abstract boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk)

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

戻り値
boolean true: Wi-Fi ネットワークに正常に接続した場合。それ以外の場合は false
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

createUser

public abstract int createUser (String name)

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

パラメータ
name String: デバイスに作成するユーザーの
戻り値
int 作成されたユーザー ID の整数
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

createUser

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

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

パラメータ
name String: デバイスに作成するユーザーの
guest boolean: 作成時にユーザーフラグ --guest を有効にする
ephemeral boolean: 作成時にユーザーフラグ --ephemeral を有効にする
戻り値
int 作成されたユーザーの ID
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

createUser

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

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

パラメータ
name String: デバイスに作成するユーザーの
guest boolean: 作成時にユーザーフラグ --guest を有効にする
ephemeral boolean: 作成時にユーザーフラグ --ephemeral を有効にする
forTesting boolean: 作成時にテストフラグ --for-testing を有効にする
戻り値
int 作成されたユーザーの ID
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

createUserNoThrow

public abstract int createUserNoThrow (String name)

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

パラメータ
name String: デバイスに作成するユーザーの
戻り値
int 作成されたユーザー ID の整数値、またはエラーの場合は -1。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

deregisterDeviceActionReceiver

public abstract void deregisterDeviceActionReceiver (IDeviceActionReceiver deviceActionReceiver)

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

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

disableKeyguard

public abstract void disableKeyguard ()

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

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

例外
DeviceNotAvailableException

disableNetworkMonitor

public abstract boolean disableNetworkMonitor ()

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

戻り値
boolean モニタリングが無効にされた場合は true。false （失敗した場合）。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

disconnectFromWifi

public abstract boolean disconnectFromWifi ()

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

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

戻り値
boolean Wi-Fi ネットワークから正常に切断された場合は true。false: 接続解除に失敗した場合。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

doesFileExist

public abstract boolean doesFileExist (String deviceFilePath, 
                int userId)

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

パラメータ
deviceFilePath String: 確認するデバイス上のファイルの絶対パス
userId int: ファイルの存在を確認するユーザー ID
戻り値
boolean ファイルが存在する場合は true、存在しない場合は false。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

ダンプヒープ

public abstract File dumpHeap (String process, 
                String devicePath)

system_server からヒープダンプを試みます。ダンプされたファイルのクリーンアップは、呼び出し元が行います。

パラメータ
process String: ダンプヒープするデバイス プロセスの名前。
devicePath String: ダンプを作成するデバイス上のパス。権限が許可されている場所にする必要があります。
戻り値
File レポートを含む ERROR(/File)。エラーが発生した場合は null。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

enableNetworkMonitor

public abstract boolean enableNetworkMonitor ()

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

戻り値
boolean モニタリングが正常に有効になっている場合は true。false （失敗した場合）。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

getActiveApexes

public abstract  getActiveApexes ()

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

戻り値
ApexInfo 個中 ERROR(/Set) 個がデバイスで現在有効です
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAllSettings

public abstract  getAllSettings (String namespace)

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

パラメータ
namespace String: {"system"、"secure"、"global"} のいずれかにする必要があります
戻り値
Key-Value ペアのマップですNamespace がサポートされていない場合は null。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAndroidId

public abstract String getAndroidId (int userId)

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

パラメータ
userId int

戻り値
String

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

getAndroidIds

public abstract  getAndroidIds ()

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

戻り値
一致するユーザー ID が見つかった Android ID のマップ。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAppPackageInfo

public abstract PackageInfo getAppPackageInfo (String packageName)

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

パラメータ
packageName String

戻り値
PackageInfo PackageInfo（情報を取得できなかった場合）または null
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getAppPackageInfos

public abstract  getAppPackageInfos ()

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

戻り値
デバイスにインストールされている PackageInfo の ERROR(/List)。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBugreport

public abstract InputStreamSource getBugreport ()

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

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

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

getBugreportz

public abstract InputStreamSource getBugreportz ()

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

「adb version」が 1.0.36 より大きい場合にのみサポートされます。

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

getCurrentFoldableState

public abstract DeviceFoldableState getCurrentFoldableState ()

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

戻り値
DeviceFoldableState

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

getCurrentUser

public abstract int getCurrentUser ()

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

戻り値
int

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

getFoldableStates

public abstract  getFoldableStates ()

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

戻り値
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getInstalledPackageNames

public abstract  getInstalledPackageNames ()

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

戻り値
現在デバイスにインストールされている String 個のパッケージ名のうち ERROR(/Set) 個。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getIpAddress

public abstract String getIpAddress ()

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

戻り値
String デバイスの IP アドレス。デバイスに IP アドレスがない場合は null
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

getKeyguardState

public abstract KeyguardControllerState getKeyguardState ()

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

戻り値
KeyguardControllerState キーガード状態のスナップショットを含む KeyguardControllerState。キーガード クエリがサポートされていない場合は Null を返します。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

getMainUserId

public abstract Integer getMainUserId ()

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

戻り値
Integer メインユーザーの userId（メインユーザーが存在する場合）。メインユーザーが存在しない場合、null。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceRuntimeException デバイスの出力が想定どおりでない場合は、
DeviceNotAvailableException

getMainlineModuleInfo

public abstract  getMainlineModuleInfo ()

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

戻り値
デバイスに現在インストールされている String Mainline モジュールの ERROR(/Set)。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getMaxNumberOfRunningUsersSupported

public abstract int getMaxNumberOfRunningUsersSupported ()

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

戻り値
int 同時に実行されるユーザー数を示す整数
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getMaxNumberOfUsersSupported

public abstract int getMaxNumberOfUsersSupported ()

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

戻り値
int サポートされているユーザー数を示す整数
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getOptions

public abstract TestDeviceOptions getOptions ()

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

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

getPrimaryUserId

public abstract Integer getPrimaryUserId ()

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

戻り値
Integer メインユーザーの userId（存在する場合）。メインユーザーが存在しない場合、null。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceRuntimeException デバイスからの出力が想定どおりでない場合は、
DeviceNotAvailableException

getScreenshot

public abstract InputStreamSource getScreenshot (String format, 
                boolean rescale)

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

パラメータ
format String: サポートされている PNG、JPEG
rescale boolean: 結果の画像のサイズを小さくするためにスクリーンショットのサイズを変更するかどうか
戻り値
InputStreamSource スクリーンショットの InputStreamSource（形式）、またはスクリーンショットが成功しなかった場合は null。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getScreenshot

public abstract InputStreamSource getScreenshot (long displayId)

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

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

パラメータ
displayId long: スクリーンショットを取得する画面のディスプレイ ID。
戻り値
InputStreamSource 形式で指定したスクリーンショットの InputStreamSource。スクリーンショットが成功しなかった場合は null。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getScreenshot

public abstract InputStreamSource getScreenshot (String format)

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

パラメータ
format String: サポートされている PNG、JPEG
戻り値
InputStreamSource スクリーンショットの InputStreamSource（形式）、またはスクリーンショットが正常に取得されなかった場合は null。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getScreenshot

public abstract InputStreamSource getScreenshot ()

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

戻り値
InputStreamSource スクリーンショットの InputStreamSource（PNG 形式）。スクリーンショットが正常に取得されなかった場合は null。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getSetting

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

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

パラメータ
userId int

namespace String

key String

戻り値
String ユーザーの namespace:key に関連付けられた値。見つからない場合は null。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getSetting

public abstract String getSetting (String namespace, 
                String key)

getSetting(int, String, String) を参照し、システム ユーザーに対して実行されます。

パラメータ
namespace String

key String

戻り値
String

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

getUninstallablePackageNames

public abstract  getUninstallablePackageNames ()

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

戻り値
デバイスに現在インストールされている、アンインストール不可の String パッケージ名の ERROR(/Set)。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getUserFlags

public abstract int getUserFlags (int userId)

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

パラメータ
userId int

戻り値
int 指定された userId に関連付けられているフラグ（見つかった場合）、それ以外の場合は -10000。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getUserInfos

public abstract  getUserInfos ()

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

戻り値
UserInfo オブジェクトのリスト。
例外
com.android.tradefed.device.DeviceNotAvailableException
com.android.tradefed.device.DeviceRuntimeException
DeviceNotAvailableException

getUserSerialNumber

public abstract int getUserSerialNumber (int userId)

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

パラメータ
userId int

戻り値
int

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

hasFeature

public abstract boolean hasFeature (String feature)

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

パラメータ
feature String: 形式は「feature:」または「」にする必要があります。
戻り値
boolean 特徴が見つかった場合は true、見つからなかった場合は false。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

installPackage

public abstract 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 abstract 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 デバイスとの接続が失われ、復元できない場合。
UnsupportedOperationException デバイス上のプラットフォームで実行時権限がサポートされていない場合。

installPackageForUser

public abstract 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 abstract 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 デバイスとの接続が失われ、復元できない場合。
UnsupportedOperationException デバイス上のプラットフォームで実行時権限がサポートされていない場合。

installPackages

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

複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。APK を複数のファイルに分割する方法については、「https://developer.android.com/studio/build/configure-apk-splits」をご覧ください。

パラメータ
packageFiles : ローカル APK ファイル
reinstall boolean: 再インストールが必要な場合は true
extraArgs String: 渡す追加の引数（省略可）。使用可能なオプションについては、「adb shell pm -h」をご覧ください。
戻り値
String エラーコードを含む String、または成功した場合は null。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。
UnsupportedOperationException デバイス上のプラットフォームで実行時権限がサポートされていない場合。

installPackages

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

Android デバイスに存在する複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリケーションをインストールします。APK を複数のファイルに分割する方法については、「https://developer.android.com/studio/build/configure-apk-splits」をご覧ください。

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

パラメータ
packageFiles : インストールするリモート APK ファイルのパス
reinstall boolean: 再インストールが必要な場合は true
grantPermissions boolean: すべてのランタイム パーミッションをインストール時に付与する必要があるかどうか
extraArgs String: 渡す追加の引数（省略可）。使用可能なオプションについては、「adb shell pm -h」をご覧ください。
戻り値
String エラーコードを含む String。成功した場合は null。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。
UnsupportedOperationException デバイス上のプラットフォームで実行時権限がサポートされていない場合。

installPackagesForUser

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

特定のユーザー用に、複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。APK を複数のファイルに分割する方法については、「https://developer.android.com/studio/build/configure-apk-splits」をご覧ください。

パラメータ
packageFiles : ローカル APK ファイル
reinstall boolean: 再インストールが必要な場合は true
userId int: インストール対象のユーザー ID（整数）。
extraArgs String: 渡す追加の引数（省略可）。使用可能なオプションについては、「adb shell pm -h」をご覧ください。
戻り値
String エラーコードを含む String。成功した場合は null。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。
UnsupportedOperationException デバイス上のプラットフォームで実行時権限がサポートされていない場合。

installPackagesForUser

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

特定のユーザーに対して、複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。apk を複数のファイルに分割する方法については、https://developer.android.com/studio/build/configure-apk-splits をご覧ください。

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

パラメータ
packageFiles : ローカル APK ファイル
reinstall boolean: 再インストールが必要な場合は true
grantPermissions boolean: すべてのランタイム パーミッションをインストール時に付与する必要があるかどうか
userId int: インストールするユーザー ID（整数）。
extraArgs String: 渡す追加の引数（省略可）。使用可能なオプションについては、「adb shell pm -h」をご覧ください。
戻り値
String エラーコードを含む String、または成功した場合は null。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。
UnsupportedOperationException デバイス上のプラットフォームで実行時権限がサポートされていない場合。

installRemotePackages

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

Android デバイス上にある複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリをインストールします。APK を複数のファイルに分割する方法については、「https://developer.android.com/studio/build/configure-apk-splits」をご覧ください。

パラメータ
remoteApkPaths : リモート APK ファイルパス
reinstall boolean: 再インストールが必要な場合は true
extraArgs String: 渡す追加の引数（省略可）。使用可能なオプションについては、「adb shell pm -h」をご覧ください。
戻り値
String エラーコードを含む String、または成功した場合は null。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。
UnsupportedOperationException デバイス上のプラットフォームで実行時権限がサポートされていない場合。

installRemotePackages

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

Android デバイスに存在する複数の APK ファイル（1 つのメイン パッケージと追加の分割パッケージ）で構成された Android アプリケーションをインストールします。apk を複数のファイルに分割する方法については、https://developer.android.com/studio/build/configure-apk-splits をご覧ください。

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

パラメータ
remoteApkPaths : リモート APK ファイルパス
reinstall boolean: 再インストールが必要な場合は true
grantPermissions boolean: すべてのランタイム パーミッションをインストール時に付与する必要があるかどうか
extraArgs String: 渡す追加の引数（省略可）。使用可能なオプションについては、「adb shell pm -h」をご覧ください。
戻り値
String エラーコードを含む String。成功した場合は null。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。
UnsupportedOperationException デバイス上のプラットフォームで実行時権限がサポートされていない場合。

isHeadlessSystemUserMode

public abstract boolean isHeadlessSystemUserMode ()

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

戻り値
boolean

例外
DeviceNotAvailableException

isMainUserPermanentAdmin

public abstract boolean isMainUserPermanentAdmin ()

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

戻り値
boolean

例外
DeviceNotAvailableException

isMultiUserSupported

public abstract boolean isMultiUserSupported ()

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

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

isPackageInstalled

public abstract boolean isPackageInstalled (String packageName, 
                String userId)

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

パラメータ
packageName String: インストールされているかどうかを確認するパッケージ。
userId String: パッケージがインストールされているユーザー ID。null の場合、メインユーザー 0 が使用されます。
戻り値
boolean パッケージがインストール済みとして報告されている場合は true です。それ以外の場合は False です。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

isPackageInstalled

public abstract boolean isPackageInstalled (String packageName)

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

パラメータ
packageName String

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

isUserRunning

public abstract boolean isUserRunning (int userId)

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

パラメータ
userId int

戻り値
boolean ユーザーが実行中の場合は true、それ以外の場合は false。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

isUserSecondary

public abstract boolean isUserSecondary (int userId)

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

パラメータ
userId int

戻り値
boolean ユーザーがセカンダリである場合は true、そうでない場合は false。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

isUserVisible

public abstract boolean isUserVisible (int userId)

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

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

パラメータ
userId int

戻り値
boolean

例外
DeviceNotAvailableException

isUserVisibleOnDisplay

public abstract boolean isUserVisibleOnDisplay (int userId, 
                int displayId)

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

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

パラメータ
userId int

displayId int

戻り値
boolean

例外
DeviceNotAvailableException

isVisibleBackgroundUsersOnDefaultDisplaySupported

public abstract boolean isVisibleBackgroundUsersOnDefaultDisplaySupported ()

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

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

戻り値
boolean

例外
DeviceNotAvailableException

isVisibleBackgroundUsersSupported

public abstract boolean isVisibleBackgroundUsersSupported ()

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

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

戻り値
boolean

例外
DeviceNotAvailableException

isWifiEnabled

public abstract boolean isWifiEnabled ()

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

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

戻り値
boolean Wi-Fi が有効な場合は true。false（無効の場合）
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

listDisplayIds

public abstract  listDisplayIds ()

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

戻り値
ディスプレイのリスト。デフォルトでは、常にデフォルトの表示 0 が返されます。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

listDisplayIdsForStartingVisibleBackgroundUsers

public abstract  listDisplayIdsForStartingVisibleBackgroundUsers ()

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

戻り値
例外
DeviceNotAvailableException

listUsers

public abstract  listUsers ()

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

戻り値
ユーザー ID のリスト。
例外
com.android.tradefed.device.DeviceNotAvailableException
com.android.tradefed.device.DeviceRuntimeException
DeviceNotAvailableException

ログバグレポート

public abstract boolean logBugreport (String dataName, 
                ITestLogger listener)

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

パラメータ
dataName String: バグレポートが報告される名前。
listener ITestLogger: バグレポートをログに記録する ITestLogger。
戻り値
boolean ロギングが成功した場合は true、それ以外の場合は false。

notifySnapuserd

public void notifySnapuserd (SnapuserdWaitPhase waitPhase)

snapuserd の完了を待つようデバイスに通知します。

パラメータ
waitPhase SnapuserdWaitPhase

registerDeviceActionReceiver

public abstract void registerDeviceActionReceiver (IDeviceActionReceiver deviceActionReceiver)

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

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

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

removeAdmin

public abstract boolean removeAdmin (String componentName, 
                int userId)

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

パラメータ
componentName String: 削除するデバイス管理者の ID。
userId int: デバイス管理者が存在するユーザー。
戻り値
boolean 成功した場合は true、失敗した場合は false。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

removeOwners

public abstract void removeOwners ()

既存のデバイス プロファイル所有者をすべて削除します。

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

removeUser

public abstract boolean removeUser (int userId)

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

パラメータ
userId int: 削除するユーザーの
戻り値
boolean ユーザーの削除に成功した場合は true、それ以外の場合は false。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

setDeviceOwner

public abstract boolean setDeviceOwner (String componentName, 
                int userId)

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

パラメータ
componentName String: デバイス管理者がデバイスのオーナーになる。
userId int: デバイス所有者が居住している国または地域のユーザー。
戻り値
boolean 成功した場合は true、失敗した場合は false。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

setSetting

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

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

パラメータ
namespace String

key String

value String

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

setSetting

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

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

パラメータ
userId int

namespace String

key String

value String

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

startUser

public abstract boolean startUser (int userId)

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

パラメータ
userId int: バックグラウンドで起動するユーザー
戻り値
boolean ユーザーがバックグラウンドで正常に開始された場合は true。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

startUser

public abstract boolean startUser (int userId, 
                boolean waitFlag)

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

パラメータ
userId int: バックグラウンドで起動するユーザー
waitFlag boolean: ユーザーが起動してロックが解除されるまでコマンドを待機させます。
戻り値
boolean ユーザーがバックグラウンドで正常に開始された場合は true。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

startVisibleBackgroundUser

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

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

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

パラメータ
userId int: バックグラウンドで起動するユーザー
displayId int: 開始ユーザーを表示するディスプレイ
waitFlag boolean: ユーザーが起動してロックが解除されるまでコマンドを待機します。
戻り値
boolean true: ユーザーがバックグラウンドで正常に起動された場合。
例外
DeviceNotAvailableException

stopUser

public abstract boolean stopUser (int userId)

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

パラメータ
userId int: 停止するユーザー。
戻り値
boolean ユーザーが正常に停止された場合は true。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

stopUser

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

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

パラメータ
userId int: 停止するユーザーの。
waitFlag boolean: ユーザーが停止するまでコマンドを待機します。
forceFlag boolean: ユーザーを強制停止します。
戻り値
boolean ユーザーが正常に停止された場合は true。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

switchUser

public abstract boolean switchUser (int userId)

デフォルトのタイムアウトを使用して別の userId に切り替える。switchUser(int, long)。

パラメータ
userId int

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

switchUser

public abstract boolean switchUser (int userId, 
                long timeout)

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

パラメータ
userId int

timeout long: ユーザーの切り替えが失敗した場合に false を返すまで待機します。
戻り値
boolean 新しい userId が userId プロバイダと一致する場合は true。それ以外の場合は False です。
例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

takeBugreport

public abstract Bugreport takeBugreport ()

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

戻り値
Bugreport

uninstallPackage

public abstract String uninstallPackage (String packageName)

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

パラメータ
packageName String: アンインストールする Android パッケージ
戻り値
String エラーコードを含む String、または成功した場合は null。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

uninstallPackageForUser

public abstract String uninstallPackageForUser (String packageName, 
                int userId)

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

パラメータ
packageName String: アンインストールする Android パッケージ
userId int: アンインストールするユーザー ID（整数）。
戻り値
String エラーコードを含む String、または成功した場合は null。
例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

waitForSnapuserd

public void waitForSnapuserd (SnapuserdWaitPhase currentPhase)

予想される場合は、snapuserd が完了するまで待ちます。

パラメータ
currentPhase SnapuserdWaitPhase

例外
DeviceNotAvailableException