NativeDevice

INVALID_USER_ID

public static final int INVALID_USER_ID

ค่าที่ส่งคืนสำหรับ ID ผู้ใช้ที่ไม่ถูกต้อง/ไม่พบ: UserHandle กำหนดค่า -10000

ค่าคงที่: -10000 (0xffffd8f0)

MAX_HOST_DEVICE_TIME_OFFSET

protected static final long MAX_HOST_DEVICE_TIME_OFFSET

ค่าคงที่: 5000 (0x0000000000001388)

MAX_RETRY_ATTEMPTS

protected static final int MAX_RETRY_ATTEMPTS

จำนวนเริ่มต้นของการลองใหม่คำสั่งพยายามดำเนินการ

ค่าคงที่: 2 (0x00000002)

SD_CARD

protected static final String SD_CARD

STORAGE_EMULATED

protected static final String STORAGE_EMULATED

mOptions

protected TestDeviceOptions mOptions

mStateMonitor

protected final IDeviceStateMonitor mStateMonitor

NativeDevice

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

สร้าง TestDevice

checkApiLevelAgainstNextRelease

public boolean checkApiLevelAgainstNextRelease (int strictMinLevel)

ตรวจสอบว่าคุณสมบัติได้รับการสนับสนุนในปัจจุบันหรือไม่โดยได้รับการสนับสนุนในระดับที่น้อยที่สุด วิธีนี้คำนึงถึงคุณลักษณะที่ยังไม่เผยแพร่ก่อนที่จะยกระดับ API

ตรวจสอบการเชื่อมต่อ

public boolean checkConnectivity ()

ตรวจสอบว่าอุปกรณ์มีการเชื่อมต่อเครือข่าย

clearErrorDialogs

public boolean clearErrorDialogs ()

พยายามปิดกล่องโต้ตอบข้อผิดพลาดที่แสดงอยู่ใน UI ของอุปกรณ์ในปัจจุบัน

clearLastConnectedWifiNetwork

public void clearLastConnectedWifiNetwork ()

ล้างเครือข่าย wifi ที่เชื่อมต่อล่าสุด ควรเรียกสิ่งนี้เมื่อเริ่มการเรียกใช้ใหม่เพื่อหลีกเลี่ยงการเชื่อมต่อกับเครือข่าย wifi ที่ใช้ในการทดสอบครั้งก่อนหลังจากอุปกรณ์รีบูต

clearLogcat

public void clearLogcat ()

ลบข้อมูล logcat ที่สะสมไว้

สิ่งนี้มีประโยชน์สำหรับกรณีที่คุณต้องการให้แน่ใจว่า ITestDevice#getLogcat() ส่งคืนเฉพาะข้อมูลบันทึกที่สร้างขึ้นหลังจากจุดหนึ่ง (เช่น หลังจากแฟลชบิลด์อุปกรณ์ใหม่ ฯลฯ)

connectToWifiNetwork

public boolean connectToWifiNetwork ( wifiSsidToPsk, 
                boolean scanSsid)

เชื่อมต่อกับเครือข่าย wifi

เปิด wifi และบล็อกจนกว่าจะทำการเชื่อมต่อสำเร็จกับหนึ่งในเครือข่าย wifi ที่ระบุในแผนที่ wifiSsidToPsk เมื่อทำการเชื่อมต่อแล้ว อินสแตนซ์จะพยายามกู้คืนการเชื่อมต่อหลังจากรีบูตทุกครั้งจนกว่า ITestDevice#disconnectFromWifi() หรือ ITestDevice#clearLastConnectedWifiNetwork() จะถูกเรียก

connectToWifiNetwork

public boolean connectToWifiNetwork (String wifiSsid, 
                String wifiPsk)

เชื่อมต่อกับเครือข่าย wifi

เปิด wifi และบล็อกจนกว่าจะทำการเชื่อมต่อกับเครือข่าย wifi ที่ระบุได้สำเร็จ เมื่อทำการเชื่อมต่อแล้ว อินสแตนซ์จะพยายามกู้คืนการเชื่อมต่อหลังจากรีบูตทุกครั้งจนกว่า ITestDevice#disconnectFromWifi() หรือ ITestDevice#clearLastConnectedWifiNetwork() จะถูกเรียก

connectToWifiNetwork

public boolean connectToWifiNetwork ( wifiSsidToPsk)

เชื่อมต่อกับเครือข่าย wifi

เปิด wifi และบล็อกจนกว่าจะทำการเชื่อมต่อสำเร็จกับหนึ่งในเครือข่าย wifi ที่ระบุในแผนที่ wifiSsidToPsk เมื่อทำการเชื่อมต่อแล้ว อินสแตนซ์จะพยายามกู้คืนการเชื่อมต่อหลังจากรีบูตทุกครั้งจนกว่า ITestDevice#disconnectFromWifi() หรือ ITestDevice#clearLastConnectedWifiNetwork() จะถูกเรียก.f

connectToWifiNetwork

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

เชื่อมต่อกับเครือข่าย wifi

เปิด wifi และบล็อกจนกว่าจะทำการเชื่อมต่อกับเครือข่าย wifi ที่ระบุได้สำเร็จ เมื่อทำการเชื่อมต่อแล้ว อินสแตนซ์จะพยายามกู้คืนการเชื่อมต่อหลังจากรีบูตทุกครั้งจนกว่า ITestDevice#disconnectFromWifi() หรือ ITestDevice#clearLastConnectedWifiNetwork() จะถูกเรียก

connectToWifiNetworkIfNeeded

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

ตัวแปรของ connectToWifiNetwork(String, String) ที่เชื่อมต่อเฉพาะเมื่ออุปกรณ์ไม่มีการเชื่อมต่อเครือข่ายในปัจจุบัน

connectToWifiNetworkIfNeeded

public boolean connectToWifiNetworkIfNeeded (String wifiSsid, 
                String wifiPsk)

ตัวแปรของ connectToWifiNetwork(String, String) ที่เชื่อมต่อเฉพาะเมื่ออุปกรณ์ไม่มีการเชื่อมต่อเครือข่ายในปัจจุบัน

createUser

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

สร้างผู้ใช้ด้วยชื่อที่กำหนดและแฟล็กที่ให้มา

createUser

public int createUser (String name)

สร้างผู้ใช้ด้วยชื่อที่กำหนดและแฟล็กเริ่มต้น 0

createUserNoThrow

public int createUserNoThrow (String name)

สร้างผู้ใช้ด้วยชื่อที่กำหนดและแฟล็กเริ่มต้น 0

ลบไฟล์

public void deleteFile (String deviceFilePath)

วิธีการช่วยเหลือในการลบไฟล์หรือไดเร็กทอรีบนอุปกรณ์

อุปกรณ์SoftRestarted

public boolean deviceSoftRestarted (ProcessInfo prevSystemServerProcess)

วิธีตัวช่วยในการตรวจสอบว่าอุปกรณ์ซอฟต์รีสตาร์ทโดยเปรียบเทียบ system_server ปัจจุบันกับ system_server ProcessInfo ก่อนหน้าหรือไม่ ใช้ getProcessByName(String) เพื่อรับ ProcessInfo

อุปกรณ์SoftRestartedตั้งแต่

public boolean deviceSoftRestartedSince (long utcEpochTime, 
                TimeUnit timeUnit)

วิธีตัวช่วยในการตรวจสอบว่าอุปกรณ์ซอฟต์รีสตาร์ทตั้งแต่เวลา UTC ตั้งแต่ยุคจากอุปกรณ์และ ERROR(/TimeUnit) Soft-Restart หมายถึง system_server ที่รีสตาร์ทภายนอกฮาร์ดรีบูตของอุปกรณ์ (เช่น: ร้องขอให้รีบูต) อุปกรณ์ปัจจุบัน utcEpochTime ในหน่วยมิลลิวินาทีสามารถรับได้โดยวิธี getDeviceDate()

ปิดการใช้งานAdbRoot

public boolean disableAdbRoot ()

ปิดรูท adb

