Configuration class

Platform: XCUILanguage: Objective-C SDK:
Latest
other languages
This class is used to create a configuration object that is used to configure an Eyes object by passing it to the [Eyes configuration] 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 EyesXCUI

Constructor

init()
The constructor for the Configuration class. This object is setup and then passed to the [Eyes configuration] method before the call to the [Eyes openWithApplicationName] method.

Properties

accessibilityValidationType:AccessibilitySettings*
Use this property to set and retrieve the accessibility testing level to use.
agentIdType:NSString*
Use this property to set and retrieve the name and version of the SDK.
apiKeyType:NSString*
Use this property to set and retrieve your Eyes license key.
appNameType:NSString*
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: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.
featuresType:NSArray<Feature *>*
Use this method to enable various Eyes features.
forceFullPageScreenshotType:BOOL
Use this property to set and retrieve whether or not Eyes does scrolling and stitching on pages whose size is greater than the viewport.
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.
ignoreCaretType:BOOL
Use this property to set and retrieve whether or not Eyes eliminates mismatches due to blinking cursor artifacts.
ignoreDisplacementsType:BOOL
Use this property to set and retrieve whether Test Manager should initially display mismatches for image features that have only been displaced, as opposed to real mismatches.
matchLevelType:MatchLevel
Use this property to set and retrieve the default match level to be used for subsequent checkpoints in the test.
matchTimeoutType:NSInteger
Use this property to set and retrieve the maximum time Eyes will try to perform a match on the fully captured image.
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.
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.
statusBarExistsType:BOOL
Use this method to inform Eyes that the status bar is visible so that Eyes can exclude it from the checkpoint. Required for ioS 13.x.
stitchOverlapType:NSInteger
Use this property to set and retrieve the overlap between sub-images when a scrolled window is stitched.
testNameType:NSString*
Use this property to set and retrieve the name of the test.
viewportSizeType:CGSize
Set the viewport size to be used by the browser for the test.