GuiSession

SAPGUI. GuiSession

new GuiSession(props[opt]) → {SAPGUI.GuiSession}

The description of an SAP Gui Session test object.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes a GuiSession test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
SAPGUI.GuiSession

Methods

applicationServer(applicationServer[opt]) → {string|Description}

The name of the application server.
Parameters:
NameTypeAttributesDescription
applicationServerstring <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(client[opt]) → {string|Description}

The client selected on the login screen.
Parameters:
NameTypeAttributesDescription
clientstring <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(codePage[opt]) → {number|Description}

The code page currently used for this session.
Parameters:
NameTypeAttributesDescription
codePagenumber <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(id[opt]) → {string|Description}

The session's unique identifier in text format.
Parameters:
NameTypeAttributesDescription
idstring <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(language[opt]) → {string|Description}

The language in which the user is working.
Parameters:
NameTypeAttributesDescription
languagestring <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(name[opt]) → {string|Description}

The name of the session.
Parameters:
NameTypeAttributesDescription
namestring <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(systemName[opt]) → {string|Description}

The name of the SAP system.
Parameters:
NameTypeAttributesDescription
systemNamestring <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(systemNumber[opt]) → {number|Description}

The system number.
Parameters:
NameTypeAttributesDescription
systemNumbernumber <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(user[opt]) → {string|Description}

The user name for the current session.
Parameters:
NameTypeAttributesDescription
userstring <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