Versions Compared

Old Version 48

changes.mady.by.user Sagar Dubewar

Saved on

compared with

New Version Current

changes.mady.by.user Sagar Dubewar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General

Mobile.OpenApp

This action launches native mobile Android or iOS application on the device (emulator or physical). If the app does not already exist on 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.

If this parameter is specified, the Package and Activity Name or Bundle ID need not be specified.

No

String

Android Package / iOS BundleID

Package name of the Android app or bundle ID of the iOS app

No

String

Android Activity

Activity name of the Android app (Only Applicable to Android. It will get ignored for iOS if specified)

No (for Android)

String


Example:

Mobile.OpenApp                         "D:\myapp.apk"

Mobile.OpenApp                         "com.app.package"                  "com.app.package.MainActivity"

Mobile.CloseApp

This action closes the specified application or mobile browser.

This action does not have any input parameters.

Example:
Mobile.CloseApp

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", "Mobile"

Yes

 String


Example:

SwitchWebExecutionPlatform                        "Mobile"

Mobile.PressBackButton

This action taps back button on the Mobile device. This action is supported for Android only. For iOS try using the Swipe action on required object(s).

This action does not have any input parameters.

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:

Parameter Name

Parameter Description

Mandatory

Data Type

key

Enter the key in which the webview handle will be stored.

Yes

String


Example:
Mobile.StoreWebViewHandle                       "Key"

Table of ContentsmaxLevel2

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


Example:
Mobile.SelectWebView             "Key"

Mobile.SelectNativeContext

This action can be used to select native context in the hybrid app. 

This action does not have any input parameters.

Example:
Mobile.SelectNativeContext

Mobile.SelectWebViewUsingURL

This action selects the web view using the URL or pattern specified in the parameters.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

URL

Enter the URL to be opened.

Yes

String

URL Pattern

Specify whether the URL is patterned or not.
Value of this parameter can be true or false.

NoBoolean

Example:

Mobile.SelectWebviewUsingURL                      "www.google.com"                    "False"

Table of Contents
maxLevel2

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.

NoString


Example:
Mobile.PressKeys                       "KEYCODE_F"

Mobile.PressKeys                       "KEYCODE_CTRL_LEFT"

Anchor
Mobile.HideKeyboard
Mobile.HideKeyboard
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:

Parameter Name

Parameter Description

Mandatory

Data Type

Strategy

Enter the strategy to hide the keyboard. Value for this parameter can be PRESS_KEY and TAP_OUTSIDE.

Yes

String

KeyNameIt is the text displayed on the button of the keyboard you want to press to hide keyboard.YesString


Example:
Mobile.HideKeyboard                       "Tap_Outside"         "Done"

Anchor
MobileButton
MobileButton
MobileButton

Anchor
_Toc472359868
_Toc472359868
Click

This action clicks the specified object.

This action does not have any input parameters. 

Example:

Click

Anchor
_Toc472359869
_Toc472359869
LongPress

This action performs the long press event on the specified object. 

This action does not have any input parameters.

Example:
LongPress

Anchor
_Toc472359870
_Toc472359870
Swipe

This action performs swipe and finds object until timeout occurs.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

upDownLeftRight

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 to perform swipe.

No

String

swipePageInSeconds

Enter in how many seconds one page should be swiped. Default is 1 second.

Note: Use this parameter with caution only when control on swipe speed is required.

No

String


Example:
Swipe                  "up"                   "10"             "1"

Anchor
_Toc472359871
_Toc472359871
StoreExistence

This action stores existence of the specified object under the given key.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

The variable in which the existence (true/false) of the object is stored.

Yes

 String


Example:
StoreExistence                          "key"

Anchor
StorePropertyValue
StorePropertyValue
StorePropertyValue

This action stores the property of the specified object under the key name. The stored 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", "type", "visible", "label", "enabled", "accessible", "rect", "frame", "accessibilityContainer", "wdName", "wdValue", "wdType", "wdVisible", "wdLabel", "wdEnabled", "wdAccessible", "wdRect", "wdFrame", "wdAccessibilityContainer"

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

