Members

displayName

Methods

$(description) → {*}

Creates a child test object of this test object. This operation does not cause OpenText Functional Testing for Developers to search for the object in the AUT. OpenText Functional Testing for Developers interacts with the application only when a step runs that performs an operation on the AUT object.

Parameters:

Name	Type	Description
description	Description	The description of the test object. Can be a full test object description or a string. If a string is provided, it is interpreted as a CSS selector with a default test object type of WebElement.

Returns:

the new child test object with the provided description.

Type

*

$$(description, dontFilterByType_opt ) → {Promise.<Array.<TestObject>>}

Returns all child objects of this object that match the supplied test object description.

Parameters:

Name	Type	Attributes	Default	Description
description				A description object that defines the test object type and the set of properties and values that should be common to all objects that are returned.
dontFilterByType	boolean	<optional>	false	Set this parameter to true to avoid limiting the returned objects to a specific test object type.

Returns:

a promise that is fulfilled with an array of test objects that match the supplied description.

Type

Promise.<Array.<TestObject>>

accessibilityId() → {Promise.<string>}

The accessibility ID of the mobile object.

Returns:

a promise that is fulfilled with the accessibility ID of the mobile object.

Type

Promise.<string>

className() → {Promise.<string>}

The test object class name used by Digital Lab.

Returns:

a promise that is fulfilled with the test object class name used by Digital Lab.

Type

Promise.<string>

container() → {Promise.<string>}

Information about the table container, if the object is in a table. (iOS only)

Returns:

a promise that is fulfilled with the information about the table container, if the object is in a table. (iOS only)

Type

Promise.<string>

description() → {*}

Returns the description for this test object. The test object must be obtained using the $ method, otherwise, this method returns null.

Returns:

the description for this test object.

Type

*

exists(timeout_opt ) → {Promise.<boolean>}

Checks whether this object exists in the AUT.

Parameters:

Name	Type	Attributes	Description
timeout	number	<optional>	The time (in seconds) to wait for this object before returning a result of true or false. By default, uses the object synchronization timeout defined in the runtime engine settings.

Returns:

a promise that is fulfilled with a boolean indicating whether the object exists.

Type

Promise.<boolean>

getTextLocations(text, rectangle_opt ) → {Promise.<Object>}

Returns all rectangular areas containing the specified text within this object.

Parameters:

Name	Type	Attributes	Description
text	string		The text to search for in the test object.
rectangle	Object	<optional>	The rectangular area in the test object to search for the text.

Returns:

a promise that is fulfilled with an array of rectangles containing all rectangular areas containing the specified text within this object.

Type

Promise.<Object>

getVisibleText(rectangle_opt ) → {Promise.<string>}

Returns all visible text from this object.

Parameters:

Name	Type	Attributes	Description
rectangle	Object	<optional>	The rectangular area in the test object to return the text from.

Returns:

a promise that is fulfilled with all the visible text from this object.

Type

Promise.<string>

highlight() → {Promise.<void>}

Highlights this object in the AUT.
Remark: This may be useful when debugging a test.

Returns:

a promise that is fulfilled when the highlighting operation ends.

Type

Promise.<void>

highlightMatches(description, dontFilterByType_opt ) → {Promise.<number>}

Highlights all children that match the supplied test object description.

Parameters:

Name	Type	Attributes	Default	Description
description				A description object that defines the test object type and the set of properties and values that should be common to all objects that are highlighted.
dontFilterByType	boolean	<optional>	false	Set this parameter to true to avoid limiting the highlighted objects to a specific test object type.

Returns:

a promise that is fulfilled with the number of matches that are found and highlighted.

Type

Promise.<number>

hint() → {Promise.<string>}

Instruction or example indicating the type of content to enter for the value of a control, for example, a grayed out hint inside a text box.

Returns:

a promise that is fulfilled with the hint of the mobile object.

Type

Promise.<string>

isCheckable() → {Promise.<boolean>}

Indicates whether the mobile object can be checked.

Returns:

a promise that is fulfilled with an indication of whether the mobile object can be checked.

Type

Promise.<boolean>

isChecked() → {Promise.<boolean>}

Indicates whether the mobile object is checked. (Relevant for objects that can have a check mark.)

Returns:

a promise that is fulfilled with an indication of whether the mobile object is checked.

Type

Promise.<boolean>

isClickable() → {Promise.<boolean>}

Indicates whether the object can be tapped.

Returns:

a promise that is fulfilled with an indication of whether the object can be tapped.

Type

Promise.<boolean>

isEnabled() → {Promise.<boolean>}

Indicates whether the mobile object is enabled.

Returns:

a promise that is fulfilled with an indication of whether the mobile object is enabled.

Type

Promise.<boolean>

isFocusable() → {Promise.<boolean>}

Indicates whether the object can receive focus.

Returns:

a promise that is fulfilled with an indication of whether the object can receive focus.

Type

Promise.<boolean>

isFocused() → {Promise.<boolean>}

Indicates whether the mobile object is in focus.

Returns:

a promise that is fulfilled with an indication of whether the mobile object is in focus.

Type

Promise.<boolean>

location() → {Promise.<Point>}

The location of the mobile object, format: {x: 0, y: 0}

Returns:

a promise that is fulfilled with the location of the mobile object.

Type

Promise.<Point>

longPress(longPressArgs_opt ) → {Promise.<void>}

Taps and holds the object for a short time.

Parameters:

Name	Type	Attributes	Description
longPressArgs	Object	<optional>	Arguments object that defines the behavior of the longPress operation. Properties Name Type Attributes Default Description duration number <optional> 0 The number of seconds to continue pressing (iOS only). numberOfTouchPoints number <optional> 1 The number of points to tap, similar to the number of fingers you would use for the gesture on a real device. (iOS only) location Location <optional> The location where the operation is performed. gesture string <optional> "" The gesture class designed by the mobile application developer to handle this gesture on this object. (iOS only)

Returns:

a promise that is fulfilled after long-pressing the center of the object or the specific location defined by the user.

Type

Promise.<void>

nativeClass() → {Promise.<string>}

The native class of the mobile object.

Returns:

a promise that is fulfilled with the native class of the mobile object.

Type

Promise.<string>

panByLocations(start, end) → {Promise.<void>}

Performs a pan gesture on the object, by location.

Parameters:

Name	Type	Description
start	Location	The location at which to start the pan gesture.
end	Location	The location at which to end the pan gesture.

Returns:

a promise that is fulfilled after the pan operation has occurred.

Type

Promise.<void>

panByPoints(start, end, panArgs_opt ) → {Promise.<void>}

Performs a pan gesture on the object, using points.

Parameters:

Name	Type	Attributes	Description
start	Point		The point at which to start the pan gesture.
end	Point		The point at which to end the pan gesture.
panArgs	Object	<optional>	Arguments object that defines the behavior of the pan operation: Properties Name Type Attributes Default Description velocity number <optional> The speed at which to perform the pan operation. (iOS Only) gesture string <optional> "" The gesture class designed by the mobile application developer to handle this gesture on this object.

Returns:

a promise that is fulfilled after the pan operation has occurred.

Type

Promise.<void>

parent() → {*}

Returns the parent test object of this test object. The child object must be obtained using the $ method, otherwise, this method returns null.

Returns:

the parent test object of this test object.

Type

*

pinch(scale, pinchArgs_opt ) → {Promise.<void>}

Performs a pinch gesture on the object.

Parameters:

Name	Type	Attributes	Description
scale	number		The scale for the pinch gesture. This number is the ratio between the start distance and the end distance between the two touch points used for the pinch. For example, if you were to touch a screen with your fingers 6 cm apart, and pinch until your fingers were 3 cm apart, the scale would be 0.5.
pinchArgs		<optional>	Arguments object that defines the behavior of the pinch operation. Properties Name Type Attributes Default Description velocity number <optional> The speed at which to perform the pinch operation. location Location <optional> The location at which to perform operation. gesture string <optional> "" The gesture class designed by the mobile application developer to handle this gesture on this object. (iOS only)

Returns:

a promise that is fulfilled after the pinch has occurred.

Type

Promise.<void>

resourceId() → {Promise.<string>}

The resource ID of the object. (Android only)

Returns:

a promise that is fulfilled with the resource ID of the object. (Android only)

Type

Promise.<string>

select(item) → {Promise.<void>}

Selects the specified radio button in the group by index or by name.

Parameters:

Name	Type	Description
item	string | number	Name or index. index: the 0-based index of the radio button to select. name: the name of the radio button to select.

Returns:

a promise that is fulfilled after the requested selection occurred.

Type

Promise.<void>

size() → {Promise.<Size>}

The size of the mobile object, format: {width: 0, height: 0}

