public class UiDevice


UiDevice provides access to state information about the device. You can also use this class to simulate user actions on the device, such as pressing the d-pad or pressing the Home and Menu buttons.

Summary

Public methods

void

Clears the text from the last UI traversal event.

boolean
click(int x, int y)

Perform a click at arbitrary coordinates on the default display specified by the user.

boolean
drag(int startX, int startY, int endX, int endY, int steps)

Performs a swipe from one coordinate to another coordinate on the default display.

void

Dumps every window's layout hierarchy to a java.io.File in XML format.

void

This method is deprecated.

Use dumpWindowHierarchy or dumpWindowHierarchy instead.

void

Dumps every window's layout hierarchy to an java.io.OutputStream in XML format.

@NonNull String
@Discouraged(message = "Can be useful for simple commands, but lacks support for proper error" + " handling, input data, or complex commands (quotes, pipes) that can be obtained " + "from UiAutomation#executeShellCommandRwe or similar utilities.")
executeShellCommand(@NonNull String cmd)

Executes a shell command using shell user identity, and return the standard output in string.

UiObject2

Returns the first object to match the selector criteria, or null if no matching objects are found.

@NonNull UiObject

Returns a UiObject which represents a view that matches the specified selector criteria.

@NonNull List<UiObject2>

Returns all objects that match the selector criteria.

void

Freezes the default display rotation at its current state.

void
@RequiresApi(value = 30)
freezeRotation(int displayId)

Freezes the rotation of the display with displayId at its current state.

String

This method is deprecated.

The results returned should be considered unreliable

String

Retrieves the name of the last package to report accessibility events.

@Px int

Gets the height of the default display, in pixels.

@Px int
getDisplayHeight(int displayId)

Gets the height of the display with displayId, in pixels.

int
int
getDisplayRotation(int displayId)
@NonNull Point

Returns the default display size in dp (device-independent pixel).

@Px int

Gets the width of the default display, in pixels.

@Px int
getDisplayWidth(int displayId)

Gets the width of the display with displayId, in pixels.

static @NonNull UiDevice

This method is deprecated.

Should use getInstance instead.

static @NonNull UiDevice

Retrieves a singleton instance of UiDevice.

String

Retrieves the text from the last UI traversal event received.

String

Retrieves the default launcher package name.

@NonNull String

Retrieves the product name of the device.

boolean

Checks if any registered UiWatcher have triggered.

boolean

Returns whether there is a match for the given selector criteria.

boolean

Checks if a specific registered UiWatcher has triggered.

boolean
boolean

Checks the power manager if the default display is ON.

boolean

Opens the notification shade.

boolean

Opens the Quick Settings shade.

U
<U> performActionAndWait(
    @NonNull Runnable action,
    @NonNull EventCondition<U> condition,
    long timeout
)

Performs the provided action and waits for the condition to be met.

boolean

Simulates a short press on the BACK button.

boolean

Simulates a short press on the CENTER button.

boolean

Simulates a short press on the DOWN button.

boolean

Simulates a short press on the LEFT button.

boolean

Simulates a short press on the RIGHT button.

boolean

Simulates a short press on the UP button.

boolean

Simulates a short press on the DELETE key.

boolean

Simulates a short press on the ENTER key.

boolean

Simulates a short press on the HOME button.

boolean
pressKeyCode(int keyCode)

Simulates a short press using a key code.

boolean
pressKeyCode(int keyCode, int metaState)

Simulates a short press using a key code.

boolean
pressKeyCodes(@NonNull int[] keyCodes)

Presses one or more keys.

boolean
pressKeyCodes(@NonNull int[] keyCodes, int metaState)

Presses one or more keys.

boolean

Simulates a short press on the MENU button.

boolean

Simulates a short press on the Recent Apps button.

boolean

Simulates a short press on the SEARCH button.

void

Registers a UiWatcher to run automatically when the testing framework is unable to find a match using a UiSelector.

void

Removes a previously registered UiWatcher.

void

Resets a UiWatcher that has been triggered.

void

This method forces all registered watchers to run.

void
setCompressedLayoutHeirarchy(boolean compressed)

This method is deprecated.

Typo in function name, should use setCompressedLayoutHierarchy instead.

void
setCompressedLayoutHierarchy(boolean compressed)

Enables or disables layout hierarchy compression.

void

Orients the default display to its landscape orientation (width >= height) and freezes rotation.

void
@RequiresApi(value = 30)
setOrientationLandscape(int displayId)

Orients the display with displayId to its landscape orientation (width >= height) and freezes rotation.

void

Orients the default display to the left and freezes rotation.

void
@RequiresApi(value = 30)
setOrientationLeft(int displayId)

Orients the display with displayId to the left and freezes rotation.

void

Orients the default display to its natural orientation and freezes rotation.

void
@RequiresApi(value = 30)
setOrientationNatural(int displayId)

Orients the display with displayId to its natural orientation and freezes rotation .

void

Orients the default display to its portrait orientation (height >= width) and freezes rotation.

void
@RequiresApi(value = 30)
setOrientationPortrait(int displayId)

Orients the display with displayId to its portrait orientation (height >= width) and freezes rotation.

void

Orients the default display to the right and freezes rotation.

void
@RequiresApi(value = 30)
setOrientationRight(int displayId)

Orients the display with displayId to the right and freezes rotation.

void

This method simply presses the power button if the default display is ON, else it does nothing if the default display is already OFF.

boolean
swipe(@NonNull Point[] segments, int segmentSteps)

Performs a swipe between points in the Point array on the default display.

boolean
swipe(int startX, int startY, int endX, int endY, int steps)

Performs a swipe from one coordinate to another on the default display using the number of steps to determine smoothness and speed.

boolean

Take a screenshot of current window and store it as PNG Default scale of 1.0f (original size) and 90% quality is used The screenshot is adjusted per screen rotation

boolean
takeScreenshot(@NonNull File storePath, float scale, int quality)

Take a screenshot of current window and store it as PNG The screenshot is adjusted per screen rotation

void

Un-freezes the default display rotation allowing its contents to rotate with its physical rotation.

void
@RequiresApi(value = 30)
unfreezeRotation(int displayId)

Un-freezes the rotation of the display with displayId allowing its contents to rotate with its physical rotation.

U
<U> wait(@NonNull Condition<UiDevice, U> condition, long timeout)

Waits for given the condition to be met.

U
<U> wait(@NonNull SearchCondition<U> condition, long timeout)

Waits for given the condition to be met.

void

Waits for the current application to idle.

void
waitForIdle(long timeout)

Waits for the current application to idle.

boolean
waitForWindowUpdate(@Nullable String packageName, long timeout)

Waits for a window content update event to occur.

void

This method simulates pressing the power button if the default display is OFF, else it does nothing if the default display is already ON.

Public methods

clearLastTraversedText

Added in 2.2.0
public void clearLastTraversedText()

Clears the text from the last UI traversal event. See getLastTraversedText.

click

Added in 2.2.0
public boolean click(int x, int y)

Perform a click at arbitrary coordinates on the default display specified by the user.

Parameters
int x

coordinate

int y

coordinate

Returns
boolean

true if the click succeeded else false

drag

Added in 2.2.0
public boolean drag(int startX, int startY, int endX, int endY, int steps)

Performs a swipe from one coordinate to another coordinate on the default display. You can control the smoothness and speed of the swipe by specifying the number of steps. Each step execution is throttled to 5 milliseconds per step, so for a 100 steps, the swipe will take around 0.5 seconds to complete.

Parameters
int startX

X-axis value for the starting coordinate

int startY

Y-axis value for the starting coordinate

int endX

X-axis value for the ending coordinate

int endY

Y-axis value for the ending coordinate

int steps

is the number of steps for the swipe action

Returns
boolean

true if swipe is performed, false if the operation fails or the coordinates are invalid

dumpWindowHierarchy

Added in 2.2.0
public void dumpWindowHierarchy(@NonNull File dest)

Dumps every window's layout hierarchy to a java.io.File in XML format.

Parameters
@NonNull File dest

The file in which to store the window hierarchy information.

Throws
java.io.IOException

if an I/O error occurs

dumpWindowHierarchy

Added in 2.2.0
Deprecated in 2.2.0
public void dumpWindowHierarchy(@NonNull String fileName)

Dumps every window's layout hierarchy to a file in XML format.

Parameters
@NonNull String fileName

The file path in which to store the window hierarchy information. Relative file paths are stored the application's internal private storage location.

dumpWindowHierarchy

Added in 2.2.0
public void dumpWindowHierarchy(@NonNull OutputStream out)

