Google s'est engagé à promouvoir l'équité raciale pour les communautés noires. Regarde comment.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

NativeDevice

public class NativeDevice
extends Object implements IManagedTestDevice

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


ITestDevice par défaut d'un appareil Android ITestDevice Non-full stack.

Résumé

Classes imbriquées

class NativeDevice.AdbAction

Un DeviceAction pour exécuter une commande du système d'exploitation 'adb ....'.

class NativeDevice.AdbShellAction

class NativeDevice.RebootDeviceAction

DeviceAction pour redémarrer un appareil.

Constantes

int INVALID_USER_ID

Valeur renvoyée pour tout ID utilisateur invalide / introuvable: UserHandle a défini la valeur -10000

long MAX_HOST_DEVICE_TIME_OFFSET

int MAX_RETRY_ATTEMPTS

le nombre par défaut de nouvelles tentatives de commande à effectuer

Des champs

protected TestDeviceOptions mOptions

protected final IDeviceStateMonitor mStateMonitor

Constructeurs publics

NativeDevice (IDevice device, IDeviceStateMonitor stateMonitor, IDeviceMonitor allocationMonitor)

Crée un TestDevice .

Méthodes publiques

boolean checkApiLevelAgainstNextRelease (int strictMinLevel)

Vérifiez si une fonctionnalité est actuellement prise en charge en fonction d'un niveau minimal pris en charge.

boolean checkConnectivity ()

Vérifiez que l'appareil dispose d'une connectivité réseau.

boolean clearErrorDialogs ()

Essayez de fermer toutes les boîtes de dialogue d'erreur actuellement affichées sur l'interface utilisateur de l'appareil.

void clearLastConnectedWifiNetwork ()

Efface le dernier réseau wifi connecté.

void clearLogcat ()

Supprime toutes les données logcat accumulées.

boolean connectToWifiNetwork (String wifiSsid, String wifiPsk)

Se connecte à un réseau wifi.

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

Se connecte à un réseau wifi.

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

Une variante de connectToWifiNetwork(String, String) qui se connecte uniquement si le périphérique n'a actuellement pas de connectivité réseau.

boolean connectToWifiNetworkIfNeeded (String wifiSsid, String wifiPsk)

Une variante de connectToWifiNetwork(String, String) qui se connecte uniquement si le périphérique n'a actuellement pas de connectivité réseau.

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

Créer un utilisateur avec un nom donné et les indicateurs fournis

int createUser (String name)

Créez un utilisateur avec un nom donné et des indicateurs par défaut 0.

int createUserNoThrow (String name)

Créez un utilisateur avec un nom donné et des indicateurs par défaut 0.

void deleteFile (String deviceFilePath)

Méthode d'assistance pour supprimer un fichier ou un répertoire sur l'appareil.

boolean disableAdbRoot ()

Désactive adb root.

void disableKeyguard ()

Tente de désactiver le keyguard.

boolean disableNetworkMonitor ()

Désactive la surveillance du réseau sur l'appareil.

boolean disconnectFromWifi ()

Se déconnecte d'un réseau wifi.

boolean doesFileExist (String deviceFilePath)

Méthode d'assistance pour déterminer si le fichier sur l'appareil existe.

File dumpHeap (String process, String devicePath)

Essayez de vider le tas du serveur_système.

boolean enableAdbRoot ()

Active adb root.

boolean enableNetworkMonitor ()

Active la surveillance du réseau sur l'appareil.

boolean encryptDevice (boolean inplace)

Crypte l'appareil.

String executeAdbCommand (String... cmdArgs)

Méthode d'assistance qui exécute une commande adb en tant que commande système.

CommandResult executeFastbootCommand (String... cmdArgs)

Méthode d'assistance qui exécute une commande fastboot en tant que commande système avec un délai d'expiration par défaut de 2 minutes.

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

Méthode d'assistance qui exécute une commande fastboot en tant que commande système.

CommandResult executeLongFastbootCommand (String... cmdArgs)

Méthode d'assistance qui exécute une commande fastboot de longue durée en tant que commande système.

String executeShellCommand (String command)

Méthode d'assistance qui exécute une commande adb shell et renvoie la sortie sous forme de String .

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

void executeShellCommand (String command, IShellOutputReceiver receiver)

Exécute la commande adb shell donnée, en réessayant plusieurs fois si la commande échoue.

CommandResult executeShellV2Command (String cmd)

Méthode d'assistance qui exécute une commande adb shell et renvoie les résultats sous la forme d'un CommandResult correctement CommandResult avec la sortie d'état de la commande, stdout et stderr.

CommandResult executeShellV2Command (String cmd, OutputStream pipeToOutput)

Méthode d'assistance qui exécute une commande adb shell et renvoie les résultats sous la forme d'un CommandResult correctement CommandResult avec la sortie d'état de la commande, stdout et stderr.

CommandResult executeShellV2Command (String cmd, File pipeAsInput)

Méthode d'assistance qui exécute une commande adb shell et renvoie les résultats sous la forme d'un CommandResult correctement CommandResult avec la sortie d'état de la commande, stdout et stderr.

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

CommandResult fastbootWipePartition (String partition)

Méthode d'assistance qui efface une partition pour le périphérique.

getActiveApexes ()

Récupérez les informations sur les APEX activés sur l'appareil.

getAllSettings (String namespace)

Renvoie les paires clé / valeur de l'espace de noms demandé.

DeviceAllocationState getAllocationState ()

Renvoie l'état d'allocation actuel de l'appareil

String getAndroidId (int userId)

Trouvez et renvoyez l'id-android associé à un userId, nul s'il n'est pas trouvé.

getAndroidIds ()

Créez une carte des identifiants Android trouvés.

int getApiLevel ()

Obtenez le niveau d'API de l'appareil.

PackageInfo getAppPackageInfo (String packageName)

Récupérez des informations sur un package installé sur l'appareil.

String getBasebandVersion ()

Méthode pratique pour obtenir la version bande de base (radio) de cet appareil.

Integer getBattery ()

Renvoie le niveau de batterie actuel d'un appareil ou Null si le niveau de batterie n'est pas disponible.

String getBootloaderVersion ()

Méthode pratique pour obtenir la version du chargeur de démarrage de cet appareil.

InputStreamSource getBugreport ()

Récupère un rapport de bogue sur l'appareil.

InputStreamSource getBugreportz ()

Récupère un bugreportz de l'appareil.

String getBuildAlias ()

Récupérez l'alias de la compilation que le périphérique est en cours d'exécution.

String getBuildFlavor ()

Récupérez la version de build de l'appareil.

String getBuildId ()

Récupérez la compilation que l'appareil exécute actuellement.

String getBuildSigningKeys ()

Renvoie le type de clé utilisé pour signer l'image de l'appareil

