A C D E F G I L M N O P R S T U V

A

abortIfNotClosed() - Method in class com.applitools.eyes.EyesBase

If a test is running, aborts it.

addMouseTriggerBase(MouseAction, Region, Location) - Method in class com.applitools.eyes.EyesBase

Adds a mouse trigger.

addTextTriggerBase(Region, String) - Method in class com.applitools.eyes.EyesBase

Adds a text trigger.

addUserInput(Trigger) - Method in class com.applitools.eyes.EyesBase

Adds a trigger to the current list of user inputs.

AppOutputProvider - Interface in com.applitools.eyes

Encapsulates a callback which returns an application output.

AppOutputWithScreenshot - Class in com.applitools.eyes

A container for a AppOutput along with the screenshot used for creating it.

AppOutputWithScreenshot(AppOutput, EyesScreenshot) - Constructor for class com.applitools.eyes.AppOutputWithScreenshot

C

checkWindowBase(RegionProvider, String, boolean) - Method in class com.applitools.eyes.EyesBase

checkWindowBase(RegionProvider, String, boolean, int) - Method in class com.applitools.eyes.EyesBase

Takes a snapshot of the application under test and matches it with the expected output.

clearUserInputs() - Method in class com.applitools.eyes.EyesBase

Clears the user inputs list.

close() - Method in class com.applitools.eyes.EyesBase

See EyesBase.close(boolean).

close(boolean) - Method in class com.applitools.eyes.EyesBase

Ends the test.

closeResponseTime(boolean) - Method in class com.applitools.eyes.EyesBase

Ends the test.

com.applitools.eyes - package com.applitools.eyes

CoordinatesTypeConversionException - Exception in com.applitools.eyes

Encapsulates an error converting between two coordinate types.

CoordinatesTypeConversionException(String) - Constructor for exception com.applitools.eyes.CoordinatesTypeConversionException

CoordinatesTypeConversionException(String, Throwable) - Constructor for exception com.applitools.eyes.CoordinatesTypeConversionException

CoordinatesTypeConversionException(CoordinatesType, CoordinatesType) - Constructor for exception com.applitools.eyes.CoordinatesTypeConversionException

Represents an error trying to convert between two coordinate types.

cut(BufferedImage) - Method in interface com.applitools.eyes.CutProvider

cut(BufferedImage) - Method in class com.applitools.eyes.FixedCutProvider

CutProvider - Interface in com.applitools.eyes

Encapsulates cutting logic.

cutProviderHandler - Variable in class com.applitools.eyes.EyesBase

D

DebugScreenshotsProvider - Class in com.applitools.eyes

Interface for saving debug screenshots.

DebugScreenshotsProvider() - Constructor for class com.applitools.eyes.DebugScreenshotsProvider

debugScreenshotsProvider - Variable in class com.applitools.eyes.EyesBase

E

EyesBase - Class in com.applitools.eyes

Applitools Eyes Base for Java API .

EyesBase(URI) - Constructor for class com.applitools.eyes.EyesBase

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

EyesScreenshotFactory - Interface in com.applitools.eyes

Encapsulates the instantiation of an EyesScreenshot object.

F

FailureReports - Enum in com.applitools.eyes

Determines how detected failures are reported.

FileDebugScreenshotsProvider - Class in com.applitools.eyes

A debug screenshot provider for saving screenshots to file.

FileDebugScreenshotsProvider() - Constructor for class com.applitools.eyes.FileDebugScreenshotsProvider

FixedCutProvider - Class in com.applitools.eyes

FixedCutProvider(int, int, int, int) - Constructor for class com.applitools.eyes.FixedCutProvider

FixedScaleProvider - Class in com.applitools.eyes

Scale provider based on a fixed scale ratio.

FixedScaleProvider(double) - Constructor for class com.applitools.eyes.FixedScaleProvider

FixedScaleProviderFactory - Class in com.applitools.eyes

Factory implementation for creating FixedScaleProvider instances.

FixedScaleProviderFactory(double, PropertyHandler<ScaleProvider>) - Constructor for class com.applitools.eyes.FixedScaleProviderFactory

G

getAgentId() - Method in class com.applitools.eyes.EyesBase

getApiKey() - Method in class com.applitools.eyes.EyesBase

getAppEnvironment() - Method in class com.applitools.eyes.EyesBase

Application environment is the environment (e.g., the host OS) which runs the application under test.

getAppName() - Method in class com.applitools.eyes.EyesBase

getAppOutput(RegionProvider, EyesScreenshot) - Method in interface com.applitools.eyes.AppOutputProvider

getAppOutput() - Method in class com.applitools.eyes.AppOutputWithScreenshot

getBaseAgentId() - Method in class com.applitools.eyes.EyesBase

getBaselineEnvName() - Method in class com.applitools.eyes.EyesBase

If not null, determines the name of the environment of the baseline.

getBaselineName() - Method in class com.applitools.eyes.EyesBase

Deprecated.

Only available for backward compatibility. See EyesBase.getBaselineEnvName().

getBatch() - Method in class com.applitools.eyes.EyesBase

getBranchName() - Method in class com.applitools.eyes.EyesBase

getControl() - Method in class com.applitools.eyes.MouseTrigger

getControl() - Method in class com.applitools.eyes.TextTrigger

getCoordinatesType() - Method in interface com.applitools.eyes.RegionProvider

getCurrentPosition() - Method in class com.applitools.eyes.InvalidPositionProvider

getCurrentPosition() - Method in interface com.applitools.eyes.PositionProvider

getDebugScreenshotsPath() - Method in class com.applitools.eyes.EyesBase

getDebugScreenshotsPrefix() - Method in class com.applitools.eyes.EyesBase

getDefaultMatchSettings() - Method in class com.applitools.eyes.EyesBase

getDefaultServerUrl() - Static method in class com.applitools.eyes.EyesBase

getElapsed() - Method in class com.applitools.eyes.TimedAppOutput

getEntireSize() - Method in class com.applitools.eyes.InvalidPositionProvider

getEntireSize() - Method in interface com.applitools.eyes.PositionProvider

getEnvName() - Method in class com.applitools.eyes.EyesBase

If not null specifies a name for the environment in which the application under test is running.

getFailureReports() - Method in class com.applitools.eyes.EyesBase

getFullAgentId() - Method in class com.applitools.eyes.EyesBase

getHostApp() - Method in class com.applitools.eyes.EyesBase

getHostOS() - Method in class com.applitools.eyes.EyesBase

getImage() - Method in interface com.applitools.eyes.ImageProvider

getInferredEnvironment() - Method in class com.applitools.eyes.EyesBase

getIsDisabled() - Method in class com.applitools.eyes.EyesBase

getIsOpen() - Method in class com.applitools.eyes.EyesBase

getIsPrimary() - Method in class com.applitools.eyes.TimedAppOutput

getLastNonMatch() - Method in class com.applitools.eyes.ResponseTimeInitialMatchSearchResult

getLastNonMatch() - Method in class com.applitools.eyes.ResponseTimeMatchFinderTask

getLastScreenshot() - Method in class com.applitools.eyes.ResponseTimeMatchFinderTask

getLocation() - Method in class com.applitools.eyes.MouseTrigger

getLogHandler() - Method in class com.applitools.eyes.EyesBase

getMatchLevel() - Method in class com.applitools.eyes.EyesBase

Deprecated.

Please useEyesBase.getDefaultMatchSettings() instead.

getMatchTimeout() - Method in class com.applitools.eyes.EyesBase

getMatchWindowData() - Method in class com.applitools.eyes.MatchWindowDataWithScreenshot

getMouseAction() - Method in class com.applitools.eyes.MouseTrigger

getParentBranchName() - Method in class com.applitools.eyes.EyesBase

getPath() - Method in class com.applitools.eyes.DebugScreenshotsProvider

getPositionProvider() - Method in class com.applitools.eyes.EyesBase

getPrefix() - Method in class com.applitools.eyes.DebugScreenshotsProvider

getProxy() - Method in class com.applitools.eyes.EyesBase

getRegion() - Method in interface com.applitools.eyes.RegionProvider

getSaveDebugScreenshots() - Method in class com.applitools.eyes.EyesBase

getSaveFailedTests() - Method in class com.applitools.eyes.EyesBase

getSaveNewTests() - Method in class com.applitools.eyes.EyesBase

getScaleProviderImpl(int) - Method in class com.applitools.eyes.FixedScaleProviderFactory

getScaleRatio() - Method in class com.applitools.eyes.EyesBase