Dumps every window's layout hierarchy to an java.io.OutputStream in XML format.

Parameters
@NonNull OutputStream out

The output stream that the window hierarchy information is written to.

Throws
java.io.IOException

if an I/O error occurs

executeShellCommand

Added in 2.3.0
@Discouraged(message = "Can be useful for simple commands, but lacks support for proper error"
            + " handling, input data, or complex commands (quotes, pipes) that can be obtained "
            + "from UiAutomation#executeShellCommandRwe or similar utilities.")
public @NonNull String executeShellCommand(@NonNull String cmd)

Executes a shell command using shell user identity, and return the standard output in string.

Calling function with large amount of output will have memory impacts, and the function call will block if the command executed is blocking.

Parameters
@NonNull String cmd

the command to run

Returns
@NonNull String

the standard output of the command

Throws
java.io.IOException

if an I/O error occurs while reading output

findObject

Added in 2.2.0
public UiObject2 findObject(@NonNull BySelector selector)

Returns the first object to match the selector criteria, or null if no matching objects are found.

findObject

Added in 2.2.0
public @NonNull UiObject findObject(@NonNull UiSelector selector)

Returns a UiObject which represents a view that matches the specified selector criteria.

Parameters
@NonNull UiSelector selector
Returns
@NonNull UiObject

UiObject object

findObjects

Added in 2.2.0
public @NonNull List<UiObject2findObjects(@NonNull BySelector selector)

Returns all objects that match the selector criteria.

freezeRotation

Added in 2.2.0
public void freezeRotation()

Freezes the default display rotation at its current state.

freezeRotation

Added in 2.3.0
@RequiresApi(value = 30)
public void freezeRotation(int displayId)

Freezes the rotation of the display with displayId at its current state.

Note: Only works on Android API level 30 (R) or above, where multi-display is officially supported.

Throws
java.lang.IllegalArgumentException

when the display with displayId is not accessible.

See also
getDisplayId

getCurrentActivityName

Added in 2.2.0
Deprecated in 2.2.0
public String getCurrentActivityName()

Retrieves the last activity to report accessibility events.

Returns
String

String name of activity

getCurrentPackageName

Added in 2.2.0
public String getCurrentPackageName()

Retrieves the name of the last package to report accessibility events.

Returns
String

String name of package

getDisplayHeight

Added in 2.2.0
public @Px int getDisplayHeight()

Gets the height of the default display, in pixels. The size is adjusted based on the current orientation of the display.

Returns
@Px int

height in pixels

getDisplayHeight

Added in 2.3.0
public @Px int getDisplayHeight(int displayId)

Gets the height of the display with displayId, in pixels. The size is adjusted based on the current orientation of the display.

Parameters
int displayId

the display ID. Use getDisplayId to get the ID.

Returns
@Px int

height in pixels

Throws
java.lang.IllegalArgumentException

when the display with displayId is not accessible.

getDisplayRotation

Added in 2.2.0
public int getDisplayRotation()
Returns
int

the current rotation of the default display

See also
getRotation

getDisplayRotation

Added in 2.3.0
public int getDisplayRotation(int displayId)
Returns
int

the current rotation of the display with displayId

Throws
java.lang.IllegalArgumentException

when the display with displayId is not accessible.

getDisplaySizeDp

Added in 2.2.0
public @NonNull Point getDisplaySizeDp()

Returns the default display size in dp (device-independent pixel).

The returned display size is adjusted per screen rotation. Also this will return the actual size of the screen, rather than adjusted per system decorations (like status bar).

Returns
@NonNull Point

a Point containing the display size in dp

See also
density

getDisplayWidth

Added in 2.2.0
public @Px int getDisplayWidth()

Gets the width of the default display, in pixels. The size is adjusted based on the current orientation of the display.

Returns
@Px int

width in pixels

getDisplayWidth

Added in 2.3.0
public @Px int getDisplayWidth(int displayId)

Gets the width of the display with displayId, in pixels. The size is adjusted based on the current orientation of the display.

Parameters
int displayId

the display ID. Use getDisplayId to get the ID.

Returns
@Px int

width in pixels

Throws
java.lang.IllegalArgumentException

when the display with displayId is not accessible.

getInstance

Added in 2.2.0
Deprecated in 2.2.0
public static @NonNull UiDevice getInstance()

Retrieves a singleton instance of UiDevice

