Skip to main content

TestResults class

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.

Import statement

import com.applitools.eyes.TestResults;

delete method

Syntax

result.delete();

Parameters

This method does not take any parameters.

Return value

Type: void

getAccessibilityStatus method

Syntax

SessionAccessibilityStatus value = result.getAccessibilityStatus();

Parameters

This method does not take any parameters.

Return value

Type: SessionAccessibilityStatus

Remarks

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

getAppName method

Syntax

String value = result.getAppName();

Parameters

This method does not take any parameters.

Return value

Type: String

The application name.

getAppUrls method

Syntax

SessionUrls 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

String value = result.getBatchId();

Parameters

This method does not take any parameters.

Return value

Type: String

The batch ID.

getBatchName method

Syntax

String value = result.getBatchName();

Parameters

This method does not take any parameters.

Return value

Type: String

The batch name.

getBranchName method

Syntax

String value = result.getBranchName();

Parameters

This method does not take any parameters.

Return value

Type: String

The branch name.

getDuration method

Syntax

int value = result.getDuration();

Parameters

This method does not take any parameters.

Return value

Type: int

The number of seconds the test ran for.

getHostApp method

Syntax

String value = result.getHostApp();

Parameters

This method does not take any parameters.

Return value

Type: String

The name of the host application

getHostDisplaySize method

Syntax

RectangleSize value = result.getHostDisplaySize();

Parameters

This method does not take any parameters.

Return value

Type: RectangleSize

The host display size.

getHostOS method

Syntax

String value = result.getHostOS();

Parameters

This method does not take any parameters.

Return value

Type: String

The Host OS.

getId method

Syntax

String value = result.getId();

Parameters

This method does not take any parameters.

Return value

Type: String

getMatches method

Syntax

int value = result.getMatches();

Parameters

This method does not take any parameters.

Return value

Type: int

getMismatches method

Syntax

int value = result.getMismatches();

Parameters

This method does not take any parameters.

Return value

Type: int

getMissing method

Syntax

int value = result.getMissing();

Parameters

This method does not take any parameters.

Return value

Type: int

getName method

Syntax

String value = result.getName();

Parameters

This method does not take any parameters.

Return value

Type: String

The name of the test.

getStartedAt method

Syntax

Calendar value = result.getStartedAt();

Parameters

This method does not take any parameters.

Return value

Type: Calendar

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

getStatus method

Syntax

TestResultsStatus 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

int value = result.getSteps();

Parameters

This method does not take any parameters.

Return value

Type: int

getStepsInfo method

Syntax

StepInfo[] 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

String value = result.getUrl();

Parameters

This method does not take any parameters.

Return value

Type: String

isAborted method

Syntax

boolean value = result.isAborted();

Parameters

This method does not take any parameters.

Return value

Type: boolean

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

isDifferent method

Syntax

boolean value = result.isDifferent();

Parameters

This method does not take any parameters.

Return value

Type: boolean

isNew method

Syntax

boolean value = result.isNew();

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.