/
getEnvironment

getEnvironment

Owned by Technische Redaktion
Last updated: Mar 31, 2025
1 min read

Einleitung

Die Methode getEnvironment stellt grundlegende Informationen zum jeweiligen Client oder angemeldeten Benutzer zur Verfügung.

Verfügbar: ab enaio® webclient 11.10.7

Beispiel

Beispiel (TypeScript)
let environment = await lib.getEnvironment();

Parameter

Keine

Rückgabewert

Die Methode gibt ein JSON-Objekt zurück, das die folgenden Informationen enthält:

Parameter

Type

Beschreibung

Parameter

Type

Beschreibung

1

userName

string

Benutzername des angemeldeten Benutzers.

2

clientType

string

  • web → enaio® webclient (Browser)

  • desktop_app → enaio® webclient as desktop application 

  • mobile → enaio® webclient (Browser) on a mobile device

  • mobile_app → enaio® mobile

  • rich_client → enaio® rich client

3

clientVersion

string

Versionsnummer der Client-Anwendung, einschließlich Build-Zeitstempel und Commit-Hash.

Format: "Hauptversion.Nebenversion.Patch (Build Zeitstempel, Commit-Hash)"

Beispiel:

  • web → "Hauptversion.Nebenversion.Patch (Build YYYY-MM-DDThh:mm:ss+0000)"

  • desktop_app → "Hauptversion.Nebenversion.Patch (Build YYYY-MM-DDThh:mm:ss.SSSZ, Commit-Hash)"

  • mobile → "Hauptversion.Nebenversion.Patch (Build YYYY-MM-DDThh:mm:ss+0000)"

  • mobile_app → "Hauptversion.Nebenversion.Patch (Build YYYY-MM-DDThh:mm:ss.SSSZ, Commit-Hash)"

  • rich_client → "Hauptversion.Nebenversion.Patch"

4

userId

integer

Die Benutzer-ID des angemeldeten Benutzers.

5

fullName

string

Der vollständige Name des Benutzers, sofern vorhanden.

6

email

string

Die E-Mail-Adresse des aktuellen Benutzers, sofern vorhanden.

7

userGuid

string

Die GUID des aktuellen Benutzers.

8

colorScheme

string

Das aktuelle Farbschema des Clients:

Wert

Steht im enaio®client für

Steht im enaio® webclient für

light

White

Light

light_gray

Light Gray

---

dark_gray

Dark Gray

---

dark

Black

Dark

high_contrast

---

High Contrast

 

9

sessionGuid

string

Die Session-GUID zum enaio® gateway. Sie kann z.  B. für REST-Anfragen genutzt werden, um sich am enaio® gateway zu authentifizieren.

10

languageObjectDefinition

string

Die vom Benutzer aktuell ausgewählte Sprache der Objektdefinition im enaio® webclient.

11

accentColor

string

Die vom Benutzer aktuell ausgewählte Akzentfarbe im enaio® webclient.

12

language

string

Die vom Benutzer aktuell ausgewählte Oberflächensprache im enaio® webclient.

13

baseUrl

string

Die Basis-URL zum enaio® gateway. Sie kann z. B. für REST-Anfragen genutzt werden.

14

workflowUserGuid 

string

Die Workflow-GUID des Nutzers.

15

workflowOrganizationGuid 

string

Die Workflow-GUID der Organisation.

 

Related content