Eyes (eyes-selenium-java3 3.146.0 API)

java.lang.Object
- com.applitools.eyes.EyesBase
- - com.applitools.eyes.selenium.Eyes

All Implemented Interfaces:

IEyes
```
public class Eyes
extends EyesBase
implements IEyes
```
The main API gateway for the SDK.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Eyes.WebDriverAction

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Eyes.WebDriverAction`

Field Summary

Fields
Modifier and Type Field and Description

static double DEFAULT_DEVICE_PIXEL_RATIO

static double UNKNOWN_DEVICE_PIXEL_RATIO
- Fields inherited from class com.applitools.eyes.EyesBase
  config, cutProviderHandler, debugScreenshotsProvider, domCaptureListener, lastScreenshot, logger, positionProviderHandler, renderInfo, runningSession, scaleProviderHandler, serverConnector, sessionStartInfo, USE_DEFAULT_TIMEOUT, viewportSizeHandler

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_DEVICE_PIXEL_RATIO`
`static double`	`UNKNOWN_DEVICE_PIXEL_RATIO`

Constructor Summary

Constructors
Constructor and Description

Eyes()
Creates a new Eyes instance that interacts with the Eyes cloud service.

Constructors
Constructor and Description
`Eyes()` Creates a new Eyes instance that interacts with the Eyes cloud service.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMouseTrigger(MouseAction action, Region control, Location cursor)` Adds a mouse trigger.
`void`	`addMouseTrigger(MouseAction action, org.openqa.selenium.WebElement element)` Adds a mouse trigger.
`void`	`addTextTrigger(Region control, String text)` Adds a keyboard trigger.
`void`	`addTextTrigger(org.openqa.selenium.WebElement element, String text)` Adds a keyboard trigger.
`protected void`	`beforeOpen()`
`void`	`check(ICheckSettings... checkSettings)` Takes multiple screenshots at once (given all `ICheckSettings` objects are on the same level).
`void`	`check(ICheckSettings checkSettings)`
`void`	`check(String name, ICheckSettings checkSettings)`
`protected void`	`checkCurrentFrame(int matchTimeout, String tag)` Verifies the current frame.
`void`	`checkElement(org.openqa.selenium.By selector)` See `checkElement(By, String)`.
`void`	`checkElement(org.openqa.selenium.By selector, int matchTimeout, String tag)` Takes a snapshot of the application under test and matches an element specified by the given selector with the expected region output.
`void`	`checkElement(org.openqa.selenium.By selector, String tag)` See `checkElement(By, int, String)`.
`void`	`checkElement(org.openqa.selenium.WebElement element)` See `checkElement(WebElement, String)`.
`void`	`checkElement(org.openqa.selenium.WebElement element, int matchTimeout, String tag)` Takes a snapshot of the application under test and matches a specific element with the expected region output.
`void`	`checkElement(org.openqa.selenium.WebElement element, String tag)` See `checkElement(WebElement, int, String)`.
`void`	`checkFrame(int frameIndex)` See `checkFrame(int, int, String)`.
`void`	`checkFrame(int frameIndex, int matchTimeout, String tag)` Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
`void`	`checkFrame(int frameIndex, String tag)` See `checkFrame(int, int, String)`.
`void`	`checkFrame(String frameNameOrId)` See `checkFrame(String, int, String)`.
`void`	`checkFrame(String[] framesPath)` See `checkFrame(String[], int, String)`.
`void`	`checkFrame(String[] framePath, int matchTimeout, String tag)` Matches the frame given by the frames path, by switching into the frame and using stitching to get an image of the frame.
`void`	`checkFrame(String[] framesPath, String tag)` See `checkFrame(String[], int, String)`.
`void`	`checkFrame(String frameNameOrId, int matchTimeout, String tag)` Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
`void`	`checkFrame(String frameNameOrId, String tag)` See `checkFrame(String, int, String)`.
`void`	`checkFrame(org.openqa.selenium.WebElement frameReference)` See `checkFrame(WebElement, int, String)`.
`void`	`checkFrame(org.openqa.selenium.WebElement frameReference, int matchTimeout, String tag)` Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
`void`	`checkFrame(org.openqa.selenium.WebElement frameReference, String tag)` See `checkFrame(WebElement, int, String)`.
`protected MatchResult`	`checkFrameFluent(String name, ICheckSettings checkSettings)`
`void`	`checkRegion(org.openqa.selenium.By selector)` See `checkRegion(By, String)`.
`void`	`checkRegion(org.openqa.selenium.By selector, boolean stitchContent)` If `stitchContent` is `false` then behaves the same as `checkRegion(By)`.
`void`	`checkRegion(org.openqa.selenium.By selector, int matchTimeout, String tag)` Takes a snapshot of the application under test and matches a region specified by the given selector with the expected region output.
`void`	`checkRegion(org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent)` If `stitchContent` is `false` then behaves the same as `checkRegion(By, int, String)`.
`void`	`checkRegion(org.openqa.selenium.By selector, String tag)` See `checkRegion(By, int, String)`.
`void`	`checkRegion(org.openqa.selenium.By selector, String tag, boolean stitchContent)` If `stitchContent` is `false` then behaves the same as `checkRegion(By, String)`.
`void`	`checkRegion(Region region)` See `checkRegion(Region, int, String)`.
`void`	`checkRegion(Region region, int matchTimeout, String tag)` Takes a snapshot of the application under test and matches a specific region within it with the expected output.
`void`	`checkRegion(org.openqa.selenium.WebElement element)` See `checkRegion(WebElement, String)`.
`void`	`checkRegion(org.openqa.selenium.WebElement element, boolean stitchContent)` If `stitchContent` is `false` then behaves the same as `checkRegion(WebElement)`, otherwise behaves the same as `checkElement(WebElement)`.
`void`	`checkRegion(org.openqa.selenium.WebElement element, int matchTimeout, String tag)` Takes a snapshot of the application under test and matches a region of a specific element with the expected region output.
`void`	`checkRegion(org.openqa.selenium.WebElement element, int matchTimeout, String tag, boolean stitchContent)` if `stitchContent` is `false` then behaves the same `checkRegion(WebElement, int, String)`.
`void`	`checkRegion(org.openqa.selenium.WebElement element, String tag)` See `checkRegion(WebElement, int, String)`.
`void`	`checkRegion(org.openqa.selenium.WebElement element, String tag, boolean stitchContent)` if `stitchContent` is `false` then behaves the same `checkRegion(WebElement, String)`.
`void`	`checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector)` See `checkRegionInFrame(int, By, String)`.
`void`	`checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, boolean stitchContent)` See `checkRegionInFrame(int, By, String)`.
`void`	`checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, int matchTimeout, String tag)` See `checkRegionInFrame(int, By, int, String, boolean)`.
`void`	`checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent)` Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
`void`	`checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, String tag)` See `checkRegionInFrame(int, By, String, boolean)`.
`void`	`checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, String tag, boolean stitchContent)` See `checkRegionInFrame(int, By, int, String, boolean)`.
`void`	`checkRegionInFrame(String[] framePath, org.openqa.selenium.By selector)` See `checkRegionInFrame(String[], By, int, String)`.
`void`	`checkRegionInFrame(String[] framePath, org.openqa.selenium.By selector, int matchTimeout, String tag)` See `checkRegionInFrame(String[], By, int, String, boolean)`.
`void`	`checkRegionInFrame(String[] framePath, org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent)` Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
`void`	`checkRegionInFrame(String[] framePath, org.openqa.selenium.By selector, String tag)` See `checkRegionInFrame(String[], By, int, String)`.
`void`	`checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector)` See `checkRegionInFrame(String, By, int, String, boolean)`.
`void`	`checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, boolean stitchContent)` See `checkRegionInFrame(String, By, int, String, boolean)`.
`void`	`checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, int matchTimeout, String tag)` See `checkRegionInFrame(String, By, int, String, boolean)`.
`void`	`checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent)` Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
`void`	`checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, String tag)` See `checkRegionInFrame(String, By, int, String, boolean)`.
`void`	`checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, String tag, boolean stitchContent)` See `checkRegionInFrame(String, By, int, String, boolean)`.
`void`	`checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector)` See `checkRegionInFrame(WebElement, By, boolean)`.
`void`	`checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, boolean stitchContent)` See `checkRegionInFrame(WebElement, By, String, boolean)`.
`void`	`checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, int matchTimeout, String tag)` See `checkRegionInFrame(WebElement, By, int, String, boolean)`.
`void`	`checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent)` Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
`void`	`checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, String tag)` See `checkRegionInFrame(WebElement, By, String, boolean)`.
`void`	`checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, String tag, boolean stitchContent)` See `checkRegionInFrame(WebElement, By, int, String, boolean)`.
`void`	`checkWindow()` See `checkWindow(String)`.
`void`	`checkWindow(int matchTimeout, String tag)` Takes a snapshot of the application under test and matches it with the expected output.
`void`	`checkWindow(String tag)` See `checkWindow(int, String)`.
`TestResults`	`close(boolean throwEx)`
`protected void`	`ensureConfiguration()`
`Object`	`getAgentSetup()`
`protected AppEnvironment`	`getAppEnvironment()`
`protected String`	`getAUTSessionId()`
`String`	`getBaseAgentId()`
`PositionProvider`	`getCurrentFramePositionProvider()`
`org.openqa.selenium.WebElement`	`getCurrentFrameScrollRootElement()`
`double`	`getDevicePixelRatio()`
`org.openqa.selenium.WebDriver`	`getDriver()`
`boolean`	`getForceFullPageScreenshot()`
`boolean`	`getHideCaret()`
`boolean`	`getHideScrollbars()`
`protected String`	`getInferredEnvironment()`
`FrameChain`	`getOriginalFC()`
`Region`	`getRegionToCheck()`
`ImageRotation`	`getRotation()`
`protected EyesScreenshot`	`getScreenshot()`
`org.openqa.selenium.WebElement`	`getScrollRootElement()`
`boolean`	`getScrollToRegion()`
`IServerConnector`	`getServerConnector()`
`StitchMode`	`getStitchMode()`
`protected EyesScreenshot`	`getSubScreenshot(EyesScreenshot screenshot, Region region, ICheckSettingsInternal checkSettingsInternal)`
`protected String`	`getTitle()`
`RectangleSize`	`getViewportSize()` Use this method only if you made a previous call to `(WebDriver, String, String)` or one of its variants.
`static RectangleSize`	`getViewportSize(org.openqa.selenium.WebDriver driver)` Call this method if for some reason you don't want to call `open(WebDriver, String, String)` (or one of its variants) yet.
`int`	`getWaitBeforeScreenshots()`
`boolean`	`isSendDom()`
`protected org.openqa.selenium.WebDriver`	`open(org.openqa.selenium.WebDriver driver)`
`org.openqa.selenium.WebDriver`	`open(org.openqa.selenium.WebDriver driver, Configuration configuration)`
`org.openqa.selenium.WebDriver`	`open(org.openqa.selenium.WebDriver driver, String appName, String testName)` See `open(WebDriver, String, String, SessionType)`.
`org.openqa.selenium.WebDriver`	`open(org.openqa.selenium.WebDriver driver, String appName, String testName, RectangleSize viewportSize)` See `open(WebDriver, String, String, RectangleSize, SessionType)`.
`protected org.openqa.selenium.WebDriver`	`open(org.openqa.selenium.WebDriver driver, String appName, String testName, RectangleSize viewportSize, SessionType sessionType)` Starts a test.
`protected org.openqa.selenium.WebDriver`	`open(org.openqa.selenium.WebDriver driver, String appName, String testName, SessionType sessionType)` See `open(WebDriver, String, String, RectangleSize)`.
`void`	`setForceFullPageScreenshot(boolean shouldForce)` Forces a full page screenshot (by scrolling and stitching) if the browser only supports viewport screenshots).
`void`	`setHideCaret(boolean hideCaret)`
`void`	`setHideScrollbars(boolean shouldHide)` Hide the scrollbars when taking screenshots.
`void`	`setIsDisabled(boolean disabled)`
`void`	`setRegionToCheck(Region regionToCheck)`
`void`	`setRotation(ImageRotation rotation)`
`void`	`setScrollToRegion(boolean shouldScroll)` Turns on/off the automatic scrolling to a region being checked by `checkRegion`.
`void`	`setStitchMode(StitchMode mode)` Set the type of stitching used for full page screenshots.
`protected void`	`setViewportSize(RectangleSize size)` Use this method only if you made a previous call to `(WebDriver, String, String)` or one of its variants.
`static void`	`setViewportSize(org.openqa.selenium.WebDriver driver, RectangleSize size)` Set the viewport size using the driver.
`void`	`setWaitBeforeScreenshots(int waitBeforeScreenshots)` Sets the time to wait just before taking a screenshot (e.g., to allow positioning to stabilize when performing a full page stitching).
`boolean`	`shouldStitchContent()`
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName)` See `testResponseTime(WebDriver, String, String, WebDriverAction, int, int)`.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action)` See `testResponseTime(WebDriver, String, String, WebDriverAction, int, int)`.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, int deadline)` See `testResponseTime(WebDriver, String, String, WebDriverAction, int, int)`.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, int deadline, int timeout)` Run a visual performance test.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, int deadline, int timeout, RectangleSize viewportSize)` Similar to `testResponseTime(WebDriver, String, String, WebDriverAction, int, int)`, except this method sets the viewport size before starting the performance test.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, int deadline, RectangleSize viewportSize)` See `testResponseTime(WebDriver, String, String, WebDriverAction, int, int, RectangleSize)`.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, RectangleSize viewportSize)` See `testResponseTime(WebDriver, String, String, WebDriverAction, int, int, RectangleSize)`.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, int deadline)` See `testResponseTime(WebDriver, String, String, WebDriverAction, int, int)`.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, int deadline, int timeout, RectangleSize viewportSize)` See `testResponseTime(WebDriver, String, String, WebDriverAction, int, int, RectangleSize)`.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, int deadline, RectangleSize viewportSize)` See `testResponseTime(WebDriver, String, String, int, int, RectangleSize)`.
`void`	`testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, RectangleSize viewportSize)` See `testResponseTime(WebDriver, String, String, int, int, RectangleSize)`.
`void`	`testWindow(org.openqa.selenium.WebDriver driver, String testName)` See `testWindow(WebDriver, String, RectangleSize)`.
`void`	`testWindow(org.openqa.selenium.WebDriver driver, String testName, RectangleSize viewportSize)` See `testWindow(WebDriver, String, String, RectangleSize)`.
`void`	`testWindow(org.openqa.selenium.WebDriver driver, String appName, String testName)` See `testWindow(WebDriver, String, String, RectangleSize)`.
`void`	`testWindow(org.openqa.selenium.WebDriver driver, String appName, String testName, RectangleSize viewportSize)` Runs a test on the current window.
`String`	`tryCaptureDom()`
`protected ScaleProviderFactory`	`updateScalingParams()` Updates the state of scaling related parameters.

Methods inherited from class com.applitools.eyes.EyesBase
abortIfNotClosed, addMouseTriggerBase, addProperty, addSessionEventHandler, addTextTriggerBase, addUserInput, afterMatchWindow, afterOpen, beforeMatchWindow, checkWindowBase, checkWindowBase, checkWindowBase, clearProperties, clearSessionEventHandlers, clearUserInputs, close, closeLogger, closeResponseTime, ensureRunningSession, 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, getRenderingInfo, getSaveDebugScreenshots, getSaveDiffs, getSaveFailedTests, getSaveNewTests, getScaleRatio, getServerUrl, getSessionEventHandlers, getStitchOverlap, getUserInputs, log, openBase, openBase, openLogger, removeSessionEventHandler, setAgentId, setApiKey, setAppEnvironment, setAppName, setBaselineBranchName, setBaselineEnvName, setBaselineName, setBatch, setBranchName, setDebugScreenshotsPath, setDebugScreenshotsPrefix, setDefaultMatchSettings, setEnvName, setExplicitViewportSize, setFailureReports, setHostApp, setHostOS, setIgnoreCaret, setImageCut, 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

Methods inherited from interface com.applitools.eyes.IEyes
abortIfNotClosed, getApiKey, getIsDisabled, getIsOpen, getLogger, getServerUrl, setApiKey, setBranchName, setLogHandler, setMatchLevel, setParentBranchName, setProxy, setServerUrl

- Field Detail
  - UNKNOWN_DEVICE_PIXEL_RATIO
```
public static final double UNKNOWN_DEVICE_PIXEL_RATIO
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DEVICE_PIXEL_RATIO
```
public static final double DEFAULT_DEVICE_PIXEL_RATIO
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Eyes
```
public Eyes()
```
    Creates a new Eyes instance that interacts with the Eyes cloud service.
- Method Detail
  - getBaseAgentId
```
public String getBaseAgentId()
```
    Specified by:
    
    getBaseAgentId in class EyesBase
  - getDriver
```
public org.openqa.selenium.WebDriver getDriver()
```
  - getOriginalFC
```
public FrameChain getOriginalFC()
```
  - getCurrentFramePositionProvider
```
public PositionProvider getCurrentFramePositionProvider()
```
  - getRegionToCheck
```
public Region getRegionToCheck()
```
  - setRegionToCheck
```
public void setRegionToCheck(Region regionToCheck)
```
  - ensureConfiguration
```
protected void ensureConfiguration()
```
    Overrides:
    
    ensureConfiguration in class EyesBase
  - getHideCaret
```
public boolean getHideCaret()
```
  - setHideCaret
```
public void setHideCaret(boolean hideCaret)
```
    Specified by:
    
    setHideCaret in interface IEyes
  - shouldStitchContent
```
public boolean shouldStitchContent()
```
  - setForceFullPageScreenshot
```
public void setForceFullPageScreenshot(boolean shouldForce)
```
    Forces a full page screenshot (by scrolling and stitching) if the browser only supports viewport screenshots).
    
    Parameters:
    
    shouldForce - Whether to force a full page screenshot or not.
  - getForceFullPageScreenshot
```
public boolean getForceFullPageScreenshot()
```
    Returns:
    
    Whether Eyes should force a full page screenshot.
  - setWaitBeforeScreenshots
```
public void setWaitBeforeScreenshots(int waitBeforeScreenshots)
```
    Sets the time to wait just before taking a screenshot (e.g., to allow positioning to stabilize when performing a full page stitching).
    
    Parameters:
    
    waitBeforeScreenshots - The time to wait (Milliseconds). Values smaller or equal to 0, will cause the default value to be used.
  - getWaitBeforeScreenshots
```
public int getWaitBeforeScreenshots()
```
    Returns:
    
    The time to wait just before taking a screenshot.
  - setScrollToRegion
```
public void setScrollToRegion(boolean shouldScroll)
```
    Turns on/off the automatic scrolling to a region being checked by checkRegion.
    
    Parameters:
    
    shouldScroll - Whether to automatically scroll to a region being validated.
  - getScrollToRegion
```
public boolean getScrollToRegion()
```
    Returns:
    
    Whether to automatically scroll to a region being validated.
  - setStitchMode
```
public void setStitchMode(StitchMode mode)
```
    Set the type of stitching used for full page screenshots. When the page includes fixed position header/sidebar, use StitchMode.CSS. Default is StitchMode.SCROLL.
    
    Parameters:
    
    mode - The stitch mode to set.
  - getStitchMode
```
public StitchMode getStitchMode()
```
    Returns:
    
    The current stitch mode settings.
  - setHideScrollbars
```
public void setHideScrollbars(boolean shouldHide)
```
    Hide the scrollbars when taking screenshots.
    
    Parameters:
    
    shouldHide - Whether to hide the scrollbars or not.
  - getHideScrollbars
```
public boolean getHideScrollbars()
```
    Returns:
    
    Whether or not scrollbars are hidden when taking screenshots.
  - getRotation
```
public ImageRotation getRotation()
```
    Returns:
    
    The image rotation model.
  - setRotation
```
public void setRotation(ImageRotation rotation)
```
    Parameters:
    
    rotation - The image rotation model.
  - getDevicePixelRatio
```
public double getDevicePixelRatio()
```
    Returns:
    
    The device pixel ratio, or UNKNOWN_DEVICE_PIXEL_RATIO if the DPR is not known yet or if it wasn't possible to extract it.
  - open
```
public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                          Configuration configuration)
```
  - open
```
public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                          String appName,
                                          String testName,
                                          RectangleSize viewportSize)
