Appium Java Eyes SDK classes

Platform: AppiumLanguage: Java SDK:

Enums

IosVersion
Defines versions of iOS for defining devices for Visual Grid. See IosDeviceInfo
ElementType
Defines values that can be passed to the method AppiumCheckSettings.cut.
Feature
Enable optional Eyes features by passing values defined by this Enum to Configuration.setFeatures.
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.

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.closeAsync or 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.
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.
AppiumCheckSettings
The methods in this class are used as part of the check Fluent API to configure and execute checkpoints.
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.
ChromeEmulationInfo
Objects of this class 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.
DesktopBrowserInfo
Objects of this class 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.
ImageRotation
An object of this class represents the amount that an image should be rotated.
IosDeviceInfo
Objects of this class are used to configure the Ultrafast Grid to render checkpoint images.
Location
Provides an object that describes a coordinate. An object of this type is required as a parameter in some methods.
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.
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.
RenderBrowserInfo
This class is used to provide information as to how a test was rendered using the Ultrafast Grid.
RunnerOptions
An object of this class is used to define options for VisualGridRunner or ClassicRunner.
SessionAccessibilityStatus
Provides the overall result of an accessibility test.
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.
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.
Target
This class provides methods that are used to define the top level target (the entire window, region, element, frame, etc.) for the check 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 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.
VisualGridOption
An object of this type represents a configuration key/value pair, to be passed to the Ultrafast Grid.
VisualLocator
Use the methods of this class to create visual locators that can be passed to Eyes.locate to find regions in the viewport with the images defined by the visual locaters.
VisualLocatorSettings
Use the methods of this class to extend visual locators created using VisualLocator by chaining them to each other using a fluent style API.