JC_API: JavaScript-API für SiteArchitect

JavaScript-Objekt: top.JC_API
Access-API-Dokumentation: JavaClientApi

SiteArchitect stellt eine JavaScript-API zur Verfügung, die Funktionalität zur Aktualisierung der Vorschau im integrierten Browser sowie zur Ausführung von FirstSpirit-Scripts in der Vorlagenverwaltung und ausführbaren Klassen, die von FirstSpirit-Modulen bereitgestellt werden, anbietet.

Zugriff auf diese API geschieht über das JavaScript-Objekt top.JC_API. Dieses Objekt kann von JavaScript verwendet werden, das in einem HTML-Dokument in der Vorschau eines integrierten Browsers verarbeitet wird.

Vorschau aktualisieren

void reload() löst eine Aktualisierung der Vorschau des integrierten Browsers aus, aus der die Funktion aufgerufen wurde. Dabei wird die aktuelle Vorschau-URL verwendet.

Scripts und Executables ausführen

Object execute(String executable) löst die Ausführung des referenzierten FirstSpirit-Scripts (in der Vorlagenverwaltung) oder einer Klasse, die von einem FirstSpirit-Modul bereitgestellt wird und das FirstSpirit-Access-API-Interface Executable implementiert, aus.

Object execute(String executable, Map parameters, String callback) löst die Ausführung des referenzierten Scripts oder der referenzierten ausführbaren Klasse (wie oben beschrieben) aus und macht die im Map-Objekt angegebenen Parameter dem Script oder der Klasse zugänglich. Das Script oder die Klasse wird asynchron ausgeführt; ein etwaiger Rückgabewert des Scripts oder der Klasse wird einer JavaScript-Callback-Funktion zur Weiterverarbeitung übergeben.

Parameterreferenz

• String executable referenziert ein FirstSpirit-Script oder eine ausführbare Klasse aus einem FirstSpirit-Modul.
  
  • Das Werteformat script:<SCRIPT_UID> referenziert ein Script, das in der Vorlagenverwaltung gespeichert ist, anhand seiner UID.
  • Das Werteformat class:<FULLY_QUALIFIED_CLASS_NAME> referenziert eine Klasse, die das Access-API-Interface Executable implementiert.
• Map parameters definiert eine Map in JSON-Format mit einem oder mehreren Schlüssel-Wert-Paaren, z.B. {"param1":"value1", "param2":"value2"}. Diese Parameter werden dem Script oder dem Executable zur Verfügung gestellt.
• String callback gibt den Namen einer JavaScript-Funktion oder die Definition eines kompletten JavaScript-Funktionsobjektes an, die einen Parameter akzeptiert, um den Rückgabewert des Scripts oder der ausführbaren Klasse innerhalb des Vorschaudokuments weiterzuverarbeiten.