getScaleRatio() - Method in class com.applitools.eyes.FixedScaleProvider

getScreenshot() - Method in class com.applitools.eyes.AppOutputWithScreenshot

getScreenshot() - Method in class com.applitools.eyes.EyesBase

getScreenshot() - Method in class com.applitools.eyes.MatchWindowDataWithScreenshot

getServerUrl() - Method in class com.applitools.eyes.EyesBase

getSessionId() - Method in class com.applitools.eyes.TargetWebDriverApplication

Gets the ID of the web-driver session or null if unknown.

getState() - Method in class com.applitools.eyes.InvalidPositionProvider

getState() - Method in interface com.applitools.eyes.PositionProvider

Get the current state of the position provider.

getTestResults() - Method in error com.applitools.eyes.TestFailedException

getText() - Method in class com.applitools.eyes.TextTrigger

getTheMatch() - Method in class com.applitools.eyes.ResponseTimeInitialMatchSearchResult

getTheMatch() - Method in class com.applitools.eyes.ResponseTimeMatchFinderTask

getTitle() - Method in class com.applitools.eyes.EyesBase

getTriggerType() - Method in class com.applitools.eyes.MouseTrigger

getTriggerType() - Method in class com.applitools.eyes.TextTrigger

getUrl() - Method in class com.applitools.eyes.TargetWebDriverApplication

Gets the URL of the remote web-driver controlling the browser that hosts the application under test or null if unknown.

getUserAgent() - Method in class com.applitools.eyes.TargetWebDriverApplication

Gets the user-agent string of the browser that hosts the application under test or null if unknown.

getUserInputs() - Method in class com.applitools.eyes.EyesBase

getViewportSize() - Method in class com.applitools.eyes.EyesBase

I

ImageProvider - Interface in com.applitools.eyes

Encapsulates image retrieval.

InvalidPositionProvider - Class in com.applitools.eyes

An implementation of PositionProvider which throws an exception for every method.

InvalidPositionProvider() - Constructor for class com.applitools.eyes.InvalidPositionProvider

L

lastScreenshot - Variable in class com.applitools.eyes.EyesBase

logger - Variable in class com.applitools.eyes.EyesBase

M

makeScreenshot(BufferedImage) - Method in interface com.applitools.eyes.EyesScreenshotFactory

matchWindow(Trigger[], EyesScreenshot, RegionProvider, String, boolean, boolean, int) - Method in class com.applitools.eyes.MatchWindowTask

Repeatedly obtains an application snapshot and matches it with the next expected output, until a match is found or the timeout expires.

MatchWindowDataWithScreenshot - Class in com.applitools.eyes

A container for a MatchWindowData along with the screenshot used for creating it.

MatchWindowDataWithScreenshot(MatchWindowData, EyesScreenshot) - Constructor for class com.applitools.eyes.MatchWindowDataWithScreenshot

MatchWindowTask - Class in com.applitools.eyes

MatchWindowTask(Logger, ServerConnector, RunningSession, int, AppOutputProvider) - Constructor for class com.applitools.eyes.MatchWindowTask

MouseAction - Enum in com.applitools.eyes

MouseTrigger - Class in com.applitools.eyes

Encapsulates a mouse trigger.

MouseTrigger(MouseAction, Region, Location) - Constructor for class com.applitools.eyes.MouseTrigger

N

NewTestException - Error in com.applitools.eyes

Indicates that a new test (i.e., a test for which no baseline exists) ended.

NewTestException(TestResults, String) - Constructor for error com.applitools.eyes.NewTestException

Creates a new NewTestException instance.

NullCutProvider - Class in com.applitools.eyes

A cut provider which does nothing.

NullCutProvider() - Constructor for class com.applitools.eyes.NullCutProvider

NullDebugScreenshotProvider - Class in com.applitools.eyes

A mock debug screenshot provider.

NullDebugScreenshotProvider() - Constructor for class com.applitools.eyes.NullDebugScreenshotProvider

NullScaleProvider - Class in com.applitools.eyes

A scale provider which does nothing.

NullScaleProvider() - Constructor for class com.applitools.eyes.NullScaleProvider

O

openBase(String, String, RectangleSize, SessionType) - Method in class com.applitools.eyes.EyesBase

Starts a test.

P

performMatch(Trigger[], AppOutputWithScreenshot, String, boolean) - Method in class com.applitools.eyes.MatchWindowTask