Returns
@NonNull UiDevice

UiDevice instance

getInstance

Added in 2.2.0
public static @NonNull UiDevice getInstance(@NonNull Instrumentation instrumentation)

Retrieves a singleton instance of UiDevice. A new instance will be created if instrumentation is also new.

Returns
@NonNull UiDevice

UiDevice instance

getLastTraversedText

Added in 2.2.0
public String getLastTraversedText()

Retrieves the text from the last UI traversal event received. You can use this method to read the contents in a WebView container because the accessibility framework fires events as each text is highlighted. You can write a test to perform directional arrow presses to focus on different elements inside a WebView, and call this method to get the text from each traversed element. If you are testing a view container that can return a reference to a Document Object Model (DOM) object, your test should use the view's DOM instead.

Returns
String

text of the last traversal event, else return an empty string

getLauncherPackageName

Added in 2.2.0
public String getLauncherPackageName()

Retrieves the default launcher package name.

As of Android 11 (API level 30), apps must declare the packages and intents they intend to query. To use this method, an app will need to include the following in its manifest:

<queries>
  <intent>
    <action android:name="android.intent.action.MAIN"/>
    <category android:name="android.intent.category.HOME"/>
  </intent>
</queries>
Returns
String

package name of the default launcher

getProductName

Added in 2.2.0
public @NonNull String getProductName()

Retrieves the product name of the device. This method provides information on what type of device the test is running on. This value is the same as returned by invoking #adb shell getprop ro.product.name.

Returns
@NonNull String

product name of the device

hasAnyWatcherTriggered

Added in 2.2.0
public boolean hasAnyWatcherTriggered()

Checks if any registered UiWatcher have triggered. See registerWatcher See hasWatcherTriggered

hasObject

Added in 2.2.0
public boolean hasObject(@NonNull BySelector selector)

Returns whether there is a match for the given selector criteria.

hasWatcherTriggered

Added in 2.2.0
public boolean hasWatcherTriggered(@Nullable String watcherName)

Checks if a specific registered UiWatcher has triggered. See registerWatcher. If a UiWatcher runs and its checkForCondition call returned true, then the UiWatcher is considered triggered. This is helpful if a watcher is detecting errors from ANR or crash dialogs and the test needs to know if a UiWatcher has been triggered.

Parameters
@Nullable String watcherName
Returns
boolean

true if triggered else false

isNaturalOrientation

Added in 2.2.0
public boolean isNaturalOrientation()
Returns
boolean

true if default display is in its natural or flipped (180 degrees) orientation

isScreenOn

Added in 2.2.0
public boolean isScreenOn()

Checks the power manager if the default display is ON.

Returns
boolean

true if the screen is ON else false

openNotification

Added in 2.2.0
public boolean openNotification()

Opens the notification shade.

Returns
boolean

true if successful, else return false

openQuickSettings

Added in 2.2.0
public boolean openQuickSettings()

Opens the Quick Settings shade.

Returns
boolean

true if successful, else return false

performActionAndWait

Added in 2.3.0
public U <U> performActionAndWait(
    @NonNull Runnable action,
    @NonNull EventCondition<U> condition,
    long timeout
)

Performs the provided action and waits for the condition to be met.

Parameters
@NonNull Runnable action

The Runnable action to perform.

@NonNull EventCondition<U> condition

The EventCondition to evaluate.

long timeout

Maximum amount of time to wait in milliseconds.

Returns
U

The final result returned by the condition.

pressBack

Added in 2.2.0
public boolean pressBack()

Simulates a short press on the BACK button.

Returns
boolean

true if successful, else return false

pressDPadCenter

Added in 2.2.0
public boolean pressDPadCenter()

Simulates a short press on the CENTER button.

Returns
boolean

true if successful, else return false

pressDPadDown

Added in 2.2.0
public boolean pressDPadDown()

Simulates a short press on the DOWN button.

Returns
boolean

true if successful, else return false

pressDPadLeft

Added in 2.2.0
public boolean pressDPadLeft()

Simulates a short press on the LEFT button.

Returns
boolean

true if successful, else return false

pressDPadRight

Added in 2.2.0
public boolean pressDPadRight()

Simulates a short press on the RIGHT button.

Returns
boolean

true if successful, else return false

pressDPadUp

Added in 2.2.0
public boolean pressDPadUp()

Simulates a short press on the UP button.

