Interface Description AlmRunInfo An object that includes test or business component information originating from ALM. AutAn abstraction of an AUT process launched by the user. BusinessComponentRunInfo An object representing the ALM Business Component information. CalendarBaseBase interface for Calendar test objects. ClickableIndicates that this object can be clicked. CloneableObjectIndicates a test object that exposes a public Clone method. DescriptionInterface for a class to be used as a test object description. DesktopEnvironmentRepresents an environment on which UFT Developer performs test operations. DoubleClickableIndicates that this object can be double-clicked. EnabledProviderA TestObject that supports the isEnabled method. EnvironmentBase interface for AUT environments. KeyboardDeviceAn interface that provides low-level keyboard operations. LocationInfoProviderIndicates that a test object supports accessing properties of its location on the screen. MenuItemBaseBase interface for all MenuItem interfaces in SDK. MouseDeviceAn interface that provides low-level mouse operations. NativeObjectExposes invocation capabilities available for native objects that were returned by the
ScrollableRepresents test objects that support scrolling. SDKConfigurationDefines the configuration information for the SDK. SupportDragAndDropA test object that supports drag and drop. SupportSendKeysA test object that supports the
SupportsNativeObjectA test object that supports the getNativeObject property, which returns a proxy of the native object represented by this test object instance. TestObjectBase interface for all test objects. TestObjectDescriberBase interface for all classes that support describing test objects. TopLevelObjectThe interface marks test object types that can be described from the Desktop. UiObjectBaseBase interface for all UiObjects in all technologies. VisibleProviderA TestObject that supports the isVisible method. WaitUntilEnabledProviderA test object that supports the waitUntilEnabled method. WaitUntilTestObjectState.WaitUntilEvaluator<T extends TestObject>This interface exposes the evaluate method, which evaluates if an object in the AUT is currently in a specific state. WaitUntilVisibleProviderA test object that supports the waitUntilVisible method. Class Description AppModelBaseBase class of all generated Application Model classes. AppModelNodeBase<T extends TestObject,TDescription extends Description>Base class for all container sub-classes generated under the Application Model class. ClickArgsClass defining operations that can be specified in a Click operation. DateRangeA range of dates used for month calendar controls that support multi-selection. DescriptionBaseThe base class for all Description classes that support the index and Visual Relation Identifier (VRI) test object properties. DescriptionBase.BuilderThis class can be used to construct an instance of the DescriptionBase class using the builder pattern. DescriptionBase.Init<T extends DescriptionBase.Init<T>>Helper class for DescriptionBase.Builder. DesktopA top-level Window or Dialog test object. DragAndDropArgsClass defining the behavior for drag and drop operations. EnvironmentDescriptionAn object describing the environment that the test requires, in capability name-value pairs. EnvironmentDescription.BuilderThis class can be used to construct an instance of the EnvironmentDescription class using the builder pattern. EnvironmentDescription.Init<T extends EnvironmentDescription.Init<T>>Helper class for EnvironmentDescription.Builder. EnvironmentFactoryA class for creating an
FunctionKeysSupplies constants representing the Function keyboard keys(F1 - F12), which can be used in the input parameter string of the
ImageMaskAreaA class representing image mask rectangle areas. KeyboardA class that enables low-level keyboard operations. KeysSupplies constants representing keyboard keys, which can be used in the input parameter string of the
LocationProvides a location (relative to an object in the application) for operations that support it. LocationPropertyClass for defining a test object's location property. ModifiableSDKConfigurationInterface for defining the configuration information for the SDK. MouseA class that enables low-level mouse operations. PropertiesDescriptionThe base of all test object descriptions. RegExpPropertyThe class used for regular expression properties. ScrollInfoClass representing the properties of a scroll bar. ScrollPropertyThe class used for scrollbar properties. SDKThe UFT Developer base class. SDKConfigurationFactoryFactory for creating an SDK configuration. SizePropertyThe size properties of a test object. StringPropertyRepresents a string property in a description of a test object. TopLevelObjectNodeBase<T extends TopLevelObject,TDescription extends Description>This class is used by 'Application Model Code Generator' as the base class for all container classes. VideoDataAn object that holds video binary data. VisualRelationClass representing Visual Relations Identifier (VRI) data.
Each VisualRelation class contains a reference to a test object, and up to three possible relations:
horizontal relation, vertical relation, and proximity relation.
The VisualRelation class can be initialized using the following builder pattern:
WaitUntilTestObjectStateThis class provides the waitUntil static method, which can be used to wait until an object reaches a specific state. Enum Description CheckedStateRepresents the check box state. HorizontalVisualRelationThe horizontal location of the related test object relative to the object to identify. ImageFormatFormats which can be used in ImageData construction. Keyboard.KeysKeys which can be used in sending keyboards events. KeyModifierRepresents keyboard keys that can be pressed and held down during the execution of a method, such as the SendKeys method. MouseButtonThe mouse button to use for mouse operations. OrientationThe visual orientation of an object. PositionIndicates the position for an offset relative to this object in the application. ProximityVisualRelationThe distance or hierarchical location of the related test object relative to the object to identify. RunningLeanFtTestTypeRepresents the possible running ALM test types ScrollOrientationRepresents the scroll bar orientation. ScrollTypeThe type of scrolling operation. SDKModeIndicates which mode the UFT Developer runtime engine uses for test runs. SwipeDirectionOptions for swipe direction. VerticalVisualRelationThe vertical location of the related test object relative to the object to identify. VideoFormatFormats which can be used in VideoData construction. WindowExtendedStylesExtended window styles as defined in the Windows API. WindowStateThe window state. WindowStylesWindow styles as defined in the Windows API. Exception Description DescriptionExceptionAn Exception that is raised when errors are encountered in the description of test objects. EmptySessionIdExceptionThe exception that is thrown when an empty session ID is received from the UFT Developer server. GeneralGridExceptionThe exception that is thrown when a general grid exception is thrown . GeneralLeanFtExceptionRepresents general errors that occur during UFT Developer application execution. GeneralReplayExceptionRepresents general errors that occur during replay stage of the UFT Developer application. GeneralServerErrorExceptionRepresent general errors that occur on the UFT Developer server side. InvalidAgentExceptionThe exception that is thrown when a message with an invalid agent field value is received by the UFT Developer server. InvalidFormatExceptionThe exception that is thrown when a message with an invalid format is received by the UFT Developer server. InvalidMessageFieldExceptionThe exception that is thrown when a message with an invalid field value is received by the UFT Developer server. InvalidVersionExceptionThe exception that is thrown when a message with invalid version is received by the UFT Developer server. LabNotConnectedExceptionThe exception that is thrown when the UFT Developer runtime engine is not connected to the expected Lab. MessageTypeNotSupportedExceptionThe exception that is thrown when a not supported message type received by the UFT Developer server. MobileCenterNotConnectedExceptionThe exception that is thrown when the UFT Developer runtime engine is not connected to UFT Digital Lab (UFT Mobile). NodeUnavailableExceptionThe exception that is thrown when a grid has found a node with a matching capabilities but it is currently locked. NoMatchingNodeFoundExceptionGeneralThe exception that is thrown when a grid has not found any registered node with the given capabilities NoValidLicenseExceptionThe exception that is thrown when no valid UFT Developer license is found. ObjectCookieNotFoundExceptionThe exception that is thrown when a test object cookie is not found in the UFT Developer server. ReplayArgumentOutOfRangeExceptionThe exception that is thrown when the value of an argument to a method is outside the allowable range of values, as defined by the invoked replay method. ReplayBrowserNotInstalledExceptionThe exception that is thrown when the browser type requested to launch is not installed. ReplayItemNotFoundExceptionThe exception that is thrown when an item of the test object is not found in the AUT. ReplayItemNotUniqueExceptionThe exception that is thrown when an item of the test object can't be uniquely identified in the AUT. ReplayObjectDisabledExceptionThe exception that is thrown when a test object with the given description is disabled in the AUT. ReplayObjectNotFoundExceptionThe exception that is thrown when a test object with the given description is not found in the AUT. ReplayObjectNotUniqueExceptionThe exception that is thrown when a test object's description is not sufficient to uniquely identify the test object in the AUT. ReplayObjectNotVisibleExceptionThe exception that is thrown when a test object with the given description is not visible in the AUT. ReplayParentMissingExceptionThe exception that is thrown when a parent of the test object with the given description is not found in the AUT. ReplayTimeoutExceptionThe exception that is thrown when a time out occurred during replay. ServerAlreadyInRecordModeExceptionThe exception that is thrown, when a start record request is received by the UFT Developer server, which is already in a record mode. ServerIsShuttingDownExceptionThe exception that is thrown when an attempting to access the UFT Developer server while it is shutting down. SessionNotFoundExceptionThe exception that is thrown when an unknown session ID is received by the UFT Developer server. VriDescriptionExceptionException raised when errors are encountered in the VRI description of test objects.