Variable in which the property value will be stored

Yes

 String

Property

Property/attribute name whose value needs to be stored in "Key". This can be any accessible property of Android/iOS native object.

Yes

 String


Example:
StorePropertyValue                            "key"                     "text"

Anchor
VerifyEnability
VerifyEnability
VerifyEnability

This action verifies the enability of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object is enabled
If False – checks if the object is disabled

No

String

Example:
VerifyEnability                          "TRUE"

Anchor
VerifyExistence
VerifyExistence
VerifyExistence

Verifies whether a button object exists or does not exist.
Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Existence

Value of this parameter can be true or false.
If True – checks if the object exists.
If False – checks that the object does not exist.

No

String


Example:
VerifyExistence                        "TRUE"

Anchor
WaitForObject
WaitForObject
WaitForObject

This action waits for the object to appear for maximum number of seconds specified. If the object is found or not found before the maximum time specified, the keyword stops waiting.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

timeOut

The maximum no of seconds to wait to check for the object existence or otherwise. This has to be 0 or a positive integer value.

No

String

Existence

String value to specify whether to check for existence or non-existence. TRUE – check for existence, FALSE – check for non-existence

No

String


Example:
WaitForObject                               "15"                    "TRUE"

Anchor
_Toc472359876
_Toc472359876
MobileElement

Anchor
_Toc472359877
_Toc472359877
Click

This action clicks the specified object.

This action does not have any input parameters. 

Example:

Click


Anchor
_Toc472359878
_Toc472359878
LongPress

This action performs the long press event on the specified object. 

This action does not have any input parameters.

Example:
LongPress

Anchor
_Toc472359879
_Toc472359879
Swipe

This action performs swipe and finds object until timeout occurs.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

upDownLeftRight

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 to perform swipe.

No

String

swipePageInSeconds

Enter in how many seconds one page should be swiped. Default is 1 second.

Note: Use this parameter with caution only when control on swipe speed is required.

No

String


Example:
Swipe                  "up"                   "10"             "1"

Anchor
_Toc472359880
_Toc472359880
StoreExistence

This action stores existence of the specified object under the given key.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

The variable in which the existence (true/false) of the object is stored.

Yes

 String


Example:
StoreExistence                          "key"

Anchor
_Toc472359881
_Toc472359881
StorePropertyValue

This action stores the property of the specified object under the key name. The stored 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", "type", "visible", "label", "enabled", "accessible", "rect", "frame", "accessibilityContainer", "wdName", "wdValue", "wdType", "wdVisible", "wdLabel", "wdEnabled", "wdAccessible", "wdRect", "wdFrame", "wdAccessibilityContainer"

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

Variable in which the property value will be stored

Yes

 String

Property

Property/attribute name whose value needs to be stored in "Key". This can be any accessible property of Android/iOS native object.

Yes

 String


Example:
StorePropertyValue                            "key"                     "text"

Anchor
_Toc472359882
_Toc472359882
VerifyEnability

This action verifies the enability of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object is enabled
If False – checks if the object is disabled

No

String

Example:
VerifyEnability                          "TRUE"


Anchor
_Toc472359883
_Toc472359883
VerifyExistence

This action verifies the existence of the specified object.

Input Parameters:

Parameter Name

Parameter Description

Is Mandatory

Data Type

Existence

Value of this parameter can be true or false.
If True – checks if the object exists.
If False – checks that the object does not exist.

No

String

Example:
VerifyExistence                        "TRUE"


Anchor
_Toc472359884
_Toc472359884
WaitForObject

This action waits for the object to appear for maximum number of seconds specified. If the object is found or not found before the maximum time specified, the keyword stops waiting.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

timeOut

The maximum no of seconds to wait to check for the object existence or otherwise. This has to be 0 or a positive integer value.

