Helper (autonomx-core 1.0.5 API)

java.lang.Object
- core.helpers.Helper

```
public class Helper
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static ClickHelper`	`click`
`static ClickHelperAction`	`clickAction`
`static ClickHelperJs`	`clickJs`
`static CsvHelper`	`csv`
`static DateHelper`	`date`
`static FormHelper`	`form`
`static ImageProcessingHelper`	`image`
`static ListHelper`	`list`
`static Loginbuilder`	`loginbuilder`
`static MobileHelper`	`mobile`
`static PageHelper`	`page`
`static VerifyHelper`	`verify`
`static WaitHelper`	`wait`

Constructor Summary

Constructors
Constructor and Description

Helper()

Constructors
Constructor and Description
`Helper()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`acceptAlert()` accepts alert by selecting ok or cancel
`static void`	`addFileToZip(String path, String srcFile, ZipOutputStream zip)`
`static void`	`appendToFile(String value, String absolutePath)` appends to existing file
`static void`	`appendToFile(String value, String directory, String filename, String type)` appends to existing file
`static void`	`assertContains(String actual, String expected)` assert actual contains expected
`static void`	`assertEquals(boolean expected, boolean actual)` assert expected equals actual
`static void`	`assertEquals(int expected, int actual)` assert expected equals actual
`static void`	`assertEquals(String expected, String actual)` assert expected equals actual
`static void`	`assertFalse(String message)`
`static void`	`assertTrue(String message, boolean value)` assert true
`static void`	`bringPageToFront()` brings current browser to front
`static EnhancedBy`	`byAccessibility(String element, String name)` gets element by accessibility id
`static EnhancedBy`	`byCss(String element, String name)` gets element by css value
`static EnhancedBy`	`byId(String element, String name)` gets element by id
`static EnhancedBy`	`byXpath(String element, String name)` gets element by xpath
`static void`	`captureExtentReportScreenshot()` captures screenshot And attaches to extent test report
`static void`	`clearAndSetField(EnhancedBy field, CharSequence... value)` sets field clears field before setting the value
`static void`	`clearAndSetField(EnhancedBy field, int index, CharSequence... value)` sets field clears field before setting the value
`static void`	`clickAndExpect(EnhancedBy target, EnhancedBy expected)` clicks target And waits for expected element to display retries 10 times
`static void`	`clickAndExpect(EnhancedBy target, EnhancedBy expected, boolean isMobileRefresh)` clicks target And waits for expected element to display retries 10 times
`static void`	`clickAndExpect(EnhancedBy target, EnhancedBy expected, EnhancedBy spinner)` clicks target And waits for expected element to show up also waits for spinner element to be removed from display
`static void`	`clickAndExpect(EnhancedBy target, int index, EnhancedBy expected)` clicks element based on index And waits for expected element to be displayed
`static void`	`clickAndExpect(EnhancedBy target, int index, EnhancedBy expected1, EnhancedBy expected2)` clicks target And wait for one the 2 expected elements to appear
`static void`	`clickAndExpect(EnhancedBy target, String text, EnhancedBy expected)` click And expect based on the text value on the element.
`void`	`clickAndExpectContainsByText(EnhancedBy target, String text, EnhancedBy expected)` click And expect based on the text value on the element.
`static void`	`clickAndHold(EnhancedBy target, double seconds)` click And hold element
`static void`	`clickAndHold(EnhancedBy target, int index, double seconds)` click And hold based on element index
`static void`	`clickAndNotExpect(EnhancedBy target, EnhancedBy expected)` clicks target And waits for expected to not be displayed retries 10 times
`static void`	`clickAndNotExpect(EnhancedBy target, int index, EnhancedBy expected)`
`static void`	`clickAndWait(EnhancedBy target, double timeInSeconds)` clicks target And waits for seconds
`static void`	`clickAndWait(EnhancedBy target, int index, double timeInSeconds)` clicks target And waits for seconds
`static void`	`clickElementContinsByText(EnhancedBy by, String text)` click element with text containing
`static void`	`clickElementLocationBy(EnhancedBy by, int x, int y)` Click on an element's specific x,y location
`static void`	`clickPoints(int x, int y)` click at position x, y
`void`	`clickPointsAndExpect(int x, int y, EnhancedBy expected)` click point at x,y coordinates and expect and element to be present retry every 5 seconds for duration of explicit timeout
`static void`	`CloseAndReturn(String defaultWindow)` close the window And return to the defaultWindow
`static void`	`copyDirectory(String dirFrom, String dirTo)` Copies directory And all content from dirFrom to dirTo overwrites the content
`static void`	`createFileFromPath(String absolutePath)` create directories and files based on absolute path
`static ZipOutputStream`	`createZip(String destZipFile)`
`static String`	`currentWindow()` return the current window handle
`static void`	`deleteAllCookies()` delete all cookies
`static void`	`deleteCookieNamed(String name)` delete cookie named
`static void`	`deleteFile(String absolutePath)` delete file
`static String`	`dimissAlert()` dismisses alert by selecting ok or cancel return alert message
`void`	`doubleClick(EnhancedBy target, int index)` double click on element
`static void`	`doubleClickBy(EnhancedBy by)`
`static void`	`doubleClickPoints(int x, int y)` double click at position
`static void`	`dragAndDrop(EnhancedBy src, EnhancedBy target)` drag And drop from src element to target element
`static void`	`dragAndDrop(EnhancedBy src, int xOffset, int yOffset)` drag And drop from src element to target element
`static String`	`excel_getCellData(ExcelObject excel)` This method is to read the test data from the Excel cell, in this we are passing parameters as Row num And Col num
`static List<String>`	`excel_getColumData(ExcelObject excel)` returns all the column data as array list of string
`static void`	`excel_setCellData(ExcelObject excel)` This method is to write in the Excel cell, Row num And Col num are the parameters
`static void`	`excel_setCellData(List<ExcelObject> excelObjects)`
`static ExcelObject`	`excel_setExcelFile(ExcelObject excel)` gets the excel file And the work sheet
`static ArrayList<String>`	`executeCommand(String command)` run command and return results as array list will run bash on linux or mac will run batch command on windows
`static ArrayList<String>`	`executeCommandFromFile(String filePath)` run script file and return results as array list will run bash on linux or mac will run batch command on windows
`static Object`	`executeJs(String script, Object... args)` execute javascript
`static List<String>`	`executeJsWithListReturn(String script, Object... args)` execute javascript
`static String`	`executeJsWithStringReturn(String script, Object... args)` execute javascript
`static int[]`	`findElementCoordinates(EnhancedBy target)` returns the center coordinates of the target element
`protected static EnhancedWebElement`	`findElements(EnhancedBy element)` finds list of elements
`protected static EnhancedWebElement`	`findElements(EnhancedBy parent, EnhancedBy child)` finds element based on parent element
`protected static EnhancedWebElement`	`findElements(EnhancedBy parent, int parentIndex, EnhancedBy child)` finds a list of elements based on parent element
`static int[]`	`findMiddleOfElement(EnhancedBy target)` returns the center coordinates of the target element
`static void`	`formSubmit(EnhancedBy button, EnhancedBy expected)` select submit button And wait for expected element to load
`static void`	`formSubmit(EnhancedBy button, EnhancedBy expected, EnhancedBy spinner)` clicks submit button, wait for element to appear And loading spinner to be removed
`static String`	`generateRandomInteger(int len)` generates random int of length len
`static int`	`generateRandomNumber(int min, int max)` generates random number between two numbers, min, max
`static String`	`generateRandomString(int len)` generates random string of length len
`static String`	`getAlertValue()` returns alert message value
`static List<String>`	`getAllValuesStartringWith(String source, String value)` gets a list of string from 'source' starting with 'value'
`static io.appium.java_client.android.AndroidDriver`	`getAndroidDriver()`
`static String`	`getAttribute(EnhancedBy byValue, int index, String attribute)` gets specified attribute of the element based on index
`static String`	`getAttribute(EnhancedBy byValue, String attribute)` gets specified attribute of the element
`static String`	`getClipboardData()` retrieves the clip board data
`static String`	`getCurrentUrl()` returns the current url
`static int`	`getElementIndexContainByText(EnhancedBy listValue, String option)` retuns index of element in list which contains in text
`static int`	`getElementIndexEqualsByText(EnhancedBy listValue, String option)` returns the index of text value in a list
`static int`	`getElementIndexInList(EnhancedBy srcList, EnhancedBy target)` find the index of the target element in list eg.
`static org.openqa.selenium.Point`	`getElementPosition(EnhancedBy by)` get element position on display
`static org.openqa.selenium.Point`	`getElementPosition(EnhancedBy by, int index)` get element position on display
`static org.openqa.selenium.Dimension`	`getElementSize(EnhancedBy by)` returns element dimension
`protected static String`	`getFileContent(String absolutePath)` gets file content as String
`static ArrayList<File>`	`getFileList(String directoryPath)` returns the list of files in directory
`static ArrayList<File>`	`getFileListByType(String directoryPath, String type)` gets the list of files
`static List<File>`	`getFileListWithSubfolders(String directoryName, String type, List<File> files)` gets list of files including from sub folder based on type.
`static io.appium.java_client.ios.IOSDriver`	`getiOSDriver()`
`static int`	`getListCount(EnhancedBy listValue)` returns the number of elements in list
`static List<String>`	`getListValues(EnhancedBy listValue)` returns the list of values in a list
`static String`	`getPageSource()` gets page source
`static String`	`getPageTitle()` returns the title of the page
`static String`	`getRootDir()` get current directory
`List<String>`	`getRowValuesFromList(EnhancedBy list, int index, EnhancedBy rows)` returns the list of string values for a row of elements
`static int`	`getStringIndexContainByText(List<String> stringList, String option)` returns the index of string value in list of strings
`static int`	`getStringIndexEqualsByText(List<String> stringList, String option)` returns the index of string value in list of strings
`HashMap<Integer,List<String>>`	`getTableMap(EnhancedBy dataRows, EnhancedBy dataCells)` gets hashmap of table rows map will return row index and row values as arraylist
`HashMap<String,List<String>>`	`getTableMap(EnhancedBy columns, EnhancedBy dataRows, EnhancedBy dataCells)` gets hashmap representation of data column with row values
`HashMap<String,List<String>>`	`getTableMap(EnhancedBy columns, EnhancedBy dataRows, EnhancedBy dataCells, int maxRows)` gets hashmap representation of data column with row values
`HashMap<String,List<String>>`	`getTableMap(EnhancedBy columns, int columnInitialIndex, EnhancedBy dataRows, int rowInitialIndex, EnhancedBy dataCells, int maxRows)` gets hashmap representation of data column with row values
`static List<String>`	`getTextList(EnhancedBy listValue)` returns the list of values in a list
`static String`	`getTextValue(EnhancedBy element)` gets the text value from an element
`static String`	`getTextValue(EnhancedBy element, int index)` gets the text value from an element
`static String`	`getValueFromPattern(String str, String pattern)`
`static List<String>`	`getValuesFromPattern(String str, String pattern)`
`static void`	`handleDifferentUser()` if single signin enabled, And new test user is different form previous, shutdown webdriver And restart
`static void`	`highLightWebElement(EnhancedBy by, int index)` highlights the web element use on clicks and send key elements
`static void`	`hoverBy(EnhancedBy by)` hover over element
`static void`	`hoverBy(EnhancedBy by, int index)` hover over element
`static void`	`hoverPoints(int x, int y)` Hover on the x,y points
`void`	`inputTextByAction(EnhancedBy by, String text)`
`static boolean`	`isAndroid()` is android driver
`static boolean`	`isAttributeContaining(EnhancedBy by, String attribute, String value)` returns true if element contains attribute value
`static boolean`	`isBoolean(String value)` returns if string is boolean
`static boolean`	`isContainedInList(EnhancedBy listValue, String option)` return if element is contained in list
`static boolean`	`isDisplayed(EnhancedBy element)` returns true if element is displayed
`static boolean`	`isElementContainingClass(EnhancedBy by, String classValue)` returns true if element contains class value
`static boolean`	`isElementContainingText(EnhancedBy element, String text)` returns true if element contains text
`static boolean`	`isExactMatchInList(EnhancedBy listValue, String option)` return if element is an exact match in list
`static boolean`	`isInternetExplorer()` returns true if browser is ie
`static boolean`	`isIOS()` is ios driver
`static boolean`	`isMac()` returns true if OS is mac
`static boolean`	`isNumeric(String value)` return if string is a number
`static boolean`	`isPresent(EnhancedBy element)` returns true if element is displayed
`static boolean`	`isTextDisplayed(String text)` is text displayed on page
`static boolean`	`isUnix()` returns true if OS is unix or linux
`static boolean`	`isUUID(String value)` is the string value UDID
`static Boolean`	`isVisibleInViewport(EnhancedBy by)` returns true if the element is visible in the current page only for web applications
`static Boolean`	`isVisibleInViewport(EnhancedBy by, int index)` returns true if the element is visible in the current page only for web applications
`static boolean`	`isWebDriver()` is web driver
`static boolean`	`isWindows()` returns true if OS is windows
`static void`	`killMacProcess(String serviceName)` returns kills the process if running
`static void`	`killWindowsProcess(String serviceName)` returns kills the process if running
`static void`	`localizationLoadJson(String fileName)` loads localization map from a json file to the test object data
`static void`	`localizationSetupCsv(String language)` sets the language for csv localization file
`static String`	`localize(String key)` gets local language from json file specified in properties file
`static void`	`maximizePage()` maximizes web page
`Set<String>`	`mobile_getContextList()` returns the list of mobile context.
`static void`	`mobile_hideKeyboard()` hides ios or android keyboard
`static boolean`	`mobile_isMobile()` returns if mobile driver is used
`static void`	`mobile_longPress(EnhancedBy target, long miliSeconds)` press per retry presses the target element
`static void`	`mobile_longPressAndExpect(EnhancedBy target, long miliSeconds, EnhancedBy expected)` long press And expect element
`static void`	`mobile_resetApp()` resets the app
`static void`	`mobile_scrollToElement(EnhancedBy target)` scrolls to mobile element until element is becomes visible
`static void`	`mobile_setLocation(org.openqa.selenium.html5.Location location)` sets gps location on ios simulator
`void`	`mobile_swipeDown(double durationInSeconds)` swipe down on the screen
`void`	`mobile_swipeDown(EnhancedBy element, int index, double durationInSeconds)` swipe down on the screen based on element position
`void`	`mobile_swipeLeft(double durationInSeconds)` swipe right on the screen
`void`	`mobile_swipeLeft(EnhancedBy element, int index, double durationInSeconds)` swipe left on the screen based on element position
`void`	`mobile_swipeRight(double durationInSeconds)` swipe right on the screen
`void`	`mobile_swipeRight(EnhancedBy element, int index, double durationInSeconds)` swipe right on the screen based on element position
`void`	`mobile_swipeUp(double durationInSeconds)` swipe up on the screen
`void`	`mobile_swipeUp(EnhancedBy element, int index, double durationInSeconds)` swipe up on the screen based on element position
`static void`	`mobile_switchToNativeView()` sets native context for android And ios apps
`void`	`mobile_switchToView(String view)` switch to view
`static void`	`mobile_switchToWebView()` sets web context for android And ios apps
`static void`	`mobile_waitAndRefreshForElementToLoad(EnhancedBy target)` waits for element to load And refreshes the app each time to renew the dom
`static void`	`mobile_waitAndRefreshForElementToLoad(EnhancedBy target, int time)` waits for element to load And refreshes the app each time to renew the dom
`static void`	`mobile_zoomIn(EnhancedBy indicator)` zooms in And checks if target level indicator has been reached
`static void`	`mobile_zoomIn(int zoomLevel)` zoom in based on zoom levels.
`static void`	`mobile_zoomOut(EnhancedBy indicator)` zooms out And checks if target level indicator has been reached
`static void`	`mobile_zoomOut(int zoomLevel)` zoom in based on zoom levels.
`static void`	`moveToElement(EnhancedBy target, int index)` move to element by using action
`static void`	`moveToElement(EnhancedBy target, int index, int xOffset, int yOffset)` move to element by using action
`static void`	`navigateBack()` navigates back
`static void`	`navigateForward()` navigate forward
`static void`	`navigateToUrl(String url)` navigate to a different url
`static void`	`pressEnterOnAndroid()` select enter on android
`static void`	`quitAllCurrentTestDrivers()` quits all drivers in the current test
`static void`	`quitCurrentDriver()` quits the current web driver
`static void`	`quitDriver(org.openqa.selenium.WebDriver driver)` quit driver
`static void`	`refreshMobileApp()` places the app in background And Then relaunches it
`static void`	`refreshPage()` reload page
`static void`	`refreshPageSource()` gets page source
`static void`	`rightClick(EnhancedBy target, int index)` right click on element at index
`static void`	`runApiContaining(String identifier, String prefix, String getApi, String targetApiId, String variable, String targerApi)` runApiContaining("name", "zzz_","getCompanies", "id","companyId","deleteCompany") get all companies with name containing zzz_, Then gets id of these companies, stores them in companyId variable And calls deleteCompany
`static void`	`runApiEquals(String identifier, String value, String getApi, String targetApiId, String variable, String targerApi)` runApiEquals("name", "test123","getCompanies", "id","companyId","deleteCompany") get all companies with name equals test123, Then gets id of these companies And calls delete with id
`static void`	`scrollDown()` scrolls down android
`static void`	`searchAndWaitForResults(String searchQuery, EnhancedBy byTarget, EnhancedBy spinner)` enters value into the search field And selects enter waits for the loading spinner to be removed
`static void`	`selectCheckBox(EnhancedBy button, boolean isSelect)` selects checkbox based on by value
`static void`	`selectDropDown(EnhancedBy field, EnhancedBy item)` select drop down using by value of the list item
`static void`	`selectDropDown(int index, EnhancedBy field, EnhancedBy listValue)` select drop down by index from the drop down list
`static void`	`selectDropDown(String option, EnhancedBy field, EnhancedBy listValue)` selects drop down
`static void`	`selectDropDown(String option, EnhancedBy field, EnhancedBy listValue, int listIndex)` select drop down based on index of the drop down list eg.
`static void`	`selectDropDown(String option, EnhancedBy field, int index, EnhancedBy listValue)` selects drop down based on index of the drop down field
`static void`	`selectDropDown(String option, EnhancedBy field, int index, EnhancedBy list, int listIndex)` select drop down based on index of the drop down list eg.
`static void`	`selectDropDown(String option, EnhancedBy field, String field_Identifier, EnhancedBy listValue)` selects drop down from list defined by another list defined by text
`static void`	`selectDropDownWithDoubleClick(String option, EnhancedBy field, EnhancedBy listValue)` selects dropdown by double clicking on the field
`static void`	`selectDropDownWithDoubleClick(String option, EnhancedBy field, int index, EnhancedBy listValue)` selects dropdown by double clicking on the field
`static void`	`selectElementContainedInList(EnhancedBy listValue, String option, EnhancedBy target)` Selects list item from a parent container eg.
`static void`	`selectElementInList(EnhancedBy listValue, int index)` selects an element in list by its index value
`static void`	`selectElementInList(EnhancedBy listValue, int index, EnhancedBy expected)` selects an element in list by its index value And waits for expected element
`static void`	`selectListItemByIndex(EnhancedBy listValue, int index)` selects list item by the string option provided
`static void`	`selectListItemContainsByName(EnhancedBy listValue, String option)` finds target element which is in the same container And has the same index as the parent eg.
`static void`	`selectListItemContainsByName(EnhancedBy listValue, String option, EnhancedBy target)` selects list item containing string eg.
`static void`	`selectListItemEqualsByName(EnhancedBy listValue, String option)` selects list item by the string option provided
`static void`	`selectListItemEqualsByName(EnhancedBy listValue, String option, EnhancedBy target)` finds target element which is in the same container And has the same index as the parent eg.
`static void`	`selectMultipleCheckboxOptions(List<String> selections, EnhancedBy checkboxes)` selects multiple checkbox options
`static void`	`selectRadioButton(EnhancedBy button)` selects a button
`static void`	`selectRadioButton(String option, EnhancedBy buttons)` selects radio button by radio button description
`static void`	`sendMail(EmailObject email)` sends email to recipient using email object
`static void`	`setAttribute(EnhancedBy by, int index, String attribute, String value)` sets attribute value of an element
`static void`	`setAttribute(EnhancedBy by, String attribute, String value)` sets attribute value of an element
`static void`	`setChildField(EnhancedBy parent, int parentIndex, EnhancedBy child, int childIndex, CharSequence... value)` sets key based on nested text field
`static void`	`setField(EnhancedBy field, CharSequence... value)` set field value if value is not empty
`static void`	`setField(String value, EnhancedBy field, int index)` sets field text value by index hides keyboard if on ios device
`static void`	`setFieldAndEnter(EnhancedBy field, CharSequence... value)` sets field And presses the enter key
`static void`	`setFieldByAction(EnhancedBy field, CharSequence... value)`
`static void`	`setFieldByAction(EnhancedBy field, int index, CharSequence... value)`
`static void`	`setFieldByJs(EnhancedBy field, CharSequence... value)`
`static void`	`setFieldByJs(EnhancedBy field, int index, CharSequence... value)`
`static void`	`setKey(org.openqa.selenium.Keys key, EnhancedBy field)` send
`static void`	`setPageSize(int x, int y)` sets page size
`static void`	`softAssertEqual(int expected, int actual)`
`static void`	`softAssertEqual(String expected, String actual)`
`static void`	`softAssertTrue(String message, boolean value)`
`static StopWatchHelper`	`start()` StopWatchHelper watch = Helper.start(); do something long passedTimeInMs = watch.time(); long passedTimeInSeconds = watch.time(TimeUnit.SECONDS);
`static String`	`stringNormalize(String value)` normalizes string removes space, new line chars
`static String`	`stringRemoveLines(String value)` normalizes string removes space, new line chars
`static void`	`switchDriver(org.openqa.selenium.WebDriver driver)` switch webdriver use for switching between different drivers
`static void`	`switchIframe(EnhancedBy frame)` switches frame to frame specified
`static void`	`switchToDefaultFrame()` switches to default frame
`static void`	`switchToNewWindow(String defaultWindow)` switch to the new opened window
`static void`	`switchToNextTab()` switch to next tab
`static void`	`switchToPreviousTab()` switch to next tab circles back to initial tab if it reaches the last tab
`static void`	`switchToTab(int index)` switch to previous tab circle back to the last tab
`static void`	`swtichUrl(String url)` navigate to a different url
`static void`	`uploadFile(String location, EnhancedBy imageButton)` uploads file by specifying file location relative to main path
`static void`	`uploadImage(String location, EnhancedBy imageButton, EnhancedBy images)` sets the image based on location
`static void`	`uploadImages(List<String> locations, EnhancedBy imageButton, EnhancedBy images)` sets the image based on location
`static void`	`verifyAnyText(EnhancedBy target, String... values)` verifies if text contains any of values in list
`static void`	`verifyAnyTextContaining(EnhancedBy target, String... values)` verifies if text contains any of values in list
`static void`	`verifyContainsIsInList(EnhancedBy listValue, String option)` verifies if option value is in the list index = -1 indicates the value is not in list
`static void`	`verifyElementContainingText(EnhancedBy element, String text)` verify if element contains text
`static void`	`verifyElementCount(EnhancedBy by, int value, int... correction)` verifies element count
`static void`	`verifyElementIsDisplayed(EnhancedBy by)` verifies if element(s) is (are) displayed
`static void`	`verifyElementIsNotDisplayed(EnhancedBy by)` verifies if element(s) is (are) not displayed
`static void`	`verifyElementText(EnhancedBy by, String value)` verifies element text equals provided value
`static void`	`verifyIsInList(EnhancedBy listValue, String option)` verifies if option value is in the list index = -1 indicates the value is not in list
`static void`	`verifyIsInList(EnhancedBy listValue, String indicator, String option)` verify text option in list based on key value in the list
`static void`	`verifyNumberOfTabs(int tabs)` switch to tab by index
`static void`	`verifyTextDisplayed(String text)` verify if text is displayed on page
`static void`	`verifyTitle(String appTitle)` verify page title
`static void`	`waitForAdditionalElementsToLoad(EnhancedBy target, int originalCount)` waits for element count to increase from the originalCount Usefull When waiting for a list to expand with additional items
`static void`	`waitForAdditionalElementsToLoad(EnhancedBy target, int originalCount, int time)` waits for element count to increase from the originalCount Usefull When waiting for a list to expand with additional items
`static boolean`	`waitForAnyTextToLoad(EnhancedBy target, int time, String... text)` wait for any text strings to become available
`static boolean`	`waitForAnyTextToLoad(EnhancedBy target, String... text)` wait for any text strings to become available
`static boolean`	`waitForAnyTextToLoadContaining(EnhancedBy target, int time, String... text)` wait for any text strings to become available
`static boolean`	`waitForAnyTextToLoadContaining(EnhancedBy target, String... text)` wait for any text strings to become available
`boolean`	`waitForClassContain(EnhancedBy target, int index, String value)` wait for class to contain
`boolean`	`waitForClassContain(EnhancedBy target, int index, String value, int time)` wait for class to contain value
`static boolean`	`waitForElementToBeClickable(EnhancedBy selector)` wait for element to become clickable causes instability with hybrid mobile app
`static boolean`	`waitForElementToBeClickable(EnhancedBy selector, int timeInSeconds)` wait for element to become clickable causes instability with hybrid mobile app
`static void`	`waitForElementToBeRemoved(EnhancedBy target)` waits for element to not be displayed wait for maximum of 60 seconds
`static boolean`	`waitForElementToBeRemoved(EnhancedBy target, int time)` waits for element to not be displayed
`static void`	`waitForElementToLoad(EnhancedBy target)` waits for element to be displayed for amount of time specified by 60 seconds
`static boolean`	`waitForElementToLoad(EnhancedBy target, int time)` waits for element to load count() checks if the element is displayed Then gets the count number
`static boolean`	`waitForElementToLoad(EnhancedBy target, int time, int count)` waits for element to load If mobile device, scrolls down the page until element is visible
`static boolean`	`waitForFirstElementToLoad(EnhancedBy element1, EnhancedBy element2)` waits for either element to load returns true When first item loads
`static boolean`	`waitForFirstElementToLoad(EnhancedBy element1, EnhancedBy element2, EnhancedBy element3)` waits for either element to load returns true When first item loads
`static boolean`	`waitForFirstElementToLoad(EnhancedBy element1, EnhancedBy element2, EnhancedBy element3, int time)` waits for either element to load returns true When first item loads
`static boolean`	`waitForFirstElementToLoad(EnhancedBy element1, EnhancedBy element2, int time)` waits for either element to load returns true When first item loads
`static void`	`waitForListItemToLoad_Contains(EnhancedBy list, String option)` waits for item containing in list to load
`static void`	`waitForPageToLoad()` waits for webpage to load
`static void`	`waitForSeconds(double seconds)` waits for number of seconds
`static void`	`waitForTextToLoad(EnhancedBy target, int time, String text)` make sure only one element And caller needs to take responsibility to have text in the element
`static void`	`waitForTextToLoad(EnhancedBy target, String text)` waits for text to be loaded for amount of time specified by 60 seconds
`static void`	`writeFile(String value, String absolutePath)` Create file (where pom.xml is) and write to it
`static void`	`writeFile(String value, String path, String filename, String type)` Create file with path starting from root directory (where pom.xml is) and write to it.
`static ZipOutputStream`	`zipFolder(String srcFolder, String destZipFile)` zip folder

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

click
```
public static ClickHelper click
```

wait
```
public static WaitHelper wait
```

mobile
```
public static MobileHelper mobile
```

list
```
public static ListHelper list
```

page
```
public static PageHelper page
```

form
```
public static FormHelper form
```

image

public static ImageProcessingHelper image

date
```
public static DateHelper date
```

csv
```
public static CsvHelper csv
```

loginbuilder

public static Loginbuilder loginbuilder

verify
```
public static VerifyHelper verify
```

clickJs
```
public static ClickHelperJs clickJs
```

clickAction

public static ClickHelperAction clickAction

Constructor Detail
- Helper
```
public Helper()
```

Method Detail

excel_setExcelFile

public static ExcelObject excel_setExcelFile(ExcelObject excel)
                                      throws Exception

gets the excel file And the work sheet

Parameters:: Path -; SheetName -
Throws:: Exception

excel_getColumData

public static List<String> excel_getColumData(ExcelObject excel)
                                       throws Exception

returns all the column data as array list of string

Parameters:: colNum -
Returns:
Throws:: Exception

excel_getCellData
```
public static String excel_getCellData(ExcelObject excel)
                                throws Exception
