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>

activate() → {Promise.<void>}

Activates this window.

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

close() → {Promise.<void>}

Closes this window or dialog box.

Returns:

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

*

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>

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>

isMinimized() → {Promise.<boolean>}

Indicates whether the window is minimized.

Returns:

a promise that is fulfilled with an indication whether the window is minimized.

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>

maximize() → {Promise.<void>}

Maximizes this window or dialog box.

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

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>

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

*

program() → {Promise.<string>}

The name of the SAP source program that is executing.

Returns:

a promise that is fulfilled with the name of the SAP source program that is executing.

Type

Promise.<string>

resize(sizeOrWidth, height_opt) → {Promise.<void>}

Resizes the Window to the specified dimensions.

Parameters:

Name	Type	Attributes	Description
sizeOrWidth	Size | number		If a Size object is passed, the Window resizes according to the object. If a number is passed, it is interpreted as a width.
height	number	<optional>	If the first parameter is a full Size object, this parameter is ignored. Otherwise it is interpreted as a height.

Returns:

a promise that is fulfilled after resizing the window/dialog.

Type

Promise.<void>

restore() → {Promise.<void>}

Restore the Window/Dialog.

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

screenNumber() → {Promise.<number>}

The number of the displayed screen.

Returns:

a promise that is fulfilled with the number of the displayed screen.

Type

Promise.<number>

scroll(orientation, toPos) → {Promise.<void>}

Sets the position of the the specified scroll bar.

Parameters:

Name	Type	Description
orientation	ScrollOrientation	The scroll bar to move.
toPos	number	The 0-based position to move the scroll bar to, in pixels

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

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

Selects an item from a context menu.

Parameters:

Name	Type	Description
menuItemId	string	The item ID.

Returns:

a promise that is fulfilled when the operation ends.

Type

Promise.<void>

sendKey(key) → {Promise.<void>}

Presses a non-printing key or key combination.

Parameters:

Name	Type	Description
key	SAPGUI.SapFunctionKey	The key or key-combination.

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>

text() → {Promise.<string>}

The text associated with the object.

Returns:

a promise that is fulfilled with the text associated with the object.

Type

Promise.<string>

transaction() → {Promise.<string>}

The transaction the user is executing.

Returns:

a promise that is fulfilled with the transaction the user is executing.

Type

Promise.<string>

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>

workingPaneSize() → {Promise.<Size>}

The size of the working pane in character metric. The working pane is the area between the toolbar and the status bar.

Returns:

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

Type

Promise.<Size>