Ausführen von Befehlen
- Themen:
- Web SDK
Erstellt für:
- Developer
Nachdem der Basis-Code auf Ihrer Web-Seite implementiert wurde, können Sie mit der Ausführung von Befehlen mit dem SDK beginnen. Sie müssen nicht auf die externe Datei (alloy.js) vom Server geladen werden, bevor Befehle ausgeführt werden. Wenn das SDK noch nicht fertig geladen wurde, werden Befehle in die Warteschlange gestellt und so bald wie möglich vom SDK verarbeitet.
Befehle werden mit der folgenden Syntax ausgeführt.
alloy("commandName", options);
commandName gibt dem SDK an, was zu tun ist, während options die Parameter und Daten sind, die Sie an einen Befehl übergeben möchten. Da die verfügbaren Optionen vom Befehl abhängen, finden Sie in der Dokumentation weitere Informationen zu den einzelnen Befehlen.
Ein Hinweis zu Promises
Promises sind von grundlegender Bedeutung für die Kommunikation des SDK mit dem Code auf Ihrer Web-Seite. Ein Promise ist eine gängige Programmierstruktur und nicht spezifisch für dieses SDK oder gar JavaScript. Ein Promise fungiert als Proxy für einen Wert, der beim Erstellen des Promise nicht bekannt ist. Sobald der Wert bekannt ist, wird das Promise mit dem Wert „aufgelöst“. Handler-Funktionen können mit einem Promise verknüpft werden, sodass Sie benachrichtigt werden können, wenn das Promise aufgelöst wurde oder ein Fehler im Prozess der Promise-Auflösung aufgetreten ist. Um mehr über Promises zu erfahren, lesen Sie dieses Tutorial oder andere Ressourcen im Web.
Umgang mit Erfolg oder Misserfolg
Jedes Mal, wenn ein Befehl ausgeführt wird, wird ein Promise zurückgegeben. Das Promise steht für den letztendlichen Abschluss des Befehls. Im Beispiel unten können Sie mithilfe der then- und catch-Methoden bestimmen, wann der Befehl erfolgreich ausgeführt wurde oder fehlgeschlagen ist.
alloy("commandName", options)
.then(function(result) {
// The command succeeded.
// "result" is whatever the command returned
})
.catch(function(error) {
// The command failed.
// "error" is an error object with additional information
});
Wenn es für Sie unwichtig ist, wann der Befehl erfolgreich ist, können Sie den then-Abruf entfernen.
alloy("commandName", options)
.catch(function(error) {
// The command failed.
// "error" is an error object with additional information
});
Ebenso können Sie den catch-Abruf entfernen, wenn es für Sie unwichtig ist, wann der Befehl fehlschlägt.
alloy("commandName", options)
.then(function(result) {
// The command succeeded.
// "value" will be whatever the command returned
});
Antwortobjekte
Alle von Befehlen zurückgegebenen Zusagen werden mit einem result -Objekt. Das Ergebnisobjekt enthält Daten, die vom Befehl und der Zustimmung des Benutzers abhängen. Beispielsweise werden Bibliotheksinformationen im folgenden Befehl als Eigenschaft des Ergebnisobjekts übergeben.
alloy("getLibraryInfo")
.then(function(result) {
console.log(result.libraryInfo.version);
console.log(result.libraryInfo.commands);
console.log(result.libraryInfo.configs);
});
Einverständnis
Wenn ein Benutzer seine Zustimmung zu einem bestimmten Zweck nicht gegeben hat, wird das promise-Objekt dennoch aufgelöst. Das Antwortobjekt enthält jedoch nur die Informationen, die im Kontext dessen bereitgestellt werden können, was der Benutzer zugestimmt hat.