```
    See open(WebDriver, String, String, RectangleSize, SessionType). sessionType defaults to null.
  - open
```
public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                          String appName,
                                          String testName)
```
    See open(WebDriver, String, String, SessionType). viewportSize defaults to null. sessionType defaults to null.
  - open
```
protected org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                             String appName,
                                             String testName,
                                             RectangleSize viewportSize,
                                             SessionType sessionType)
```
    Starts a test.
    
    Parameters:
    
    driver - The web driver that controls the browser hosting the application under test.
    
    appName - The name of the application under test.
    
    testName - The test name.
    
    viewportSize - The required browser's viewport size (i.e., the visible part of the document's body) or null to use the current window's viewport.
    
    sessionType - The type of test (e.g., standard test / visual performance test).
    
    Returns:
    
    A wrapped WebDriver which enables Eyes trigger recording and frame handling.
  - open
```
protected org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver)
                                      throws EyesException
```
    Throws:
    
    EyesException
  - getScrollRootElement
```
public org.openqa.selenium.WebElement getScrollRootElement()
```
  - open
```
protected org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                             String appName,
                                             String testName,
                                             SessionType sessionType)
```
    See open(WebDriver, String, String, RectangleSize). viewportSize defaults to null.
  - checkWindow
```
public void checkWindow()
```
    See checkWindow(String). tag defaults to null. Default match timeout is used.
  - checkWindow
```
public void checkWindow(String tag)
```
    See checkWindow(int, String). Default match timeout is used.
    
    Parameters:
    
    tag - An optional tag to be associated with the snapshot.
  - checkWindow
```
public void checkWindow(int matchTimeout,
                        String tag)