```
This method is to read the test data from the Excel cell, in this we are passing parameters as Row num And Col num

Parameters:

RowNum -

ColNum -

Returns:

Throws:

Exception

excel_setCellData
```
public static void excel_setCellData(ExcelObject excel)
                              throws Exception
```
This method is to write in the Excel cell, Row num And Col num are the parameters

Parameters:

excel - - required: excel.row, excel.column, excel.value, excel.file

Throws:

Exception

excel_setCellData

public static void excel_setCellData(List<ExcelObject> excelObjects)
                              throws Exception

Parameters:: excelObjects - - contains data info
Throws:: Exception

assertTrue

public static void assertTrue(String message,
                              boolean value)

assert true

Parameters:: message - if fail; value -

assertFalse

public static void assertFalse(String message)

assertEquals

public static void assertEquals(String expected,
                                String actual)

assert expected equals actual

Parameters:: expected -; actual -

assertEquals

public static void assertEquals(boolean expected,
                                boolean actual)

assert expected equals actual

Parameters:: expected -; actual -

assertEquals

public static void assertEquals(int expected,
                                int actual)

assert expected equals actual

Parameters:: expected -; actual -

assertContains

public static void assertContains(String actual,
                                  String expected)

assert actual contains expected

Parameters:: actual -; expected -

softAssertTrue

public static void softAssertTrue(String message,
                                  boolean value)

softAssertEqual

public static void softAssertEqual(String expected,
                                   String actual)

softAssertEqual

public static void softAssertEqual(int expected,
                                   int actual)

findElements

protected static EnhancedWebElement findElements(EnhancedBy parent,
                                                 EnhancedBy child)

finds element based on parent element

Parameters:: element -; parent -
Returns:

findElements

protected static EnhancedWebElement findElements(EnhancedBy element)

finds list of elements

Parameters:: element -
Returns:

findElements

protected static EnhancedWebElement findElements(EnhancedBy parent,
                                                 int parentIndex,
                                                 EnhancedBy child)

finds a list of elements based on parent element

Parameters:: element -; parent -
Returns:

byCss

public static EnhancedBy byCss(String element,
                               String name)

gets element by css value

Parameters:: element -; name -
Returns:

byId

public static EnhancedBy byId(String element,
                              String name)

gets element by id

Parameters:: element -; name -
Returns:

byXpath

public static EnhancedBy byXpath(String element,
                                 String name)

gets element by xpath

Parameters:: element -; name -
Returns:

byAccessibility

public static EnhancedBy byAccessibility(String element,
                                         String name)

gets element by accessibility id

Parameters:: element -; name -
Returns:

clickAndExpect

public static void clickAndExpect(EnhancedBy target,
                                  EnhancedBy expected)

clicks target And waits for expected element to display retries 10 times

Parameters:: target -; expected -

clickAndExpect

public static void clickAndExpect(EnhancedBy target,
                                  String text,
                                  EnhancedBy expected)

click And expect based on the text value on the element. eg. button with "OK" text

Parameters:: target -; text -; expected -

clickAndExpectContainsByText

public void clickAndExpectContainsByText(EnhancedBy target,
                                         String text,
                                         EnhancedBy expected)

click And expect based on the text value on the element. eg. button with "OK" text

Parameters:: target -; text -; expected -

clickAndExpect

public static void clickAndExpect(EnhancedBy target,
                                  EnhancedBy expected,
                                  boolean isMobileRefresh)

clicks target And waits for expected element to display retries 10 times

Parameters:: target -; expected -

clickAndExpect

public static void clickAndExpect(EnhancedBy target,
                                  int index,
                                  EnhancedBy expected1,
                                  EnhancedBy expected2)

clicks target And wait for one the 2 expected elements to appear

Parameters:: target -; index -; expected1 -; expected2 -

clickAndExpect

public static void clickAndExpect(EnhancedBy target,
                                  int index,
                                  EnhancedBy expected)

clicks element based on index And waits for expected element to be displayed

Parameters:: target -; index -; expected -

clickAndExpect

public static void clickAndExpect(EnhancedBy target,
                                  EnhancedBy expected,
                                  EnhancedBy spinner)

clicks target And waits for expected element to show up also waits for spinner element to be removed from display

Parameters:: target -; expected -; spinner -

clickAndNotExpect

public static void clickAndNotExpect(EnhancedBy target,
                                     EnhancedBy expected)

clicks target And waits for expected to not be displayed retries 10 times

Parameters:: target -; expected -

clickAndWait

public static void clickAndWait(EnhancedBy target,
                                double timeInSeconds)

clicks target And waits for seconds

Parameters:: target -; expected -

clickAndWait

public static void clickAndWait(EnhancedBy target,
                                int index,
                                double timeInSeconds)

clicks target And waits for seconds

Parameters:: target -; expected -

clickAndNotExpect

public static void clickAndNotExpect(EnhancedBy target,
                                     int index,
                                     EnhancedBy expected)

clickElementLocationBy

public static void clickElementLocationBy(EnhancedBy by,
                                          int x,
                                          int y)

Click on an element's specific x,y location

Parameters:: by - by element; x - x offset coordinate; y - y offset coordinate

clickPoints

public static void clickPoints(int x,
                               int y)

click at position x, y

Parameters:: x -; y -

clickPointsAndExpect

public void clickPointsAndExpect(int x,
                                 int y,
                                 EnhancedBy expected)

click point at x,y coordinates and expect and element to be present retry every 5 seconds for duration of explicit timeout

Parameters:: x -; y -; expected -

doubleClickPoints

public static void doubleClickPoints(int x,
                                     int y)

double click at position

Parameters:: x -; y -

doubleClick

public void doubleClick(EnhancedBy target,
                        int index)

double click on element

Parameters:: target -; index -

rightClick

public static void rightClick(EnhancedBy target,
                              int index)

right click on element at index

Parameters:: target -; index -

clickElementContinsByText

public static void clickElementContinsByText(EnhancedBy by,
                                             String text)

click element with text containing

Parameters:: by -; text -

clickAndHold

public static void clickAndHold(EnhancedBy target,
                                double seconds)

click And hold element

Parameters:: target -; seconds -

clickAndHold

public static void clickAndHold(EnhancedBy target,
                                int index,
                                double seconds)

click And hold based on element index

Parameters:: target -; index -; seconds -

dragAndDrop

public static void dragAndDrop(EnhancedBy src,
                               EnhancedBy target)

drag And drop from src element to target element

Parameters:: src -; target -

dragAndDrop

public static void dragAndDrop(EnhancedBy src,
                               int xOffset,
                               int yOffset)

drag And drop from src element to target element

Parameters:: src -; target -

verifyElementIsDisplayed
```
public static void verifyElementIsDisplayed(EnhancedBy by)
```
verifies if element(s) is (are) displayed

Parameters:

by -

isDisplayed
```
public static boolean isDisplayed(EnhancedBy element)
```
returns true if element is displayed

Parameters:

element -

Returns:

isPresent
```
public static boolean isPresent(EnhancedBy element)
```
returns true if element is displayed

Parameters:

element -

Returns:

isElementContainingText

public static boolean isElementContainingText(EnhancedBy element,
                                              String text)

returns true if element contains text

Parameters:: element -; text -
Returns:

verifyElementContainingText

public static void verifyElementContainingText(EnhancedBy element,
                                               String text)

verify if element contains text

Parameters:: element -; text -

verifyTextDisplayed
```
public static void verifyTextDisplayed(String text)
```
verify if text is displayed on page

Parameters:

text -

isTextDisplayed
```
public static boolean isTextDisplayed(String text)
```
is text displayed on page

Parameters:

text -

Returns:

verifyElementIsNotDisplayed
```
public static void verifyElementIsNotDisplayed(EnhancedBy by)
```
verifies if element(s) is (are) not displayed

Parameters:

by -

verifyElementText

public static void verifyElementText(EnhancedBy by,
                                     String value)

verifies element text equals provided value

Parameters:: by -; value -

verifyElementCount

public static void verifyElementCount(EnhancedBy by,
                                      int value,
                                      int... correction)

verifies element count

Parameters:: by -; value -

verifyAnyTextContaining

public static void verifyAnyTextContaining(EnhancedBy target,
                                           String... values)

verifies if text contains any of values in list

Parameters:: target -; values -

verifyAnyText

public static void verifyAnyText(EnhancedBy target,
                                 String... values)

verifies if text contains any of values in list

Parameters:: target -; values -

setField

public static void setField(String value,
                            EnhancedBy field,
                            int index)

sets field text value by index hides keyboard if on ios device

Parameters:: value -; field -; index -

setField

public static void setField(EnhancedBy field,
                            CharSequence... value)

set field value if value is not empty

Parameters:: field -; value -

setFieldByAction

public static void setFieldByAction(EnhancedBy field,
                                    int index,
                                    CharSequence... value)

setFieldByAction

public static void setFieldByAction(EnhancedBy field,
                                    CharSequence... value)

setFieldByJs

public static void setFieldByJs(EnhancedBy field,
                                int index,
                                CharSequence... value)

setFieldByJs

public static void setFieldByJs(EnhancedBy field,
                                CharSequence... value)

clearAndSetField

public static void clearAndSetField(EnhancedBy field,
                                    CharSequence... value)

sets field clears field before setting the value

Parameters:: field -; value -

clearAndSetField

public static void clearAndSetField(EnhancedBy field,
                                    int index,
                                    CharSequence... value)

sets field clears field before setting the value

Parameters:: field -; index -; value -

setChildField

public static void setChildField(EnhancedBy parent,
                                 int parentIndex,
                                 EnhancedBy child,
                                 int childIndex,
                                 CharSequence... value)

sets key based on nested text field

Parameters:: parent -; parentIndex -; child -; childIndex -; value -

setFieldAndEnter

public static void setFieldAndEnter(EnhancedBy field,
                                    CharSequence... value)

sets field And presses the enter key

Parameters:: field -; value -

setKey

public static void setKey(org.openqa.selenium.Keys key,
                          EnhancedBy field)

send

Parameters:: key -; field -

formSubmit

public static void formSubmit(EnhancedBy button,
                              EnhancedBy expected)

select submit button And wait for expected element to load

Parameters:: button -; expected -

formSubmit

public static void formSubmit(EnhancedBy button,
                              EnhancedBy expected,
                              EnhancedBy spinner)

clicks submit button, wait for element to appear And loading spinner to be removed

Parameters:: button -; expected -; spinner -

selectDropDownWithDoubleClick

public static void selectDropDownWithDoubleClick(String option,
                                                 EnhancedBy field,
                                                 EnhancedBy listValue)

selects dropdown by double clicking on the field

Parameters:: option -; field -; list -

selectDropDownWithDoubleClick

public static void selectDropDownWithDoubleClick(String option,
                                                 EnhancedBy field,
                                                 int index,
                                                 EnhancedBy listValue)

selects dropdown by double clicking on the field

Parameters:: option -; field -; list -

selectDropDown

public static void selectDropDown(String option,
                                  EnhancedBy field,
                                  EnhancedBy listValue)

selects drop down

Parameters:: option - : list option we want to select; field - : the drop down field; list - : the list items in the drop down list

selectDropDown

public static void selectDropDown(String option,
                                  EnhancedBy field,
                                  String field_Identifier,
                                  EnhancedBy listValue)

selects drop down from list defined by another list defined by text

Parameters:: option -; field -; field_Identifier -; list -

selectDropDown

public static void selectDropDown(int index,
                                  EnhancedBy field,
                                  EnhancedBy listValue)

select drop down by index from the drop down list

Parameters:: index -; field -; list -

selectDropDown

public static void selectDropDown(EnhancedBy field,
                                  EnhancedBy item)

select drop down using by value of the list item

Parameters:: index -; field -; list -

selectDropDown

public static void selectDropDown(String option,
                                  EnhancedBy field,
                                  EnhancedBy listValue,
                                  int listIndex)

select drop down based on index of the drop down list eg. used for date selection where each date value: day, month, year, is separate list send key is used to select the value from the list

Parameters:: option -; field -; list -; listIndex -

selectDropDown

public static void selectDropDown(String option,
                                  EnhancedBy field,
                                  int index,
                                  EnhancedBy list,
                                  int listIndex)

select drop down based on index of the drop down list eg. used for date selection where each date value: day, month, year, is separate list send key is used to select the value from the list

Parameters:: option -; field -; index -; list -; listIndex -

selectDropDown

public static void selectDropDown(String option,
                                  EnhancedBy field,
                                  int index,
                                  EnhancedBy listValue)

selects drop down based on index of the drop down field

Parameters:: option -; field -; index -; list -

selectCheckBox

public static void selectCheckBox(EnhancedBy button,
                                  boolean isSelect)

selects checkbox based on by value

Parameters:: button -; isSelect -

selectRadioButton

public static void selectRadioButton(String option,
                                     EnhancedBy buttons)

selects radio button by radio button description

Parameters:: option -; buttons -

selectRadioButton

public static void selectRadioButton(EnhancedBy button)

selects a button

Parameters:: button -

selectMultipleCheckboxOptions

public static void selectMultipleCheckboxOptions(List<String> selections,
                                                 EnhancedBy checkboxes)

selects multiple checkbox options

Parameters:: selections -; checkboxes -

uploadFile

public static void uploadFile(String location,
                              EnhancedBy imageButton)

uploads file by specifying file location relative to main path

Parameters:: location -; imageButton -

uploadImages

public static void uploadImages(List<String> locations,
                                EnhancedBy imageButton,
                                EnhancedBy images)

sets the image based on location

Parameters:: location -; imageButton -; images - : uploaded image

uploadImage

public static void uploadImage(String location,
                               EnhancedBy imageButton,
                               EnhancedBy images)

sets the image based on location

Parameters:: location -; imageButton -; images - : uploaded image

getTextValue
```
public static String getTextValue(EnhancedBy element)
```
gets the text value from an element

Parameters:

element -

Returns:

getTextValue

public static String getTextValue(EnhancedBy element,
                                  int index)

gets the text value from an element

Parameters:: element -
Returns:

selectElementInList

public static void selectElementInList(EnhancedBy listValue,
                                       int index)

selects an element in list by its index value

Parameters:: list -; index -

selectElementInList

public static void selectElementInList(EnhancedBy listValue,
                                       int index,
                                       EnhancedBy expected)

selects an element in list by its index value And waits for expected element

Parameters:: list -; index -; expected -

searchAndWaitForResults

public static void searchAndWaitForResults(String searchQuery,
                                           EnhancedBy byTarget,
                                           EnhancedBy spinner)

enters value into the search field And selects enter waits for the loading spinner to be removed

Parameters:: searchQuery -; byTarget -; spinner -

selectListItemEqualsByName

public static void selectListItemEqualsByName(EnhancedBy listValue,
                                              String option)

selects list item by the string option provided

Parameters:: list -; option -

selectListItemEqualsByName

public static void selectListItemEqualsByName(EnhancedBy listValue,
                                              String option,
                                              EnhancedBy target)

finds target element which is in the same container And has the same index as the parent eg. delete button in the list of customers, both having index 2. we find the index by name, And use that to find the target element

Parameters:: list -; option -; target -

selectListItemContainsByName

public static void selectListItemContainsByName(EnhancedBy listValue,
                                                String option,
                                                EnhancedBy target)

selects list item containing string eg. a list of athletes names containing a delete button

Parameters:: list -; option -; target -

getElementIndexInList
```
public static int getElementIndexInList(EnhancedBy srcList,
                                        EnhancedBy target)