Returns
boolean

true if successful, else return false

pressDelete

Added in 2.2.0
public boolean pressDelete()

Simulates a short press on the DELETE key.

Returns
boolean

true if successful, else return false

pressEnter

Added in 2.2.0
public boolean pressEnter()

Simulates a short press on the ENTER key.

Returns
boolean

true if successful, else return false

pressHome

Added in 2.2.0
public boolean pressHome()

Simulates a short press on the HOME button.

Returns
boolean

true if successful, else return false

pressKeyCode

Added in 2.2.0
public boolean pressKeyCode(int keyCode)

Simulates a short press using a key code. See KeyEvent

Returns
boolean

true if successful, else return false

pressKeyCode

Added in 2.2.0
public boolean pressKeyCode(int keyCode, int metaState)

Simulates a short press using a key code. See KeyEvent.

Parameters
int keyCode

the key code of the event.

int metaState

an integer in which each bit set to 1 represents a pressed meta key

Returns
boolean

true if successful, else return false

pressKeyCodes

Added in 2.3.0
public boolean pressKeyCodes(@NonNull int[] keyCodes)

Presses one or more keys. For example, you can simulate taking a screenshot on the device by pressing both the power and volume down keys.

pressKeyCodes(new int[]{KeyEvent.KEYCODE_POWER, KeyEvent.KEYCODE_VOLUME_DOWN})
Parameters
@NonNull int[] keyCodes

array of key codes.

Returns
boolean

true if successful, else return false

See also
KeyEvent

pressKeyCodes

Added in 2.3.0
public boolean pressKeyCodes(@NonNull int[] keyCodes, int metaState)

Presses one or more keys. For example, you can simulate taking a screenshot on the device by pressing both the power and volume down keys.

pressKeyCodes(new int[]{KeyEvent.KEYCODE_POWER, KeyEvent.KEYCODE_VOLUME_DOWN})
Parameters
@NonNull int[] keyCodes

array of key codes.

int metaState

an integer in which each bit set to 1 represents a pressed meta key

Returns
boolean

true if successful, else return false

See also
KeyEvent

pressMenu

Added in 2.2.0
public boolean pressMenu()

Simulates a short press on the MENU button.

Returns
boolean

true if successful, else return false

pressRecentApps

Added in 2.2.0
public boolean pressRecentApps()

Simulates a short press on the Recent Apps button.

Returns
boolean

true if successful, else return false

pressSearch

Added in 2.2.0
public boolean pressSearch()

Simulates a short press on the SEARCH button.

Returns
boolean

true if successful, else return false

registerWatcher

Added in 2.2.0
public void registerWatcher(@Nullable String name, @Nullable UiWatcher watcher)

Registers a UiWatcher to run automatically when the testing framework is unable to find a match using a UiSelector. See runWatchers

Parameters
@Nullable String name

to register the UiWatcher

@Nullable UiWatcher watcher

UiWatcher

removeWatcher

Added in 2.2.0
public void removeWatcher(@Nullable String name)

Removes a previously registered UiWatcher. See registerWatcher

Parameters
@Nullable String name

used to register the UiWatcher

resetWatcherTriggers

Added in 2.2.0
public void resetWatcherTriggers()

Resets a UiWatcher that has been triggered. If a UiWatcher runs and its checkForCondition call returned true, then the UiWatcher is considered triggered. See registerWatcher

runWatchers

Added in 2.2.0
public void runWatchers()

This method forces all registered watchers to run. See registerWatcher

setCompressedLayoutHeirarchy

Added in 2.2.0
Deprecated in 2.3.0
public void setCompressedLayoutHeirarchy(boolean compressed)

Enables or disables layout hierarchy compression. If compression is enabled, the layout hierarchy derived from the Acessibility framework will only contain nodes that are important for uiautomator testing. Any unnecessary surrounding layout nodes that make viewing and searching the hierarchy inefficient are removed.

Parameters
boolean compressed

true to enable compression; else, false to disable

setCompressedLayoutHierarchy

Added in 2.3.0
public void setCompressedLayoutHierarchy(boolean compressed)

Enables or disables layout hierarchy compression. If compression is enabled, the layout hierarchy derived from the Accessibility framework will only contain nodes that are important for uiautomator testing. Any unnecessary surrounding layout nodes that make viewing and searching the hierarchy inefficient are removed.

Parameters
boolean compressed

