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.

Fetch APIs

While working on scripts, we often need to fetch content from the application screen. Examples may be: Fetching and storing a generated userId for later use in script Getting the value of form field for verification Getting the text from a UI element for assertion Getting some particular attribute of a UI element, like href of a link

Modes BrowserWindowsJavaAndroidiOSSAP

Parameters

NameTypeDescription
$elementHTML DOM elementForm element whose value we need

Returns

stringValue of the element
Raw script
// Using in an assertion
_assertEqual("Tyto", _getValue(_textbox("company")));
// Fetching and storing value
var $userId = _getValue(_textbox("userId"));

Sahi Pro Classic API _getValue

Modes BrowserWindowsJavaAndroidiOSSAP

The returned string is normalized for different browsers. Multiple continuous spaces are replaced with single space.
Multiple continuous newlines are replaced with single newline. Newlines are always returned as \n even on
Mac and Linux, so that scripts can work across browsers and OSes.

This action uses the textContent or innerText attributes of elements.

Parameters

NameTypeDescription
$elHTML DOM elementElement whose text we need

Returns

stringText content of the element
Raw script
// Using in an assertion
_assertEqual("Tyto", _getText(_div("companyDiv")));
// Fetching and storing value
var $userId = _getText(_div("userIdDiv"));

Sahi Pro Classic API _getText

Modes Browser

Specifies the filter data on input element which filters the list. This action should be used with _getOptions. Eg. _getOptions(Datalist Filter(_datalist("country_list"), "ind")); returns array with all options matching with “ind” in the list.

Parameters

NameTypeDescription
$elHTML DOM elementInput or datalist element
$filterstringoptionalData to filter (case-insensitive).

Returns

HTML DOM element

Sahi Pro Classic API _datalistFilter

Modes BrowserWindowsJavaSAP

If we want the values of all the options of the selectbox:

Parameters

NameTypeDescription
$elHTML DOM elementSelect/ Input or associated datalist to the input element
$typestringoptionalType can be specified as "value" or "text".
If the type is specified as "text" then text contents of all the options are returned.
If the type is specified as "value" then values of all the options are returned.
If the type is not specified then text contents of all the options are returned.

Returns

array of stringsArray containing the values or texts of all options of the select or datalist element
Raw script
var $list = _getOptions(_select("select_id"), "value");
_assertEqual("Value of First Option", $list[0]);
_assertEqual("Value of Second Option", $list[1]);
_assertEqual(2, $list.length);

Sahi Pro Classic API _getOptions

Modes BrowserWindowsJavaSAP

Returns the text of the selected option in a select dropdown box.

Parameters

NameTypeDescription
$elHTML DOM elementSelect dropdown element whose selected text we need

Returns

stringText content of the selected option of a select dropdown
Raw script
// Using in an assertion
_assertEqual("18", _getSelectedText(_select("legalAge")));
// Fetching and storing value
var $legalAge = _getSelectedText(_select("legalAge"));

Sahi Pro Classic API _getSelectedText

Modes BrowserWindowsJavaAndroidiOSSAP

Returns the specified attribute’s value for the element.

Parameters

NameTypeDescription
$elHTML DOM elementElement whose attribute we need
$attributeNamestringThe attribute to be fetched

Returns

stringThe attribute value
Raw script
// Using in an assertion
_assertEqual("http://sahi.co.in/", _getAttribute(_link("Home"), "href"));
// Fetching and storing value
var $href="_getAttribute(_link(""Home"), "href");

Sahi Pro Classic API _getAttribute

Modes BrowserWindowsJavaAndroidiOSSAP

It checks for existence of the element in the application. However, note that elements may exist but not be visible on the user interface.

Parameters

NameTypeDescription
$elHTML DOM elementElement to check

Returns

booleantrue if element exists on the page, else false
Raw script
// Using in an assertion
_assertTrue(_exists(_link("Home")));
// same as
_assertExists(_link("Home")));
// Fetching and storing value
var $exists = _exists(_link("Home"));

Sahi Pro Classic API _exists

Modes BrowserWindowsJavaSAP

Compares two Javascript data type or arrays.

Parameters

