Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Configurator

Allows you to set key parameters for running uiautomator tests. The new settings take effect immediately and can be changed any time during a test run. To modify parameters using Configurator , first obtain an instance by calling getInstance() . As a best practice, make sure you always save the original value of any parameter that you are modifying. After running your tests with the modified parameters, make sure to also restore the original parameter values, otherwise this will impact other tests cases.

Summary

Public Methods
long getActionAcknowledgmentTimeout ()
Gets the current timeout for waiting for an acknowledgment of generic uiautomator actions, such as clicks, text setting, and menu presses.
static Configurator getInstance ()
Retrieves a singleton instance of Configurator.
long getKeyInjectionDelay ()
Gets the current delay between key presses when injecting text input.
long getScrollAcknowledgmentTimeout ()
Gets the timeout for waiting for an acknowledgement of an uiautomtor scroll swipe action.
long getWaitForIdleTimeout ()
Gets the current timeout used for waiting for the user interface to go into an idle state.
long getWaitForSelectorTimeout ()
Gets the current timeout for waiting for a widget to become visible in the user interface so that it can be matched by a selector.
Configurator setActionAcknowledgmentTimeout (long timeout)
Sets the timeout for waiting for an acknowledgment of generic uiautomator actions, such as clicks, text setting, and menu presses.
Configurator setKeyInjectionDelay (long delay)
Sets a delay between key presses when injecting text input.
Configurator setScrollAcknowledgmentTimeout (long timeout)
Sets the timeout for waiting for an acknowledgement of an uiautomtor scroll swipe action.
Configurator setWaitForIdleTimeout (long timeout)
Sets the timeout for waiting for the user interface to go into an idle state before starting a uiautomator action.
Configurator setWaitForSelectorTimeout (long timeout)
Sets the timeout for waiting for a widget to become visible in the user interface so that it can be matched by a selector.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public long getActionAcknowledgmentTimeout ()

Gets the current timeout for waiting for an acknowledgment of generic uiautomator actions, such as clicks, text setting, and menu presses. The acknowledgment is an AccessibilityEvent , corresponding to an action, that lets the framework determine if the action was successful. Generally, this timeout should not be modified. See UiObject

Returns
  • current timeout in milliseconds
Since
  • Android API Level 18

public static Configurator getInstance ()

Retrieves a singleton instance of Configurator.

Returns
  • Configurator instance
Since
  • Android API Level 18

public long getKeyInjectionDelay ()

Gets the current delay between key presses when injecting text input. See setText(String)

Returns
  • current delay in milliseconds
Since
  • Android API Level 18

public long getScrollAcknowledgmentTimeout ()

Gets the timeout for waiting for an acknowledgement of an uiautomtor scroll swipe action. The acknowledgment is an AccessibilityEvent , corresponding to the scroll action, that lets the framework determine if the scroll action was successful. Generally, this timeout should not be modified. See UiScrollable

Returns
  • current timeout in milliseconds
Since
  • Android API Level 18

public long getWaitForIdleTimeout ()

Gets the current timeout used for waiting for the user interface to go into an idle state. By default, all core uiautomator objects except UiDevice will perform this wait before starting to search for the widget specified by the object's UiSelector . Once the idle state is detected or the timeout elapses (whichever occurs first), the object will start to wait for the selector to find a match. See setWaitForSelectorTimeout(long)

Returns
  • Current timeout value in milliseconds
Since
  • Android API Level 18

public long getWaitForSelectorTimeout ()

Gets the current timeout for waiting for a widget to become visible in the user interface so that it can be matched by a selector. Because user interface content is dynamic, sometimes a widget may not be visible immediately and won't be detected by a selector. This timeout allows the uiautomator framework to wait for a match to be found, up until the timeout elapses.

Returns
  • Current timeout value in milliseconds
Since
  • Android API Level 18

public Configurator setActionAcknowledgmentTimeout (long timeout)

Sets the timeout for waiting for an acknowledgment of generic uiautomator actions, such as clicks, text setting, and menu presses. The acknowledgment is an AccessibilityEvent , corresponding to an action, that lets the framework determine if the action was successful. Generally, this timeout should not be modified. See UiObject

Parameters
timeout Timeout value in milliseconds
Returns
  • self
Since
  • Android API Level 18

public Configurator setKeyInjectionDelay (long delay)

Sets a delay between key presses when injecting text input. See setText(String)

Parameters
delay Delay value in milliseconds
Returns
  • self
Since
  • Android API Level 18

public Configurator setScrollAcknowledgmentTimeout (long timeout)

Sets the timeout for waiting for an acknowledgement of an uiautomtor scroll swipe action. The acknowledgment is an AccessibilityEvent , corresponding to the scroll action, that lets the framework determine if the scroll action was successful. Generally, this timeout should not be modified. See UiScrollable

Parameters
timeout Timeout value in milliseconds
Returns
  • self
Since
  • Android API Level 18

public Configurator setWaitForIdleTimeout (long timeout)

Sets the timeout for waiting for the user interface to go into an idle state before starting a uiautomator action. By default, all core uiautomator objects except UiDevice will perform this wait before starting to search for the widget specified by the object's UiSelector . Once the idle state is detected or the timeout elapses (whichever occurs first), the object will start to wait for the selector to find a match. See setWaitForSelectorTimeout(long)

Parameters
timeout Timeout value in milliseconds
Returns
  • self
Since
  • Android API Level 18

public Configurator setWaitForSelectorTimeout (long timeout)

Sets the timeout for waiting for a widget to become visible in the user interface so that it can be matched by a selector. Because user interface content is dynamic, sometimes a widget may not be visible immediately and won't be detected by a selector. This timeout allows the uiautomator framework to wait for a match to be found, up until the timeout elapses.

Parameters
timeout Timeout value in milliseconds.
Returns
  • self
Since
  • Android API Level 18