com.applitools.eyes.appium

Class Eyes

java.lang.Object

com.applitools.eyes.EyesBase

com.applitools.eyes.selenium.Eyes

com.applitools.eyes.appium.Eyes

All Implemented Interfaces:

IEyesBase

public class Eyes
extends Eyes

Nested Class Summary

Nested classes/interfaces inherited from class com.applitools.eyes.selenium.Eyes

Eyes.WebDriverAction

Field Summary

Fields inherited from class com.applitools.eyes.selenium.Eyes

DEFAULT_DEVICE_PIXEL_RATIO, doNotGetTitle, imageProvider, regionPositionCompensation, targetElement, UNKNOWN_DEVICE_PIXEL_RATIO

Fields inherited from class com.applitools.eyes.EyesBase

config, cutProviderHandler, debugScreenshotsProvider, domCaptureListener, lastScreenshot, logger, positionProviderHandler, runningSession, scaleProviderHandler, serverConnector, sessionStartInfo, USE_DEFAULT_TIMEOUT, viewportSizeHandler, visualLocatorProvider

Constructor Summary

Constructors

Constructor and Description
Eyes()

Method Summary

Modifier and Type	Method and Description
void	check(ICheckSettings checkSettings)
protected MatchResult	checkElement(org.openqa.selenium.WebElement element, String name, ICheckSettings checkSettings)
protected MatchResult	checkRegion(String name, ICheckSettings checkSettings)
protected double	extractDevicePixelRatio()
protected AppEnvironment	getAppEnvironment()
String	getBaseAgentId()
org.openqa.selenium.WebDriver	getDriver()
Location	getElementOriginalLocation(org.openqa.selenium.WebElement element)
EyesAppiumDriver	getEyesDriver()
protected EyesAppiumScreenshot	getFullPageScreenshot()
protected ScaleProviderFactory	getScaleProviderFactory()
protected EyesAppiumScreenshot	getSimpleScreenshot()
protected EyesScreenshot	getSubScreenshot(EyesScreenshot screenshot, Region region, ICheckSettingsInternal checkSettingsInternal)
protected void	initDriver(org.openqa.selenium.WebDriver driver)
protected void	initDriverBasedPositionProviders()
protected void	initImageProvider()
protected void	initVisualLocatorProvider()
protected boolean	isMobileDevice(org.openqa.selenium.WebDriver driver)
Map<String,List<Region>>	locate(IVisualLocatorSettings visualLocatorSettings)

Methods inherited from class com.applitools.eyes.selenium.Eyes

addMouseTrigger, addMouseTrigger, addTextTrigger, addTextTrigger, beforeOpen, check, check, checkCurrentFrame, checkElement, checkElement, checkElement, checkElement, checkElement, checkElement, checkFrame, checkFrame, checkFrame, checkFrame, checkFrame, checkFrame, checkFrame, checkFrame, checkFrame, checkFrame, checkFrame, checkFrame, checkFrameFluent, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegion, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkRegionInFrame, checkWindow, checkWindow, checkWindow, ensureConfiguration, getAgentSetup, getAUTSessionId, getCurrentFramePositionProvider, getDevicePixelRatio, getForceFullPageScreenshot, getFrameOrElementScreenshot, getHideCaret, getHideScrollbars, getInferredEnvironment, getJsExecutor, getRegionToCheck, getRotation, getScreenshot, getScrollToRegion, getServerConnector, getStitchMode, getTitle, getUserAgent, getViewportSize, getViewportSize, getWaitBeforeScreenshots, isSendDom, open, open, open, open, open, open, setForceFullPageScreenshot, setHideCaret, setHideScrollbars, setJsExecutor, setRegionToCheck, setRotation, setScrollToRegion, setStitchMode, setUserAgent, setViewportSize, setViewportSize, setWaitBeforeScreenshots, shouldStitchContent, testResponseTime, testResponseTime, testResponseTime, testResponseTime, testResponseTime, testResponseTime, testResponseTime, testResponseTime, testResponseTime, testResponseTime, testResponseTime, testWindow, testWindow, testWindow, testWindow, tryCaptureDom, tryUpdateDevicePixelRatio, updateScalingParams

Methods inherited from class com.applitools.eyes.EyesBase

