Skip to content
Sahi Pro Flowcharts is retired. These pages document the last release (v12) and are no longer updated. Go to the current documentation.Flowcharts is retired. Current docs
Get Free Trial
Sahi Pro Flowcharts is retired. These pages document the last release (v12) and are no longer updated. Go to the current documentation.

Mobile Common APIs

This page lists the APIs common to both Android and iOS. These APIs have a _m prefix in camel case, example: _mSwipeLeft. These APIs work on an Android device/simulator as well as on an iOS device/simulator.

Modes AndroidiOS

Activates an application.

Parameters

NameTypeDescription
$bundleIdstringAndroid: Package name of the application
iOS: Bundle ID of the application
$forcebooleanoptionalFlag to specify whether to start an application with clean state. If not specified, default false will be used.
Raw script
_mActivateApplication("com.android.settings", true);
_mActivateApplication("com.apple.Preferences");

Sahi Pro Classic API _mActivateApplication

Modes AndroidiOS

MLong Click simulates a user’s long click on the given element.

Parameters

NameTypeDescription
$elementMobile ElementMobile element to long click on
$durationintegeroptionalDuration for the long click.
Raw script
_mLongClick(_button("Click Me"));

Sahi Pro Classic API _mLongClick

Modes AndroidiOS

Performs a pinch open gesture on the given element.

Parameters

NameTypeDescription
$elementMobile ElementMobile element to perform pinch open action on.
$percentfloatAndroid: Optional. The size of the pinch as a percentage of this element's size. If not specified, a value of 1.0 will be used.
iOS: Needs to be specified. Scale of the pinch gesture. Has to be greater than 1
$speedinteger|floatAndroid: Optional. Speed to perform the pinch gesture, to be specified as an integer . If not specified, default value will be used specific to device.
iOS: Needs to be specified. Velocity of the pinch in scale factor per second, to be specified as a float. Has to be greater than or equal to 0.
Raw script
Android:
_mPinchOpen(_image("abc"));
_mPinchOpen(_image("abc"), 0.5, 2000);
iOS:
_mPinchOpen(_image("abc"), 1.5, 0.8);

Sahi Pro Classic API _mPinchOpen

Modes AndroidiOS

Performs a pinch close gesture on the given element.

Parameters

NameTypeDescription
$elementMobile ElementMobile element to perform pinch close action on.
$percentfloatAndroid: Optional. The size of the pinch as a percentage of this element's size. If not specified, a value of 1.0 will be used.
iOS: Needs to be specified. Scale of the pinch gesture. Should be between 0 and 1
$speedinteger|floatAndroid: Optional. Speed to perform the pinch gesture, to be specified as an integer. If not specified, default value will be used specific to device.
iOS: Needs to be specified. Velocity of the pinch in scale factor per second, to be specified as a float. Has to be lesser than 0. If a positive value is given, it will be converted to a negative value.
Raw script
Android:
_mPinchClose(_image("abc"));
_mPinchClose(_image("abc"), 0.5, 2000);
iOS:
_mPinchClose(_image("abc"), 0.5, -0.8);

Sahi Pro Classic API _mPinchClose

Modes AndroidiOS

Brings up the Home screen.

Parameters

NameTypeDescription
None
Raw script
_mPressHome();

Sahi Pro Classic API _mPressHome

Modes AndroidiOS

Rotate the device screen based on the orientation type.

Parameters

NameTypeDescription
$orientationTypeOrientation type: can be PORTRAIT, PORTRAIT_UPSIDE_DOWN, LANDSCAPE_LEFT, LANDSCAPE_RIGHT
Raw script
// Rotate the screen in portrait mode.
_mSetOrientation("PORTRAIT");
// Rotate the screen upside down in portrait mode.
_mSetOrientation("PORTRAIT_UPSIDE_DOWN");
// Rorate the screen to the left side.
_mSetOrientation("LANDSCAPE_LEFT");
// Rorate the screen to the right side.
_mSetOrientation("LANDSCAPE_RIGHT");

Sahi Pro Classic API _mSetOrientation

Modes AndroidiOS

Android: Returns the SDK Level of the Android device, for example: 21 for Lollypop, 20 for Kitkat etc.
iOS: Returns the iOS version of the iOS device, for example: 11.2.6

Parameters

NameTypeDescription
None

Returns

stringAndroid: SDK version of device/emulator.
iOS: iOS version of device/simulator.
Raw script
var $version = _mOSVersion();

Sahi Pro Classic API _mOSVersion

Modes AndroidiOS

Returns device orientation, for example: PORTRAIT, PORTRAIT_UPSIDE_DOWN, LANDSCAPE_LEFT, LANDSCAPE_RIGHT

Parameters

NameTypeDescription
None

Returns

stringDevice orientation.
Raw script
var $orientation = _mGetOrientation();

Sahi Pro Classic API _mGetOrientation

These APIs are used to induce swipe action on an element, for example: to delete an email from the list.

Modes AndroidiOS

Swipes up on the element.

Parameters

NameTypeDescription
$elementMobile ElementoptionalElement to be swiped. If not specified, then it will consider the top most element to perform swipe gesture.
$percentfloatoptionalAndroid: The length of the swipe as a percentage of the element's size. If not specified, a value of 1.0 will be used.
iOS: It is not used.
$speedintegeroptionalAndroid: Speed to perform swipe. If not specified, default value will be used specific to device.
iOS: It is not used.
Raw script
_mSwipeUp();
_mSwipeUp(_mScrollView("Test"));
_mSwipeUp(_aRelativeLayout("Swipe Me"), 0.5, 1000);

