getEnvironment(code)

rich.getEnvironment(code) liest einen Umgebungsslot des Rich Clients synchron aus dem Bridge-Mitglied osjxGetEnvironment(code) aus. Sie ist eine Methode des Rich-Client-Handles — der Handle wird einmal über dashlet.getRichClientApi() bezogen und seine Methoden lesen die Bridge pro Aufruf (verzögert, ohne Snapshot).

1. Signatur

getEnvironment(code: number): string | null;

2. Parameter

Name Typ Beschreibung

code

number

Der Umgebungsslot-Code (einer der dokumentierten Slots unten, oder eine beliebige andere Zahl — ein unbekannter Slot liefert null, nicht die Markierung).

3. Verhalten

Das Bridge-Mitglied osjxGetEnvironment(code) wird synchron, pro Aufruf aufgerufen — die Bridge wird verzögert zum Aufrufzeitpunkt gelesen (eine später reduzierte oder ausgetauschte Bridge-Oberfläche wird sofort sichtbar; es wird kein Snapshot gehalten). Die zurückgegebene Zeichenkette wird ohne Trimmen weitergegeben: Slot 10 (Clientversion) behält sein Nachlauf-Leerzeichen (z. B. '12.0.702 ').

Slot Bedeutung Anmerkung

3

Anmeldename

10

Clientversion

Rohwert: das Nachlauf-Leerzeichen bleibt erhalten (entfernt/normalisiert nur in InitContext.clientVersion).

14

Vollständiger Name

16

E-Mail

18

User-GUID

24

Sprache (GUI-Kurzcode, z. B. eng, de)

'' ist ein echter Wert — Version 10.10 liefert am Start leere Werte (Warm-up, siehe unten).

27

Session-GUID

sonst

nicht dokumentiert

Die Host-Markierung „Unbekannter Parameter: N" wird gefiltert — die Methode liefert null statt der Markierung.

null und '' sind streng getrennt: null bedeutet „nicht lesbar" (fehlendes oder nicht-funktionales Mitglied, ausnahmswerfender Aufruf, nicht-String-Ergebnis oder ein unbekannter Slot, dessen Host-Markierung gefiltert wurde); '' ist ein echter leerer Wert und wird erhalten. Zur Unterscheidung eines unbekannten Slots von einem fehlenden Mitglied dient rich.has('osjxGetEnvironment') (siehe Rich-Client-Handle).

v10.10 Warm-up. Bei Clientversion 10.10 liefert osjxGetEnvironment(n) am Clientstart leere Werte, bis das Warm-up abgeschlossen ist — ein getEnvironment(…)-Aufruf vor dem Warm-up-Ende liefert daher '' (der echte Leerwert), danach den eigentlichen Wert. Die Bibliothek führt dafür ein eigenes begrenztes Warm-up mit Aktualisierung und Neu-Emission des Kontexts durch; siehe Umgebungen — v10.10 Warm-up.

4. Beispiele

const lang = rich.getEnvironment(24);   // 'eng'
const version = rich.getEnvironment(10); // '12.0.702 ' (Leerzeichen bleibt)

5. Fehler

Bridge-Probleme zeigen sich nie als Throw von getEnvironment — der Lesevorgang liefert stattdessen null (fehlendes Mitglied, ausnahmswerfender Aufruf, unbekannter Slot). Die aufgeführten harten Fehler stammen aus dem Handle-Accessor dashlet.getRichClientApi():

  • Error('dashlet destroyed') — das Dashlet wurde zerstört (Accessor und Handle-Methoden).

  • TypeError: Dashlet.getRichClientApi(): the environment is not resolved yet - await the dashlet.init promise first — der Accessor wurde aufgerufen, bevor die Umgebung aufgelöst war.

  • TypeError: Dashlet.getRichClientApi(): the rich client API handle is only available in the richClient environment (current: …) — der Accessor wurde in der falschen Umgebung aufgerufen (der aktuelle Wert wird genannt).