Skip to main content

ApiUrls class

Platform: Puppeteer
Language: Javascript
Selenium JavaSelenium CsharpSelenium JavascriptImagesappkit ObjectivecPuppeteer JavascriptImages JavaImages PythonImages CsharpImages JavascriptImages ObjectivecSelenium JavascriptWdio4 JavascriptPlaywright JavascriptNightwatch JavascriptXcui ObjectivecProtractor JavascriptAppium JavaAppium CsharpWdiogeneric Javascript


An object of this class is contained in the StepInfo object, which is in itself an object in the TestResults object returned by the Eyes.close method.The methods in this class are used to retrieve a URI that can be used with the REST API to obtain information about a particular step.

getBaselineImage method​

Syntax​

let value = apiurls.getBaselineImage();
value = apiurls.baselineImage;

Note that this feature is available as both a method and a property.

Parameters​

This method does not take any parameters.

Return value​

Type: string

getCheckpointImage method​

Syntax​

let value = apiurls.getCheckpointImage();
value = apiurls.checkpointImage;

Note that this feature is available as both a method and a property.

Parameters​

This method does not take any parameters.

Return value​

Type: string

getCheckpointImageThumbnail method​

Syntax​

let value = apiurls.getCheckpointImageThumbnail();
value = apiurls.checkpointImageThumbnail;

Note that this feature is available as both a method and a property.

Parameters​

This method does not take any parameters.

Return value​

Type: string

getDiffImage method​

Syntax​

let value = apiurls.getDiffImage();
value = apiurls.diffImage;

Note that this feature is available as both a method and a property.

Parameters​

This method does not take any parameters.

Return value​

Type: string