com.applitools.eyes

Class Eyes

java.lang.Object

com.applitools.eyes.Eyes

public class Eyes
extends Object

The main API gateway for the SDK.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARSET_NAME
protected com.applitools.eyes.EyesScreenshot	lastScreenshot
protected com.applitools.eyes.Logger	logger
protected com.applitools.eyes.RunningSession	runningSession
protected com.applitools.eyes.ServerConnector	serverConnector
protected com.applitools.eyes.SessionStartInfo	sessionStartInfo
protected static int	USE_DEFAULT_TIMEOUT
protected com.applitools.eyes.RectangleSize	viewportSize

Constructor Summary

Constructors

Constructor and Description
Eyes()
Eyes(URI serverUrl) Creates a new (possibly disabled) Eyes instance that interacts with the Eyes Server at the specified url.

Method Summary

Modifier and Type	Method and Description
void	abortIfNotClosed()
protected void	addMouseTrigger(com.applitools.eyes.MouseAction action, com.applitools.eyes.Region control, com.applitools.eyes.Location cursor) Adds a mouse trigger.
protected void	addMouseTrigger(com.applitools.eyes.MouseAction action, org.openqa.selenium.WebElement element) Adds a mouse trigger.
protected void	addMouseTriggerBase(com.applitools.eyes.MouseAction arg0, com.applitools.eyes.Region arg1, com.applitools.eyes.Location arg2)
protected void	addTextTrigger(com.applitools.eyes.Region control, String text) Adds a keyboard trigger.
protected void	addTextTrigger(org.openqa.selenium.WebElement element, String text) Adds a keyboard trigger.
protected void	addTextTriggerBase(com.applitools.eyes.Region arg0, String arg1)
protected void	addUserInput(com.applitools.eyes.Trigger arg0)
protected void	checkCurrentFrame(int matchTimeout, String tag) Checks the current frame
void	checkFrame(int frameIndex)
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)
void	checkFrame(String frameNameOrId)
void	checkFrame(String[] framesPath)
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)
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)
void	checkFrame(org.openqa.selenium.WebElement frameReference)
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)
void	checkRegion(org.openqa.selenium.By selector)
void	checkRegion(org.openqa.selenium.By selector, int matchTimeout, String tag)
void	checkRegion(org.openqa.selenium.By selector, String tag)
void	checkRegion(com.applitools.eyes.Region region)
void	checkRegion(com.applitools.eyes.Region region, int matchTimeout, String tag)
void	checkRegion(org.openqa.selenium.WebElement element)
void	checkRegion(org.openqa.selenium.WebElement element, int matchTimeout, String tag)
void	checkRegion(org.openqa.selenium.WebElement element, String tag)
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector)
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, int matchTimeout, String tag) 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)
void	checkRegionInFrame(String[] framePath, org.openqa.selenium.By selector)
void	checkRegionInFrame(String[] framePath, org.openqa.selenium.By selector, int matchTimeout, String tag) 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)
void	checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector)
void	checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, int matchTimeout, String tag) 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)
void	checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector)
void	checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, int matchTimeout, String tag) 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)
void	checkWindow()
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)
protected com.applitools.eyes.MatchResult	checkWindowBase(com.applitools.eyes.RegionProvider arg0, String arg1, boolean arg2)
protected com.applitools.eyes.MatchResult	checkWindowBase(com.applitools.eyes.RegionProvider arg0, String arg1, boolean arg2, int arg3)
protected void	clearUserInputs()
com.applitools.eyes.TestResults	close()
com.applitools.eyes.TestResults	close(boolean arg0)
String	getAgentId()
String	getApiKey()
String	getBaseAgentId()
String	getBaselineName()
com.applitools.eyes.BatchInfo	getBatch()
String	getBranchName()
static URI	getDefaultServerUrl()
protected com.applitools.eyes.AppEnvironment	getEnvironment() This override also checks for mobile operating system.
com.applitools.eyes.FailureReports	getFailureReports()
boolean	getForceFullPageScreenshot()
protected String	getFullAgentId()
boolean	getHideScrollbars()
String	getHostApp()
String	getHostOS()
protected String	getInferredEnvironment()
boolean	getIsDisabled()
boolean	getIsOpen()
com.applitools.eyes.LogHandler	getLogHandler()
com.applitools.eyes.MatchLevel	getMatchLevel()
int	getMatchTimeout()
String	getParentBranchName()
com.applitools.eyes.ProxySettings	getProxy()
boolean	getSaveFailedTests()
boolean	getSaveNewTests()
protected com.applitools.eyes.EyesScreenshot	getScreenshot()
URI	getServerUrl()
protected String	getTitle()
protected com.applitools.eyes.Trigger[]	getUserInputs()
protected com.applitools.eyes.RectangleSize	getViewportSize()
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName)
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, com.applitools.eyes.RectangleSize viewportSize) Starts a test.
void	openBase(String arg0, String arg1, com.applitools.eyes.RectangleSize arg2)
void	setAgentId(String arg0)
void	setApiKey(String arg0)
void	setAppEnvironment(String arg0, String arg1) Deprecated.
void	setBaselineName(String arg0)
void	setBatch(com.applitools.eyes.BatchInfo arg0)
void	setBranchName(String arg0)
void	setFailureReports(com.applitools.eyes.FailureReports arg0)
void	setForceFullPageScreenshot(boolean shouldForce)
void	setHideScrollbars(boolean shouldHide)
void	setHostApp(String arg0)
void	setHostOS(String arg0)
void	setIsDisabled(boolean arg0)
void	setLogHandler(com.applitools.eyes.LogHandler arg0)
void	setMatchLevel(com.applitools.eyes.MatchLevel arg0)
void	setMatchTimeout(int arg0)
void	setParentBranchName(String arg0)
void	setProxy(com.applitools.eyes.ProxySettings arg0)
void	setSaveFailedTests(boolean arg0)
void	setSaveNewTests(boolean arg0)
void	setServerUrl(URI arg0)
protected void	setViewportSize(com.applitools.eyes.RectangleSize size)
protected void	startSession()

Methods inherited from class java.lang.Object

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

Field Detail

USE_DEFAULT_TIMEOUT

protected static final int USE_DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CHARSET_NAME

public static final String DEFAULT_CHARSET_NAME

See Also:

Constant Field Values

serverConnector

protected com.applitools.eyes.ServerConnector serverConnector

runningSession

protected com.applitools.eyes.RunningSession runningSession

sessionStartInfo

protected com.applitools.eyes.SessionStartInfo sessionStartInfo

viewportSize

protected com.applitools.eyes.RectangleSize viewportSize

lastScreenshot

protected com.applitools.eyes.EyesScreenshot lastScreenshot

logger

protected com.applitools.eyes.Logger logger

Constructor Detail

Eyes

public Eyes(URI serverUrl)

Creates a new (possibly disabled) Eyes instance that interacts with the Eyes Server at the specified url.

Parameters:

serverUrl - The Eyes server URL.

Eyes

public Eyes()

Method Detail

getBaseAgentId

public String getBaseAgentId()

setForceFullPageScreenshot

public void setForceFullPageScreenshot(boolean shouldForce)

getForceFullPageScreenshot

public boolean getForceFullPageScreenshot()

setHideScrollbars

public void setHideScrollbars(boolean shouldHide)

getHideScrollbars

public boolean getHideScrollbars()

open

public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                          String appName,
                                          String testName,
                                          com.applitools.eyes.RectangleSize viewportSize)

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 allow any viewport size.

Returns:

A wrapped WebDriver which enables Eyes trigger recording and frame handling.

open

public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                          String appName,
                                          String testName)

checkWindow

public void checkWindow()

checkWindow

public void checkWindow(String tag)

Parameters:

tag - An optional tag to be associated with the snapshot.

See Also:

. Default match timeout is used.

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.

checkRegion

public void checkRegion(com.applitools.eyes.Region region)

checkRegion

public void checkRegion(com.applitools.eyes.Region region,
                        int matchTimeout,
                        String tag)

checkRegion

public void checkRegion(org.openqa.selenium.WebElement element)

checkRegion

public void checkRegion(org.openqa.selenium.WebElement element,
                        String tag)

checkRegion

public void checkRegion(org.openqa.selenium.WebElement element,
                        int matchTimeout,
                        String tag)

checkRegion

public void checkRegion(org.openqa.selenium.By selector)

checkRegion

public void checkRegion(org.openqa.selenium.By selector,
                        String tag)

checkRegion

public void checkRegion(org.openqa.selenium.By selector,
                        int matchTimeout,
                        String tag)

checkRegionInFrame

public void checkRegionInFrame(int frameIndex,
                               org.openqa.selenium.By selector)

checkRegionInFrame

public void checkRegionInFrame(int frameIndex,
                               org.openqa.selenium.By selector,
                               String tag)

checkRegionInFrame

public void checkRegionInFrame(int frameIndex,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag)

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.

checkRegionInFrame

public void checkRegionInFrame(String frameNameOrId,
                               org.openqa.selenium.By selector)

checkRegionInFrame

public void checkRegionInFrame(String frameNameOrId,
                               org.openqa.selenium.By selector,
                               String tag)

checkRegionInFrame

public void checkRegionInFrame(String frameNameOrId,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag)

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.

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)

checkRegionInFrame

public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                               org.openqa.selenium.By selector,
                               String tag)

checkRegionInFrame

public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag)

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.

checkCurrentFrame

protected void checkCurrentFrame(int matchTimeout,
                                 String tag)

Checks 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)

checkFrame

public void checkFrame(String frameNameOrId,
                       String tag)

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)

checkFrame

public void checkFrame(int frameIndex,
                       String tag)

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)

checkFrame

public void checkFrame(org.openqa.selenium.WebElement frameReference,
                       String tag)

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)

checkFrame

public void checkFrame(String[] framesPath)

checkRegionInFrame

public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag)

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.

checkRegionInFrame

public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector,
                               String tag)

checkRegionInFrame

public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector)

addMouseTrigger

protected void addMouseTrigger(com.applitools.eyes.MouseAction action,
                               com.applitools.eyes.Region control,
                               com.applitools.eyes.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

protected void addMouseTrigger(com.applitools.eyes.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

protected void addTextTrigger(com.applitools.eyes.Region control,
                              String text)

Adds a keyboard trigger.

Parameters:

control - The control's context-relative region.

text - The trigger's text.

addTextTrigger

protected 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

protected com.applitools.eyes.RectangleSize getViewportSize()

setViewportSize

protected void setViewportSize(com.applitools.eyes.RectangleSize size)

getScreenshot

protected com.applitools.eyes.EyesScreenshot getScreenshot()

getTitle

protected String getTitle()

getInferredEnvironment

protected String getInferredEnvironment()

getEnvironment

protected com.applitools.eyes.AppEnvironment getEnvironment()

This override also checks for mobile operating system.

setAgentId

public void setAgentId(String arg0)

getAgentId

public String getAgentId()

setApiKey

public void setApiKey(String arg0)

getApiKey

public String getApiKey()

setServerUrl

public void setServerUrl(URI arg0)

getServerUrl

public URI getServerUrl()

setProxy

public void setProxy(com.applitools.eyes.ProxySettings arg0)

getProxy

public com.applitools.eyes.ProxySettings getProxy()

setIsDisabled

public void setIsDisabled(boolean arg0)

getIsDisabled

public boolean getIsDisabled()

setBranchName

public void setBranchName(String arg0)

getBranchName

public String getBranchName()

setParentBranchName

public void setParentBranchName(String arg0)

getParentBranchName

public String getParentBranchName()

clearUserInputs

protected void clearUserInputs()

getUserInputs

protected com.applitools.eyes.Trigger[] getUserInputs()

setMatchTimeout

public void setMatchTimeout(int arg0)

getMatchTimeout

public int getMatchTimeout()

setSaveNewTests

public void setSaveNewTests(boolean arg0)

getSaveNewTests

public boolean getSaveNewTests()

setSaveFailedTests

public void setSaveFailedTests(boolean arg0)

getSaveFailedTests

public boolean getSaveFailedTests()

setBatch

public void setBatch(com.applitools.eyes.BatchInfo arg0)

getBatch

public com.applitools.eyes.BatchInfo getBatch()

setFailureReports

public void setFailureReports(com.applitools.eyes.FailureReports arg0)

getFailureReports

public com.applitools.eyes.FailureReports getFailureReports()

setMatchLevel

public void setMatchLevel(com.applitools.eyes.MatchLevel arg0)

getMatchLevel

public com.applitools.eyes.MatchLevel getMatchLevel()

getFullAgentId

protected String getFullAgentId()

getIsOpen

public boolean getIsOpen()

getDefaultServerUrl

public static URI getDefaultServerUrl()

setLogHandler

public void setLogHandler(com.applitools.eyes.LogHandler arg0)

getLogHandler

public com.applitools.eyes.LogHandler getLogHandler()

close

public com.applitools.eyes.TestResults close()

close

public com.applitools.eyes.TestResults close(boolean arg0)

abortIfNotClosed

public void abortIfNotClosed()

setHostOS

public void setHostOS(String arg0)

getHostOS

public String getHostOS()

setHostApp

public void setHostApp(String arg0)

getHostApp

public String getHostApp()

setBaselineName

public void setBaselineName(String arg0)

getBaselineName

public String getBaselineName()

setAppEnvironment

@Deprecated
public void setAppEnvironment(String arg0,
                                          String arg1)

Deprecated.

checkWindowBase

protected com.applitools.eyes.MatchResult checkWindowBase(com.applitools.eyes.RegionProvider arg0,
                                                          String arg1,
                                                          boolean arg2)

checkWindowBase

protected com.applitools.eyes.MatchResult checkWindowBase(com.applitools.eyes.RegionProvider arg0,
                                                          String arg1,
                                                          boolean arg2,
                                                          int arg3)

openBase

public void openBase(String arg0,
                     String arg1,
                     com.applitools.eyes.RectangleSize arg2)

addUserInput

protected void addUserInput(com.applitools.eyes.Trigger arg0)

addTextTriggerBase

protected void addTextTriggerBase(com.applitools.eyes.Region arg0,
                                  String arg1)

addMouseTriggerBase

protected void addMouseTriggerBase(com.applitools.eyes.MouseAction arg0,
                                   com.applitools.eyes.Region arg1,
                                   com.applitools.eyes.Location arg2)

startSession

protected void startSession()