checkFrame method

Class: EyesPlatform: Selenium 3Language: Java SDK:

Run a checkpoint on the area of a particular frame.

Syntax


eyes.checkFrame(frameNameOrId);
eyes.checkFrame(frameNameOrId, tag);
eyes.checkFrame(frameNameOrId, matchTimeout, tag);
eyes.checkFrame(frameIndex);
eyes.checkFrame(frameIndex, tag);
eyes.checkFrame(frameIndex, matchTimeout, tag);
eyes.checkFrame(frameReference);
eyes.checkFrame(frameReference, tag);
eyes.checkFrame(frameReference, matchTimeout, tag);
eyes.checkFrame(framePath, matchTimeout, tag);
eyes.checkFrame(framesPath, tag);
eyes.checkFrame(framesPath);

Parameters

frameNameOrId
Type:String
The name or id of the frame element.
tag
Type:String

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.

matchTimeout
Type:int
The retry time in milliseconds. If there is a mismatch, then Eyes will recapture and recheck the checkpoint until the timeout limit. This can help avoid mismatches in cases where the capture was done before the page was fully rendered. This parameter overrides any global timeout set using setMatchTimeout. Passing a value of -1 will force the default timeout.
frameIndex
Type:int
A Selenium frame index.
frameReference
Type:WebElement
An object that references the frame.
framePath
Type:String[]
The path of the frame to check. This is a fully defined, top-down list of frame names or IDs, where each frame is nested in the previous frame.
framesPath
Type:String[]
The path of the frame to check. This is a fully defined, top-down list of frame names or IDs, where each frame is nested in the previous frame.

Return value

Type: void