Konstanten, Funktionen und Ereignisse für eingebettete Amazon AppStream 2.0-Streaming-Sitzungen - Amazon AppStream 2.0
Arbeiten mit HIDDEN_ELEMENTSFunktionen für das AppStream.Embed-ObjektEreignisse für Embedded AppStream 2.0-Streaming-SitzungenBeispiele für das Hinzufügen von Event-Listenern und das Beenden einer Embedded AppStream 2.0-Streaming-Sitzung

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Konstanten, Funktionen und Ereignisse für eingebettete Amazon AppStream 2.0-Streaming-Sitzungen

Die folgenden Themen enthalten Referenzinformationen für Konstanten, Funktionen und Ereignisse, die Sie zur Konfiguration von Embedded AppStream 2.0-Streaming-Sitzungen verwenden können.

Die folgenden AppStream 2.0-Benutzeroberflächenelemente können an die HIDDEN_ELEMENTS Konfigurationsoption übergeben werden, wenn eine Embedded AppStream 2.0-Streaming-Sitzung initialisiert wird.

Arbeiten mit HIDDEN_ELEMENTS

Die folgenden AppStream 2.0-Benutzeroberflächenelemente können als Konstanten an die HIDDEN_ELEMENTS Konfigurationsoption übergeben werden, wenn eine eingebettete AppStream 2.0-Streaming-Sitzung initialisiert wird. 

AppStream.Embed.Elements.TOOLBAR
AppStream.Embed.Elements.FULLSCREEN_BUTTON
AppStream.Embed.Elements.END_SESSION_BUTTON
AppStream.Embed.Elements.TOOLBAR
AppStream.Embed.Elements.CATALOG_BUTTON
AppStream.Embed.Elements.WINDOW_SWITCHER_BUTTON
AppStream.Embed.Elements.FILES_BUTTON
AppStream.Embed.Elements.CLIPBOARD_BUTTON
AppStream.Embed.Elements.COPY_LOCAL_BUTTON
AppStream.Embed.Elements.PASTE_REMOTE_BUTTON
AppStream.Embed.Elements.SETTINGS_BUTTON
AppStream.Embed.Elements.STREAMING_MODE_BUTTON
AppStream.Embed.Elements.SCREEN_RESOLUTION_BUTTON
AppStream.Embed.Elements.REGIONAL_SETTINGS_BUTTON
AppStream.Embed.Elements.FULLSCREEN_BUTTON
AppStream.Embed.Elements.END_SESSION_BUTTON

Die folgenden drei Elemente können nicht als KonstantenELEMENTS, sondern als Zeichenketten an HIDDEN _ übergeben werden.

String Beschreibung
'adminCommandsButton' Wenn Sie mit einem AppStream 2.0-Image Builder verbunden sind, wird die Schaltfläche „Admin-Befehle“ in der oberen rechten Ecke der AppStream 2.0-Symbolleiste angezeigt. Wenn diese Zeichenfolge an HIDDEN_ELEMENTS übergeben wird, wird die Schaltfläche Admin Commands (Admin-Befehle) ausgeblendet.
'softKeyboardButton' Während AppStream 2.0-Streaming-Sitzungen auf berührungsfähigen Geräten können Benutzer auf das Tastatursymbol in der AppStream 2.0-Symbolleiste tippen, um die Bildschirmtastatur anzuzeigen. Wenn Sie diese Zeichenfolge HIDDEN_ELEMENTS übergeben, wird das Tastatursymbol ausgeblendet.
'keyboardShortcutsButton' Während AppStream 2.0-Streaming-Sitzungen auf berührungsfähigen Geräten können Benutzer auf das Fn-Symbol in der AppStream 2.0-Symbolleiste tippen, um Tastenkombinationen anzuzeigen. Wenn Sie diese Zeichenfolge HIDDEN_ELEMENTS übergeben, wird das Fn-Symbol ausgeblendet.

Funktionen für das AppStream.Embed-Objekt

In der folgenden Tabelle sind die Funktionen aufgeführt, die für das Objekt AppStream.Embed ausgeführt werden können.

Funktion Beschreibung
AppStream.Embed(containerId:string, options:object) Der AppStream.Embed-Objektkonstruktor. Dieser Konstruktor initialisiert das Objekt AppStream.Embed und kommuniziert mit ihm und verwendet eine div-Container-ID. Die ID wird zum Einfügen des iframe verwendet. Außerdem wird ein Objekt eingefügt, das die Konfigurationsoptionen für (appstreamOptionssessionURL undHIDDEN_ELEMENTS).
endSession() Diese Funktion beendet die Streaming-Sitzung, zerstört aber nicht den iframe. Wenn Sie eine Weiterleitung angebenURL, versucht der Iframe, die URL zu laden. Abhängig von den CORS Headern der Seite wird der URL möglicherweise nicht geladen.
launchApp(appId:string) Diese Funktion startet programmgesteuert eine Anwendung mit der Anwendungs-ID, die während der Erstellung des Abbildes angegeben wurde.
launchAppSwitcher() Diese Funktion sendet den AppSwitcher Befehl an das AppStream 2.0-Portal. Dies löst den Befehl AppSwitcher für die Instance aus.
getSessionState() Diese Funktion gibt ein Objekt für sessionStatus zurück. Weitere Informationen finden Sie unter Ereignisse für Embedded AppStream 2.0-Streaming-Sitzungen.
getUserInterfaceState()

