AIR.SWF in-browser API

Zusätzlich zur mit dem SDK gelieferten badge.swf-Datei können Sie eine eigene SWF-Datei für die Verwendung auf Browserseiten erstellen. Diese benutzerdefinierte SWF-Datei kann wie folgt mit der Laufzeitumgebung interagieren:

• Sie kann eine AIR-Anwendung installieren. Weitere Informationen finden Sie unter Installieren von AIR-Anwendungen aus dem Browser .

• Sie kann überprüfen, ob eine bestimmte AIR-Anwendung installiert ist. Weitere Informationen finden Sie unter Prüfen auf installierte AIR-Anwendungen von einer Webseite aus .

• Sie kann überprüfen, ob die Laufzeitumgebung installiert ist. Weitere Informationen finden Sie unter Prüfen auf installierte Laufzeitumgebung .

• Sie kann eine auf dem System des Benutzers installierte AIR-Anwendung aufrufen. Weitere Informationen finden Sie unter Aufrufen installierter AIR-Anwendungen vom Browser .

Diese Möglichkeiten werden alle durch den Aufruf von APIs in einer SWF-Datei unter adobe.com: air.swf bereitgestellt. Sie können die Datei „badge.swf“ anpassen und die APIs in „air.swf“ von Ihrer eigenen SWF-Datei aus aufrufen.

Eine im Browser ausgeführte SWF-Datei kann außerdem über die LocalConnection-Klasse mit einer laufenden AIR-Anwendung kommunizieren. Weitere Informationen finden Sie unter Kommunikation mit anderen Flash Player- und AIR-Instanzen (für ActionScript-Entwickler) oder Communicating with other Flash Player and AIR instances (für HTML-Entwickler).

Das AIR-SDK und das Flex-SDK enthält eine badge.swf-Datei, mit der die nahtlose Installation einfach verwendet werden kann. Die badge.swf-Datei kann die Laufzeitumgebung und eine AIR-Anwendung von einem Link auf einer Webseite installieren. Die Datei „badge.swf“ und ihr Quellcode werden Ihnen für die Verteilung über Ihre Website zur Verfügung gestellt.

Sie können eine eigene SWF-Datei erstellen, die die APIs in einer air.swf-Datei verwendet, um mit der Laufzeitumgebung und AIR-Anwendungen einer Webseite in einem Browser zu interagieren. Die air.swf-Datei wird unter http://airdownload.adobe.com/air/browserapi/air.swf gehostet. Um von Ihrer SWF-Datei auf die air.swf-APIs zu verweisen, laden Sie die air.swf-Datei in dieselbe Anwendungsdomäne wie die SWF-Datei. Das folgende Beispiel zeigt einen Code für das Laden der air.swf-Datei in die Anwendungsdomäne der ladenden SWF-Datei:

var airSWF:Object; // This is the reference to the main class of air.swf 
var airSWFLoader:Loader = new Loader(); // Used to load the SWF 
var loaderContext:LoaderContext = new LoaderContext();  
                                // Used to set the application domain  
 
loaderContext.applicationDomain = ApplicationDomain.currentDomain; 
 
airSWFLoader.contentLoaderInfo.addEventListener(Event.INIT, onInit); 
airSWFLoader.load(new URLRequest("http://airdownload.adobe.com/air/browserapi/air.swf"),  
                    loaderContext); 
 
function onInit(e:Event):void  
{ 
    airSWF = e.target.content; 
}

Sobald die air.swf-Datei geladen ist (wenn das contentLoaderInfo -Objekt des Loader-Objekts das init -Ereignis auslöst), können Sie die air.swf-APIs aufrufen, die in den folgenden Abschnitten beschrieben werden.

Eine SWF-Datei kann prüfen, ob die Laufzeitumgebung installiert ist, indem sie die Methode getStatus( ) der von http://airdownload.adobe.com/air/browserapi/air.swf geladenen air.swf-Datei aufruft. Weitere Einzelheiten finden Sie unter Laden von air.swf-Dateien .

