checkImage method

Class: EyesPlatform: ImagesAppKitLanguage: Objective-C SDK:

Run a checkpoint on an image that you provide as a parameter.


Call syntax

BOOL value =  [ eyes checkImage  : image   ]

BOOL value =  [ eyes checkImage  : image tag: tag   ]

BOOL value =  [ eyes checkImage  : image tag: tag ignoreMismatch: ignoreMismatch   ]


(BOOL)checkImage:(NSImage *)image tag:(nullable NSString *)tag ignoreMismatch:(BOOL)ignoreMismatch


An image stored in a buffer in PNG format.

The tag defines a name for the checkpoint in the Eyes Test Manager. The name may be any string and serves to identify the step to the user in the Test manager. You may change the tag value without impacting testing in any way since Eyes does not use the tag to identify the baseline step that corresponds to the checkpoint - Eyes matches steps based on their content and position in the sequences of images of the test. See How Eyes compares checkpoints and baseline images for details.

This parameter is used to implement retry of a checkpoint. If you are not implementing retry, then don't pass this parameter or pass a value of false. To implement retry, on all retry attempts apart from the last, pass this parameter a value of true. When the method returns, check the return value. A returned value of true means that the checkpoint passed, and you can continue with the next checkpoint. A returned value of false means that that the checkpoint did not match. Since this parameter was passed as true, Eyes will not store the outcome of this checkpoint and will expect that the next image sent is for the current step (i.e. is being retried). On the last retry attempt, pass a value of false. This way, Eyes knows that there will be no more retries, and it will store the results of the last check as the result of the current step. The next checkpoint sent will be treated as the next step. Note that since Eyes allows for new or deleted steps, once there is a mismatch for one step, all subsequent steps will also return a mismatch, and Eyes determines the actual match/mismatch/new/missing status of all the steps when the test is closed.

Return value

Type: BOOL