Skip to content
Get Free Trial

iOS Functions

This page lists the functions specific to iOS. These functions have an _i prefix in camel case, example: _iRotate. These functions will work only on an iOS device/simulator.

Since
Mobile Engine 7.5.0

Modes iOS

_iTwoFingerTap($element)

Arguments

NameTypeDescription
$elementiOS ElementElement to be tapped.

Returns

null

Simulates two finger touches on an element, each with a single tap.

_iTwoFingerTap(_image("abc"));
Since
Mobile Engine 7.5.0

Modes iOS

_iTapWithNumberOfTapsNumberOfTouches($element, $taps, $touches)

Arguments

NameTypeDescription
$elementiOS Elementelement to be tapped
$tapsintegerNumber of taps
$touchesintegerNumber of touches.

Returns

null

Simulates number of finger touches on an element, each with a number of taps. NOTE that the first parameter is for taps and the second is for touches.

_iTapWithNumberOfTapsNumberOfTouches(_iMap(0), 2, 1); // One touch, with two taps. Same as _doubleClick
_iTapWithNumberOfTapsNumberOfTouches(_iMap(0), 1, 2); // Two touches, each with a single tap. Same as _iTwoFingerTap
Since
Mobile Engine 7.5.0

Modes iOS

_iRotate($element, $rotationAngle, $velocity)

Arguments

NameTypeDescription
$elementiOS ElementElement to be rotated
$rotationAnglefloatRotation of the gesture in radians. A positive value indicates a clockwise rotation. A negative value indicates counter clockwise rotation.
$velocityfloatVelocity of the rotation gesture in radians per second. If rotationAngle is negative, then velocity must be negative.

Returns

null

Simulates a rotation gesture on an element.

_iRotate(_iMap(0), Math.PI/4, 0.5); // Clockwise rotation
_iRotate(_iMap(0), -Math.PI/4, -0.5); // Counter-clockwise rotation
Since
Mobile Engine 7.5.0

Modes iOS

_iActivateSiriWithVoiceRecognitionText($text)

Arguments

NameTypeDescription
$textstringText to be recognized.

Returns

null

Activates Siri with voice recognition text.
Works only on iOS devices/simulators with iOS version greater than iOS 10.3.

_iActivateSiriWithVoiceRecognitionText("Please set a reminder for my meeting with John");
Since
Mobile Engine 7.5.0

Modes iOS

_iPressVolumeUp()

Arguments

NameTypeDescription
None

Returns

null

Simulates volume up action on an iOS Device.
Works only on an iOS device, and not on an iOS simulator.

_iPressVolumeUp();
Since
Mobile Engine 7.5.0

Modes iOS

_iPressVolumeDown()

Arguments

NameTypeDescription
None

Returns

null

Simulates volume down action on an iOS Device.
Works only on an iOS device, and not on an iOS simulator.

_iPressVolumeDown();
Since
Mobile Engine 7.5.0

Modes iOS

_iIsSelected($element)

Arguments

NameTypeDescription
$elementiOS ElementElement whose isSelected attribute is to be checked.

Returns

booleantrue or false based on whether the element is selected or not.

Returns true if the element is selected. Otherwise, returns false.

var $selected = _iIsSelected(_button("radio-button"));
Since
Mobile Engine 7.5.0

Modes iOS

_iIsDevice()

Arguments

NameTypeDescription
None

Returns

booleantrue or false based on whether the running platform is an iOS device.

Returns true if the running platform is an iOS device. Returns false for an iOS simulator.

if (_iIsDevice()) { // Volume down can be simulated only for an iOS device.
_iPressVolumeDown();
}
Since
Mobile Engine 7.5.0

Modes iOS

_iGetApplicationState($bundleId)

Arguments

NameTypeDescription
$bundleIdiOS App Bundle IdBundle id of application whose state is required.Element whose isSelected attribute is to be checked.

Returns

booleanState of application as number.

Returns state of application.

var $state = _iGetApplicationState("com.sahipro.ios.test.SahiTestApp");

In iOS, system dialogs cannot be automated with regular APIs. For example, one cannot use _click to click on the Allow button in a system dialog.

Refer to Automating System Dialogs for details on how to automate a system dialog.

Since
Mobile Engine 7.5.0

Modes iOS

_iExpectSystemDialog($message, $buttonIdentifier[, $persist])

Arguments

NameTypeDescription
$messagestringMessage to expect in dialog. This can also be a regular expression
$buttonIdentifierstring|integerSahi Identifier for the button. Can also be just an index.
$persistbooleanoptionalIf true, will accept a single _iExpectSystemDialog statement for all system dialogs coming after the statement. If false, will accept only the next system dialog to work with the _iExpectSystemDialog statement. Default is false.

Returns

null

_iExpectSystemDialog tells Sahi to click the button with the given buttonIdentifier, for a dialog with given message.

var $dialogLabelExpected = "/Allow.*Maps.*location/";
var $btnTextToClick = "Allow"; // This will click the "Allow" button
// Set the expected dialog label, and indicate the button to click.
_iExpectSystemDialog($dialogLabelExpected, $btnTextToClick);
Since
Mobile Engine 7.5.0

Modes iOS

_iInteractWithApp()

Arguments

NameTypeDescription
None

Returns

null

For iOS to invoke the system dialog handler, the app has to be interacted with. _iInteractWithApp() does just that.

_iInteractWithApp();
Since
Mobile Engine 7.5.0

Modes iOS

_iLastSystemDialog([$alldialogs])

Arguments

NameTypeDescription
$alldialogsbooleanoptionalIf true, returns array of all system dialog messages.

Returns

stringlast system dialog message if $alldialogs is false
array of stringsan array of all dialog messages in the browser if $alldialogs is true
// Return array of all system dialog messages.
var $allMessages = _iLastSystemDialog(true);
// Return only last system dialog message.
var $lastMessage= _iLastSystemDialog();
Since
Mobile Engine 7.5.0

Modes iOS

_iClearLastSystemDialog()

Arguments

NameTypeDescription
None

Returns

null

Removes the last system dialog message from session so that further occurrence of system dialogs can be checked

_iClearLastSystemDialog();
var $dialogLabelExpected = "/Allow.*Maps.*location/";
var $btnTextToClick = "Allow";
// Set the expected dialog label, and indicate the button to click.
_iExpectSystemDialog($dialogLabelExpected, $btnTextToClick);
// Activate the Maps application
_mActivateApplication("com.apple.Maps", true);
// Wait a little while so that the system dialog comes up.
_wait(3000);
// IMPORTANT: Interact with the app. This is what will trigger the dialog handler.
_iInteractWithApp();
// Sahi would click on the Allow button now.
// Get the last dialog label and assert that it is same as expected.
var $dialogLabelActual = _iLastSystemDialog();
_assertEqual($dialogLabelExpected, $dialogLabelActual);
Since
Mobile Engine 8.0.0

Modes iOS

_iSetAutoDismissKeyboard($autoDismiss)

Arguments

NameTypeDescription
$autoDismissbooleantrue or false

Returns

null

By default, Sahi will try to dismiss keyboard automatically after setting value in the textfield. To disable this functionaity set it to false.
Sahi will try to click on the keyboard button provided by ios.keyboard.buttons.autoclick property in SAHI_INSTALL_PATH\config\sahi.properties.