com.applitools.eyes.selenium.rendering

Class VisualGridEyes

java.lang.Object

com.applitools.eyes.selenium.rendering.VisualGridEyes

All Implemented Interfaces:

com.applitools.eyes.IEyesBase, ISeleniumEyes, com.applitools.eyes.visualgrid.services.IEyes

public class VisualGridEyes
extends Object
implements ISeleniumEyes

Constructor Summary

Constructors

Constructor and Description
VisualGridEyes(com.applitools.eyes.visualgrid.services.VisualGridRunner renderingGridManager, com.applitools.eyes.config.ConfigurationProvider configurationProvider)

Method Summary

Modifier and Type	Method and Description
com.applitools.eyes.TestResults	abort()
void	abortAsync()
com.applitools.eyes.TestResults	abortIfNotClosed()
void	addProperty(String name, String value) Adds a property to be sent to the server.
void	apiKey(String apiKey)
void	check(com.applitools.ICheckSettings... checkSettings)
void	check(com.applitools.ICheckSettings checkSettings)
void	check(String name, com.applitools.ICheckSettings checkSettings)
void	clearProperties() Clears the list of custom properties.
com.applitools.eyes.TestResults	close(boolean throwException)
void	closeAsync()
Map<String,com.applitools.eyes.RunningTest>	getAllRunningTests()
List<com.applitools.eyes.TestResultContainer>	getAllTestResults()
String	getApiKey()
com.applitools.eyes.IBatchCloser	getBatchCloser()
String	getBatchId()
EyesSeleniumDriver	getDriver()
String	getFullAgentId()
boolean	getIsDisabled()
boolean	getIsOpen()
com.applitools.eyes.Logger	getLogger()
com.applitools.eyes.LogHandler	getLogHandler()
com.applitools.eyes.AbstractProxySettings	getProxy()
URI	getServerUrl()
boolean	isCompleted()
boolean	isEyesClosed()
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver webDriver)
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, com.applitools.eyes.RectangleSize viewportSize)
void	proxy(com.applitools.eyes.AbstractProxySettings abstractProxySettings)
void	serverUrl(String serverUrl)
void	setApiKey(String apiKey)
void	setBatch(com.applitools.eyes.BatchInfo batch) Sets the batch in which context future tests will run or null if tests are to run standalone.
void	setDebugScreenshotsPath(String pathToSave)
void	setDebugScreenshotsPrefix(String prefix)
void	setImageProvider(com.applitools.eyes.capture.ImageProvider imageProvider)
void	setIsDisabled(Boolean disabled)
void	setLogHandler(com.applitools.eyes.LogHandler logHandler) Sets a handler of log messages generated by this API.
void	setSaveDebugScreenshots(boolean saveDebugScreenshots)
void	setServerConnector(com.applitools.connectivity.ServerConnector serverConnector)
void	setServerUrl(String serverUrl)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualGridEyes

public VisualGridEyes(com.applitools.eyes.visualgrid.services.VisualGridRunner renderingGridManager,
                      com.applitools.eyes.config.ConfigurationProvider configurationProvider)

Method Detail

setLogHandler

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

Sets a handler of log messages generated by this API.

Specified by:

setLogHandler in interface com.applitools.eyes.IEyesBase

Parameters:

logHandler - Handles log messages generated by this API.

getLogHandler

public com.applitools.eyes.LogHandler getLogHandler()

Specified by:

getLogHandler in interface com.applitools.eyes.IEyesBase

apiKey

public void apiKey(String apiKey)

Specified by:

apiKey in interface com.applitools.eyes.visualgrid.services.IEyes

serverUrl

public void serverUrl(String serverUrl)

Specified by:

serverUrl in interface com.applitools.eyes.visualgrid.services.IEyes

setImageProvider

public void setImageProvider(com.applitools.eyes.capture.ImageProvider imageProvider)

setSaveDebugScreenshots

public void setSaveDebugScreenshots(boolean saveDebugScreenshots)

setDebugScreenshotsPath

public void setDebugScreenshotsPath(String pathToSave)

setDebugScreenshotsPrefix

public void setDebugScreenshotsPrefix(String prefix)

open

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

Specified by:

open in interface ISeleniumEyes

Throws:

com.applitools.eyes.EyesException

open

public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver webDriver)

Specified by:

open in interface ISeleniumEyes

close

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

Specified by:

close in interface com.applitools.eyes.visualgrid.services.IEyes

abortIfNotClosed

public com.applitools.eyes.TestResults abortIfNotClosed()

