com.applitools.eyes

Class Eyes

java.lang.Object

com.applitools.eyes.Eyes

public class Eyes
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected com.applitools.eyes.AgentConnector	agentConnector
static String	DEFAULT_CHARSET_NAME
protected static com.applitools.eyes.MatchLevel	DEFAULT_MATCH_LEVEL
protected com.applitools.eyes.EyesScreenshot	lastScreenshot
protected com.applitools.eyes.RunningSession	runningSession
protected com.applitools.eyes.SessionStartInfo	sessionStartInfo
protected com.applitools.eyes.RectangleSize	viewportSize

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	abortIfNotClosed()
void	addMouseTrigger(com.applitools.eyes.MouseAction action, com.applitools.eyes.Region control, com.applitools.eyes.Location cursor) Adds a mouse trigger.
void	addTextTrigger(com.applitools.eyes.Region control, String text) Adds a keyboard trigger.
protected void	addUserInput(com.applitools.eyes.Trigger arg0)
void	checkRegion(BufferedImage image, com.applitools.eyes.Region region) Perform visual validation of a region for a given image.
void	checkRegion(BufferedImage image, com.applitools.eyes.Region region, String tag) Perform visual validation for a region in a given image.
void	checkRegion(BufferedImage image, com.applitools.eyes.Region region, String tag, boolean ignoreMismatch) Perform visual validation for the current image.
void	checkWindow(BufferedImage image) Perform visual validation for a given image.
void	checkWindow(BufferedImage image, String tag) Perform visual validation for a given image.
void	checkWindow(BufferedImage image, String tag, boolean ignoreMismatch) Perform visual validation for a given image.
protected void	clearUserInputs()
com.applitools.eyes.TestResults	close()
com.applitools.eyes.TestResults	close(boolean arg0)
String	getAgentId()
static String	getApiKey() Gets the currently set API key or null if no key is set.
static URI	getDefaultServerUrl()
protected com.applitools.eyes.AppEnvironment	getEnvironment()
com.applitools.eyes.FailureReports	getFailureReports()
protected String	getInferredEnvironment()
boolean	getIsDisabled()
boolean	getIsOpen()
protected com.applitools.eyes.EyesScreenshot	getLastScreenshot()
static com.applitools.eyes.ProxySettings	getProxy() Get the current proxy settings.
boolean	getSaveFailedTests()
boolean	getSaveNewTests()
protected String	getTitle()
protected com.applitools.eyes.Trigger[]	getUserInputs()
protected com.applitools.eyes.RectangleSize	getViewportSize()
void	open(String appName, String testName) Starts a test for any viewport size that reports failures upon test completion.
void	open(String appName, String testName, com.applitools.eyes.RectangleSize viewportSize) Starts a test that reports failures upon test completion.
void	open(String appName, String testName, com.applitools.eyes.RectangleSize viewportSize, com.applitools.eyes.FailureReports failureReports) Starts a test.
void	open(String appName, String testName, com.applitools.eyes.RectangleSize viewportSize, com.applitools.eyes.MatchLevel matchLevel) Starts a test that reports failures upon test completion.
void	open(String appName, String testName, com.applitools.eyes.RectangleSize viewportSize, com.applitools.eyes.MatchLevel matchLevel, com.applitools.eyes.FailureReports failureReports) Starts a test.
protected void	resetLastScreenshot()
static void	setApiKey(String apiKey) Sets the API key of your applitools Eyes account.
void	setAppEnvironment(String arg0, String arg1)
void	setBatch(com.applitools.eyes.BatchInfo arg0)
void	setBranchName(String arg0)
static void	setLogHandler(com.applitools.eyes.LogHandler logHandler) Sets a handler of log messages generated by this API.
void	setParentBranchName(String arg0)
static void	setProxy(com.applitools.eyes.ProxySettings proxySettings) Sets a proxy.
void	setSaveFailedTests(boolean arg0)
void	setSaveNewTests(boolean arg0)
protected void	setViewportSize(com.applitools.eyes.RectangleSize arg0)
protected void	startSession()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MATCH_LEVEL

protected static final com.applitools.eyes.MatchLevel DEFAULT_MATCH_LEVEL

DEFAULT_CHARSET_NAME

public static final String DEFAULT_CHARSET_NAME

See Also:

Constant Field Values

agentConnector

protected com.applitools.eyes.AgentConnector agentConnector

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

Constructor Detail

Eyes

public Eyes(URI serverUrl,
    boolean isDisabled)

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

Parameters:

serverUrl - The Eyes server URL.

isDisabled - If true, all interactions with this API will be

Eyes

public Eyes(URI serverUrl)

Creates a new Eyes instance that interacts with the Eyes Server at the specified url.

Parameters:

serverUrl - The Eyes server URL.

Eyes

public Eyes()

Creates a new Eyes instance that interacts with the Eyes Server at the specified url.

Method Detail

setLogHandler

public static void setLogHandler(com.applitools.eyes.LogHandler logHandler)

Sets a handler of log messages generated by this API.

Parameters:

logHandler - Handles log messages generated by this API.

setApiKey

public static void setApiKey(String apiKey)

Sets the API key of your applitools Eyes account.

getApiKey

public static String getApiKey()

Gets the currently set API key or null if no key is set.

setProxy

public static void setProxy(com.applitools.eyes.ProxySettings proxySettings)

