openIndexData()

Öffnet die Indexdaten von objectId nur-lesend (mode: 'view') oder editierbar (mode: 'edit'). Eine der sieben portablen Fassade-Methoden des Dashlet-Handles — siehe call für die zeichenkettenbasierte Oberfläche, die denselben Dispatch-Kern teilt.

1. Signatur

openIndexData(options: OpenIndexDataOptions): Promise<boolean | undefined>;

2. Parameter

Name Typ Beschreibung

inNewTab

boolean

In einem neuen Tab öffnen (Webclient; von der Rich-Client-Bridge wird ignoriert — dort gibt es kein Äquivalent).

mode

'view' oder 'edit'

'view' = nur-lesend, 'edit' = editierbar.

objectId

string oder number

Die Objekt-ID (osId).

objectTypeId

string oder number (optional)

Die Objekttyp-ID. Verbessert die Performance im Webclient; wird vom Rich-Client-Bridge nicht unterstützt (dort nicht gesendet).

3. Verhalten pro Umgebung

Umgebung Verhalten

webclient

Postet openIndexData mit dem plain-Array-Params-Slot [inNewTab, mode, objectId, objectTypeId] (korreliert — die Host-Antwort wird abgewartet). Löst sich mit dem booleschen Host-Ergebnis auf.

rich client

osjxOpenDataSheet(objectId, mode === 'view') — eine numerische Objekt-ID, und nur-lesend genau dann, wenn mode === 'view'. inNewTab und objectTypeId haben kein Bridge-Äquivalent und werden nicht gesendet. Löst sich undefined auf (die Bridge hat keinen Rückgabewert).

standalone (oder noch im Erkennungsmodus ohne Wire)

Es gibt keinen Host-Antwortsweg — der Aufruf wird (begrenzt) mit dem TimeoutError abgelehnt, damit Aufrufer einen Fallback darstellen können, statt aufzuhängen.

4. Beispiele

await dashlet.openIndexData({ inNewTab: false, mode: 'view', objectId: '1024' });

Das zeichenkettenbasierte Äquivalent (derselbe Dispatch-Kern) ist dashlet.call('openIndexData', [false, 'view', '1024']) — die positionale Array-Form derselben Optionen.

5. Fehler

  • TypeError — eine ungültige (fehlende/leere/nicht-numerische) objectId im Rich Client: Die ID wird in die numerische Bridge-Form umgewandelt, und leere oder nicht-numerische IDs werden beschreibend abgelehnt, statt stillschweigend Objekt 0 zu öffnen.

  • Error('dashlet destroyed') — das Dashlet wurde vor dem Aufruf zerstört.

  • TimeoutError — begrenztes Fehlen einer Antwort im Standalone, oder ein Host, der innerhalb von timeoutMs nicht geantwortet hat.

  • Das Host-{ error }-Payload — wenn der Host einen Fehler bei einem Webclient-Methodenaufruf meldet.