This section includes the detailed documentation for the following object classes of Mobile.
Mobile General Actions
Mobile.DragAndDropToObject
This action drags the specified mobile object and drops on another specified mobile object.
Input Parameters:
...
Parameter Nane
...
Parameter Description
...
Mandatory
...
Data Type
...
dragLocator
...
The locator value of the mobile element you want to drag.
...
Yes
...
String
...
dragLocatorType
...
The locator type of mobile element you want to drag.
...
Yes
...
String
...
dropToLocator
...
The locator value of the mobile element on which you want to drop.
...
Yes
...
String
...
dropToLocatorType
...
The locator type of the mobile element on which you want to drop.
...
Yes
...
String
Example:
Mobile.DragAndDropToObject dragLocator dragLocatorType dropToLocator dropToLocatorType
Mobile.CloseApp
This action closes the specified application or mobile browser.
This action does not have any parameter.
As the mobile app is closed, you cannot have any mobile action after the step containing this action.
Example:
Mobile.CloseApp
Mobile.HideKeyboard
This action hides the keyboard if present on the screen.
Parameters mentioned below are applicable for iOS only.
For Android, parameters are not required and ignored if provided.
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
Strategy
...
Enter the strategy to hide the keyboard. Value for this parameter can be PRESS_KEY and TAP_OUTSIDE.
...
No
...
String
...
KeyName
...
Enter the text that is displayed on the button of the keyboard you want to press to hide keyboard.
...
No
...
String
...
Mobile.OpenApp
This action launches native/hybrid mobile Android or iOS application on the mobile device (emulator or physical). If the app does not exist in the device, this action will take the APK/ IPA file path specified and install it on the device before launching it.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Android APK Path / iOS IPA Path
...
Enter the absolute path of the apk/app/ipa file. This path should be accessible to the system where Appium server is installed.
...
No
...
String
...
Android Package / iOS BundleID
...
Enter the package name of the Android app or bundle ID of the iOS app.
...
Yes
...
String
...
Android Activity
...
Enter the activity name of the Android app. For iOS, enter as Dummy Activity Name.
...
Yes
...
String
Example:
Mobile.OpenApp "D:\myapp.apk" "com.app.package" "com.app.package.MainActivity"
Mobile.PressAt
This action clicks at the specified point on the device screen.
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
X
...
The x-coordinate value of the specified point on the screen.
...
No
...
String
...
Y
...
The y-coordinate value of the specified point on the screen.
...
No
...
String
Example
Mobile.PressAt "5" "10"
Mobile.PressHomeButton
This action opens the home screen of the device.
This action does not have any parameter.
Example:
Mobile.PressHomeButton
Mobile.PressRecentsButton
This action shows the recent application.
This action does not have any parameter.
Note: This action is not supported on the iOS platform.
Example:
Mobile.PressRecentsButton
Mobile.SwitchApp
This action launches new native/hybrid mobile Android or iOS application to which you want to switch from the already launched native/hybrid mobile application.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Package
...
Package Name
...
Enter the package name of the Android app or bundle ID of the iOS app.
...
No
...
String
...
ActivityName
...
Enter the activity name of the Android app. For iOS, enter as Dummy Activity Name.
...
No
...
String
Example:
Mobile.SwitchApp "com.app.package" "com.app.package.MainActivity"
SwitchWebExecutionPlatform
This action changes the current Web execution platform from Desktop to Mobile or from Mobile to Desktop. When used, web application test case will run on specified platform.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Platform
...
Platform to run web application on. Supported platforms are "Desktop" and "Mobile".
...
Yes
...
String
Example:
SwitchWebExecutionPlatform "Mobile"
Mobile.PressBackButton
This action taps back button on the Mobile device.
This action is supported for Android only.
This action does not have any parameter.
Example:
Mobile.PressBackButton
Mobile.StoreWebViewHandle
This action stores the web view handle under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
key
...
Enter the key under which you want to store the web view handle.
...
Yes
...
String
...
Mobile.SelectWebView
This action selects the web view present in the current page hybrid app. If key is provided (by using StoreWebViewHandle action), system selects the webview specified in key. If key is not provided, default webview will be selected.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
enter the key used in the action "StoreWebViewHandle".
...
No
...
String
...
Mobile.SelectNativeContext
This action can be used to select native context from the hybrid app.
This action does not have any parameter.
Example:
Mobile.SelectNativeContext
Mobile.SelectWebViewUsingURL
This action selects the web view using the URL or pattern specified in the parameters.
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
URL
...
Enter the URL to open.
...
No
...
String
...
IsURLPattern
...
Specify whether the URL is patterned or not.
Value of this parameter can be True or False.
...
No
...
String
Example:
Mobile.SelectWebviewUsingURL "www.google.com" "False"
Mobile.PressKeys
This action presses the specified keys using the mobile keyboard.
This action can be used when working with Android applications.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
keyName
...
Enter the key to be pressed. For more information, click here.
...
Yes
...
String
...
modifierKeyName
...
Enter Modifier (Meta State) key to press. Generally used for combination of keys such as Shift, Ctrl, and so on. For more information, click here.
...
No
...
String
...
Mobile.Presskeys “F”
Mobile.Presskeys “CAP_LOCKED”
Mobile.Swipe
This action performs swipe based on the coordinates provided in the parameters.
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
startX
...
Enter the starting point in x-axis from where you want to start the swipe.
...
Yes
...
String
...
startY
...
Enter the starting point in y-axis from where you want to start the swipe.
...
Yes
...
String
...
endX
...
Enter the starting point in x-axis from where you want to stop the swipe.
...
Yes
...
String
...
endY
...
Enter the starting point in y-axis from where you want to stop the swipe.
...
Yes
...
String
...
duration
...
Enter the duration seconds for the action to perform
...
No
...
String
Example:
Mobile.Swipe "100" "123" "145" "121" "1"
Mobile.OpenNotification
A notification is a message at the device level against the application and stored in the notification panel.
This action pulls down the notification panel on Android and iOS device. It does not have any parameters.
Example:
Mobile.OpenNotification
Mobile.VerifyToast
A toast provides simple feedback about an operation in a small popup.
This action verifies whether the toast message matches the text provided in the action parameter. The match can either be a partial or an exact match. Currently, this action is supported only on the Android platform.
This parameter is mandatory.
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
matchText
...
The toast message, which is expected to display.
...
Yes
...
String
Example:
Mobile.VerifyToast "Success"
Mobile Element Actions
Click
This action clicks the specified object.
This action does not have any parameter.
Example:
Click
LongPress
This action performs the long press event on the specified object.
This action does not have any parameter.
Example:
LongPress
StorePropertyValue
This action stores the property of the specified object under the key name. The stored key value can be retrieved using the key name.
Some Android and iOS properties are not accessible.
List of accessible properties for Android: "name", "contentDescription", "className", "resourceId", "text", "enabled", "checkable", "checked", "clickable", "focusable", "focused", "longClickable", "scrollable", "selected", "displayed"
List of accessible properties for iOS: "name", "value", "label", "hint"
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the property value will be stored.
...
Yes
...
String
...
Property
...
Property/attribute name whose value needs to be stored under the specified key. This can be any accessible property of Android/iOS native object mentioned above.
...
Yes
...
String
Example: StorePropertyValue "key" "text"
StoreVisibility
This action stores visibility of the mobile object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
strKey
...
The visibility value for the mobile object is stored as:
True denotes the object is visible
False denotes the object is not visible
...
No
...
String
Example:
StoreVisibility "Key"
Swipe
This action performs swipe and finds object until timeout occurs.
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
upDownLeftRight
...
Enter the direction of swipe:
Up: Move finger from down to up on the device screen.
Down: Move finger from up to down on the device screen.
Left: Move finger from right to left on the device screen.
Right: Move finger from left to right on the device screen.
...
No
...
String
...
timeoutInSeconds
...
Enter the timeout in seconds.
...
No
...
String
...
swipePageInSeconds
...
Enter in how many seconds one page should be swiped. Default is 1 second.
Use this parameter with caution only when control on swipe speed is required.
...
No
...
String
Example:
Swipe "up" "10" "1"
VerifyEnability
This action verifies the enability of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
enability
...
Value for this parameter can be True or False.
Set True if you want to verify that the object is enabled.
Set False if you want to verify that the object is disabled.
Note: If you do not enter any value, the default value is set to True during the test case execution.
...
No
...
String
Example:
VerifyEnability "True"
VerifyExistence
This action verifies the existence of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check the existence.
Set False if you want to check the non-existence.
...
No
...
String
Example: VerifyExistence "True"
WaitForObject (Deprecated)
This action waits for the object to appear or disappear for the maximum number of seconds specified.
If the object is found or not found before the maximum time specified, execution continues to the next steps.
If the wait time is "" then the wait time shall be the "Sync Time" set under the associated execution profile.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Timeout
...
Enter the number of seconds to wait for the object to appear or disappear. This has to be 0 or any positive number.
...
No
...
String
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check for the appearance of the object.
Set False if you want to check for the disappearance of the object.
...
No
...
String
Example:
WaitForObject "10" "True"
The action waits for maximum 10 seconds for the object to appear. If the object appears before 10 seconds elapses, execution continues to the next steps.
WaitForObject "15" "False"
The action shall wait for maximum 15 seconds for the object to disappear. If the object disappears before 15 seconds elapses, the execution continues to the next steps.
MobileButton Actions
Click
This action clicks the specified object.
This action does not have any parameter.
Example:
Click
StoreExistence
This action stores existence of the object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
Enter the key name under which the existence's Boolean value will be stored.
...
Stores True if the object exists.
...
Yes
...
String
Example:
StoreExistence "Key"
LongPress
This action performs the long press event on the specified object.
This action does not have any parameter.
Example:
LongPress
Swipe
This action performs swipe and finds object until timeout occurs.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
upDownLeftRight
...
Enter the direction of swipe:
Up: Move finger from down to up on the device screen.
Down: Move finger from up to down on the device screen.
Left: Move finger from right to left on the device screen.
Right: Move finger from left to right on the device screen.
...
No
...
String
...
timeoutInSeconds
...
Enter the timeout in seconds.
...
No
...
String
...
swipePageInSeconds
...
Enter in how many seconds one page should be swiped. Default is 1 second.
Use this parameter with caution only when control on swipe speed is required.
...
No
...
String
Example:
Swipe "up" "10" "1"
StorePropertyValue
This action stores the property of the specified object under the key name. The stored key value can be retrieved using the key name.
Some Android and iOS properties are not accessible.
List of accessible properties for Android: "name", "contentDescription", "className", "resourceId", "text", "enabled", "checkable", "checked", "clickable", "focusable", "focused", "longClickable", "scrollable", "selected", "displayed"
List of accessible properties for iOS: "name", "value", "label", "hint"
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the property value will be stored.
...
Yes
...
String
...
Property
...
Property/attribute name whose value needs to be stored under the specified key. This can be any accessible property of Android/iOS native object mentioned above.
...
Yes
...
String
Example:
StorePropertyValue "key" "text"
StoreVisibility
This action stores visibility of the mobile object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
strKey
...
The visibility value for the mobile object is stored as:
True denotes the object is visible
False denotes the object is not visible
...
No
...
String
Example:
StoreVisibility "Key"
VerifyEnability
This action verifies the enability of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
enability
...
Value for this parameter can be True or False.
Set True if you want to verify that the object is enabled.
Set False if you want to verify that the object is disabled.
Note: If you do not enter any value, the default value is set to True during the test case execution.
...
No
...
String
Example:
VerifyEnability "True"
VerifyExistence
This action verifies the existence of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check the existence.
Set False if you want to check the non-existence.
...
No
...
String
Example:
VerifyExistence "True"
WaitForObject
This action waits for the object to appear or disappear for the maximum number of seconds specified.
If the object is found or not found before the maximum time specified, execution continues to the next steps.
If the wait time is "" then the wait time shall be the "Sync Time" set under the associated execution profile.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Timeout
...
Enter the number of seconds to wait for the object to appear or disappear. This has to be 0 or any positive number.
...
No
...
String
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check for the appearance of the object.
Set False if you want to check for the disappearance of the object.
...
No
...
String
Example:
WaitForObject "10" "True"
The action waits for maximum 10 seconds for the object to appear. If the object appears before 10 seconds elapses, execution continues to the next steps.
WaitForObject "15" "False"
The action shall wait for maximum 15 seconds for the object to disappear. If the object disappears before 15 seconds elapses, the execution continues to the next steps.
MobileCheckbox Actions
Check
This action selects the specified check box.
This action does not have any parameter.
Example:
Check
CheckIfTrue
This action selects the check box, only if the parameter passed is True.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Check
...
Value of this parameter can be True or False.
Set True if you want to select the check box.
Set False if you do not want to select the check box.
...
No
...
String
Example:
CheckIfTrue "True"
Click
This action clicks the specified object.
This action does not have any parameter.
Example:
Click
On this page:
Table of Contents | ||||
---|---|---|---|---|
|
IsChecked
This action verifies whether the specified check box is selected.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
state
...
Value of this parameter can be either True or False.
Set True if you want to check that the checkbox is selected
Set False if you want to check that the checkbox is deselected
...
No
...
String
Example:
IsChecked "True"
LongPress
This action performs the long press event on the specified object.
This action does not have any parameter.
Example:
LongPress
StoreExistence
This action stores existence of the object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the existence's Boolean value will be stored.
Stores True if the object exists.
Stores False if the object does not exist.
...
Yes
...
String
Example:
StoreExistence "Key"
StorePropertyValue
This action stores the property of the specified object under the key name. The stored key value can be retrieved using the key name.
Some Android and iOS properties are not accessible.
List of accessible properties for Android: "name", "contentDescription", "className", "resourceId", "text", "enabled", "checkable", "checked", "clickable", "focusable", "focused", "longClickable", "scrollable", "selected", "displayed"
List of accessible properties for iOS: "name", "value", "label", "hint"
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the property value will be stored.
...
Yes
...
String
...
Property
...
Property/attribute name whose value needs to be stored under the specified key. This can be any accessible property of Android/iOS native object mentioned above.
...
Yes
...
String
Example:
StorePropertyValue "key" "text"
StoreVisibility
This action stores visibility of the mobile object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
strKey
...
The visibility value for the mobile object is stored as:
True denotes the object is visible
False denotes the object is not visible
...
No
...
String
Example:
StoreVisibility "Key"
Swipe
This action performs swipe and finds object until timeout occurs.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
upDownLeftRight
...
Enter the direction of swipe:
Up: Move finger from down to up on the device screen.
Down: Move finger from up to down on the device screen.
Left: Move finger from right to left on the device screen.
Right: Move finger from left to right on the device screen.
...
No
...
String
...
timeoutInSeconds
...
Enter the timeout in seconds.
...
No
...
String
...
swipePageInSeconds
...
Enter in how many seconds one page should be swiped. Default is 1 second.
Use this parameter with caution only when control on swipe speed is required.
...
No
...
String
Example:
Swipe "up" "10" "1"
Uncheck
This action deselects the specified check box.
This action does not have any parameter.
Example:
UnCheck
VerifyEnability
This action verifies the enability of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
enability
...
Value for this parameter can be True or False.
Set True if you want to verify that the object is enabled.
Set False if you want to verify that the object is disabled.
Note: If you do not enter any value, the default value is set to True during the test case execution.
...
No
...
String
Example:
VerifyEnability "True"
VerifyExistence
This action verifies the existence of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check the existence.
Set False if you want to check the non-existence.
...
No
...
String
Example:
VerifyExistence "True"
WaitForObject
This action waits for the object to appear or disappear for the maximum number of seconds specified.
If the object is found or not found before the maximum time specified, execution continues to the next steps.
If the wait time is "" then the wait time shall be the "Sync Time" set under the associated execution profile.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Timeout
...
Enter the number of seconds to wait for the object to appear or disappear. This has to be 0 or any positive number.
...
No
...
String
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check for the appearance of the object.
Set False if you want to check for the disappearance of the object.
...
No
...
String
Example:
WaitForObject "10" "True"
The action waits for maximum 10 seconds for the object to appear. If the object appears before 10 seconds elapses, execution continues to the next steps.
WaitForObject "15" "False"
The action shall wait for maximum 15 seconds for the object to disappear. If the object disappears before 15 seconds elapses, the execution continues to the next steps.
MobileDropDown Actions
Note |
---|
These actions are available when working with the Android application testing only. |
Click
This action clicks the specified object.
This action does not have any parameter.
Example:
Click
LongPress
This action performs the long press event on the specified object.
This action does not have any parameter.
Example:
LongPress
SelectItemByName
This action selects the specified item from the MobileDropDown. The parameter value specified here is case-sensitive.
Items present in the drop-down must have a 'text' property.
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
itemName
...
Enter the item name that you want to select from the list.
...
Yes
...
String
Example:
SelectItemByName "Qualitia"
On this page:
Table of Contents | ||||
---|---|---|---|---|
|
StoreExistence
This action stores existence of the object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the existence's Boolean value will be stored.
Stores True if the object exists.
Stores False if the object does not exist.
...
Yes
...
String
Example:
StoreExistence "Key"
StorePropertyValue
This action stores the property of the specified object under the key name. The stored key value can be retrieved using the key name.
Some Android and iOS properties are not accessible.
List of accessible properties for Android: "name", "contentDescription", "className", "resourceId", "text", "enabled", "checkable", "checked", "clickable", "focusable", "focused", "longClickable", "scrollable", "selected", "displayed"
List of accessible properties for iOS: "name", "value", "label", "hint"
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the property value will be stored.
...
Yes
...
String
...
Property
...
Property/attribute name whose value needs to be stored under the specified key. This can be any accessible property of Android/iOS native object mentioned above.
...
Yes
...
String
Example:
StorePropertyValue "key" "text"
StoreVisibility
This action stores visibility of the mobile object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
strKey
...
The visibility value for the mobile object is stored as:
True denotes the object is visible
False denotes the object is not visible
...
No
...
String
Example:
StoreVisibility "Key"
Swipe
This action performs swipe and finds object until timeout occurs.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
upDownLeftRight
...
Enter the direction of swipe:
Up: Move finger from down to up on the device screen.
Down: Move finger from up to down on the device screen.
Left: Move finger from right to left on the device screen.
Right: Move finger from left to right on the device screen.
...
No
...
String
...
timeoutInSeconds
...
Enter the timeout in seconds.
...
No
...
String
...
swipePageInSeconds
...
Enter in how many seconds one page should be swiped. Default is 1 second.
Use this parameter with caution only when control on swipe speed is required.
...
No
...
String
Example:
Swipe "up" "10" "1"
VerifyEnability
This action verifies the enability of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
enability
...
Value for this parameter can be True or False.
Set True if you want to verify that the object is enabled.
Set False if you want to verify that the object is disabled.
Note: If you do not enter any value, the default value is set to True during the test case execution.
...
No
...
String
Example:
VerifyEnability "True"
VerifyExistence
This action verifies the existence of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check the existence.
Set False if you want to check the non-existence.
...
No
...
String
Example:
VerifyExistence "True"
WaitForObject
This action waits for the object to appear or disappear for the maximum number of seconds specified.
If the object is found or not found before the maximum time specified, execution continues to the next steps.
If the wait time is "" then the wait time shall be the "Sync Time" set under the associated execution profile.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Timeout
...
Enter the number of seconds to wait for the object to appear or disappear. This has to be 0 or any positive number.
...
No
...
String
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check for the appearance of the object.
Set False if you want to check for the disappearance of the object.
...
No
...
String
Example:
WaitForObject "10" "True"
The action waits for maximum 10 seconds for the object to appear. If the object appears before 10 seconds elapses, execution continues to the next steps.
WaitForObject "15" "False"
The action shall wait for maximum 15 seconds for the object to disappear. If the object disappears before 15 seconds elapses, the execution continues to the next steps.
MobileList Actions
Info |
---|
MobileList control is abstract control for any layout/widget having list-item like structures in UIAutomator. UIAutomation such as Android (android.widget.ListView, any RelativeLayout having listItems child, elements grandchild, and TableLayout android.widget.GridView) In the iOS platform, only UITable with UITableCell is seen (only that is supported for now). The following limitations of the MobileList control are:
|
Click
This action clicks the specified object.
This action does not have any parameter.
Example:
Click
ClickElement
This action clicks the element present at the specified location.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
listItemIndex
...
Enter the list item index which you want to select. Index starts at 1.
...
Yes
...
String
...
listItemMemberIndex
...
Enter the list item member from the list which you want to select. Index starts at 1.
...
Yes
...
String
Example:
ClickElement "3" "2"
CompareListItemMembersData
This action compares the data present at the specified list item member index.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
listItemMemberIndex
...
Enter the list item member index where you want to compare the data.
...
No
...
String
...
expectedListItemMembersData
...
Enter the expected data to verify.
...
No
...
Array
Example:
CompareListItemMembersData "2" "Qualitia^QTP^WebDriver"
CompareListItemData
This action compares the data present at the specified list item index.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
listItemIndex
...
Enter the list item index where you want to compare the data.
...
Yes
...
String
...
expectedListItemData
...
Enter the expected data to verify.
...
No
...
Array
Example:
CompareListItemData "2" "Qualitia^QTP^WebDriver"
On this page:
Table of Contents | ||||
---|---|---|---|---|
|
DeSelectCheckboxAtListItemMember
This action deselects the check box present at given list item index.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
listItemIndex
...
Enter the list item index from where check box is to be deselected.
...
Yes
...
String
...
listItemMemberIndex
...
Enter the list item member index from where check box is to be deselected.
...
No
...
String
Example:
DeSelectCheckboxAtListItemMemberIndex "3" "7"
LongPress
This action performs the long press event on the specified object.
This action does not have any parameter.
Example:
LongPress
SelectCheckboxAtListItemMember
This action selects the check box present in the specified list item member.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
listItemIndex
...
Enter the list item index from where you want to select the check box.
...
Yes
...
String
...
listItemMemberIndex
...
Enter the list item member index from where you want to select the check box.
...
No
...
String
Example:
SelectCheckboxatListItemMember "5" "4"
StoreExistence
This action stores existence of the object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the existence's Boolean value will be stored.
Stores True if the object exists.
Stores False if the object does not exist.
...
Yes
...
String
Example:
StoreExistence "Key"
StoreListItemCount
This action stores the count of list items in the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name in which you want to store the item count.
...
Yes
...
String
Example:
StoreListItemCount "Key"
StoreListItemIndexContainingMaxValue
This action stores the list item index which contains the maximum value. This action only works with numerical data.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key in which you want to save the list item index.
...
Yes
...
String
...
listItemMemberIndex
...
Enter the list item member index in which you want to look for the data.
...
No
...
String
Example:
StoreListItemIndexContainingMaxValue "Key" "1"
StoreListItemIndexContainingMinValue
This action stores the list item index which contains the minimum value. This action only works with numerical data.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key in which the list item index will be saved.
...
Yes
...
String
...
listItemMemberIndex
...
Enter the list item member index in which the data is to be checked.
...
Yes
...
String
Example:
StoreListItemIndexContainingMinValue "Key" "1"
StoreListItemIndexContainingText
This action stores the list item index which contains the specified text.
The comparison is case-sensitive.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key in which you want to save the list item index.
...
Yes
...
String
...
textToVerify
...
Enter the text that you want to verify.
...
No
...
String
...
listItemMemberIndex
...
Enter the list item member index in which you want to check the data.
...
Yes
...
String
...
StoreListItemIndexContainingText "Key" "Qualitia" "1"
StoreListItemIndexContainingTextInArray
This action checks if each string separated by caret is part of the list item member data.
For example, if list item member data is abc,def,ghi and input data is d^f then listItemIndex 2 will be stored under the key name.
The comparison is case-sensitive.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name in which the index number will be stored.
...
Yes
...
String
...
textArrayToVerify
...
Enter the text array to be verified.
...
Yes
...
Array
...
listItemMemberIndex
...
Enter the list item member from where the text is to be taken.
...
Yes
...
String
...
StoreListItemIndexContainingTextInArray "Key" "d^f" "3"
StoreListItemMembersCount
This action stores the total count of the specified list item members under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which you want to store the count.
...
Yes
...
String
Example:
StoreListItemMembersCount "Key"
StorePropertyValue
This action stores the property of the specified object under the key name. The stored key value can be retrieved using the key name.
Some Android and iOS properties are not accessible.
List of accessible properties for Android: "name", "contentDescription", "className", "resourceId", "text", "enabled", "checkable", "checked", "clickable", "focusable", "focused", "longClickable", "scrollable", "selected", "displayed"
List of accessible properties for iOS: "name", "value", "label", "hint"
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the property value will be stored.
...
Yes
...
String
...
Property
...
Property/attribute name whose value needs to be stored under the specified key. This can be any accessible property of Android/iOS native object mentioned above.
...
Yes
...
String
Example:
StorePropertyValue "key" "text"
StoreVisibility
This action stores visibility of the mobile object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
strKey
...
The visibility value for the mobile object is stored as:
True denotes the object is visible
False denotes the object is not visible
...
No
...
String
Example:
StoreVisibility "Key"
Swipe
This action performs swipe and finds object until timeout occurs.
Input Parameters:
...
ParameterName
...
Parameter Description
...
Mandatory
...
Data Type
...
upDownLeftRight
...
Enter the direction of swipe:
Up: Move finger from down to up on the device screen.
Down: Move finger from up to down on the device screen.
Left: Move finger from right to left on the device screen.
Right: Move finger from left to right on the device screen.
...
No
...
String
...
timeoutInSeconds
...
Enter the timeout in seconds.
...
No
...
String
...
swipePageInSeconds
...
Enter in how many seconds one page should be swiped. Default is 1 second.
Use this parameter with caution only when control on swipe speed is required.
...
No
...
String
Example:
Swipe "up" "10" "1"
VerifyDataExistenceInListItem
This action verifies the existence of the data in the specified list item.
The data comparison is case-sensitive.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
listItemIndex
...
Enter the list item index where you want to verify the existence.
...
Yes
...
String
...
expectedListItemsData
...
Enter the expected data separated by carrot. You can provide one or more expected strings.
...
No
...
Array
...
existence
...
Enter the expected existence of the data (True or False).
...
No
...
String
Example:
VerifyDataExistenceInListItem "7" "40" "True"
VerifyDataExistenceInListItem "7" "Zensoft^9" "True"
VerifyDataExistenceInListItemMembers
This action verifies the existence of the data present in the specified list item member index.
The data comparison is case-sensitive.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
listItemMemberIndex
...
Enter the list item member index where existence is to be verified.
...
Yes
...
String
...
expectedListItemMembersData
...
Enter the expected data separated by carrot. You can provide one or more expected strings.
...
No
...
Array
...
existence
...
Enter the expected existence of the data (True or False).
...
No
...
String
Example:
VerifyDataExistenceInListItemMembers "5" "49" "True"
VerifyDataExistenceInListItemMembers "5" "Qualitia^6" "False"
VerifyEnability
This action verifies the enability of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
enability
...
Value for this parameter can be True or False.
Set True if you want to verify that the object is enabled.
Set False if you want to verify that the object is disabled.
Note: If you do not enter any value, the default value is set to True during the test case execution.
...
No
...
String
Example:
VerifyEnability "True"
VerifyExistence
This action verifies the existence of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check the existence.
Set False if you want to check the non-existence.
...
No
...
String
Example:
VerifyExistence "True"
VerifyListItemCount
This action verifies the total count of items present under the list with the expected specified count.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
expectedListItemsCount
...
Enter the expected count.
...
No
...
String
Example:
VerifyListItemCount "5"
VerifyListItemMemberCount
This action verifies the list item member count with the expected specified count.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
expectedListItemMembersCount
...
Enter the expected count.
...
Yes
...
String
Example:
VerifyListItemMemberCount "5"
VerifyText
This action verifies the actual data of the specified location matches with the expected data.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
data
...
Enter the data which you want to verify (case-sensitive).
...
Yes
...
String
...
listItemIndex
...
Enter the list item index from which you want to verify the data.
...
Yes
...
String
...
listItemMemberIndex
...
Enter the list item member index from which you want to verify the data.
...
No
...
String
Example:
VerifyText "Qualitia" "3" "1"
WaitForObject (Deprecated)
This action waits for the object to appear or disappear for the maximum number of seconds specified.
If the object is found or not found before the maximum time specified, execution continues to the next steps.
If the wait time is "" then the wait time shall be the "Sync Time" set under the associated execution profile.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Timeout
...
Enter the number of seconds to wait for the object to appear or disappear. This has to be 0 or any positive number.
...
No
...
String
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check for the appearance of the object.
Set False if you want to check for the disappearance of the object.
...
No
...
String
Example:
WaitForObject "10" "True"
The action waits for maximum 10 seconds for the object to appear. If the object appears before 10 seconds elapses, execution continues to the next steps.
WaitForObject "15" "False"
The action shall wait for maximum 15 seconds for the object to disappear. If the object disappears before 15 seconds elapses, the execution continues to the next steps.
MobileText Actions
ClearText
This action clears the text present in the specified MobileEdit box.
This action does not have any parameter.
Example:
ClearText
Click
This action clicks the specified object.
This action does not have any parameter.
Example:
Click
LongPress
This action performs the long press event on the specified object.
This action does not have any parameter.
Example:
LongPress
SecureSet
This action enters the value into the specified MobileEdit box. When you remove the mouse from the parameter in Test Case Editor screen, the value is displayed in the encrypted format.
Input Parameters:
...
Paramters Name
...
Parameter Description
...
Mandatory
...
String
...
Text
...
Enter the test that needs to be entered in the specified text box in the specified format.
Format: Encrypt(<TEXT TO BE ADDED>)
...
Yes
...
String
Example:
SecureSet "Encrypt(Abc)". When you remove mouse from the parameter in Test Case Editor screen, you will view the data ABC as encrypted form such as "vHpmlfI4R3PQkCN4sZnuqw==þNWE3ZDdkNjE3N2JmNDM2ODgxMzQwYWI1MTA3YWNjMDc="
Set
This action sets the text into mobile text box object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Value
...
Enter the value you want to add into specified mobile text box.
...
No
...
String
Example:
Set "Qualitia"
On this page:
Table of Contents | ||||
---|---|---|---|---|
|
StoreExistence
This action stores existence of the object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the existence's Boolean value will be stored.
Stores True if the object exists.
Stores False if the object does not exist.
...
Yes
...
String
Example:
StoreExistence "Key"
StorePropertyValue
This action stores the property of the specified object under the key name. The stored key value can be retrieved using the key name.
Some Android and iOS properties are not accessible.
List of accessible properties for Android: "name", "contentDescription", "className", "resourceId", "text", "enabled", "checkable", "checked", "clickable", "focusable", "focused", "longClickable", "scrollable", "selected", "displayed"
List of accessible properties for iOS: "name", "value", "label", "hint"
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the property value will be stored.
...
Yes
...
String
...
Property
...
Property/attribute name whose value needs to be stored under the specified key. This can be any accessible property of Android/iOS native object mentioned above.
...
Yes
...
String
Example:
StorePropertyValue "key" "text"
StoreText
This action reads the existing text available in mobile text box and stores it into the specified key.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which you want to store the text.
...
Yes
...
String
Example:
StoreText "Key"
StoreVisibility
This action stores visibility of the object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
strKey
...
The visibility value for the object is stored as:
True denotes the object is visible
False denotes the object is not visible
...
No
...
String
Example:
StoreVisibilty "Key"
Swipe
This action performs swipe and finds object until timeout occurs.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
upDownLeftRight
...
Enter the direction of swipe:
Up: Move finger from down to up on the device screen.
Down: Move finger from up to down on the device screen.
Left: Move finger from right to left on the device screen.
Right: Move finger from left to right on the device screen.
...
No
...
String
...
timeoutInSeconds
...
Enter the timeout in seconds.
...
No
...
String
...
swipePageInSeconds
...
Enter in how many seconds one page should be swiped. Default is 1 second.
Use this parameter with caution only when control on swipe speed is required.
...
No
...
String
Example:
Swipe "up" "10" "1"
VerifyEnability
This action verifies the enability of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
enability
...
Value for this parameter can be True or False.
Set True if you want to verify that the object is enabled.
Set False if you want to verify that the object is disabled.
Note: If you do not enter any value, the default value is set to True during the test case execution.
...
No
...
String
Example:
VerifyEnability "True"
VerifyExistence
This action verifies the existence of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check the existence.
Set False if you want to check the non-existence.
...
No
...
String
Example:
VerifyExistence "True"
WaitForObject
This action waits for the object to appear or disappear for the maximum number of seconds specified.
If the object is found or not found before the maximum time specified, execution continues to the next steps.
If the wait time is "" then the wait time shall be the "Sync Time" set under the associated execution profile.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Timeout
...
Enter the number of seconds to wait for the object to appear or disappear. This has to be 0 or any positive number.
...
No
...
String
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check for the appearance of the object.
Set False if you want to check for the disappearance of the object.
...
No
...
String
Example:
WaitForObject "10" "True"
The action waits for maximum 10 seconds for the object to appear. If the object appears before 10 seconds elapses, execution continues to the next steps.
WaitForObject "15" "False"
The action shall wait for maximum 15 seconds for the object to disappear. If the object disappears before 15 seconds elapses, the execution continues to the next steps.
MobileRadioButton Actions
Note |
---|
These actions are available when working with the Android application testing only. |
Click
This action clicks the specified object.
This action does not have any parameter.
Example:
Click
IsSelected
This action verifies whether the radio button is selected or deselected.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
State
...
Value of this parameter can be either True or False.
Set True if you want to check that the radio button is selected.
Set False if you want to check that the radio button is deselected.
...
No
...
String
If radio button is selected and state is "True", result is success. If radio button is selected and state is "False" result is failure.
If radio button is not selected and state is "True", result is failure. If radio button is not selected and state is "False" result is success.
Example:
IsSelected "True"
LongPress
This action performs the long press event on the specified object.
This action does not have any parameter.
Example:
LongPress
Select
This action selects the specified radio button.
This action does not have any parameter.
Example:
Select
On this page:
Table of Contents | ||||
---|---|---|---|---|
|
SelectByIndex
This action selects the specified radio button based on its index number. The index starts from 1. This action should be used only when radio button is part of a radio-group and group has a valid resource ID on Android.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
groupName
...
Enter the resource ID of the radio group.
...
Yes
...
String
...
Index
...
Enter the index of the radio button in the radio group. Index starts at 1.
...
No
...
String
Example:
SelectByIndex "com.sample.app:id/radiogroup1" "2"
SelectIfTrue
This action selects the radio button if parameter passed is TRUE.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Select
...
Value of this parameter can be True or False.
Set True if you want to select the radio button.
Set False if you do not want to select the radio button.
...
No
...
String
Example:
SelectIfTrue "True"
StoreExistence
This action stores existence of the object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the existence's Boolean value will be stored.
Stores True if the object exists.
Stores False if the object does not exist.
...
Yes
...
String
Example:
StoreExistence "Key"
StorePropertyValue
This action stores the property of the specified object under the key name. The stored key value can be retrieved using the key name.
Some Android and iOS properties are not accessible.
List of accessible properties for Android: "name", "contentDescription", "className", "resourceId", "text", "enabled", "checkable", "checked", "clickable", "focusable", "focused", "longClickable", "scrollable", "selected", "displayed"
List of accessible properties for iOS: "name", "value", "label", "hint"
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Key
...
Enter the key name under which the property value will be stored.
...
Yes
...
String
...
Property
...
Property/attribute name whose value needs to be stored under the specified key. This can be any accessible property of Android/iOS native object mentioned above.
...
Yes
...
String
Example:
StorePropertyValue "key" "text"
StoreVisibility
This action stores visibility of the mobile object under the specified key. The key value can be retrieved using the key name.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
strKey
...
The visibility value for the mobile object is stored as:
True denotes the object is visible
False denotes the object is not visible
...
No
...
String
Example:
StoreVisibility "Key"
Swipe
This action performs swipe and finds object until timeout occurs.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
upDownLeftRight
...
Enter the direction of swipe:
Up: Move finger from down to up on the device screen.
Down: Move finger from up to down on the device screen.
Left: Move finger from right to left on the device screen.
Right: Move finger from left to right on the device screen.
...
No
...
String
...
timeoutInSeconds
...
Enter the timeout in seconds.
...
No
...
String
...
swipePageInSeconds
...
Enter in how many seconds one page should be swiped. Default is 1 second.
Use this parameter with caution only when control on swipe speed is required.
...
No
...
String
Example:
Swipe "up" "10" "1"
VerifyEnability
This action verifies the enability of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
enability
...
Value for this parameter can be True or False.
Set True if you want to verify that the object is enabled.
Set False if you want to verify that the object is disabled.
Note: If you do not enter any value, the default value is set to True during the test case execution.
...
No
...
String
Example:
VerifyEnability "True"
VerifyExistence
This action verifies the existence of the specified object.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check the existence.
Set False if you want to check the non-existence.
...
No
...
String
Example:
VerifyExistence "True"
WaitForObject
This action waits for the object to appear or disappear for the maximum number of seconds specified.
If the object is found or not found before the maximum time specified, execution continues to the next steps.
If the wait time is "" then the wait time shall be the "Sync Time" set under the associated execution profile.
Input Parameters:
...
Parameter Name
...
Parameter Description
...
Mandatory
...
Data Type
...
Timeout
...
Enter the number of seconds to wait for the object to appear or disappear. This has to be 0 or any positive number.
...
No
...
String
...
existence
...
Value for this parameter can be True or False.
Set True if you want to check for the appearance of the object.
Set False if you want to check for the disappearance of the object.
...
No
...
String
Example:
WaitForObject "10" "true"
The action waits for maximum 10 seconds for the object to appear. If the object appears before 10 seconds elapses, execution continues to the next steps.
WaitForObject "15" "False"
...