true to enable compression; else, false to disable

setOrientationLandscape

Added in 2.3.0
public void setOrientationLandscape()

Orients the default display to its landscape orientation (width >= height) and freezes rotation. Use unfreezeRotation to un-freeze the rotation.

setOrientationLandscape

Added in 2.3.0
@RequiresApi(value = 30)
public void setOrientationLandscape(int displayId)

Orients the display with displayId to its landscape orientation (width >= height) and freezes rotation. Use unfreezeRotation to un-freeze the rotation.

Note: Only works on Android API level 30 (R) or above, where multi-display is officially supported.

Throws
java.lang.IllegalArgumentException

when the display with displayId is not accessible.

See also
getDisplayId

setOrientationLeft

Added in 2.2.0
public void setOrientationLeft()

Orients the default display to the left and freezes rotation. Use unfreezeRotation to un-freeze the rotation.

Note: This rotation is relative to the natural orientation which depends on the device type (e.g. phone vs. tablet). Consider using setOrientationPortrait and setOrientationLandscape.

setOrientationLeft

Added in 2.3.0
@RequiresApi(value = 30)
public void setOrientationLeft(int displayId)

Orients the display with displayId to the left and freezes rotation. Use unfreezeRotation to un-freeze the rotation.

Note: This rotation is relative to the natural orientation which depends on the device type (e.g. phone vs. tablet). Consider using setOrientationPortrait and setOrientationLandscape.

Note: Only works on Android API level 30 (R) or above, where multi-display is officially supported.

Throws
java.lang.IllegalArgumentException

when the display with displayId is not accessible.

See also
getDisplayId

setOrientationNatural

Added in 2.2.0
public void setOrientationNatural()

Orients the default display to its natural orientation and freezes rotation. Use unfreezeRotation to un-freeze the rotation.

Note: The natural orientation depends on the device type (e.g. phone vs. tablet). Consider using setOrientationPortrait and setOrientationLandscape.

setOrientationNatural

Added in 2.3.0
@RequiresApi(value = 30)
public void setOrientationNatural(int displayId)

Orients the display with displayId to its natural orientation and freezes rotation . Use unfreezeRotation to un-freeze the rotation.

Note: The natural orientation depends on the device type (e.g. phone vs. tablet). Consider using setOrientationPortrait and setOrientationLandscape.

Note: Only works on Android API level 30 (R) or above, where multi-display is officially supported.

Throws
java.lang.IllegalArgumentException

when the display with displayId is not accessible.

See also
getDisplayId

setOrientationPortrait

Added in 2.3.0
public void setOrientationPortrait()

Orients the default display to its portrait orientation (height >= width) and freezes rotation. Use unfreezeRotation to un-freeze the rotation.

setOrientationPortrait

Added in 2.3.0
@RequiresApi(value = 30)
public void setOrientationPortrait(int displayId)

Orients the display with displayId to its portrait orientation (height >= width) and freezes rotation. Use unfreezeRotation to un-freeze the rotation.

Note: Only works on Android API level 30 (R) or above, where multi-display is officially supported.

Throws
java.lang.IllegalArgumentException

when the display with displayId is not accessible.

See also
getDisplayId

setOrientationRight

Added in 2.2.0
public void setOrientationRight()

Orients the default display to the right and freezes rotation. Use unfreezeRotation to un-freeze the rotation.

Note: This rotation is relative to the natural orientation which depends on the device type (e.g. phone vs. tablet). Consider using setOrientationPortrait and setOrientationLandscape.

setOrientationRight

Added in 2.3.0
@RequiresApi(value = 30)
public void setOrientationRight(int displayId)

Orients the display with displayId to the right and freezes rotation. Use unfreezeRotation to un-freeze the rotation.

Note: This rotation is relative to the natural orientation which depends on the device type (e.g. phone vs. tablet). Consider using setOrientationPortrait and setOrientationLandscape.

Note: Only works on Android API level 30 (R) or above, where multi-display is officially supported.

Throws
java.lang.IllegalArgumentException

when the display with displayId is not accessible.

See also
getDisplayId

sleep

Added in 2.2.0
public void sleep()

This method simply presses the power button if the default display is ON, else it does nothing if the default display is already OFF.

swipe

Added in 2.2.0
public boolean swipe(@NonNull Point[] segments, int segmentSteps)

