Configurator

public void addUiAccessibilityValidator(@NonNull UiAccessibilityValidator validator)

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.

public long getActionAcknowledgmentTimeout()

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

public int getDefaultDisplayId()

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.

public static @NonNull Configurator getInstance()

Retrieves a singleton instance of Configurator.

public long getKeyInjectionDelay()

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

public long getScrollAcknowledgmentTimeout()

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

public int getToolType()

Gets the current tool type to use for motion events.

public @NonNull List<UiAccessibilityValidator> getUiAccessibilityValidators()

Gets the currently assigned UiAccessibilityValidators.

public int getUiAutomationFlags()

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

public long getWaitForIdleTimeout()

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

public long getWaitForSelectorTimeout()

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.

public void removeUiAccessibilityValidator(
    @NonNull UiAccessibilityValidator validator
)

Removes a validator added via addUiAccessibilityValidator.

public @NonNull Configurator resetDefaultDisplayId()

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

public @NonNull Configurator setActionAcknowledgmentTimeout(long timeout)

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.

public @NonNull Configurator setDefaultDisplayId(int defaultDisplayId)

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.

public @NonNull Configurator setKeyInjectionDelay(long delay)

Sets a delay between key presses when injecting text input.

public @NonNull Configurator setScrollAcknowledgmentTimeout(long timeout)

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.

public @NonNull Configurator setToolType(int toolType)

Sets the tool type to use for motion events.

public @NonNull Configurator setUiAutomationFlags(int flags)

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

public @NonNull Configurator setWaitForIdleTimeout(long timeout)

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

public @NonNull Configurator setWaitForSelectorTimeout(long timeout)

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.