```
find the index of the target element in list eg. list A, 5 rows, has element B in row 2. therefore, index 1 is returned @param list

Parameters:

list -

target -

Returns:

index of element in list

getRowValuesFromList

public List<String> getRowValuesFromList(EnhancedBy list,
                                         int index,
                                         EnhancedBy rows)

returns the list of string values for a row of elements

Parameters:: list -; index -; rows -
Returns:

getTableMap

public HashMap<String,List<String>> getTableMap(EnhancedBy columns,
                                                EnhancedBy dataRows,
                                                EnhancedBy dataCells)

gets hashmap representation of data column with row values

Parameters:: columns -; dataRows -
Returns:

getTableMap

public HashMap<String,List<String>> getTableMap(EnhancedBy columns,
                                                EnhancedBy dataRows,
                                                EnhancedBy dataCells,
                                                int maxRows)

gets hashmap representation of data column with row values

Parameters:: columns -; dataRows -; dataCells -; maxRows -
Returns:

getTableMap

public HashMap<String,List<String>> getTableMap(EnhancedBy columns,
                                                int columnInitialIndex,
                                                EnhancedBy dataRows,
                                                int rowInitialIndex,
                                                EnhancedBy dataCells,
                                                int maxRows)

gets hashmap representation of data column with row values

Parameters:: columns -; columnInitialIndex -; dataRows -; rowInitialIndex -; dataCells -; maxRows -
Returns:

getTableMap

public HashMap<Integer,List<String>> getTableMap(EnhancedBy dataRows,
                                                 EnhancedBy dataCells)

gets hashmap of table rows map will return row index and row values as arraylist

Parameters:: dataRows -; dataCells -
Returns:

selectElementContainedInList

public static void selectElementContainedInList(EnhancedBy listValue,
                                                String option,
                                                EnhancedBy target)

Selects list item from a parent container eg. delete button in a list defined by name find the container containing the name And Then finds the delete button in that container as target

Parameters:: list -; option -; target -

selectListItemContainsByName
```
public static void selectListItemContainsByName(EnhancedBy listValue,
                                                String option)
```
finds target element which is in the same container And has the same index as the parent eg. delete button in the list of customers, both having index 2. we find the index containing name, And use that to find the target element

Parameters:

list -

option -

selectListItemByIndex

public static void selectListItemByIndex(EnhancedBy listValue,
                                         int index)

selects list item by the string option provided

Parameters:: list -; option -

getListCount
```
public static int getListCount(EnhancedBy listValue)
```
returns the number of elements in list

Parameters:

list -

Returns:

getElementIndexEqualsByText

public static int getElementIndexEqualsByText(EnhancedBy listValue,
                                              String option)

returns the index of text value in a list

Parameters:: list -; option -
Returns:

getElementIndexContainByText

public static int getElementIndexContainByText(EnhancedBy listValue,
                                               String option)

retuns index of element in list which contains in text

Parameters:: list -; option -
Returns:

getStringIndexContainByText

public static int getStringIndexContainByText(List<String> stringList,
                                              String option)

returns the index of string value in list of strings

Parameters:: stringList - normalized; option - normalized
Returns:

getStringIndexEqualsByText

public static int getStringIndexEqualsByText(List<String> stringList,
                                             String option)

returns the index of string value in list of strings

Parameters:: stringList - normalized; option - normalized
Returns:

verifyContainsIsInList

public static void verifyContainsIsInList(EnhancedBy listValue,
                                          String option)

verifies if option value is in the list index = -1 indicates the value is not in list

Parameters:: list -; option -

verifyIsInList

public static void verifyIsInList(EnhancedBy listValue,
                                  String option)

verifies if option value is in the list index = -1 indicates the value is not in list

Parameters:: list -; option -

verifyIsInList

public static void verifyIsInList(EnhancedBy listValue,
                                  String indicator,
                                  String option)

verify text option in list based on key value in the list

Parameters:: list -; indicator -; option -

isContainedInList

public static boolean isContainedInList(EnhancedBy listValue,
                                        String option)

return if element is contained in list

Parameters:: list -; option -
Returns:

isExactMatchInList

public static boolean isExactMatchInList(EnhancedBy listValue,
                                         String option)

return if element is an exact match in list

Parameters:: list -; option -
Returns:

getListValues
```
public static List<String> getListValues(EnhancedBy listValue)
```
returns the list of values in a list

Parameters:

list -

Returns:

getTextList
```
public static List<String> getTextList(EnhancedBy listValue)
```
returns the list of values in a list

Parameters:

list -

Returns:

getAndroidDriver

public static io.appium.java_client.android.AndroidDriver getAndroidDriver()

getiOSDriver

public static io.appium.java_client.ios.IOSDriver getiOSDriver()

mobile_hideKeyboard
```
public static void mobile_hideKeyboard()
```
hides ios or android keyboard

pressEnterOnAndroid

public static void pressEnterOnAndroid()

select enter on android

mobile_resetApp
```
public static void mobile_resetApp()
```
resets the app

refreshMobileApp
```
public static void refreshMobileApp()
```
places the app in background And Then relaunches it

mobile_isMobile
```
public static boolean mobile_isMobile()
```
returns if mobile driver is used

Returns:

isInternetExplorer
```
public static boolean isInternetExplorer()
```
returns true if browser is ie

Returns:

isIOS
```
public static boolean isIOS()
```
is ios driver

Returns:

isAndroid
```
public static boolean isAndroid()
```
is android driver

Returns:

isWebDriver
```
public static boolean isWebDriver()
```
is web driver

Returns:

mobile_setLocation

public static void mobile_setLocation(org.openqa.selenium.html5.Location location)

sets gps location on ios simulator

Parameters:: location -

mobile_swipeRight

public void mobile_swipeRight(double durationInSeconds)

swipe right on the screen

mobile_swipeRight

public void mobile_swipeRight(EnhancedBy element,
                              int index,
                              double durationInSeconds)

swipe right on the screen based on element position

mobile_swipeLeft

public void mobile_swipeLeft(double durationInSeconds)

swipe right on the screen

mobile_swipeLeft

public void mobile_swipeLeft(EnhancedBy element,
                             int index,
                             double durationInSeconds)

swipe left on the screen based on element position

mobile_swipeUp

public void mobile_swipeUp(EnhancedBy element,
                           int index,
                           double durationInSeconds)

swipe up on the screen based on element position

mobile_swipeUp

public void mobile_swipeUp(double durationInSeconds)

swipe up on the screen

mobile_swipeDown

public void mobile_swipeDown(double durationInSeconds)

swipe down on the screen

mobile_swipeDown

public void mobile_swipeDown(EnhancedBy element,
                             int index,
                             double durationInSeconds)

swipe down on the screen based on element position

mobile_switchToNativeView
```
public static void mobile_switchToNativeView()
```
sets native context for android And ios apps

Parameters:

context -

mobile_switchToWebView
```
public static void mobile_switchToWebView()
```
sets web context for android And ios apps

Parameters:

context -

mobile_switchToView

public void mobile_switchToView(String view)

switch to view

Parameters:: view -

mobile_getContextList
```
public Set<String> mobile_getContextList()
```
returns the list of mobile context. eg. webview, native view

Returns:

mobile_longPress

public static void mobile_longPress(EnhancedBy target,
                                    long miliSeconds)

press per retry presses the target element

Parameters:: target -; index -; miliSeconds -; expected -

mobile_longPressAndExpect

public static void mobile_longPressAndExpect(EnhancedBy target,
                                             long miliSeconds,
                                             EnhancedBy expected)

long press And expect element

Parameters:: target -; miliSeconds -; expected -

mobile_zoomOut
```
public static void mobile_zoomOut(int zoomLevel)
```
zoom in based on zoom levels. eg. 3 equals zooming out 3 times

Parameters:

zoomLevel -

mobile_zoomOut
```
public static void mobile_zoomOut(EnhancedBy indicator)
```
zooms out And checks if target level indicator has been reached

Parameters:

zoomLevel -

indicator -

mobile_zoomIn
```
public static void mobile_zoomIn(EnhancedBy indicator)
```
zooms in And checks if target level indicator has been reached

Parameters:

zoomLevel -

indicator -

mobile_zoomIn
```
public static void mobile_zoomIn(int zoomLevel)
```
zoom in based on zoom levels. eg. 3 equals zooming in 3 times

Parameters:

zoomLevel -

scrollDown
```
public static void scrollDown()
```
scrolls down android

mobile_scrollToElement
```
public static void mobile_scrollToElement(EnhancedBy target)
```
scrolls to mobile element until element is becomes visible

Parameters:

target -

maximizePage
```
public static void maximizePage()
```
maximizes web page

setPageSize

public static void setPageSize(int x,
                               int y)

sets page size

Parameters:: x -; y -

refreshPage
```
public static void refreshPage()
```
reload page

switchIframe
```
public static void switchIframe(EnhancedBy frame)
```
switches frame to frame specified

Parameters:

frame -

switchToDefaultFrame
```
public static void switchToDefaultFrame()
```
switches to default frame

dimissAlert
```
public static String dimissAlert()
```
dismisses alert by selecting ok or cancel return alert message

Parameters:

alert -

acceptAlert
```
public static String acceptAlert()
```
accepts alert by selecting ok or cancel

Parameters:

alert -

getAlertValue
```
public static String getAlertValue()
```
returns alert message value

Returns:

currentWindow
```
public static String currentWindow()
```
return the current window handle

Returns:

switchToNewWindow
```
public static void switchToNewWindow(String defaultWindow)
```
switch to the new opened window

Parameters:

defaultWindow -

CloseAndReturn
```
public static void CloseAndReturn(String defaultWindow)
```
close the window And return to the defaultWindow

Parameters:

defaultWindow -

refreshPageSource

public static void refreshPageSource()

gets page source

verifyTitle

public static void verifyTitle(String appTitle)

verify page title

Parameters:: appTitle -

switchDriver
```
public static void switchDriver(org.openqa.selenium.WebDriver driver)
```
switch webdriver use for switching between different drivers

Parameters:

driver -

switchToNextTab
```
public static void switchToNextTab()
```
switch to next tab

switchToPreviousTab
```
public static void switchToPreviousTab()
```
switch to next tab circles back to initial tab if it reaches the last tab

switchToTab
```
public static void switchToTab(int index)
```
switch to previous tab circle back to the last tab

verifyNumberOfTabs

public static void verifyNumberOfTabs(int tabs)

switch to tab by index

getPageTitle
```
public static String getPageTitle()
```
returns the title of the page

Returns:

getCurrentUrl
```
public static String getCurrentUrl()
```
returns the current url

Returns:

getPageSource
```
public static String getPageSource()
```
gets page source

Returns:

navigateBack
```
public static void navigateBack()
```
navigates back

navigateForward
```
public static void navigateForward()
```
navigate forward

deleteAllCookies
```
public static void deleteAllCookies()
```
delete all cookies

deleteCookieNamed

public static void deleteCookieNamed(String name)

delete cookie named

Parameters:: name -

bringPageToFront
```
public static void bringPageToFront()
```
brings current browser to front

swtichUrl
```
public static void swtichUrl(String url)
```
navigate to a different url

Parameters:

url -

navigateToUrl
```
public static void navigateToUrl(String url)
```
navigate to a different url

Parameters:

url -

getClipboardData
```
public static String getClipboardData()
```
retrieves the clip board data

Returns:

quitCurrentDriver
```
public static void quitCurrentDriver()
```
quits the current web driver

quitDriver

public static void quitDriver(org.openqa.selenium.WebDriver driver)

quit driver

Parameters:: driver -

quitAllCurrentTestDrivers
```
public static void quitAllCurrentTestDrivers()
```
quits all drivers in the current test

isVisibleInViewport
```
public static Boolean isVisibleInViewport(EnhancedBy by,
                                          int index)