```
    Takes a snapshot of the application under test and matches it with the expected output.
    
    Parameters:
    
    matchTimeout - The amount of time to retry matching (Milliseconds).
    
    tag - An optional tag to be associated with the snapshot.
    
    Throws:
    
    TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.
  - testWindow
```
public void testWindow(org.openqa.selenium.WebDriver driver,
                       String appName,
                       String testName,
                       RectangleSize viewportSize)
```
    Runs a test on the current window.
    
    Parameters:
    
    driver - The web driver that controls the browser hosting the application under test.
    
    appName - The name of the application under test.
    
    testName - The test name (will also be used as the tag name for the step).
    
    viewportSize - The required browser's viewport size (i.e., the visible part of the document's body) or null to use the current window's viewport.
  - testWindow
```
public void testWindow(org.openqa.selenium.WebDriver driver,
                       String appName,
                       String testName)
```
    See testWindow(WebDriver, String, String, RectangleSize). viewportSize defaults to null.
  - testWindow
```
public void testWindow(org.openqa.selenium.WebDriver driver,
                       String testName,
                       RectangleSize viewportSize)
```
    See testWindow(WebDriver, String, String, RectangleSize). appName defaults to null (which means the name set in EyesBase.setAppName(String) would be used.
  - testWindow
```
public void testWindow(org.openqa.selenium.WebDriver driver,
                       String testName)
