io.appium.java_client

Class TouchAction<T extends TouchAction<T>>

java.lang.Object

io.appium.java_client.TouchAction<T>

All Implemented Interfaces:

PerformsActions<T>

Direct Known Subclasses:

AndroidTouchAction, IOSTouchAction

public class TouchAction<T extends TouchAction<T>>
extends java.lang.Object
implements PerformsActions<T>

Used for Webdriver 3 touch actions See the Webriver 3 spec https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html The flow is to chain individual touch actions into an entire gesture. e.g. TouchAction action = new TouchAction(performsTouchActions); action.press(element).waitAction(300).moveTo(element1).release().perform(); Calling perform() sends the action command to the Mobile Driver. Otherwise, more and more actions can be chained.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TouchAction.ActionParameter Just holds values to eventually return the parameters required for the mjsonwp.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.collect.ImmutableList.Builder<TouchAction.ActionParameter>	parameterBuilder

Constructor Summary

Constructors

Constructor and Description
TouchAction(PerformsTouchActions performsTouchActions)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this action, if it was partially completed by the performsTouchActions.
protected T	clearParameters() Clears all the existing action parameters and resets the instance to the initial state.
protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	getParameters() Get the mjsonwp parameters for this Action.
T	longPress(LongPressOptions longPressOptions) Press and hold the at the center of an element until the context menu event has fired.
T	longPress(PointOption longPressOptions) Press and hold the at the center of an element until the context menu event has fired.
T	moveTo(PointOption moveToOptions) Moves current touch to a new position.
T	perform() Perform this chain of actions on the performsTouchActions.
T	press(PointOption pressOptions) Press action on the screen.
T	release() Remove the current touching implement from the screen (withdraw your touch).
T	tap(PointOption tapOptions) Tap on a position.
T	tap(TapOptions tapOptions) Tap on an element.
T	waitAction() A wait action, used as a NOP in multi-chaining.
T	waitAction(WaitOptions waitOptions) Waits for specified amount of time to pass before continue to next touch action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parameterBuilder

protected com.google.common.collect.ImmutableList.Builder<TouchAction.ActionParameter> parameterBuilder

Constructor Detail

TouchAction

public TouchAction(PerformsTouchActions performsTouchActions)

Method Detail

press

public T press(PointOption pressOptions)

Press action on the screen.

Parameters:

pressOptions - see PointOption and ElementOption.

Returns:

this TouchAction, for chaining.

release

public T release()

Remove the current touching implement from the screen (withdraw your touch).

Returns:

this TouchAction, for chaining.

moveTo

public T moveTo(PointOption moveToOptions)

Moves current touch to a new position.

Parameters:

moveToOptions - see PointOption and ElementOption Important: some older Appium drivers releases have a bug when moveTo coordinates are calculated as relative to the recent pointer position in the chain instead of being absolute.

Returns:

this TouchAction, for chaining.

See Also:

Appium Issue #7486 for more details.

tap

public T tap(TapOptions tapOptions)

Tap on an element.

Parameters:

tapOptions - see TapOptions.

Returns:

this TouchAction, for chaining.

tap

public T tap(PointOption tapOptions)

Tap on a position.

Parameters:

tapOptions - see PointOption and ElementOption

Returns:

this TouchAction, for chaining.

waitAction

public T waitAction()

A wait action, used as a NOP in multi-chaining.

Returns:

this TouchAction, for chaining.

waitAction

public T waitAction(WaitOptions waitOptions)

Waits for specified amount of time to pass before continue to next touch action.

Parameters:

waitOptions - see WaitOptions.

Returns:

this TouchAction, for chaining.

longPress

public T longPress(LongPressOptions longPressOptions)

Press and hold the at the center of an element until the context menu event has fired.

Parameters:

longPressOptions - see LongPressOptions.

Returns:

this TouchAction, for chaining.

longPress

public T longPress(PointOption longPressOptions)

Press and hold the at the center of an element until the context menu event has fired.

Parameters:

longPressOptions - see PointOption and ElementOption.

Returns:

this TouchAction, for chaining.

cancel

public void cancel()

Cancel this action, if it was partially completed by the performsTouchActions.

perform

public T perform()

Perform this chain of actions on the performsTouchActions.

Specified by:

perform in interface PerformsActions<T extends TouchAction<T>>

Returns:

this TouchAction, for possible segmented-touches.

getParameters

protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getParameters()

Get the mjsonwp parameters for this Action.

Returns:

A map of parameters for this touch action to pass as part of mjsonwp.

clearParameters

protected T clearParameters()

Clears all the existing action parameters and resets the instance to the initial state.

Returns:

this TouchAction, for possible segmented-touches.