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

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>

activateNode(nodeOrPath) → {Promise.<void>}

Activate a node.

Parameters:

Name	Type	Description
nodeOrPath	SAPGUI.TreeViewNode | string	The node to be activated. The input can be the TreeViewNode, or the path of the node

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

buildNodePath(…nodePathParts) → {string}

Returns the path constructed from the specified path elements.

Parameters:

Name	Type	Attributes	Description
nodePathParts	number | string	<repeatable>	The menu path parts can be: logical name(string), full path(string), or numeric 1-based index(int).

Returns:

the path of the specified menu item.

Type

string

clickColumn(columnOrIndex) → {Promise.<void>}

Clicks the specified column in this column tree or list tree

Parameters:

Name	Type	Description
columnOrIndex	number | string	The name or the 0-based index of the column to click.

Returns:

a promise that is fulfilled when the 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

*

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>

getNode(path) → {SAPGUI.TreeViewNode}

Create a TreeViewNode from its given path. When the path is not unique, returns the first matching node. Use the BuildNodePath method to build the node path string to be used as the path argument for this method.

Parameters:

Name	Type	Description
path	string	Elements of the path are separated by semi-colons (;).

Returns:

TreeViewNode object. See SAPGUI.TreeViewNode

Type

SAPGUI.TreeViewNode

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

The object's unique identifier in text format.

Returns:

a promise that is fulfilled with the object's unique identifier in text format.

Type

Promise.<string>

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

Waits until this test object becomes enabled 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 milliseconds) to wait 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>

isEnabled() → {Promise.<boolean>}

Indicates whether the tree can accept user input.

Returns:

a promise that is fulfilled with an indication whether the tree can accept user input.

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

The name of the object.

Returns:

a promise that is fulfilled with the name of the object.

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>

openContextMenu() → {Promise.<void>}

Opens a tree's default context menu. After opening a context menu, you can use the selectMenuItemById method to select the menu item.

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

openHeaderContextMenu(columnOrIndex) → {Promise.<void>}

Opens the context menu for a header in this column tree or list tree, by column name or index.

Parameters:

Name	Type	Description
columnOrIndex	number | string	The name or the 0-based index of the column to open.

Returns:

a promise that is fulfilled when the 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

*

pressEnter() → {Promise.<void>}

Presses the ENTER key when the tree is in focus.

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

selectedItem() → {Promise.<string>}

The value of the selected item in the tree node.

Returns:

a promise that is fulfilled with the value of the selected item in the tree node.

Type

Promise.<string>

selectedNodePath() → {Promise.<string>}

The path to the selected node. The semicolon delimited list of nodes in the path.

Returns:

a promise that is fulfilled with the path to the selected node.

Type

Promise.<string>

selectionMode() → {Promise.<SAPGUI.TreeSelectionMode>}

Indicates which selections can be made in the tree.

Returns:

a promise that is fulfilled with which selections can be made in the tree.

Type

Promise.<SAPGUI.TreeSelectionMode>

selectMenuItemById(menuItemId) → {Promise.<void>}

Selects the specified menu item from a context menu in a tree.

Parameters:

Name	Type	Description
menuItemId	string	The SAP ID of the menu item in string format.

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

selectNode(nodeOrPath) → {Promise.<void>}

Select a node.

Parameters:

Name	Type	Description
nodeOrPath	SAPGUI.TreeViewNode | string	The node to be selected. The input can be the TreeViewNode, or the path of the node

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

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

treeType() → {Promise.<SAPGUI.TreeType>}

Indicates the type of tree.

Returns:

a promise that is fulfilled with the type of tree.

Type

Promise.<SAPGUI.TreeType>

type() → {Promise.<SAPGUI.ComponentType>}

The SAPGUI component type of this object.

Returns:

a promise that is fulfilled with the SAPGUI component type.

Type

Promise.<SAPGUI.ComponentType>

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>