Diese Funktion gibt ein Objekt für UserInterfaceState zurück. Das Objekt enthält die Schlüssel-Wert-Paare für Folgendes:

sessionStatus: Status-Aufzählung

sessionTerminationReason: Zeichenfolge

sessionDisconnectionReason: Zeichenfolge

Weitere Informationen finden Sie unter Ereignisse für Embedded AppStream 2.0-Streaming-Sitzungen.
addEventListener(name, callback) Diese Funktion fügt eine Callback-Funktion hinzu, die aufzurufen ist, wenn das angegebene Ereignis ausgelöst wird. Eine Liste der Ereignisse, die ausgelöst werden können, finden Sie unter Ereignisse für Embedded AppStream 2.0-Streaming-Sitzungen.
removeEventListener(name, callback) Diese Funktion entfernt den Rückruf für die angegebenen Ereignisse.
destroy() Diese Funktion löscht den iframe und bereinigt Ressourcen. Diese Funktion hat keine Auswirkungen auf Streaming-Sitzungen, die gerade ausgeführt werden.

Ereignisse für Embedded AppStream 2.0-Streaming-Sitzungen

In der folgenden Tabelle sind die Ereignisse aufgeführt, die während Embedded AppStream 2.0-Streaming-Sitzungen ausgelöst werden können.

Ereignis Daten Beschreibung
AppStream.Embed.Events.SESSION_STATE_CHANGE

sessionStatus: State enumeration

sessionTerminationReason: Zeichenfolge

sessionDisconnectionReason: Zeichenfolge

Dieses Ereignis wird ausgelöst, wenn eine Änderung des Sitzungsstatus auftritt. Das Ereignis enthält eine Karte der geänderten Zustände. Verwenden Sie die Funktion getSessionState(), um den vollständigen Sitzungsstatus abzurufen.

Nachstehend folgen die Sitzungsstatus:

AppStream.Embed.SessionStatus.Unknown – Die Sitzung hat noch nicht begonnen und ist nicht reserviert.

AppStream.Embed.SessionStatus.Reserved – Die Sitzung ist reserviert, hat aber noch nicht begonnen.

AppStream.Embed.SessionStatus.Started – Der Benutzer hat sich mit der Sitzung verbunden und mit dem Streaming begonnen.

AppStream.Embed.SessionStatus Disconnected  – Der Benutzer hat die Verbindung zur Sitzung getrennt.

AppStream.Embed.SessionStatus.Ended – Die Sitzung wurde als beendet oder abgelaufen markiert.
AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE

hiddenElements: Zeichenfolgen-Array

isFullscreen: Boolesch

isSoftKeyboardVisible: Boolesch

 Dieses Ereignis wird ausgelöst, wenn eine Änderung des Sitzungsstatus auftritt. Das Ereignis enthält eine Karte der geänderten Zustände. Verwenden Sie die Funktion getSessionState(), um den vollständigen Sitzungsstatus abzurufen.
AppStream.Embed.Events.SESSION_ERROR

errorCode: Nummer

errorMessage: Zeichenfolge

 Dieses Ereignis wird ausgelöst, wenn während einer Sitzung Fehler auftreten.

Beispiele für das Hinzufügen von Event-Listenern und das Beenden einer Embedded AppStream 2.0-Streaming-Sitzung

In den Beispielen in diesem Abschnitt wird gezeigt, wie Sie Folgendes tun können:

  • Fügen Sie Ereignis-Listener für eingebettete AppStream 2.0-Streaming-Sitzungen hinzu.

  • Beenden Sie programmgesteuert eine eingebettete AppStream 2.0-Streaming-Sitzung.

Beispiel 1: Fügen Sie Ereignis-Listener für eingebettete AppStream 2.0-Streaming-Sitzungen hinzu

Verwenden Sie den folgenden Code, um Ereignis-Listener für Sitzungsstatusänderungen, Sitzungsschnittstellenstatusänderungen und Sitzungsfehler während eingebetteter Streaming-Sitzungen hinzuzufügen:

appstreamEmbed.addEventListener(AppStream.Embed.Events.SESSION_STATE_CHANGE, updateSessionStateCallback);

appstreamEmbed.addEventListener(AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE, updateUserInterfaceStateCallback);

appstreamEmbed.addEventListener(AppStream.Embed.Events.SESSION_ERROR, errorCallback);

In diesem Beispiel sind AppStream.Embed.Events.SESSION_STATE_CHANGE, AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE und AppStream.Embed.Events.SESSION_ERROR Ereignisnamen.

Die Funktionen updateSessionStateCallback, updateUserInterfaceStateCallback und errorCallback sind diejenigen, die Sie implementieren. Diese Funktionen werden in die Funktion addEventListener übergeben und aufgerufen, wenn ein Ereignis ausgelöst wird.

Beispiel 2: Programmgesteuertes Beenden einer eingebetteten AppStream 2.0-Streaming-Sitzung

Verwenden Sie die folgende Funktion, um eine eingebettete AppStream 2.0-Streaming-Sitzung zu beenden:

appstreamEmbed.endSession();