Skip to main content

StepInfo class

When a test terminates, the close method returns an object with methods/properties defined by the TestResults class. Within the TestResults, there is an array of objects which have the properties defined by the class StepInfo. Each element of this array describes information for one step in the test.The properties in this class are used to retrieve information for a given step in the test results.

You can access the array of objects with the step information using the getStepsInfo method.

getApiUrls method

Syntax

let value = stepinfo.getApiUrls();

Parameters

This method does not take any parameters.

Return value

Type: ApiUrls

See ApiUrls for a detailed description of this object.

getAppUrls method

Syntax

let value = stepinfo.getAppUrls();

Parameters

This method does not take any parameters.

Return value

Type: AppUrls

See AppUrls for a detailed description of this object.

getHasBaselineImage method

Syntax

let value = stepinfo.getHasBaselineImage();

Parameters

This method does not take any parameters.

Return value

Type: boolean

getIsDifferent method

Syntax

let value = stepinfo.getIsDifferent();

Parameters

This method does not take any parameters.

Return value

Type: boolean

Returns true if a corresponding baseline image exists and the checkpoint image does not match that baseline image, Returns false if the checkpoint image matched the baseline image or if its a new checkpoint image (there is no baseline image yet).

getName method

Syntax

let value = stepinfo.getName();

Parameters

This method does not take any parameters.

Return value

Type: string