Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend

Unfortunately Apple's XCTest framework does not natively support W3C standards for TouchAction interface implementation. Although, it provides rich set of gestures, inluding these, that are unique for iOS platform. It is possible to directly invoke these gestures in Appium starting from version 1.6.4-beta.

It is important to rememeber that XCTest and WDA are being constantly changed. This means all "mobile: *" commands can be also subject of change in Appium without any preliminary notice.

mobile: swipe

This gesture performs a simple "swipe" gesture on the particular screen element or on the application element, which is usually the whole screen. This method does not accept coordnates and siply emulates single swipe with one finger. It might be useful for such cases like album pagination, switching views, etc. More advanced cases may require to call "mobile: dragFromToForDuration", where one can supply coordinates and duration.

Supported arguments

• direction: Either 'up', 'down', 'left' or 'right'. The parameter is mandatory
• element: The internal element identifier (as hexadecimal hash string) to swipe on. Application element will be used instead if this parameter is not provided

Usage examples

// Java
JavascriptExecutor js = (JavascriptExecutor) driver;
Map<String, Object> params = new HashMap<>();
scrollObject.put("direction", "down");
scrollObject.put("element", ((RemoteWebElement) element).getId());
js.executeScript("mobile: swipe", params);

mobile: scroll

Scrolls the element or the whole screen. Different scrolling strategies are supported. Arguments define the choosen strategy: either 'name', 'direction', 'predicateString' or 'toVisible' in that order. All strategies are exclusive and only one strategy can be applied at a single moment of time. Use "mobile: scroll" to emulate precise scrolling in tables or collection views, where it is already known to which element the scrolling should be performed. Although, there is one known limitation there: in case it is necessary to perform too many scroll gestures on parent container to reach the necessary child element (tens of them) then the method call may fail.

Supported arguments

• element: The internal element identifier (as hexadecimal hash string) to scroll on. Application element will be used if this argument is not set
• name: the accessibility id of the child element, to which scrolling is performed. The same result can be achieved by setting predicateString argument to 'name == accessibilityId'. Has no effect if element is not a container
• direction: Either 'up', 'down', 'left' or 'right'. The main difference from swipe call with the same argument is that scroll will try to move the current viewport exactly to the next/previous page (the term "page" means the content, which fits into a single device screen)
• predicateString: the NSPredicate locator of the child element, to which the scrolling should be performed. Has no effect if element is not a container
• toVisible: Boolean parameter. If set to true then asks to scroll to the first visible element in the parent container. Has no effect if element is not set

Usage examples

# Python
driver.execute_script('mobile: scroll', {'direction': 'down'});

mobile: pinch

Performs pinch gesture on the given element or on the application element.

Supported arguments

• element: The internal element identifier (as hexadecimal hash string) to pinch on. Application element will be used instead if this parameter is not provided
• scale: Pinch scale of type float. Use a scale between 0 and 1 to "pinch close" or zoom out and a scale greater than 1 to "pinch open" or zoom in. Mandatory parameter
• velocity: The velocity of the pinch in scale factor per second (float value). Mandatory parameter

Usage examples

# Ruby
execute_script 'mobile: pinch', scale: 0.5, velocity: 1.1, element: element.ref

mobile: doubleTap

Performs double tap gesture on the given element or on the screen.

Supported arguments

• element: The internal element identifier (as hexadecimal hash string) to double tap on
• x: Screen x tap coordinate of type float. Mandatory parameter only if element is not set
• y: Screen y tap coordinate of type float. Mandatory parameter only if element is not set

Usage examples

// javascript
driver.execute('mobile: doubleTap', {element: element.value.ELEMENT});

mobile: touchAndHold

Performs long press gesture on the given element or on the screen.

Supported arguments

• element: The internal element identifier (as hexadecimal hash string) to long tap on
• duration: The float duration of press action in seconds. Mandatory patameter
• x: Screen x long tap coordinate of type float. Mandatory parameter only if element is not set
• y: Screen y long tap coordinate of type float. Mandatory parameter only if element is not set

Usage examples

