public class

Web.WebInteraction<R>

extends java.lang.Object

 java.lang.Object

↳androidx.test.espresso.web.sugar.Web.WebInteraction<R>

Overview

Analogous to a ViewInteraction or a DataInteraction, a WebInteraction exposes a fluent API to the underlying WebView.

Summary

Methods
public Web.WebInteraction<java.lang.Object>check(WebAssertion<java.lang.Object> assertion)

Evaluates the given WebAssertion.

public Web.WebInteraction<java.lang.Object>forceJavascriptEnabled()

Performs a force enable of Javascript on a WebView.

public java.lang.Objectget()

Returns the result of a prior call to perform or check.

public Web.WebInteraction<java.lang.Object>inWindow(Atom<WindowReference> windowPicker)

Causes this WebInteraction to have it's javascript evaluated in a particular DOM window.

public Web.WebInteraction<java.lang.Object>inWindow(WindowReference window)

Causes this WebInteraction to have it's javascript evaluated in a particular DOM window.

public Web.WebInteraction<java.lang.Object>perform(Atom<java.lang.Object> atom)

Executes the provided atom within the current context (the combination of Window and Element References).

public Web.WebInteraction<java.lang.Object>reset()

Removes the Element and Window references from this interaction.

public Web.WebInteraction<java.lang.Object>withContextualElement(Atom<ElementReference> elementPicker)

Allows for contextually evaluating this WebInteraction with the selected element.

public Web.WebInteraction<java.lang.Object>withElement(Atom<ElementReference> elementPicker)

Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation.

public Web.WebInteraction<java.lang.Object>withElement(ElementReference element)

Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation.

public Web.WebInteraction<java.lang.Object>withNoTimeout()

Disables all Timeouts on this WebInteraction.

public Web.WebInteraction<java.lang.Object>withTimeout(long amount, java.util.concurrent.TimeUnit unit)

Sets a specific timeout for this WebInteraction.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods

public Web.WebInteraction<java.lang.Object> reset()

Removes the Element and Window references from this interaction.

This is usually necessary when a prior action (for example a click) introduces a navigation that invalidates the ElementReference and WindowReference pointers.

public Web.WebInteraction<java.lang.Object> forceJavascriptEnabled()

Performs a force enable of Javascript on a WebView.

All WebView interactions are done via Javascript - therefore the WebView we are working on must support Javascript evaluation.

Enabling Javascript may cause the WebView under test to be reloaded. This is necessary to ensure the test infrastructure javascript bridges are loaded by the WebView.

public Web.WebInteraction<java.lang.Object> withNoTimeout()

Disables all Timeouts on this WebInteraction.

Javascript evaluation is performed asynchronously on the WebKit/Chromium thread. By default we wait a short while for the result to be delivered back to the test.

public Web.WebInteraction<java.lang.Object> withTimeout(long amount, java.util.concurrent.TimeUnit unit)

Sets a specific timeout for this WebInteraction.

public Web.WebInteraction<java.lang.Object> inWindow(WindowReference window)

Causes this WebInteraction to have it's javascript evaluated in a particular DOM window.

By default Javascript may be evaluated in the main window. However in an application which uses frames, you may want to evaluate in another frame.

public Web.WebInteraction<java.lang.Object> inWindow(Atom<WindowReference> windowPicker)

Causes this WebInteraction to have it's javascript evaluated in a particular DOM window.

This method accepts an Atom which will be evaluated in the main window to choose a particular DOM window for further interactions. This method will block until the the provided Atom returns with a result.

public Web.WebInteraction<java.lang.Object> withElement(ElementReference element)

Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation.

Calling this method resets any previously selected ElementReference.

Atom.getArguments(ElementReference)

public Web.WebInteraction<java.lang.Object> withElement(Atom<ElementReference> elementPicker)

Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation.

Atom.getArguments(ElementReference)

This method accepts an Atom which it will evaluate on the current context's Window. This method blocks until the evaluation completes.

Calling this method resets any previously selected ElementReference.

If you want to evaluate the elementPicker in the context of the previously selected ElementReference Web.WebInteraction.withContextualElement(Atom)

public Web.WebInteraction<java.lang.Object> withContextualElement(Atom<ElementReference> elementPicker)

Allows for contextually evaluating this WebInteraction with the selected element.

Specifically the elementPicker atom will be evaluated with the CURRENTLY selected element to discover the new element to work against.

This allows callers to interact with a document that looks like this: 

 
 

   

     
Socrates

   

 

 

   

     
Plato
With code like this: 
 onWebView()
   .withElement(findElement(Locator.ID, "teacher"))
   .withContextualElement(findElement(Locator.ID, "person_name"))
   .check(webMatches(getText(), containsString("Socrates")));

public Web.WebInteraction<java.lang.Object> perform(Atom<java.lang.Object> atom)

Executes the provided atom within the current context (the combination of Window and Element References).

This method blocks until the Atom returns. The result of the Atom's evaluation is used to create a new instance of WebInteraction which can be used to access the result of the Atom's evaluation.

public Web.WebInteraction<java.lang.Object> check(WebAssertion<java.lang.Object> assertion)

Evaluates the given WebAssertion.

The WebAssertion's atom is evaluated, after it's evaluation completes, the WebAssertion is run on the main thread to perform further checks. The WebAssertion is given the Atom's result and the WebView it had run against.

After this method completes, the result of the atom's evaluation is avaliable via get.

public java.lang.Object get()

Returns the result of a prior call to perform or check.

Generated Wed, 25 May 2022 15:45:12 +0200 by Michael Jentsch - Privacy Policy - Legal Details