Creates the match data and calls the server connector matchWindow method.

PositionMemento - Class in com.applitools.eyes

A base class for position related memento instances.

PositionMemento() - Constructor for class com.applitools.eyes.PositionMemento

positionProvider - Variable in class com.applitools.eyes.EyesBase

PositionProvider - Interface in com.applitools.eyes

Encapsulates page/element positioning.

R

RegionProvider - Interface in com.applitools.eyes

Encapsulates a getRegion "callback" and how the region's coordinates should be used.

ResponseTimeAlgorithm - Class in com.applitools.eyes

A container for the algorithm for window timing tests.

ResponseTimeAlgorithm() - Constructor for class com.applitools.eyes.ResponseTimeAlgorithm

ResponseTimeInitialMatchSearchResult - Class in com.applitools.eyes

A container for the results of the initial match search of a response time test.

ResponseTimeInitialMatchSearchResult(MatchWindowDataWithScreenshot, MatchWindowDataWithScreenshot) - Constructor for class com.applitools.eyes.ResponseTimeInitialMatchSearchResult

ResponseTimeMatchFinderTask - Class in com.applitools.eyes

A class which performs a checkWindow call (so it can be run on a separate thread).

ResponseTimeMatchFinderTask(BlockingInstanceContainer<MatchWindowDataWithScreenshot>, long, ServerConnector, RunningSession) - Constructor for class com.applitools.eyes.ResponseTimeMatchFinderTask

restoreState(PositionMemento) - Method in class com.applitools.eyes.InvalidPositionProvider

restoreState(PositionMemento) - Method in interface com.applitools.eyes.PositionProvider

Restores the state of the position provider to the state provided as a parameter.

run() - Method in class com.applitools.eyes.ResponseTimeMatchFinderTask

runNewProgressionSession(Logger, ServerConnector, RunningSession, AppOutputProvider, RegionProvider, long, int) - Static method in class com.applitools.eyes.ResponseTimeAlgorithm

Runs a new progression session (i.e., no existing baseline).

runningSession - Variable in class com.applitools.eyes.EyesBase

runProgressionSessionForExistingBaseline(Logger, ServerConnector, RunningSession, AppOutputProvider, RegionProvider, long, int, int, long) - Static method in class com.applitools.eyes.ResponseTimeAlgorithm

Runs a progression session, for an existing baseline.

S

save(BufferedImage, String) - Method in class com.applitools.eyes.DebugScreenshotsProvider

save(BufferedImage, String) - Method in class com.applitools.eyes.FileDebugScreenshotsProvider

save(BufferedImage, String) - Method in class com.applitools.eyes.NullDebugScreenshotProvider

scale(double) - Method in interface com.applitools.eyes.CutProvider

Get a scaled version of the cut provider.

scale(double) - Method in class com.applitools.eyes.FixedCutProvider

scaleProviderHandler - Variable in class com.applitools.eyes.EyesBase

serverConnector - Variable in class com.applitools.eyes.EyesBase

sessionStartInfo - Variable in class com.applitools.eyes.EyesBase

setAgentId(String) - Method in class com.applitools.eyes.EyesBase

setApiKey(String) - Method in class com.applitools.eyes.EyesBase

Sets the API key of your applitools Eyes account.

setAppEnvironment(String, String) - Method in class com.applitools.eyes.EyesBase

Deprecated.

setAppName(String) - Method in class com.applitools.eyes.EyesBase

setBaselineEnvName(String) - Method in class com.applitools.eyes.EyesBase

If not null, determines the name of the environment of the baseline.

setBaselineName(String) - Method in class com.applitools.eyes.EyesBase

Deprecated.

Only available for backward compatibility. See EyesBase.setBaselineEnvName(String).

setBatch(BatchInfo) - Method in class com.applitools.eyes.EyesBase

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

setBranchName(String) - Method in class com.applitools.eyes.EyesBase

Sets the branch in which the baseline for subsequent test runs resides.

setDebugScreenshotsPath(String) - Method in class com.applitools.eyes.EyesBase

setDebugScreenshotsPrefix(String) - Method in class com.applitools.eyes.EyesBase

setDefaultMatchSettings(ImageMatchSettings) - Method in class com.applitools.eyes.EyesBase

setEnvName(String) - Method in class com.applitools.eyes.EyesBase

