Skip to main content

TestResults class

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


Encapsulates the results of a visual test, including summary information and checkpoint-specific details. An object of this class is returned by the close method upon test completion.

Require statement

const {TestResults} = require('@applitools/eyes-images');

getAccessibilityStatus method​

Syntax​

let value = result.getAccessibilityStatus();

Parameters​

This method does not take any parameters.

Return value​

Type: SessionAccessibilityStatus

Type definitions​

SessionAccessibilityStatus

Represent the overall result of an accessibility test.

Remarks​

For more information about the Contrast advisor feature see Contrast advisor.

getAppName method​

Syntax​

let value = result.getAppName();

Parameters​

This method does not take any parameters.

Return value​

Type: string

The application name.

getAppUrls method​

Syntax​

let value = result.getAppUrls();

Parameters​

This method does not take any parameters.

Return value​

Type: SessionUrls

See SessionUrls

The returned object has two properties, both are strings in the form of a URL:

batch

If you paste this URL into a browser then the browser will open the Test manager, displaying the batch results and all of its tests.

session

If you paste this URL into a browser then the browser will open the Test manager, displaying the batch results, with the focus on the test of this test result.

getBatchId method​

Syntax​

let value = result.getBatchId();

Parameters​

This method does not take any parameters.

Return value​

Type: string

The batch ID.

getBatchName method​

Syntax​

let value = result.getBatchName();

Parameters​

This method does not take any parameters.

Return value​

Type: string

The batch name.

getBranchName method​

Syntax​

let value = result.getBranchName();

Parameters​

This method does not take any parameters.

Return value​

Type: string

The branch name.

getDuration method​

Syntax​

let value = result.getDuration();

Parameters​

This method does not take any parameters.

Return value​

Type: number

The number of seconds the test ran for.

getHostApp method​

Syntax​

let value = result.getHostApp();

Parameters​

This method does not take any parameters.

Return value​

Type: string

The name of the host application

getHostDisplaySize method​

Syntax​

let value = result.getHostDisplaySize();

Parameters​

This method does not take any parameters.

Return value​

Type: RectangleSize

The host display size.

getHostOS method​

Syntax​

let value = result.getHostOS();

Parameters​

This method does not take any parameters.

Return value​

Type: string

The Host OS.

getId method​

Syntax​

let value = result.getId();

Parameters​

This method does not take any parameters.

Return value​

Type: string

getIsAborted method​

Syntax​

let value = result.getIsAborted();

Parameters​

This method does not take any parameters.

Return value​

Type: boolean

Use this method to retrieve true if the test was aborted.

getIsDifferent method​

Syntax​

let value = result.getIsDifferent();

Parameters​

This method does not take any parameters.

Return value​

Type: boolean

getIsNew method​

Syntax​

let value = result.getIsNew();

Parameters​

This method does not take any parameters.

Return value​

Type: boolean

Use this method to retrieve true if this is a new test, false otherwise.

getMatches method​

Syntax​

let value = result.getMatches();

Parameters​

This method does not take any parameters.

Return value​

Type: number

getMismatches method​

Syntax​

let value = result.getMismatches();

Parameters​

This method does not take any parameters.

Return value​

Type: number

getMissing method​

Syntax​

let value = result.getMissing();

Parameters​

This method does not take any parameters.

Return value​

Type: number

getName method​

Syntax​

let value = result.getName();

Parameters​

This method does not take any parameters.

Return value​

Type: string

The name of the test.

getStartedAt method​

Syntax​

let value = result.getStartedAt();

Parameters​

This method does not take any parameters.

Return value​

Type: Date

In ISO 8601 format. For example, '2018-07-31T08:06:41.3932844+00:00'.

getStatus method​

Syntax​

let value = result.getStatus();

Parameters​

This method does not take any parameters.

Return value​

Type: TestResultsStatus

Use this method to retrieve one of the following enumerated values:

  • TestResultsStatus.Passed
  • TestResultsStatus.Unresolved
  • TestResultsStatus.Failed

See TestResultsStatus for details.

getSteps method​

Syntax​

let value = result.getSteps();

Parameters​

This method does not take any parameters.

Return value​

Type: number

getStepsInfo method​

Syntax​

let value = result.getStepsInfo();

Parameters​

This method does not take any parameters.

Return value​

Type: StepInfo[]

This is an array of StepInfo objects.

getUrl method​

Syntax​

let value = result.getUrl();

Parameters​

This method does not take any parameters.

Return value​

Type: string