Specified by:

abortIfNotClosed in interface com.applitools.eyes.IEyesBase

abort

public com.applitools.eyes.TestResults abort()

Specified by:

abort in interface com.applitools.eyes.IEyesBase

closeAsync

public void closeAsync()

Specified by:

closeAsync in interface com.applitools.eyes.IEyesBase

abortAsync

public void abortAsync()

Specified by:

abortAsync in interface com.applitools.eyes.IEyesBase

getIsOpen

public boolean getIsOpen()

Specified by:

getIsOpen in interface com.applitools.eyes.IEyesBase

getApiKey

public String getApiKey()

Specified by:

getApiKey in interface com.applitools.eyes.IEyesBase

Specified by:

getApiKey in interface com.applitools.eyes.visualgrid.services.IEyes

setApiKey

public void setApiKey(String apiKey)

setIsDisabled

public void setIsDisabled(Boolean disabled)

Specified by:

setIsDisabled in interface com.applitools.eyes.IEyesBase

getIsDisabled

public boolean getIsDisabled()

Specified by:

getIsDisabled in interface com.applitools.eyes.IEyesBase

getServerUrl

public URI getServerUrl()

Specified by:

getServerUrl in interface com.applitools.eyes.IEyesBase

Specified by:

getServerUrl in interface com.applitools.eyes.visualgrid.services.IEyes

setServerUrl

public void setServerUrl(String serverUrl)

proxy

public void proxy(com.applitools.eyes.AbstractProxySettings abstractProxySettings)

Specified by:

proxy in interface com.applitools.eyes.visualgrid.services.IEyes

getProxy

public com.applitools.eyes.AbstractProxySettings getProxy()

Specified by:

getProxy in interface com.applitools.eyes.visualgrid.services.IEyes

isEyesClosed

public boolean isEyesClosed()

Specified by:

isEyesClosed in interface com.applitools.eyes.visualgrid.services.IEyes

check

public void check(com.applitools.ICheckSettings... checkSettings)

Specified by:

check in interface com.applitools.eyes.visualgrid.services.IEyes

check

public void check(String name,
                  com.applitools.ICheckSettings checkSettings)

Specified by:

check in interface com.applitools.eyes.visualgrid.services.IEyes

check

public void check(com.applitools.ICheckSettings checkSettings)

Specified by:

check in interface com.applitools.eyes.visualgrid.services.IEyes

getLogger

public com.applitools.eyes.Logger getLogger()

Specified by:

getLogger in interface com.applitools.eyes.IEyesBase

Specified by:

getLogger in interface com.applitools.eyes.visualgrid.services.IEyes

getAllRunningTests

public Map<String,com.applitools.eyes.RunningTest> getAllRunningTests()

Specified by:

getAllRunningTests in interface com.applitools.eyes.visualgrid.services.IEyes

toString

public String toString()

Overrides:

toString in class Object

setServerConnector

public void setServerConnector(com.applitools.connectivity.ServerConnector serverConnector)

getFullAgentId

public String getFullAgentId()

Specified by:

getFullAgentId in interface com.applitools.eyes.IEyesBase

Returns:

The full agent id composed of both the base agent id and the user given agent id.

setBatch

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

Sets the batch in which context future tests will run or null if tests are to run standalone.

Parameters:

batch - The batch info to set.

addProperty

public void addProperty(String name,
                        String value)

Adds a property to be sent to the server.

Specified by:

addProperty in interface com.applitools.eyes.IEyesBase

Parameters:

name - The property name.

value - The property value.

clearProperties

public void clearProperties()

Clears the list of custom properties.

Specified by:

clearProperties in interface com.applitools.eyes.IEyesBase

getDriver

public EyesSeleniumDriver getDriver()

Specified by:

getDriver in interface ISeleniumEyes

getBatchCloser

public com.applitools.eyes.IBatchCloser getBatchCloser()

Specified by:

getBatchCloser in interface com.applitools.eyes.visualgrid.services.IEyes

getBatchId

public String getBatchId()

Specified by:

getBatchId in interface com.applitools.eyes.visualgrid.services.IEyes

getAllTestResults

public List<com.applitools.eyes.TestResultContainer> getAllTestResults()

Specified by:

getAllTestResults in interface com.applitools.eyes.visualgrid.services.IEyes

Returns:

If all tests completed, returns their results. Otherwise, returns null

isCompleted

public boolean isCompleted()

Specified by:

isCompleted in interface com.applitools.eyes.visualgrid.services.IEyes