Startseite
jump to top

Startseite / Vorlagenentwicklung / FirstSpirit API / API-Dokumentation

API-Dokumentation

Die API-Dokumentationen (engl. für Application Programming Interface = Programmierschnittstelle) beschreiben die Schnittstellen zu FirstSpirit. Über diese Schnittstellen kann in den Vorlagen und Skripten auf die unterschiedlichsten Werte, Funktionen usw. zugegriffen werden.

Hierbei wird unterschieden zwischen der Access-API und der Developer-API. Der Unterschied ergibt sich hierbei hauptsächlich aus verschiedenen Stabilitätsauflagen, die nachfolgend näher erläutert werden. Die Dokumentationen zu den APIs werden auch unterschiedlich farblich dargestellt (Access-API = blau, Developer-API = brombeer).

Access-API

Die Access-API gehört zu den wichtigsten Schnittstellen, die FirstSpirit bietet. Sie unterliegt demnach auch den höchsten Stabilitätsauflagen. Diese lassen sich mit folgenden Aussagen beschreiben:

  • Die Access-API ist innerhalb einer Major-Versionslinie stabil.
  • Die Access-API unterliegt dem Deprecation-Announcement:
    • Methoden, Klassen und Funktionen, die verändert werden sollen, werden in der aktuellen Versionslinie zunächst als deprecated (@deprecated) markiert.
    • Wird eine Deprecation in einer Minor-Version hinzugefügt, so bleibt diese innerhalb dieser Minor-Linie erhalten. Damit sind keine Code-Anpassung innerhalb einer Minor-Version notwendig.
    • Methoden, Klassen und Funktionen, die auf diese Weise als deprecated markiert sind, können mit der folgenden Major-Version aus der Access-API entfernt bzw. geändert werden.
  • Beim Wechsel zwischen Minor- oder Release-Versionen sind bei Verwendung der freigegebenen API-Schnittstellen keine Quellcode-Änderungen erforderlich. Es kann aber unter Umständen bei einem Release-Wechsel vorkommen, dass Module für die neue Version neu kompiliert werden müssen. In diesem Fall ist eine Aktualisierung des betroffenen Moduls notwendig (siehe dazu Module (→Dokumentation für Administratoren) sowie allgemein die FirstSpirit Dokumentation zur Modul-Entwicklung (bzw. Thema dieser Dokumentation (→Entwicklerhandbuch für Komponenten))).

Die Dokumentation zur FirstSpirit Access-API kann über einen Klick auf den folgenden Verweis geöffnet werden:

Developer-API

Im Gegensatz zur Access-API unterliegt die Developer-API geringeren Stabilitätsauflagen:

  • Die Developer-API ist innerhalb einer Minor-Versionslinie stabil, d.h. dass Änderungen bei einem Minor-Versionswechsel durchgeführt werden dürfen.

Die Dokumentation zur FirstSpirit Developer-API kann über einen Klick auf den folgenden Verweis geöffnet werden:

Java SE Core-API

Die Java Standard Edition (SE) Core-API-Dokumentation von Oracle (allgemeine Funktionalitäten) kann über einen Klick auf den folgenden Verweis geöffnet werden:

JavaScript-APIs

FirstSpirit stellt mehrere JavaScript-APIs zur Verfügung, die die funktionale Verknüpfung von Vorschaudokument und den Clients ContentCreator und SiteArchitect ermöglichen. So kann z. B. die Konfiguration von Parametern der Funktionalität „Multi Perspective Preview“ (Multi Perspective Preview (MPP) (→Handbuch FirstSpirit SiteArchitect)) vom HTML-Dokument in der integrierten Vorschau gesteuert werden, sodass Parameter nach Ereignissen im Dokument entsprechend angepasst werden.

ContentCreator

SiteArchitect

Multi Perspective Preview (beide Clients)

© 2005 - 2019 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2019-11 | Datenschutz | Impressum | Kontakt