Eyes JavaScript - Selenium 4 SDK classes

Platform: Selenium 4Language: JavaScript

Enums

BrowserType
The set of browsers supported by the Visual Grid.
DeviceName
Defines the names of the devices that can be rendered by the Visual Grid.
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 lookupid.
StitchMode
Defines the mechanism used to offset sub-images when generating a full page image by stitching together multiple sub-images.

Classes

ApiUrls
An object of this class is contained in the lookupid object, which is in itself an object in the lookupid object returned by the lookupid 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.
AppUrls
An object of this class is contained in the lookupid object, which is in itself an object in the lookupid object returned by the lookupid 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.
BatchInfo
Call lookupid with an object of this class to configure the batch for one or more tests.
ClassicRunner
An object of this class is used to manage multiple Eyes sessions when working without the Visual Grid.
Configuration
This class is used to create a configuration object that is passed to the lookupid method.
Eyes
This class provides the main methods used to execute tests and checkpoints.
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.
PropertyData
A property is name/value pair that you can associate with a test. TBDAG: Should this be 'A property is a name/value pair' or 'A property is the name/value pair'? You can view these properties and filter and group by these properties in the Test Manager. Set properties using the Configuration method lookupid or lookupid.
ProxySettings
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.
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.
SeleniumCheckSettings
The methods in this class are used as part of the lookupid Fluent API to configure and execute checkpoints.
SessionUrls
An object of this class is returned as part of the information in the lookupid class. This class 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 lookupid method returns an object with methods/properties defined by the lookupid class. Within the lookupid, there is an array of objects which have the properties defined by the class lookupid. 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.
Target
This class provides methods that are used to define the top level target (the entire window, region, element, frame, etc.) for the lookupid method.
TestResultContainer
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 lookupid method upon test completion.
TestResultsSummary
An object of this type is used to obtain all of the test results that were run using a runner such as the lookupid.
VisualGridRunner
An object of this class is used to manage multiple Eyes sessions when working with the Visual Grid.