5.3 Dashlet-Events

5.3.1 Einleitung

Wie in "5.2.3 Kommunikation Dashlet ↔ enaio® webclient" dargestellt, arbeitet enaio® webclient auf Event-Basis. Im Nachfolgenden werden die einzelnen Events in einer Übersicht dargestellt. Details zu jedem Event findet sich dann auf der jeweiligen Event-Unterseite.

Events (sortiert nach Titel)

5.3.2 Event-Registrierung

Um eine eigene Methode am onInit- oder onUpdate-Event als Handler zu registrieren, bietet die Kommunikationsbibliothek jeweils eine Registrierungsmethode an:

onInit → lib.registerOnInitCallback(<Method>, "*");
onUpdate → lib.registerOnUpdateCallback(<Method>, "*");

Als ersten Parameter nehmen beide Registrierungsmethoden eine Methodenreferenz entgegen, die bei Eintreffen des Events aufgerufen wird. Diese Methode erhält beim Aufruf den gesamten Payload des onInit- bzw. des onUpdate-Events als Argument, sodass Sie direkt auf die Informationen zugreifen können.

Der zweite Parameter sollte nicht wie dargestellt einen * enthalten sondern die Hostadresse, auf dem der enaio® webclient zu erreichen ist. Wenn z. B. https://enaio.mydomain.com/osweb die Adresse von enaio® webclient ist, so tragen Sie als zweiten Parameter https://enaio.mydomain.com ein. Dies dient der Sicherheit, damit dem Dashlet keine fremden postMessages von anderen Browserfenstern oder -tabs zugesendet werden können.

Beispiel (TypeScript)

// Callback-Funktion, die beim onInit-Event aufgerufen wird
function handleOnInit(initData) {
  console.log("onInit-Daten empfangen:", initData);
  
  // Beispiel: Zugriff auf den aktuellen Kontext
  if (initData && initData.context) {
    console.log("Kontext: ", initData.context);
  }
  // Weitere Initialisierung abhängig vom Kontext ...
}

// Registrierung des onInit-Callbacks
lib.registerOnInitCallback(handleOnInit, "https://enaio.mydomain.com");

5.3.3 Liste der Events

Übersicht über alle verfügbaren Events in enaio® webclient und ab welcher Version diese verfügbar sind.

Event	Verfügbar ab	Beschreibung

Event

Verfügbar ab

Beschreibung

onInit (Dashlet)

10.0 Final SR2

onUpdate (Dashlet)

10.0 Final SR2