```
returns true if the element is visible in the current page only for web applications

Parameters:

by -

Returns:

isVisibleInViewport
```
public static Boolean isVisibleInViewport(EnhancedBy by)
```
returns true if the element is visible in the current page only for web applications

Parameters:

by -

Returns:

getAttribute

public static String getAttribute(EnhancedBy byValue,
                                  String attribute)

gets specified attribute of the element

Parameters:: byValue -; index -; attribute -

isElementContainingClass

public static boolean isElementContainingClass(EnhancedBy by,
                                               String classValue)

returns true if element contains class value

Parameters:: by -; classValue -
Returns:

isAttributeContaining

public static boolean isAttributeContaining(EnhancedBy by,
                                            String attribute,
                                            String value)

returns true if element contains attribute value

Parameters:: by -; classValue -
Returns:

getAttribute

public static String getAttribute(EnhancedBy byValue,
                                  int index,
                                  String attribute)

gets specified attribute of the element based on index

Parameters:: byValue -; index -; attribute -

setAttribute

public static void setAttribute(EnhancedBy by,
                                String attribute,
                                String value)

sets attribute value of an element

Parameters:: by -; attribute -; value -

setAttribute

public static void setAttribute(EnhancedBy by,
                                int index,
                                String attribute,
                                String value)

sets attribute value of an element

Parameters:: by -; index -; attribute -; value -

getElementSize

public static org.openqa.selenium.Dimension getElementSize(EnhancedBy by)

returns element dimension

Parameters:: by -
Returns:

getElementPosition

public static org.openqa.selenium.Point getElementPosition(EnhancedBy by)

get element position on display

Parameters:: by -
Returns:

getElementPosition

public static org.openqa.selenium.Point getElementPosition(EnhancedBy by,
                                                           int index)

get element position on display

Parameters:: by -; index -
Returns:

findElementCoordinates
```
public static int[] findElementCoordinates(EnhancedBy target)
```
returns the center coordinates of the target element

Parameters:

target -

Returns:

findMiddleOfElement
```
public static int[] findMiddleOfElement(EnhancedBy target)
```
returns the center coordinates of the target element

Parameters:

target -

Returns:

waitForElementToLoad
```
public static void waitForElementToLoad(EnhancedBy target)
```
waits for element to be displayed for amount of time specified by 60 seconds

Parameters:

target -

waitForElementToLoad
```
public static boolean waitForElementToLoad(EnhancedBy target,
                                           int time)