// c#
Dictionary<string, object> tfLongTap = new Dictionary<string, object>();
tfLongTap.Add("element", element.Id);
tfLongTap.Add("duration", 2.0);
((IJavaScriptExecutor)driver).ExecuteScript("mobile: touchAndHold", tfLongTap);

mobile: twoFingerTap

Performs two finger tap gesture on the given element or on the application element.

Supported arguments

• element: The internal element identifier (as hexadecimal hash string) to double tap on. Application element will be used instead if this parameter is not provided

Usage examples

// c#
Dictionary<string, object> tfTap = new Dictionary<string, object>();
tfTap.Add("element", element.Id);
((IJavaScriptExecutor)driver).ExecuteScript("mobile: twoFingerTap", tfTap);

mobile: tap

Performs tap gesture by coordinates on the given element or on the screen.

Supported arguments

• element: The internal element identifier (as hexadecimal hash string) to long tap on. x and y tap coordinates will be calulated relatively to the current element position on the screen if this argument is provided. Otherwise they should be calculated relatively to screen borders.
• x: x tap coordinate of type float. Mandatory parameter
• y: y tap coordinate of type float. Mandatory parameter

Usage examples

// PHP
$params = array(array('x' => 100.0, 'y' => 50.0, 'element' => element.GetAttribute("id")));
$driver->executeScript("mobile: tap", $params);

mobile: dragFromToForDuration

Performs drag and drop gesture by coordinates. This can be done either on an element or on the screen

Supported arguments

• element: The internal element identifier (as hexadecimal hash string) to perform drag on. All the coordinates will be calculated relatively this this element position on the screen. Absolute screen coordinates are expected if this argument is not set
• duration: Float number of seconds in range [0.5, 60]. How long the tap gesture at starting drag point should be before to start dragging. Mandatory parameter
• fromX: The x coordinate of starting drag point (type float). Mandatory parameter
• fromY: The y coordinate of starting drag point (type float). Mandatory parameter
• toX: The x coordinate of ending drag point (type float). Mandatory parameter
• toY: The y coordinate of ending drag point (type float). Mandatory parameter

Usage examples

// Java
JavascriptExecutor js = (JavascriptExecutor) driver;
Map<String, Object> params = new HashMap<>();
params.put("duration", 1.0);
params.put("fromX", 100);
params.put("fromY", 100);
params.put("toX", 200);
params.put("toY", 200);
params.put("element", ((RemoteWebElement) element).getId());
js.executeScript("mobile: dragFromToForDuration", params);

mobile: selectPickerWheelValue

Performs selection of the next or previous picker wheel value. This might be useful if these values are populated dynamically, so you don't know which one to select or value selection does not work because of XCTest bug.

Supported arguments

• element: PickerWheel's internal element id (as hexadecimal hash string) to perform value selection on. The element must be of type XCUIElementTypePickerWheel. Mandatory parameter
• order: Either next to select the value next to the current one from the target picker wheel or previous to select the previous one. Mandatory parameter
• offset: The value in range [0.01, 0.5]. It defines how far from picker wheel's center the click should happen. The actual distance is culculated by multiplying this value to the actual picker wheel height. Too small offset value may not change the picker wheel value and too high value may cause the wheel to switch two or more values at once. Usually the optimal value is located in range [0.15, 0.3]. 0.2 by default

Usage examples

// Java
JavascriptExecutor js = (JavascriptExecutor) driver;
Map<String, Object> params = new HashMap<>();
params.put("order", "next");
params.put("offset", 0.15);
params.put("element", ((RemoteWebElement) element).getId());
js.executeScript("mobile: selectPickerWheelValue", params);

mobile: alert

Performs operations on NSAlert instance.

Supported arguments

• action: The following actions are supported: accept, dismiss and getButtons. Mandatory parameter
• buttonLabel: The label text of an existing alert button to click on. This is an optional parameter and is only valid in combination with accept and dismiss actions.

Usage examples

# Python
driver.execute_script('mobile: alert', {'action': 'accept', 'buttonLabel': 'My Cool Alert Button'});

Advanced Topics

Check WDA Element Commands API to get the information about the gestures implemented in Facebook WebDriverAgent. Check Apple XCTest documentation on XCUIElement and XCUICoordinate methods list to get the information about all gestures available there.