Eyes class

Platform: Selenium 3Language: C# SDK:
This class provides the main methods used to execute tests and checkpoints.

Using statement

using Applitools.Selenium;
	

Constructor

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

Properties

BaselineEnvName
This property can be used to set and retrieve the name of the environment that will be used to determine the baseline.
IsOpen
Use this to know if the Eyes instance is currently open.
AgentId
This property can be used to set and retrieve the name and version of the SDK.
ApiKey
This property can be used to set and retrieve your Eyes license key.
AppName
This property can be used to set and retrieve the value of the application name property. The application name is one of the 5 properties that define the baseline.
BaselineBranchName
This property can be used to set and retrieve the name of the branch the baseline reference will be taken from and where new and accepted steps will be saved to.
Batch
This property can be used to set and retrieve the batch information for this test.
BranchName
This property can be used to set and retrieve the branch used for the baseline of this run.
ForceFullPageScreenshot
This property can be used to set and retrieve whether or not Eyes does scrolling and stitching on pages whose size is greater than the viewport.
HideCaret
This property can be used to set and retrieve whether Eyes should hide the cursor before the screenshot is captured.
HideScrollbars
This property can be used to set and retrieve whether Eyes hides the scrollbars before capturing screenshots or not.
HostApp
This property can be used to set and retrieve the name of the hosting application property.
HostOS
This property can be used to set and retrieve the name of the hosting operating system property.
IgnoreCaret
This property can be used to set and retrieve whether or not Eyes eliminates mismatches due to blinking cursor artifacts.
IsDisabled
This property can be used to set and retrieve whether or not interactions with Eyes will be silently ignored.
MatchLevel
This property can be used to set and retrieve the default match level to be used for subsequent checkpoints in the test.
MatchTimeout
This property can be used to set and retrieve the maximum time Eyes will try to perform a match on the fully captured image.
ParentBranchName
This property can be used to set and retrieve the parent branch from which newly created branches get their initial baseline.
Proxy
Use this method to configure Eyes so that it will interact with the Eyes server via a proxy.
SaveDiffs
This property can be used to set and retrieve if steps that have mismatches should be automatically saved to the baseline or not.
SaveNewTests
This property can be used to set and retrieve whether or not 'new' tests are saved to the baseline by default.
ScaleRatio
This property can be used to set and retrieve the scale ratio to be applied to images before matching, to compensate for different vertical and horizontal pixels density on some devices.
SendDom
This property can be used to set and retrieve if DOM information should be sent for checkpoints.
ServerUrl
This property can be used to set and retrieve the URL of the Eyes server used to process the captured images.
StitchMode
This property can be used to set and retrieve the type of stitching used for full page screenshots.
StitchOverlap
This property can be used to set and retrieve the overlap between sub-images when a scrolled window is stitched.
ViewportSize
The value that was set for the viewport.
WaitBeforeScreenshots
This property can be used to set and retrieve the amount of time in milliseconds that Eyes will wait before capturing a screenshot.

Methods

Abort()
When a test is aborted, and it may be that not all of its checkpoints have excuted, call this method instead of CloseAsync or Close methods so that it will have an Aborted status in the Eyes Test Manager.
AbortAsync()
When a test is aborted, and it may be that not all of its checkpoints have excuted, call this method instead of CloseAsync or Close methods so that it will have an Aborted status in the Eyes Test Manager.
AbortIfNotClosed()
When a test is aborted, and it may be that not all of its checkpoints have excuted, call this method instead of CloseAsync or 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.
CheckFrame()
Run a checkpoint on the area of a particular frame.
CheckRegion()
Checks a particular region of the checkpoint window.
CheckWindow()
Runs a checkpoint of the entire application (e.g. browser) window.
ClearProperties()
Clears any custom key name/value properties.
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.
CloseAsync()
Call this method or Close at the end of the test. The call to CloseAsync terminates the sequence of checkpoints and returns immediately, without waiting for the test results.
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.
GetDriver()
Use this method to retrieve the driver returned by the call to the Open method.
InRegion()
Use this to do OCR on a rectangular area in the window.
Open()
Call this method to start a test, before calling any of the check methods.
SetConfiguration()
Use this method to configure Eyes based on a configuration object.
SetScrollToRegion()
Use this method to set whether or not Eyes scrolls a region into view before capturing the checkpoint.