abortIfNotClosed, addMouseTriggerBase, addProperty, addSessionEventHandler, addTextTriggerBase, addUserInput, afterMatchWindow, afterOpen, beforeMatchWindow, checkWindowBase, checkWindowBase, checkWindowBase, clearProperties, clearSessionEventHandlers, clearUserInputs, close, close, closeResponseTime, fireValidationWillStartEvent, getAgentId, getApiKey, getAppName, getBaselineBranchName, getBaselineEnvName, getBaselineName, getBatch, getBranchName, getDebugScreenshotsPath, getDebugScreenshotsPrefix, getDebugScreenshotsProvider, getDefaultMatchSettings, getDefaultServerUrl, getEnvName, getFailureReports, getFullAgentId, getHostApp, getHostOS, getIgnoreCaret, getIsCutProviderExplicitlySet, getIsDisabled, getIsOpen, getLogger, getLogHandler, getMatchLevel, getMatchTimeout, getParentBranchName, getPositionProvider, getProxy, getSaveDebugScreenshots, getSaveDiffs, getSaveFailedTests, getSaveNewTests, getScaleRatio, getServerUrl, getSessionEventHandlers, getStitchOverlap, getUserInputs, log, openBase, openBase, removeSessionEventHandler, setAgentId, setApiKey, setAppEnvironment, setAppName, setBaselineBranchName, setBaselineEnvName, setBaselineName, setBatch, setBranchName, setDebugScreenshotsPath, setDebugScreenshotsPrefix, setDefaultMatchSettings, setEnvName, setExplicitViewportSize, setFailureReports, setHostApp, setHostOS, setIgnoreCaret, setImageCut, setIsDisabled, setLogHandler, setMatchLevel, setMatchTimeout, setOnDomCapture, setParentBranchName, setPositionProvider, setProxy, setSaveDebugScreenshots, setSaveDiffs, setSaveFailedTests, setSaveNewTests, setScaleRatio, setSendDom, setServerConnector, setServerUrl, setServerUrl, setStitchOverlap, startSession, testResponseTimeBase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Eyes

public Eyes()

Method Detail

getBaseAgentId

public String getBaseAgentId()

Overrides:

getBaseAgentId in class Eyes

getEyesDriver

public EyesAppiumDriver getEyesDriver()

Overrides:

getEyesDriver in class Eyes

initDriverBasedPositionProviders

protected void initDriverBasedPositionProviders()

Overrides:

initDriverBasedPositionProviders in class Eyes

initImageProvider

protected void initImageProvider()

Overrides:

initImageProvider in class Eyes

getDriver

public org.openqa.selenium.WebDriver getDriver()

Overrides:

getDriver in class Eyes

initDriver

protected void initDriver(org.openqa.selenium.WebDriver driver)

Overrides:

initDriver in class Eyes

getScaleProviderFactory

protected ScaleProviderFactory getScaleProviderFactory()

Overrides:

getScaleProviderFactory in class Eyes

isMobileDevice

protected boolean isMobileDevice(org.openqa.selenium.WebDriver driver)

Overrides:

isMobileDevice in class Eyes

Parameters:

driver - The driver for which to check if it represents a mobile device.

Returns:

true if the platform running the test is a mobile platform. false otherwise.

getAppEnvironment

protected AppEnvironment getAppEnvironment()

This override also checks for mobile operating system.

Overrides:

getAppEnvironment in class EyesBase

extractDevicePixelRatio

protected double extractDevicePixelRatio()

Overrides:

extractDevicePixelRatio in class Eyes

check

public void check(ICheckSettings checkSettings)

Overrides:

check in class Eyes

checkElement

protected MatchResult checkElement(org.openqa.selenium.WebElement element,
                                   String name,
                                   ICheckSettings checkSettings)

Overrides:

checkElement in class Eyes

getFullPageScreenshot

protected EyesAppiumScreenshot getFullPageScreenshot()

Overrides:

getFullPageScreenshot in class Eyes

getSimpleScreenshot

protected EyesAppiumScreenshot getSimpleScreenshot()

Overrides:

getSimpleScreenshot in class Eyes

checkRegion

protected MatchResult checkRegion(String name,
                                  ICheckSettings checkSettings)

Overrides:

checkRegion in class Eyes

getSubScreenshot

protected EyesScreenshot getSubScreenshot(EyesScreenshot screenshot,
                                          Region region,
                                          ICheckSettingsInternal checkSettingsInternal)

Overrides:

getSubScreenshot in class Eyes

getElementOriginalLocation

public Location getElementOriginalLocation(org.openqa.selenium.WebElement element)

Overrides:

getElementOriginalLocation in class Eyes

initVisualLocatorProvider

protected void initVisualLocatorProvider()

Overrides:

initVisualLocatorProvider in class EyesBase

locate

public Map<String,List<Region>> locate(IVisualLocatorSettings visualLocatorSettings)