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(int x, int y) Deprecated. use longPress(PointOption) instead
T	longPress(int x, int y, java.time.Duration duration) Deprecated. use longPress(LongPressOptions) instead
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	longPress(WebElement el) Deprecated. use longPress(PointOption) instead
T	longPress(WebElement el, java.time.Duration duration) Deprecated. use longPress(LongPressOptions) instead
T	longPress(WebElement el, int x, int y) Deprecated. use longPress(PointOption) instead
T	longPress(WebElement el, int x, int y, java.time.Duration duration) Deprecated. use longPress(LongPressOptions) instead
T	moveTo(int x, int y) Deprecated. moveTo(PointOption) instead
T	moveTo(PointOption moveToOptions) Moves current touch to a new position.
T	moveTo(WebElement el) Deprecated. moveTo(PointOption) instead
T	moveTo(WebElement el, int x, int y) Deprecated. moveTo(PointOption) instead
T	perform() Perform this chain of actions on the performsTouchActions.
T	press(int x, int y) Deprecated. use press(PointOption) instead
T	press(PointOption pressOptions) Press action on the screen.
T	press(WebElement el) Deprecated. use press(PointOption) instead
T	press(WebElement el, int x, int y) Deprecated. use press(PointOption) instead
T	release() Remove the current touching implement from the screen (withdraw your touch).
T	tap(int x, int y) Deprecated. use tap(PointOption) instead.
T	tap(PointOption tapOptions) Tap on a position.
T	tap(TapOptions tapOptions) Tap on an element.
T	tap(WebElement el) Deprecated. use tap(PointOption) instead.
T	tap(WebElement el, int x, int y) Deprecated. use tap(PointOption) instead.
T	waitAction() A wait action, used as a NOP in multi-chaining.
T	waitAction(java.time.Duration duration) Deprecated. use waitAction(WaitOptions) instead.
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.

press

@Deprecated
public T press(WebElement el)

Deprecated. use press(PointOption) instead

Press on the center of an element.

Parameters:

el - element to press on.

Returns:

this TouchAction, for chaining.

press

@Deprecated
public T press(int x,
                            int y)

Deprecated. use press(PointOption) instead

Press on an absolute position on the screen.

Parameters:

x - x coordinate.

y - y coordinate.

Returns:

this TouchAction, for chaining.

press

@Deprecated
public T press(WebElement el,
                            int x,
                            int y)

Deprecated. use press(PointOption) instead

Press on an element, offset from upper left corner by a number of pixels.

Parameters:

el - element to press on.

x - x offset.

y - y offset.

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

Returns:

this TouchAction, for chaining.

moveTo

@Deprecated
public T moveTo(WebElement el)

Deprecated. moveTo(PointOption) instead

Move current touch to center of an element.

Parameters:

el - element to move to.

Returns:

this TouchAction, for chaining.

moveTo

@Deprecated
public T moveTo(int x,
                             int y)

Deprecated. moveTo(PointOption) instead

Move current touch to a new position relative to the current position on the screen. If the current position of this TouchAction is (xOld, yOld), then this method will move the TouchAction to (xOld + x, yOld + y).

Parameters:

x - change in x coordinate to move through.

y - change in y coordinate to move through.

Returns:

this TouchAction, for chaining.

moveTo

@Deprecated
public T moveTo(WebElement el,
                             int x,
                             int y)

Deprecated. moveTo(PointOption) instead

Move current touch to an element, offset from upper left corner.

Parameters:

el - element to move current touch to.

x - x offset.

y - y offset.

Returns:

this TouchAction, for chaining.

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.

tap

@Deprecated
public T tap(WebElement el)

Deprecated. use tap(PointOption) instead.

Tap the center of an element.

Parameters:

el - element to tap.

Returns:

this TouchAction, for chaining.

tap

@Deprecated
public T tap(int x,
                          int y)

Deprecated. use tap(PointOption) instead.

Tap an absolute position on the screen.

Parameters:

x - x coordinate.

y - y coordinate.

Returns:

this TouchAction, for chaining.

tap

@Deprecated
public T tap(WebElement el,
                          int x,
                          int y)

Deprecated. use tap(PointOption) instead.

Tap an element, offset from upper left corner.

Parameters:

el - element to tap.

x - x offset.

y - y offset.

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.

waitAction

@Deprecated
public T waitAction(java.time.Duration duration)

Deprecated. use waitAction(WaitOptions) instead.

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

Parameters:

duration - of the wait action. Minimum time reolution unit is one millisecond.

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.

longPress

@Deprecated
public T longPress(WebElement el)

Deprecated. use longPress(PointOption) instead

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

Parameters:

el - element to long-press.

Returns:

this TouchAction, for chaining.

longPress

@Deprecated
public T longPress(WebElement el,
                                java.time.Duration duration)

Deprecated. use longPress(LongPressOptions) instead

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

Parameters:

el - element to long-press.

duration - of the long-press. Minimum time resolution unit is one millisecond.

Returns:

this TouchAction, for chaining.

longPress

@Deprecated
public T longPress(int x,
                                int y)

Deprecated. use longPress(PointOption) instead

Press and hold the at an absolute position on the screen until the contextmenu event has fired.

Parameters:

x - x coordinate.

y - y coordinate.

Returns:

this TouchAction, for chaining.

longPress

@Deprecated
public T longPress(int x,
                                int y,
                                java.time.Duration duration)

Deprecated. use longPress(LongPressOptions) instead

Press and hold the at an absolute position on the screen until the contextmenu event has fired.

Parameters:

x - x coordinate.

y - y coordinate.

duration - of the long-press. Minimum time resolution unit is one millisecond.

Returns:

this TouchAction, for chaining.

longPress

@Deprecated
public T longPress(WebElement el,
                                int x,
                                int y)

Deprecated. use longPress(PointOption) instead

Press and hold the at an elements upper-left corner, offset by the given amount, until the contextmenu event has fired.

Parameters:

el - element to long-press.

x - x offset.

y - y offset.

Returns:

this TouchAction, for chaining.

longPress

@Deprecated
public T longPress(WebElement el,
                                int x,
                                int y,
                                java.time.Duration duration)

Deprecated. use longPress(LongPressOptions) instead

Press and hold the at an elements upper-left corner, offset by the given amount, until the contextmenu event has fired.

Parameters:

el - element to long-press.

x - x offset.

y - y offset.

duration - of the long-press. Minimum time resolution unit is one millisecond.

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.