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.

Android APIs

This page lists the APIs specific to Android. These APIs have an _a prefix in camel case, example: _aPressBack. These APIs will work only on an Android device/emulator.

Modes Android

AWake Up simulates pressing the power button if the screen is OFF else it does nothing if the screen is already ON.

Parameters

NameTypeDescription
None

Sahi Pro Classic API _aWakeUp

Modes Android

APress Back Performs a Back action.

Parameters

NameTypeDescription
None

Sahi Pro Classic API _aPressBack

Modes Android

APress Recent Apps Brings up the Recent Apps screen.

Parameters

NameTypeDescription
None

Sahi Pro Classic API _aPressRecentApps

Modes Android

APress Search Brings up the Search box.

Parameters

NameTypeDescription
None

Sahi Pro Classic API _aPressSearch

Modes Android

APress Menu Simulates a press on the MENU button.

Parameters

NameTypeDescription
None

Sahi Pro Classic API _aPressMenu

Modes Android

APress Enter Simulates a press on the ENTER key.

Parameters

NameTypeDescription
None

Sahi Pro Classic API _aPressEnter

Modes Android

APress Delete Simulates a press on the DELETE key.

Parameters

NameTypeDescription
None

Sahi Pro Classic API _aPressDelete

Modes Android

Returns true or false based on screen is ON or OFF.

Parameters

NameTypeDescription
None

Returns

booleantrue or false based based on screen is ON or OFF.
Raw script
var $screenOn = _aIsScreenOn();

Sahi Pro Classic API _aIsScreenOn

Implicit scroll APIs for element identification

Section titled “Implicit scroll APIs for element identification”

In Android, only visible elements can be interacted with. Thus if a scroll view has elements that do not lie on the screen, these elements cannot be interacted with, unless they are scrolled into view. In a scroll view that can contain different numbers of elements at different times, the user will first have to determine how much to scroll. To save the user this trouble, Sahi provides APIs that automatically perform the scrolling to identify the element.

Modes Android

Enables automatic vertical scrolling and disables horizontal scrolling for element identification. This affects all subsequent steps in the script. To turn it off, call _aDisableScroll().

Once AEnable Vertical Scroll has been called, an element is identified as follows.

  • When an element is identified, if an _in clause is specified, it will be identified in that container. Else it will be identified in the topmost container.
  • If the element is visible on the page, it will be identified.
  • Else, if the container is scrollable, it will be scrolled vertically from the beginning till the element is identified. If the end has been reached, it means that the element has not been found.
  • Else, if the container is not scrollable but contains a scrollable child container, the child container will be scrolled vertically from the beginning till the element is identified. If the end has been reached, it means that the element has not been found.

Parameters

NameTypeDescription
$elementAndroid ElementoptionalScrollable element in which subsequent elements will be searched. If not specified, top most scrollable element will be considered.
$maxScrollCountintegeroptionalSpecify maximum scroll count to attempt scrolling to identify an element. If not specified, it will perform the scrolling till the end.

Sahi Pro Classic API _aEnableVerticalScroll

Modes Android

Enables automatic horizontal scrolling and disables vertical scrolling for element identification. This affects all subsequent steps in the script. To turn it off, call _aDisableScroll().

Once AEnable Horizontal Scroll has been called, an element is identified as follows.

  • When an element is identified, if an _in clause is specified, it will be identified in that container. Else it will be identified in the topmost container.
  • If the element is visible on the page, it will be identified.
  • Else, if the container is scrollable, it will be scrolled horizontally from the beginning till the element is identified. If the end has been reached, it means that the element has not been found.
  • Else, if the container is not scrollable but contains a scrollable child container, the child container will be scrolled horizontally from the beginning till the element is identified. If the end has been reached, it means that the element has not been found.

Parameters

NameTypeDescription
$elementAndroid ElementoptionalScrollable element in which subsequent elements will be searched. If not specified, top most scrollable element will be considered.
$maxScrollCountintegeroptionalSpecify maximum scroll count to attempt scrolling to identify an element. If not specified, it will perform the scrolling till the end.

Sahi Pro Classic API _aEnableHorizontalScroll

Modes Android

Disables automatic horizontal and vertical scrolling for element identification. This affects all subsequent steps in the script.

Once ADisable Scroll has been called, an element is identified as follows.

  • When an element is identified, if an _in clause is specified, it will be identified in that container. Else it will be identified in the topmost container.
  • If the element is visible on the page, it will be identified. Else it means that the element has not been found.

Parameters

NameTypeDescription
None

Sahi Pro Classic API _aDisableScroll

Modes Android

Returns true if automatic vertical scrolling has been enabled by calling _aEnableVerticalScroll().

Parameters

NameTypeDescription
None

Returns

booleantrue or false based on vertical scrolling is enabled or not.
Raw script
var $enabled = _aIsVerticalScrollEnabled();

Sahi Pro Classic API _aIsVerticalScrollEnabled

Modes Android

Returns true if automatic horizontal scrolling has been enabled by calling _aEnableHorizontalScroll().

Parameters

NameTypeDescription
None

Returns

booleantrue or false based on horizontal scrolling is enabled or not.
Raw script
var $enabled = _aIsHorizontalScrollEnabled();

Sahi Pro Classic API _aIsHorizontalScrollEnabled

Modes Android

Returns true if automatic horizontal or vertical scrolling has been enabled by calling _aEnableVerticalScroll() or _aEnableHorizontalScroll().

Parameters

NameTypeDescription
None

Returns