No

String

Existence

String value to specify whether to check for existence or non-existence. TRUE – check for existence, FALSE – check for non-existence

No

String


Example:
WaitForObject                               "15"                    "TRUE"

Anchor
_Toc472359885
_Toc472359885
MobileText

Anchor
Set
Set
Set

This action sets the text into mobile text box object.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Value

Value to be entered into specified mobile text box object.

No

String

Example:

Set                 "Qualitia"

Anchor
StoreText
StoreText
StoreText

This action reads the existing text available in mobile text box and stores it into a variable.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

Variable in which the text needs to be stored

Yes

 String


Example:

StoreText               "Key"

Anchor
Click
Click
Click

This action clicks the specified object.

This action does not have any input parameters. 

Example:

Click

Anchor
LongPress
LongPress
LongPress

This action performs the long press event on the specified object. 

This action does not have any input parameters.

Example:
LongPress


Anchor
_Toc472359890
_Toc472359890
Swipe

This action performs swipe and finds object until timeout occurs.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

upDownLeftRight

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 to perform swipe.

No

String

swipePageInSeconds

Enter in how many seconds one page should be swiped. Default is 1 second.

Note: Use this parameter with caution only when control on swipe speed is required.

No

String


Example:
Swipe                  "up"                   "10"             "1"

Anchor
StoreExistence
StoreExistence
StoreExistence

This action stores existence of the specified object under the given key.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

The variable in which the existence (true/false) of the object is stored.

Yes

 String


Example:
StoreExistence                          "key"

Anchor
StorePropertyValue
StorePropertyValue
StorePropertyValue

This action stores the property of the specified object under the key name. The stored 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", "type", "visible", "label", "enabled", "accessible", "rect", "frame", "accessibilityContainer", "wdName", "wdValue", "wdType", "wdVisible", "wdLabel", "wdEnabled", "wdAccessible", "wdRect", "wdFrame", "wdAccessibilityContainer"

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

Variable in which the property value will be stored

Yes

 String

Property

Property/attribute name whose value needs to be stored in "Key". This can be any accessible property of Android/iOS native object.

Yes

 String


Example:
StorePropertyValue                            "key"                     "text"

Anchor
_Toc472359893
_Toc472359893
VerifyEnability

This action verifies the enability of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object is enabled
If False – checks if the object is disabled

No

String

Example:
VerifyEnability                          "TRUE"


Anchor
_Toc472359894
_Toc472359894
VerifyExistence

Verifies whether a button object exists or does not exist.
Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Existence

Value of this parameter can be true or false.
If True – checks if the object exists.
If False – checks that the object does not exist.

Yes

String


Example:
VerifyExistence                        "TRUE"


Anchor
_Toc472359895
_Toc472359895
WaitForObject

This action waits for the object to appear for maximum number of seconds specified. If the object is found or not found before the maximum time specified, the keyword stops waiting.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

timeOut

The maximum no of seconds to wait to check for the object existence or otherwise. This has to be 0 or a positive integer value.

No

String

Existence

String value to specify whether to check for existence or non-existence. TRUE – check for existence, FALSE – check for non-existence

No

String


Example:
WaitForObject                               "15"                    "TRUE"

Anchor
_Toc472359896
_Toc472359896
MobileCheckbox

Anchor
Check
Check
Check

This action selects the specified check box.

This action does not have any parameter.

Example:

Check

Anchor
UnCheck
UnCheck
Uncheck

This action deselects the specified check box.

This action does not have any parameter.

Example:

UnCheck

Anchor
IsChecked
IsChecked
IsChecked

This action verifies that the specified check box is selected. 

If a checkbox is checked and parameter "state" is "true", result is success. If checkbox is checked and parameter "state" is "false" result is Failure.
If checkbox is un-checked and parameter "state" is "true", result is Failure. If checkbox is un-checked and parameter "state" is "false" result is success.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

state

