WaitElement Method (Mobile Objects)

Applies to TestComplete 15.0, last modified on October 14, 2021

Description

Use the WaitElement method to delay the test run until the specified mobile object becomes available to TestComplete.

Requirements

  • An active license for TestComplete Mobile Module.

  • The Appium Support plugin must be enabled in TestComplete. You can check the plugin state in the File > Install Extensions dialog in TestComplete. You can find the plugin in the Mobile group.

  • Your TestComplete workstation must have access to the mobile device cloud.

  • Your tested mobile application must be compiled with accessibility information. To learn more, see the documentation for the IDE you use to develop your application.

  • A testing session must be opened on your mobile device, and your test must have access to that session. See Connecting to Mobile Device Clouds and Opening Testing Sessions.

Declaration

TestObj.WaitElement(LocationStrategy, SelectorValue, Timeout)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
LocationStrategy [in]    Required    String    
SelectorValue [in]    Required    String    
Timeout [in]    Optional    Integer Default value: -1   
Result A mobile object or a null object

Applies To

The method is applied to the following object:

View Mode

To view this method in the Object Browser panel and in other panels and dialogs, activate the Advanced view mode.

Parameters

The method has the following parameters:

LocationStrategy

A string that specifies the locator strategy the method will use to search for the object. The string value depends on the driver you use to open the testing session on your mobile device. See the Selector Strategies section in the Appium documentation.

SelectorValue

A string that specifies the search condition. Depending on the LocationStrategy it can be an XPath expression, an ID, Accessibility ID, or class of the sought-for objects specified in the application source code.

Timeout

The number of milliseconds to wait until the specified object becomes available. If Timeout is 0, the method returns immediately. If Timeout is -1 (default), the wait time is infinite.

Result Value

The method returns an object that matches the specified search criteria.

If no matching object was found, the method will return a stub object. To determine whether the method returns a valid object, use the Exists property of the returned object. If the property returns False, the object is a stub object.

See Also

FindElement Method (Mobile Objects)
About Mobile Tests

Highlight search results