API-Übersicht

Die öffentliche API-Fläche von ecmind-blue-dashlet — die enaio Dashlet-API, framework-agnostisch. Das Importieren des Pakets registriert window.osDashletInit und den puffernden Message-Listener bei Import (kein Host-Event kann vor der Konfiguration verloren gehen); die erste Anweisung im eigenen Top-Level sollte dann der installDashletGlobal-Aufruf sein.

1. Einstiegspunkt und Konfiguration

installDashletGlobal(options?) — installiert das vom Host aufgerufene Globale und gibt den Dashlet-Handle zurück
DashletOptions — expectedOrigin, timeoutMs, pollIntervalMs, detectionTimeoutMs, window

2. Das `Dashlet`-Objekt

Das Dashlet-Objekt — vollständige Mitgliedfläche
init — das Versprechen, das genau ein Mal mit dem normalisierten Kontext erfüllt wird (in jeder Umgebung, einschließlich des abgemilderten Standalone-Zustands)
onInit() — Abo auf Init-Ausgaben
onUpdate() — der reservierte Update-Slot
onError() — Abo auf Fehler
call(method, params?) — dünner, zeichenkettenbasierter Host-Durchgang (dieselben Wire-Posts wie die Fassade unten)
getWebclientApi() — der Webclient-Handle: die sieben Endpunkte + rohe call, asynchron (gecacht)
getRichClientApi() — der Rich-Client-Handle: die vollständige osjx*-Bridge + has() + rohe call, synchron (gecacht)
destroy() — Abbruch des Pollings, Entfernung der Listener, Trennung der Verbindung (dokumentiert auf der Dashlet-Seite)

3. Portable Fassade (host-unabhängig)

Ein Aufruf dient sowohl dem Webclient als auch dem Rich Client; die Bibliothek wählt die Wire-/Bridge-Abbildung aus der aufgelösten Umgebung. Standalone: Jede Methode lehnt mit dem begrenzten Zeitüberschreitungsfehler ab.

openIndexData(options) — Indexdaten-Ansicht, nur-lesen oder bearbeitbar
openObject(objectId) — das Objekt in seiner natürlichen Ansicht
openLocation(options) — der Ort des Objekts (Ordner/Register-Ansicht)
openHitListByIds(options) — eine gemischte Trefferliste mit den gegebenen Objekten
refreshHitListObjects(ids) — Objekte in offenen Trefferlisten aktualisieren
getSelectedObjects() — die Auswahl, in beiden Clients identisch normalisiert
resetSessionTimeout() — Reset des Sitzungstimeouts (Rich Client: dokumentiertes No-Op)

4. Typen und Fehlermodell

InitContext — die eine normalisierte Kontextform, inkl. Sicherheitshinweis zu Host-Zeichenketten
SelectedEntry — der Elementtyp der Auswahl, die mainType-Berechnung, SelectedObjectRef
Fehlermodell — TimeoutError, Host-Fehler, deskriptive `TypeError`s, begrenzte Semantik

5. Sekundäre API

Feinere Primitive für Verbraucher, die unterhalb der Fassade zugreifen:

WebclientWire — die postMessage-Wire-Klasse
originMatches() — Origin-Abgleich für die Wire
withTimeout() — das begrenzte Antwort-Zeitüberschreitungs-Primitiv
Normalisierungshilfen — Normalisierung von Auswahl, Ort, Sitzung und Payload
Probe-Hilfen — Erkundung der Bridge-Fähigkeiten
VERSION und registerBootstrap