Value of this parameter can be true or false.
If True – verifies if the checkbox is checked.
If False – verifies if the checkbox is unchecked.

Yes

TRUE

Example:

IsChecked               "TRUE"

Anchor
CheckIfTrue
CheckIfTrue
CheckIfTrue

This action selects the checkbox, 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.
If True – selects the checkbox.
If False – Does not select the checkbox.

No

TRUE

Example:

CheckIfTrue           "TRUE"

Anchor
_Toc472359901
_Toc472359901
Click

This action clicks the specified object.

This action does not have any input parameters. 

Example:

Click


Anchor
_Toc472359902
_Toc472359902
LongPress

This action performs the long press event on the specified object. 

This action does not have any input parameters.

Example:
LongPress


Anchor
_Toc472359903
_Toc472359903
Swipe

This action performs swipe and finds object until timeout occurs.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

upDownLeftRight

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 to perform swipe.

No

String

swipePageInSeconds

Enter in how many seconds one page should be swiped. Default is 1 second.

Note: Use this parameter with caution only when control on swipe speed is required.

No

String


Example:
Swipe                  "up"                   "10"             "1"


Anchor
_Toc472359904
_Toc472359904
StoreExistence

This action stores existence of the specified object under the given key.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

The variable in which the existence (true/false) of the object is stored.

Yes

 String


Example:
StoreExistence                          "key"


Anchor
_Toc472359905
_Toc472359905
StorePropertyValue

This action stores the property of the specified object under the key name. The stored 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", "type", "visible", "label", "enabled", "accessible", "rect", "frame", "accessibilityContainer", "wdName", "wdValue", "wdType", "wdVisible", "wdLabel", "wdEnabled", "wdAccessible", "wdRect", "wdFrame", "wdAccessibilityContainer"

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

Variable in which the property value will be stored

Yes

 String

Property

Property/attribute name whose value needs to be stored in "Key". This can be any accessible property of Android/iOS native object.

Yes

 String


Example:
StorePropertyValue                            "key"                     "text"


Anchor
_Toc472359906
_Toc472359906
VerifyEnability

This action verifies the enability of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object is enabled
If False – checks if the object is disabled

No

String

Example:
VerifyEnability                          "TRUE"

Anchor
_Toc472359907
_Toc472359907
VerifyExistence

This action verifies the existence of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Existence

Value of this parameter can be true or false.
If True – checks if the object exists.
If False – checks that the object does not exist.

No

String


Example:
VerifyExistence                        "TRUE"

Anchor
_Toc472359908
_Toc472359908
WaitForObject

This action waits for the object to appear for maximum number of seconds specified. If the object is found or not found before the maximum time specified, the keyword stops waiting.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

timeOut

The maximum no of seconds to wait to check for the object existence or otherwise. This has to be 0 or a positive integer value.

No

String

Existence

String value to specify whether to check for existence or non-existence. TRUE – check for existence, FALSE – check for non-existence

No

String


Example:
WaitForObject                               "15"                    "TRUE"

Anchor
_Toc472359909
_Toc472359909
MobileDropDown (Android Only)

Anchor
_Toc472359910
_Toc472359910
SelectItemByName

This action selects the specified item from the MobileDropDown. The parameter value specified here is case-sensitive. 

Note: Items present in the drop-down must have a 'text' property.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

itemName

Enter the itemnname to be selected from the list.

Yes

 String


Example:
SelectItemByName             "Qualitia"

Anchor
_Toc472359911
_Toc472359911
Click

This action clicks the specified object.

This action does not have any input parameters. 

Example:

Click


Anchor
_Toc472359912
_Toc472359912
LongPress

This action performs the long press event on the specified object. 

This action does not have any input parameters.

Example:
LongPress

Anchor
_Toc472359913
_Toc472359913
Swipe

This action performs swipe and finds object until timeout occurs.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

upDownLeftRight

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 to perform swipe.

No

String

swipePageInSeconds

Enter in how many seconds one page should be swiped. Default is 1 second.

