Open topic with navigation

# GuiSession

## SAPGUI. GuiSession

## new GuiSession(propsopt) → {SAPGUI.GuiSession}

The description of an SAP Gui Session test object.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`props` | Object | <optional> | Initializes a GuiSession test object using the supplied property bag.

##### Returns:

the description object that was initialized.

Type
  SAPGUI.GuiSession

# Methods

## applicationServer(applicationServeropt) → {string|Description}

The name of the application server.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`applicationServer` | string | <optional> | When provided, this method acts as a setter and sets the applicationServer value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored applicationServer value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## client(clientopt) → {string|Description}

The client selected on the login screen.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`client` | string | <optional> | When provided, this method acts as a setter and sets the client value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored client value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## codePage(codePageopt) → {number|Description}

The code page currently used for this session.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`codePage` | number | <optional> | When provided, this method acts as a setter and sets the codePage value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored codePage value; otherwise it returns 'this' for use with the builder pattern.

Type
  number | Description

## id(idopt) → {string|Description}

The session's unique identifier in text format.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`id` | string | <optional> | When provided, this method acts as a setter and sets the id value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored id value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## language(languageopt) → {string|Description}

The language in which the user is working.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`language` | string | <optional> | When provided, this method acts as a setter and sets the language value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored language value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## name(nameopt) → {string|Description}

The name of the session.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`name` | string | <optional> | When provided, this method acts as a setter and sets the name value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored name value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## systemName(systemNameopt) → {string|Description}

The name of the SAP system.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`systemName` | string | <optional> | When provided, this method acts as a setter and sets the systemName value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored systemName value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## systemNumber(systemNumberopt) → {number|Description}

The system number.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`systemNumber` | number | <optional> | When provided, this method acts as a setter and sets the systemNumber value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored systemNumber value; otherwise it returns 'this' for use with the builder pattern.

Type
  number | Description

## user(useropt) → {string|Description}

The user name for the current session.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`user` | string | <optional> | When provided, this method acts as a setter and sets the user value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored user value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description