การปิดใช้งานรูท adb อาจทำให้อุปกรณ์ยกเลิกการเชื่อมต่อจาก adb วิธีนี้จะบล็อกจนกว่าอุปกรณ์จะพร้อมใช้งาน

ปิดการใช้งานKeyguard

public void disableKeyguard ()

ความพยายามที่จะปิดการใช้งานคีย์การ์ด

ขั้นแรก ให้รอจนกว่าการส่งอินพุตจะพร้อม สิ่งนี้จะเกิดขึ้นในช่วงเวลาเดียวกับที่อุปกรณ์รายงาน BOOT_COMPLETE ซึ่งดูเหมือนจะไม่พร้อมกัน เนื่องจากการใช้งานเฟรมเวิร์กในปัจจุบันมีสภาวะการแข่งขันเป็นครั้งคราว จากนั้นคำสั่งจะถูกส่งไปยังปิดคีย์การ์ด (ใช้งานได้กับคีย์การ์ดที่ไม่ปลอดภัยเท่านั้น)

ปิดใช้งานNetworkMonitor

public boolean disableNetworkMonitor ()

ปิดใช้งานการตรวจสอบเครือข่ายบนอุปกรณ์

ตัดการเชื่อมต่อจากWifi

public boolean disconnectFromWifi ()

ตัดการเชื่อมต่อจากเครือข่าย wifi

ลบเครือข่ายทั้งหมดออกจากรายการเครือข่ายที่รู้จักและปิดใช้งาน wifi

ไม่FileExist

public boolean doesFileExist (String deviceFilePath, 
                int userId)

วิธี Helper เพื่อตรวจสอบว่าไฟล์ในอุปกรณ์มีอยู่สำหรับผู้ใช้ที่กำหนดหรือไม่

ไม่FileExist

public boolean doesFileExist (String deviceFilePath)

วิธี Helper เพื่อตรวจสอบว่าไฟล์ในอุปกรณ์มีอยู่หรือไม่

dumpHeap

public File dumpHeap (String process, 
                String devicePath)

พยายามดัมพ์ฮีพจาก system_server เป็นความรับผิดชอบของผู้โทรในการล้างไฟล์ที่ทิ้ง

เปิดใช้งานAdbRoot

public boolean enableAdbRoot ()

เปิด adb root หากการตั้งค่า "เปิดใช้งานรูท" เป็น "เท็จ" จะบันทึกข้อความและส่งคืนโดยไม่ต้องเปิดใช้งานรูท

การเปิดใช้งาน adb root อาจทำให้อุปกรณ์ตัดการเชื่อมต่อจาก adb วิธีนี้จะบล็อกจนกว่าอุปกรณ์จะพร้อมใช้งาน

enableNetworkMonitor

public boolean enableNetworkMonitor ()

เปิดใช้งานการตรวจสอบเครือข่ายบนอุปกรณ์

รันAdbCommand

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

เมธอด Helper ซึ่งรันคำสั่ง adb เป็นคำสั่งระบบที่มีการหมดเวลาที่ระบุ

ควรใช้ executeShellCommand(String) แทนทุกเมื่อที่ทำได้ เนื่องจากวิธีการดังกล่าวให้การตรวจจับความล้มเหลวและประสิทธิภาพที่ดีขึ้น

รันAdbCommand

public String executeAdbCommand (String... cmdArgs)

เมธอด Helper ซึ่งรันคำสั่ง adb เป็นคำสั่งระบบ

ควรใช้ executeShellCommand(String) แทนทุกเมื่อที่ทำได้ เนื่องจากวิธีการดังกล่าวให้การตรวจจับความล้มเหลวและประสิทธิภาพที่ดีขึ้น

ดำเนินการFastbootCommand

public CommandResult executeFastbootCommand (String... cmdArgs)

เมธอด Helper ซึ่งรันคำสั่ง fastboot เป็นคำสั่งระบบโดยมีการหมดเวลาเริ่มต้น 2 นาที

คาดว่าจะใช้เมื่ออุปกรณ์อยู่ในโหมด fastboot แล้ว

ดำเนินการFastbootCommand

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

เมธอด Helper ซึ่งรันคำสั่ง fastboot เป็นคำสั่งระบบ

คาดว่าจะใช้เมื่ออุปกรณ์อยู่ในโหมด fastboot แล้ว

รันLongFastbootCommand

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

เมธอด Helper ซึ่งรันคำสั่ง fastboot ที่รันเป็นเวลานานเป็นคำสั่งระบบพร้อมตัวแปรสภาพแวดล้อมของระบบ

เหมือนกันกับ executeFastbootCommand(String) ยกเว้นว่าใช้การหมดเวลานานขึ้น

รันLongFastbootCommand

public CommandResult executeLongFastbootCommand (String... cmdArgs)

เมธอด Helper ซึ่งรันคำสั่ง fastboot ที่รันเป็นเวลานานเป็นคำสั่งระบบ

เหมือนกันกับ executeFastbootCommand(String) ยกเว้นว่าใช้การหมดเวลานานขึ้น

executeShellCommand

public String executeShellCommand (String command)

เมธอด Helper ซึ่งรันคำสั่ง adb shell และส่งคืนเอาต์พุตเป็น String

executeShellCommand

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

ดำเนินการคำสั่งเชลล์ adb พร้อมพารามิเตอร์เพิ่มเติมเพื่อควบคุมพฤติกรรมของคำสั่ง

executeShellCommand

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

ดำเนินการคำสั่งเชลล์ adb พร้อมพารามิเตอร์เพิ่มเติมเพื่อควบคุมพฤติกรรมของคำสั่ง

executeShellCommand

public void executeShellCommand (String command, 
                IShellOutputReceiver receiver)

ดำเนินการคำสั่งเชลล์ adb ที่กำหนด ลองใหม่หลายครั้งหากคำสั่งล้มเหลว

รูปแบบที่ง่ายกว่าของ executeShellCommand(String, com.android.ddmlib.IShellOutputReceiver, long, TimeUnit, int) พร้อมค่าเริ่มต้น

executeShellV2Command

public CommandResult executeShellV2Command (String cmd)

เมธอด Helper ซึ่งรันคำสั่ง adb shell และส่งกลับผลลัพธ์เป็น CommandResult ที่เติมอย่างถูกต้องด้วยเอาต์พุตสถานะคำสั่ง stdout และ stderr

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                OutputStream pipeToOutput)

เมธอด Helper ที่รันคำสั่งเชลล์ adb และส่งคืนผลลัพธ์เป็น CommandResult ที่เติมอย่างเหมาะสมด้วยเอาต์พุตสถานะคำสั่งและ stderr stdout ถูกนำไปยังสตรีมที่ระบุ

executeShellV2Command

public CommandResult executeShellV2Command (String cmd, 
                File pipeAsInput)

เมธอด Helper ที่รันคำสั่งเชลล์ adb และส่งคืนผลลัพธ์เป็น CommandResult ที่เติมอย่างเหมาะสมด้วยเอาต์พุตสถานะคำสั่ง stdout และ stderr

executeShellV2Command

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

ดำเนินการคำสั่งเชลล์ adb พร้อมพารามิเตอร์เพิ่มเติมเพื่อควบคุมพฤติกรรมของคำสั่ง

executeShellV2Command

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

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

executeShellV2Command

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

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

executeShellV2Command

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

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

fastbootWipePartition

public CommandResult fastbootWipePartition (String partition)

Helper method which wipes a partition for the device.

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

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

getActiveApexes

public  getActiveApexes ()

Fetch the information about APEXes activated on the device.

getAllSettings

public  getAllSettings (String namespace)

Return key value pairs of requested namespace.

getAllocationState

public DeviceAllocationState getAllocationState ()

Return the current allocation state of device

getAndroidId

public String getAndroidId (int userId)

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

getAndroidIds

public  getAndroidIds ()

Create a Map of android ids found matching user ids. There is no insurance that each user id will found an android id associated in this function so some user ids may match null.

getApiLevel

public int getApiLevel ()

Get the device API Level. Defaults to UNKNOWN_API_LEVEL .

getAppPackageInfo