Note: Use this parameter with caution only when control on swipe speed is required.

No

String


Example:
Swipe                  "up"                   "10"             "1"

Anchor
_Toc472359914
_Toc472359914
StoreExistence

This action stores existence of the specified object under the given key.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

The variable in which the existence (true/false) of the object is stored.

Yes

 String


Example:
StoreExistence                          "key"

Anchor
_Toc472359915
_Toc472359915
StorePropertyValue

This action stores the property of the specified object under the key name. The stored 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", "type", "visible", "label", "enabled", "accessible", "rect", "frame", "accessibilityContainer", "wdName", "wdValue", "wdType", "wdVisible", "wdLabel", "wdEnabled", "wdAccessible", "wdRect", "wdFrame", "wdAccessibilityContainer"

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

Variable in which the property value will be stored

Yes

 String

Property

Property/attribute name whose value needs to be stored in "Key". This can be any accessible property of Android/iOS native object.

Yes

 String


Example:
StorePropertyValue                            "key"                     "text"

Anchor
_Toc472359916
_Toc472359916
VerifyEnability

This action verifies the enability of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object is enabled
If False – checks if the object is disabled

No

String

Example:
VerifyEnability                          "TRUE"


Anchor
_Toc472359917
_Toc472359917
VerifyExistence

This action verifies the existence of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object exists
If False – checks that object does not exist

No

String

Example:
VerifyExistence                          "TRUE"

Anchor
_Toc472359918
_Toc472359918
WaitForObject

This action waits for the object to appear for maximum number of seconds specified. If the object is found or not found before the maximum time specified, the keyword stops waiting.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

timeOut

The maximum no of seconds to wait to check for the object existence or otherwise. This has to be 0 or a positive integer value.

Yes

String

Existence

String value to specify whether to check for existence or non-existence.

If TRUE – checks for existence

If FALSE – check for non-existence

Yes

String

Example:
WaitForObject                               "15"                    "TRUE"


Anchor
_Toc472359919
_Toc472359919
MobileRadioButton (Android Only)

Anchor
_Toc472359920
_Toc472359920
Select

This action selects the specified radio button.

This action does not have any input parameters. 

Example:

Select

Anchor
_Toc472359921
_Toc472359921
SelectByIndex

This action selects the specified radio button based on its index number. The indexes start from 1. This action is to 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

Resource ID of the radio group

Yes

 String

Index

Index of the radio button in the radio group. Index starts at 1

No

String

Example:

SelectByIndex              "com.sample.app:id/radiogroup1"         "2"

Anchor
_Toc472359922
_Toc472359922
IsSelected

This action verifies whether the radio button is selected or deselected.

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.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

State

Value of this parameter can be true or false.
If True – checks if the radio button is selected
If False – checks if the radio button is not selected

No

String

Example:
IsSelected                    "TRUE"

Anchor
_Toc472359923
_Toc472359923
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.
If True – Selects the radio button
If False – Does not select the radio button

No

String

Example:
SelectIfTrue                        "TRUE"

Anchor
_Toc472359924
_Toc472359924
Click

This action clicks the specified object.

This action does not have any input parameters. 

Example:

Click

Anchor
_Toc472359925
_Toc472359925
LongPress

This action performs the long press event on the specified object. 

This action does not have any input parameters.

Example:
LongPress

Anchor
_Toc472359926
_Toc472359926
Swipe

This action performs swipe and finds object until timeout occurs.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

upDownLeftRight

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 to perform swipe.

No

String

swipePageInSeconds

Enter in how many seconds one page should be swiped. Default is 1 second.

Note: Use this parameter with caution only when control on swipe speed is required.

No

String


Example:
Swipe                  "up"                   "10"             "1"

Anchor
_Toc472359927
_Toc472359927
StoreExistence

This action stores existence of the specified object under the given key.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

The variable in which the existence (true/false) of the object is stored.

Yes

 String