booleantrue or false based on vertical/horizontal scrolling is enabled or not.
Raw script
var $enabled = _aIsScrollEnabled();

Sahi Pro Classic API _aIsScrollEnabled

Modes Android

Scrolls the element’s contents to the leftmost position, i.e. it scrolls horizontally to the beginning. Returns true or false.

Parameters

NameTypeDescription
$elementAndroid Elementelement to be scrolled
$maxSwipesintegeroptionalmaximum swipes to attempt to scroll to the leftmost position. If not specified, the default max swipes as supported by the device will be used.

Returns

booleantrue or false based based whether the element can still scroll.
Raw script
_aScrollLeftMost(_mScrollView("Test"));
_aScrollLeftMost(_mScrollView("Test"), 5); //this will perform 5 swipes only

Sahi Pro Classic API _aScrollLeftMost

Modes Android

Scrolls the element’s contents to the rightmost position, i.e. it scrolls horizontally to the end. Returns true or false.

Parameters

NameTypeDescription
$elementAndroid Elementelement to be scrolled
$maxSwipesintegeroptionalmaximum swipes to attempt to scroll to the rightmost position. If not specified, the default max swipes as supported by the device will be used.

Returns

booleantrue or false based based whether the element can still scroll.
Raw script
_aScrollRightMost(_mScrollView("Test"));
_aScrollRightMost(_mScrollView("Test"), 5); //this will perform 5 swipes only

Sahi Pro Classic API _aScrollRightMost

Modes Android

Scrolls the element’s contents to the topmost position, i.e. it scrolls vertically to the beginning. Returns true or false.

Parameters

NameTypeDescription
$elementAndroid Elementelement to be scrolled
$maxSwipesintegeroptionalmaximum swipes to attempt to scroll to the topmost position. If not specified, the default max swipes as supported by the device will be used.

Returns

booleantrue or false based based whether the element can still scroll.
Raw script
_aScrollTopMost(_mScrollView("Test"));
_aScrollTopMost(_mScrollView("Test"), 5); //this will perform 5 swipes only

Sahi Pro Classic API _aScrollTopMost

Modes Android

Scrolls the element’s contents to the bottommost position, i.e. it scrolls vertically to the end. Returns true or false.

Parameters

NameTypeDescription
$elementAndroid Elementelement to be scrolled
$maxSwipesintegeroptionalmaximum swipes to attempt to scroll to the bottommost position. If not specified, the default max swipes as supported by the device will be used.

Returns

booleantrue or false based based whether the element can still scroll.
Raw script
_aScrollBottomMost(_mScrollView("Test"));
_aScrollBottomMost(_mScrollView("Test"), 5); //this will perform 5 swipes only

Sahi Pro Classic API _aScrollBottomMost

Modes Android

Scrolls the element’s contents one page to the left. Returns false if content cannot be scrolled further, true otherwise.

Parameters

NameTypeDescription
$elementAndroid Elementelement to be scrolled
$percentfloatoptionalpercent to scroll the element, If not specified, a value of 1.0 will be used.
$speedintegeroptionalspeed to perform scroll, If not specified, default value will be used specific to device.

Returns

booleantrue or false based based whether the element can still scroll.
Raw script
_aScrollLeft(_mScrollView("Test"));
_aScrollLeft(_mScrollView("Test"), 0.5, 1000);

Sahi Pro Classic API _aScrollLeft

Modes Android

Scrolls the element’s contents one page to the right. Returns false if content cannot be scrolled further, true otherwise.

Parameters

NameTypeDescription
$elementAndroid Elementelement to be scrolled
$percentfloatoptionalpercent to scroll the element, If not specified, a value of 1.0 will be used.
$speedintegeroptionalspeed to perform scroll, If not specified, default value will be used specific to device.

Returns

booleantrue or false based based whether the element can still scroll.
Raw script
_aScrollRight(_mScrollView("Test"));
_aScrollRight(_mScrollView("Test"), 0.5, 1000);

Sahi Pro Classic API _aScrollRight

Modes Android

Scrolls the element’s contents one page up. Returns false if content cannot be scrolled further, true otherwise.

Parameters

NameTypeDescription
$elementAndroid Elementelement to be scrolled
$percentfloatoptionalpercent to scroll the element, If not specified, a value of 1.0 will be used.
$speedintegeroptionalspeed to perform scroll, If not specified, default value will be used specific to device.

Returns

booleantrue or false based based whether the element can still scroll.
Raw script
_aScrollUp(_mScrollView("Test"));
_aScrollUp(_mScrollView("Test"), 0.5, 1000);

Sahi Pro Classic API _aScrollUp

Modes Android

Scrolls the element’s contents one page down. Returns false if content cannot be scrolled further, true otherwise.

Parameters

NameTypeDescription
$elementAndroid Elementelement to be scrolled
$percentfloatoptionalpercent to scroll the element, If not specified, a value of 1.0 will be used.
$speedintegeroptionalspeed to perform scroll, If not specified, default value will be used specific to device.

Returns

booleantrue or false based based whether the element can still scroll.
Raw script
_aScrollDown(_mScrollView("Test"));
_aScrollDown(_mScrollView("Test"), 0.5, 1000);

Sahi Pro Classic API _aScrollDown

Modes Android

After leaving the dead zone area then it starts swiping.

Parameters

NameTypeDescription
$percentfloatpercent to set the deadzone for Swipe gesture.
Raw script
_aSetSwipeDeadzonePercentage(0.1);

Sahi Pro Classic API _aSetSwipeDeadzonePercentage