Eyes class

Platform: ImagesLanguage: C# SDK:

This class provides the main methods used to execute tests and checkpoints.

Using statement

using Applitools.Images;

Constructor

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

Properties

IsOpenType:bool: Use this to know if the Eyes instance is currently open.

AgentIdType:string: Use this property to set and retrieve the name and version of the SDK.

ApiKeyType:string: Use this property to set and retrieve your Eyes license key.

AppNameType:string: Use this property to set and retrieve the value of the application name property. The application name is one of the 5 properties that define the baseline.

BaselineBranchNameType:string: Use this property 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.

BaselineEnvNameType:string: Use this property to set and retrieve the name of the environment that will be used to determine the baseline.

BatchType:BatchInfo: Use this property to set and retrieve the batch information for this test.

BranchNameType:string: Use this property to set and retrieve the branch used for the baseline of this run.

HostAppType:string: Use this property to set and retrieve the name of the hosting application property.

HostOSType:string: Use this property to set and retrieve the name of the hosting operating system property.

IgnoreCaretType:bool: Use this property to set and retrieve whether or not Eyes eliminates mismatches due to blinking cursor artifacts.

IsDisabledType:bool: Use this property to set and retrieve whether or not interactions with Eyes will be silently ignored.

MatchLevelType:MatchLevel: Use this property to set and retrieve the default match level to be used for subsequent checkpoints in the test.

ParentBranchNameType:string: Use this property to set and retrieve the parent branch from which newly created branches get their initial baseline.

ProxyType:WebProxy: Use this method to configure Eyes so that it will interact with the Eyes server via a proxy.

SaveDiffsType:bool?: Use this property to set and retrieve if steps that have mismatches should be automatically saved to the baseline or not.

SaveNewTestsType:bool: Use this property to set and retrieve whether or not 'new' tests are saved to the baseline by default.

ScaleRatioType:double: Use this property to set and retrieve the scale ratio to be applied to images before matching.

SendDomType:bool: Use this property to set and retrieve if DOM information should be sent for checkpoints.

ServerUrlType:string: Use this property to set and retrieve the URL of the Eyes server used to process the captured images.

ViewportSizeType:RectangleSize: The value that was set for the viewport.

ViewportSizeType:RectangleSize: Set the default viewport size property. Eyes uses this if a subsequent call to Open is done without a viewport size.

Methods

Abort(): 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.

AbortAsync(): 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.

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 user-defined key name/value property that will be associated with tests.

Check(): Run a checkpoint. Uses Fluent arguments to specify the various parameters.

CheckImage(): Run a checkpoint on an image that you provide as a parameter.

CheckImageAtUrl(): Executes a checkpoint based on an image obtained from a URL.

CheckImageFile(): Executes a checkpoint based on an image obtained from a file.

CheckRegion(): Checks a particular region of the checkpoint image.

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.

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.

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.

SetTitle(): Sets the title of the page (simulates the effect of the HTML <title> tag).