Sets a proxy. Set null to remove existing proxy settings.

getProxy

public static com.applitools.eyes.ProxySettings getProxy()

Get the current proxy settings.

open

public void open(String appName,
        String testName,
        com.applitools.eyes.RectangleSize viewportSize,
        com.applitools.eyes.MatchLevel matchLevel,
        com.applitools.eyes.FailureReports failureReports)

Starts a test.

Parameters:

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.

matchLevel - The test-wide match level to use when comparing actual application outputs with expected outputs (overrides stricter step-specific match levels).

failureReports - Specifies how detected failures are reported.

open

public void open(String appName,
        String testName,
        com.applitools.eyes.RectangleSize viewportSize,
        com.applitools.eyes.MatchLevel matchLevel)

Starts a test that reports failures upon test completion.

See open(java.lang.String, java.lang.String, com.applitools.eyes.RectangleSize, com.applitools.eyes.MatchLevel, com.applitools.eyes.FailureReports).

open

public void open(String appName,
        String testName,
        com.applitools.eyes.RectangleSize viewportSize,
        com.applitools.eyes.FailureReports failureReports)

Starts a test.

See open(java.lang.String, java.lang.String, com.applitools.eyes.RectangleSize, com.applitools.eyes.MatchLevel, com.applitools.eyes.FailureReports).

open

public void open(String appName,
        String testName,
        com.applitools.eyes.RectangleSize viewportSize)

Starts a test that reports failures upon test completion.

See open(java.lang.String, java.lang.String, com.applitools.eyes.RectangleSize, com.applitools.eyes.MatchLevel, com.applitools.eyes.FailureReports).

open

public void open(String appName,
        String testName)

Starts a test for any viewport size that reports failures upon test completion.

See open(java.lang.String, java.lang.String, com.applitools.eyes.RectangleSize, com.applitools.eyes.MatchLevel, com.applitools.eyes.FailureReports)

checkRegion

public void checkRegion(BufferedImage image,
               com.applitools.eyes.Region region,
               String tag,
               boolean ignoreMismatch)

Perform visual validation for the current image.

Parameters:

image - The image to perform visual validation for.

tag - An optional tag to be associated with the validation checkpoint.

ignoreMismatch - True if the server should ignore a negative result for the visual validation.

Throws:

TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.

checkRegion

public void checkRegion(BufferedImage image,
               com.applitools.eyes.Region region,
               String tag)

Perform visual validation for a region in a given image. Does not ignore mismatches.

Parameters:

image - The image to perform visual validation for.

tag - An optional tag to be associated with the validation checkpoint.

Throws:

TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.

checkRegion

public void checkRegion(BufferedImage image,
               com.applitools.eyes.Region region)

Perform visual validation of a region for a given image. Tag is empty and mismatches are not ignored.

Parameters:

image - The image to perform visual validation for.

Throws:

TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.

checkWindow

public void checkWindow(BufferedImage image,
               String tag,
               boolean ignoreMismatch)

Perform visual validation for a given image.

Parameters:

image - The image to perform visual validation for.

tag - An optional tag to be associated with the validation checkpoint.

ignoreMismatch - True if the server should ignore a negative result for the visual validation.

Throws:

TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.

checkWindow

public void checkWindow(BufferedImage image,
               String tag)

Perform visual validation for a given image. Does not ignore mismatches.

Parameters:

image - The image to perform visual validation for.

tag - An optional tag to be associated with the validation checkpoint.

Throws:

TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.

checkWindow

public void checkWindow(BufferedImage image)

Perform visual validation for a given image. Tag is empty (null) and mismatches are not ignored.

Parameters:

image - The image to perform visual validation for.

Throws:

TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.

addMouseTrigger

public 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 (location is relative to the window).

cursor - The cursor's position relative to the control.

addTextTrigger

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

Adds a keyboard trigger.

Parameters:

control - The control's position relative to the window.

text - The trigger's text.

getAgentId

public String getAgentId()

getInferredEnvironment

protected String getInferredEnvironment()

getTitle

protected String getTitle()

getIsDisabled

public boolean getIsDisabled()

getIsOpen

public boolean getIsOpen()

getFailureReports

public com.applitools.eyes.FailureReports getFailureReports()

getSaveNewTests

public boolean getSaveNewTests()

setSaveNewTests

public void setSaveNewTests(boolean arg0)

getSaveFailedTests

public boolean getSaveFailedTests()

setSaveFailedTests

public void setSaveFailedTests(boolean arg0)

close

public com.applitools.eyes.TestResults close()

close

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

abortIfNotClosed

public void abortIfNotClosed()

setBranchName

public void setBranchName(String arg0)

setParentBranchName

public void setParentBranchName(String arg0)

setAppEnvironment

public void setAppEnvironment(String arg0,
                     String arg1)

setBatch

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

getDefaultServerUrl

public static URI getDefaultServerUrl()

getLastScreenshot

protected com.applitools.eyes.EyesScreenshot getLastScreenshot()

addUserInput

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

resetLastScreenshot

protected void resetLastScreenshot()

clearUserInputs

protected void clearUserInputs()

getUserInputs

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

getViewportSize

protected com.applitools.eyes.RectangleSize getViewportSize()

setViewportSize

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

getEnvironment

protected com.applitools.eyes.AppEnvironment getEnvironment()

startSession

protected void startSession()