Nachdem die air.swf-Datei geladen wurde, kann die SWF-Datei die Methode getStatus( ) der air.swf-Datei wie folgt aufrufen:

var status:String = airSWF.getStatus();

Die Methode getStatus() gibt einen der folgenden, auf dem Status der Laufzeitumgebung auf dem Computer basierenden Stringwerte zurück:

Die getStatus() -Methode gibt einen Fehler aus, wenn die erforderliche Version von Flash Player (Version 9 Update 3 oder höher unter Windows und Mac OS bzw. Version 10 unter Linux) nicht im Browser installiert ist.

Eine SWF-Datei kann prüfen, ob eine AIR-Anwendung (mit übereinstimmender Anwendungs-ID und Herausgeber-ID) installiert ist, indem sie die Methode getApplicationVersion( ) der von http://airdownload.adobe.com/air/browserapi/air.swf geladenen air.swf-Datei aufruft. Weitere Einzelheiten finden Sie unter Laden von air.swf-Dateien .

Nachdem die air.swf-Datei geladen wurde, kann die SWF-Datei die Methode getApplicationVersion() der air.swf-Datei wie folgt aufrufen:

var appID:String = "com.example.air.myTestApplication"; 
var pubID:String = "02D88EEED35F84C264A183921344EEA353A629FD.1"; 
airSWF.getApplicationVersion(appID, pubID, versionDetectCallback); 
 
function versionDetectCallback(version:String):void 
{ 
    if (version == null) 
    { 
        trace("Not installed."); 
        // Take appropriate actions. For instance, present the user with 
        // an option to install the application. 
    } 
    else 
    { 
        trace("Version", version, "installed."); 
        // Take appropriate actions. For instance, enable the 
        // user interface to launch the application. 
    } 
}

Die getApplicationVersion() -Methode verfügt über die folgenden Parameter:

Die getApplicationVersion() -Methode gibt einen Fehler aus, wenn die erforderliche Version von Flash Player (Version 9 Update 3 oder höher unter Windows und Mac OS bzw. Version 10 unter Linux) nicht im Browser installiert ist.

Eine SWF-Datei kann eine AIR-Anwendung installieren, indem sie die Methode installApplication( ) der von http://airdownload.adobe.com/air/browserapi/air.swf geladenen air.swf-Datei aufruft. Weitere Einzelheiten finden Sie unter Laden von air.swf-Dateien .

Nachdem die air.swf-Datei geladen wurde, kann die SWF-Datei die Methode installApplication() der air.swf-Datei wie folgt aufrufen:

var url:String = "http://www.example.com/myApplication.air"; 
var runtimeVersion:String = "1.0"; 
var arguments:Array = ["launchFromBrowser"]; // Optional 
airSWF.installApplication(url, runtimeVersion, arguments); 

Die Methode installApplication() installiert die angegebene Anwendung auf dem Gerät des Benutzers. Die Methode hat die folgenden Parameter:

Die Methode installApplication() funktioniert nur, wenn sie in einer Ereignisprozedur für ein Benutzerereignis, zum Beispiel einen Mausklick, aufgerufen wurde.

Die installApplication() -Methode gibt einen Fehler aus, wenn die erforderliche Version von Flash Player (Version 9 Update 3 oder höher unter Windows und Mac OS bzw. Version 10 unter Linux) nicht im Browser installiert ist.

Um unter Mac OS eine aktualisierte Version einer Anwendung zu installieren, muss der Benutzer über die entsprechenden Berechtigungen für die Installation ins Anwendungsverzeichnis verfügen (sowie über Administratorberechtigungen, wenn die Anwendung die Laufzeitumgebung aktualisiert). Unter Windows muss der Benutzer über Administratorberechtigungen verfügen.

