io.appium.java_client

Interface TouchableElement

All Superinterfaces:

org.openqa.selenium.SearchContext, org.openqa.selenium.WebElement

All Known Implementing Classes:

AndroidElement, IOSElement, MobileElement

public interface TouchableElement
extends org.openqa.selenium.WebElement

It supposed that mobile elements could be tappable, swipeable, zoomable and so on. This interface extends WebElement and describes this behavior.

Method Summary

Methods

Modifier and Type	Method and Description
void	pinch() Convenience method for pinching the given element.
void	swipe(SwipeElementDirection direction, int duration) Convenience method for swiping on the given element to the given direction
void	swipe(SwipeElementDirection direction, int offsetFromStartBorder, int offsetFromEndBorder, int duration) Convenience method for swiping on the given element to the given direction
void	tap(int fingers, int duration) Convenience method for tapping the center of the given element
void	zoom() Convenience method for "zooming in" on the given element.

Methods inherited from interface org.openqa.selenium.WebElement

clear, click, findElement, findElements, getAttribute, getCssValue, getLocation, getSize, getTagName, getText, isDisplayed, isEnabled, isSelected, sendKeys, submit

Method Detail

pinch

void pinch()

Convenience method for pinching the given element. "pinching" refers to the action of two appendages pressing the screen and sliding towards each other. NOTE: This convenience method places the initial touches around the element, if this would happen to place one of them off the screen, appium with return an outOfBounds error. In this case, revert to using the MultiTouchAction api instead of this method.

tap

void tap(int fingers,
       int duration)

Convenience method for tapping the center of the given element

Parameters:

fingers - number of fingers/appendages to tap with

duration - how long between pressing down, and lifting fingers/appendages

zoom

void zoom()

Convenience method for "zooming in" on the given element. "zooming in" refers to the action of two appendages pressing the screen and sliding away from each other. NOTE: This convenience method slides touches away from the element, if this would happen to place one of them off the screen, appium will return an outOfBounds error. In this case, revert to using the MultiTouchAction api instead of this method.

swipe

void swipe(SwipeElementDirection direction,
         int duration)

Convenience method for swiping on the given element to the given direction

Parameters:

direction - UP, DOWN, LEFT, RIGHT

duration - amount of time in milliseconds for the entire swipe action to take

swipe

void swipe(SwipeElementDirection direction,
         int offsetFromStartBorder,
         int offsetFromEndBorder,
         int duration)
           throws IllegalCoordinatesException

Convenience method for swiping on the given element to the given direction

Parameters:

direction - direction UP, DOWN, LEFT, RIGHT

offsetFromEndBorder - is the offset from the border of the element where the swiping should be started. If direction is UP then this is offset from the bottom of the element. If direction is DOWN then this is offset from the top of the element. If direction is RIGHT then this is offset from the left border of the element. If direction is LEFT then this is offset from the right border of the element.

offsetFromEndBorder - is the offset from the border of the element where the swiping should be finished. If direction is UP then this is offset from the top of the element. If direction is DOWN then this is offset from the bottom of the element. If direction is RIGHT then this is offset from the right border of the element. If direction is LEFT then this is offset from the left border of the element.

duration - amount of time in milliseconds for the entire swipe action to take

Throws:

IllegalCoordinatesException - when resulted coordinates are out of the element borders or disagree with the given direction