XCUICheckSettings class
Platform: XCUILanguage: Objective-C SDK:
The methods in this class are used as part of the checkWithTag Fluent API
to configure and execute checkpoints.
To use these methods, first create a target object using a method from the Target class,
then call one or more of the methods in this class on the returned object,
using a series of nested calls.
Import statement
@import EyesXCUI
Methods
- accessibility()
- Use to define an accessibility region and its type.
- content()
- If called without parameters, sets the match level for this target to . Otherwise, defines that a match level of MatchLevelContent should be used for the regions passed as a parameters.
- exact()
- Sets the match level for this target to MatchLevelExact.
- floating()
- Add one more floating region to this target.
- fully()
- Defines if the screenshot for this target should be extended to contain the entire element or region being checked, even if it extends the borders of the viewport.
- ignore()
- Add one or more ignore regions to this target (i.e. areas whose content matches anything).
- ignoreCaret()
- Use this method to tell Eyes that for this target it should detect mismatch artifacts caused by a blinking cursor and not report them as mismatches.
- ignoreDisplacements()
- Sets whether Test Manager should intially display mismatches for image features that have only been displaced, as opposed to real mismatches.
- layout()
- If called without parameters, sets the match level for this target to MatchLevelLayout. Otherwise, defines that a match level of MatchLevelLayout should be used for the regions passed as parameters.
- matchLevel()
- Use this method to set the default match level (the type of matching) to use for this target when matching the captured image to the baseline image.
- region()
- Requests that only a region within a selected i-frame should be matched.
- statusBarExists()
- 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.
- strict()
- If called without parameters, sets the match level for this target to MatchLevelStrict. Otherwise, defines that a match level of MatchLevelStrict should be used for the regions passed as a parameters.
- timeoutInSeconds()
- Defines the timeout to use when acquiring and comparing screenshots for this target.
- withStatusBar()
- Instructs Eyes not to exclude the status bar in the checkpoint image (the default is to exlude it).