En règle générale, les appareils Android peuvent être signés avec des clés de test (comme dans AOSP) ou des clés de libération (contrôlées par des fabricants d'appareils individuels)

String[] getChildren (String path)

Alternative à l'utilisation de IFileEntry qui ne fonctionnera parfois pas à cause des autorisations.

int getCurrentUser ()

Renvoie l'ID de l'utilisateur en cours d'exécution.

String getDeviceClass ()

Obtenez la classe de périphérique.

long getDeviceDate ()

Renvoie la date de l'appareil en millisecondes depuis l'époque.

DeviceDescriptor getDeviceDescriptor ()

Renvoyez un DeviceDescriptor partir des informations de périphérique pour obtenir des informations dessus sans passer l'objet périphérique réel.

TestDeviceState getDeviceState ()

Obtenez l'état de l'appareil.

long getDeviceTimeOffset (Date date)

Aide pour obtenir le décalage horaire entre l'appareil et une ERROR(/Date) donnée ERROR(/Date) .

InputStreamSource getEmulatorOutput ()

Obtenez le flux de l'émulateur stdout et stderr

Process getEmulatorProcess ()

Renvoyez le Process correspondant à cet émulateur.

final File getExecuteShellCommandLog ()

Le journal qui contient tous les executeShellCommand(String) .

long getExternalStoreFreeSpace ()

Méthode d'assistance pour déterminer la quantité d'espace libre sur le stockage externe de l'appareil.

String getFastbootPath ()

Renvoie le chemin du binaire fastboot utilisé.

String getFastbootProductType ()

Méthode pratique pour obtenir le type de produit de cet appareil lorsqu'il est en mode de démarrage rapide.

String getFastbootProductVariant ()

Méthode pratique pour obtenir le type de produit de cet appareil lorsqu'il est en mode de démarrage rapide.

String getFastbootVersion ()

Renvoie la chaîne de version du binaire fastboot utilisé.

IFileEntry getFileEntry (String path)

Récupérez une référence à un fichier distant sur l'appareil.

IFileEntry getFileEntry (FileListingService.FileEntry entry)

FileEntry non officielle pour obtenir un FileEntry partir d'un chemin non racine.

IDevice getIDevice ()

Renvoie une référence à l'IDevice IDevice associé.

getInstalledPackageNames ()

Récupérez les noms des packages d'application présents sur l'appareil.

String getIpAddress ()

Obtient l'adresse IP de l'appareil.

KeyguardControllerState getKeyguardState ()

Renvoie un objet pour obtenir l'état actuel du keyguard ou null s'il n'est pas pris en charge.

long getLastExpectedRebootTimeMillis ()

Renvoie la dernière fois que les API Tradefed ont déclenché un redémarrage en millisecondes depuis EPOCH comme renvoyé par System.currentTimeMillis() .

InputStreamSource getLogcat ()

Récupère un flux instantané des données logcat.

InputStreamSource getLogcat (int maxBytes)

Récupère un flux instantané des derniers maxBytes des données logcat capturées.

InputStreamSource getLogcatDump ()

Obtenez un vidage du logcat actuel pour le périphérique.

InputStreamSource getLogcatSince (long date)

Récupère un flux instantané des données logcat capturées à partir de la date fournie.

String getMacAddress ()

Renvoie l'adresse MAC du périphérique, nulle si la requête échoue à partir du périphérique.

int getMaxNumberOfRunningUsersSupported ()

Obtenez le nombre maximum d'utilisateurs exécutés simultanément pris en charge.

int getMaxNumberOfUsersSupported ()

Obtenez le nombre maximum d'utilisateurs pris en charge.

IDeviceStateMonitor getMonitor ()

Renvoyez l' IDeviceStateMonitor associé au périphérique.

String getMountPoint (String mountName)

Renvoie un point de montage.

ITestDevice.MountPointInfo getMountPointInfo (String mountpoint)

Renvoie un MountPointInfo correspondant au chemin du point de montage spécifié, ou null si ce chemin n'a rien de monté ou n'apparaît pas dans / proc / mounts en tant que point de montage.

getMountPointInfo ()

Renvoie une version analysée des informations dans / proc / mounts sur le périphérique

TestDeviceOptions getOptions ()

Récupérez les options de test de l'appareil.

long getPartitionFreeSpace (String partition)

Méthode d'assistance pour déterminer la quantité d'espace libre sur la partition de périphérique.

Integer getPrimaryUserId ()

Renvoie l'ID utilisateur principal.

ProcessInfo getProcessByName (String processName)

La méthode d'assistance exécute la commande "ps" et renvoie USER, PID et NAME du nom de processus donné.

String getProcessPid (String process)

Renvoie le pid du service ou null en cas de problème.

getProcesses ()

La méthode d'assistance exécute la commande "ps" et renvoie la liste USER, PID et NAME de tous les processus.

String getProductType ()

Méthode pratique pour obtenir le type de produit de cet appareil.

String getProductVariant ()

Méthode pratique pour obtenir la variante de produit de cet appareil.

String getProperty (String name)

Récupérez la valeur de propriété donnée de l'appareil.

ITestDevice.RecoveryMode getRecoveryMode ()

Obtenez le mode de récupération actuel utilisé pour l'appareil.

InputStreamSource getScreenshot (int displayId)

Prend une capture d'écran à partir de l'identifiant d'affichage de l'appareil.

InputStreamSource getScreenshot (String format)

Prend une capture d'écran de l'appareil.

InputStreamSource getScreenshot (String format, boolean rescale)

Prend une capture d'écran de l'appareil.

InputStreamSource getScreenshot ()

Prend une capture d'écran de l'appareil.

String getSerialNumber ()

Méthode pratique pour obtenir le numéro de série de cet appareil.

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

Renvoie la valeur du paramètre demandé.

String getSetting (String namespace, String key)

Voir getSetting(int, String, String) et exécuté sur l'utilisateur système.

String getSimOperator ()

Renvoie l'opérateur de la carte SIM ou nul si l'appareil n'est pas disponible.

String getSimState ()

Renvoie l'état de la carte SIM ou nul si l'appareil n'est pas disponible.

getTombstones ()

Récupérez et retournez la liste des pierres tombales des appareils.

long getTotalMemory ()

Renvoie la taille totale de la mémoire physique en octets ou -1 en cas d'erreur interne

getUninstallablePackageNames ()

Récupérez les noms des packages d'application qui peuvent être désinstallés.

boolean getUseFastbootErase ()

Déterminez s'il faut utiliser l'effacement ou le format de démarrage rapide pour effacer une partition sur l'appareil.

int getUserFlags (int userId)

Trouvez et renvoyez les drapeaux d'un utilisateur donné.

getUserInfos ()

Obtient le mappage de useId à UserInfo sur l'appareil.

int getUserSerialNumber (int userId)

Renvoie le numéro de série associé à userId s'il est trouvé, -10000 dans les autres cas.

IManagedTestDevice.DeviceEventResponse handleAllocationEvent (DeviceEvent event)

Traitez le DeviceEvent donné.

Traitez DeviceEvent, qui peut ou non faire passer ce périphérique à un nouvel état d'allocation.

boolean hasFeature (String feature)

Vérifiez si une fonction est disponible sur un appareil.

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

Installez un package Android sur l'appareil.

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

Installez un package Android sur l'appareil.

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

Installez un package Android sur l'appareil pour un utilisateur donné.

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

Installez un package Android sur l'appareil pour un utilisateur donné.

boolean isAdbRoot ()

boolean isAdbTcp ()
boolean isDeviceEncrypted ()

Renvoie si l'appareil est chiffré.

boolean isDirectory (String path)

Renvoie True si le chemin sur le périphérique est un répertoire, false dans le cas contraire.

boolean isEnableAdbRoot ()
boolean isEncryptionSupported ()

Renvoie si le cryptage est pris en charge sur l'appareil.

boolean isExecutable (String fullPath)

Renvoie True si le chemin du fichier sur le périphérique est un fichier exécutable, False dans le cas contraire.

boolean isFastbootEnabled ()

Renvoie si fastboot est disponible pour l'appareil.

boolean isHeadless ()

Renvoie true si l'appareil est sans tête (pas d'écran), false dans le cas contraire.

boolean isMultiUserSupported ()

Détermine si le multi-utilisateur est pris en charge.

boolean isPackageInstalled (String packageName, String userId)

Interrogez l'appareil pour un nom de package donné et un identifiant utilisateur donné pour vérifier s'il est actuellement installé ou non pour cet utilisateur.

boolean isPackageInstalled (String packageName)

Interrogez l'appareil pour un nom de package donné pour vérifier s'il est actuellement installé ou non.

boolean isRuntimePermissionSupported ()

Vérifiez si la plate-forme sur l'appareil prend en charge l'octroi d'autorisations d'exécution

boolean isUserRunning (int userId)

Vérifiez si un utilisateur donné est en cours d'exécution.

boolean isUserSecondary (int userId)

Renvoie si l'utilisateur spécifié est un utilisateur secondaire selon ses indicateurs.

boolean isWifiEnabled ()

Testez si le wifi est activé.

listDisplayIds ()

Collectez la liste des affichages disponibles sur le périphérique, comme indiqué par "dumpsys SurfaceFlinger".

listUsers ()

Obtient la liste des utilisateurs sur l'appareil.

boolean logBugreport (String dataName, ITestLogger listener)

Méthode d'assistance pour prendre un rapport de bogue et le consigner aux journalistes.

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

Enregistrez un message dans le logcat de l'appareil.

void nonBlockingReboot ()

Emet une commande pour redémarrer l'appareil et revient lorsque la commande est terminée et lorsque l'appareil n'est plus visible par adb.

void postAdbRootAction ()

Remplacez si l'appareil a besoin de certaines actions spécifiques après la racine adb et avant que l'appareil ne soit de nouveau en ligne.

void postAdbUnrootAction ()

Remplacez si l'appareil a besoin de certaines actions spécifiques après l'annulation de l'adb et avant que l'appareil ne soit de nouveau en ligne.

void postBootSetup ()

Suivez les instructions pour configurer le périphérique pour le tester après chaque démarrage.

void postInvocationTearDown ()

Étapes supplémentaires pour le nettoyage requis spécifique au périphérique qui sera exécuté après l'appel.

void preInvocationSetup ( IBuildInfo info)

Étapes supplémentaires pour la configuration requise spécifique au périphérique qui sera exécutée sur le périphérique avant le flux d'appel.

boolean pullDir (String deviceFilePath, File localDir)

Extraire récursivement le contenu du répertoire du périphérique.

boolean pullFile (String remoteFilePath, File localFile)

Récupère un fichier hors de l'appareil.

File pullFile (String remoteFilePath)

Récupère un fichier hors de l'appareil, le stocke dans une ERROR(/File) temporaire locale ERROR(/File) et renvoie ce File .

String pullFileContents (String remoteFilePath)

Récupère un fichier hors de l'appareil et renvoie le contenu.

File pullFileFromExternal (String remoteFilePath)

Une méthode pratique pour récupérer un fichier à partir du stockage externe de l'appareil, le stocker dans une ERROR(/File) temporaire locale ERROR(/File) et renvoyer une référence à ce File .

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

Poussez récursivement le contenu du répertoire vers le périphérique tout en excluant certains répertoires filtrés.

boolean pushDir (File localFileDir, String deviceFilePath)

Poussez récursivement le contenu du répertoire vers le périphérique.

boolean pushFile (File localFile, String remoteFilePath)

Transférer un fichier sur l'appareil

boolean pushString (String contents, String remoteFilePath)

Envoyer le fichier créé à partir d'une chaîne vers l'appareil

void reboot ()

Redémarre l'appareil en mode adb.

void rebootIntoBootloader ()

Redémarre l'appareil en mode bootloader.

void rebootIntoRecovery ()

Redémarre l'appareil en mode de récupération adb.

void rebootUntilOnline ()

Une alternative à reboot() qui ne bloque que jusqu'à ce que l'appareil soit en ligne, c'est-à-dire visible par adb.

void recoverDevice ()

Tente de récupérer la communication de l'appareil.

void remountSystemWritable ()

Rendez la partition système du périphérique inscriptible.

boolean removeAdmin (String componentName, int userId)

Supprimez l'administrateur de l'appareil donné dans l'utilisateur donné et retournez true s'il réussit, false cas contraire.

void removeOwners ()

Supprimez tous les propriétaires de profil d'appareil existants avec le meilleur effort.

boolean removeUser (int userId)

Supprimer un utilisateur donné de l'appareil.

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

Méthode pratique pour exécuter ERROR(/#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection)) avec un ou plusieurs écouteurs passés en paramètres.

boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, listeners) runInstrumentationTests (IRemoteAndroidTestRunner runner, listeners)

Exécute des tests d'instrumentation et assure la récupération de l'appareil.

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

Identique à ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, ITestLifeCycleReceiver...) mais exécute le test pour un utilisateur donné.

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

Identique à ERROR(ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection)/com.android.tradefed.device.ITestDevice#runInstrumentationTests(com.android.ddmlib.testrunner.IRemoteAndroidTestRunner,Collection) ITestDevice#runInstrumentationTests(IRemoteAndroidTestRunner, Collection)) pour l'utilisateur donné.

void setDate (Date date)

Règle la date sur l'appareil

Remarque: le réglage de la date sur l'appareil nécessite la racine

boolean setDeviceOwner (String componentName, int userId)

Définissez un composant d'administration de l'appareil comme propriétaire de l'appareil dans un utilisateur donné.

void setDeviceState ( TestDeviceState deviceState)

Mettez à jour l'état de l'appareil.

void setEmulatorOutputStream ( SizeLimitedOutputStream output)

Pour l'émulateur, définissez SizeLimitedOutputStream pour journaliser la sortie

void setEmulatorProcess (Process p)

Définit le Process , lorsque cet appareil est un émulateur.

void setFastbootEnabled (boolean fastbootEnabled)

Définissez l'option de démarrage rapide pour l'appareil.

void setFastbootPath (String fastbootPath)

Définit le chemin d'accès au binaire fastboot qui doit être utilisé.

void setIDevice (IDevice newDevice)

Mettez à jour l'IDevice associé à cet ITestDevice.

void setOptions ( TestDeviceOptions options)

Définissez les TestDeviceOptions pour l'appareil

boolean setProperty (String propKey, String propValue)

Définit la valeur de propriété donnée sur l'appareil.

void setRecovery ( IDeviceRecovery recovery)

Définissez IDeviceRecovery à utiliser pour cet appareil.

void setRecoveryMode ( ITestDevice.RecoveryMode mode)

Définissez le mode de récupération actuel à utiliser pour l'appareil.

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

Voir setSetting(int, String, String, String) et exécuté sur l'utilisateur système.

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

Ajoutez une valeur de paramètre à l'espace de noms d'un utilisateur donné.

void setUseFastbootErase (boolean useFastbootErase)

Définissez si vous souhaitez utiliser l'effacement ou le format de démarrage rapide pour effacer une partition sur l'appareil.

void startLogcat ()

Commencez à capturer la sortie logcat du périphérique en arrière-plan.

boolean startUser (int userId)

Démarre un utilisateur donné en arrière-plan s'il est actuellement arrêté.

boolean startUser (int userId, boolean waitFlag)

Démarre un utilisateur donné en arrière-plan s'il est actuellement arrêté.

void stopEmulatorOutput ()

Fermez et supprimez la sortie de l'émulateur.

void stopLogcat ()

Arrêtez de capturer la sortie logcat de l'appareil et supprimez les données logcat actuellement enregistrées.

boolean stopUser (int userId)

Arrête un utilisateur donné.

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

Arrêtez un utilisateur donné.

String switchToAdbTcp ()

Mettez l'appareil en mode adb-over-tcp.

boolean switchToAdbUsb ()

Basculez l'appareil en mode adb via usb.

boolean switchUser (int userId)

Basculez vers un autre userId avec un délai par défaut.

boolean switchUser (int userId, long timeout)

Basculez vers un autre userId avec le délai d'expiration fourni comme date limite.

boolean syncFiles (File localFileDir, String deviceFilePath)

Synchronise de manière incrémentielle le contenu d'un répertoire de fichiers local avec l'appareil.

Bugreport takeBugreport ()

Prenez un rapport de bogue et retournez-le dans un objet Bugreport pour le gérer.

boolean unencryptDevice ()

Déchiffre le périphérique.

String uninstallPackage (String packageName)

Désinstallez un package Android de l'appareil.

boolean unlockDevice ()

Déverrouille l'appareil si l'appareil est dans un état chiffré.

boolean waitForBootComplete (long timeOut)

Bloque jusqu'à ce que l'indicateur de fin de démarrage du périphérique soit défini.

void waitForDeviceAvailable ()

Attend que l'appareil soit réactif et disponible pour les tests.

void waitForDeviceAvailable (long waitTime)

Attend que l'appareil soit réactif et disponible pour les tests.

boolean waitForDeviceInRecovery (long waitTime)

Bloque pour que l'appareil soit dans l'état 'adb recovery' (notez que ceci est différent de IDeviceRecovery ).

boolean waitForDeviceNotAvailable (long waitTime)

Blocs pour que l'appareil ne soit pas disponible, c'est-à-dire manquant dans adb

void waitForDeviceOnline ()

Bloque jusqu'à ce que l'appareil soit visible via adb.

void waitForDeviceOnline (long waitTime)

Bloque jusqu'à ce que l'appareil soit visible via adb.

boolean waitForDeviceShell (long waitTime)

Attend que le périphérique réponde à une commande adb shell de base.

Méthodes protégées

void checkApiLevelAgainst (String feature, int strictMinLevel)
NativeDevice.RebootDeviceAction createRebootDeviceAction (String into)

Créez un RebootDeviceAction à utiliser lors de l'exécution d'une action de redémarrage.

void doAdbReboot (String into)

Effectuez un redémarrage adb.

void ensureRuntimePermissionSupported ()

méthode d'assistance pour lever une exception si l'autorisation d'exécution n'est pas prise en charge

InputStreamSource getBugreportInternal ()
File getBugreportzInternal ()

Méthode d'assistance interne pour obtenir le fichier zip bugreportz en tant ERROR(/File) .

IRunUtil getRunUtil ()

Obtenez l'instance RunUtil à utiliser.

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

Récupérez une propriété de périphérique, à partir du cache ddmlib par défaut, et revenez à `adb shell getprop` ou` fastboot getvar` selon que le périphérique est dans Fastboot ou non.

boolean isNewer (File localFile, IFileEntry entry)

Renvoie true si le fichier local est plus récent que le fichier distant.

boolean performDeviceAction (String actionDescription, com.android.tradefed.device.NativeDevice.DeviceAction action, int retryAttempts)

Effectue une action sur cet appareil.

void postAdbReboot ()

Actions supplémentaires possibles qui peuvent être effectuées après un redémarrage.

void prePostBootSetup ()

Permet à chaque type d'appareil (AndroidNativeDevice, TestDevice) de remplacer cette méthode pour une configuration post-démarrage spécifique.

void setClock (Clock clock)

Définissez l'instance d'horloge à utiliser.

void setLogStartDelay (int delay)

Définit le temps d'attente en ms avant de démarrer la capture logcat pour un périphérique en ligne.

void waitForDeviceNotAvailable (String operationDesc, long time)

Constantes

IDENTIFIANT INVALIDE

public static final int INVALID_USER_ID

Valeur renvoyée pour tout ID utilisateur invalide / introuvable: UserHandle a défini la valeur -10000

Valeur constante: -10000 (0xffffd8f0)

MAX_HOST_DEVICE_TIME_OFFSET

protected static final long MAX_HOST_DEVICE_TIME_OFFSET

Valeur constante: 5000 (0x0000000000001388)

MAX_RETRY_ATTEMPTS

protected static final int MAX_RETRY_ATTEMPTS

le nombre par défaut de nouvelles tentatives de commande à effectuer

Valeur constante: 2 (0x00000002)

Des champs

mOptions

protected TestDeviceOptions mOptions

mStateMonitor

protected final IDeviceStateMonitor mStateMonitor

Constructeurs publics

NativeDevice

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

Crée un TestDevice .

Paramètres
device IDevice : l' IDevice associé

stateMonitor IDeviceStateMonitor : le mécanisme IDeviceStateMonitor à utiliser

allocationMonitor IDeviceMonitor : IDeviceMonitor pour informer des changements d'état d'allocation. Peut être nul

Méthodes publiques

checkApiLevelAgainstNextRelease

public boolean checkApiLevelAgainstNextRelease (int strictMinLevel)

Vérifiez si une fonctionnalité est actuellement prise en charge en fonction d'un niveau de prise en charge minimal. Cette méthode prend en compte des fonctionnalités inédites, avant que le niveau d'API ne soit augmenté.

Paramètres
strictMinLevel int : Le niveau minimum strict possible qui prend en charge la fonctionnalité.

Retour
boolean Vrai si le niveau est pris en charge. Faux sinon.

Jette
DeviceNotAvailableException

checkConnectivité

public boolean checkConnectivity ()

Vérifiez que l'appareil dispose d'une connectivité réseau.

Retour
boolean true si l'appareil a une connexion réseau fonctionnelle, false overwise.

Jette
DeviceNotAvailableException

clearErrorDialogs

public boolean clearErrorDialogs ()

Essayez de fermer toutes les boîtes de dialogue d'erreur actuellement affichées sur l'interface utilisateur de l'appareil.

Retour
boolean true si aucune boîte de dialogue n'était présente ou si les boîtes de dialogue ont été effacées avec succès. false sinon.

Jette
DeviceNotAvailableException

clearLastConnectedWifiNetwork

public void clearLastConnectedWifiNetwork ()

Efface le dernier réseau wifi connecté. Cela doit être appelé lors du démarrage d'une nouvelle invocation pour éviter de se connecter au réseau wifi utilisé dans le test précédent après le redémarrage de l'appareil.

clearLogcat

public void clearLogcat ()

Supprime toutes les données logcat accumulées.

Ceci est utile dans les cas où vous voulez vous assurer que ITestDevice#getLogcat() ne renvoie que les données de journal produites après un certain point (comme après le flashage d'une nouvelle version de périphérique, etc.).

connectToWifiNetwork

public boolean connectToWifiNetwork (String wifiSsid, 
                String wifiPsk)

Se connecte à un réseau wifi.

Active le wifi et se bloque jusqu'à ce qu'une connexion réussie soit établie au réseau wifi spécifié. Une fois la connexion établie, l'instance essaiera de restaurer la connexion après chaque redémarrage jusqu'à ITestDevice#disconnectFromWifi() que ITestDevice#disconnectFromWifi() ou ITestDevice#clearLastConnectedWifiNetwork() soit appelé.

Paramètres
wifiSsid String : le ssid wifi auquel se connecter

wifiPsk String : phrase de passe PSK ou null si non chiffrée

Retour
boolean true si connecté au réseau wifi avec succès. false sinon

Jette
DeviceNotAvailableException

connectToWifiNetwork

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

Se connecte à un réseau wifi.

Active le wifi et se bloque jusqu'à ce qu'une connexion réussie soit établie au réseau wifi spécifié. Une fois la connexion établie, l'instance essaiera de restaurer la connexion après chaque redémarrage jusqu'à ITestDevice#disconnectFromWifi() que ITestDevice#disconnectFromWifi() ou ITestDevice#clearLastConnectedWifiNetwork() soit appelé.

Paramètres
wifiSsid String : le ssid wifi auquel se connecter

wifiPsk String : phrase de passe PSK ou null si non chiffrée

scanSsid boolean : s'il faut rechercher le SSID caché pour ce réseau.

Retour
boolean true si connecté au réseau wifi avec succès. false sinon

Jette
DeviceNotAvailableException

connectToWifiNetworkSiNécessaire

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

Une variante de connectToWifiNetwork(String, String) qui se connecte uniquement si le périphérique n'a actuellement pas de connectivité réseau.

Paramètres
scanSsid boolean : s'il faut rechercher le SSID caché pour ce réseau

Retour
boolean true si connecté au réseau wifi avec succès. false sinon

Jette
DeviceNotAvailableException

connectToWifiNetworkSiNécessaire

public boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk)

Une variante de connectToWifiNetwork(String, String) qui se connecte uniquement si le périphérique n'a actuellement pas de connectivité réseau.

Retour
boolean true si connecté au réseau wifi avec succès. false sinon

Jette
DeviceNotAvailableException

Créer un utilisateur

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

Créer un utilisateur avec un nom donné et les indicateurs fournis

Paramètres
name String : de l'utilisateur à créer sur l'appareil

guest boolean : active le drapeau utilisateur --guest lors de la création

ephemeral boolean : active le drapeau utilisateur - éphémère lors de la création

Retour
int id de l'utilisateur créé

Jette
DeviceNotAvailableException

Créer un utilisateur

public int createUser (String name)

Créez un utilisateur avec un nom donné et des indicateurs par défaut 0.

Paramètres
name String : de l'utilisateur à créer sur l'appareil

Retour
int l'entier de l'ID utilisateur créé

Jette
DeviceNotAvailableException

createUserNoThrow

public int createUserNoThrow (String name)

Créez un utilisateur avec un nom donné et des indicateurs par défaut 0.

Paramètres
name String : de l'utilisateur à créer sur l'appareil

Retour
int le nombre entier de l'ID utilisateur créé ou -1 en cas d'erreur.

Jette
DeviceNotAvailableException

supprimer le fichier

public void deleteFile (String deviceFilePath)

Méthode d'assistance pour supprimer un fichier ou un répertoire sur l'appareil.

Paramètres
deviceFilePath String : chemin absolu du fichier sur l'appareil.

Jette
DeviceNotAvailableException

disableAdbRoot

public boolean disableAdbRoot ()

Désactive adb root.

La désactivation de la racine adb peut entraîner la déconnexion de l'appareil de l'adb. Cette méthode se bloquera jusqu'à ce que l'appareil soit disponible.

Retour
boolean true cas de succès.

Jette
DeviceNotAvailableException

disableKeyguard

public void disableKeyguard ()

Tente de désactiver le keyguard.

Attendez d'abord que la distribution d'entrée soit prête, cela se produit à peu près au même moment où le périphérique signale BOOT_COMPLETE, apparemment de manière asynchrone, car l'implémentation actuelle du framework a une condition de concurrence occasionnelle. Ensuite, la commande est envoyée pour ignorer le keyguard (fonctionne uniquement sur les non sécurisés)

Jette
DeviceNotAvailableException

disableNetworkMonitor

public boolean disableNetworkMonitor ()

Désactive la surveillance du réseau sur l'appareil.

Retour
boolean true si la surveillance est désactivée avec succès. false cas d'échec.

Jette
DeviceNotAvailableException

déconnecterDeWifi

public boolean disconnectFromWifi ()

Se déconnecte d'un réseau wifi.

Supprime tous les réseaux de la liste des réseaux connus et désactive le wifi.

Retour
boolean true si déconnecté du réseau wifi avec succès. false si la déconnexion a échoué.

Jette
DeviceNotAvailableException

doesFileExist

public boolean doesFileExist (String deviceFilePath)

Méthode d'assistance pour déterminer si le fichier sur l'appareil existe.

Paramètres
deviceFilePath String : le chemin absolu du fichier sur l'appareil à vérifier

Retour
boolean true si le fichier existe, false cas contraire.

Jette
DeviceNotAvailableException

dumpHeap

public File dumpHeap (String process, 
                String devicePath)

Essayez de vider le tas du serveur_système. Il est de la responsabilité de l'appelant de nettoyer le fichier sauvegardé.

Paramètres
process String : le nom du processus de périphérique sur lequel effectuer le vidage.

devicePath String : le chemin sur le périphérique où placer le vidage. Il doit s'agir d'un emplacement où les autorisations le permettent.

Retour
File l' ERROR(/File) contenant le rapport. Nul si quelque chose a échoué.

Jette
DeviceNotAvailableException

enableAdbRoot

public boolean enableAdbRoot ()

Active adb root. Si le paramètre «enable-root» est «false», enregistrera un message et retournera sans activer root.

L'activation de la racine adb peut entraîner la déconnexion de l'appareil de l'adb. Cette méthode se bloquera jusqu'à ce que l'appareil soit disponible.

Retour
boolean true cas de succès.

Jette
DeviceNotAvailableException

enableNetworkMonitor

public boolean enableNetworkMonitor ()

Active la surveillance du réseau sur l'appareil.

Retour
boolean true si la surveillance est activée avec succès. false cas d'échec.

Jette
DeviceNotAvailableException

encryptDevice

public boolean encryptDevice (boolean inplace)

Crypte l'appareil.

Le cryptage de l'appareil peut être effectué sur place ou avec un effacement. Le cryptage en place n'effacera aucune donnée sur l'appareil, mais prend normalement quelques ordres de grandeur de plus que l'effacement.

Cette méthode redémarrera l'appareil s'il n'est pas déjà chiffré et se bloquera jusqu'à ce que l'appareil soit en ligne. De plus, il ne déchiffrera pas l'appareil après le redémarrage. Par conséquent, le périphérique peut ne pas être complètement démarré et / ou prêt à être testé lorsque cette méthode revient.

Paramètres
inplace boolean : si le processus de cryptage doit prendre place et que l'appareil ne doit pas être effacé.

Retour
boolean true cas de succès.

Jette
DeviceNotAvailableException

executeAdbCommand

public String executeAdbCommand (String... cmdArgs)

Méthode d'assistance qui exécute une commande adb en tant que commande système.

executeShellCommand(String) doit être utilisé à la place dans la mesure du possible, car cette méthode offre une meilleure détection des pannes et de meilleures performances.

Paramètres
cmdArgs String : la commande adb et les arguments à exécuter

Retour
String la commande stdout from. null si la commande n'a pas pu s'exécuter.

Jette
DeviceNotAvailableException

executeFastbootCommand

public CommandResult executeFastbootCommand (String... cmdArgs)

Méthode d'assistance qui exécute une commande fastboot en tant que commande système avec un délai d'expiration par défaut de 2 minutes.

Devrait être utilisé lorsque l'appareil est déjà en mode de démarrage rapide.

Paramètres
cmdArgs String : la commande fastboot et les arguments à exécuter

Retour
CommandResult le CommandResult contenant la sortie de la commande

Jette
DeviceNotAvailableException

executeFastbootCommand

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

Méthode d'assistance qui exécute une commande fastboot en tant que commande système.

Devrait être utilisé lorsque l'appareil est déjà en mode de démarrage rapide.

Paramètres
timeout long : le temps en millisecondes avant l'expiration de la commande

cmdArgs String : la commande fastboot et les arguments à exécuter

Retour
CommandResult le CommandResult contenant la sortie de la commande

Jette
DeviceNotAvailableException

executeLongFastbootCommand

public CommandResult executeLongFastbootCommand (String... cmdArgs)

Méthode d'assistance qui exécute une commande fastboot de longue durée en tant que commande système.

Identique à executeFastbootCommand(String) sauf utilise un délai d'expiration plus long.

Paramètres
cmdArgs String : la commande fastboot et les arguments à exécuter

Retour
CommandResult le CommandResult contenant la sortie de la commande

Jette
DeviceNotAvailableException

executeShellCommand

public String executeShellCommand (String command)

Méthode d'assistance qui exécute une commande adb shell et renvoie la sortie sous forme de String .

