Summary: Methods | Inherited Methods | [Expand All]

# Configurator

`public final class Configurator`
`extends Object` ``

java.lang.Object
↳ | android.support.test.uiautomator.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.
`int` | `getToolType()` Gets the current tool type to use for motion events.
`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` | `setToolType(int toolType)` Sets the current tool type to use for motion events.
`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.

### Inherited methods
From class `java.lang.Object`
`Object` | `clone()`
`boolean` | `equals(Object arg0)`
`void` | `finalize()`
`final Class<?>` | `getClass()`
`int` | `hashCode()`
`final void` | `notify()`
`final void` | `notifyAll()`
`String` | `toString()`
`final void` | `wait(long arg0, int arg1)`
`final void` | `wait(long arg0)`
`final void` | `wait()`

## Public methods

### getActionAcknowledgmentTimeout

    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
`long` | current timeout in milliseconds

### getInstance

    Configurator getInstance ()

Retrieves a singleton instance of Configurator.

Returns
`Configurator` | Configurator instance

### getKeyInjectionDelay

    long getKeyInjectionDelay ()

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

Returns
`long` | current delay in milliseconds

### getScrollAcknowledgmentTimeout

    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
`long` | current timeout in milliseconds

### getToolType

    int getToolType ()

Gets the current tool type to use for motion events.

Returns
`int` |

See also:

- `getToolType(int)`

### getWaitForIdleTimeout

    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
`long` | Current timeout value in milliseconds

### getWaitForSelectorTimeout

    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
`long` | Current timeout value in milliseconds

### setActionAcknowledgmentTimeout

    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` | `long`: Timeout value in milliseconds

Returns
`Configurator` | self

### setKeyInjectionDelay

    Configurator setKeyInjectionDelay (long delay)

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

Parameters
`delay` | `long`: Delay value in milliseconds

Returns
`Configurator` | self

### setScrollAcknowledgmentTimeout

    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` | `long`: Timeout value in milliseconds

Returns
`Configurator` | self

### setToolType

    Configurator setToolType (int toolType)

Sets the current tool type to use for motion events.

Parameters
`toolType` | `int`

Returns
`Configurator` |

See also:

- `getToolType(int)`

### setWaitForIdleTimeout

    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` | `long`: Timeout value in milliseconds

Returns
`Configurator` | self

### setWaitForSelectorTimeout

    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` | `long`: Timeout value in milliseconds.

Returns
`Configurator` | self

- ## Interfaces

  - IAutomationSupport
  - UiWatcher

- ## Classes

  - By
  - BySelector
  - Configurator
  - EventCondition
  - SearchCondition
  - UiAutomatorInstrumentationTestRunner
  - UiAutomatorTestCase
  - UiCollection
  - UiDevice
  - UiObject
  - UiObject2
  - UiObject2Condition
  - UiScrollable
  - UiSelector
  - Until

- ## Enums

  - Direction

- ## Exceptions

  - StaleObjectException
  - UiObjectNotFoundException