{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

Class Index

These are all the API classes. See all API packages.

A B C D E F G H I K L M N O P R S T U V

A

`ActiveRootLister`	Provides access to all root views in an application.
`ActivityLifecycles`	Helper methods to understand ActivityLifecycle of the app.
`AdapterDataLoaderAction`	Forces an AdapterView to ensure that the data matching a provided data matcher is loaded into the current view hierarchy.
`AdapterViewProtocol`	A sadly necessary layer of indirection to interact with AdapterViews.
`AdapterViewProtocol.AdaptedData`	A holder that associates a data object from an AdapterView with a token the AdapterViewProtocol can use to force that data object to be rendered as a child or deeper descendant of the adapter view.
`AdapterViewProtocol.AdaptedData.Builder`
`AdapterViewProtocol.DataFunction`	A custom function that is applied when `getData` is executed.
`AdapterViewProtocols`	Implementations of `AdapterViewProtocol` for standard SDK Widgets.
`AmbiguousViewMatcherException`	An exception which indicates that a `Matcher<View>` matched multiple views in the hierarchy when only one view was expected.
`AmbiguousViewMatcherException.Builder`	Builder for `AmbiguousViewMatcherException`.
`AppNotIdleException`	An exception which indicates that the App has not become idle even after the specified duration.

B

`Bindable`	Interface that can be implemented by classes that provide an `IBinder`.
`BoundedDiagnosingMatcher`	A matcher that allows for a quick creation of a matcher that applies to a given type but only processes items of a specific subtype of that matcher.
`BoundedMatcher`	Some matcher sugar that lets you create a matcher for a given type but only process items of a specific subtype of that matcher.

C

`CloseKeyboardAction`	Closes soft keyboard.
`ConstructorInvocation`	Reflectively invokes the constructor of a declared class.
`Converter`	Converts input to output.
`CoordinatesProvider`	Interface to implement calculation of Coordinates.
`CursorMatchers`	A collection of Hamcrest matchers that matches a data row in a `Cursor`.
`CursorMatchers.CursorMatcher`	A `Matcher` that matches `Cursor`s based on values in their columns.

D

`DataInteraction`	An interface to interact with data displayed in AdapterViews.
`DataInteraction.DisplayDataMatcher`	Internal matcher that is required for `onData`.
`Default`	Annotates a default provider.
`DefaultFailureHandler`	Espresso's default `FailureHandler`.

E

`EditorAction`	Performs whatever editor (IME) action is available on a view.
`Espresso`	Entry point to the Espresso framework.
`EspressoException`	Used for identifying an exception as coming from the `Espresso` framework.
`EspressoKey`	Class that wraps the key code and meta state of the desired key press.
`EspressoKey.Builder`	Builder for the EspressoKey class.
`EspressoOptional`	This class is a wrapper around `com.google.common.base.Optional` in order to avoid having public references to Guava API.
`EspressoRemote`	A singleton class that facilitates communication between other Espresso instance that may be running in different processes.
`EspressoRemoteMessage`	Transforms an Espresso remote message from and to a proto message.
`EspressoRemoteMessage.From`	Transforms a proto message of type M into a class of type T.
`EspressoRemoteMessage.To`	Transforms a class implementing this interface to a proto message.

F

`FailureHandler`	Handles failures that happen during test execution.
`FieldDescriptor`	Provides additional meta data about a `Field` declared in a class.

G

`GeneralClickAction`	Enables clicking on views.
`GeneralLocation`	Calculates coordinate position for general locations.
`GeneralSwipeAction`	Enables swiping across a view.
`GenericRemoteMessage`	Generic implementation of the `EspressoRemoteMessage` interface, which uses reflection for proto message serialization and deserialization.

H

`HasBackgroundMatcher`	Matcher to match `android.view.View` based on its background resource.
`HumanReadables`	Text converters for various Android objects.

I

`IdlingPolicies`	Allows users fine grain control over idling policies.
`IdlingPolicy`	Allows users to control idling idleTimeouts in Espresso.
`IdlingResourceRegistry`	Keeps track of user-registered `IdlingResources`.
`IdlingResourceTimeoutException`	Indicates that an `IdlingResource`, which has been registered with the framework, has not idled within the allowed time.
`IdlingUiController`	Similar to `UiController` but with one additional method that enables getting an instance of `IdlingResourceRegistry`.
`InjectEventSecurityException`	An checked `Exception` indicating that event injection failed with a .
`InteractionRequest`	Encapsulates an InteractionRequestProto request.
`InteractionRequest.Builder`	Creates an instance of `InteractionRequest` from a View matcher and action.
`InteractionResponse`	Encapsulates a InteractionResultProto request.
`InteractionResponse.Builder`	Builder for `InteractionResponse`
`InteractionResponse.RemoteError`	TODO(b/31122396): parse this from a proto Enum representing wire protocol error codes and their default description.
`InteractionResponse.Status`	The status of this interaction response.
`InterruptableUiController`	Similar to `UiController` but with one additional method that enables interrupting Espresso tasks.

K

KeyEventAction

Enables pressing KeyEvents on views.

L

`LayoutAssertions`	A collection of layout `ViewAssertion`s.
`LayoutMatchers`	A collection of hamcrest matches to detect typical layout issues.

M

`MainThread`	Annotates an Executor that executes tasks on the main thread
`MotionEvents`	Facilitates sending of motion events to a `UiController`.
`MotionEvents.DownResultHolder`	Holds the result of a down motion.

N

`NoActivityResumedException`	An exception which indicates that there are no activities in stage RESUMED.
`NoMatchingRootException`	Indicates that a given matcher did not match any `Root`s (windows) from those that are currently available.
`NoMatchingViewException`	Indicates that a given matcher did not match any elements in the view hierarchy.
`NoMatchingViewException.Builder`	Builder for `NoMatchingViewException`.
`NoRemoteEspressoInstanceException`	An `Exception` which indicates that there are no remote Espresso clients present.
`NoopRemoteInteraction`	Noop RemoteInteraction object

O

OpenLinkAction

Invokes onClick of a link within a TextView (made with Linkify or via another method).

P

`PerformException`	Indicates that an exception occurred while performing a ViewAction on the UI thread.
`PerformException.Builder`	Builder for `PerformException`.
`PlatformTestStorageModule`	Dagger module for creating `PlatformTestStorage` instances.
`PositionAssertions`	A collection of `ViewAssertion`s for checking relative position of elements on the screen.
`PrecisionDescriber`	Interface to implement size of click area.
`PreferenceMatchers`	A collection of hamcrest matchers that match `Preference`s.
`Press`	Returns different touch target sizes.
`PressBackAction`	Performs an Android press back action
`ProtoUtils`	Contains various utility methods to ease use of protos and increased readability in code.

R

`RemoteDescriptor`	Descriptor object containing all the required information to serialize and deserialize a type to and from a proto.
`RemoteDescriptor.Builder`	Builder for `RemoteDescriptor`
`RemoteDescriptorRegistry`	A registry for registering remote descriptors.
`RemoteEspressoException`	Espresso exception representing any runtime related errors in a multi-process environment
`RemoteInteraction`	Facilitates communication between other Espresso instance that may be running in different processes.
`RemoteInteractionRegistry`	An exposed registry instance to make it easy for callers to get a hold of Remote Interaction
`RemoteProtocolException`	Espresso exception representing any protocol related errors in a multi-process environment
`RepeatActionUntilViewState`	Enables performing a given action on a view until it reaches desired state matched by given View matcher.
`ReplaceTextAction`	Replaces view text by setting `EditText`s text property to given String.
`Root`	Represents a root view in the application and optionally the layout params of the window holding it.
`Root.Builder`
`RootMatchers`	A collection of matchers for `Root` objects.
`RootViewException`	An `EspressoException` that can provide a Root View.
`RootViewPicker`	Provides the root View of the top-most Window, with which the user can interact.
`RootViewPickerScope`	Scope for components that use `RootViewPicker`.

S

`ScrollToAction`	Enables scrolling to the given view.
`Swipe`	Executes different swipe types to given positions.
`Swiper`	Interface to implement different swipe types.
`Swiper.Status`	The result of the swipe.

T

`Tap`	Executes different click types to given position.
`Tapper`	Interface to implement different click types.
`Tapper.Status`	The result of the tap.
`TreeIterables`	Utility methods for iterating over tree structured items.
`TreeIterables.ViewAndDistance`	Represents the distance a given view is from the root view.
`TypeProtoConverters`	Converters from Any proto messages to their unwrapped target types.
`TypeTextAction`	Enables typing text on views.

U

UiController

Provides base-level UI operations (such as injection of MotionEvents) that can be used to build user actions such as clicks, scrolls, swipes, etc.

V

`ViewAction`	Responsible for performing an interaction on the given View element.
`ViewActions`	A collection of common `ViewActions`.
`ViewAssertion`	Responsible for performing assertions on a View element.
`ViewAssertions`	Collection of common `ViewAssertions`.
`ViewFinder`	Uses matchers to locate particular views within the view hierarchy.
`ViewFinderImpl`	Implementation of `ViewFinder`.
`ViewInteraction`	Provides the primary interface for test authors to perform actions or asserts on views.
`ViewInteractionCapture`
`ViewInteractionComponent`	Dagger component for view interaction classes.
`ViewMatchers`	A collection of hamcrest matchers that match `View`s.
`ViewMatchers.Visibility`	Enumerates the possible list of values for `getVisibility`.