io.appium.droiddriver

Interface UiDevice

All Known Implementing Classes:

BaseUiDevice

public interface UiDevice

Interface for device-wide interaction.

Method Summary

Modifier and Type	Method and Description
boolean	isScreenOn() Returns whether the screen is on.
boolean	perform(Action action) Executes a global action without the context of a certain UiElement.
void	pressBack() Simulates pressing "back" button
void	sleep() Puts device to sleep if the screen is on
boolean	takeScreenshot(java.lang.String path) Takes a screenshot of current window and stores it in path as PNG.
boolean	takeScreenshot(java.lang.String path, android.graphics.Bitmap.CompressFormat format, int quality) Takes a screenshot of current window and stores it in path.
void	wakeUp() Wakes up device if the screen is off

Method Detail

isScreenOn

boolean isScreenOn()

Returns whether the screen is on.

wakeUp

void wakeUp()

Wakes up device if the screen is off

sleep

void sleep()

Puts device to sleep if the screen is on

pressBack

void pressBack()

Simulates pressing "back" button

perform

boolean perform(Action action)

Executes a global action without the context of a certain UiElement.

Parameters:

action - The action to execute

Returns:

true if the action is successful

takeScreenshot

boolean takeScreenshot(java.lang.String path)

Takes a screenshot of current window and stores it in path as PNG.

If this is used in a test which extends ActivityInstrumentationTestCase2, call this before tearDown() because tearDown() finishes activities created by ActivityInstrumentationTestCase2.getActivity().

Parameters:

path - the path of file to save screenshot

Returns:

true if screen shot is created successfully

takeScreenshot

boolean takeScreenshot(java.lang.String path,
                       android.graphics.Bitmap.CompressFormat format,
                       int quality)

Takes a screenshot of current window and stores it in path. Note some implementations may not capture everything on the screen, for example InstrumentationDriver may not see the IME soft keyboard or system content.

Parameters:

path - the path of file to save screenshot

format - The format of the compressed image

quality - Hint to the compressor, 0-100. 0 meaning compress for small size, 100 meaning compress for max quality. Some formats, like PNG which is lossless, will ignore the quality setting

Returns:

true if screen shot is created successfully