Protractor JavaScript Eyes SDK classes

Platform: ProtractorLanguage: JavaScript SDK:

Enums

IosVersion
Defines versions of iOS for defining devices for Visual Grid. See iosDeviceInfo
AccessibilityLevel
These values represent accessibility levels as defined by WCAG 2.
AccessibilityRegionType
The classification type of an accessibility region.
AccessibilityGuidelinesVersion
Defines which version of the accessibility standard is used when verifying accessibility.
AccessibilityStatus
This value classifies the results of an accessibility testing in the test results.
IosDeviceName
Defines the Apple devices that can be rendered by the Ultrafast Grid using an iOS simulator.
BrowserType
The set of browsers supported by the Ultrafast Grid.
DeviceName
Defines the names of the devices that can be rendered by the Ultrafast Grid using Chrome mobile emulation.
ScreenOrientation
This enum defines literals that are used to define whether rendering of a device should be in portrait on landscape mode.
MatchLevel
Values that define different types of Image matching. These are used in various commands that set the match level. See How to use Eyes match levels for details.
TestResultsStatus
This enum defines literals that define the possible test results for a single test. It is returned by the getStatus method.
StitchMode
Defines the mechanism used to offset sub-images when generating a full page image by stitching together multiple sub-images.

Classes

AccessibilitySettings
A class that is used to set up accessibility validation.
ApiUrls
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.
ApiUrlsPlain
An object of this type 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 type are used to retrieve a URI that can be used with the REST API to obtain information about a particular step.
AppUrls
An object of this class is contained in the StepInfo object, which is in itself an object in the TestResults object returned by the close method.The properties in this class are used to retrieve a URI that can be used in a browser to open the Test Manager on a page that displays information about a particular step.
AppUrlsPlain
An object of this type is contained in the StepInfo object, which is in itself an object in the TestResults object returned by the close method.The properties in this type are used to retrieve a URI that can be used in a browser to open the Test Manager on a page that displays information about a particular step.
BatchClose
Use an object of this class to close a batch explicitly.
BatchInfo
Call the Configuration.setBatch method or Eyes.setBatch method with an object of this class to configure the batch for one or more tests.
BatchInfoPlain
Call the Configuration.setBatch method or Eyes.setBatch method with an object of this type to configure the batch for one or more tests.
CheckSettings
The methods in this class are used as part of the check Fluent API to configure and execute checkpoints.
CheckSettingsPlain
The methods in this type are used as part of the check Fluent API to configure and execute checkpoints.
ChromeEmulationInfo
Objects of this type are used to configure the Ultrafast Grid to render checkpoints by emulating a device by using Chrome mobile emulation.
ClassicRunner
An object of this class is used to manage multiple Eyes sessions when working without the Ultrafast Grid.
Configuration
This class is used to create a configuration object that is used to configure an Eyes object by passing it to the Eyes.setConfiguration method.
ConfigurationPlain
This type is used to create a configuration object that is used to configure an Eyes object by passing it to the Eyes.setConfiguration method.
DesktopBrowserInfo
Objects of this type are used to configure the Ultrafast Grid to render checkpoints by rendering them on a particular desktop browser.
Eyes
This class provides the main methods used to execute tests and checkpoints.
IOSDeviceInfo
Objects of this type are used to configure the Ultrafast Grid to render checkpoint images.
ImageRotation
An object of this class represents the amount that an image should be rotated.
Location
Provides an object that describes a coordinate. An object of this type is required as a parameter in some methods.
LocationPlain
Provides an object that describes a coordinate. An object of this type is required as a parameter in some methods.
MatchResult
This value is for internal use only.
MatchResultPlain
This value is for internal use only.
PropertyData
A test property is a user-defined name/value pair that you can associate with a test. You can view these properties as well as filter and group by these properties in the Test Manager. You can set properties using the Eyes.addProperty method, Configuration.addProperty method, Configuration.setProperties method or Configuration.properties property.
PropertyDataPlain
A test property is a user-defined name/value pair that you can associate with a test. You can view these properties as well as filter and group by these properties in the Test Manager. You can set properties using the Eyes.addProperty method, Configuration.addProperty method, Configuration.setProperties method or Configuration.properties property.
ProxySettings
An object used to set and retrieve the details of the proxy server used to interact with the Eyes server.
ProxySettingsPlain
An object used to set and retrieve the details of the proxy server used to interact with the Eyes server.
RectangleSize
Provides an object that describes a rectangle. An object of this type is required as a parameter in some methods.
RectangleSizePlain
Provides an object that describes a rectangle. An object of this type is required as a parameter in some methods.
Region
Provides an object that describes a rectangular area at a coordinate. An object of this type is required as a parameter in some methods.
RunnerOptionsPlain
An object of this type is used to define options for VisualGridRunner or ClassicRunner.
SessionUrls
An object of this class is returned as part of the information in the TestResults class. This class provides URIs that can be used in a browser to display the Test Manager batch and test results for this test.
SessionUrlsPlain
An object of this type is returned as part of the information in the TestResults class. This type provides URIs that can be used in a browser to display the Test Manager batch and test results for this test.
StepInfo
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.
StepInfoPlain
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 type are used to retrieve information for a given step in the test results.
Target
This class provides methods that are used to
TestAccessibilityStatus
Provides the overall result of an accessibility test.
TestResultContainer
An object of this type represents the result of running a test. It bundles together the test results and an exception status.
TestResultContainerPlain
An object of this type represents the result of running a test. It bundles together the test results and an exception status.
TestResults
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.
TestResultsPlain
Encapsulates the results of a visual test, including summary information and checkpoint-specific details. An object of this type is returned by the close method upon test completion.
TestResultsSummary
An object of this type is used to obtain all of the test results that were run using the VisualGridRunner or ClassicRunner runner.
VisualGridRunner
An object of this class is used to manage multiple Eyes sessions when working with the Ultrafast Grid.
VisualLocatorSettings
Use the fields of this object to defined the locator names and whether all instances should be found or only the first.