Configuration class

Platform: AppiumLanguage: Java 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.

Import statement

import com.applitools.eyes.config.Configuration;
	

Constructor

Configuration()
The constructor for the Configuration class. This object isset upand then passed to the Eyes.setConfiguration method before the call to the Eyes.open method.

Methods

addBrowser()
Request that the checkpoint be rendered by the Ultrafast Grid using a particular target desktop or mobile device browser.
addBrowsers()
Request that the checkpoint be rendered by the Ultrafast Grid using the specified desktop browsers and viewport sizes.
addDeviceEmulation()
Request that the checkpoint be rendered by the Ultrafast Grid using Chrome mobile emulation.
addMobileDevice()
Request that the checkpoint be rendered by the Ultrafast Grid using a Native mobile simulator.
addMobileDevices()
Request that the checkpoint be rendered by the Ultrafast Grid for multiple devices using a Native mobile simulator.
getAccessibilityValidation()
Use this method to retrieve the accessibility testing level.
getAgentId()
Returns the value configured by setAgentId.
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()
Returns the value configured by setAppName.
getBaselineBranchName()
Returns the value configured by setBaselineBranchName.
getBaselineEnvName()
Returns the value configured by setBaselineEnvName.
getBatch()
Returns the value configured by the setBatch method.
getBranchName()
Returns the branchname configured by setBranchName.
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.
getHideCaret()
Use this method to retrieve whether Eyes hides the cursor before the screenshot is captured or not.
getHostApp()
Use this method to retrieve the name that is being used for the host application (browser) property.
getHostOS()
Use this method to retrieve the name of the hosting operating system property.
getHostingAppInfo()
Get the value of the hostingappinfo that was set using the Configuration.setHostingAppInfo method.
getIgnoreCaret()
Use this method to retrieve whether or not Eyes eliminates mismatches due to blinking cursor artifacts.
getIgnoreDisplacements()
Use this method to set whether Eyes ignores image features that have been displaced.
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.
getOsInfo()
Get the value of the hostingappinfo that was set using the Configuration.setOsInfo method.
getParentBranchName()
Returns the value configured by setParentBranchName.
getProxy()
Use this method to retrieve the settings used to access the Eyes proxy server.
getSaveDiffs()
Returns the value configured by setSaveDiffs.
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.
getTestName()
Returns the value configured by setTestName.
getVisualGridOptions()
Use this method to set configuration values for the Ultrafast Grid.
getWaitBeforeScreenshots()
Returns the amount of time in milliseconds that Eyes will wait before capturing a screenshot.
isSendDom()
Returns whether the DOM is being sent to the server or not.
setAccessibilityValidation()
Use this method to set the accessibility testing level to use.
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.
setBrowsersInfo()
Sets the devices to be rendered on the Ultrafast Grid.
setDeviceInfo()
Set the name of the device being rendered on the Ultrafast Grid.
setFeatures()
Use this method to enable various Eyes features.
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.
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.
setHostingAppInfo()
Set the value that shold be displayed in the Browser column of the Test Results page of the Test Manager.
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.
setOsInfo()
Set the value that shold be displayed in the OS column of the Test Results page of the Test Manager.
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.
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.
setTestName()
Use this method to set the name of the test.
setVisualGridOptions()
Use this method to set configuration values for the Ultrafast Grid.
setWaitBeforeScreenshots()
Use this method to set the amount of time in milliseconds that Eyes will wait before capturing a screenshot.