```
waits for element to load count() checks if the element is displayed Then gets the count number

Parameters:

target -

time -

waitForFirstElementToLoad

public static boolean waitForFirstElementToLoad(EnhancedBy element1,
                                                EnhancedBy element2,
                                                EnhancedBy element3)

waits for either element to load returns true When first item loads

Parameters:: element1 -; element2 -; time -
Returns:

waitForFirstElementToLoad

public static boolean waitForFirstElementToLoad(EnhancedBy element1,
                                                EnhancedBy element2,
                                                EnhancedBy element3,
                                                int time)

waits for either element to load returns true When first item loads

Parameters:: element1 -; element2 -; time -
Returns:

waitForFirstElementToLoad

public static boolean waitForFirstElementToLoad(EnhancedBy element1,
                                                EnhancedBy element2,
                                                int time)

waits for either element to load returns true When first item loads

Parameters:: element1 -; element2 -; time -
Returns:

waitForFirstElementToLoad

public static boolean waitForFirstElementToLoad(EnhancedBy element1,
                                                EnhancedBy element2)

waits for either element to load returns true When first item loads

Parameters:: element1 -; element2 -; time -
Returns:

mobile_waitAndRefreshForElementToLoad

public static void mobile_waitAndRefreshForElementToLoad(EnhancedBy target,
                                                         int time)

waits for element to load And refreshes the app each time to renew the dom

Parameters:: target -

mobile_waitAndRefreshForElementToLoad
```
public static void mobile_waitAndRefreshForElementToLoad(EnhancedBy target)
```
waits for element to load And refreshes the app each time to renew the dom

Parameters:

target -

waitForElementToLoad
```
public static boolean waitForElementToLoad(EnhancedBy target,
                                           int time,
                                           int count)
