Configurator

fun addUiAccessibilityValidator(validator: UiAccessibilityValidator): Unit

Adds a validator to be run before important test actions like click(), swipe(), etc.

The validator can provide custom accessibility checks. The validate method is called before performing any action on a UI element via UiObject2, or the display via UiDevice, such as clicking or scrolling.

fun getActionAcknowledgmentTimeout(): Long

Gets the current timeout for waiting for an acknowledgment of a UiObject click.

fun getDefaultDisplayId(): Int

Gets the default display ID to use when obtaining a androidx.test.uiautomator.BySelector instance, or returns INVALID_DISPLAY if the default display ID is not set yet.

java-static fun getInstance(): Configurator

Retrieves a singleton instance of Configurator.

fun getKeyInjectionDelay(): Long

Gets the current delay between key presses when injecting text input.

fun getScrollAcknowledgmentTimeout(): Long

Gets the current timeout for waiting for an acknowledgement of a UiScrollable scroll action.

fun getToolType(): Int

Gets the current tool type to use for motion events.

fun getUiAccessibilityValidators(): (Mutable)List<UiAccessibilityValidator!>

Gets the currently assigned UiAccessibilityValidators.

fun getUiAutomationFlags(): Int

Gets the current flags that are used to obtain a android.app.UiAutomation instance.

fun getWaitForIdleTimeout(): Long

Gets the current timeout used for waiting for the user interface to go into an idle state before starting a UiAutomator action.

fun getWaitForSelectorTimeout(): Long

Gets the current timeout for waiting for a UiObject to become visible in the user interface so that it can be matched by a UiSelector.

fun removeUiAccessibilityValidator(validator: UiAccessibilityValidator): Unit

Removes a validator added via addUiAccessibilityValidator.

fun resetDefaultDisplayId(): Configurator

Resets the default display ID to use when obtaining a androidx.test.uiautomator.BySelector instance.

fun setActionAcknowledgmentTimeout(timeout: Long): Configurator

Sets the timeout for waiting for an acknowledgment of a UiObject click.

The acknowledgment is an android.view.accessibility.AccessibilityEvent corresponding to a content change that lets the framework determine if the action was successful. Generally, this timeout should not be modified.

Has no effect on UiDevice and UiObject2 clicks.

fun setDefaultDisplayId(defaultDisplayId: Int): Configurator

Sets the default display ID to use when obtaining a androidx.test.uiautomator.BySelector instance. To avoid interfering with other tests, the caller must call resetDefaultDisplayId when the test is finished.

fun setKeyInjectionDelay(delay: Long): Configurator

Sets a delay between key presses when injecting text input.

fun setScrollAcknowledgmentTimeout(timeout: Long): Configurator

Sets the timeout for waiting for an acknowledgement of a UiScrollable scroll action.

The acknowledgment is an android.view.accessibility.AccessibilityEvent corresponding to the scroll action that lets the framework determine if it was successful. Generally, this timeout should not be modified.

Has no effect on UiObject2 scrolls.

fun setToolType(toolType: Int): Configurator

Sets the tool type to use for motion events.

fun setUiAutomationFlags(flags: Int): Configurator

Sets the flags to use when obtaining a android.app.UiAutomation instance.

fun setWaitForIdleTimeout(timeout: Long): Configurator

Sets the timeout for waiting for the user interface to go into an idle state before starting a UiAutomator action.

fun setWaitForSelectorTimeout(timeout: Long): Configurator

Sets the timeout for waiting for a UiObject to become visible in the user interface so that it can be matched by a UiSelector.

For UiObjects, the underlying node is fetched with this timeout before every action.

Has no effect on UiObject2s, which cache the underlying node. Instead, use wait and findObject to wait for the object to become visible.