```
    See testWindow(WebDriver, String, RectangleSize). viewportSize defaults to null.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             int deadline,
                             int timeout)
```
    Run a visual performance test.
    
    Parameters:
    
    driver - The driver to use.
    
    appName - The name of the application being tested.
    
    testName - The test name.
    
    action - Actions to be performed in parallel to starting the test.
    
    deadline - The expected time until the application should have been loaded. (Seconds)
    
    timeout - The maximum time until the application should have been loaded. (Seconds)
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             int deadline)
```
    See testResponseTime(WebDriver, String, String, WebDriverAction, int, int). timeout defaults to deadline + RESPONSE_TIME_DEFAULT_DIFF_FROM_DEADLINE.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action)
```
    See testResponseTime(WebDriver, String, String, WebDriverAction, int, int). deadline defaults to RESPONSE_TIME_DEFAULT_DEADLINE. timeout defaults to RESPONSE_TIME_DEFAULT_DEADLINE + RESPONSE_TIME_DEFAULT_DIFF_FROM_DEADLINE.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             int deadline)
```
    See testResponseTime(WebDriver, String, String, WebDriverAction, int, int). action defaults to null. timeout defaults to deadline + RESPONSE_TIME_DEFAULT_DIFF_FROM_DEADLINE.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName)
```
    See testResponseTime(WebDriver, String, String, WebDriverAction, int, int). deadline defaults to RESPONSE_TIME_DEFAULT_DEADLINE. timeout defaults to RESPONSE_TIME_DEFAULT_DEADLINE + RESPONSE_TIME_DEFAULT_DIFF_FROM_DEADLINE. action defaults to null.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             int deadline,
                             int timeout,
                             RectangleSize viewportSize)
