io.appium.droiddriver.actions

Interface Action

All Known Implementing Classes:

AccessibilityAction, AccessibilityClickAction, AccessibilityClickAction.DoubleClick, AccessibilityClickAction.LongClick, AccessibilityClickAction.SingleClick, AccessibilityScrollAction, BaseAction, ClickAction, ClickAction.DoubleClick, ClickAction.LongClick, ClickAction.SingleClick, CloseKeyboardAction, EventAction, KeyAction, SingleKeyAction, SwipeAction, TextAction, ViewAction

public interface Action

Interface for performing action on a UiElement. An action is a high-level user interaction that can be performed in various ways, for example, via synthesized events, or the Accessibility API.

Method Summary

Modifier and Type	Method and Description
long	getTimeoutMillis() Gets the timeout to wait for an indicator that the action has been carried out.
boolean	perform(UiElement element) Performs the action.
java.lang.String	toString()

Method Detail

perform

boolean perform(UiElement element)

Performs the action.

Parameters:

element - the Ui element to perform the action on

Returns:

Whether the action is successful. Some actions throw exceptions in case of failure, when that behavior is more appropriate. For example, if event injection returns false.

getTimeoutMillis

long getTimeoutMillis()

Gets the timeout to wait for an indicator that the action has been carried out. Different DroidDriver implementations use this value in different ways. For example, UiAutomationDriver waits for AccessibilityEvent up to this value. InstrumentationDriver ignores this value because it synchronizes on the event loop.

toString

java.lang.String toString()

It is recommended that this method return the description of the action, for example, "SwipeAction{DOWN}".

Overrides:

toString in class java.lang.Object