Example:
StoreExistence                          "key"

Anchor
_Toc472359928
_Toc472359928
StorePropertyValue

This action stores the property of the specified object under the key name. The stored 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", "type", "visible", "label", "enabled", "accessible", "rect", "frame", "accessibilityContainer", "wdName", "wdValue", "wdType", "wdVisible", "wdLabel", "wdEnabled", "wdAccessible", "wdRect", "wdFrame", "wdAccessibilityContainer"

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

Variable in which the property value will be stored

Yes

 String

Property

Property/attribute name whose value needs to be stored in "Key". This can be any accessible property of Android/iOS native object.

Yes

 String


Example:
StorePropertyValue                            "key"                     "text"

Anchor
_Toc472359929
_Toc472359929
VerifyEnability

This verifies the enability of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object is enabled
If False – checks if the object is disabled

No

String


Example:
VerifyEnability                          "TRUE"

Anchor
_Toc472359930
_Toc472359930
VerifyExistence

This verifies the existence of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object exists.
If False – checks that the object does not exist.

No

String


Example:
VerifyExistence                          "TRUE"

Anchor
_Toc472359931
_Toc472359931
WaitForObject

This action waits for the object to appear for maximum number of seconds specified. If the object is found or not found before the maximum time specified, the keyword stops waiting.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

timeOut

The maximum no of seconds to wait to check for the object existence or otherwise. This has to be 0 or a positive integer value.

Yes

String

Existence

String value to specify whether to check for existence or non-existence.
TRUE – check for existence,
FALSE – check for non-existence

Yes

String

Example:

WaitForObject                               "15"                    "TRUE"

Anchor
_Toc472359932
_Toc472359932
Anchor
_GoBack
_GoBack
MobileList

Anchor
_Toc472359933
_Toc472359933
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 to be selected. It starts at 1.

Yes

 String

listItemMemberIndex

Enter the list item member from the list to be selected. It starts at 1.

Yes

String 

Example:
ClickElement                      "3"                    "2" 

Anchor
_Toc472359934
_Toc472359934
VerifyText

This action verifies the actual data of the specified location with the expected data.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

data

Data which is to be verified (case-sensitive).

Yes

 String

listItemIndex

Enter the list item index from which the data is to be verified.

Yes

 String

listItemMemberIndex

Enter the list item member index from which the data is to be verified.

Yes

 String

Example:
VerifyText                     "Qualitia"              "3"                "1" 

Anchor
_Toc472359935
_Toc472359935
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

The variable name to store the list's count.

Yes

String

Example:

StoreListItemMembersCount                       "Key"

DeSelectCheckboxAtListItemMember

This action deselects the checkbox present at given list item index and list item member 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

listItemMemberIndexEnter the list item member index from where check box is to be deselected.YesString

Example: 

DeSelectCheckboxAtListItemMemberIndex                             "3"             "7"

VerifyListItemCount

This action verifies the total count of items present in the list with the expected specified count.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

expectedListItemsCount

Enter the expected count.

Yes

String

Example:

VerifyListItemCount               "5"

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

KeyEnter the key in which the list item index will be saved.YesString

listItemMemberIndex

Enter the list item member index in which the data is to be checked.

Yes

String

Example:

StoreListItemIndexContainingMinValue             "Key"             "1"

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

KeyEnter the key in which the list item index will be saved.YesString

listItemMemberIndex

Enter the list item member index in which the data is to be checked.

Yes

String

Example:

StoreListItemIndexContainingMaxValue             "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

KeyEnter the key in which the list item index will be saved.YesString
textToVerifyEnter the text to be verified.YesString

listItemMemberIndex

Enter the list item member index in which the data is to be checked.

Yes

String

Example:

StoreListItemIndexContainingText             "Key"              "Qualitia"              "1"

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 with which data is to be compared.

Yes

String

expectedListItemMembersDataEnter the expected data to be verified.YesArray

Example:

CompareListItemData             "2"              "Qualitia^QTP^WebDriver" 

StoreExistence

This action stores existence of the specified object under the given key.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

The variable in which the existence (true/false) of the object is stored.

Yes

 String


Example:
StoreExistence                          "key"

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"

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

listItemMemberIndexEnter the list item member index where existence is to be verified.YesString

expectedListItemMembersData

Enter the expected data separated by carrot. You can provide one or more expected strings.

Yes

Array

existenceEnter the expected existence of the data (true or false).YesString

Example:

VerifyDataExistenceInListItemMembers               "5"                  "49"              "True"

VerifyDataExistenceInListItemMembers               "5"                  "Qualitia^6"              "False"

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

listItemIndexEnter the list item index where existence is to be verified.YesString

expectedListItemsData

Enter the expected data separated by carrot. You can provide one or more expected strings.

Yes

Array

existenceEnter the expected existence of the data (true or false).
YesString

Example:

VerifyDataExistenceInListItem                     "7"                  "40"              "True"

VerifyDataExistenceInListItem                     "7"                  "Zensoft^9"              "True"

SelectCheckboxAtListItemMember

This action selects the check box present in the specified list item member. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

listItemIndexEnter the list item index where the check box is to be selected.YesString
listItemMemberIndexEnter the list item member index where the check box is to be selected. YesString

Example:

SelectCheckboxatListItemMember                     "5"           "4"

Anchor
_Toc472359928
_Toc472359928
StorePropertyValue

This action stores the property of the specified object under the key name. The stored 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", "type", "visible", "label", "enabled", "accessible", "rect", "frame", "accessibilityContainer", "wdName", "wdValue", "wdType", "wdVisible", "wdLabel", "wdEnabled", "wdAccessible", "wdRect", "wdFrame", "wdAccessibilityContainer".

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

Key

Variable in which the property value will be stored

Yes

 String

Property

Property/attribute name whose value needs to be stored in "Key". This can be any accessible property of Android/iOS native object.

Yes

 String

Example:
StorePropertyValue                            "key"                     "text"

Anchor
_Toc472359929
_Toc472359929
VerifyEnability

This verifies the enability of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object is enabled
If False – checks if the object is disabled

Yes

String


Example:
VerifyEnability                          "TRUE"

Anchor
_Toc472359930
_Toc472359930
VerifyExistence

This verifies the existence of the specified object. 

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

enability

Value of this parameter can be true or false.
If True – checks if the object exists.
If False – checks that the object does not exist.

Yes

String


Example:
VerifyExistence                          "TRUE"

Anchor
_Toc472359931
_Toc472359931
WaitForObject

This action waits for the object to appear for maximum number of seconds specified. If the object is found or not found before the maximum time specified, the keyword stops waiting.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

timeOut

The maximum no of seconds to wait to check for the object existence or otherwise. This has to be 0 or a positive integer value.

Yes

String

Existence

String value to specify whether to check for existence or non-existence. TRUE – check for existence, FALSE – check for non-existence

Yes

String

Example:

WaitForObject                               "15"                    "TRUE"

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

textArrayToVerifyEnter the text array to be verified. YesArray
listItemMemberIndexEnter the list item member from where the text is to be taken. YesString

Example:

StoreListItemIndexContainingTextInArray                 "Key"               "d^f"                 "3"

Swipe

This action performs swipe and finds object until timeout occurs.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

upDownLeftRight

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 to perform swipe.

No

String

swipePageInSeconds

Enter in how many seconds one page should be swiped. Default is 1 second.

Note: Use this parameter with caution only when control on swipe speed is required.

No

String

Example:
Swipe                  "up"                   "10"             "1"

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 the item count will be stored.

Yes

String

Example:

StoreListItemCount                  "Key" 

Click

This action clicks the specified object.

This action does not have any input parameters. 

Example:

Click

LongPress

This action performs the long press event on the specified object. 

This action does not have any input parameters.

Example:

LongPress