Einstellung des Anwendungs- manifest.json

Jede Anwendung hat ein manifest.json welches die Metadaten der Anwendung festlegt. Metadaten enthalten den Namen und das Symbol, mit denen die Anwendung im Speakap Marktplatz gelistet wird, ebenso wie die entries durch welche die Anwendung aufgerufen werden kann. Hier ist ein Beispielmanifest:

{
    "name": {
        "en-US": "Speakap Example Manifest",
        "nl-NL": "Speakap voorbeeldmanifest"
    },
    "icon": "https://example.app.speakap.io/icon.png",
    "iconThumbnailUrl": "https://example.app.speakap.io/icon_thumbnail.png",
    "permissions": ["send_alerts"],
    "entries": [
        {
            "position": "main",
            "devices": "all",
            "url": "https://example.app.speakap.io/",
            "label": {
                "en-US": "Example app",
                "nl-NL": "Voorbeeld-app"
            },
            "icon": "\uf073"
        },
        {
            "position": "network-timeline-widget",
            "devices": "all",
            "url": "https://example.app.speakap.io/widget",
            "height": "200",
            "label": {
                "en-US": "Example widget",
                "nl-NL": "Voorbeeld-widget"
            }
        },
        {
            "position": "install-wizard",
            "devices": "all",
            "url": "https://example.app.speakap.io/install"
        }
    ]
}

name und icon sind die häufigsten allgemeinen Informationen, beide dienen der Präsentation der Anwendung im Speakap Markt. Für den Namen, ebenso wie für entry labels, ist es wichtig, Übersetzungen in jede Sprache zu haben, die für die Zielgruppe Ihrer Anwendung von Bedeutung ist. Die “en-US” Übersetzung ist immer erforderlich, da sie dazu genutzt wird, jedem Nutzer von Speakap den Namen und die Labels in einer Sprache zu präsentieren, für welche die Anwendung keine geeignete Übersetzung bietet.

Die iconThumbnailUrl wird genutzt, um Daten, die von der Anwendung gesendet werden, darzustellen. Beispielsweise können Anwendungen Rechte zum Senden von aktualisierten Zeitstrahlen erteilt werden. Normalerweise aber verfügt jede Aktualisierung über ein Vorschaubild des Verfassers, das in der Nähe dazu angezeigt wird. Für Aktualisierungen, die von einer Anwendung gesendet werden, wird stattdessen das Vorschaubild der Anwendung verwendet.

Die Grundlage des Manifest wird durch die Definitionen der entries gebildet. Mindestens ein Eintrag sollte vorgesehen werden, denn ohne ihn würde die Anwendung für Nutzer nie sichtbar sein. Ebenso wäre nicht erkennbar, dass es überhaupt installiert ist. Jeder Eintrag hat eine position und eine url, und wahlweise können devices, ein label und ein icon bereitgestellt werden. Als Erstes werden wir die verschiedenen Positionen erklären:

 

Position Label? Icon? Beschreibung
main Ja Ja Die main Position für Anwendungen wird dem Benutzer angezeigt, wenn er im linken Menü der Internet oder der mobilen Speakap Anwendung auf eine Anwendung klickt.
network-timeline-widget Ja Nein Die network timeline widget ist eine Position in der Liste von Widgets, die rechter Hand der Netzwerkzeitlinie angezeigt werden (Auf der “Homepage” der Speakap Internetanwendung). In der mobilen Version ist diese Position nicht verfügbar.
install-wizard Nein Nein Der installation wizard wird angezeigt wenn die Anwendung vom Netzwerkadministrator installiert wurde. Mehr dazu ist im Tutorial für das Erstellen eines Installationsassistenten zu finden.
settings-page Nein Nein Die settings page wird genutzt um die Anwendung nach ihrer Installation einzustellen. Sie funktioniert genauso wie die “install-wizard” Position, hat jedoch die Option durch das lightboxTemplateproperty eine andere Anzeige auszuwählen.
*-lightbox Nein Nein Jede Position mit einer “-lightbox” Endung kann genutzt werden, um benutzerdefinierte Lightbox-Inhalte zu laden. Siehe auch openLightbox() für mehr Informationen.

Bevor wir weiter machen, werden wir ebenso alle erlaubten Eigenschaften zum Festlegen eines entry erklären:

Property Beschreibung
position Die Position, für die der entry gilt (Siehe Beschreibung oben).
permissions Eine Reihe von Rechten, die eine Anwendung erfordert. Siehe auch Application Permissions.
devices Das Element, für welches der entry gilt. Eines für phone, tablet, desktop oder all.
url Die URL, von der das Objekt geladen werden soll. Diese URL wird durch eine signed request geladen.
label Das für den Benutzer sichtbare Label, um den entry der Anwendung darzustellen. Dies sollte als Wörterbuch für Übersetzungen festgelegt werden (Siehe Beispiel).
icon Das für den Benutzer sichtbare Symbol, um den entry der Anwendung darzustellen. Dies könnte eine vollständige URL zum Symbol sein oder (vorzugsweise) ein Unicode codepoint in der Schriftart Awesome. Schriftarteinstellung:http://fortawesome.github.io/Font-Awesome/icons/
lightboxTemplate Nur anwendbar für die settings-page Position, dieses Merkmal definiert, welche Art von Lightbox genutzt werden soll, um die Position zu beinhalten. Ein Wert save-cancel (Standard) stellt eine Lighbox mit den Schaltflächen Speichern und Abbrechen dar. Ein Wert close stellt eine Lightbox mit einer Schließen-Schaltfläche dar.

Jetzt haben Sie ein Verständnis über die Eigenschaften, die festgelegt werden können, und den Positionen, für welche Sie Listeneinträge erstellen. Es ist wichtig zu erkennen, dass der entry durch die Kombination aus der position und den devices definiert wird. Als Beispiel: Sie können ein entry für die “main”-Position für “all” Elemente festlegen wie im Beispiel weiter oben, wenn Sie aber verschiedene URL-Endpunkte nutzen wollen, um eine optimierte Erfahrung für verschiedene Formfaktoren zu bieten, sollten Sie drei entries für die “main”-Position festlegen, eine für “phone”-Elemente, eine für “tablet”-Elemente und eine für “desktop”-Elemente.