Sahi Pro Classic API _mSwipeUp

Modes AndroidiOS

Swipes down on the element.

Parameters

NameTypeDescription
$elementMobile ElementoptionalElement to be swiped. If not specified, then it will consider the top most element to perform swipe gesture.
$percentfloatoptionalAndroid: The length of the swipe as a percentage of the element's size. If not specified, a value of 1.0 will be used.
iOS: It is not used.
$speedintegeroptionalAndroid: Speed to perform swipe. If not specified, default value will be used specific to device.
iOS: It is not used.
Raw script
_mSwipeDown();
_mSwipeDown(_mScrollView("Test"));
_mSwipeDown(_aRelativeLayout("Swipe Me"), 0.5, 1000);

Sahi Pro Classic API _mSwipeDown

Modes AndroidiOS

Swipes left on the element.

Parameters

NameTypeDescription
$elementMobile ElementoptionalElement to be swiped. If not specified, then it will consider the top most element to perform swipe gesture.
$percentfloatoptionalAndroid: The length of the swipe as a percentage of the element's size. If not specified, a value of 1.0 will be used.
iOS: It is not used.
$speedintegeroptionalAndroid: Speed to perform swipe. If not specified, default value will be used specific to device.
iOS: It is not used.
Raw script
_mSwipeLeft();
_mSwipeLeft(_mScrollView("Test"));
_mSwipeLeft(_aRelativeLayout("Swipe Me"), 0.5, 1000);

Sahi Pro Classic API _mSwipeLeft

Modes AndroidiOS

Swipes right on the element.

Parameters

NameTypeDescription
$elementMobile ElementoptionalElement to be swiped. If not specified, then it will consider the top most element to perform swipe gesture.
$percentfloatoptionalAndroid: The length of the swipe as a percentage of the element's size. If not specified, a value of 1.0 will be used.
iOS: It is not used.
$speedintegeroptionalAndroid: Speed to perform swipe. If not specified, default value will be used specific to device.
iOS: It is not used.
Raw script
_mSwipeRight();
_mSwipeRight(_mScrollView("Test"));
_mSwipeRight(_aRelativeLayout("Swipe Me"), 0.5, 1000);

Sahi Pro Classic API _mSwipeRight

Modes AndroidiOS

Changes the execution mode to ANDROID_WEBVIEW/IOS_WEBVIEW and starts the execution of the following steps as Web.

Parameters

NameTypeDescription
$packageNamestringAndroid: application package name
iOS: Not required
Raw script
Android:
_mStartWebContext("com.sahipro.SahiTestApp");
iOS:
_mStartWebContext();

Sahi Pro Classic API _mStartWebContext

Modes AndroidiOS

Stop the execution of following steps in Android/iOS WebView.

Parameters

NameTypeDescription
None

Sahi Pro Classic API _mStopWebContext

Modes AndroidiOS

Returns the browserInstanceId Launches a new browser instance. This instance does not share cookies with the base browser.

Once launched, steps can be directed to different browser instances via _selectBrowser

Parameters

NameTypeDescription
$deviceIdstringdeviceId of the device on which the browser will be launched.
$urlstringoptionalURL to load on opening new browser instance. If URL is null, the Start URL of the script is launched.

Returns

stringBrowser instanceId. This can be passed to _selectBrowser
Raw script
// for Android
_setMode("ANDROID_BROWSER");
// _connectDevice will return the deviceId and use that deviceId as parameter in _launchNewMobileBrowser
var $deviceId = _connectDevice();
// It will launch browser with Specified URL.
var $sessionId = _launchNewMobileBrowser($deviceId, "https://sahitest.com/demo/");
_selectBrowser($sessionId);
...
// for iOS
_setMode("IOS_BROWSER");
// _connectDevice will return the deviceId and use that deviceId as parameter in _launchNewMobileBrowser
var $deviceId = _connectDevice();
// It will launch browser with Specified URL.
var $sessionId = _launchNewMobileBrowser($deviceId, "https://sahitest.com/demo/");
_selectBrowser($sessionId);
...

Sahi Pro Classic API _launchNewMobileBrowser

Modes AndroidiOS

Returns the browserInstanceId.
Launches a new browser instance. This instance does not share cookies with the base browser.
Once launched, steps can be directed to different browser instances via _selectBrowser

Parameters

NameTypeDescription
$deviceIdstringoptionaldeviceId of the device on which the browser will be launched, If deviceId is null, the Start DeviceId of the script is used.
$urlstringoptionalURL to load on opening new browser instance. If URL is null, the Start URL of the script is launched.

Returns

stringBrowser instanceId. This can be passed to _selectBrowser
Raw script
// For Android Browser playback
_setMode("ANDROID_BROWSER");
var $sessionId = _launchNewMobileBrowser2();
_selectBrowser();
...
// For iOS Browser playback
_setMode("IOS_BROWSER");
var $sessionId = _launchNewMobileBrowser2();
_selectBrowser();
...

Sahi Pro Classic API _launchNewMobileBrowser2

Modes AndroidiOS

Returns device information as an associative array. Array contains following information:

  • name: Name of the device specified in userdata/config/(android_devices.xml or ios_devices.xml)
  • displayName: Display name of the device specified in userdata/config/(android_devices.xml or ios_devices.xml)
  • deviceName: Device name
  • deviceId: Device Id.
  • version: Device OS version

Parameters

NameTypeDescription
None

Returns

objectDevice object
Raw script
var $deviceInfo = _deviceInfo();
var $displayName = $deviceInfo["displayName"];
// or
var $displayName = $deviceInfo.displayName;

Sahi Pro Classic API _deviceInfo