```
    Similar to testResponseTime(WebDriver, String, String, WebDriverAction, int, int), except this method sets the viewport size before starting the performance test.
    
    Parameters:
    
    viewportSize - The required viewport size.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             int deadline,
                             RectangleSize viewportSize)
```
    See testResponseTime(WebDriver, String, String, WebDriverAction, int, int, RectangleSize). timeout defaults to deadline + RESPONSE_TIME_DEFAULT_DIFF_FROM_DEADLINE.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             RectangleSize viewportSize)
```
    See testResponseTime(WebDriver, String, String, WebDriverAction, int, int, RectangleSize). deadline defaults to RESPONSE_TIME_DEFAULT_DEADLINE. timeout defaults to RESPONSE_TIME_DEFAULT_DEADLINE + RESPONSE_TIME_DEFAULT_DIFF_FROM_DEADLINE.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             int deadline,
                             int timeout,
                             RectangleSize viewportSize)
```
    See testResponseTime(WebDriver, String, String, WebDriverAction, int, int, RectangleSize). action defaults to null.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             int deadline,
                             RectangleSize viewportSize)
```
    See testResponseTime(WebDriver, String, String, int, int, RectangleSize). timeout defaults to deadline + RESPONSE_TIME_DEFAULT_DIFF_FROM_DEADLINE.
  - testResponseTime
```
public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             RectangleSize viewportSize)
```
    See testResponseTime(WebDriver, String, String, int, int, RectangleSize). deadline defaults to RESPONSE_TIME_DEFAULT_DEADLINE. timeout defaults to RESPONSE_TIME_DEFAULT_DEADLINE + RESPONSE_TIME_DEFAULT_DIFF_FROM_DEADLINE.
  - check
```
public void check(ICheckSettings... checkSettings)
```
    Takes multiple screenshots at once (given all ICheckSettings objects are on the same level).
    
    Parameters:
    
    checkSettings - Multiple ICheckSettings object representing different regions in the viewport.
  - check
```
public void check(String name,
                  ICheckSettings checkSettings)
```
    Specified by:
    
    check in interface IEyes
  - setIsDisabled
```
public void setIsDisabled(boolean disabled)
```
    Specified by:
    
    setIsDisabled in interface IEyes
    
    Overrides:
    
    setIsDisabled in class EyesBase
  - tryCaptureDom
```
public String tryCaptureDom()
```
    Specified by:
    
    tryCaptureDom in class EyesBase
  - check
```
public void check(ICheckSettings checkSettings)
```
    Specified by:
    
    check in interface IEyes
  - checkFrameFluent
```
protected MatchResult checkFrameFluent(String name,
                                       ICheckSettings checkSettings)
```
  - checkRegion
```
public void checkRegion(Region region)
```
    See checkRegion(Region, int, String). tag defaults to null. Default match timeout is used.
  - checkRegion
```
public void checkRegion(Region region,
                        int matchTimeout,
                        String tag)
```
    Takes a snapshot of the application under test and matches a specific region within it with the expected output.
    
    Parameters:
    
    region - A non empty region representing the screen region to check.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
    
    Throws:
    
    TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.WebElement element)
```
    See checkRegion(WebElement, String). tag defaults to null.
    
    Parameters:
    
    element - The element which represents the region to check.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.WebElement element,
                        boolean stitchContent)
```
    If stitchContent is false then behaves the same as checkRegion(WebElement), otherwise behaves the same as checkElement(WebElement).
    
    Parameters:
    
    element - The element which represents the region to check.
    
    stitchContent - Whether to take a screenshot of the whole region and stitch if needed.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.WebElement element,
                        String tag)
```
    See checkRegion(WebElement, int, String). Default match timeout is used.
    
    Parameters:
    
    element - The element which represents the region to check.
    
    tag - An optional tag to be associated with the snapshot.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.WebElement element,
                        String tag,
                        boolean stitchContent)
```
    if stitchContent is false then behaves the same checkRegion(WebElement, String). Otherwise behaves the same as checkElement(WebElement, String).
    
    Parameters:
    
    element - The element which represents the region to check.
    
    tag - An optional tag to be associated with the snapshot.
    
    stitchContent - Whether to take a screenshot of the whole region and stitch if needed.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.WebElement element,
                        int matchTimeout,
                        String tag)
```
    Takes a snapshot of the application under test and matches a region of a specific element with the expected region output.
    
    Parameters:
    
    element - The element which represents the region to check.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
    
    Throws:
    
    TestFailedException - if a mismatch is detected and immediate failure reports are enabled
  - checkRegion
```
public void checkRegion(org.openqa.selenium.WebElement element,
                        int matchTimeout,
                        String tag,
                        boolean stitchContent)
```
    if stitchContent is false then behaves the same checkRegion(WebElement, int, String). Otherwise behaves the same as checkElement(WebElement, String).
    
    Parameters:
    
    element - The element which represents the region to check.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
    
    stitchContent - Whether to take a screenshot of the whole region and stitch if needed.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.By selector)
```
    See checkRegion(By, String). tag defaults to null.
    
    Parameters:
    
    selector - The selector by which to specify which region to check.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.By selector,
                        boolean stitchContent)
```
    If stitchContent is false then behaves the same as checkRegion(By). Otherwise, behaves the same as #checkElement(org.openqa.selenium.By)
    
    Parameters:
    
    selector - The selector by which to specify which region to check.
    
    stitchContent - Whether to take a screenshot of the whole region and stitch if needed.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.By selector,
                        String tag)
