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

InteractionRequest.Builder

class InteractionRequest.Builder

Creates an instance of InteractionRequest from a View matcher and action.

Summary

Public constructors
`Builder()` Creates a new `Builder` instance.

Public functions
`InteractionRequest!`	`build()` Builds an `InteractionRequest` object.
`InteractionRequest.Builder!`	`setRequestProto(protoByteArray: ByteArray)` Set the result proto as a byte array.
`InteractionRequest.Builder!`	`setRootMatcher(rootMatcher: Matcher<Root!>)` Sets the root matcher for this `InteractionRequest`
`InteractionRequest.Builder!`	`setViewAction(viewAction: ViewAction)` Sets the `ViewAction` for this `InteractionRequest`
`InteractionRequest.Builder!`	`setViewAssertion(viewAssertion: ViewAssertion)` Sets the `ViewAssertion` for this `InteractionRequest`
`InteractionRequest.Builder!`	`setViewMatcher(viewMatcher: Matcher<View!>)` Sets the view matcher for this `InteractionRequest`

Public constructors

Builder

Builder()

Creates a new Builder instance.

Public functions

build

fun build(): InteractionRequest!

Builds an InteractionRequest object.

Returns
`InteractionRequest!`	an `InteractionRequest` object.

Throws
`java.lang.IllegalStateException: java.lang.IllegalStateException`	when conflicting properties are set. You can either set a < and a `ViewAction` or set the proto byte array but not both. Setting all values would result in an override, therefore setting both properties will result in an exception.
`androidx.test.espresso.remote.RemoteProtocolException: androidx.test.espresso.remote.RemoteProtocolException`	when the provided proto byte array cannot be parsed into a protocol buffer of type InteractionRequestProto

setRequestProto

fun setRequestProto(protoByteArray: ByteArray): InteractionRequest.Builder!

Set the result proto as a byte array. This byte array will be parsed into an . Providing an invalid byte array will result in a when the build method is called!

Parameters
`protoByteArray: ByteArray`	the proto byte array to set

Returns
`InteractionRequest.Builder!`	fluent interface `Builder`

setRootMatcher

fun setRootMatcher(rootMatcher: Matcher<Root!>): InteractionRequest.Builder!

Sets the root matcher for this InteractionRequest

Parameters
`rootMatcher: Matcher<Root!>`	the root matcher to set

Returns
`InteractionRequest.Builder!`	fluent interface

See also
`Root`

setViewAction

fun setViewAction(viewAction: ViewAction): InteractionRequest.Builder!

Sets the ViewAction for this InteractionRequest

Parameters
`viewAction: ViewAction`	the view action to set

Returns
`InteractionRequest.Builder!`	fluent interface

Throws
`java.lang.IllegalStateException: java.lang.IllegalStateException`	if a `ViewAssertion` was already set through `setViewAssertion` before. supports only one of `ViewAction` or `ViewAssertion`, but not both.

setViewAssertion

fun setViewAssertion(viewAssertion: ViewAssertion): InteractionRequest.Builder!

Sets the ViewAssertion for this InteractionRequest

Parameters
`viewAssertion: ViewAssertion`	the view action to set

Returns
`InteractionRequest.Builder!`	fluent interface

Throws
`java.lang.IllegalStateException: java.lang.IllegalStateException`	if a `ViewAction` was already set through `setViewAction` before. `InteractionRequest` supports only one of `ViewAction` or `ViewAssertion`, but not both.

setViewMatcher

fun setViewMatcher(viewMatcher: Matcher<View!>): InteractionRequest.Builder!

Sets the view matcher for this InteractionRequest

Parameters
`viewMatcher: Matcher<View!>`	the view matcher to set

Returns
`InteractionRequest.Builder!`	fluent interface