Returns:

a promise that is fulfilled with the size of the mobile object.

Type

Promise.<Size>

snapshot(options_opt ) → {Promise.<string>}

Captures and returns a Base64 representation of this test object.

Parameters:

Name	Type	Attributes	Description
options	Object	<optional>	An options object that defines the image capture preferences. Properties Name Type Attributes Default Description format string <optional> "png" The format of the image. Possible values: png, bmp.

Returns:

a promise that is fulfilled with the Base64 string of the test object's image.

Type

Promise.<string>

swipe(swipeDirection, swipeArgs_opt ) → {Promise.<void>}

Swipes the object in the specified direction.

Parameters:

Name	Type	Attributes	Description
swipeDirection	SwipeDirection		The direction of the swipe.
swipeArgs	object	<optional>	Arguments object that defines the behavior of the swipe operation, format: Properties Name Type Attributes Default Description location Location <optional> The location where the operation is performed. gesture string <optional> "" The gesture class designed by the mobile application developer to handle this gesture on this object. (iOS only)

Returns:

a promise that is fulfilled after the swipe has occurred.

Type

Promise.<void>

tap(tapArgs_opt ) → {Promise.<void>}

Taps the center of the object.

Parameters:

Name	Type	Attributes	Description
tapArgs	Object	<optional>	Arguments object that defines the behavior of the tap operation. Properties Name Type Attributes Default Description numberOfTaps number <optional> 1 The number of times to tap the object (iOS only). location Location <optional> The location where the operation is performed. numberOfTouchPoints number <optional> 1 The number of points to tap, similar to the number of fingers you would use for the gesture on a real device. (iOS only) gesture string <optional> "" The gesture class designed by the mobile application developer to handle this gesture on this object. (iOS only)

Returns:

a promise that is fulfilled after tapping the center of the object or the specific location defined by the user.

Type

Promise.<void>

text() → {Promise.<string>}

The text of the mobile object.

Returns:

a promise that is fulfilled with the text of the mobile object.

Type

Promise.<string>

verifyImageExists(imageToFind, similarity_opt ) → {Promise.<Object>}

Checks whether a snapshot of this object contains the supplied image.

Parameters:

Name	Type	Attributes	Description
imageToFind	string		A Base64 string representation of the image to look for within the test object's snapshot.
similarity	number	<optional>	The minimum similarity between the two images (as a percentage), above which the find is considered a match. Default = 100.

Returns:

a promise that is fulfilled with an object representing the point where the image was located, or null if it was not found.

Type

Promise.<Object>

verifyImageMatch(expectedImage, pixelTolerance_opt , rgbTolerance_opt ) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.

Parameters:

Name	Type	Attributes	Description
expectedImage	string		A Base64 string representation of the image to compare to the test object snapshot.
pixelTolerance	number	<optional>	The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerance	number	<optional>	The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.

Returns:

a promise that is fulfilled with a boolean representing the comparison result.

Type

Promise.<boolean>

verifyImageMatchWithMask(expectedImage, maskAreaImage, pixelTolerance_opt , rgbTolerance_opt ) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.

Parameters:

Name	Type	Attributes	Description
expectedImage	string		A Base64 string representation of the image to compare to the test object snapshot.
maskAreaImage	string		A Base64 string representation of the image mask area to use in the image comparison.
pixelTolerance	number	<optional>	The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerance	number	<optional>	The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.

Returns:

a promise that is fulfilled with a boolean representing the comparison result.

Type

Promise.<boolean>

waitUntilEnabled(timeout_opt ) → {Promise.<boolean>}

Waits until the test object becomes enabled or the timeout elapses. This method is useful for synchronizing your test with your application.

Parameters:

Name	Type	Attributes	Description
timeout	number	<optional>	The length of time to wait (in milliseconds) for the test object to become enabled.

Returns:

a promise fulfilled with true if test object becomes enabled before the timeout is reached; otherwise, false.

Type

Promise.<boolean>

waitUntilExists(timeout_opt ) → {Promise.<boolean>}

Waits until this test object exists or until the specified timeout elapses. This method is useful for synchronizing your test with your application.

Parameters:

Name	Type	Attributes	Description
timeout	number	<optional>	The time (in seconds) to wait for this object to exist. By default, uses the object synchronization timeout defined in the runtime engine settings.

Returns:

a promise that is fulfilled with a boolean indicating whether the object exists.

Type

Promise.<boolean>