```
    See checkRegion(By, int, String). Default match timeout is used.
    
    Parameters:
    
    selector - The selector by which to specify which region to check.
    
    tag - An optional tag to be associated with the screenshot.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.By selector,
                        String tag,
                        boolean stitchContent)
```
    If stitchContent is false then behaves the same as checkRegion(By, String). Otherwise, behaves the same as checkElement(By, String).
    
    Parameters:
    
    selector - The selector by which to specify which region to check.
    
    tag - An optional tag to be associated with the screenshot.
    
    stitchContent - Whether to take a screenshot of the whole region and stitch if needed.
  - checkRegion
```
public void checkRegion(org.openqa.selenium.By selector,
                        int matchTimeout,
                        String tag)
```
    Takes a snapshot of the application under test and matches a region specified by the given selector with the expected region output.
    
    Parameters:
    
    selector - The selector by which to specify which region to check.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the screenshot.
    
    Throws:
    
    TestFailedException - if a mismatch is detected and immediate failure reports are enabled
  - checkRegion
```
public void checkRegion(org.openqa.selenium.By selector,
                        int matchTimeout,
                        String tag,
                        boolean stitchContent)
```
    If stitchContent is false then behaves the same as checkRegion(By, int, String). Otherwise, behaves the same as checkElement(By, int, String).
    
    Parameters:
    
    selector - The selector by which to specify which region to check.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the screenshot.
    
    stitchContent - Whether to take a screenshot of the whole region and stitch if needed.
  - checkRegionInFrame
```
public void checkRegionInFrame(int frameIndex,
                               org.openqa.selenium.By selector)
```
    See checkRegionInFrame(int, By, String). tag defaults to null.
    
    Parameters:
    
    frameIndex - The index of the frame to switch to. (The same index as would be used in a call to driver.switchTo().frame()).
    
    selector - The selector by which to specify which region to check inside the frame.
  - checkRegionInFrame
```
public void checkRegionInFrame(int frameIndex,
                               org.openqa.selenium.By selector,
                               boolean stitchContent)
```
    See checkRegionInFrame(int, By, String). tag defaults to null.
    
    Parameters:
    
    frameIndex - The index of the frame to switch to. (The same index as would be used in a call to driver.switchTo().frame()).
    
    selector - The selector by which to specify which region to check inside the frame.
    
    stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - checkRegionInFrame
```
public void checkRegionInFrame(int frameIndex,
                               org.openqa.selenium.By selector,
                               String tag)
```
    See checkRegionInFrame(int, By, String, boolean). stitchContent defaults to false.
    
    Parameters:
    
    frameIndex - The index of the frame to switch to. (The same index as would be used in a call to driver.switchTo().frame()).
    
    selector - The selector by which to specify which region to check inside the frame.
    
    tag - An optional tag to be associated with the screenshot.
  - checkRegionInFrame
```
public void checkRegionInFrame(int frameIndex,
                               org.openqa.selenium.By selector,
                               String tag,
                               boolean stitchContent)
```
    See checkRegionInFrame(int, By, int, String, boolean). Default match timeout is used.
    
    Parameters:
    
    frameIndex - The index of the frame to switch to. (The same index as would be used in a call to driver.switchTo().frame()).
    
    selector - The selector by which to specify which region to check inside the frame.
    
    tag - An optional tag to be associated with the screenshot.
    
    stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - checkRegionInFrame
```
public void checkRegionInFrame(int frameIndex,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag)
```
    See checkRegionInFrame(int, By, int, String, boolean). stitchContent defaults to false.
    
    Parameters:
    
    frameIndex - The index of the frame to switch to. (The same index as would be used in a call to driver.switchTo().frame()).
    
    selector - The selector by which to specify which region to check inside the frame.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the screenshot.
  - checkRegionInFrame
```
public void checkRegionInFrame(int frameIndex,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag,
                               boolean stitchContent)
```
    Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
    
    Parameters:
    
    frameIndex - The index of the frame to switch to. (The same index as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
    
    stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - checkRegionInFrame
```
public void checkRegionInFrame(String frameNameOrId,
                               org.openqa.selenium.By selector)
```
    See checkRegionInFrame(String, By, int, String, boolean). stitchContent defaults to null.
    
    Parameters:
    
    frameNameOrId - The name or id of the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check.
  - checkRegionInFrame
```
public void checkRegionInFrame(String frameNameOrId,
                               org.openqa.selenium.By selector,
                               boolean stitchContent)
```
    See checkRegionInFrame(String, By, int, String, boolean). tag defaults to null.
    
    Parameters:
    
    frameNameOrId - The name or id of the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check.
    
    stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - checkRegionInFrame
```
public void checkRegionInFrame(String frameNameOrId,
                               org.openqa.selenium.By selector,
                               String tag)
```
    See checkRegionInFrame(String, By, int, String, boolean). stitchContent defaults to null.
    
    Parameters:
    
    frameNameOrId - The name or id of the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check.
    
    tag - An optional tag to be associated with the snapshot.
  - checkRegionInFrame
```
public void checkRegionInFrame(String frameNameOrId,
                               org.openqa.selenium.By selector,
                               String tag,
                               boolean stitchContent)
```
    See checkRegionInFrame(String, By, int, String, boolean). Default match timeout is used
    
    Parameters:
    
    frameNameOrId - The name or id of the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check.
    
    tag - An optional tag to be associated with the snapshot.
    
    stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - checkRegionInFrame
```
public void checkRegionInFrame(String frameNameOrId,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag)
```
    See checkRegionInFrame(String, By, int, String, boolean). stitchContent defaults to false.
    
    Parameters:
    
    frameNameOrId - The name or id of the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check inside the frame.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
  - checkRegionInFrame
```
public void checkRegionInFrame(String frameNameOrId,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag,
                               boolean stitchContent)
```
    Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
    
    Parameters:
    
    frameNameOrId - The name or id of the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check inside the frame.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
    
    stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - checkRegionInFrame
```
public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                               org.openqa.selenium.By selector)
```
    See checkRegionInFrame(WebElement, By, boolean). stitchContent defaults to null.
    
    Parameters:
    
    frameReference - The element which is the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check inside the frame.
  - checkRegionInFrame
```
public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                               org.openqa.selenium.By selector,
                               boolean stitchContent)
```
    See checkRegionInFrame(WebElement, By, String, boolean). tag defaults to null.
    
    Parameters:
    
    frameReference - The element which is the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check inside the frame.
    
    stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - checkRegionInFrame
```
public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                               org.openqa.selenium.By selector,
                               String tag)
```
    See checkRegionInFrame(WebElement, By, String, boolean). stitchContent defaults to false.
    
    Parameters:
    
    frameReference - The element which is the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check inside the frame.
    
    tag - An optional tag to be associated with the snapshot.
  - checkRegionInFrame
```
public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                               org.openqa.selenium.By selector,
                               String tag,
                               boolean stitchContent)
```
    See checkRegionInFrame(WebElement, By, int, String, boolean). Default match timeout is used.
    
    Parameters:
    
    frameReference - The element which is the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check inside the frame.
    
    tag - An optional tag to be associated with the snapshot.
    
    stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - checkRegionInFrame
```
public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag)
```
    See checkRegionInFrame(WebElement, By, int, String, boolean). stitchContent defaults to false.
    
    Parameters:
    
    frameReference - The element which is the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check inside the frame.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
  - checkRegionInFrame
```
public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag,
                               boolean stitchContent)
```
    Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
    
    Parameters:
    
    frameReference - The element which is the frame to switch to. (as would be used in a call to driver.switchTo().frame()).
    
    selector - A Selector specifying the region to check.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
    
    stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - updateScalingParams
```
protected ScaleProviderFactory updateScalingParams()
```
    Updates the state of scaling related parameters.
  - getCurrentFrameScrollRootElement
```
public org.openqa.selenium.WebElement getCurrentFrameScrollRootElement()
```
  - checkCurrentFrame
```
protected void checkCurrentFrame(int matchTimeout,
                                 String tag)
```
    Verifies the current frame.
    
    Parameters:
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
  - checkFrame
```
public void checkFrame(String frameNameOrId)
```
    See checkFrame(String, int, String). tag defaults to null. Default match timeout is used.
  - checkFrame
```
public void checkFrame(String frameNameOrId,
                       String tag)
```
    See checkFrame(String, int, String). Default match timeout is used.
  - checkFrame
```
public void checkFrame(String frameNameOrId,
                       int matchTimeout,
                       String tag)
```
    Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
    
    Parameters:
    
    frameNameOrId - The name or id of the frame to check. (The same name/id as would be used in a call to driver.switchTo().frame()).
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the match.
  - checkFrame
```
public void checkFrame(int frameIndex)
```
    See checkFrame(int, int, String). tag defaults to null. Default match timeout is used.
  - checkFrame
```
public void checkFrame(int frameIndex,
                       String tag)
```
    See checkFrame(int, int, String). Default match timeout is used.
  - checkFrame
```
public void checkFrame(int frameIndex,
                       int matchTimeout,
                       String tag)
```
    Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
    
    Parameters:
    
    frameIndex - The index of the frame to switch to. (The same index as would be used in a call to driver.switchTo().frame()).
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the match.
  - checkFrame
```
public void checkFrame(org.openqa.selenium.WebElement frameReference)
```
    See checkFrame(WebElement, int, String). tag defaults to null. Default match timeout is used.
  - checkFrame
```
public void checkFrame(org.openqa.selenium.WebElement frameReference,
                       String tag)
```
    See checkFrame(WebElement, int, String). Default match timeout is used.
  - checkFrame
```
public void checkFrame(org.openqa.selenium.WebElement frameReference,
                       int matchTimeout,
                       String tag)
```
    Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
    
    Parameters:
    
    frameReference - The element which is the frame to switch to. (as would be used in a call to driver.switchTo().frame() ).
    
    matchTimeout - The amount of time to retry matching (milliseconds).
    
    tag - An optional tag to be associated with the match.
  - checkFrame
```
public void checkFrame(String[] framePath,
                       int matchTimeout,
                       String tag)
```
    Matches the frame given by the frames path, by switching into the frame and using stitching to get an image of the frame.
    
    Parameters:
    
    framePath - The path to the frame to check. This is a list of frame names/IDs (where each frame is nested in the previous frame).
    
    matchTimeout - The amount of time to retry matching (milliseconds).
    
    tag - An optional tag to be associated with the match.
  - checkFrame
```
public void checkFrame(String[] framesPath,
                       String tag)
```
    See checkFrame(String[], int, String). Default match timeout is used.
  - checkFrame
```
public void checkFrame(String[] framesPath)
```
    See checkFrame(String[], int, String). Default match timeout is used. tag defaults to null.
  - checkRegionInFrame
```
public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag,
                               boolean stitchContent)
```
    Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
    
    Parameters:
    
    framePath - The path to the frame to check. This is a list of frame names/IDs (where each frame is nested in the previous frame).
    
    selector - A Selector specifying the region to check.
    
    matchTimeout - The amount of time to retry matching (milliseconds).
    
    tag - An optional tag to be associated with the snapshot.
    
    stitchContent - Whether or not to stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.
  - checkRegionInFrame
```
public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag)
```
    See checkRegionInFrame(String[], By, int, String, boolean). stitchContent defaults to false.
  - checkRegionInFrame
```
public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector,
                               String tag)
```
    See checkRegionInFrame(String[], By, int, String). Default match timeout is used.
  - checkRegionInFrame
```
public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector)
```
    See checkRegionInFrame(String[], By, int, String). Default match timeout is used. tag defaults to null.
  - checkElement
```
public void checkElement(org.openqa.selenium.WebElement element)
```
    See checkElement(WebElement, String). tag defaults to null.
  - checkElement
```
public void checkElement(org.openqa.selenium.WebElement element,
                         String tag)
```
    See checkElement(WebElement, int, String). Default match timeout is used.
  - checkElement
```
public void checkElement(org.openqa.selenium.WebElement element,
                         int matchTimeout,
                         String tag)
```
    Takes a snapshot of the application under test and matches a specific element with the expected region output.
    
    Parameters:
    
    element - The element to check.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the snapshot.
    
    Throws:
    
    TestFailedException - if a mismatch is detected and immediate failure reports are enabled
  - checkElement
```
public void checkElement(org.openqa.selenium.By selector)
```
    See checkElement(By, String). tag defaults to null.
  - checkElement
```
public void checkElement(org.openqa.selenium.By selector,
                         String tag)
```
    See checkElement(By, int, String). Default match timeout is used.
  - checkElement
```
public void checkElement(org.openqa.selenium.By selector,
                         int matchTimeout,
                         String tag)
```
    Takes a snapshot of the application under test and matches an element specified by the given selector with the expected region output.
    
    Parameters:
    
    selector - Selects the element to check.
    
    matchTimeout - The amount of time to retry matching. (Milliseconds)
    
    tag - An optional tag to be associated with the screenshot.
    
    Throws:
    
    TestFailedException - if a mismatch is detected and immediate failure reports are enabled
  - addMouseTrigger
```
public void addMouseTrigger(MouseAction action,
                            Region control,
                            Location cursor)
```
    Adds a mouse trigger.
    
    Parameters:
    
    action - Mouse action.
    
    control - The control on which the trigger is activated (context relative coordinates).
    
    cursor - The cursor's position relative to the control.
  - addMouseTrigger
```
public void addMouseTrigger(MouseAction action,
                            org.openqa.selenium.WebElement element)
```
    Adds a mouse trigger.
    
    Parameters:
    
    action - Mouse action.
    
    element - The WebElement on which the click was called.
  - addTextTrigger
```
public void addTextTrigger(Region control,
                           String text)
```
    Adds a keyboard trigger.
    
    Parameters:
    
    control - The control's context-relative region.
    
    text - The trigger's text.
  - addTextTrigger
```
public void addTextTrigger(org.openqa.selenium.WebElement element,
                           String text)
```
    Adds a keyboard trigger.
    
    Parameters:
    
    element - The element for which we sent keys.
    
    text - The trigger's text.
  - getViewportSize
```
public RectangleSize getViewportSize()
```
    Use this method only if you made a previous call to (WebDriver, String, String) or one of its variants.
    
    Specified by:
    
    getViewportSize in class EyesBase
  - getViewportSize
```
public static RectangleSize getViewportSize(org.openqa.selenium.WebDriver driver)
```
    Call this method if for some reason you don't want to call open(WebDriver, String, String) (or one of its variants) yet.
    
    Parameters:
    
    driver - The driver to use for getting the viewport.
    
    Returns:
    
    The viewport size of the current context.
  - setViewportSize
```
protected void setViewportSize(RectangleSize size)
```
    Use this method only if you made a previous call to (WebDriver, String, String) or one of its variants.
    
    Specified by:
    
    setViewportSize in class EyesBase
  - setViewportSize
```
public static void setViewportSize(org.openqa.selenium.WebDriver driver,
                                   RectangleSize size)
```
    Set the viewport size using the driver. Call this method if for some reason you don't want to call open(WebDriver, String, String) (or one of its variants) yet.
    
    Parameters:
    
    driver - The driver to use for setting the viewport.
    
    size - The required viewport size.
  - beforeOpen
```
protected void beforeOpen()
```
    Overrides:
    
    beforeOpen in class EyesBase
  - getSubScreenshot
```
protected EyesScreenshot getSubScreenshot(EyesScreenshot screenshot,
                                          Region region,
                                          ICheckSettingsInternal checkSettingsInternal)
```
    Overrides:
    
    getSubScreenshot in class EyesBase
  - getScreenshot
```
protected EyesScreenshot getScreenshot()
```
    Specified by:
    
    getScreenshot in class EyesBase
  - getTitle
```
protected String getTitle()
```
    Specified by:
    
    getTitle in class EyesBase
  - getInferredEnvironment
```
protected String getInferredEnvironment()
```
    Specified by:
    
    getInferredEnvironment in class EyesBase
  - getAppEnvironment
```
protected AppEnvironment getAppEnvironment()
```
    This override also checks for mobile operating system.
    
    Overrides:
    
    getAppEnvironment in class EyesBase
  - getAUTSessionId
```
protected String getAUTSessionId()
```
    Specified by:
    
    getAUTSessionId in class EyesBase
  - close
```
public TestResults close(boolean throwEx)
```
    Overrides:
    
    close in class EyesBase
  - getAgentSetup
```
public Object getAgentSetup()
```
    Overrides:
    
    getAgentSetup in class EyesBase
  - getServerConnector
```
public IServerConnector getServerConnector()
```
  - isSendDom
```
public boolean isSendDom()
```
    Overrides:
    
    isSendDom in class EyesBase

Class Eyes

Nested Class Summary

Field Summary

Fields inherited from class com.applitools.eyes.EyesBase

Constructor Summary

Method Summary

Methods inherited from class com.applitools.eyes.EyesBase

Methods inherited from class java.lang.Object

Methods inherited from interface com.applitools.eyes.IEyes

Field Detail

UNKNOWN_DEVICE_PIXEL_RATIO

DEFAULT_DEVICE_PIXEL_RATIO

Constructor Detail

Eyes

Method Detail

getBaseAgentId

getDriver

getOriginalFC

getCurrentFramePositionProvider

getRegionToCheck

setRegionToCheck

ensureConfiguration

getHideCaret

setHideCaret

shouldStitchContent

setForceFullPageScreenshot

getForceFullPageScreenshot

setWaitBeforeScreenshots

getWaitBeforeScreenshots

setScrollToRegion

getScrollToRegion

setStitchMode

getStitchMode

setHideScrollbars

getHideScrollbars

getRotation

setRotation

getDevicePixelRatio

open

open

open

open

open

getScrollRootElement

open

checkWindow

checkWindow

checkWindow

testWindow

testWindow

testWindow

testWindow

testResponseTime

testResponseTime

testResponseTime

testResponseTime

testResponseTime

testResponseTime

testResponseTime

testResponseTime

testResponseTime

testResponseTime

testResponseTime

check

check

setIsDisabled

tryCaptureDom

check

checkFrameFluent

checkRegion

checkRegion

checkRegion

checkRegion

checkRegion

checkRegion

checkRegion

checkRegion

checkRegion

checkRegion

checkRegion