Paramètres
command String : la commande adb shell à exécuter

Retour
String la sortie du shell

Jette
DeviceNotAvailableException

executeShellCommand

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

Paramètres
command String : la commande adb shell à exécuter

receiver IShellOutputReceiver : le IShellOutputReceiver vers IShellOutputReceiver diriger la sortie du shell.

maxTimeToOutputShellResponse long : la durée maximale pendant laquelle la commande est autorisée à n'émettre aucune réponse; unité comme spécifié dans timeUnit

timeUnit TimeUnit : unité pour maxTimeToOutputShellResponse

retryAttempts int : le nombre maximum de tentatives de commande en cas d'échec en raison d'une exception. DeviceNotResponsiveException sera levée si retryAttempts est effectué sans succès.

Jette
DeviceNotAvailableException

executeShellCommand

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

Paramètres
command String : la commande adb shell à exécuter

receiver IShellOutputReceiver : le IShellOutputReceiver vers IShellOutputReceiver diriger la sortie du shell.

maxTimeoutForCommand long : le délai maximum pour l'exécution de la commande; unité comme spécifié dans timeUnit

maxTimeToOutputShellResponse long : la durée maximale pendant laquelle la commande est autorisée à n'émettre aucune réponse; unité comme spécifié dans timeUnit

timeUnit TimeUnit : unité pour maxTimeToOutputShellResponse

retryAttempts int : le nombre maximum de tentatives de commande en cas d'échec en raison d'une exception. DeviceNotResponsiveException sera levée si retryAttempts est effectué sans succès.

Jette
DeviceNotAvailableException

executeShellCommand

public void executeShellCommand (String command, 
                IShellOutputReceiver receiver)

Exécute la commande adb shell donnée, en réessayant plusieurs fois si la commande échoue.

Une forme plus simple de executeShellCommand(String, com.android.ddmlib.IShellOutputReceiver, long, TimeUnit, int) avec des valeurs par défaut.

Paramètres
command String : la commande adb shell à exécuter

receiver IShellOutputReceiver : le IShellOutputReceiver vers IShellOutputReceiver diriger la sortie du shell.

Jette
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd)

Méthode d'assistance qui exécute une commande adb shell et renvoie les résultats sous la forme d'un CommandResult correctement CommandResult avec la sortie d'état de la commande, stdout et stderr.

Paramètres
cmd String : la commande qui doit être exécutée.

Retour
CommandResult Le résultat dans CommandResult .

Jette
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                OutputStream pipeToOutput)

Méthode d'assistance qui exécute une commande adb shell et renvoie les résultats sous la forme d'un CommandResult correctement CommandResult avec la sortie d'état de la commande, stdout et stderr.

Paramètres
cmd String : la commande qui doit être exécutée.

pipeToOutput OutputStream : ERROR(/OutputStream) où la sortie std sera redirigée.

Retour
CommandResult Le résultat dans CommandResult .

Jette
DeviceNotAvailableException

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                File pipeAsInput)

Méthode d'assistance qui exécute une commande adb shell et renvoie les résultats sous la forme d'un CommandResult correctement CommandResult avec la sortie d'état de la commande, stdout et stderr.

Paramètres
cmd String : la commande qui doit être exécutée.

pipeAsInput File : Une ERROR(/File) qui sera redirigée comme entrée de la commande.

Retour
CommandResult Le résultat dans CommandResult .

Jette
DeviceNotAvailableException

executeShellV2Command

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

Paramètres
cmd String : la commande adb shell à exécuter

maxTimeoutForCommand long : le délai maximum pour l'exécution de la commande; unité comme spécifié dans timeUnit

timeUnit TimeUnit : unité pour maxTimeToOutputShellResponse

retryAttempts int : le nombre maximum de tentatives de commande en cas d'échec en raison d'une exception. DeviceNotResponsiveException sera levée si retryAttempts est effectué sans succès.

Retour
CommandResult

Jette
DeviceNotAvailableException

executeShellV2Command

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

Paramètres
cmd String : la commande adb shell à exécuter

maxTimeoutForCommand long : le délai maximum pour l'exécution de la commande; unité comme spécifié dans timeUnit

timeUnit TimeUnit : unité pour maxTimeToOutputShellResponse

Retour
CommandResult

Jette
DeviceNotAvailableException

executeShellV2Command

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

Exécute une commande adb shell, avec plus de paramètres pour contrôler le comportement de la commande.

Paramètres
cmd String : la commande adb shell à exécuter

pipeAsInput File : Une ERROR(/File) qui sera redirigée comme entrée de la commande.

pipeToOutput OutputStream : ERROR(/OutputStream) où la sortie std sera redirigée.

maxTimeoutForCommand long : le délai maximum pour l'exécution de la commande; unité comme spécifié dans timeUnit

timeUnit TimeUnit : unité pour maxTimeToOutputShellResponse

retryAttempts int : le nombre maximum de tentatives de commande en cas d'échec en raison d'une exception. DeviceNotResponsiveException sera levée si retryAttempts est effectué sans succès.

Retour
CommandResult

Jette
DeviceNotAvailableException

fastbootWipePartition

public CommandResult fastbootWipePartition (String partition)

Méthode d'assistance qui efface une partition pour le périphérique.

Si getUseFastbootErase() est true , l'effacement de getUseFastbootErase() sera utilisé pour effacer la partition. Le périphérique doit alors créer un système de fichiers au prochain démarrage du périphérique. Sinon, le format Fastboot est utilisé, ce qui créera un nouveau système de fichiers sur l'appareil.

Devrait être utilisé lorsque l'appareil est déjà en mode de démarrage rapide.

Paramètres
partition String : la partition à effacer

Retour
CommandResult le CommandResult contenant la sortie de la commande

Jette
DeviceNotAvailableException

getActiveApexes

public  getActiveApexes ()

Récupérez les informations sur les APEX activés sur l'appareil.

Retour
ERROR(/Set) d' ApexInfo actuellement activé sur l'appareil

Jette
DeviceNotAvailableException

getAllSettings

public  getAllSettings (String namespace)

Renvoie les paires clé / valeur de l'espace de noms demandé.

Paramètres
namespace String : doit être l'un des {"system", "secure", "global"}

Retour
la carte des paires valeur / clé. Null si l'espace de noms n'est pas pris en charge.

Jette
DeviceNotAvailableException

getAllocationState

public DeviceAllocationState getAllocationState ()

Renvoie l'état d'allocation actuel de l'appareil

Retour
DeviceAllocationState

getAndroidId

public String getAndroidId (int userId)

Trouvez et renvoyez l'id-android associé à un userId, nul s'il n'est pas trouvé.

Paramètres
userId int

Retour
String

Jette
DeviceNotAvailableException

getAndroidIds

public  getAndroidIds ()

Créez une carte des identifiants Android trouvés. Il n'y a aucune assurance que chaque identifiant d'utilisateur trouvera un identifiant Android associé à cette fonction, de sorte que certains identifiants d'utilisateurs peuvent correspondre à null.

Retour
Carte des identifiants Android trouvés.

Jette
DeviceNotAvailableException

getApiLevel

public int getApiLevel ()

Obtenez le niveau d'API de l'appareil. La valeur par défaut est UNKNOWN_API_LEVEL .

Retour
int un entier indiquant le niveau d'API de l'appareil

Jette
DeviceNotAvailableException

getAppPackageInfo

public PackageInfo getAppPackageInfo (String packageName)

Récupérez des informations sur un package installé sur l'appareil.

Paramètres
packageName String

Retour
PackageInfo PackageInfo ou null si les informations n'ont pas pu être récupérées

Jette
DeviceNotAvailableException

getBasebandVersion

public String getBasebandVersion ()

Méthode pratique pour obtenir la version bande de base (radio) de cet appareil. L'obtention de la version radio est spécifique à l'appareil, il se peut donc qu'elle ne renvoie pas les informations correctes pour tous les appareils. Cette méthode s'appuie sur la propriété gsm.version.baseband pour renvoyer les informations de version correctes. Ce n'est pas exact pour certains périphériques CDMA et la version renvoyée ici peut ne pas correspondre à la version signalée par Fastboot et peut ne pas renvoyer la version pour la radio CDMA. TL; DR cette méthode ne signale la version exacte que si la propriété gsm.version.baseband est la même que la version renvoyée par fastboot getvar version-baseband .

Retour
String la version de bande de base String ou null si elle ne peut pas être déterminée (l'appareil n'a pas de radio ou la chaîne de version ne peut pas être lue)

Jette
DeviceNotAvailableException

getBattery

public Integer getBattery ()

Renvoie le niveau de batterie actuel d'un appareil ou Null si le niveau de batterie n'est pas disponible.

Retour
Integer

getBootloaderVersion

public String getBootloaderVersion ()

Méthode pratique pour obtenir la version du chargeur de démarrage de cet appareil.

Essaiera de récupérer la version du chargeur de démarrage à partir de l'état actuel du périphérique. (c'est-à-dire que si l'appareil est en mode fastboot, il tentera de récupérer la version de fastboot)

Retour
String la version du chargeur de démarrage String ou null si elle est introuvable

Jette
DeviceNotAvailableException

getBugreport

public InputStreamSource getBugreport ()

Récupère un rapport de bogue sur l'appareil.

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

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

getBugreportz

public InputStreamSource getBugreportz ()

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

Only supported for 'adb version' > 1.0.36

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

getBuildAlias

public String getBuildAlias ()

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

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

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

Throws
DeviceNotAvailableException

getBuildFlavor

public String getBuildFlavor ()

Retrieve the build flavor for the device.

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

Throws
DeviceNotAvailableException

