Members
displayName
Methods
$(description) → {*}
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:
- Type
- *
$$(description, dontFilterByTypeopt) → {Promise.<Array.<TestObject>>}
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:
- Type
- Promise.<Array.<TestObject>>
absoluteLocation() → {Promise.<Point>}
Remark: 0,0 is always the top-left corner of the (primary) monitor.
Returns:
- Type
- Promise.<Point>
buildMenuPath(…menuPathParts) → {string}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
menuPathParts | string |
<repeatable> | The menu path parts can be: logical name(string), full path(separated strings by ->). |
Returns:
- Type
- string
classPath() → {Promise.<string>}
Returns:
- Type
- Promise.<string>
description() → {*}
Returns:
- Type
- *
exists(timeoutopt) → {Promise.<boolean>}
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:
- Type
- Promise.<boolean>
getItem(path) → {MenuItem}
Parameters:
Name | Type | Description |
---|---|---|
path | string | The full path of the menu item to select from the menu list. The path is composed of the menu item names separated by a -> set of chars. |
Returns:
- Type
- MenuItem
getTextLocations(text, rectangleopt) → {Promise.<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:
- Type
- Promise.<Object>
getVisibleText(rectangleopt) → {Promise.<string>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
rectangle | Object |
<optional> | The rectangular area in the test object to return the text from. |
Returns:
- Type
- Promise.<string>
highlight() → {Promise.<void>}
Remark: This may be useful when debugging a test.
Returns:
- Type
- Promise.<void>
highlightMatches(description, dontFilterByTypeopt) → {Promise.<number>}
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:
- Type
- Promise.<number>
isEnabled() → {Promise.<boolean>}
Returns:
- Type
- Promise.<boolean>
location() → {Promise.<Point>}
Returns:
- Type
- Promise.<Point>
objectType() → {Promise.<string>}
Returns:
- Type
- Promise.<string>
parent() → {*}
Returns:
- Type
- *
selectFromPopupMenu(...menuPathParts) → {Promise.<void>}
Opens the context menu and selects the specified menu option.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
menuPathParts | string |
<repeatable> | The parts that make up the path of the context menu item to select. Each part can be a name of a menu item or a full path of items separated by "->". |
Returns:
- Type
- Promise.<void>
selectMenuItem(menuItem) → {Promise.<void>}
Parameters:
Name | Type | Description |
---|---|---|
menuItem | MenuItem | string | The item to be selected. It can be the MenuItem, or the menu path. Use the getItem method to get the menu item argument for this method. Use the buildMenuPath method to build the item path string that can then be used as the menu path argument for this method. |
Returns:
- Type
- Promise.<void>
sendKey(key) → {Promise.<void>}
Parameters:
Name | Type | Description |
---|---|---|
key | Oracle.SoftKeys | The softkey function to perform. Use Oracle.SoftKeys for special keys. |
Returns:
- Type
- Promise.<void>
shortTitle() → {Promise.<string>}
Returns:
- Type
- Promise.<string>
size() → {Promise.<Size>}
Returns:
- Type
- Promise.<Size>
snapshot(optionsopt) → {Promise.<string>}
Parameters:
Name | Type | Attributes | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | Object |
<optional> | An options object that defines the image capture preferences.
Properties
|
Returns:
- Type
- Promise.<string>
verifyImageExists(imageToFind, similarityopt) → {Promise.<Object>}
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:
- Type
- Promise.<Object>
verifyImageMatch(expectedImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}
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:
- Type
- Promise.<boolean>
verifyImageMatchWithMask(expectedImage, maskAreaImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<boolean>}
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:
- Type
- Promise.<boolean>
waitUntilEnabled(timeoutopt) → {Promise.<boolean>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
timeout | number |
<optional> | The length of time to wait (in milliseconds) for the test object to become enabled. |
Returns:
- Type
- Promise.<boolean>
waitUntilExists(timeoutopt) → {Promise.<boolean>}
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:
- Type
- Promise.<boolean>