Eyes class

Platform: EspressoLanguage: Java SDK:
This class provides the main methods used to execute tests and checkpoints.

Constructor

Eyes()
This is the constructor for the Eyes class.

Methods

abortIfNotClosed()
When a test is aborted, and it may be that not all of its checkpoints have excuted, call this method instead of close methods so that it will have an Aborted status in the Eyes Test Manager.
addProperty()
Adds a custom key name/value property that will be associated with tests. You can view these properties and filter and group by these properties in the Test Manager.
check()
Run a checkpoint. Uses Fluent arguments to specify the various parameters.
checkElement()
Run a checkpoint on the area of a particular element.
checkGoogleMapFragment()
Use this method to check a GoogleMap fragment.
checkGoogleMapView()
Use this method to check a GoogleMap view.
checkRegion()
Checks a particular region of the checkpoint window.
checkWindow()
Runs a checkpoint of the entire application (e.g. browser) window.
checkWindowAllLayers()
Use this method to check the screen image when a dialog or popup is being displayed, and you want the dialog/popup to be part of the captured image.
close()
Call this method at the end of the test. This terminates the sequence of checkpoints, and then waits synchronously for the test results and returns them.
getAgentId()
Use this method to retrieve the name and version of the SDK.
getApiKey()
Use this method to retrieve your Eyes license key that you set with setApiKey, or was extracted from the APPLITOOLS_API_KEY environment variable.
getAppName()
Use this method to retrieve the name of the application property.
getBaselineBranchName()
Use this method to retrieve the name of the branch the baseline reference will be taken from and where new and accepted steps will be saved to.
getBaselineEnvName()
Returns the name of the baseline environment defined for this test run.
getBranchName()
Use this method to retrieve the branch used for the baseline of this run.
getConfiguration()
Use this method to retrieve the current configuration object. This will be the most recent configuration object set using setConfiguration, or the initial default configuration object.
getDeviceInfo()
Retrieve the name of the device being rendered on the Ultrafast Grid, if it was configured explicitly by the user.
getForceFullPageScreenshot()
Use this method to retrieve whether or not Eyes does scrolling and stitching on pages whose size is greater than the viewport.
getIgnoreCaret()
Use this method to retrieve whether or not Eyes eliminates mismatches due to blinking cursor artifacts.
getIsDisabled()
Use this method to retrieve whether or not interactions with Eyes are ignored.
getIsOpen()
Use this to know if the Eyes instance is currently open.
getMatchLevel()
Use this method to retrieve the default match level to be used for subsequent checkpoints in the test.
getMatchTimeout()
Use this method to retrieve the maximum amount of time Eyes will try to perform a match on the fully captured image.
getParentBranchName()
Use this method to retrieve the parent branch, from which newly created branches get their initial baseline.
getSaveDiffs()
Use this method to retrieve if steps that have mismatches are automatically saved to the baseline or not.
getSaveNewTests()
Use this method to retrieve whether or not 'new' tests are saved to the baseline by default.
getServerUrl()
Use this method to retrieve the URL of the Eyes server used to process the captured images.
getStitchOverlap()
Use this method to retrieve the overlap between sub-images when a scrolled window is stitched.
isHideCaret()
Use this method to retrieve whether Eyes hides the cursor before the screenshot is captured or not.
open()
Call this method to start a test, before calling any of the check methods.
setAgentId()
Use this method to set the name and version of the SDK.
setApiKey()
Use this method to set your Eyes license key.
setAppName()
Use this method to set the value of the application name property. The application name is one of the 5 properties that define the baseline.
setBaselineBranchName()
Use this method to set the name of the branch the baseline reference will be taken from and where new and accepted steps will be saved to.
setBaselineEnvName()
Use this method to set the name of the environment that will be used to determine the baseline.
setBatch()
Use this method to set the batch information for this test.
setBranchName()
Use this method to set the branch used for the baseline of this run.
setComponentsProvider()
If you use the AndroidX libraries then call this method after you instantiate Eyes.
setConfiguration()
Use this method to configure Eyes based on a configuration object.
setDeviceInfo()
Set the name of the device being rendered on the Ultrafast Grid.
setForceFullPageScreenshot()
Use this method to set whether or not Eyes does scrolling and stitching on pages whose size is greater than the viewport.
setHideCaret()
Use this method to set whether Eyes should hide the cursor before the screenshot is captured.
setIgnoreCaret()
Use this method to set whether or not Eyes eliminates mismatches due to blinking cursor artifacts.
setIsDisabled()
Use this method to set whether or not interactions with Eyes will be silently ignored.
setMatchLevel()
Use this method to set the default match level to be used for subsequent checkpoints in the test.
setMatchTimeout()
Use this method to set the maximum time Eyes will try to perform a match on the fully captured image.
setParentBranchName()
Use this method to set the parent branch from which newly created branches get their initial baseline.
setProxy()
Use this method to configure Eyes so that it will interact with the Eyes server via a proxy.
setSaveDiffs()
Use this method to set if steps that have mismatches should be automatically saved to the baseline or not.
setSaveNewTests()
Use this method to set whether or not 'new' tests are saved to the baseline by default.
setServerUrl()
Use this method to set the URL of the Eyes server used to process the captured images.
setStitchOverlap()
Use this method to set the overlap between sub-images when a scrolled window is stitched.