Eyes class

Platform: ImagesAppKitLanguage: Objective-C SDK:
This class provides the main methods used to execute tests and checkpoints.

Import statement

@import EyesImagesAppKit
	

Constructor

init()
This is the constructor for the Eyes class.
initWithRunner()
This is the constructor for the Eyes class when using a runner.

Properties

apiKeyType:NSString*
Use this property to set and retrieve your Eyes license key.
baselineBranchNameType:NSString*
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:NSString*
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:NSString*
Use this property to set and retrieve the branch used for the baseline of this run.
configurationType:Configuration*
Use this method to configure Eyes based on a configuration object.
debugScreenshotsPathType:NSString*
Use this property to set and retrieve the folder path where locally saved checkpoint images should be stored (if enabled).
debugScreenshotsPrefixType:NSString*
Use this property to set and retrieve the prefix that should be added to the file names for locally stored checkpoint images (if enabled).
deviceInfoType:NSString*
Set the name of the device being rendered on the Ultrafast Grid.
hostAppType:NSString*
Use this property to set and retrieve the name of the hosting application property.
hostOSType:NSString*
Use this property to set and retrieve the name of the hosting operating system property.
hostingAppInfoType:NSString*
Set the value that shold be displayed in the Browser column of the Test Results page of the Test Manager.
ignoreCaretType:BOOL
Use this property to set and retrieve whether or not Eyes eliminates mismatches due to blinking cursor artifacts.
matchLevelType:MatchLevel
Use this property to set and retrieve the default match level to be used for subsequent checkpoints in the test.
matchTimeoutType:NSUInteger
Use this property to set and retrieve the maximum time Eyes will try to perform a match on the fully captured image.
osInfoType:NSString*
Set the value that shold be displayed in the OS column of the Test Results page of the Test Manager.
parentBranchNameType:NSString*
Use this property to set and retrieve the parent branch from which newly created branches get their initial baseline.
proxyType:AbstractProxySettings*
Use this method to configure Eyes so that it will interact with the Eyes server via a proxy.
saveDebugScreenshotsType:BOOL
Use this property to set and retrieve whether or not checkpoint images should be copied to a local file (typically for troubleshooting).
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.
serverURLType:NSString*
Use this property to set and retrieve the URL of the Eyes server used to process the captured images.

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.
checkImage()
Run a checkpoint on an image that you provide as a parameter.
checkRegion()
Checks a particular region of the checkpoint window.
checkWithTag()
Run a checkpoint. Uses Fluent arguments to specify the various parameters.
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.
openWithApplicationName()
Call this method to start a test, before calling any of the check methods.