WaitElementByAccessibilityID Method (Mobile Objects)

Applies to TestComplete 14.91, last modified on July 20, 2021

Description

Use the WaitElementByAccessibilityID method to delay the test run until the mobile object with the specified Accessibility ID 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.WaitElementByAccessibilityID(AccessibilityIdTimeout)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
AccessibilityId [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:

AccessibilityId

A string that specifies the accessibility identifier assigned to the object in the tested application.

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

FindElementByAccessibilityID Method (Mobile Objects)
About Mobile Tests

Highlight search results