HTML-SDK

Benötigt: IP-Symcon >= 7.1

Beschreibung

Das HTML-SDK ermöglicht es PHP-Modulen eine individuelle Objektdarstellung zu nutzen. Diese Darstellung ermöglicht dank HTML volle Flexibilität. Durch Nachrichten zwischen der HTML-Darstellung und dem Modul kann die Darstellung zur Laufzeit aktualisiert werden oder das Modul über Interaktion durch den Benutzer informieren.

HTML als Darstellung nutzen

Soll das HTML-SDK verwendet werden, so muss die Darstellung mit der Funktion SetVisualizationType aktiviert werden. Soll dann die Kachel in der Visualisierung dargestellt werden, wird die Funktion GetVisualizationTile verwendet um den HTML-Inhalt zurückzugeben.

Übersetzung

Analog zu Konfigurationsformularen werden auch die Texte der HTML-Elemente der Darstellung basierend auf der Sprache des Benutzers lokalisiert.

Nachrichten

Die Funktion GetVisualizationTile wird initial einmalig aufgerufen. Soll die Darstellung zur Laufzeit angepasst werden, so muss dies über Nachrichten geschehen. Alternativ ermöglichen Nachrichten einen Kanal von der Darstellung zum Modul um Variablen zu schalten oder andere Interaktion durchzuführen.

Es ist zwar möglich eine vergleichbare Kommunikation auch über eine HTML-Box zu realisieren. Dies ist allerdings zum einen recht aufwendig und birgt zum anderen das Risiko Sicherheitslücken zu erstellen, welche ausgenutzt werden könnten. Die Kommunikation via HTML-SDK ist im Gegenzug in beide Richtungen mit dem Passwort der Visualisierung abgesichert.

Modul zu Darstellung

Soll eine Nachricht vom Modul zur Darstellung geschickt werden, so muss im Modul die Funktion UpdateVisualizationValue verwendet werden. Um den Inhalt dieser Nachricht in der Darstellung zu empfangen und zu verarbeiten, muss via JavaScript die Funktion handleMessage implementiert werden. Diese erhält als Eingabe genau den Inhalt, der mit UpdateVisualizationTile abgeschickt wurde. Das Format dieser Daten ist absolut frei und sollte passend zum Modul gewählt werden.

Darstellung zu Modul

Die Darstellung kann via JavaScript die Funktion requestAction verwenden. Diese Funktion führt im Gegenzug auf Seite des Moduls die PHP-Funktion RequestAction aus, wodurch das Modul auf die Nachricht reagieren kann.

Spezielle Funktionen in JavaScript

Das HTML-SDK bietet eine Reihe von Funktionen, welche innerhalb der Darstellung via JavaScript verwendet werden können.

Webinar und Beispiele

Bei der Veröffentlichung wurde die Funktionalität des HTML-SDK im Rahmen eines Webinars auf YouTube vorgestellt.

In unserem Test-Repository können auch einige Beispielimplementation eingesehen und ausprobiert werden: