Document toolboxDocument toolbox

MobileList Actions

Owned by Dhiraj Chandanshive (Unlicensed)
Last updated: Apr 08, 2022
8 min read



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:

  • The MobileList control action is used only when a tree having multiple children at level 1 and there is only one child from level 2 to level n.

  • The MobileList control action doesn't support addressing the intermediate elements. Hence, you can use only when you want to address the leaf node/element.

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"

DeSelectCheckboxAtListItemMember

This action deselects the check box present at given list item index.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

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

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

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

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

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

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

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


Example:

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

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


Example:

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

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

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

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

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

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

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

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

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

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

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

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.

Note:

  • For the WaitFor actions to complete successfully, the specified object must exist.

  • Only for all the Wait actions, you can override the actual execution result with that of your choice using the statusIfConditionNotSatisfied parameter. For example, if you set the statusIfConditionNotSatisfied parameter to Pass, the action execution result will always be Pass, irrespective of whether the actual execution result was Fail or Defect.

Input Parameters:



Parameter Name

Parameter Description

Mandatory

Data Type

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.