getBuildId

public String getBuildId ()

Retrieve the build the device is currently running.

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

Throws
DeviceNotAvailableException

getBuildSigningKeys

public String getBuildSigningKeys ()

Returns the key type used to sign the device image

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

Returns
String The signing key if found, null otherwise.

Throws
DeviceNotAvailableException

getChildren

public String[] getChildren (String path)

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

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

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

Throws
DeviceNotAvailableException

getCurrentUser

public int getCurrentUser ()

Return the id of the current running user.

Returns
int

Throws
DeviceNotAvailableException

getDeviceClass

public String getDeviceClass ()

Get the device class.

Returns
String the String device class.

getDeviceDate

public long getDeviceDate ()

Return the date of the device in millisecond since epoch.

Returns
long the date of the device in epoch format.

Throws
DeviceNotAvailableException

getDeviceDescriptor

public DeviceDescriptor getDeviceDescriptor ()

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

Returns
DeviceDescriptor

getDeviceState

public TestDeviceState getDeviceState ()

Get the device's state.

Returns
TestDeviceState

getDeviceTimeOffset

public long getDeviceTimeOffset (Date date)

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

Parameters
date Date

Returns
long the difference in milliseconds

Throws
DeviceNotAvailableException

getEmulatorOutput

public InputStreamSource getEmulatorOutput ()

Get the stream of emulator stdout and stderr

Returns
InputStreamSource emulator output

getEmulatorProcess

public Process getEmulatorProcess ()

Return the Process corresponding to this emulator.

Returns
Process the Process or null

getExecuteShellCommandLog

public final File getExecuteShellCommandLog ()

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

Returns
File

getExternalStoreFreeSpace

public long getExternalStoreFreeSpace ()

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

Returns
long the amount of free space in KB

Throws
DeviceNotAvailableException

getFastbootPath

public String getFastbootPath ()

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

Returns
String

getFastbootProductType

public String getFastbootProductType ()

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

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

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

Throws
DeviceNotAvailableException

getFastbootProductVariant

public String getFastbootProductVariant ()

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

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

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

Throws
DeviceNotAvailableException

getFastbootVersion

public String getFastbootVersion ()

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

Returns
String

getFileEntry

public IFileEntry getFileEntry (String path)

Retrieve a reference to a remote file on device.

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

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

Throws
DeviceNotAvailableException

getFileEntry

public IFileEntry getFileEntry (FileListingService.FileEntry entry)

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

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

Returns
IFileEntry a FileEntryWrapper representing the FileEntry.

Throws
DeviceNotAvailableException

getIDevice

public IDevice getIDevice ()

Returns a reference to the associated ddmlib IDevice .

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

Returns
IDevice the IDevice

getInstalledPackageNames

public  getInstalledPackageNames ()

Fetch the application package names present on the device.

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

Throws
DeviceNotAvailableException

getIpAddress

public String getIpAddress ()

Gets the device's IP address.

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

Throws
DeviceNotAvailableException

getKeyguardState

public KeyguardControllerState getKeyguardState ()

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

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

Throws
DeviceNotAvailableException

getLastExpectedRebootTimeMillis

public long getLastExpectedRebootTimeMillis ()

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

Returns
long

getLogcat

public InputStreamSource getLogcat ()

Grabs a snapshot stream of the logcat data.

Works in two modes:

  • If the logcat is currently being captured in the background, will return up to TestDeviceOptions#getMaxLogcatDataSize() bytes of the current contents of the background logcat capture
  • Otherwise, will return a static dump of the logcat data if device is currently responding

    Returns
    InputStreamSource

  • getLogcat

    public InputStreamSource getLogcat (int maxBytes)

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

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

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

    Returns
    InputStreamSource

    getLogcatDump

    public InputStreamSource getLogcatDump ()

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

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

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

    getLogcatSince

    public InputStreamSource getLogcatSince (long date)

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

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

    Returns
    InputStreamSource

    getMacAddress

    public String getMacAddress ()

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

    Returns
    String

    getMaxNumberOfRunningUsersSupported

    public int getMaxNumberOfRunningUsersSupported ()

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

    Returns
    int an integer indicating the number of simultaneously running users

    Throws
    DeviceNotAvailableException

    getMaxNumberOfUsersSupported

    public int getMaxNumberOfUsersSupported ()

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

    Returns
    int an integer indicating the number of supported users

    Throws
    DeviceNotAvailableException

    getMonitor

    public IDeviceStateMonitor getMonitor ()

    Return the IDeviceStateMonitor associated with device.

    Returns
    IDeviceStateMonitor

    getMountPoint

    public String getMountPoint (String mountName)

    Returns a mount point.

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

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

    Parameters
    mountName String : the name of the mount point

    Returns
    String the mount point or null

    getMountPointInfo

    public ITestDevice.MountPointInfo getMountPointInfo (String mountpoint)

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

    Parameters
    mountpoint String

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

    Throws
    DeviceNotAvailableException

    getMountPointInfo

    public  getMountPointInfo ()

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

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

    Throws
    DeviceNotAvailableException

    getOptions

    public TestDeviceOptions getOptions ()

    Fetch the test options for the device.

    Returns
    TestDeviceOptions TestDeviceOptions related to the device under test.

    getPartitionFreeSpace

    public long getPartitionFreeSpace (String partition)

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

    Parameters
    partition String

    Returns
    long the amount of free space in KB

    Throws
    DeviceNotAvailableException

    getPrimaryUserId

    public Integer getPrimaryUserId ()

    Returns the primary user id.

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

    Throws
    DeviceNotAvailableException

    getProcessByName

    public ProcessInfo getProcessByName (String processName)

    Helper method runs the "ps" command and returns USER, PID and NAME of the given process name.

    Parameters
    processName String

    Returns
    ProcessInfo ProcessInfo of given processName

    Throws
    DeviceNotAvailableException

    getProcessPid

    public String getProcessPid (String process)

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

    Parameters
    process String

    Returns
    String

    Throws
    DeviceNotAvailableException

    getProcesses

    public  getProcesses ()

    Helper method runs the "ps" command and returns list of USER, PID and NAME of all the processes.

    Returns
    List of ProcessInfo objects

    Throws
    DeviceNotAvailableException

    getProductType

    public String getProductType ()

    Convenience method to get the product type of this device.

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

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

    Throws
    DeviceNotAvailableException

    getProductVariant

    public String getProductVariant ()

    Convenience method to get the product variant of this device.

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

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

    Throws
    DeviceNotAvailableException

    getProperty

    public String getProperty (String name)

    Retrieve the given property value from the device.

    Parameters
    name String : the property name

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

    Throws
    DeviceNotAvailableException

    getRecoveryMode

    public ITestDevice.RecoveryMode getRecoveryMode ()

    Get the current recovery mode used for the device.

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

    getScreenshot

    public InputStreamSource getScreenshot (int displayId)

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

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

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

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

    Throws
    DeviceNotAvailableException

    getScreenshot

    public InputStreamSource getScreenshot (String format)

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

    Parameters
    format String : supported PNG, JPEG

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

    Throws
    DeviceNotAvailableException

    getScreenshot

    public InputStreamSource getScreenshot (String format, 
                    boolean rescale)

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

    Parameters
    format String : supported PNG, JPEG

    rescale boolean : if screenshot should be rescaled to reduce the size of resulting image

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

    Throws
    DeviceNotAvailableException

    getScreenshot

    public InputStreamSource getScreenshot ()

    Grabs a screenshot from the device.

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

    Throws
    DeviceNotAvailableException

    getSerialNumber

    public String getSerialNumber ()

    Convenience method to get serial number of this device.

    Returns
    String the String serial number

    getSetting

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

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

    Parameters
    userId int

    namespace String

    key String

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

    Throws
    DeviceNotAvailableException

    getSetting

    public String getSetting (String namespace, 
                    String key)

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

    Parameters
    namespace String

    key String

    Returns
    String

    Throws
    DeviceNotAvailableException

    getSimOperator

    public String getSimOperator ()

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

    Returns
    String

    getSimState

    public String getSimState ()

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

    Returns
    String

    getTombstones

    public  getTombstones ()

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

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

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

    Throws
    DeviceNotAvailableException

    getTotalMemory

    public long getTotalMemory ()

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

    Returns
    long

    getUninstallablePackageNames

    public  getUninstallablePackageNames ()

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

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

    Throws
    DeviceNotAvailableException

    getUseFastbootErase

    public boolean getUseFastbootErase ()

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

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

    getUserFlags

    public int getUserFlags (int userId)

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

    Parameters
    userId int

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

    Throws
    DeviceNotAvailableException

    getUserInfos

    public  getUserInfos ()

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

    Returns
    the list of UserInfo objects.

    Throws
    DeviceNotAvailableException

    getUserSerialNumber

    public int getUserSerialNumber (int userId)

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

    Parameters
    userId int

    Returns
    int

    Throws
    DeviceNotAvailableException

    handleAllocationEvent

    public IManagedTestDevice.DeviceEventResponse handleAllocationEvent (DeviceEvent event)

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

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

    Parameters
    event DeviceEvent

    Returns
    IManagedTestDevice.DeviceEventResponse

    hasFeature

    public boolean hasFeature (String feature)

    Check if a feature is available on a device.

    Parameters
    feature String : which format should be "feature: ".

    Returns
    boolean True if feature is found, false otherwise.

    Throws
    DeviceNotAvailableException

    installPackage

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

    Install an Android package on device.

    Parameters
    packageFile File : the apk file to install

    reinstall boolean : true if a reinstall should be performed

    extraArgs String : optional extra arguments to pass. See 'adb shell pm install --help' for available options.

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

    Throws
    DeviceNotAvailableException

    installPackage

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

    Install an Android package on device.

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

    Parameters
    packageFile File : the apk file to install

    reinstall boolean : true if a reinstall should be performed

    grantPermissions boolean : if all runtime permissions should be granted at install time

    extraArgs String : optional extra arguments to pass. See 'adb shell pm install --help' for available options.

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

    Throws
    DeviceNotAvailableException

    installPackageForUser

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

    Install an Android package on device for a given user.

    Parameters
    packageFile File : the apk file to install

    reinstall boolean : true if a reinstall should be performed

    userId int : the integer user id to install for.

    extraArgs String : optional extra arguments to pass. See 'adb shell pm install --help' for available options.

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

    Throws
    DeviceNotAvailableException

    installPackageForUser

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

    Install an Android package on device for a given user.

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

    Parameters
    packageFile File : the apk file to install

    reinstall boolean : true if a reinstall should be performed

    grantPermissions boolean : if all runtime permissions should be granted at install time

    userId int : the integer user id to install for.

    extraArgs String : optional extra arguments to pass. See 'adb shell pm install --help' for available options.

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

    Throws
    DeviceNotAvailableException

    isAdbRoot

    public boolean isAdbRoot ()

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    isAdbTcp

    public boolean isAdbTcp ()

    Returns
    boolean

    isDeviceEncrypted

    public boolean isDeviceEncrypted ()

    Returns if the device is encrypted.

    Returns
    boolean true if the device is encrypted.

    Throws
    DeviceNotAvailableException

    isDirectory

    public boolean isDirectory (String path)

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

    Parameters
    path String

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    isEnableAdbRoot

    public boolean isEnableAdbRoot ()

    Returns
    boolean true if adb root should be enabled on device

    isEncryptionSupported

    public boolean isEncryptionSupported ()

    Returns if encryption is supported on the device.

    Returns
    boolean true if the device supports encryption.

    Throws
    DeviceNotAvailableException

    isExecutable

    public boolean isExecutable (String fullPath)

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

    Parameters
    fullPath String

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    isFastbootEnabled

    public boolean isFastbootEnabled ()

    Return if fastboot is available for the device.

    Returns
    boolean

    isHeadless

    public boolean isHeadless ()

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

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    isMultiUserSupported

    public boolean isMultiUserSupported ()

    Determines if multi user is supported.

    Returns
    boolean true if multi user is supported, false otherwise

    Throws
    DeviceNotAvailableException

    isPackageInstalled

    public boolean isPackageInstalled (String packageName, 
                    String userId)

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

    Parameters
    packageName String : the package we are checking if it's installed.

    userId String : The user id we are checking the package is installed for. If null, primary user zero will be used.

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

    Throws
    DeviceNotAvailableException

    isPackageInstalled

    public boolean isPackageInstalled (String packageName)

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

    Parameters
    packageName String

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

    Throws
    DeviceNotAvailableException

    isRuntimePermissionSupported

    public boolean isRuntimePermissionSupported ()

    Check whether platform on device supports runtime permission granting

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

    Throws
    DeviceNotAvailableException

    isUserRunning

    public boolean isUserRunning (int userId)

    Check if a given user is running.

    Parameters
    userId int

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

    Throws
    DeviceNotAvailableException

    isUserSecondary

    public boolean isUserSecondary (int userId)

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

    Parameters
    userId int

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

    Throws
    DeviceNotAvailableException

    isWifiEnabled

    public boolean isWifiEnabled ()

    Test if wifi is enabled.

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

    Returns
    boolean true if wifi is enabled. false if disabled

    Throws
    DeviceNotAvailableException

    listDisplayIds

    public  listDisplayIds ()

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

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

    Throws
    DeviceNotAvailableException

    listUsers

    public  listUsers ()

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

    Returns
    the list of user ids.

    Throws
    DeviceNotAvailableException

    logBugreport

    public boolean logBugreport (String dataName, 
                    ITestLogger listener)

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

    Parameters
    dataName String : name under which the bugreport will be reported.

    listener ITestLogger : an ITestLogger to log the bugreport.

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

    logOnDevice

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

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

    Parameters
    tag String : The tag under which we log our message in the logcat.

    level Log.LogLevel : The debug level of the message in the logcat.

    format String : The message format.

    args Object : the args to be replaced via String.format().

    nonBlockingReboot

    public void nonBlockingReboot ()

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

    Throws
    DeviceNotAvailableException

    postAdbRootAction

    public void postAdbRootAction ()

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

    Throws
    DeviceNotAvailableException

    postAdbUnrootAction

    public void postAdbUnrootAction ()

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

    Throws
    DeviceNotAvailableException

    postBootSetup

    public void postBootSetup ()

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

    Should be called after device is fully booted/available

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

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

    Throws
    DeviceNotAvailableException

    postInvocationTearDown

    public void postInvocationTearDown ()

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

    preInvocationSetup

    public void preInvocationSetup ( IBuildInfo info)

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

    Parameters
    info IBuildInfo

    Throws
    DeviceNotAvailableException
    TargetSetupError

    pullDir

    public boolean pullDir (String deviceFilePath, 
                    File localDir)

    Recursively pull directory contents from device.

    Parameters
    deviceFilePath String : the absolute file path of the remote source

    localDir File : the local directory to pull files into

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

    Throws
    DeviceNotAvailableException

    pullFile

    public boolean pullFile (String remoteFilePath, 
                    File localFile)

    Retrieves a file off device.

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

    localFile File : the local file to store contents in. If non-empty, contents will be replaced.

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

    Throws
    DeviceNotAvailableException

    pullFile

    public File pullFile (String remoteFilePath)

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

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

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

    Throws
    DeviceNotAvailableException

    pullFileContents

    public String pullFileContents (String remoteFilePath)

    Retrieves a file off device, and returns the contents.

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

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

    Throws
    DeviceNotAvailableException

    pullFileFromExternal

    public File pullFileFromExternal (String remoteFilePath)

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

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

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

    Throws
    DeviceNotAvailableException

    pushDir

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

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

    Parameters
    localFileDir File : the local directory to push

    deviceFilePath String : the absolute file path of the remote destination

    excludedDirectories : Set of excluded directories names that shouldn't be pushed.

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

    Throws
    DeviceNotAvailableException

    pushDir

    public boolean pushDir (File localFileDir, 
                    String deviceFilePath)

    Recursively push directory contents to device.

    Parameters
    localFileDir File : the local directory to push

    deviceFilePath String : the absolute file path of the remote destination

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

    Throws
    DeviceNotAvailableException

    pushFile

    public boolean pushFile (File localFile, 
                    String remoteFilePath)

    Push a file to device

    Parameters
    localFile File : the local file to push

    remoteFilePath String : the remote destination absolute file path

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

    Throws
    DeviceNotAvailableException

    pushString

    public boolean pushString (String contents, 
                    String remoteFilePath)

    Push file created from a string to device

    Parameters
    contents String : the contents of the file to push

    remoteFilePath String : the remote destination absolute file path

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

    Throws
    DeviceNotAvailableException

    reboot

    public void reboot ()

    Reboots the device into adb mode.

    Blocks until device becomes available.

    Throws
    DeviceNotAvailableException

    rebootIntoBootloader

    public void rebootIntoBootloader ()

    Reboots the device into bootloader mode.

    Blocks until device is in bootloader mode.

    Throws
    DeviceNotAvailableException

    rebootIntoRecovery

    public void rebootIntoRecovery ()

    Reboots the device into adb recovery mode.

    Blocks until device enters recovery

    Throws
    DeviceNotAvailableException

    rebootUntilOnline

    public void rebootUntilOnline ()

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

    Throws
    DeviceNotAvailableException

    recoverDevice

    public void recoverDevice ()

    Attempts to recover device communication.

    Throws
    DeviceNotAvailableException if device is not longer available

    remountSystemWritable

    public void remountSystemWritable ()

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

    Throws
    DeviceNotAvailableException

    removeAdmin

    public boolean removeAdmin (String componentName, 
                    int userId)

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

    Parameters
    componentName String : of device admin to be removed.

    userId int : of user that the device admin lives in.

    Returns
    boolean True if it is successful, false otherwise.

    Throws
    DeviceNotAvailableException

    removeOwners

    public void removeOwners ()

    Remove all existing device profile owners with the best effort.

    Throws
    DeviceNotAvailableException

    removeUser

    public boolean removeUser (int userId)

    Remove a given user from the device.

    Parameters
    userId int : of the user to remove

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

    Throws
    DeviceNotAvailableException

    runInstrumentationTests

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

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

    Parameters
    runner IRemoteAndroidTestRunner : the IRemoteAndroidTestRunner which runs the tests

    listeners ITestLifeCycleReceiver : the test result listener(s)

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

    Throws
    DeviceNotAvailableException

    runInstrumentationTests

    public boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, 
                     listeners)

    Runs instrumentation tests, and provides device recovery.

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

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

    Parameters
    runner IRemoteAndroidTestRunner : the IRemoteAndroidTestRunner which runs the tests

    listeners : the test result listeners

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

    Throws
    DeviceNotAvailableException

    runInstrumentationTestsAsUser

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

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

    Parameters
    runner IRemoteAndroidTestRunner

    userId int

    listeners ITestLifeCycleReceiver

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    runInstrumentationTestsAsUser

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

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

    Parameters
    runner IRemoteAndroidTestRunner

    userId int

    listeners

    Returns
    boolean

    Throws
    DeviceNotAvailableException

    setDate

    public void setDate (Date date)

    Sets the date on device

    Note: setting date on device requires root

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

    Throws
    DeviceNotAvailableException

    setDeviceOwner

    public boolean setDeviceOwner (String componentName, 
                    int userId)

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

    Parameters
    componentName String : of device admin to be device owner.

    userId int : of the user that the device owner lives in.

    Returns
    boolean True if it is successful, false otherwise.

    Throws
    DeviceNotAvailableException

    setDeviceState

    public void setDeviceState ( TestDeviceState deviceState)

    Update the device's state.

    Parameters
    deviceState TestDeviceState : the TestDeviceState

    setEmulatorOutputStream

    public void setEmulatorOutputStream ( SizeLimitedOutputStream output)

    For emulator set SizeLimitedOutputStream to log output

    Parameters
    output SizeLimitedOutputStream : to log the output

    setEmulatorProcess

    public void setEmulatorProcess (Process p)

    Sets the Process , when this device is an emulator.

    Parameters
    p Process

    setFastbootEnabled

    public void setFastbootEnabled (boolean fastbootEnabled)

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

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

    setFastbootPath

    public void setFastbootPath (String fastbootPath)

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

    Parameters
    fastbootPath String

    setIDevice

    public void setIDevice (IDevice newDevice)

    Update the IDevice associated with this ITestDevice.

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

    Parameters
    newDevice IDevice : the IDevice

    setOptions

    public void setOptions ( TestDeviceOptions options)

    Set the TestDeviceOptions for the device

    Parameters
    options TestDeviceOptions

    setProperty

    public boolean setProperty (String propKey, 
                    String propValue)

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

    Parameters
    propKey String : The key targeted to be set.

    propValue String : The property value to be set.

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

    Throws
    DeviceNotAvailableException

    setRecovery

    public void setRecovery ( IDeviceRecovery recovery)

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

    Parameters
    recovery IDeviceRecovery : the IDeviceRecovery

    setRecoveryMode

    public void setRecoveryMode ( ITestDevice.RecoveryMode mode)

    Set the current recovery mode to use for the device.

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

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

    setSetting

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

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

    Parameters
    namespace String

    key String

    value String

    Throws
    DeviceNotAvailableException

    setSetting

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

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

    Parameters
    userId int

    namespace String

    key String

    value String

    Throws
    DeviceNotAvailableException

    setUseFastbootErase

    public void setUseFastbootErase (boolean useFastbootErase)

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

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

    startLogcat

    public void startLogcat ()

    Start capturing logcat output from device in the background.

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

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

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

    startUser

    public boolean startUser (int userId)

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

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

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

    Throws
    DeviceNotAvailableException

    startUser

    public boolean startUser (int userId, 
                    boolean waitFlag)

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

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

    waitFlag boolean : will make the command wait until user is started and unlocked.

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

    Throws
    DeviceNotAvailableException

    stopEmulatorOutput

    public void stopEmulatorOutput ()

    Close and delete the emulator output.

    stopLogcat

    public void stopLogcat ()

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

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

    stopUser

    public boolean stopUser (int userId)

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

    Parameters
    userId int : of the user to stop.

    Returns
    boolean true if the user was successfully stopped.

    Throws
    DeviceNotAvailableException

    stopUser

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

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

    Parameters
    userId int : of the user to stop.

    waitFlag boolean : will make the command wait until user is stopped.

    forceFlag boolean : will force stop the user.

    Returns
    boolean true if the user was successfully stopped.

    Throws
    DeviceNotAvailableException

    switchToAdbTcp

    public String switchToAdbTcp ()

    Switch device to adb-over-tcp mode.

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

    Throws
    DeviceNotAvailableException

    switchToAdbUsb

    public boolean switchToAdbUsb ()

    Switch device to adb over usb mode.

    Returns
    boolean true if switch was successful, false otherwise.

    Throws
    DeviceNotAvailableException

    switchUser

    public boolean switchUser (int userId)

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

    Parameters
    userId int

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

    Throws
    DeviceNotAvailableException

    switchUser

    public boolean switchUser (int userId, 
                    long timeout)

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

    Parameters
    userId int

    timeout long : to wait before returning false for switch-user failed.

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

    Throws
    DeviceNotAvailableException

    syncFiles

    public boolean syncFiles (File localFileDir, 
                    String deviceFilePath)

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

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

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

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

    Parameters
    localFileDir File : the local file directory containing files to recursively push.

    deviceFilePath String : the remote destination absolute file path root. All directories in thos file path must be readable. ie pushing to /data/local/tmp when adb is not root will fail

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

    Throws
    DeviceNotAvailableException

    takeBugreport

    public Bugreport takeBugreport ()

    Take a bugreport and returns it inside a Bugreport object to handle it. Return null in case of issue.

    File referenced in the Bugreport object need to be cleaned via Bugreport#close() .

    Returns
    Bugreport

    unencryptDevice

    public boolean unencryptDevice ()

    Unencrypts the device.

    Unencrypting the device may cause device to be wiped and may reboot device. This method will block until device is available and ready for testing. Requires fastboot inorder to wipe the userdata partition.

    Returns
    boolean true if successful.

    Throws
    DeviceNotAvailableException

    uninstallPackage

    public String uninstallPackage (String packageName)

    Uninstall an Android package from device.

    Parameters
    packageName String : the Android package to uninstall

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

    Throws
    DeviceNotAvailableException

    unlockDevice

    public boolean unlockDevice ()

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

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

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

    Throws
    DeviceNotAvailableException

    waitForBootComplete

    public boolean waitForBootComplete (long timeOut)

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

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

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

    Throws
    DeviceNotAvailableException

    waitForDeviceAvailable

    public void waitForDeviceAvailable ()

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

    Throws
    DeviceNotAvailableException

    waitForDeviceAvailable

    public void waitForDeviceAvailable (long waitTime)

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

    Parameters
    waitTime long : the time in ms to wait

    Throws
    DeviceNotAvailableException

    waitForDeviceInRecovery

    public boolean waitForDeviceInRecovery (long waitTime)

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

    Parameters
    waitTime long : the time in ms to wait

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

    waitForDeviceNotAvailable

    public boolean waitForDeviceNotAvailable (long waitTime)

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

    Parameters
    waitTime long : the time in ms to wait

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

    waitForDeviceOnline

    public void waitForDeviceOnline ()

    Blocks until device is visible via adb. Uses default timeout

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

    Throws
    DeviceNotAvailableException

    waitForDeviceOnline

    public void waitForDeviceOnline (long waitTime)

    Blocks until device is visible via adb.

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

    Parameters
    waitTime long : the time in ms to wait

    Throws
    DeviceNotAvailableException

    waitForDeviceShell

    public boolean waitForDeviceShell (long waitTime)

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

    Parameters
    waitTime long : the time in ms to wait

    Returns
    boolean true if device becomes responsive before waitTime elapses.

    Protected methods

    checkApiLevelAgainst

    protected void checkApiLevelAgainst (String feature, 
                    int strictMinLevel)

    Parameters
    feature String

    strictMinLevel int

    createRebootDeviceAction

    protected NativeDevice.RebootDeviceAction createRebootDeviceAction (String into)

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

    Parameters
    into String : the bootloader name to reboot into, or null to just reboot the device.

    Returns
    NativeDevice.RebootDeviceAction the created RebootDeviceAction .

    doAdbReboot

    protected void doAdbReboot (String into)

    Perform a adb reboot.

    Parameters
    into String : the bootloader name to reboot into, or null to just reboot the device.

    Throws
    DeviceNotAvailableException

    ensureRuntimePermissionSupported

    protected void ensureRuntimePermissionSupported ()

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

    Throws
    DeviceNotAvailableException

    getBugreportInternal

    protected InputStreamSource getBugreportInternal ()

    Returns
    InputStreamSource

    getBugreportzInternal

    protected File getBugreportzInternal ()

    Internal Helper method to get the bugreportz zip file as a ERROR(/File) .

    Returns
    File

    getRunUtil

    protected IRunUtil getRunUtil ()

    Get the RunUtil instance to use.

    Returns
    IRunUtil

    internalGetProperty

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

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

    Parameters
    propName String : The name of the device property as returned by `adb shell getprop`

    fastbootVar String : The name of the equivalent fastboot variable to query. if null , fastboot query will not be attempted

    description String : A simple description of the variable. First letter should be capitalized.

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

    Throws
    DeviceNotAvailableException

    isNewer

    protected boolean isNewer (File localFile, 
                    IFileEntry entry)

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

    Parameters
    localFile File

    entry IFileEntry

    Returns
    boolean

    performDeviceAction

    protected boolean performDeviceAction (String actionDescription, 
                    com.android.tradefed.device.NativeDevice.DeviceAction action, 
                    int retryAttempts)

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

    Parameters
    actionDescription String : a short description of action to be performed. Used for logging purposes only.

    action com.android.tradefed.device.NativeDevice.DeviceAction : the action to be performed

    retryAttempts int : the retry attempts to make for action if it fails but recovery succeeds

    Returns
    boolean true if action was performed successfully

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

    postAdbReboot

    protected void postAdbReboot ()

    Possible extra actions that can be taken after a reboot.

    Throws
    DeviceNotAvailableException

    prePostBootSetup

    protected void prePostBootSetup ()

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

    Throws
    DeviceNotAvailableException

    setClock

    protected void setClock (Clock clock)

    Set the Clock instance to use.

    Parameters
    clock Clock

    setLogStartDelay

    protected void setLogStartDelay (int delay)

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

    Parameters
    delay int : the delay in ms

    waitForDeviceNotAvailable

    protected void waitForDeviceNotAvailable (String operationDesc, 
                    long time)

    Parameters
    operationDesc String

    time long