AiObjectTO

AI. AiObjectTO

AiObjectTO

Constructor

new AiObjectTO()

An object identified using Artificial Intelligence.

Members

displayName

Returns the object display name defined in the Application Model.

Methods

$(description) → {*}

Creates a child test object of this test object. This operation does not search for the object in the AUT. The interaction with the application occurs only when a step runs and performs an operation on the AUT object.

Parameters:

NameTypeDescription
descriptionDescriptionThe 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, dontFilterByTypeopt) → {Promise.<Array.<TestObject>>}

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

Parameters:

NameTypeAttributesDefaultDescription
descriptionA 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.
dontFilterByTypeboolean <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>>

aiClass() → {Promise.<string>}

Returns the AI Class type of the AI object.

Returns:

a promise that is fulfilled with the object's AI class.
Type
Promise.<string>

click(argsopt) → {Promise.<void>}

Clicks on this object using the definitions from the supplied args object. If you do not provide the args object, the click is performed in the center of the object using the left mouse button.

Parameters:

NameTypeAttributesDescription
argsObject <optional>
The arguments for the click operation.
Properties
NameTypeAttributesDefaultDescription
buttonMouseButton <optional>
MouseButton.left The mouse button to use for the click.
anchorPosition <optional>
Position.center The position within the object from which the offset is taken.
offsetObject <optional>
The offset from the anchor position.
Properties
NameTypeAttributesDefaultDescription
xnumber <optional>
0 The x-coordinate of the offset.
ynumber <optional>
0 The y-coordinate of the offset.

Returns:

a promise that is fulfilled when the click operation ends.
Type
Promise.<void>

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
*

doubleClick() → {Promise.<void>}

Double-clicks in the middle of the AI object. This method is not supported for mobile applications.

Returns:

a promise that is fulfilled when the doubleClick operation ends.
Type
Promise.<void>

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

Checks whether this object exists in the AUT.

Parameters:

NameTypeAttributesDescription
timeoutnumber <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, rectangleopt) → {Promise.<Object>}

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

Parameters:

NameTypeAttributesDescription
textstringThe text to search for in the test object.
rectangleObject <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>

getValue() → {Promise.<any>}

Returns the AI object’s value. The value is based on the following object properties: text for text objects, state for toggleable controls, and value for input fields, text boxes, and combo boxes.

Returns:

a promise that is fulfilled with the object's value.
Type
Promise.<any>

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

Returns all visible text from this object.

Parameters:

NameTypeAttributesDescription
rectangleObject <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, dontFilterByTypeopt) → {Promise.<number>}

Highlights all children that match the supplied test object description.

Parameters:

NameTypeAttributesDefaultDescription
descriptionA 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.
dontFilterByTypeboolean <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>

hover(duration) → {Promise.<void>}

Holds the cursor over an AI object. This method is not supported for mobile applications.

Parameters:

NameTypeDescription
durationintThe duration of the hover on the AI object. This parameter is optional.

Returns:

a promise that is fulfilled when the hover operation ends.
Type
Promise.<void>

longClick() → {Promise.<void>}

Long-clicks in the middle of the AI object. This method is not supported for mobile applications.

Returns:

a promise that is fulfilled when the longClick operation ends.
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
*

rightClick() → {Promise.<void>}

Right-clicks in the middle of the AI object. This method is not supported for mobile applications.

Returns:

a promise that is fulfilled when the rightClick operation ends.
Type
Promise.<void>
Types the specified text into the search box and clicks the search icon. This method is supported only for search AI class.

Parameters:

NameTypeDescription
textstringThe text to type into the search box.

Returns:

a promise that is fulfilled when the search operation ends.
Type
Promise.<void>

sendKeys(text) → {Promise.<void>}

Types the specified text into the AI object.

Parameters:

NameTypeDescription
textstringThe text to type into the AI object.

Returns:

a promise that is fulfilled when the sendKeys operation ends.
Type
Promise.<void>

sendSecureKeys(encodedText) → {Promise.<void>}

Types the specified encoded text into the AI object.

Parameters:

NameTypeDescription
encodedTextstringThe encoded text to type into the AI object.

Returns:

a promise that is fulfilled when the sendSecureKeys operation ends.
Type
Promise.<void>

setState(state) → {Promise.<void>}

Sets the state of the check box/toggle button.

Parameters:

NameTypeDescription
statebooleanIndicates whether this check box/toggle button will be checked.

Returns:

a promise that is fulfilled after the checkbox/toggle button is set.
Type
Promise.<void>

setText(encodedText) → {Promise.<void>}

Sets the value of the AI object. This method is relevant for AIObjects that represent text boxes, input controls, and combo boxes. This method is not supported for mobile applications.

Parameters:

NameTypeDescription
encodedTextstringThe encoded text to type into the AI object.

Returns:

a promise that is fulfilled when the setText operation ends.
Type
Promise.<void>

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

Captures and returns a Base64 representation of this test object.

Parameters:

NameTypeAttributesDescription
optionsObject <optional>
An options object that defines the image capture preferences.
Properties
NameTypeAttributesDefaultDescription
formatstring <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>

text() → {Promise.<string>}

Returns the object's text.

Returns:

a promise that is fulfilled with the object's text.
Type
Promise.<string>

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

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

Parameters:

NameTypeAttributesDescription
imageToFindstringA Base64 string representation of the image to look for within the test object's snapshot.
similaritynumber <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, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}

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

Parameters:

NameTypeAttributesDescription
expectedImagestringA Base64 string representation of the image to compare to the test object snapshot.
pixelTolerancenumber <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerancenumber <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, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}

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

Parameters:

NameTypeAttributesDescription
expectedImagestringA Base64 string representation of the image to compare to the test object snapshot.
maskAreaImagestringA Base64 string representation of the image mask area to use in the image comparison.
pixelTolerancenumber <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerancenumber <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>

waitUntilExists(timeoutopt) → {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:

NameTypeAttributesDescription
timeoutnumber <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>