io.appium.droiddriver

Interface DroidDriver

All Known Implementing Classes:

AccessibilityDriver, BaseDroidDriver, InstrumentationDriver, UiAutomationDriver

public interface DroidDriver

The entry interface for using droiddriver.

Method Summary

Modifier and Type	Method and Description
void	checkExists(Finder finder) Polls until a UiElement is found using the given finder, or the default timeout is reached.
void	checkGone(Finder finder) Polls until the UiElement found using the given finder is gone, or the default timeout is reached.
boolean	dumpUiElementTree(java.lang.String path) Dumps the UiElement tree to a file to help debug.
UiElement	find(Finder finder) Returns the first UiElement found using the given finder without polling and without refreshUiElementTree().
Poller	getPoller() Returns the Poller.
UiDevice	getUiDevice() Returns a UiDevice for device-wide interaction.
boolean	has(Finder finder) Returns whether a matching element exists without polling.
boolean	has(Finder finder, long timeoutMillis) Returns whether a matching element appears within timeoutMillis.
UiElement	on(Finder finder) Returns the first UiElement found using the given finder.
void	refreshUiElementTree() Refreshes the UiElement tree.
void	setPoller(Poller poller) Sets the Poller.

Method Detail

has

boolean has(Finder finder)

Returns whether a matching element exists without polling. Use this if the UI is not in the progress of updating.

has

boolean has(Finder finder,
            long timeoutMillis)

Returns whether a matching element appears within timeoutMillis. Use this only if you have no way to determine the content of current page. There are very few occasions using this is justified. For instance, you are looking for UiElements in a scrollable view, whose content varies based on the scroll position. Refrain from using this method in these cases:

• You know one of a set of UiElements will show, but are not sure which one. Use this instead:

   UiElement el = driver.on(By.anyOf(finder1, finder2, ...));
   // UI is stable now, find which one is returned
   if (finder1.matches(el)) ...
   

• You know the UiElement will appear, and want to optimize the speed by using a smaller timeout than the default timeout. It's not worth it -- on and checkExists return as soon as the finder is found. If it is not found, that's a test failure and should be rare.

on

UiElement on(Finder finder)

Returns the first UiElement found using the given finder. This method will poll until a match is found, or the default timeout is reached.

Parameters:

finder - The matching mechanism

Returns:

The first matching element

Throws:

TimeoutException - If no matching elements are found within the allowed time

find

UiElement find(Finder finder)

Returns the first UiElement found using the given finder without polling and without refreshUiElementTree(). This method is useful in Poller.PollingListener.onPolling(io.appium.droiddriver.DroidDriver, io.appium.droiddriver.finders.Finder). In other situations polling is desired, and on(io.appium.droiddriver.finders.Finder) is more appropriate.

Parameters:

finder - The matching mechanism

Returns:

The first matching element

Throws:

ElementNotFoundException - If no matching elements are found

refreshUiElementTree

void refreshUiElementTree()

Refreshes the UiElement tree. All methods in this interface that take a Finder parameter call this method, unless noted otherwise.

checkExists

void checkExists(Finder finder)

Polls until a UiElement is found using the given finder, or the default timeout is reached. This behaves the same as on(io.appium.droiddriver.finders.Finder) except that it does not return the UiElement.

Parameters:

finder - The matching mechanism

Throws:

TimeoutException - If matching element does not appear within the default timeout

checkGone

void checkGone(Finder finder)

Polls until the UiElement found using the given finder is gone, or the default timeout is reached.

Parameters:

finder - The matching mechanism

Throws:

TimeoutException - If matching element is not gone within the default timeout

getPoller

Poller getPoller()

Returns the Poller.

setPoller

void setPoller(Poller poller)

Sets the Poller.

getUiDevice

UiDevice getUiDevice()

Returns a UiDevice for device-wide interaction.

dumpUiElementTree

boolean dumpUiElementTree(java.lang.String path)

Dumps the UiElement tree to a file to help debug. The tree is based on the last used root UiElement if it exists, otherwise refreshUiElementTree() is called.

The dump may contain invisible UiElements that are not used in the finding algorithm.

Parameters:

path - the path of file to save the tree

Returns:

whether the dumping succeeded