If not null specifies a name for the environment in which the application under test is running.

setFailureReports(FailureReports) - Method in class com.applitools.eyes.EyesBase

setHostApp(String) - Method in class com.applitools.eyes.EyesBase

setHostOS(String) - Method in class com.applitools.eyes.EyesBase

setImageCut(CutProvider) - Method in class com.applitools.eyes.EyesBase

setIsDisabled(boolean) - Method in class com.applitools.eyes.EyesBase

setLogHandler(LogHandler) - Method in class com.applitools.eyes.EyesBase

Sets a handler of log messages generated by this API.

setMatchLevel(MatchLevel) - Method in class com.applitools.eyes.EyesBase

This function is deprecated.

setMatchTimeout(int) - Method in class com.applitools.eyes.EyesBase

Sets the maximum time (in ms) a match operation tries to perform a match.

setParentBranchName(String) - Method in class com.applitools.eyes.EyesBase

Sets the branch under which new branches are created.

setPath(String) - Method in class com.applitools.eyes.DebugScreenshotsProvider

setPosition(Location) - Method in class com.applitools.eyes.InvalidPositionProvider

setPosition(Location) - Method in interface com.applitools.eyes.PositionProvider

Go to the specified location.

setPositionProvider(PositionProvider) - Method in class com.applitools.eyes.EyesBase

setPrefix(String) - Method in class com.applitools.eyes.DebugScreenshotsProvider

setProxy(ProxySettings) - Method in class com.applitools.eyes.EyesBase

Sets the proxy settings to be used by the rest client.

setSaveDebugScreenshots(boolean) - Method in class com.applitools.eyes.EyesBase

setSaveFailedTests(boolean) - Method in class com.applitools.eyes.EyesBase

Set whether or not failed tests are saved by default.

setSaveNewTests(boolean) - Method in class com.applitools.eyes.EyesBase

Set whether or not new tests are saved by default.

setScaleRatio(Double) - Method in class com.applitools.eyes.EyesBase

setServerUrl(URI) - Method in class com.applitools.eyes.EyesBase

Sets the current server URL used by the rest client.

setViewportSize(RectangleSize) - Method in class com.applitools.eyes.EyesBase

startSession() - Method in class com.applitools.eyes.EyesBase

Start eyes session on the eyes server.

T

TargetApplication - Class in com.applitools.eyes

A base class for encapsulating data about applications to be tested.

TargetApplication() - Constructor for class com.applitools.eyes.TargetApplication

TargetWebDriverApplication - Class in com.applitools.eyes

TargetWebDriverApplication(URL, String, String) - Constructor for class com.applitools.eyes.TargetWebDriverApplication

Creates a new TargetWebDriverApplication instance.

TestFailedException - Error in com.applitools.eyes

Indicates that a test did not pass (i.e., test either failed or is a new test).

TestFailedException(TestResults, String) - Constructor for error com.applitools.eyes.TestFailedException

Creates a new TestFailedException instance.

TestFailedException(String) - Constructor for error com.applitools.eyes.TestFailedException

Creates a new TestFailedException instance.

TestFailedException(String, Throwable) - Constructor for error com.applitools.eyes.TestFailedException

Creates an EyesException instance.

testResponseTimeBase(RegionProvider, Runnable, int, int, long) - Method in class com.applitools.eyes.EyesBase

Runs a timing test.

TextTrigger - Class in com.applitools.eyes

Encapsulates a text input by the user.

TextTrigger(Region, String) - Constructor for class com.applitools.eyes.TextTrigger

TimedAppOutput - Class in com.applitools.eyes

AppOutput with timing information.

TimedAppOutput(String, String, long, boolean) - Constructor for class com.applitools.eyes.TimedAppOutput

toString() - Method in class com.applitools.eyes.MouseTrigger

toString() - Method in class com.applitools.eyes.TextTrigger

U

USE_DEFAULT_TIMEOUT - Static variable in class com.applitools.eyes.EyesBase

V

valueOf(String) - Static method in enum com.applitools.eyes.FailureReports

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.applitools.eyes.MouseAction

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.applitools.eyes.FailureReports

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.applitools.eyes.MouseAction

Returns an array containing the constants of this enum type, in the order they are declared.

viewportSize - Variable in class com.applitools.eyes.EyesBase

A C D E F G I L M N O P R S T U V