Performs a swipe between points in the Point array on the default display. Each step execution is throttled to 5ms per step. So for a 100 steps, the swipe will take about 1/2 second to complete.

Parameters
@NonNull Point[] segments

is Point array containing at least one Point object

int segmentSteps

steps to inject between two Points

Returns
boolean

true on success

swipe

Added in 2.2.0
public boolean swipe(int startX, int startY, int endX, int endY, int steps)

Performs a swipe from one coordinate to another on the default display using the number of steps to determine smoothness and speed. Each step execution is throttled to 5ms per step. So for a 100 steps, the swipe will take about 1/2 second to complete.

Parameters
int startX

X-axis value for the starting coordinate

int startY

Y-axis value for the starting coordinate

int endX

X-axis value for the ending coordinate

int endY

Y-axis value for the ending coordinate

int steps

is the number of move steps sent to the system

Returns
boolean

false if the operation fails or the coordinates are invalid

takeScreenshot

Added in 2.2.0
public boolean takeScreenshot(@NonNull File storePath)

Take a screenshot of current window and store it as PNG Default scale of 1.0f (original size) and 90% quality is used The screenshot is adjusted per screen rotation

Parameters
@NonNull File storePath

where the PNG should be written to

Returns
boolean

true if screen shot is created successfully, false otherwise

takeScreenshot

Added in 2.2.0
public boolean takeScreenshot(@NonNull File storePath, float scale, int quality)

Take a screenshot of current window and store it as PNG The screenshot is adjusted per screen rotation

Parameters
@NonNull File storePath

where the PNG should be written to

float scale

scale the screenshot down if needed; 1.0f for original size

int quality

quality of the PNG compression; range: 0-100

Returns
boolean

true if screen shot is created successfully, false otherwise

unfreezeRotation

Added in 2.2.0
public void unfreezeRotation()

Un-freezes the default display rotation allowing its contents to rotate with its physical rotation. During testing, it is best to keep the default display frozen in a specific orientation.

Note: Need to wait a short period for the rotation animation to complete before performing another operation.

unfreezeRotation

Added in 2.3.0
@RequiresApi(value = 30)
public void unfreezeRotation(int displayId)

Un-freezes the rotation of the display with displayId allowing its contents to rotate with its physical rotation. During testing, it is best to keep the display frozen in a specific orientation.

Note: Need to wait a short period for the rotation animation to complete before performing another operation.

Note: Some secondary displays don't have rotation sensors and therefore won't respond to this method.

Note: Only works on Android API level 30 (R) or above, where multi-display is officially supported.

See also
getDisplayId

wait

Added in 2.3.0
public U <U> wait(@NonNull Condition<UiDevice, U> condition, long timeout)

Waits for given the condition to be met.

Parameters
@NonNull Condition<UiDevice, U> condition

The Condition to evaluate.

long timeout

Maximum amount of time to wait in milliseconds.

Returns
U

The final result returned by the condition, or null if the condition was not met before the timeout.

wait

Added in 2.3.0
public U <U> wait(@NonNull SearchCondition<U> condition, long timeout)

Waits for given the condition to be met.

Parameters
@NonNull SearchCondition<U> condition

The SearchCondition to evaluate.

long timeout

Maximum amount of time to wait in milliseconds.

Returns
U

The final result returned by the condition, or null if the condition was not met before the timeout.

waitForIdle

Added in 2.2.0
public void waitForIdle()

Waits for the current application to idle. Default wait timeout is 10 seconds

waitForIdle

Added in 2.2.0
public void waitForIdle(long timeout)

Waits for the current application to idle.

Parameters
long timeout

in milliseconds

waitForWindowUpdate

Added in 2.2.0
public boolean waitForWindowUpdate(@Nullable String packageName, long timeout)

Waits for a window content update event to occur. If a package name for the window is specified, but the current window does not have the same package name, the function returns immediately.

Parameters
@Nullable String packageName

the specified window package name (can be null). If null, a window update from any front-end window will end the wait

long timeout

the timeout for the wait

Returns
boolean

true if a window update occurred, false if timeout has elapsed or if the current window does not have the specified package name

wakeUp

Added in 2.2.0
public void wakeUp()

This method simulates pressing the power button if the default display is OFF, else it does nothing if the default display is already ON.

If the default display was OFF and it just got turned ON, this method will insert a 500ms delay for the device to wake up and accept input.