Sie können auch die Methode getApplicationVersion() der air.swf-Datei aufrufen, um zu überprüfen, ob bereits eine Anwendung installiert ist. Rufen Sie die Methode vor dem Installationsvorgang oder während der Installation auf. Weitere Informationen finden Sie unter Prüfen auf installierte AIR-Anwendungen von einer Webseite aus . Sobald die Anwendung läuft, kann sie über die LocalConnection-Klasse mit den SWF-Inhalten im Browser kommunizieren. Weitere Informationen finden Sie unter Kommunikation mit anderen Flash Player- und AIR-Instanzen (für ActionScript-Entwickler) oder Communicating with other Flash Player and AIR instances (für HTML-Entwickler).

Um die Browseraufruffunktion zu verwenden (die den Aufruf vom Browser aus ermöglicht), muss die Anwendungsdeskriptordatei der Zielanwendung die folgenden Einstellungen enthalten:

<allowBrowserInvocation>true</allowBrowserInvocation>

Weitere Informationen zur Anwendungsdeskriptordatei finden Sie unter AIR-Anwendungsdeskriptordateien .

Eine SWF-Datei im Browser kann eine AIR-Anwendung aufrufen, indem sie die Methode launchApplication() der von http://airdownload.adobe.com/air/browserapi/air.swf geladenen air.swf-Datei aufruft. Weitere Einzelheiten finden Sie unter Laden von air.swf-Dateien .

Nachdem die air.swf-Datei geladen wurde, kann die SWF-Datei die Methode launchApplication() der air.swf-Datei wie folgt aufrufen:

var appID:String = "com.example.air.myTestApplication"; 
var pubID:String = "02D88EEED35F84C264A183921344EEA353A629FD.1"; 
var arguments:Array = ["launchFromBrowser"]; // Optional 
airSWF.launchApplication(appID, pubID, arguments);

Die Methode launchApplication() wird auf der obersten Ebene der air.swf-Datei definiert (diese Datei wird in die Anwendungsdomäne der Benutzeroberflächen-SWF-Datei geladen). Beim Aufruf dieser Methode wird die angegebene Anwendung gestartet (wenn diese installiert ist und der Browseraufruf über die Einstellung allowBrowserInvocation in der Anwendungsdeskriptordatei gestattet wurde). Die Methode hat die folgenden Parameter:

Die Methode launchApplication() funktioniert nur, wenn sie in einer Ereignisprozedur für ein Benutzerereignis, zum Beispiel einen Mausklick, aufgerufen wurde.

Die launchApplication() -Methode gibt einen Fehler aus, wenn die erforderliche Version von Flash Player (Version 9 Update 3 oder höher unter Windows und Mac OS bzw. Version 10 unter Linux) nicht im Browser installiert ist.

Wenn das Element allowBrowserInvocation in der Anwendungsdeskriptordatei auf false gesetzt wurde, bleibt ein Aufruf der Methode launchApplication() wirkungslos.

Bevor Sie die Benutzeroberfläche für das Aufrufen der Anwendung einblenden, möchten Sie vielleicht die Methode getApplicationVersion( ) in der air.swf-Datei aufrufen. Weitere Informationen finden Sie unter Prüfen auf installierte AIR-Anwendungen von einer Webseite aus .

Wird die Anwendung über die Browseraufruffunktion aufgerufen, löst das Objekt NativeApplication der Anwendung ein BrowserInvokeEvent-Objekt aus. Weitere Informationen finden Sie unter Aufrufen von AIR-Anwendungen aus dem Browser (für ActionScript-Entwickler) oder Invoking an AIR application from the browser (für HTML-Entwickler).

Stellen Sie bei Verwendung der Browseraufrufsfunktion sicher, dass alle Sicherheitsüberlegungen beachtet wurden. Diese sind beschrieben unter Aufrufen von AIR-Anwendungen aus dem Browser (für ActionScript-Entwickler) und Invoking an AIR application from the browser (für HTML-Entwickler).

Sobald die Anwendung läuft, kann sie über die LocalConnection-Klasse mit den SWF-Inhalten im Browser kommunizieren. Weitere Informationen finden Sie unter Kommunikation mit anderen Flash Player- und AIR-Instanzen (für ActionScript-Entwickler) oder Communicating with other Flash Player and AIR instances (für HTML-Entwickler).