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
Get Value
Section titled “Get Value”Modes BrowserWindowsJavaAndroidiOSSAP
Parameters
| Name | Type | Description |
|---|---|---|
$element | HTML DOM element | Form element whose value we need |
Returns
string | Value of the element |
Raw script
// Using in an assertion_assertEqual("Tyto", _getValue(_textbox("company")));
// Fetching and storing valuevar $userId = _getValue(_textbox("userId"));Sahi Pro Classic API _getValue
Get Text
Section titled “Get Text”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
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | Element whose text we need |
Returns
string | Text content of the element |
Raw script
// Using in an assertion_assertEqual("Tyto", _getText(_div("companyDiv")));
// Fetching and storing valuevar $userId = _getText(_div("userIdDiv"));Sahi Pro Classic API _getText
Datalist Filter
Section titled “Datalist Filter”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
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | Input or datalist element |
$filter | stringoptional | Data to filter (case-insensitive). |
Returns
HTML DOM element |
Sahi Pro Classic API _datalistFilter
Get Options
Section titled “Get Options”Modes BrowserWindowsJavaSAP
If we want the values of all the options of the selectbox:
Parameters
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | Select/ Input or associated datalist to the input element |
$type | stringoptional | Type 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 strings | Array 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
Get Selected Text
Section titled “Get Selected Text”Modes BrowserWindowsJavaSAP
Returns the text of the selected option in a select dropdown box.
Parameters
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | Select dropdown element whose selected text we need |
Returns
string | Text content of the selected option of a select dropdown |
Raw script
// Using in an assertion_assertEqual("18", _getSelectedText(_select("legalAge")));
// Fetching and storing valuevar $legalAge = _getSelectedText(_select("legalAge"));Sahi Pro Classic API _getSelectedText
Get Attribute
Section titled “Get Attribute”Modes BrowserWindowsJavaAndroidiOSSAP
Returns the specified attribute’s value for the element.
Parameters
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | Element whose attribute we need |
$attributeName | string | The attribute to be fetched |
Returns
string | The attribute value |
Raw script
// Using in an assertion_assertEqual("http://sahi.co.in/", _getAttribute(_link("Home"), "href"));
// Fetching and storing valuevar $href="_getAttribute(_link(""Home"), "href");Sahi Pro Classic API _getAttribute
Exists
Section titled “Exists”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
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | Element to check |
Returns
boolean | true 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 valuevar $exists = _exists(_link("Home"));Sahi Pro Classic API _exists
Are Equal
Section titled “Are Equal”Modes BrowserWindowsJavaSAP
Compares two Javascript data type or arrays.
Parameters
| Name | Type | Description |
|---|---|---|
$expected | any | Expected value. This value can be any normal javascript data type or an array Regular expressions can also be used. (eg. "/del/") |
$actual | any | Actual value. This value can be any normal javascript data type or an array. It is mostly some attribute of a HTML DOM element. |
Returns
boolean | true 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
Is Visible
Section titled “Is Visible”Modes BrowserWindowsJavaAndroidiOSSAPVisual Assist
Parameters
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | Element to check |
$checkZIndex | booleanoptional | If 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. |
$doScroll | booleanoptional | If 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
boolean | true 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 valuevar $visible = _isVisible(_link("Home"));Sahi Pro Classic API _isVisible
Is Checked
Section titled “Is Checked”Modes BrowserWindowsJavaAndroidiOSSAP
Returns true if the element is checked. This is applicable for radio buttons and checkboxes.
Parameters
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | Element to check |
Returns
boolean | true if element is checked, else false |
Raw script
// Using in an assertion_assertTrue(_isChecked(_radio("Male")));Sahi Pro Classic API _isChecked
Is Enabled
Section titled “Is Enabled”Modes BrowserWindowsJavaAndroidiOSSAP
Some elements in your application could be disabled. This action returns true if the specified element is enabled.
Parameters
| Name | Type | Description |
|---|---|---|
$element | element | element to be check |
Returns
boolean | true if element is enabled, else false |
Raw script
// Using in an assertion_assertTrue(_isEnabled(_button("Download")));Sahi Pro Classic API _isEnabled
Contains Text
Section titled “Contains Text”Modes BrowserWindowsJavaiOSSAP
Returns true if the element contains the specified text.
Parameters
| Name | Type | Description |
|---|---|---|
$element | el | Element where we need to check if text is present |
$text | string | Text to check for. Can also be a regular expression |
Returns
boolean | true 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
Contains HTML
Section titled “Contains HTML”Modes Browser
Returns true if the element contains the specified HTML content.
Parameters
| Name | Type | Description |
|---|---|---|
$element | el | Element where we need to check if text is present |
$html | string | HTML to check for. Can also be a regular expression |
Returns
boolean | true 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
Contains
Section titled “Contains”Modes BrowserWindowsJava
Parameters
| Name | Type | Description |
|---|---|---|
$parent | HTML DOM element | Parent element |
$child | HTML DOM element | Child element |
Returns
boolean | true 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
| Name | Type | Description |
|---|---|---|
None |
Returns
string | Title 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
Get Table Contents
Section titled “Get Table Contents”Modes BrowserJava
Parameters
| Name | Type | Description |
|---|---|---|
$tableEl | HTML DOM element | Table element |
$columns | array of objectsoptional | Array of column identifiers. The identifiers can be index, text or regular expression of text |
$rows | string|integer|array of integersoptional | Can be a regular expression, an array of indexes or the starting index |
$count | integeroptional | If 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 strings | The data from the table |
Raw script
// All table datavar $data = _getTableContents(_table("tableId"));
// All rows, but only specific columns from the tablevar $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 tablevar $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 tablevar $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 tablevar $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 tablevar $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 tablevar $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
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | element whose style attribute we need |
$styleAttribute | string | style attribute to be fetched |
$pseudoEl | stringoptional | Use this argument to fetch style attribute from pseudo-elements like ::before, ::after, etc. |
Returns
string | The style attribute value |
Raw script
// Using in assertion_assertEqual("24px", _style(_heading1(0), "font-size"));
// Fetching and storing valuevar $fontSize = _style(_heading1(0), "font-size");
// Fetch style of a pseudo elementvar $backgroundColor = _style(_listItem("entry1"), "background-color", ":before")Sahi Pro Classic API _style
Position
Section titled “Position”Modes BrowserWindowsJavaAndroidiOSSAP
This may be used to verify layouts by comparing positions of specific elements.
Parameters
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | element whose position we need |
$relative | booleanoptional | If true, returns position relative to current viewport. Default is false. |
Returns
array of integers | An 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 valuevar $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
Position Native
Section titled “Position Native”Modes BrowserJavaVisual Assist
This may be used inside native events to find the absolute positions of elements.
Parameters
| Name | Type | Description |
|---|---|---|
$el | HTML DOM element | element whose position we need |
Returns
array of integers | An array [x,y] of the elements absolute position in pixels |
Raw script
// Using in assertionvar $xy = _positionNative(_link("Link Test"));_assertEqual(222, $xy[1]);
// Fetching and storing valuevar $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 elementSahi Pro Classic API _positionNative
Dimensions
Section titled “Dimensions”Modes BrowserWindowsJavaAndroidiOSSAP
This action gets the width and height as an array for the specified element.
Parameters
| Name | Type | Description |
|---|---|---|
$el | Element | element whose dimensions we need |
Returns
array of integers | An array [w,h] of the element's dimensions in pixels |
Raw script
// Using in assertion_assertEqual([100,40], _dimensions(_image("logo")));
// Fetching and storing valuevar $dimensions = _dimensions(_image("logo"));_log($dimensions[0]); //logs width (eg. 100)_log($dimensions[1]); //logs height (eg. 40)Sahi Pro Classic API _dimensions
Get Selection Text
Section titled “Get Selection Text”Modes BrowserWindowsJavaSAP
Parameters
| Name | Type | Description |
|---|---|---|
$el | HTML DOM elementoptional | Element in which to look for selection. This is optional only for Browser Automation, as Sahi will automatically look in all frames and elements. |
Returns
string | Text 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 valuevar $currentSelectedText = _getSelectionText();Sahi Pro Classic API _getSelectionText
Get Copied Text
Section titled “Get Copied Text”Modes Browser
Returns the text copied to the system clipboard by a web application.
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
string | Copied text |
Raw script
_lockWindow();_focusWindow();_clickNative(_button("Copy Text to Clipboard"));_unlockWindow();var $copiedText = _getCopiedText();_assertEqual("Copied text", $copiedText);Sahi Pro Classic API _getCopiedText
Browser Detection APIs
Section titled “Browser Detection APIs”User Agent
Section titled “User Agent”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
string | The userAgent string of the current browser |
Sahi Pro Classic API _userAgent
Get Screen Size
Section titled “Get Screen Size”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
array of integers | Screen 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 assertionvar $screensize=_getScreenSize();_assertTrue(($screensize[0]>=783)&&($screensize[0]<=800));_assertTrue(($screensize[1]>=280)&&($screensize[1]<=400));Sahi Pro Classic API _getScreenSize
Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Internet Explorer, else false |
Sahi Pro Classic API _isIE
Is IE9
Section titled “Is IE9”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Internet Explorer 9, else false |
Sahi Pro Classic API _isIE9
Is IE10
Section titled “Is IE10”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Internet Explorer 10, else false |
Sahi Pro Classic API _isIE10
Is Edge
Section titled “Is Edge”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Edge, else false |
Sahi Pro Classic API _isEdge
Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Firefox, else false |
Sahi Pro Classic API _isFF
Is FF3
Section titled “Is FF3”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Firefox 3, else false |
Sahi Pro Classic API _isFF3
Is FF4
Section titled “Is FF4”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Firefox 4, else false |
Sahi Pro Classic API _isFF4
Is Chrome
Section titled “Is Chrome”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Chrome, else false |
Sahi Pro Classic API _isChrome
Is Safari
Section titled “Is Safari”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Safari, else false |
Sahi Pro Classic API _isSafari
Is Opera
Section titled “Is Opera”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Opera, else false |
Sahi Pro Classic API _isOpera
Is Phantom JS
Section titled “Is Phantom JS”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is PhantomJS, else false |
Sahi Pro Classic API _isPhantomJS
Is Brave
Section titled “Is Brave”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true if the current browser is Brave, else false |
Sahi Pro Classic API _isBrave
Is HTMLUnit
Section titled “Is HTMLUnit”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
None |
Returns
boolean | true 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)”Generic attribute fetching mechanism
Section titled “Generic attribute fetching mechanism”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
| Name | Type | Description |
|---|---|---|
$expression | string|DOM expression | Expression which we wish to evaluate and fetch. |
Returns
string | Value of the expression |
Raw script
var $rowCount = _fetch(_table("tableId").rows.length);
// You can also use an expression as a stringvar $userAgent = _fetch("navigator.userAgent");// And fetch results of custom utility functions of your web appvar $value = _fetch("jQuery('#id').val()");
// While working with popup windows use _selectWindow first_selectWindow("popupWin");// Fetch table row count from popupWin windowvar $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
| Name | Type | Description |
|---|---|---|
$variable | variable | Variable into which we wish to get the specific value. |
$expression | DOM Expression | Expression which we wish to evaluate and set. |
Raw script
// Fetching href attributevar $href="null;" // initialize variable_set($href, _link("Home").href); // set it
// Getting row count of tablevar $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 itSahi Pro Classic API _set
Condition
Section titled “Condition”Modes Browser
Parameters
| Name | Type | Description |
|---|---|---|
$expression | DOM expression | Expression which we wish to evaluate. |
Returns
boolean | true 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
Multiple Elements
Section titled “Multiple Elements”Collect
Section titled “Collect”Modes BrowserWindowsJavaAndroidiOS
Parameters
| Name | Type | Description |
|---|---|---|
$elementType | string | type of elements to collect. Eg. "_link", "_button", "/text/" etc. |
$identifier | string | Sahi Identifier. Can also be just an index. |
$relations | relationsoptional | Relations like _in, _near etc. |
Returns
array of element stubs | Array 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 textboxesfor (var $i=0; $i<$textboxes.length; $i++) { _setValue($textboxes[$i], "value");}Sahi Pro Classic API _collect
Modes BrowserWindowsJavaAndroidiOS
Parameters
| Name | Type | Description |
|---|---|---|
$elementType | string | type of elements to collect. Eg. "_link", "_button", "/text/" etc. |
$identifier | string|object | Sahi Identifier/Attributes JSON. Can also be just an index. |
$relations | relationsoptional | Relations like _in, _near etc. |
Returns
integer | Count 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 explicitlyvar $textboxCount = _count("_textbox", {name:"q"});Sahi Pro Classic API _count
Collect Attributes
Section titled “Collect Attributes”Modes BrowserWindowsJavaAndroidiOS
Fetching a simple attribute from multiple elements
Parameters
| Name | Type | Description |
|---|---|---|
$elementType | string | type of elements to collect. Eg. "_link", "_button", "/text/" etc. |
$identifier | string | Sahi Identifier. Can also be just an index. |
$attribute | string|function | attribute or function. |
$relations | relationsoptional | Relations like _in, _near etc. |
Returns
li_s | Array 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-itemvar $menuTexts = _collectAttributes("_div", "menu-item", "sahiText");// or more explicitlyvar $menuTexts = _collectAttributes("_div", {className:"menu-item"}, "sahiText");Sahi Pro Classic API _collectAttributes
Collect Elements Info
Section titled “Collect Elements Info”Modes BrowserWindowsJava
Parameters
| Name | Type | Description |
|---|---|---|
$elementType | string | Type of elements to collect. Can be regular expression. Eg. "_link", "_button", "/text/" etc. |
$relations | relationsoptional | Relations like _in, _near etc. |
Returns
array of objects | Array 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

