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:

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

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

Name Type Attributes Description

args

Object

The arguments for the click operation.

Properties

Name Type Attributes Default Description

button MouseButton <optional> MouseButton.left The mouse button to use for the click.

anchor Position <optional> Position.center The position within the object from which the offset is taken.

offset

Object

The offset from the anchor position.

Properties

Name	Type	Attributes	Default	Description
`x`	number	<optional>	0	The x-coordinate of the offset.
`y`	number	<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(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>

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(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>

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

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

Parameters:

Name	Type	Description
`duration`	int	The number of seconds to hover on the AI object. This parameter is optional. (Default=2)

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>

search(text) → {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:

Name	Type	Description
`text`	string	The 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:

Name	Type	Description
`text`	string	The 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:

Name	Type	Description
`encodedText`	string	The 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:

Name	Type	Description
`state`	boolean	Indicates 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:

Name	Type	Description
`encodedText`	string	The encoded text to type into the AI object.

Returns:

a promise that is fulfilled when the setText operation ends.

Type: Promise.<void>

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

Captures and returns a Base64 representation of this test object.

Parameters:

Name Type Attributes Description

options

Object

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>

text() → {Promise.<string>}

Returns the object's text.

Returns:

a promise that is fulfilled with the object's text.

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>

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>

AiObjectTO

AI. AiObjectTO

Constructor

new AiObjectTO()

Members

displayName

Methods

$(description) → {*}

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

aiClass() → {Promise.<string>}

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

Properties

Properties

description() → {*}

doubleClick() → {Promise.<void>}

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

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

getValue() → {Promise.<any>}

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

highlight() → {Promise.<void>}

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

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

longClick() → {Promise.<void>}

parent() → {*}

rightClick() → {Promise.<void>}

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

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

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

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

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

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

Properties

text() → {Promise.<string>}

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

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

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

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

Send Help Center Feedback

AiObjectTO

Constructor

new AiObjectTO()

Members

displayName

Methods

$(description) → {*}

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

aiClass() → {Promise.<string>}

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

Properties

Properties

description() → {*}

doubleClick() → {Promise.<void>}

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

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

getValue() → {Promise.<any>}

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

highlight() → {Promise.<void>}

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

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

longClick() → {Promise.<void>}

parent() → {*}

rightClick() → {Promise.<void>}

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

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

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

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

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

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

Properties

text() → {Promise.<string>}

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

verifyImageMatch(expectedImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}

verifyImageMatchWithMask(expectedImage, maskAreaImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}

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

Send Help Center Feedback

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

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

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

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

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

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

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

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

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

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

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