Share this page

# ApplicationSessionTO

## Oracle. ApplicationSessionTO

An Oracle Applications session window.

# Constructor

## new ApplicationSessionTO()

### 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 cause UFT Developer to search for the object in the AUT. UFT Developer 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, dontFilterByTypeopt) → {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>

## classPath() → {Promise.<string>}

Returns the Oracle class hierarchy of the object's Oracle class.

Returns:

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

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
  *

## exists(timeoutopt) → {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>

## exit() → {Promise.<void>}

Exits the Oracle Applications session window.

Returns:

a promise that is fulfilled when the exit operation ends.

Type
  Promise.<void>

## getActiveWindow() → {Promise.<TestObject>}

Returns the test object representing the currently active window.

Returns:

a promise that is fulfilled with a test object representing the currently active window.

Type
  Promise.<TestObject>

## getTextLocations(text, rectangleopt) → {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(rectangleopt) → {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, dontFilterByTypeopt) → {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>

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

## objectType() → {Promise.<string>}

Returns the general object type.

Returns:

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

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
  *

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

Invokes the specified Oracle softkey.

Parameters:

Name | Type | Description
--- | --- | ---
`key` | Oracle.SoftKeys | The softkey function to perform. Use Oracle.SoftKeys for special keys.

Returns:

a promise that is fulfilled when the sendKeys 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(optionsopt) → {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>

## sync(secondsopt) → {Promise.<void>}

Instructs UFT Developer to wait the specified number of seconds to synchronize with Oracle Applications before continuing the run session.

Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`seconds` | number | <optional> | If a number is passed, it will wait this number of seconds for a response.

Returns:

a promise that is fulfilled when the sync operation ends.

Type
  Promise.<void>

## verifyImageExists(imageToFind, similarityopt) → {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, pixelToleranceopt, rgbToleranceopt) → {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, pixelToleranceopt, rgbToleranceopt) → {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(timeoutopt) → {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>

Tips to improve your search results... UFT Developer JavaScript SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: