com.applitools.eyes

Interface ServerConnector

public interface ServerConnector

Defines the interface which should be implemented by a ServerConnector.

Method Summary

Modifier and Type	Method and Description
String	getApiKey()
ProxySettings	getProxy()
URI	getServerUrl()
int	getTimeout()
com.applitools.eyes.MatchResult	matchWindow(com.applitools.eyes.RunningSession runningSession, com.applitools.eyes.MatchWindowData matchData) Matches the current window (held by the WebDriver) to the expected window.
void	setApiKey(String apiKey)
void	setProxy(ProxySettings proxySettings)
void	setServerUrl(URI serverUrl)
com.applitools.eyes.RunningSession	startSession(com.applitools.eyes.SessionStartInfo sessionStartInfo) Starts a new running session in the agent.
TestResults	stopSession(com.applitools.eyes.RunningSession runningSession, boolean isAborted, boolean save) Stops the running session.

Method Detail

setApiKey

void setApiKey(String apiKey)

getApiKey

String getApiKey()

setServerUrl

void setServerUrl(URI serverUrl)

getServerUrl

URI getServerUrl()

setProxy

void setProxy(ProxySettings proxySettings)

getProxy

ProxySettings getProxy()

getTimeout

int getTimeout()

Returns:

The server timeout. (Seconds).

startSession

com.applitools.eyes.RunningSession startSession(com.applitools.eyes.SessionStartInfo sessionStartInfo)

Starts a new running session in the agent. Based on the given parameters, this running session will either be linked to an existing session, or to a completely new session.

Parameters:

sessionStartInfo - The start parameters for the session.

Returns:

RunningSession object which represents the current running session

Throws:

EyesException

stopSession

TestResults stopSession(com.applitools.eyes.RunningSession runningSession,
                        boolean isAborted,
                        boolean save)

Stops the running session.

Parameters:

runningSession - The running session to be stopped.

Returns:

TestResults object for the stopped running session

Throws:

EyesException

matchWindow

com.applitools.eyes.MatchResult matchWindow(com.applitools.eyes.RunningSession runningSession,
                                            com.applitools.eyes.MatchWindowData matchData)

Matches the current window (held by the WebDriver) to the expected window.

Parameters:

runningSession - The current agent's running session.

matchData - Encapsulation of a capture taken from the application.

Returns:

The results of the window matching.

Throws:

EyesException