```
waits for element to load If mobile device, scrolls down the page until element is visible

Parameters:

target: - element to wait for

time: - max time to wait

count: - minimum count of elements to wait for in list

Returns:

waitForAdditionalElementsToLoad
```
public static void waitForAdditionalElementsToLoad(EnhancedBy target,
                                                   int originalCount)
```
waits for element count to increase from the originalCount Usefull When waiting for a list to expand with additional items

Parameters:

target -

originalCount -

waitForAdditionalElementsToLoad

public static void waitForAdditionalElementsToLoad(EnhancedBy target,
                                                   int originalCount,
                                                   int time)

waits for element count to increase from the originalCount Usefull When waiting for a list to expand with additional items

Parameters:: target -; originalCount -

waitForElementToBeRemoved
```
public static void waitForElementToBeRemoved(EnhancedBy target)
```
waits for element to not be displayed wait for maximum of 60 seconds

Parameters:

target -

waitForElementToBeRemoved

public static boolean waitForElementToBeRemoved(EnhancedBy target,
                                                int time)

waits for element to not be displayed

Parameters:: target -; time - : maximum amount of time in seconds to wait

waitForSeconds
```
public static void waitForSeconds(double seconds)
```
waits for number of seconds

Parameters:

seconds -

waitForPageToLoad
```
public static void waitForPageToLoad()
```
waits for webpage to load

waitForListItemToLoad_Contains

public static void waitForListItemToLoad_Contains(EnhancedBy list,
                                                  String option)

waits for item containing in list to load

Parameters:: list -; option -; time -

waitForTextToLoad

public static void waitForTextToLoad(EnhancedBy target,
                                     String text)

waits for text to be loaded for amount of time specified by 60 seconds

Parameters:: target -

waitForTextToLoad

public static void waitForTextToLoad(EnhancedBy target,
                                     int time,
                                     String text)

make sure only one element And caller needs to take responsibility to have text in the element

Parameters:: target -; time -

waitForElementToBeClickable
```
public static boolean waitForElementToBeClickable(EnhancedBy selector)
```
wait for element to become clickable causes instability with hybrid mobile app

Parameters:

selector -

Returns:

waitForElementToBeClickable

public static boolean waitForElementToBeClickable(EnhancedBy selector,
                                                  int timeInSeconds)

wait for element to become clickable causes instability with hybrid mobile app

Parameters:: selector -
Returns:

waitForClassContain

public boolean waitForClassContain(EnhancedBy target,
                                   int index,
                                   String value)

wait for class to contain

Parameters:: target -; index -; value -
Returns:

waitForClassContain

public boolean waitForClassContain(EnhancedBy target,
                                   int index,
                                   String value,
                                   int time)

wait for class to contain value

Parameters:: target -; index -; value -; time -
Returns:

waitForAnyTextToLoadContaining

public static boolean waitForAnyTextToLoadContaining(EnhancedBy target,
                                                     String... text)

wait for any text strings to become available

Parameters:: target -; time -; text -
Returns:

waitForAnyTextToLoadContaining

public static boolean waitForAnyTextToLoadContaining(EnhancedBy target,
                                                     int time,
                                                     String... text)

wait for any text strings to become available

Parameters:: target -; time -; text -
Returns:

waitForAnyTextToLoad

public static boolean waitForAnyTextToLoad(EnhancedBy target,
                                           String... text)

wait for any text strings to become available

Parameters:: target -; time -; text -
Returns:

waitForAnyTextToLoad

public static boolean waitForAnyTextToLoad(EnhancedBy target,
                                           int time,
                                           String... text)

wait for any text strings to become available

Parameters:: target -; time -; text -
Returns:

start
```
public static StopWatchHelper start()
```
StopWatchHelper watch = Helper.start(); do something long passedTimeInMs = watch.time(); long passedTimeInSeconds = watch.time(TimeUnit.SECONDS);

Returns:

generateRandomString
```
public static String generateRandomString(int len)
```
generates random string of length len

Parameters:

len -

Returns:

generateRandomInteger
```
public static String generateRandomInteger(int len)
```
generates random int of length len

Parameters:

len -

Returns:

generateRandomNumber
```
public static int generateRandomNumber(int min,
                                       int max)
