Open topic with navigation

# GuiSessionTO

## SAPGUI. GuiSessionTO

GuiSessionTO

## Constructor

## new GuiSessionTO()

# 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 LeanFT to search for the object in the AUT. LeanFT 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>>

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

The name of the window that has focus.

##### Returns:

a promise that is fulfilled with the name of the window that has focus.

Type
  Promise.<string>

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

The name of the application server. Applies only when the connection specifies an application server and is not using load balancing.

##### Returns:

a promise that is fulfilled with the name of the application server.

Type
  Promise.<string>

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

The client selected on the login screen.

##### Returns:

a promise that is fulfilled with the client selected on the login screen.

Type
  Promise.<string>

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

Closes the SAP GUI for Windows session without displaying a warning message.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## codePage() → {Promise.<number>}

The code page for this session.

##### Returns:

a promise that is fulfilled with the code page for this session.

Type
  Promise.<number>

## 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 milliseconds) 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(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>

## flushes() → {Promise.<number>}

The number of flushes or passes of data during server communication to the client.

##### Returns:

a promise that is fulfilled with the number of flushes or passes of data during server communication to the client.

Type
  Promise.<number>

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

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

Login group information. Applies only when connection is using load balancing.

##### Returns:

a promise that is fulfilled with the login group information.

Type
  Promise.<string>

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

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

The session's unique identifier in text format.

##### Returns:

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

Type
  Promise.<string>

## interpretationTime() → {Promise.<number>}

The time, in milliseconds, it takes for the client to interpret the information received from the server.

##### Returns:

a promise that is fulfilled with the interpretation time.

Type
  Promise.<number>

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

The language the user is working in.

##### Returns:

a promise that is fulfilled with the language the user is working in.

Type
  Promise.<string>

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

The name of the message server. Applies only when connection is using load balancing.

##### Returns:

a promise that is fulfilled with the name of the message server.

Type
  Promise.<string>

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

The name of the session.

##### Returns:

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

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>

## reset(transactionCodeopt) → {Promise.<void>}

Navigates to the session initial screen.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`transactionCode` | string | <optional> | The transaction to navigate to.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

## responseTime() → {Promise.<number>}

The server response time in milliseconds.

##### Returns:

a promise that is fulfilled with the server response time in milliseconds.

Type
  Promise.<number>

## roundTrips() → {Promise.<number>}

The number of communications between client and server while the client is locked and waiting for data from the server.

##### Returns:

a promise that is fulfilled with the number of communications between client and server while the client is locked. and waiting for data from the server.

Type
  Promise.<number>

## screenNumber() → {Promise.<number>}

The number of the displayed screen.

##### Returns:

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

Type
  Promise.<number>

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

Suspends execution until the SAP GUI for Windows session is available. After time-out, the test run continues regardless of the session status. You can use this method when invoking a new session from an existing session or when moving from a session that is open on one server to a new session on a different server.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`timeOut` | number | <optional> | Milliseconds.

##### Returns:

a promise that is fulfilled when the operation ends.

Type
  Promise.<void>

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

The name of the SAP system.

##### Returns:

a promise that is fulfilled with the name of the SAP system.

Type
  Promise.<string>

## systemNumber() → {Promise.<number>}

The system number. Applies only when connection specifies an application server and is not using load balancing.

##### Returns:

a promise that is fulfilled with the system number.

Type
  Promise.<number>

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

##### Returns:

a promise that is fulfilled with the SAPGUI component type.

Type
  Promise.<SAPGUI.ComponentType>

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

The user name.

##### Returns:

a promise that is fulfilled with the user name.

Type
  Promise.<string>

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