Constructor

new FrameTO()

A Web frame object that represents both the frame element in a frame set and an embedded frame that uses the iframe element.
Note: The frame is a separate HTML document that is part of the test object hierarchy.

Members

displayName

Returns the object display name defined in the Application Model.

Methods

$(selector, objType_opt) → {*}

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	Attributes	Default	Description
`selector`	Description \| string			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.
`objType`	Description	<optional>	Web.Element()	The type of test object to use when supplying a CSS string for the selector.

Returns:

the new child test object with the provided description.

Type: *

$$(selector, 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
`selector`	Description \| string			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>>

$x(xpath, childType_opt) → {*}

Creates a child test object of this test object based on the specified xpath. 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	Attributes	Default	Description
`xpath`	string			The xpath to use as the description for the new child test object.
`childType`	Description	<optional>	Web.Element()	The test object type for the new child test object.

Returns:

the new child test object with the provided xpath as its description.

Type: *

absoluteLocation() → {Promise.<Point>}

Returns the object's absolute coordinates relative to the screen (in pixels), format: {x,y}.
Remark: 0,0 is always the top-left corner of the (primary) monitor.

Returns:

a promise that is fulfilled with the object's absolute coordinates.

Type: Promise.<Point>

attributes() → {Promise.<object>}

Returns a copy of the attribute collection that is attached to this object. For example: 'id','class', ...

Returns:

the object keys are the attribute names and the corresponding values are the attribute values.

Type: Promise.<object>

className() → {Promise.<string>}

Returns the object's CSS class.

Returns:

the object's CSS class.

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

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>

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>

getAttribute(attributeName) → {Promise.<string>}

Returns the value of the specified attribute.

Parameters:

Name	Type	Description
`attributeName`	string	The attribute name of the value to retrieve.

Returns:

the value of the specified attribute; null if the attribute does not exist.

Type: Promise.<string>

getComputedStyle(stylePropertyName) → {Promise.<string>}

Returns the value of the specified style.

Parameters:

Name	Type	Description
`stylePropertyName`	string	The style name of the value to retrieve.

Returns:

the value of the specified style. Null if the style does not exist.

Type: Promise.<string>

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>

id() → {Promise.<string>}

Returns the object's HTML identifier.

Returns:

the object's HTML identifier.

Type: Promise.<string>

innerHTML() → {Promise.<string>}

Returns the HTML code contained between the object's start and end tags.

Returns:

the HTML code contained between the object's start and end tags.

Type: Promise.<string>

innerText() → {Promise.<string>}

Returns the text contained between the object's start and end tags.

Returns:

the text contained between the object's start and end tags.

Type: Promise.<string>

waitUntilVisible(timeout[opt]) → {Promise.<boolean>}

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

Parameters:

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

Returns:

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

Type: Promise.<boolean>

isVisible() → {Promise.<boolean>}

Indicates whether the current element is visible.

Returns:

true if the current element is visible, otherwise false.

Type: Promise.<boolean>

location() → {Promise.<Point>}

Returns the object's coordinates relative to the parent window (in pixels), format: {x,y}.

Returns:

a promise that is fulfilled with the object's relative coordinates.

Type: Promise.<Point>

name() → {Promise.<string>}

Returns the object's name property.

Returns:

the object's name property.

Type: Promise.<string>

nativeObject() → {Promise.<Object>}

Returns the native application object that is represented by this test object instance, enabling you to access the native properties and methods provided by that object.

Returns:

a promise that is fulfilled with the native application object that is represented by this test object instance.

Type: Promise.<Object>

outerHTML() → {Promise.<string>}

Returns the object's HTML code and its content.

Returns:

the object's HTML code and its content.

Type: Promise.<string>

outerText() → {Promise.<string>}

Returns the object's text.

Returns:

the object's text.

Type: Promise.<string>

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

runScript(script_to_run) → {Promise.<*>}

Runs the specified JavaScript code in the page's context and returns the result.

Parameters:

Name	Type	Description
`script_to_run`	string \| function	The JavaScript code to run. If a function is passed, it will be transformed to a string and executed in the frame's context.

Returns:

a promise this is fulfilled with the return value of the script.

Type: Promise.<*>

size() → {Promise.<Size>}

Returns the object's size (in pixels).

Returns:

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

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

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>

styles() → {Promise.<object>}

Returns a copy of the style collection that is attached to this object.

Returns:

the object keys are the attribute names and the corresponding values are the attribute values.

Type: Promise.<object>

sync() → {Promise.<void>}

Waits for the page state to be idle.

Returns:

a promise that is fulfilled when the frame is idle.

Type: Promise.<void>

tagName() → {Promise.<string>}

Returns the object's HTML tag.

Returns:

the object's HTML tag.

Type: Promise.<string>

text() → {Promise.<string>}

Returns the inner text of the body element.

Returns:

a promise this is fulfilled with the inner text of the body element.

Type: Promise.<string>

title() → {Promise.<string>}

Returns the element's title attribute.

Returns:

the element's title attribute.

Type: Promise.<string>

url() → {Promise.<string>}

Returns the URL of the HTML page.

Returns:

a promise this is fulfilled with the URL of the HTML page.

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>

FrameTO

Constructor

new FrameTO()

Members

displayName

Methods

$(selector, objTypeopt) → {*}

Parameters:

Returns:

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

Parameters:

Returns:

$x(xpath, childTypeopt) → {*}

Parameters:

Returns:

absoluteLocation() → {Promise.<Point>}

Returns:

attributes() → {Promise.<object>}

Returns:

className() → {Promise.<string>}

Returns:

description() → {*}

Returns:

waitUntilExists(timeout[opt]) → {Promise.<boolean>}

Parameters:

Returns:

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

Parameters:

Returns:

getAttribute(attributeName) → {Promise.<string>}

Parameters:

Returns:

getComputedStyle(stylePropertyName) → {Promise.<string>}

Parameters:

Returns:

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

Parameters:

Returns:

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

Parameters:

Returns:

highlight() → {Promise.<void>}

Returns:

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

Parameters:

Returns:

id() → {Promise.<string>}

Returns:

innerHTML() → {Promise.<string>}

Returns:

innerText() → {Promise.<string>}

Returns:

waitUntilVisible(timeout[opt]) → {Promise.<boolean>}

Parameters:

Returns:

isVisible() → {Promise.<boolean>}

Returns:

location() → {Promise.<Point>}

Returns:

name() → {Promise.<string>}

Returns:

nativeObject() → {Promise.<Object>}

Returns:

outerHTML() → {Promise.<string>}

Returns:

outerText() → {Promise.<string>}

Returns:

parent() → {*}

Returns:

runScript(script_to_run) → {Promise.<*>}

Parameters:

Returns:

size() → {Promise.<Size>}

Returns:

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

Parameters:

Properties

Returns:

styles() → {Promise.<object>}

Returns:

$(selector, objType_opt) → {*}

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

$x(xpath, childType_opt) → {*}

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