@CompileStatic class MobileBuiltInKeywords extends BuiltinKeywords
Constructor and description |
---|
MobileBuiltInKeywords
() |
Type Params | Return Type | Name and description |
---|---|---|
|
static void |
checkElement(TestObject to, int timeout, FailureHandling flowControl) Check a check-box mobile element (android.widget.CheckBox for Android, UIASwitch for iOS) |
|
static void |
checkElement(TestObject to, int timeout) Check a check-box mobile element (android.widget.CheckBox for Android, UIASwitch for iOS) |
|
static void |
clearText(TestObject to, int timeout, FailureHandling flowControl) Clear text of a mobile element |
|
static void |
clearText(TestObject to, int timeout) Clear text of a mobile element |
|
static void |
closeApplication(FailureHandling flowControl) Close the current running application |
|
static void |
closeApplication() Close the current running application |
|
static void |
closeNotifications(FailureHandling flowControl) Simulate closing notification action on mobile devices |
|
static void |
closeNotifications() Simulate closing notification action on mobile devices |
|
static void |
doubleTap(TestObject to, int timeout, FailureHandling flowControl) Performs a double tap action on a mobile element. |
|
static void |
doubleTap(TestObject to, int timeout) Performs a double tap action on a mobile element. |
|
static void |
dragAndDrop(TestObject fromObject, TestObject toObject, int timeout, FailureHandling flowControl) Drag and drop an element into another element |
|
static void |
dragAndDrop(TestObject fromObject, TestObject toObject, int timeout) Drag and drop an element into another element |
|
static void |
executeMobileCommand(String command, Map args, FailureHandling flowControl) Executes a native mobile command |
|
static Object |
executeMobileCommand(String command, Map args) Executes a native mobile command |
|
static WebElement |
findImageElement(String imageFilePath, FailureHandling flowControl) Finds the mobile element that is recognized by the given image. |
|
static WebElement |
findImageElement(String imageFilePath) Finds the mobile element that is recognized by the given image. |
|
static List |
findImageElements(String imageFilePath, FailureHandling flowControl) Finds all mobile elements that are recognized by the given image. |
|
static List |
findImageElements(String imageFilePath) Finds all mobile elements that are recognized by the given image. |
|
static String |
getAttribute(TestObject to, String name, int timeout, FailureHandling flowControl) Get a specific attribute of a mobile element |
|
static String |
getAttribute(TestObject to, String name, int timeout) Get a specific attribute of a mobile element |
|
static String |
getCurrentOrientation(FailureHandling flowControl) Get current screen orientation of the device |
|
static String |
getCurrentOrientation() Get current screen orientation of the device |
|
static int |
getDeviceHeight(FailureHandling flowControl) Get device's physical height |
|
static int |
getDeviceHeight() Get device's physical height |
|
static String |
getDeviceManufacturer(FailureHandling flowControl) Get the manufacturer of the current active mobile device |
|
static String |
getDeviceManufacturer() Get the manufacturer of the current active mobile device |
|
static String |
getDeviceOS(FailureHandling flowControl) Get the device os of the current active mobile device |
|
static String |
getDeviceOS() Get the device os of the current active mobile device |
|
static String |
getDeviceOSVersion(FailureHandling flowControl) Get the device os version of the current active mobile device |
|
static String |
getDeviceOSVersion() Get the device os version of the current active mobile device |
|
static int |
getDeviceWidth(FailureHandling flowControl) Get device's physical width |
|
static int |
getDeviceWidth() Get device's physical width |
|
static int |
getElementHeight(TestObject to, int timeout, FailureHandling flowControl) Get the height of mobile element |
|
static int |
getElementHeight(TestObject to, int timeout) Get the height of mobile element |
|
static int |
getElementLeftPosition(TestObject to, int timeout, FailureHandling flowControl) Get the left position of mobile element |
|
static int |
getElementLeftPosition(TestObject to, int timeout) Get the left position of mobile element |
|
static int |
getElementTopPosition(TestObject to, int timeout, FailureHandling flowControl) Get the top position of mobile element |
|
static int |
getElementTopPosition(TestObject to, int timeout) Get the top position of mobile element |
|
static int |
getElementWidth(TestObject to, int timeout, FailureHandling flowControl) Get the width of mobile element |
|
static int |
getElementWidth(TestObject to, int timeout) Get the width of mobile element |
|
static String |
getText(TestObject to, int timeout, FailureHandling flowControl) Get text of a mobile element |
|
static String |
getText(TestObject to, int timeout) Get text of a mobile element |
|
static void |
hideKeyboard(FailureHandling flowControl) Hide the keyboard if it is showing |
|
static void |
hideKeyboard() Hide the keyboard if it is showing |
|
static void |
longPress(TestObject to, int timeout, FailureHandling flowControl) Performs a long-press action on a mobile element. |
|
static void |
longPress(TestObject to, int timeout) Performs a long-press action on a mobile element. |
|
static void |
openNotifications(FailureHandling flowControl) Simulate opening notification action on mobile devices |
|
static void |
openNotifications() Simulate opening notification action on mobile devices |
|
static void |
performTouchID(boolean match, FailureHandling flowControl) Simulate a Touch ID event on iOS simulators. |
|
static void |
performTouchID(boolean match) Simulate a Touch ID event on iOS simulators. |
|
static void |
pinchToZoomInAtPosition(Number x, Number y, Number offset, FailureHandling flowControl) Pinch to zoom in at a specific position on the screen of the mobile device |
|
static void |
pinchToZoomInAtPosition(Number x, Number y, Number offset) Pinch to zoom in at a specific position on the screen of the mobile device |
|
static void |
pinchToZoomOutAtPosition(Number x, Number y, Number offset, FailureHandling flowControl) Pinch to zoom out at a specific position on the screen of the mobile device |
|
static void |
pinchToZoomOutAtPosition(Number x, Number y, Number offset) Pinch to zoom out at a specific position on the screen of the mobile device |
|
static void |
pressBack(FailureHandling flowControl) Simulate pressing back button on a mobile device (Android only) |
|
static void |
pressBack() Simulate pressing back button on a mobile device (Android only) |
|
static void |
pressHome(FailureHandling flowControl) Simulate pressing home button on mobile devices (Android only) |
|
static void |
pressHome() Simulate pressing home button on mobile devices (Android only) |
|
static void |
runIOSAppInBackgroundAndWait(int seconds, FailureHandling flowControl) Running the active application in background |
|
static void |
runIOSAppInBackgroundAndWait(int seconds) Running the active application in background |
|
static void |
scrollToText(String text, FailureHandling flowControl) Scroll to an element which contains the given text. |
|
static void |
scrollToText(String text) Scroll to an element which contains the given text. |
|
static void |
selectListItemByIndex(TestObject to, int index, int timeout, FailureHandling flowControl) Select item of list view control by its index. |
|
static void |
selectListItemByIndex(TestObject to, int index, int timeout) Select item of list view control by its index. |
|
static void |
selectListItemByLabel(TestObject to, String label, int timeout, FailureHandling flowControl) Select item of list view control by its label. |
|
static void |
selectListItemByLabel(TestObject to, String label, int timeout) Select item of list view control by its label. |
|
static void |
sendKeys(TestObject to, String strokeKeys, FailureHandling flowControl) Simulates keystroke events on the specified element, as though you typed the value key-by-key. |
|
static void |
sendKeys(TestObject to, String strokeKeys) Simulates keystroke events on the specified element, as though you typed the value key-by-key. |
|
static void |
setEncryptedText(TestObject to, String encryptedText, int timeout, FailureHandling flowControl) Set encrypted text into an input field. |
|
static void |
setEncryptedText(TestObject to, String encryptedText, int timeout) Set encrypted text into an input field. |
|
static void |
setSliderValue(TestObject to, Number percent, int timeOut, FailureHandling flowControl) Set the value for Slider control (android.widget.SeekBar for Android, UIASlider for iOS) at specific percentage |
|
static void |
setSliderValue(TestObject to, Number percent, int timeOut) Set the value for Slider control (android.widget.SeekBar for Android, UIASlider for iOS) at specific percentage |
|
static void |
setText(TestObject to, String text, int timeout, FailureHandling flowControl) Set text to a mobile element |
|
static void |
setText(TestObject to, String text, int timeout) Set text to a mobile element |
|
static void |
startApplication(String appFile, boolean uninstallAfterCloseApp, FailureHandling flowControl) Start up an application |
|
static void |
startApplication(String appFile, boolean uninstallAfterCloseApp) Start up an application |
|
static void |
startExistingApplication(String appId) Starts Appium driver and activate an installed application by it's given application ID. |
|
static void |
startExistingApplication(String appId, FailureHandling flowControl) Starts Appium driver and activate an installed application by it's given application ID. |
|
static void |
swipe(int startX, int startY, int endX, int endY, FailureHandling flowControl) Simulate swiping fingers on the mobile device |
|
static void |
swipe(int startX, int startY, int endX, int endY) Simulate swiping fingers on the mobile device |
|
static boolean |
switchToLandscape(FailureHandling flowControl) Switch the current device's mode to landscape mode |
|
static boolean |
switchToLandscape() Switch the current device's mode to landscape mode |
|
static void |
switchToNative(FailureHandling flowControl) Switch the current device driver to native context |
|
static void |
switchToNative() Switch the current device driver to native context |
|
static boolean |
switchToPortrait(FailureHandling flowControl) Switch the current device's mode to portrait mode |
|
static boolean |
switchToPortrait() Switch the current device's mode to portrait mode |
|
static void |
switchToWebView(FailureHandling flowControl) Switch the current device driver to web view context |
|
static void |
switchToWebView() Switch the current device driver to web view context |
|
static String |
takeAreaScreenshot(String fileName, Rectangle rect, List<TestObject> ignoredElements, Color hidingColor, FailureHandling flowControl) Take a screenshot of a specific area. |
|
static String |
takeAreaScreenshot(String fileName, Rectangle rect, List<TestObject> ignoredElements, Color hidingColor) Take a screenshot of a specific area. |
|
static String |
takeAreaScreenshot(String fileName, Rectangle rect, List<TestObject> ignoredElements, FailureHandling flowControl) Take a screenshot of a specific area. |
|
static String |
takeAreaScreenshot(String fileName, Rectangle rect, List<TestObject> ignoredElements) Take a screenshot of a specific area. |
|
static String |
takeAreaScreenshot(String fileName, Rectangle rect, FailureHandling flowControl) |
|
static String |
takeAreaScreenshot(String fileName, Rectangle rect) Take a screenshot of a specific area. |
|
static String |
takeAreaScreenshot(Rectangle rect, FailureHandling flowControl) Take a screenshot of a specific area. |
|
static String |
takeAreaScreenshot(Rectangle rect) Take a screenshot of a specific area. |
|
static String |
takeAreaScreenshotAsCheckpoint(String checkpointName, Rectangle rect, List<TestObject> ignoredElements, Color hidingColor, FailureHandling flowControl) Take a screenshot of a specific area to send to TestOps Vision. |
|
static String |
takeAreaScreenshotAsCheckpoint(String checkpointName, Rectangle rect, List<TestObject> ignoredElements, Color hidingColor) Take a screenshot of a specific area to send to TestOps Vision. |
|
static String |
takeAreaScreenshotAsCheckpoint(String checkpointName, Rectangle rect, List<TestObject> ignoredElements, FailureHandling flowControl) Take a screenshot of a specific area to send to TestOps Vision. |
|
static String |
takeAreaScreenshotAsCheckpoint(String checkpointName, Rectangle rect, List<TestObject> ignoredElements) Take a screenshot of a specific area to send to TestOps Vision. |
|
static String |
takeAreaScreenshotAsCheckpoint(String checkpointName, Rectangle rect, FailureHandling flowControl) Take a screenshot of a specific area to send to TestOps Vision. |
|
static String |
takeAreaScreenshotAsCheckpoint(String checkpointName, Rectangle rect) Take a screenshot of a specific area to send to TestOps Vision. |
|
static String |
takeElementScreenshot(String fileName, TestObject to, List<TestObject> ignoredElements, Color hidingColor, FailureHandling flowControl) Take a screenshot of a UI element. |
|
static String |
takeElementScreenshot(String fileName, TestObject to, List<TestObject> ignoredElements, Color hidingColor) Take a screenshot of a UI element. |
|
static String |
takeElementScreenshot(String fileName, TestObject to, List<TestObject> ignoredElements, FailureHandling flowControl) Take a screenshot of a UI element. |
|
static String |
takeElementScreenshot(String fileName, TestObject to, List<TestObject> ignoredElements) Take a screenshot of a UI element. |
|
static String |
takeElementScreenshot(String fileName, TestObject to, FailureHandling flowControl) Take a screenshot of a UI element. |
|
static String |
takeElementScreenshot(String fileName, TestObject to) Take a screenshot of a UI element. |
|
static String |
takeElementScreenshot(TestObject to, FailureHandling flowControl) Take a screenshot of a UI element. |
|
static String |
takeElementScreenshot(TestObject to) Take a screenshot of a UI element. |
|
static String |
takeElementScreenshotAsCheckpoint(String checkpointName, TestObject to, List<TestObject> ignoredElements, Color hidingColor, FailureHandling flowControl) Take a screenshot of a UI element to send to TestOps Vision. |
|
static String |
takeElementScreenshotAsCheckpoint(String checkpointName, TestObject to, List<TestObject> ignoredElements, Color hidingColor) Take a screenshot of a UI element to send to TestOps Vision. |
|
static String |
takeElementScreenshotAsCheckpoint(String checkpointName, TestObject to, List<TestObject> ignoredElements, FailureHandling flowControl) Take a screenshot of a UI element to send to TestOps Vision. |
|
static String |
takeElementScreenshotAsCheckpoint(String checkpointName, TestObject to, List<TestObject> ignoredElements) Take a screenshot of a UI element to send to TestOps Vision. |
|
static String |
takeElementScreenshotAsCheckpoint(String checkpointName, TestObject to, FailureHandling flowControl) Take a screenshot of a UI element to send to TestOps Vision. |
|
static String |
takeElementScreenshotAsCheckpoint(String checkpointName, TestObject to) Take a screenshot of a UI element to send to TestOps Vision. |
|
static String |
takeScreenshot(String fileName, FailureHandling flowControl) Taking screenshot of the mobile device screen |
|
static String |
takeScreenshot(String fileName) Taking screenshot of the mobile device screen |
|
static String |
takeScreenshot(FailureHandling flowControl) Taking screenshot of the mobile device screen |
|
static String |
takeScreenshot() Taking screenshot of the mobile device screen |
|
static String |
takeScreenshotAsCheckpoint(String checkpointName, List<TestObject> ignoredElements, Color hidingColor, FailureHandling flowControl) Take a screenshot of the current application to send to TestOps Vision. |
|
static String |
takeScreenshotAsCheckpoint(String checkpointName, List<TestObject> ignoredElements, Color hidingColor) Take a screenshot of the current application to send to TestOps Vision. |
|
static String |
takeScreenshotAsCheckpoint(String checkpointName, List<TestObject> ignoredElements, FailureHandling flowControl) Take a screenshot of the current application to send to TestOps Vision. |
|
static String |
takeScreenshotAsCheckpoint(String checkpointName, List<TestObject> ignoredElements) Take a screenshot of the current application to send to TestOps Vision. |
|
static String |
takeScreenshotAsCheckpoint(String checkpointName, FailureHandling flowControl) Take a screenshot of the current application to send to TestOps Vision. |
|
static String |
takeScreenshotAsCheckpoint(String checkpointName) Take a screenshot of the current application to send to TestOps Vision. |
|
static void |
tap(TestObject to, int timeout, FailureHandling flowControl) Tap on an mobile element |
|
static void |
tap(TestObject to, int timeout) Tap on an mobile element |
|
static void |
tapAndHold(TestObject to, Number duration, int timeout, FailureHandling flowControl) Tap and hold on a mobile element for a duration |
|
static void |
tapAndHold(TestObject to, Number duration, int timeout) Tap and hold on a mobile element for a duration |
|
static void |
tapAndHoldAtPosition(Number x, Number y, Number duration, FailureHandling flowControl) Tap and hold at a specific position on the screen of the mobile device |
|
static void |
tapAndHoldAtPosition(Number x, Number y, Number duration) Tap and hold at a specific position on the screen of the mobile device |
|
static void |
tapAtPosition(Number x, Number y, FailureHandling flowControl) Tap at a specific position on the screen of the mobile device |
|
static void |
tapAtPosition(Number x, Number y) Tap at a specific position on the screen of the mobile device |
|
static void |
tapOnImage(String imageFilePath, FailureHandling flowControl) Finds the webElement that is recognized by the given image then taps on the found element's location. |
|
static void |
tapOnImage(String imageFilePath) Finds the mobile element that is recognized by the given image and taps on the found element's location. |
|
static void |
toggleAirplaneMode(String mode, FailureHandling flowControl) Simulate toggling airplane mode on mobile devices |
|
static void |
toggleAirplaneMode(String mode) Simulate toggling airplane mode on mobile devices |
|
static void |
toggleWifi(String mode, FailureHandling flowControl) Simulate toggling Wifi on/off on mobile devices. |
|
static void |
toggleWifi(String mode) Simulate toggling Wifi on/off on mobile devices. |
|
static void |
uncheckElement(TestObject to, int timeout, FailureHandling flowControl) Un-check a check-box mobile element (android.widget.CheckBox for Android, UIASwitch for iOS) |
|
static void |
uncheckElement(TestObject to, int timeout) Un-check a check-box mobile element (android.widget.CheckBox for Android, UIASwitch for iOS) |
|
static void |
unlockScreen(FailureHandling flowControl) Unlock device screen |
|
static void |
unlockScreen() Unlock device screen |
|
static void |
useFingerprint(int fingerprintId, FailureHandling flowControl) Simulate a fingerprint touch event on Android emulators. |
|
static void |
useFingerprint(int fingerprintId) Simulate a fingerprint touch event on Android emulators. |
|
static boolean |
verifyElementAttributeValue(TestObject to, String attributeName, String attributeValue, int timeout, FailureHandling flowControl) Verify if the element has an attribute with the specific name and value |
|
static boolean |
verifyElementAttributeValue(TestObject to, String attributeName, String attributeValue, int timeout) Verify if the element has an attribute with the specific name and value |
|
static boolean |
verifyElementChecked(TestObject to, int timeout, FailureHandling flowControl) Verify if a mobile element is checked |
|
static boolean |
verifyElementChecked(TestObject to, int timeout) Verify if a mobile element is checked |
|
static boolean |
verifyElementExist(TestObject to, int timeout, FailureHandling flowControl) Verify if a mobile element is presented |
|
static boolean |
verifyElementExist(TestObject to, int timeout) Verify if a mobile element is presented |
|
static boolean |
verifyElementHasAttribute(TestObject to, String attributeName, int timeout, FailureHandling flowControl) Verify if the element has an attribute with the specific name |
|
static boolean |
verifyElementHasAttribute(TestObject to, String attributeName, int timeout) Verify if the element has an attribute with the specific name |
|
static boolean |
verifyElementNotChecked(TestObject to, int timeout, FailureHandling flowControl) Verify if a mobile element is not checked |
|
static boolean |
verifyElementNotChecked(TestObject to, int timeout) Verify if a mobile element is not checked |
|
static boolean |
verifyElementNotExist(TestObject to, int timeout, FailureHandling flowControl) Verify if a mobile element is NOT presented |
|
static boolean |
verifyElementNotExist(TestObject to, int timeout) Verify if a mobile element is NOT presented |
|
static boolean |
verifyElementNotHasAttribute(TestObject to, String attributeName, int timeout, FailureHandling flowControl) Verify if the element doesn't have an attribute with the specific name |
|
static boolean |
verifyElementNotHasAttribute(TestObject to, String attributeName, int timeout) Verify if the element doesn't have an attribute with the specific name |
|
static boolean |
verifyElementNotVisible(TestObject to, int timeout, FailureHandling flowControl) Verify if a mobile element is NOT visible |
|
static boolean |
verifyElementNotVisible(TestObject to, int timeout) Verify if a mobile element is NOT visible |
|
static boolean |
verifyElementText(TestObject to, String expectedText, FailureHandling flowControl) Verify text of an element. |
|
static boolean |
verifyElementText(TestObject to, String expectedText) Verify text of an element. |
|
static boolean |
verifyElementVisible(TestObject to, int timeout, FailureHandling flowControl) Verify if a mobile element is visible |
|
static boolean |
verifyElementVisible(TestObject to, int timeout) Verify if a mobile element is visible |
|
static boolean |
verifyImagePresent(String imageFilePath, FailureHandling flowControl) Verifies the given image that presents on the device screen or not. |
|
static boolean |
verifyImagePresent(String imageFilePath) Verifies the given image that presents on the device screen or not. |
|
static boolean |
verifyIsLandscape(FailureHandling flowControl) Verify if current device is in landscape mode |
|
static boolean |
verifyIsLandscape() Verify if current device is in landscape mode |
|
static boolean |
verifyIsPortrait(FailureHandling flowControl) Verify if current device is in portrait mode |
|
static boolean |
verifyIsPortrait() Verify if current device is in portrait mode |
|
static boolean |
waitForElementAttributeValue(TestObject to, String attributeName, String attributeValue, int timeout, FailureHandling flowControl) Wait until the given web element has an attribute with the specific name and value |
|
static boolean |
waitForElementAttributeValue(TestObject to, String attributeName, String attributeValue, int timeout) Wait until the given web element has an attribute with the specific name and value |
|
static boolean |
waitForElementHasAttribute(TestObject to, String attributeName, int timeout, FailureHandling flowControl) Wait until the given web element has an attribute with the specific name |
|
static boolean |
waitForElementHasAttribute(TestObject to, String attributeName, int timeout) Wait until the given web element has an attribute with the specific name |
|
static boolean |
waitForElementNotHasAttribute(TestObject to, String attributeName, int timeout, FailureHandling flowControl) Wait until the given web element doesn't have an attribute with the specific name |
|
static boolean |
waitForElementNotHasAttribute(TestObject to, String attributeName, int timeout) Wait until the given web element doesn't have an attribute with the specific name |
|
static boolean |
waitForElementNotPresent(TestObject to, int timeout, FailureHandling flowControl) Wait for a mobile element to NOT present (disappear) within the given time in second unit |
|
static boolean |
waitForElementNotPresent(TestObject to, int timeout) Wait for a mobile element to NOT present (disappear) within the given time in second unit |
|
static boolean |
waitForElementPresent(TestObject to, int timeout, FailureHandling flowControl) Wait for a mobile element to present |
|
static boolean |
waitForElementPresent(TestObject to, int timeout) Wait for a mobile element to present |
Methods inherited from class | Name |
---|---|
class BuiltinKeywords |
callTestCase, callTestCase, comment, concatenate, concatenate, delay, delay, verifyCheckpoint, verifyCheckpoint, verifyEqual, verifyEqual, verifyGreaterThan, verifyGreaterThan, verifyGreaterThanOrEqual, verifyGreaterThanOrEqual, verifyLessThan, verifyLessThan, verifyLessThanOrEqual, verifyLessThanOrEqual, verifyMatch, verifyMatch, verifyNotEqual, verifyNotEqual, verifyNotMatch, verifyNotMatch |
Check a check-box mobile element (android.widget.CheckBox for Android, UIASwitch for iOS)
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultCheck a check-box mobile element (android.widget.CheckBox for Android, UIASwitch for iOS)
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultClear text of a mobile element
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultClear text of a mobile element
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultClose the current running application
Close the current running application
Simulate closing notification action on mobile devices
Simulate closing notification action on mobile devices
Performs a double tap action on a mobile element.
to
- Represent a mobile element.timeout
- System will wait at most timeout (seconds) to return result.flowControl
- Optional parameter: Used to control the step if the step failed.
Performs a double tap action on a mobile element.
to
- Represent a mobile element.timeout
- System will wait at most timeout (seconds) to return result.Drag and drop an element into another element
fromObject
- represent the drag-able mobile elementtoObject
- represent the drop-able mobile elementtimeout
- system will wait at most timeout (seconds) to return resultDrag and drop an element into another element
fromObject
- represent the drag-able mobile elementtoObject
- represent the drop-able mobile elementtimeout
- system will wait at most timeout (seconds) to return result Executes a native mobile command
Sample of usage:
Mobile.executeMobileCommand("mobile:scroll", ImmutableMap.of("direction", "down"))
command
- Mobile command nameargs
- The provided arguments that the command requires forflowControl
- Optional parameter: Used to control the step if the step failed.
Executes a native mobile command
Sample of usage:
Mobile.executeMobileCommand("mobile:scroll", ImmutableMap.of("direction", "down"))
command
- Mobile command nameargs
- The provided arguments that the command requires forFinds the mobile element that is recognized by the given image.
imageFilePath
- Absolute path of the image.flowControl
- Optional parameter: Controls the execution flow if the step failed.
Finds the mobile element that is recognized by the given image.
imageFilePath
- Absolute path of the image.Finds all mobile elements that are recognized by the given image.
imageFilePath
- Absolute path of the image.flowControl
- Optional parameter: Controls the execution flow if the step failed.
Finds all mobile elements that are recognized by the given image.
imageFilePath
- Absolute path of the image.Get a specific attribute of a mobile element
to
- represent a mobile elementname
- name of the attribute to gettimeout
- system will wait at most timeout (seconds) to return resultGet a specific attribute of a mobile element
to
- represent a mobile elementname
- name of the attribute to gettimeout
- system will wait at most timeout (seconds) to return resultGet current screen orientation of the device
Get current screen orientation of the device
Get device's physical height
Get device's physical height
Get the manufacturer of the current active mobile device
Get the manufacturer of the current active mobile device
Get the device os of the current active mobile device
Get the device os of the current active mobile device
Get the device os version of the current active mobile device
Get the device os version of the current active mobile device
Get device's physical width
Get device's physical width
Get the height of mobile element
to
-
represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultGet the height of mobile element
to
-
represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultGet the left position of mobile element
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultGet the left position of mobile element
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultGet the top position of mobile element
to
- mobile element objectGet the top position of mobile element
to
- mobile element objectGet the width of mobile element
to
-
represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultGet the width of mobile element
to
-
represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultGet text of a mobile element
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultGet text of a mobile element
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultHide the keyboard if it is showing
Hide the keyboard if it is showing
Performs a long-press action on a mobile element.
to
- Represent a mobile element.timeout
- System will wait at most timeout (seconds) to return result.flowControl
- Optional parameter: Used to control the step if the step failed.
Performs a long-press action on a mobile element.
to
- Represent a mobile element.timeout
- System will wait at most timeout (seconds) to return result.Simulate opening notification action on mobile devices
Simulate opening notification action on mobile devices
Simulate a Touch ID event on iOS simulators. To enable this keyword, Touch ID on the simulator must be enrolled.
match
- (Boolean)
Simulate a successful touch (true) or a failed touch (false).flowControl
- (FailureHandling)
Optional parameter: Used to control the step if the step failed.
Simulate a Touch ID event on iOS simulators. To enable this keyword, Touch ID on the simulator must be enrolled.
match
- (Boolean)
Simulate a successful touch (true) or a failed touch (false).Pinch to zoom in at a specific position on the screen of the mobile device
x
- x positiony
- y positionoffset
- the offset length to pinchPinch to zoom in at a specific position on the screen of the mobile device
x
- x positiony
- y positionoffset
- the offset length to pinchPinch to zoom out at a specific position on the screen of the mobile device
x
- x positiony
- y positionoffset
- the offset length to pinchPinch to zoom out at a specific position on the screen of the mobile device
x
- x positiony
- y positionoffset
- the offset length to pinchSimulate pressing back button on a mobile device (Android only)
Simulate pressing back button on a mobile device (Android only)
Simulate pressing home button on mobile devices (Android only)
Simulate pressing home button on mobile devices (Android only)
Running the active application in background
seconds
- amounts of time (in seconds) for the application to run in backgroundRunning the active application in background
seconds
- amounts of time (in seconds) for the application to run in backgroundScroll to an element which contains the given text.
text
- : text of an element to scroll toScroll to an element which contains the given text.
text
- : text of an element to scroll toSelect item of list view control by its index. Have not implemented for Android because its list view is async loaded
to
-
represent a mobile elementindex
-
item index (1-based indexed)timeout
- system will wait at most timeout (seconds) to return resultSelect item of list view control by its index. Have not implemented for Android because its list view is async loaded
to
-
represent a mobile elementindex
-
item index (1-based indexed)timeout
- system will wait at most timeout (seconds) to return resultSelect item of list view control by its label.
to
-
represent a mobile elementlabel
-
item labeltimeout
- system will wait at most timeout (seconds) to return resultSelect item of list view control by its label.
to
-
represent a mobile elementlabel
-
item labeltimeout
- system will wait at most timeout (seconds) to return resultSimulates keystroke events on the specified element, as though you typed the value key-by-key.
to
- represent a mobile element.strokeKeys
- the combination of keys to typeSimulates keystroke events on the specified element, as though you typed the value key-by-key.
to
- represent a mobile element.strokeKeys
- the combination of keys to typeSet encrypted text into an input field. It also clears the previous value of the input field. To encrypt raw text, go to Help/Encrypt Text.
to
- represent a mobile element.encryptedText
- the encrypted text to set to the mobile element.timeout
- system will wait at most timeout (seconds) to return result.flowControl
- Optional parameter: Used to control the step if the step failed.
Set encrypted text into an input field. It also clears the previous value of the input field. To encrypt raw text, go to Help/Encrypt Text.
to
- Represent a mobile element.encryptedText
- The encrypted text to set to the mobile element.timeout
- System will wait at most timeout (seconds) to return result.Set the value for Slider control (android.widget.SeekBar for Android, UIASlider for iOS) at specific percentage
to
- represent a mobile element (android.widget.SeekBar for Android, UIASlider for iOS)percent
- percentage value to set to the slider ( 0 <= percent <= 100 )timeOut
- system will wait at most timeout (seconds) to return resultSet the value for Slider control (android.widget.SeekBar for Android, UIASlider for iOS) at specific percentage
to
- represent a mobile element (android.widget.SeekBar for Android, UIASlider for iOS)percent
- percentage value to set to the slider ( 0 <= percent <= 100 )timeOut
- system will wait at most timeout (seconds) to return resultSet text to a mobile element
to
- represent a mobile elementtext
- the text to set to the mobile elementtimeout
- system will wait at most timeout (seconds) to return resultSet text to a mobile element
to
- represent a mobile elementtext
- the text to set to the mobile elementtimeout
- system will wait at most timeout (seconds) to return resultStart up an application
appFile
- The absolute path or relative path of the mobile application installation file.
In case relative path is used, the base directory is the project location.uninstallAfterCloseApp
- true if uninstalling the application automatically after run completed; otherwise, falseStart up an application
appFile
- The absolute path or relative path of the mobile application installation file.
In case relative path is used, the base directory is the project location.uninstallAfterCloseApp
- true if uninstalling the application automatically after run completed; otherwise, falseStarts Appium driver and activate an installed application by it's given application ID.
appId
- ID of the application under test. It is package name for Android app, and bundleId for iOS app.Starts Appium driver and activate an installed application by it's given application ID.
appId
- ID of the application under test. It is package name for Android app, and bundleId for iOS app.flowControl
-
Optional parameter: Used to control the step if the step failed.
Simulate swiping fingers on the mobile device
startX
- starting x positionstartY
- starting y positionendX
- relative x position of startXendY
- relative y position of startYSimulate swiping fingers on the mobile device
startX
- starting x positionstartY
- starting y positionendX
- relative x position of startXendY
- relative y position of startYSwitch the current device's mode to landscape mode
Switch the current device's mode to landscape mode
Switch the current device driver to native context
Switch the current device driver to native context
Switch the current device's mode to portrait mode
Switch the current device's mode to portrait mode
Switch the current device driver to web view context
Switch the current device driver to web view context
Take a screenshot of a specific area. The area should be inside the application viewport; otherwise, this keyword will fail.
import org.openqa.selenium.Rectangle as Rectangle
import java.awt.Color
Mobile.takeAreaScreenshot('screenshot_area_demo.png',[findTestObject('hidden_object1')], Color.Black, new Rectangle(x, y, height, width), FailureHandling.STOP_ON_FAILURE)
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, the test engine will generate a random file name.rect
- A rectangle defining the position and size of the area to be captured.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a specific area. The area should be inside the application viewport; otherwise, this keyword will fail.
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, the test engine will generate a random file name.rect
- A rectangle defining the position and size of the area to be captured.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.Take a screenshot of a specific area. The area should be inside the application viewport; otherwise, this keyword will fail.
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, the test engine will generate a random file name.rect
- A rectangle defining the position and size of the area to be captured.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a specific area. The area should be inside the application viewport; otherwise, this keyword will fail.
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, the test engine will generate a random file name.rect
- A rectangle defining the position and size of the area to be captured.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.
Take a screenshot of a specific area. The area should be inside the application viewport; otherwise, this keyword will fail. You have to use Script mode to create the Rectangle object.
import org.openqa.selenium.Rectangle as Rectangle
Mobile.takeAreaScreenshotAsCheckpoint('screenshot_area_demo.png', new Rectangle(x, y, width, height))
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, the test engine will generate a random file name.rect
- A rectangle defining the position and size of the area to be captured.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a specific area. The area should be inside the application viewport; otherwise, this keyword will fail.
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, the test engine will generate a random file name.rect
- A rectangle defining the position and size of the area to be captured.Take a screenshot of a specific area. The area should be inside the application viewport; otherwise, this keyword will fail.
rect
- A rectangle defining the position and size of the area to be captured.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a specific area. The area should be inside the application viewport; otherwise, this keyword will fail.
rect
- A rectangle defining the position and size of the area to be captured.Take a screenshot of a specific area to send to TestOps Vision. The area should be inside the application viewport; otherwise, this keyword will fail.
import org.openqa.selenium.Rectangle as Rectangle
import java.awt.Color
Mobile.takeAreaScreenshotAsCheckpoint('checkpoint_area_demo',[findTestObject('hidden_object1')], Color.Black, new Rectangle(x, y, height, width), FailureHandling.STOP_ON_FAILURE)
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.rect
- A rectangle defining the position and size of the area to be captured.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a specific area to send to TestOps Vision. The area should be inside the application viewport; otherwise, this keyword will fail.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.rect
- A rectangle defining the position and size of the area to be captured.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.Take a screenshot of a specific area to send to TestOps Vision. The area should be inside the application viewport; otherwise, this keyword will fail.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.rect
- A rectangle defining the position and size of the area to be captured.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a specific area to send to TestOps Vision. The area should be inside the application viewport; otherwise, this keyword will fail.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.rect
- A rectangle defining the position and size of the area to be captured.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.Take a screenshot of a specific area to send to TestOps Vision. The area should be inside the application viewport; otherwise, this keyword will fail.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.rect
- A rectangle defining the position and size of the area to be captured.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a specific area to send to TestOps Vision. The area should be inside the application viewport; otherwise, this keyword will fail.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.rect
- A rectangle defining the position and size of the area to be captured.Take a screenshot of a UI element. The test engine will scroll to this element first then taking a screenshot.
import java.awt.Color
Mobile.takeElementScreenshot('screenshot_demo.png', findTestObject('capture_object'), [findTestObject('hidden_object1')], Color.Black, FailureHandling.STOP_ON_FAILURE)
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, Katalon Studio will generate a random file name.to
- UI element to be taken screenshot of.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a UI element. The test engine will scroll to this element first then taking a screenshot.
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, Katalon Studio will generate a random file name.to
- UI element to be taken screenshot of.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.Take a screenshot of a UI element. The test engine will scroll to this element first then taking a screenshot.
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, Katalon Studio will generate a random file name.to
- UI element to be taken screenshot of.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a UI element. The test engine will scroll to this element first then taking a screenshot.
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, Katalon Studio will generate a random file name.to
- UI element to be taken screenshot of.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.Take a screenshot of a UI element. The test engine will scroll to this element first then taking a screenshot.
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, Katalon Studio will generate a random file name.to
- UI element to be taken screenshot of.flowContro
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a UI element. The test engine will scroll to this element first then taking a screenshot.
fileName
- Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format.
If the file name is not defined, Katalon Studio will generate a random file name.to
- UI element to be taken screenshot of.Take a screenshot of a UI element. The test engine will scroll to this element first then taking a screenshot.
to
- UI element to be taken screenshot of.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a UI element. The test engine will scroll to this element first then taking a screenshot.
to
- UI element to be taken screenshot of.Take a screenshot of a UI element to send to TestOps Vision. The test engine will scroll to this element first then taking a screenshot. The captured image will be saved to the `keyes` folder in the report.
import java.awt.Color
Mobile.takeElementScreenshotAsCheckpoint('screenshot_demo', findTestObject('capture_object'), [findTestObject('hidden_object1')], Color.Black, FailureHandling.STOP_ON_FAILURE)
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.to
- UI element to be taken screenshot of.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a UI element to send to TestOps Vision. The test engine will scroll to this element first then taking a screenshot. The captured image will be saved to the `keyes` folder in the report.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.to
- UI element to be taken screenshot of.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.Take a screenshot of a UI element to send to TestOps Vision. The test engine will scroll to this element first then taking a screenshot. The captured image will be saved to the `keyes` folder in the report.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.to
- UI element to be taken screenshot of.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a UI element to send to TestOps Vision. The test engine will scroll to this element first then taking a screenshot. The captured image will be saved to the `keyes` folder in the report.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.to
- UI element to be taken screenshot of.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.Take a screenshot of a UI element to send to TestOps Vision. The test engine will scroll to this element first then taking a screenshot. The captured image will be saved to the `keyes` folder in the report.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.to
- UI element to be taken screenshot of.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of a UI element to send to TestOps Vision. The test engine will scroll to this element first then taking a screenshot. The captured image will be saved to the `keyes` folder in the report.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.to
- UI element to be taken screenshot of.Taking screenshot of the mobile device screen
fileName
- the absolute path of the saved screenshot image fileTaking screenshot of the mobile device screen
fileName
- the absolute path of the saved screenshot image fileTaking screenshot of the mobile device screen
Taking screenshot of the mobile device screen
Take a screenshot of the current application to send to TestOps Vision. The captured image will be saved to the **keyes** folder in the report. The screenshot will not include OS's status and navigation bars.
import java.awt.Color
Mobile.takeScreenshotAsCheckpoint('screenshot_demo', [findTestObject('hidden_object1')], Color.Black, FailureHandling.STOP_ON_FAILURE)
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of the current application to send to TestOps Vision. The captured image will be saved to the keyes folder in the report. The screenshot will not include OS's status and navigation bars.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.Take a screenshot of the current application to send to TestOps Vision. The captured image will be saved to the keyes folder in the report. The screenshot will not include OS's status and navigation bars.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of the current application to send to TestOps Vision. The captured image will be saved to the keyes folder in the report. The screenshot will not include OS's status and navigation bars.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.ignoredElements
- List of the ignored elements. These elements will be hidden by drawing an overlap color layer.
If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.hidingColor
- The color used to draw the overlap layer. If not defined, Color.GRAY is used.Take a screenshot of the current application to send to TestOps Vision. The captured image will be saved to the keyes folder in the report. The screenshot will not include OS's status and navigation bars.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.flowControl
- Specify FailureHandling schema to determine whether the execution should be allowed to continue or stop.
Take a screenshot of the current application to send to TestOps Vision. The captured image will be saved to the keyes folder in the report. The screenshot will not include OS's status and navigation bars.
checkpointName
- A String representing the name of the image on TestOps Vision. This name will be used to detect which baseline this checkpoint is compared with.
This name will be appended with the TestOps Vision prefix ('keyes-') on a local machine.Tap on an mobile element
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultTap on an mobile element
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultTap and hold on a mobile element for a duration
to
- represent a mobile elementduration
- duration (in seconds) that the tap is hold on the element, if set to <= 0 then will use default durationtimeout
- system will wait at most timeout (seconds) to return resultTap and hold on a mobile element for a duration
to
- represent a mobile elementduration
- duration (in seconds) that the tap is hold on the element, if set to <= 0 then will use default durationtimeout
- system will wait at most timeout (seconds) to return resultTap and hold at a specific position on the screen of the mobile device
x
- x positiony
- y positionduration
- duration (in seconds) that the tap is hold on the element, if set to <= 0 then will use default durationTap and hold at a specific position on the screen of the mobile device
x
- x positiony
- y positionduration
- duration (in seconds) that the tap is hold on the element, if set to <= 0 then will use default durationTap at a specific position on the screen of the mobile device
x
- x positiony
- y positionTap at a specific position on the screen of the mobile device
x
- x positiony
- y positionFinds the webElement that is recognized by the given image then taps on the found element's location.
imageFilePath
- Absolute path of the image.flowControl
- Optional parameter: Controls the execution flow if the step failed.
Finds the mobile element that is recognized by the given image and taps on the found element's location.
imageFilePath
- Absolute path of the image.Simulate toggling airplane mode on mobile devices
mode
- ["yes", "on", "true"] to turn on airplane mode; otherwise, airplane mode is turn offSimulate toggling airplane mode on mobile devices
mode
- ["yes", "on", "true"] to turn on airplane mode; otherwise, airplane mode is turn off Simulate toggling Wifi on/off on mobile devices.
Support iOS real devices and Android emulators.
mode
- ["yes", "on", "true"] to turn on the the Wifi. Otherwise, the Wifi will be turned off.flowControl
- Optional parameter: Used to control the step if the step failed.
Simulate toggling Wifi on/off on mobile devices.
Support iOS real devices and Android emulators.
mode
- ["yes", "on", "true"] to turn on the the Wifi. Otherwise, the Wifi will be turned off.Un-check a check-box mobile element (android.widget.CheckBox for Android, UIASwitch for iOS)
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultUn-check a check-box mobile element (android.widget.CheckBox for Android, UIASwitch for iOS)
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultUnlock device screen
Unlock device screen
Simulate a fingerprint touch event on Android emulators. To enable this keyword, at least one fingerprint must be enrolled on the emulator using Android Debug Bridge.
fingerprintId
- (int)
An Android fingerprint ID (from 1 to 10).flowControl
- (FailureHandling)
Optional parameter: Used to control the step if the step failed.
Simulate a fingerprint touch event on Android emulators. To enable this keyword, at least one fingerprint must be enrolled on the emulator using Android Debug Bridge.
fingerprintId
- (int)
An Android fingerprint ID (from 1 to 10).Verify if the element has an attribute with the specific name and value
to
- represent a mobile elementattributeName
- the name of the attribute to verifyattributeValue
- the value of the attribute to verifytimeOut
- system will wait at most timeout (seconds) to return resultVerify if the element has an attribute with the specific name and value
to
- represent a mobile elementattributeName
- the name of the attribute to verifyattributeValue
- the value of the attribute to verifytimeOut
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is checked
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is checked
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is presented
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is presented
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if the element has an attribute with the specific name
to
- represent a mobile elementattributeName
- the name of the attribute to verifytimeOut
- system will wait at most timeout (seconds) to return resultVerify if the element has an attribute with the specific name
to
- represent a mobile elementattributeName
- the name of the attribute to verifytimeOut
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is not checked
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is not checked
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is NOT presented
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is NOT presented
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if the element doesn't have an attribute with the specific name
to
- represent a mobile elementattributeName
- the name of the attribute to verifytimeOut
- system will wait at most timeout (seconds) to return resultVerify if the element doesn't have an attribute with the specific name
to
- represent a mobile elementattributeName
- the name of the attribute to verifytimeOut
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is NOT visible
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is NOT visible
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify text of an element.
to
- represent a mobile element.expectedText
- text of the element to verify.Verify text of an element.
to
- represent a mobile element.expectedText
- text of the element to verify.Verify if a mobile element is visible
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerify if a mobile element is visible
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultVerifies the given image that presents on the device screen or not.
imageFilePath
- Absolute path of the image.flowControl
- Optional parameter: Controls the execution flow if the step failed.
Verifies the given image that presents on the device screen or not.
imageFilePath
- Absolute path of the image.Verify if current device is in landscape mode
Verify if current device is in landscape mode
Verify if current device is in portrait mode
Verify if current device is in portrait mode
Wait until the given web element has an attribute with the specific name and value
to
- represent a mobile elementattributeName
- the name of the attribute to wait forattributeValue
- the value of the attribute to wait fortimeOut
- system will wait at most timeout (seconds) to return resultWait until the given web element has an attribute with the specific name and value
to
- represent a mobile elementattributeName
- the name of the attribute to wait forattributeValue
- the value of the attribute to wait fortimeOut
- system will wait at most timeout (seconds) to return resultWait until the given web element has an attribute with the specific name
to
- represent a mobile elementattributeName
- the name of the attribute to wait fortimeOut
- system will wait at most timeout (seconds) to return resultWait until the given web element has an attribute with the specific name
to
- represent a mobile elementattributeName
- the name of the attribute to wait fortimeOut
- system will wait at most timeout (seconds) to return resultWait until the given web element doesn't have an attribute with the specific name
to
- represent a web elementattributeName
- the name of the attribute to wait fortimeOut
- system will wait at most timeout (seconds) to return resultWait until the given web element doesn't have an attribute with the specific name
to
- represent a web elementattributeName
- the name of the attribute to wait fortimeOut
- system will wait at most timeout (seconds) to return resultWait for a mobile element to NOT present (disappear) within the given time in second unit
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultWait for a mobile element to NOT present (disappear) within the given time in second unit
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultWait for a mobile element to present
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return resultWait for a mobile element to present
to
- represent a mobile elementtimeout
- system will wait at most timeout (seconds) to return result