io.appium.java_client

Interface FindsByImage<T extends WebElement>

All Superinterfaces:

FindsByFluentSelector<T>

All Known Implementing Classes:

AndroidDriver, AppiumDriver, IOSDriver, WindowsDriver

public interface FindsByImage<T extends WebElement>
extends FindsByFluentSelector<T>

Method Summary

Modifier and Type	Method and Description
default T	findElementByImage(java.lang.String b64Template) Performs the lookup for a single element by matching its image template to the current full screen shot.
default java.util.List<T>	findElementsByImage(java.lang.String b64Template) Performs the lookup for a list of elements by matching them to image template in the current full screen shot.

Methods inherited from interface io.appium.java_client.FindsByFluentSelector

findElement, findElements

Method Detail

findElementByImage

default T findElementByImage(java.lang.String b64Template)

Performs the lookup for a single element by matching its image template to the current full screen shot. This type of locator requires OpenCV libraries and bindings for NodeJS to be installed on the server machine. Lookup options fine-tuning might be done via HasSettings.setSetting(Setting, Object).

Parameters:

b64Template - base64-encoded template image string. Supported image formats are the same as for OpenCV library.

Returns:

The first element that matches the given selector

Throws:

org.openqa.selenium.NoSuchElementException - when no element is found

Since:

Appium 1.8.2

See Also:

The documentation on Image Comparison Features, The settings available for lookup fine-tuning

findElementsByImage

default java.util.List<T> findElementsByImage(java.lang.String b64Template)

Performs the lookup for a list of elements by matching them to image template in the current full screen shot. This type of locator requires OpenCV libraries and bindings for NodeJS to be installed on the server machine. Lookup options fine-tuning might be done via HasSettings.setSetting(Setting, Object).

Parameters:

b64Template - base64-encoded template image string. Supported image formats are the same as for OpenCV library.

Returns:

a list of elements that match the given selector or an empty list

Since:

Appium 1.8.2

See Also:

The documentation on Image Comparison Features, The settings available for lookup fine-tuning