public PackageInfo getAppPackageInfo (String packageName)

Fetch information about a package installed on device.

getAppPackageInfos

public  getAppPackageInfos ()

Fetch information of packages installed on the device.

getBasebandVersion

public String getBasebandVersion ()

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

getBattery

public Integer getBattery ()

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

getBooleanProperty

public boolean getBooleanProperty (String name, 
                boolean defaultValue)

Returns boolean value of the given property.

getBootHistory

public  getBootHistory ()

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

getBootHistorySince

public  getBootHistorySince (long utcEpochTime, 
                TimeUnit timeUnit)

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

getBootloaderVersion

public String getBootloaderVersion ()

Convenience method to get the bootloader version of this device.

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

getBugreport

public InputStreamSource getBugreport ()

Retrieves a bugreport from the device.

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

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

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

getBuildFlavor

public String getBuildFlavor ()

Retrieve the build flavor for the device.

getBuildId

public String getBuildId ()

Retrieve the build the device is currently running.

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)

getCachedDeviceDescriptor

public DeviceDescriptor getCachedDeviceDescriptor ()

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

getCachedDeviceDescriptor

public DeviceDescriptor getCachedDeviceDescriptor (boolean shortDescriptor)

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

getChildren

public String[] getChildren (String path)

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

getCurrentFoldableState

public DeviceFoldableState getCurrentFoldableState ()

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

getCurrentUser

public int getCurrentUser ()

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

getDeviceClass

public String getDeviceClass ()

Get the device class.

getDeviceDate

public long getDeviceDate ()

Return the date of the device in millisecond since epoch.

getDeviceDescriptor

public DeviceDescriptor getDeviceDescriptor ()

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

getDeviceDescriptor

public DeviceDescriptor getDeviceDescriptor (boolean shortDescriptor)

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

getDeviceState

public TestDeviceState getDeviceState ()

Get the device's state.

getDeviceTimeOffset

public long getDeviceTimeOffset (Date date)

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

getEmulatorOutput

public InputStreamSource getEmulatorOutput ()

Get the stream of emulator stdout and stderr

getEmulatorProcess

public Process getEmulatorProcess ()

Return the Process corresponding to this emulator.

getExecuteShellCommandLog

public final File getExecuteShellCommandLog ()

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

getExternalStoreFreeSpace

public long getExternalStoreFreeSpace ()

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

getFastbootPath

public String getFastbootPath ()

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

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.

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.

getFastbootSerialNumber

public String getFastbootSerialNumber ()

Returns the fastboot mode serial number.

getFastbootVariable

public String getFastbootVariable (String variableName)

Retrieve the given fastboot variable value from the device.

getFastbootVersion

public String getFastbootVersion ()

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

getFileEntry

public IFileEntry getFileEntry (String path)

Retrieve a reference to a remote file on device.

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

getFoldableStates

public  getFoldableStates ()

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

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.

getInstalledPackageNames

public  getInstalledPackageNames ()

Fetch the application package names present on the device.

getIntProperty

public long getIntProperty (String name, 
                long defaultValue)

Returns integer value of the given property from the device.

getIpAddress

public String getIpAddress ()

Gets the device's IP address.

getKeyguardState

public KeyguardControllerState getKeyguardState ()

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

getLastExpectedRebootTimeMillis

public long getLastExpectedRebootTimeMillis ()

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

getLaunchApiLevel

public int getLaunchApiLevel ()

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

getLogcat

public InputStreamSource getLogcat ()

Grabs a snapshot stream of the logcat data.

Works in two modes:

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.

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.

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

getMacAddress

public String getMacAddress ()

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

getMainlineModuleInfo

public  getMainlineModuleInfo ()

Get the information about the mainline modules installed on the device.

getMaxNumberOfRunningUsersSupported

public int getMaxNumberOfRunningUsersSupported ()

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

getMaxNumberOfUsersSupported

public int getMaxNumberOfUsersSupported ()

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

getMonitor

public IDeviceStateMonitor getMonitor ()

Return the IDeviceStateMonitor associated with device.

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)

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.

getMountPointInfo

