io.appium.java_client

Interface TouchShortcuts

All Known Subinterfaces:

MobileDriver

All Known Implementing Classes:

AndroidDriver, AppiumDriver, IOSDriver

public interface TouchShortcuts

Method Summary

Methods

Modifier and Type	Method and Description
void	pinch(int x, int y) Convenience method for pinching an element on the screen.
void	pinch(org.openqa.selenium.WebElement el) Convenience method for pinching an element on the screen.
void	swipe(int startx, int starty, int endx, int endy, int duration) Convenience method for swiping across the screen
void	tap(int fingers, int x, int y, int duration) Convenience method for tapping a position on the screen
void	tap(int fingers, org.openqa.selenium.WebElement element, int duration) Convenience method for tapping the center of an element on the screen
void	zoom(int x, int y) Convenience method for "zooming in" on an element on the screen.
void	zoom(org.openqa.selenium.WebElement el) Convenience method for "zooming in" on an element on the screen.

Method Detail

zoom

void zoom(int x,
        int y)

Convenience method for "zooming in" on an element on the screen. "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.

Parameters:

x - x coordinate to start zoom on

y - y coordinate to start zoom on

zoom

void zoom(org.openqa.selenium.WebElement el)

Convenience method for "zooming in" on an element on the screen. "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.

Parameters:

el - The element to pinch

tap

void tap(int fingers,
       int x,
       int y,
       int duration)

Convenience method for tapping a position on the screen

Parameters:

fingers - number of fingers/appendages to tap with

x - x coordinate

y - y coordinate

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

tap

void tap(int fingers,
       org.openqa.selenium.WebElement element,
       int duration)

Convenience method for tapping the center of an element on the screen

Parameters:

fingers - number of fingers/appendages to tap with

element - element to tap

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

swipe

void swipe(int startx,
         int starty,
         int endx,
         int endy,
         int duration)

Convenience method for swiping across the screen

Parameters:

startx - starting x coordinate

starty - starting y coordinate

endx - ending x coordinate

endy - ending y coordinate

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

pinch

void pinch(int x,
         int y)

Convenience method for pinching an element on the screen. "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 at a distance, 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.

Parameters:

x - x coordinate to terminate the pinch on

y - y coordinate to terminate the pinch on

pinch

void pinch(org.openqa.selenium.WebElement el)

Convenience method for pinching an element on the screen. "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.

Parameters:

el - The element to pinch