Configuration class

Platform: Selenium 3Language: C# SDK:
This class is used to create a configuration object that is used to configure an Eyes object by passing it to the Eyes.SetConfiguration method.
You can use this configuration object instead of using the various Eyes methods and properties that set the same attributes. Typically you set up a Configuration object by calling its setXXXX methods chained with a '.' in a Fluent coding style. In this class, some attributes can be set by both a property and a set command. The properties allow you simple direct access to assign to and retrieve the attribute. The corresponding set method allows you to set multiple attributes using a Fluent style.

Using statement

using Configuration = Applitools.Selenium.Configuration;
	

Constructor

Configuration()
The constructor for the Configuration class. This object is setup and then passed to the Eyes.SetConfiguration method before the call to Eyes.Open.

Properties

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.
BaselineEnvName
This property can be used to set and retrieve the name of the environment that will be used to determine the baseline.
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.
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.
IgnoreDisplacements
This property can be used to set and retrieve whether Test Manager should initially display mismatches for image features that have only been displaced, as opposed to real mismatches.
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.
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.
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.
TestName
This property can be used to set and retrieve the name of the test.
ViewportSize
This property can be used to set and retrieve the viewport size to be used by the browser for the test.
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

AddBrowser()
Request that the Ultrafast Grid generate checkpoint images using a particular desktop browser and viewport size.
AddBrowsers()
Request that the Ultrafast Grid generate checkpoint images for a list of desktop browsers and viewport sizes.
AddDeviceEmulation()
Request that the Ultrafast Grid generate checkpoint images for an emulated mobile device.
Clone()
Returns a clone of the configuration object.
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.
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.
SetHideScrollbars()
Use this method to set whether Eyes hides the scrollbars before capturing screenshots or not.
SetHostApp()
Use this method to set the name of the hosting application property.
SetHostOS()
Use this method to set the name of the hosting operating system property.
SetIgnoreCaret()
Use this method to set whether or not Eyes eliminates mismatches due to blinking cursor artifacts.
SetIgnoreDisplacements()
Use this method to set whether Test Manager should initially display mismatches for image features that have only been displaced, as opposed to real mismatches.
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.
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.
SetSendDom()
Use this method to set if DOM information should be sent for checkpoints.
SetServerUrl()
Use this method to set the URL of the Eyes server used to process the captured images.
SetStitchMode()
Use this method to set the type of stitching used for full page screenshots.
SetStitchOverlap()
Use this method to set the overlap between sub-images when a scrolled window is stitched.
SetTestName()
Use this method to set the name of the test.
SetViewportSize()
Set the viewport size to be used by the browser for the test.
SetWaitBeforeScreenshots()
Use this method to set the amount of time in milliseconds that Eyes will wait before capturing a screenshot.