NameTypeDescription
$expectedanyExpected value.
This value can be any normal javascript data type or an array
Regular expressions can also be used. (eg. "/del/")
$actualanyActual value.
This value can be any normal javascript data type or an array.
It is mostly some attribute of a HTML DOM element.

Returns

booleantrue if the expected and actual values match, else false
Raw script
// Compare string with regular expression.
var $compare1 = _areEqual("/^a.*c$/", "abc"); // $compare1 is true.
// Compare text of an element with regular expression.
var $compare2 = _areEqual("/created/", _getText(_div("result")));
// Compare arrays.
$exp = [/[a-z]+$/, "b"];
$act = ["ab", "b"];
var $compareArr = _areEqual($exp, $act); // $compareArr is true.

Sahi Pro Classic API _areEqual

Modes BrowserWindowsJavaAndroidiOSSAPVisual Assist

Parameters

NameTypeDescription
$elHTML DOM elementElement to check
$checkZIndexbooleanoptionalIf true, checks whether the element is on top or not(Checks whether some other element with a higher Z index is not hiding it). If false, omits this check.
Default is false.
$doScrollbooleanoptionalIf true, checks whether element is the top element by scrolling to the element. If false, checks only for the current viewport.
Default is false. Used only when checkZIndex is true.

Returns

booleantrue if element is visible, else false
Raw script
// Using in an assertion
_assertTrue(_isVisible(_link("Home"))); // doesn't check z-index
_assertTrue(_isVisible(_link("Home"), true)); //checks z-index
_assertTrue(_isVisible(_link("Home"), true, true)); //checks z-index after scrolling
// Fetching and storing value
var $visible = _isVisible(_link("Home"));

Sahi Pro Classic API _isVisible

Modes BrowserWindowsJavaAndroidiOSSAP

Returns true if the element is checked. This is applicable for radio buttons and checkboxes.

Parameters

NameTypeDescription
$elHTML DOM elementElement to check

Returns

booleantrue if element is checked, else false
Raw script
// Using in an assertion
_assertTrue(_isChecked(_radio("Male")));

Sahi Pro Classic API _isChecked

Modes BrowserWindowsJavaAndroidiOSSAP

Some elements in your application could be disabled. This action returns true if the specified element is enabled.

Parameters

NameTypeDescription
$elementelementelement to be check

Returns

booleantrue if element is enabled, else false
Raw script
// Using in an assertion
_assertTrue(_isEnabled(_button("Download")));

Sahi Pro Classic API _isEnabled

Modes BrowserWindowsJavaiOSSAP

Returns true if the element contains the specified text.

Parameters

NameTypeDescription
$elementelElement where we need to check if text is present
$textstringText to check for. Can also be a regular expression

Returns

booleantrue if element contains the text, else false
Raw script
<div id="d1" style="background-color:yellow"><i>Formatted</i> Text</div>

Sahi Pro Classic API _containsText

Modes Browser

Returns true if the element contains the specified HTML content.

Parameters

NameTypeDescription
$elementelElement where we need to check if text is present
$htmlstringHTML to check for. Can also be a regular expression

Returns

booleantrue if element contains the HTML, else false
Raw script
<div id="d1" style="background-color:yellow"><i>Formatted</i> Text</div>

Sahi Pro Classic API _containsHTML

Modes BrowserWindowsJava

Parameters

NameTypeDescription
$parentHTML DOM elementParent element
$childHTML DOM elementChild element

Returns

booleantrue if the specified child element is a child of the specified parent element, else false
Raw script
<div id="d1">
<span>inside</span>
</div>

Sahi Pro Classic API _contains

Modes Browser

Parameters

NameTypeDescription
None

Returns

stringTitle of the top most page (the title visible on the browser)
Raw script
var $title = _title(); // returns "Sahi Pro - Fetch APIs" for this page.

Sahi Pro Classic API _title

Modes BrowserJava

Parameters

NameTypeDescription
$tableElHTML DOM elementTable element
$columnsarray of objectsoptionalArray of column identifiers. The identifiers can be index, text or regular expression of text
$rowsstring|integer|array of integersoptionalCan be a regular expression, an array of indexes or the starting index
$countintegeroptionalIf rows is the starting index, count is the ending index, If rows is a regular expression, count is the total count. If rows is an array of indexes, count is ignored.

