Document toolboxDocument toolbox

MobileCheckbox Actions

Owned by ravi.chandran (Unlicensed)
Last updated: Feb 24, 2021
4 min read

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:

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
NoString

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 (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 Configuration Settings (Execution) window.

Input Parameters:

Parameter Name

Parameter Description

Mandatory

Data Type

waitTime

Enter the number of seconds to wait for the object to appear or disappear. This has to be 0 or any positive number.

Yes

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.

Yes

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,execution continues to the next steps.