Erstellen eines Installationsassistenten

Einführung

Bevor Nutzer irgendeine Speakap-Anwendung benutzen können, muss die Anwendung vom Netzwerkadministrator über den Speakap-Marktplatz (derzeit als begrenzte Betaversion) installiert werden. Falls gewünscht, kann dieser Installationsprozess ohne eine Interaktion mit der Anwendung, die installiert werden soll, durchgeführt werden. Anwendungen können jedoch wahlweise einen Installationsassistenten anbieten, der vervollständigt werden muss, bevor die Installation abgeschlossen ist. Dieser Installationsassistent wird vom Schöpfer der Anwendung eingebaut und betrieben und ist der perfekte Ort für Dritte um ihre Backendkomponenten mit der Speakap-Plattform zu verbinden.

Manifest Eingabe

Um einen Installationsassistenten zu erstellen, muss eine Eingabe zum manifest.json ergänzt werden. Die entry für den Installationsassistenten könnte wie folgt aussehen:

{
    "position": "install-wizard",
    "devices": "all",
    "url": "https://example.app.speakap.io/install"
}

Sobald diese entry vorhanden ist, wird der Administrator der die Anwendung installiert mit dem Assistenten vorgestellt bevor er oder sie die Installation abschließen kann.

Ausführung des Assistenten

Der aktuelle Assistent wird wie jede andere Eingabe für die Anwendung ausgeführt, um jedoch den Assistenten zu vervollständigen, muss ein spezielles saveSettings-Ereignis aus der Speakap Frontend Library, berücksichtigt werden, wie:

Speakap.on("saveSettings", function(event) {
    // perform some validation whether the user has successfully completed all
    // steps of the wizard
    if (everythingIsSuccessful) {
        Speakap.replyEvent(event, { status: "success" });
    } else {
        Speakap.replyEvent(event, { status: "failure" });
        Speakap.showError("An informative message explaining what went wrong");
    }
});

Dieses saveSettings Ereignis wird ausgelöst wann immer der Nutzer die Installationsschaltfläche des Assistenten klickt (die Schaltfläche wird von Speakap-Frontend bereit gestellt, nicht von der Anwendung) und sobald Speakap die“success” Antwort empfangen hat, wird es die Installation als erfolgreich betrachten und die Anwendung wird für das Netzwerk verfügbar.

Bitte beachten Sie, dass die Antworten auf das Ereignis unsynchron generiert werden können, so haben Sie zum Beispiel die Möglichkeit Anfragen an das eigene Anwendungs-Backend zu senden.