Returns

two dimensional array of stringsThe data from the table
Raw script
// All table data
var $data = _getTableContents(_table("tableId"));
// All rows, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), [1,3,7] );
// Returns all rows with columns 2, 4 and 8 since index is 0 based.
// All rows, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), [1,"Price", "/Stock/"] );
// Returns all rows with column 2 (index is 0 based), column with header "Price" and column header matching regular expression /Stock/
// Rows containing specified keyword, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), ["Price", "/Stock/"], "/pen/" );
// Returns all rows containing words matching regular expression /pen/, with columns having column header Price and column header matching
// regular expression /Stock/. Note that /pen/ is matched with all the columns of the row.
// First n rows containing specified keyword, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), ["Price", "/Stock/"], "/pen/", 8);
// Returns first 8 rows contain words matching regular expression /pen/ having column header Price and column header matching
// regular expression /Stock/
// Rows having indexes specified in array, with specific columns from the table
var $data = _getTableContents(_table("tableId"), ["Price", "/Stock/"], [3,4,7]);
// Returns rows 4, 5 and 8 (index is 0 based) having all columns with header "Price" and column header matching regular expression /Stock/
// Rows from m to n, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), ["Price", "/Stock/"], 3, 7 );
// Returns rows from 3 to 7 having all columns with header "Price" and column header matching regular expression /Stock/

Sahi Pro Classic API _getTableContents

Modes Browser

Parameters

NameTypeDescription
$elHTML DOM elementelement whose style attribute we need
$styleAttributestringstyle attribute to be fetched
$pseudoElstringoptionalUse this argument to fetch style attribute from pseudo-elements like ::before, ::after, etc.

Returns

stringThe style attribute value
Raw script
// Using in assertion
_assertEqual("24px", _style(_heading1(0), "font-size"));
// Fetching and storing value
var $fontSize = _style(_heading1(0), "font-size");
// Fetch style of a pseudo element
var $backgroundColor = _style(_listItem("entry1"), "background-color", ":before")

Sahi Pro Classic API _style

Modes BrowserWindowsJavaAndroidiOSSAP

This may be used to verify layouts by comparing positions of specific elements.

Parameters

NameTypeDescription
$elHTML DOM elementelement whose position we need
$relativebooleanoptionalIf true, returns position relative to current viewport.
Default is false.

Returns

array of integersAn array [x,y] of the elements position in pixels relative to its window/frame/iframe
Raw script
// Using in assertion
_assertEqual([10,20], _position(_image("logo")));
// Fetching and storing value
var $position = _position(_image("logo"));
_log($position[0]); //logs x coordinate (eg. 10)
_log($position[1]); //logs y coordinate (eg. 20)

Sahi Pro Classic API _position

Modes BrowserJavaVisual Assist

This may be used inside native events to find the absolute positions of elements.

Parameters

NameTypeDescription
$elHTML DOM elementelement whose position we need

Returns

array of integersAn array [x,y] of the elements absolute position in pixels
Raw script
// Using in assertion
var $xy = _positionNative(_link("Link Test"));
_assertEqual(222, $xy[1]);
// Fetching and storing value
var $xy = _positionNative(_link("Link Test"));
_log("x coordinate "+ $xy[0] ); //logs x coordinate of the element
_log("y coordinate "+ $xy[1] ); //logs y coordinate of the element

Sahi Pro Classic API _positionNative

Modes BrowserWindowsJavaAndroidiOSSAP

This action gets the width and height as an array for the specified element.

Parameters

NameTypeDescription
$elElementelement whose dimensions we need

Returns

array of integersAn array [w,h] of the element's dimensions in pixels
Raw script
// Using in assertion
_assertEqual([100,40], _dimensions(_image("logo")));
// Fetching and storing value
var $dimensions = _dimensions(_image("logo"));
_log($dimensions[0]); //logs width (eg. 100)
_log($dimensions[1]); //logs height (eg. 40)

Sahi Pro Classic API _dimensions

Modes BrowserWindowsJavaSAP

Parameters

NameTypeDescription
$elHTML DOM elementoptionalElement in which to look for selection. This is optional only for Browser Automation, as Sahi will automatically look in all frames and elements.

Returns

stringText selected by the user (using mouse drag, like we select before copy paste)
Raw script
// Using in an assertion
_assertEqual("Search", _getSelectionText());
// Fetching and storing value
var $currentSelectedText = _getSelectionText();

Sahi Pro Classic API _getSelectionText

Modes Browser

Returns the text copied to the system clipboard by a web application.

Parameters

NameTypeDescription
None

Returns

stringCopied text
Raw script
_lockWindow();
_focusWindow();
_clickNative(_button("Copy Text to Clipboard"));
_unlockWindow();
var $copiedText = _getCopiedText();
_assertEqual("Copied text", $copiedText);

Sahi Pro Classic API _getCopiedText

Modes Browser

Parameters

NameTypeDescription
None

Returns

stringThe userAgent string of the current browser

Sahi Pro Classic API _userAgent

Modes Browser

Parameters

NameTypeDescription
None

Returns

array of integersScreen size as an array [x,y]. The first value is the inner width of the browser window and the second value is the inner height
Raw script
// Using in an assertion
var $screensize=_getScreenSize();
_assertTrue(($screensize[0]>=783)&&($screensize[0]<=800));
_assertTrue(($screensize[1]>=280)&&($screensize[1]<=400));

Sahi Pro Classic API _getScreenSize

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Internet Explorer, else false

Sahi Pro Classic API _isIE

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Internet Explorer 9, else false

Sahi Pro Classic API _isIE9

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Internet Explorer 10, else false

Sahi Pro Classic API _isIE10

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Edge, else false

Sahi Pro Classic API _isEdge

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Firefox, else false

Sahi Pro Classic API _isFF

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Firefox 3, else false

Sahi Pro Classic API _isFF3

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Firefox 4, else false

Sahi Pro Classic API _isFF4

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Chrome, else false

Sahi Pro Classic API _isChrome

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Safari, else false

Sahi Pro Classic API _isSafari

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Opera, else false

Sahi Pro Classic API _isOpera

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is PhantomJS, else false

Sahi Pro Classic API _isPhantomJS

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is Brave, else false

Sahi Pro Classic API _isBrave

Modes Browser

Parameters

NameTypeDescription
None

Returns

booleantrue if the current browser is HTMLUnit, else false

Sahi Pro Classic API _isHTMLUnit

Rich Text Editors (Content Editable elements)

Section titled “Rich Text Editors (Content Editable elements)”

Most common attributes needed during automation are exposed via Sahi’s fetch APIs.
However there are lots of DOM attributes which are not exposed.
For example the href attribute of a link is not exposed by any in-built Sahi API.
To work with such attributes, the APIs _fetch, _set and _condition are used.

Modes Browser

Parameters

NameTypeDescription
$expressionstring|DOM expressionExpression which we wish to evaluate and fetch.

Returns

stringValue of the expression
Raw script
var $rowCount = _fetch(_table("tableId").rows.length);
// You can also use an expression as a string
var $userAgent = _fetch("navigator.userAgent");
// And fetch results of custom utility functions of your web app
var $value = _fetch("jQuery('#id').val()");
// While working with popup windows use _selectWindow first
_selectWindow("popupWin");
// Fetch table row count from popupWin window
var $rowCount = _fetch(_table("tableId").rows.length);

Sahi Pro Classic API _fetch

Modes Browser

Sets the value of expression into variable
Set communicates with the browser to evaluate the expression and fetches the result.

Parameters

NameTypeDescription
$variablevariableVariable into which we wish to get the specific value.
$expressionDOM ExpressionExpression which we wish to evaluate and set.
Raw script
// Fetching href attribute
var $href="null;" // initialize variable
_set($href, _link("Home").href); // set it
// Getting row count of table
var $rowCount = 0; // initialize variable
_set($rowCount, _table("tableId").rows.length); // set it
// Getting column count of table (first row)
var $colCount = 0; // initialize variable
_set($colCount, _table("tableId").rows[0].cells.length); // set it

Sahi Pro Classic API _set

Modes Browser

Parameters

NameTypeDescription
$expressionDOM expressionExpression which we wish to evaluate.

Returns

