Android-specific
	The Android Convenience API is only available for the Squish for Android editions.

Here are some quick links to the Android Convenience API's functions:

This function returns a UiAutomator object, when the Android OS is at API level 18 or higher (Android-4.3 or later). Which should be used when accessing the android.support.test.uiautomator classes and objects from a Squish test script.

This read-only property of squishinfo Object (Section 6.3.17) holds the Android device string that is selected in the IDE or passed as --device option to squishrunner

This function double taps on the specified objectOrName widget. The x and y coordinates are optional. If they are not specified, the double tap is made in the center of the widget. On the other hand, if the additional parameters are given, the double tap is made at position x and y (in the objectOrName widget's coordinates).

This function taps the Android back button. The specified objectOrName can refer to any object that is visible, though Squish will record the object having the input focus.

This function taps the Android home button when UiAutomation is enabled. Otherwise this function does nothing.

This function taps the Android recents button when UiAutomation is enabled. Otherwise this function throws an exception.

This function opens the Android notifications when UiAutomation is enabled. Otherwise this function throws an exception.

This function opens the Android quick-settings when UiAutomation is enabled. Otherwise this function throws an exception.

This function plays a gesture. The specified objectOrName can refer to any object that is visible and serves for synchronization only. The specified touches refers to a GestureBuilder object, which can be retrieved using readGesture.

This function takes a screenshot of the object view rectangle and returns it as an QImage Object (Section 6.3.13).

	The Newer Way to Grab a Widget
	Instead of using grabWidget to get an AUT-side QImage, it is easier to capture an Image Object (Section 6.3.14) using object.grabScreenshot. The Image.save function allows you to save directly to a location on the squishrunner host.

This function hides the soft keyboard when it is showing. The specified object can refer to any object that is visible. Note that waitForObject also implicitly hides the soft keyboard.

Hiding keyboard does not does not work for AccessibilityNode objects.

This function installs a global event handler. The script function named or referenced in handlerFunctionNameOrReference, will be called when an event of the eventName type occurs.

The eventName can be the name of any of the following event types:

The function named in handlerFunctionName is called with one argument—the object that was shown.

	Python-specific
	In Python scripts, you can specify the callback function to invoke by passing an actual function or a lambda function.

For examples see How to Use Event Handlers (Section 5.10).

	The AUT Must be Running
	The installEventHandler function will only work if it is called after the AUT has been started (e.g., using the startApplication function).

This function taps by pressing 2s on the specified objectOrName widget. The x and y coordinates are optional. If they are not specified the tap is made in the center of the widget. On the other hand, if the additional parameters are given, the tap is made at position x and y (in the objectOrName widget's coordinates).

This function performs a touch drag operation, pressing 2s first then drag, of the specified objectOrName widget. The objectOrName widget is dragged by dx pixels horizontally and by dy pixels vertically. The x and y coordinates are optional. If they are not specified the initial press is made in the center of the widget. On the other hand, if the additional parameters are given, the initial press is made at position x and y (in the objectOrName widget's coordinates).

This function taps the Android menu button. The specified objectOrName can refer to any object that is visible, though Squish will record the object having the input focus.

Squish automatically adds a property called nativeObject to every Android object. The native object provides access to all the underlying object's methods and properties.

For examples of how to use the nativeObject see How to Use the nativeObject Property (Section 5.7.2).

This function plays a gesture by using Android's shell commands and thus works outside the by Squish started app. Only the first stroke in a gesture file is replayed (i.e. touches for one finger). The specified touches refers to a GestureBuilder object, which can be retrieved using readGesture.

This function performs a tap by using Android's shell commands and thus works outside the by Squish started app. The x and y are relative w.r.t. the top-left of the screen.

This function opens a gesture file from a test suite directory and returns a GestureBuilder object. This can then be passed to gesture. The specified gesture-file refers to the filename.

This function should only be used when --no-autostart-observer (Section 7.4.7.2.6) is specified as launcher argument to androidobserver (Section 7.4.7.2) or when stopObserver has been called. When the observer is not running, the object recognition with popups, dropdowns and dialogs is limited or will not work at all.

This function stops the observer. Use this function when a certain part in the app execution becomes very slow when running under Squish. See startObserver for enabling the observer again.

This function performs a menu action. The specified objectOrName can refer to any object that is visible, though Squish will record the current Activity object.

	Note
	tapMenuItem does not work on AccessibilityNode objects. Also the application menu has to be open or else this function will fail.

This function taps on the specified objectOrName widget. The x and y coordinates are optional. If they are not specified, the tap is made in the center of the widget. On the other hand, if the additional parameters are given, the click is made at position x and y (in the objectOrName widget's coordinates).

This function performs a touch drag operation. It initiates a drag of the specified objectOrName widget starting at position x and y. The objectOrName widget is dragged by dx pixels horizontally and by dy pixels vertically.

This function types the specified text (as if the user had used the keyboard) into the objectOrName editable widget. If the text is surrounded by angle brackets (<>), it is interpreted as a key combination, e.g "<Ctrl+Return>". The input is case-sensitive, so type(object, "R") is different from type(object, "r"). (For a list of the supported special keys see the nativeType function's documentation.)

This function uninstalls an event handler that has been previously installed using installEventHandler.

This function is a convenient for android.webkit.WebView.evaluateJavaScript The target WebView is a UI element of type WebView and the script argument is some JavaScript code. This function returns the result of the JavaScript evaluation as a string.

var webview = waitForObject(":some_WebView");
test.log("Pixel ratio is " + webview.evalJS("window.top.devicePixelRatio"));

my $webview = waitForObject(":some_WebView");
test::log("Pixel ratio is " . $webview->evalJS("window.top.devicePixelRatio"));

webview = waitForObject(":some_WebView")
test.log("Pixel ratio is " + webview.evalJS("window.top.devicePixelRatio"))

webview = waitForObject(":some_WebView")
Test.log("Pixel ratio is " + webview.evalJS("window.top.devicePixelRatio"))

set webview [waitForObject ":some_WebView"]
test log [concat "Pixel ratio is" [webview evalJS "window.top.devicePixelRatio"]]

goHome()
tapObject(waitForObject(":Apps_Clickable"))
geom = Screen.byIndex(0).geometry
w = geom.width
touchAndDrag(waitForObject(":_AccessiblePanel"), w-10, geom.height/2, 20-w, 0)
tapObject(waitForObject(":Settings_Clickable"))

var au = androidUiAutomator();

//press home
var dev = au.getDevice();
dev.pressHome();

//open application launcher
var sel = au.createSelector().description("Apps");
var obj = au.createObject(sel);
obj.click();

//swipe right to left
var y = dev.displayHeight / 2;
dev.swipe(dev.displayWidth - 10, y, 10, y, 50);

//open settings app
sel = au.createSelector().text("Settings");
obj = au.createObject(sel);
obj.click();

my $au = androidUiAutomator();

#press home
my $dev = $au->getDevice();
$dev->pressHome();

#open application launcher
my $sel = $au->createSelector()->description("Apps");
my $obj = $au->createObject($sel);
$obj->click();

#swipe right to left
my $y = $dev->displayHeight / 2;
$dev->swipe($dev->displayWidth - 10, $y, 10, $y, 50);

#open settings app
$sel = $au->createSelector()->text("Settings");
$obj = $au->createObject($sel);
$obj->click();

au = androidUiAutomator()

#press home
dev = au.getDevice()
dev.pressHome()

#open application launcher
sel = au.createSelector().description("Apps")
obj = au.createObject(sel)
obj.click()

#swipe right to left
y = dev.displayHeight / 2
dev.swipe(dev.displayWidth - 10, y, 10, y, 50)

#open settings app
sel = au.createSelector().text("Settings")
obj = au.createObject(sel)
obj.click()

au = androidUiAutomator()

#press home
dev = au.getDevice()
dev.pressHome()

#open application launcher
sel = au.createSelector().description("Apps")
obj = au.createObject(sel)
obj.click()

#swipe right to left
y = dev.displayHeight / 2
dev.swipe(dev.displayWidth - 10, y, 10, y, 50)

#open settings app
sel = au.createSelector().text("Settings")
obj = au.createObject(sel)
obj.click()

set au [invoke androidUiAutomator]

#press home
set dev [invoke $au getDevice]
invoke $dev pressHome

#open application launcher
set sel [invoke [invoke $au createSelector] description "Apps"]
set obj [invoke $au createObject $sel]
invoke $obj click

#swipe right to left
set y [expr [property get $dev displayHeight] / 2]
invoke $dev swipe [expr [property get $dev displayWidth] - 10] $y 10 $y 50

#open settings app
set sel [invoke [invoke $au createSelector] text "Settings"]
set obj [invoke $au createObject $sel]
invoke $obj click