```
generates random number between two numbers, min, max

Parameters:

min -

max -

Returns:

highLightWebElement

public static void highLightWebElement(EnhancedBy by,
                                       int index)

highlights the web element use on clicks and send key elements

Parameters:: by -; index -

isMac
```
public static boolean isMac()
```
returns true if OS is mac

Returns:

isWindows
```
public static boolean isWindows()
```
returns true if OS is windows

Returns:

isUnix
```
public static boolean isUnix()
```
returns true if OS is unix or linux

Returns:

isUUID
```
public static boolean isUUID(String value)
```
is the string value UDID

Parameters:

value -

Returns:

isBoolean
```
public static boolean isBoolean(String value)
```
returns if string is boolean

Parameters:

value -

Returns:

isNumeric
```
public static boolean isNumeric(String value)
```
return if string is a number

Parameters:

str -

Returns:

executeJs

public static Object executeJs(String script,
                               Object... args)

execute javascript

Parameters:: script -

executeJsWithListReturn

public static List<String> executeJsWithListReturn(String script,
                                                   Object... args)

execute javascript

Parameters:: script -

executeJsWithStringReturn

public static String executeJsWithStringReturn(String script,
                                               Object... args)

execute javascript

Parameters:: script -

stringNormalize
```
public static String stringNormalize(String value)
```
normalizes string removes space, new line chars

Parameters:

value -

Returns:

stringRemoveLines
```
public static String stringRemoveLines(String value)
```
normalizes string removes space, new line chars

Parameters:

value -

Returns:

killWindowsProcess
```
public static void killWindowsProcess(String serviceName)
```
returns kills the process if running

Parameters:

serviceName -

Throws:

Exception

killMacProcess
```
public static void killMacProcess(String serviceName)
```
returns kills the process if running

Parameters:

serviceName -

Throws:

Exception

createFileFromPath
```
public static void createFileFromPath(String absolutePath)
```
create directories and files based on absolute path

Parameters:

path -

writeFile

public static void writeFile(String value,
                             String path,
                             String filename,
                             String type)

Create file with path starting from root directory (where pom.xml is) and write to it. eg. writeFile("something","", "myFile", "txt");

Parameters:: value - value in file; path - path from root; filename - name of the file; type - type of file

writeFile

public static void writeFile(String value,
                             String absolutePath)

Create file (where pom.xml is) and write to it

Parameters:: value -; absolutePath -

deleteFile

public static void deleteFile(String absolutePath)

delete file

Parameters:: absolutePath -

appendToFile

public static void appendToFile(String value,
                                String absolutePath)

appends to existing file

Parameters:: value -; absolutePath -

appendToFile

public static void appendToFile(String value,
                                String directory,
                                String filename,
                                String type)

appends to existing file

Parameters:: value -; directory -; filename -; type -

executeCommand
```
public static ArrayList<String> executeCommand(String command)
```
run command and return results as array list will run bash on linux or mac will run batch command on windows

Parameters:

command -

Returns:

Throws:

IOException

executeCommandFromFile
```
public static ArrayList<String> executeCommandFromFile(String filePath)
```
run script file and return results as array list will run bash on linux or mac will run batch command on windows

Parameters:

filePath - path from the root directory ( where pom.xml is )

Returns:

the results as arraylist

copyDirectory

public static void copyDirectory(String dirFrom,
                                 String dirTo)

Copies directory And all content from dirFrom to dirTo overwrites the content

Parameters:: dirFrom -; dirTo -

zipFolder

public static ZipOutputStream zipFolder(String srcFolder,
                                        String destZipFile)

zip folder

Parameters:: srcFolder -; destZipFile -
Returns:
Throws:: Exception

createZip

public static ZipOutputStream createZip(String destZipFile)

addFileToZip

public static void addFileToZip(String path,
                                String srcFile,
                                ZipOutputStream zip)

getAllValuesStartringWith

public static List<String> getAllValuesStartringWith(String source,
                                                     String value)

gets a list of string from 'source' starting with 'value'

Parameters:: source -; value -
Returns:

getValueFromPattern

public static String getValueFromPattern(String str,
                                         String pattern)

Parameters:: str -; pattern - regular expression pattern
Returns:

getValuesFromPattern

public static List<String> getValuesFromPattern(String str,
                                                String pattern)

Parameters:: str -; pattern - regular expression pattern
Returns:

getRootDir
```
public static String getRootDir()
```
get current directory

Returns:

getFileListByType

public static ArrayList<File> getFileListByType(String directoryPath,
                                                String type)

gets the list of files

Returns:

getFileList
```
public static ArrayList<File> getFileList(String directoryPath)
```
returns the list of files in directory

Parameters:

directoryPath -

Returns:

getFileListWithSubfolders

public static List<File> getFileListWithSubfolders(String directoryName,
                                                   String type,
                                                   List<File> files)

gets list of files including from sub folder based on type. eg. ".csv"

Returns:

getFileContent
```
protected static String getFileContent(String absolutePath)
```
gets file content as String

Parameters:

absolutePath -

Returns:

captureExtentReportScreenshot
```
public static void captureExtentReportScreenshot()
```
captures screenshot And attaches to extent test report

Parameters:

description -

hoverBy

public static void hoverBy(EnhancedBy by)

hover over element

Parameters:: by -

hoverBy

public static void hoverBy(EnhancedBy by,
                           int index)

hover over element

Parameters:: by -

inputTextByAction

public void inputTextByAction(EnhancedBy by,
                              String text)

doubleClickBy

public static void doubleClickBy(EnhancedBy by)

hoverPoints

public static void hoverPoints(int x,
                               int y)

Hover on the x,y points

Parameters:: x -; y -

moveToElement

public static void moveToElement(EnhancedBy target,
                                 int index)

move to element by using action

Parameters:: target -; index -

moveToElement

public static void moveToElement(EnhancedBy target,
                                 int index,
                                 int xOffset,
                                 int yOffset)

move to element by using action

Parameters:: target -; index -

sendMail
```
public static void sendMail(EmailObject email)
```
sends email to recipient using email object

Throws:

Exception

handleDifferentUser
```
public static void handleDifferentUser()
```
if single signin enabled, And new test user is different form previous, shutdown webdriver And restart

Parameters:

newUserName -

Throws:

Exception

localize
```
public static String localize(String key)
```
gets local language from json file specified in properties file

Parameters:

key -

Returns:

localizationLoadJson
```
public static void localizationLoadJson(String fileName)
```
loads localization map from a json file to the test object data

Parameters:

fileName -

localizationSetupCsv
```
public static void localizationSetupCsv(String language)
```
sets the language for csv localization file

Parameters:

language -

runApiContaining
```
public static void runApiContaining(String identifier,
                                    String prefix,
                                    String getApi,
                                    String targetApiId,
                                    String variable,
                                    String targerApi)
                             throws org.json.JSONException
```
runApiContaining("name", "zzz_","getCompanies", "id","companyId","deleteCompany") get all companies with name containing zzz_, Then gets id of these companies, stores them in companyId variable And calls deleteCompany

Parameters:

getApi: - api to search for identifier. eg. name containing "zzz"

prefix: - value containing in getApi. eg. name containing "zzz"

identifier: - api to call to get all values. eg. getCompanies

targetApiId: - id used to call target api.eg. id for deleteCompany api

variable: - variable the id is stored in csv keyword file. eg companyId

targerApi: - api to call. eg. deleteCompany

Throws:

org.json.JSONException

runApiEquals
```
public static void runApiEquals(String identifier,
                                String value,
                                String getApi,
                                String targetApiId,
                                String variable,
                                String targerApi)
                         throws org.json.JSONException
```
runApiEquals("name", "test123","getCompanies", "id","companyId","deleteCompany") get all companies with name equals test123, Then gets id of these companies And calls delete with id

Parameters:

getApi: - api to search for identifier. eg. name equals "test123"

value: - value containing in getApi. eg. name equals "test123"

identifier: - api to call to get all values. eg. getCompanies

targetApiId: - id used to call target api.eg. id for deleteCompany api

variable: - variable the id is stored in csv keyword file. eg companyId

targerApi: - api to call. eg. deleteCompany

Throws:

org.json.JSONException

Class Helper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

click

wait

mobile

list

page

form

image

date

csv

loginbuilder

verify

clickJs

clickAction

Constructor Detail

Helper

Method Detail

excel_setExcelFile

excel_getColumData

excel_getCellData

excel_setCellData

excel_setCellData

assertTrue

assertFalse

assertEquals

assertEquals

assertEquals

assertContains

softAssertTrue

softAssertEqual

softAssertEqual

findElements

findElements

findElements

byCss

byId

byXpath

byAccessibility

clickAndExpect

clickAndExpect

clickAndExpectContainsByText

clickAndExpect

clickAndExpect

clickAndExpect

clickAndExpect

clickAndNotExpect

clickAndWait

clickAndWait

clickAndNotExpect

clickElementLocationBy

clickPoints

clickPointsAndExpect

doubleClickPoints

doubleClick

rightClick

clickElementContinsByText

clickAndHold

clickAndHold

dragAndDrop

dragAndDrop

verifyElementIsDisplayed

isDisplayed

isPresent

isElementContainingText

verifyElementContainingText

verifyTextDisplayed

isTextDisplayed

verifyElementIsNotDisplayed

verifyElementText

verifyElementCount

verifyAnyTextContaining

verifyAnyText

setField

setField

setFieldByAction