booleantrue or false based on the expression
Raw script
if (_condition(_link(0).href="=" "http://sahi.co.in/")){
_click(_link(0));
}
// Note that this is the same as
var $href="_fetch(_link(0).href);"
if ($href="=" "http://sahi.co.in/"){
_click(_link(0));
}
// or
var $href="null;"
_set($href, _link(0).href);
if ($href="=" "http://sahi.co.in/"){
_click(_link(0));
}

Sahi Pro Classic API _condition

Modes BrowserWindowsJavaAndroidiOS

Parameters

NameTypeDescription
$elementTypestringtype of elements to collect. Eg. "_link", "_button", "/text/" etc.
$identifierstringSahi Identifier. Can also be just an index.
$relationsrelationsoptionalRelations like _in, _near etc.

Returns

array of element stubsArray of all elements of the specified type matching the identifier within relations
Raw script
// Collect all textboxes matching any identifier, in table "listing".
// Note the use of match all regular expression "/.*/"
var $textboxes = _collect("_textbox", "/.*/", _in(_table("listing")));
// Iterate and set values on all textboxes
for (var $i=0; $i<$textboxes.length; $i++) {
_setValue($textboxes[$i], "value");
}

Sahi Pro Classic API _collect

Modes BrowserWindowsJavaAndroidiOS

Parameters

NameTypeDescription
$elementTypestringtype of elements to collect. Eg. "_link", "_button", "/text/" etc.
$identifierstring|objectSahi Identifier/Attributes JSON. Can also be just an index.
$relationsrelationsoptionalRelations like _in, _near etc.

Returns

integerCount of all elements of the specified type matching the identifier within relations
Raw script
// Count all textboxes matching any identifier, in table "listing".
// Note the use of match all regular expression "/.*/"
var $textboxCount = _count("_textbox", "/.*/", _in(_table("listing")); // may return 5;
// or more explicitly
var $textboxCount = _count("_textbox", {name:"q"});

Sahi Pro Classic API _count

Modes BrowserWindowsJavaAndroidiOS

Fetching a simple attribute from multiple elements

Parameters

NameTypeDescription
$elementTypestringtype of elements to collect.
Eg. "_link", "_button", "/text/" etc.
$identifierstringSahi Identifier. Can also be just an index.
$attributestring|functionattribute or function.
$relationsrelationsoptionalRelations like _in, _near etc.

Returns

li_sArray of element attributes of all elements of the specified type matching the identifier within relations
Raw script
// Collect the id attribute of all textboxes in table "listing".
// Note the use of match all regular expression "/.*/"
var $textboxIds = _collectAttributes("_textbox", "/.*/", "id", _in(_table("listing")));
// Collect text of divs whose className is menu-item
var $menuTexts = _collectAttributes("_div", "menu-item", "sahiText");
// or more explicitly
var $menuTexts = _collectAttributes("_div", {className:"menu-item"}, "sahiText");

Sahi Pro Classic API _collectAttributes

Modes BrowserWindowsJava

Parameters

NameTypeDescription
$elementTypestringType of elements to collect. Can be regular expression.
Eg. "_link", "_button", "/text/" etc.
$relationsrelationsoptionalRelations like _in, _near etc.

Returns

array of objectsArray of Accessor Info object of all elements of the specified type within relations
Raw script
var $accs1 = _collectElementsInfo("/text/"); // Collect all _textbox and _textarea accessor info.
// Collect all _radio accessor infos in div "modes".
var $accs = _collectElementsInfo("_radio", _in(_div("modes")));
/*
$accs = [
{"api":"_radio", "identifiers":{"id":"sahiradio", "index":0, "name":"mode", "value":"on"}, "tag":"INPUT"},
{"api":"_radio", "identifiers":{"id":"javaradio", "index":1, "name":"mode[1]", "value":"on[1]"}, "tag":"INPUT"},
{"api":"_radio", "identifiers":{"id":"rubyradio", "index":2, "name":"mode[2]", "value":"on[2]"}, "tag":"INPUT"}
]
*/
for (var $i=0; $i<$accs.length; $i++) {
var $obj = $accs[$i];
var $identifiers = $obj["identifiers"];
var $el = $obj["api"] + "(\"" + $identifiers["id"] + "\")";
_log($el);
}

Sahi Pro Classic API _collectElementsInfo