public  getMountPointInfo ()

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

getOptions

public TestDeviceOptions getOptions ()

Fetch the test options for the device.

getPartitionFreeSpace

public long getPartitionFreeSpace (String partition)

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

getPrimaryUserId

public Integer getPrimaryUserId ()

Returns the primary user id.

getProcessByName

public ProcessInfo getProcessByName (String processName)

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

getProcessPid

public String getProcessPid (String process)

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

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.

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.

getProperty

public String getProperty (String name)

Retrieve the given property value from the device.

getRecoveryMode

public ITestDevice.RecoveryMode getRecoveryMode ()

Get the current recovery mode used for the device.

getScreenshot

public InputStreamSource getScreenshot (String format)

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

getScreenshot

public InputStreamSource getScreenshot (long displayId)

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

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

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.

getScreenshot

public InputStreamSource getScreenshot ()

Grabs a screenshot from the device.

getSerialNumber

public String getSerialNumber ()

Convenience method to get serial number of this device.

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"}

getSetting

public String getSetting (String namespace, 
                String key)

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

getSimOperator

public String getSimOperator ()

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

getSimState

public String getSimState ()

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

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.

getTotalMemory

public long getTotalMemory ()

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

getUninstallablePackageNames

public  getUninstallablePackageNames ()

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

getUseFastbootErase

public boolean getUseFastbootErase ()

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

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.

getUserInfos

public  getUserInfos ()

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

getUserSerialNumber

public int getUserSerialNumber (int userId)

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

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.

hasFeature

public boolean hasFeature (String feature)

Check if a feature is available on a device.

installPackage

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

Install an Android package on device.

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.

installPackageForUser

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

Install an Android package on device for a given user.

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.

isAdbRoot

public boolean isAdbRoot ()

isAdbTcp

public boolean isAdbTcp ()

isAppEnumerationSupported

public boolean isAppEnumerationSupported ()

Check whether platform on device supports app enumeration

isDeviceEncrypted

public boolean isDeviceEncrypted ()

Returns if the device is encrypted.

isDirectory

public boolean isDirectory (String path)

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

isEnableAdbRoot

public boolean isEnableAdbRoot ()

isEncryptionSupported

public boolean isEncryptionSupported ()

Returns if encryption is supported on the device.

isExecutable

public boolean isExecutable (String fullPath)

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

isFastbootEnabled

public boolean isFastbootEnabled ()

Return if fastboot is available for the device.

isHeadless

public boolean isHeadless ()

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

isMultiUserSupported

public boolean isMultiUserSupported ()

Determines if multi user is supported.

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.

isPackageInstalled

public boolean isPackageInstalled (String packageName)

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

isRuntimePermissionSupported

public boolean isRuntimePermissionSupported ()

Check whether platform on device supports runtime permission granting

isStateBootloaderOrFastbootd

public boolean isStateBootloaderOrFastbootd ()

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

isUserRunning

public boolean isUserRunning (int userId)

Check if a given user is running.

isUserSecondary

public boolean isUserSecondary (int userId)

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

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.

listDisplayIds

public  listDisplayIds ()

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

listUsers

public  listUsers ()

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

logAnrs

public boolean logAnrs (ITestLogger logger)

Collects and log ANRs from the device.

logBugreport

public boolean logBugreport (String dataName, 
                ITestLogger listener)

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

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.

nonBlockingReboot

public void nonBlockingReboot ()

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

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.

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.

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)

postInvocationTearDown

public void postInvocationTearDown (Throwable exception)

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

preInvocationSetup

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

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

pullDir

public boolean pullDir (String deviceFilePath, 
                File localDir)

Recursively pull directory contents from device.

pullFile

public boolean pullFile (String remoteFilePath, 
                File localFile)

Retrieves a file off device.

pullFile

public File pullFile (String remoteFilePath, 
                int userId)

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

pullFile

public File pullFile (String remoteFilePath)

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

pullFile

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

Retrieves a file off device.

pullFileContents

public String pullFileContents (String remoteFilePath)

Retrieves a file off device, and returns the contents.

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 .

pushDir

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

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