Interfejs API środowiska w przeglądarce — AIR.SWF

Oprócz korzystania z pliku badge.swf udostępnionego w SDK możliwe jest również utworzenie własnego pliku SWF do użytku na stronie przeglądarki. Niestandardowy plik SWF może wchodzić w interakcje ze środowiskiem wykonawczym na następujące sposoby:

• Może zainstalować aplikację AIR. Patrz Instalowanie aplikacji AIR z przeglądarki .

• Może sprawdzić, czy konkretna aplikacja AIR została zainstalowana. Patrz Sprawdzanie ze strony internetowej, czy aplikacja AIR została zainstalowana .

• Może sprawdzić, czy zainstalowane jest środowisko wykonawcze. Patrz Sprawdzanie, czy środowisko wykonawcze jest zainstalowane .

• Może uruchomić zainstalowaną aplikację AIR w systemie użytkownika. Patrz Uruchamianie zainstalowanej aplikacji AIR z przeglądarki .

Wszystkie te funkcje stają się dostępne po wywołaniu interfejsów API w pliku SWF, który znajduje się w witrynie adobe.com: air.swf. Istnieje możliwość dostosowania pliku badge.swf i wywoływania elementów interfejsu API pliku air.swf z własnego pliku SWF użytkownika.

Ponadto plik SWF działający w przeglądarce może komunikować się z działającą aplikacją AIR za pomocą klasy LocalConnection. Więcej informacji zawiera sekcja Komunikacja z innymi wystąpieniami programu Flash Player i środowiska AIR (dla programistów ActionScript) oraz sekcja Komunikacja z innymi wystąpieniami programu Flash Player i środowiska AIR (dla programistów HTML).

Pakiety AIR SDK i Flex SDK zawierają plik badge.swf, który umożliwia łatwe korzystanie z funkcji instalacji bezproblemowej. Plik badge.swf może zainstalować środowisko wykonawcze i aplikację AIR za pośrednictwem odsyłacza na stronie internetowej. Plik badge.swf oraz jego kod źródłowy są dostępne do dystrybucji na stronie internetowej.

Możliwe jest utworzenie własnego pliku SWF, który będzie korzystał z interfejsów API pliku air.swf w celu interakcji ze środowiskiem wykonawczym i aplikacjami AIR ze strony internetowej w przeglądarce. Plik air.swf jest dostępny na stronie http://airdownload.adobe.com/air/browserapi/air.swf. W celu utworzenia odwołania do interfejsów API air.swf z pliku SWF należy załadować plik air.swf do tej samej domeny aplikacji, co plik SWF. Poniższy kod stanowi przykład ładowania pliku air.swf do domeny aplikacji ładującego pliku SWF:

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; 
}

Po załadowaniu pliku air.swf (gdy obiekt contentLoaderInfo obiektu Loader wywoła zdarzenie init ) można wywołać dowolny element interfejsu API pliku air.swf, tak jak opisano to w następnych sekcjach.

Plik SWF może sprawdzić, czy środowisko wykonawcze jest zainstalowane — w tym celu należy wywołać metodę getStatus( ) w pliku air.swf załadowanym ze strony http://airdownload.adobe.com/air/browserapi/air.swf. Szczegółowe informacje zawiera sekcja Ładowanie pliku air.swf .

Po załadowaniu pliku air.swf plik SWF może wywołać metodę getStatus( ) pliku air.swf, jak w poniższym kodzie:

var status:String = airSWF.getStatus();

Metoda getStatus() zwraca jeden z następujących ciągów znaków w zależności od statusu środowiska wykonawczego na komputerze:

Metoda getStatus() generuje błąd, jeśli w przeglądarce nie jest zainstalowana wymagana wersja programu Flash Player (wersja 9 z aktualizacją 3 lub nowszą w systemach Windows i Mac OS albo wersja 10 w systemie Linux).

Plik SWF może sprawdzić, czy zainstalowana jest aplikacja AIR (ze zgodnym identyfikatorem aplikacji i wydawcy) — w tym celu musi wywołać metodę getApplicationVersion( ) w pliku air.swf załadowanym ze strony http://airdownload.adobe.com/air/browserapi/air.swf. Szczegółowe informacje zawiera sekcja Ładowanie pliku air.swf .

Po załadowaniu pliku air.swf plik SWF może wywołać metodę getApplicationVersion( ) pliku air.swf, jak w poniższym kodzie:

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. 
    } 
}

Metoda getApplicationVersion() ma następujące parametry:

Metoda getApplicationVersion() generuje błąd, jeśli w przeglądarce nie jest zainstalowana wymagana wersja programu Flash Player (wersja 9 z aktualizacją 3 lub nowszą w systemach Windows i Mac OS albo wersja 10 w systemie Linux).

Plik SWF może zainstalować aplikację AIR poprzez wywołanie metody installApplication( ) w pliku air.swf załadowanym ze strony http://airdownload.adobe.com/air/browserapi/air.swf . Szczegółowe informacje zawiera sekcja Ładowanie pliku air.swf .

Po załadowaniu pliku air.swf plik SWF może wywołać metodę installApplication( ) pliku air.swf, jak w poniższym kodzie:

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

Metoda installApplication() zainstaluje określoną aplikację na komputerze użytkownika. Ta metoda ma następujące parametry:

Metoda installApplication() może działać wyłącznie wówczas, gdy zostanie wywołana w module obsługi zdarzeń, np. w przypadku zdarzenia myszy.

Metoda installApplication() generuje błąd, jeśli w przeglądarce nie jest zainstalowana wymagana wersja programu Flash Player (wersja 9 z aktualizacją 3 lub nowszą w systemach Windows i Mac OS albo wersja 10 w systemie Linux).

W celu zainstalowania zaktualizowanej wersji aplikacji w systemie Mac OS użytkownik powinien mieć odpowiednie uprawnienia dostępu do instalowania w katalogu aplikacji (a także uprawnienia administracyjne, jeśli aplikacja aktualizuje środowisko wykonawcze). W systemie Windows użytkownik potrzebuje uprawnień administratora.

Możliwe jest również wywołanie metody getApplicationVersion() pliku air.swf w celu sprawdzenia, czy aplikacja jest już zainstalowana. Tę metodę można wywołać przed zainstalowaniem aplikacji lub po uruchomieniu instalowania. Szczegółowe informacje zawiera sekcja Sprawdzanie ze strony internetowej, czy aplikacja AIR została zainstalowana . Uruchomiona aplikacja może się komunikować z treścią pliku SWF w przeglądarce — w tym celu może korzystać z klasy LocalConnection. Więcej informacji zawiera sekcja Komunikacja z innymi instancjami Flash Player i AIR (dla programistów ActionScript) oraz sekcja Komunikacja z innymi instancjami Flash Player i AIR (dla programistów HTML).

W celu korzystania z trybu wywołania z przeglądarki (która umożliwia uruchomienie aplikacji z przeglądarki) plik deskryptora aplikacji docelowej musi zawierać następujące ustawienia:

<allowBrowserInvocation>true</allowBrowserInvocation>

Więcej informacji na temat pliku deskryptora aplikacji zawiera rozdział Pliki deskryptora aplikacji AIR .

Plik SWF w przeglądarce może uruchamiać aplikację AIR poprzez wywołanie metody launchApplication( ) w pliku air.swf załadowanym ze strony http://airdownload.adobe.com/air/browserapi/air.swf. Szczegółowe informacje zawiera sekcja Ładowanie pliku air.swf .

Po załadowaniu pliku air.swf plik SWF może wywołać metodę launchApplication( ) pliku air.swf, jak w poniższym kodzie:

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

Metoda launchApplication() jest zdefiniowana na najwyższym poziomie pliku air.swf (który jest załadowany do domeny aplikacji pliku SWF interfejsu użytkownika). Wywołanie tej metody sprawia, że środowisko AIR uruchamia określoną aplikację (jeśli jest zainstalowana i możliwe jest wywołanie przeglądarki, co definiuje ustawienie allowBrowserInvocation w pliku deskryptora aplikacji). Ta metoda ma następujące parametry:

Metoda launchApplication() może działać wyłącznie wówczas, gdy zostanie wywołana w module obsługi zdarzeń, np. w przypadku zdarzenia myszy.

Metoda launchApplication() generuje błąd, jeśli w przeglądarce nie jest zainstalowana wymagana wersja programu Flash Player (wersja 9 z aktualizacją 3 lub nowszą w systemach Windows i Mac OS albo wersja 10 w systemie Linux).

Jeśli dla elementu allowBrowserInvocation ustawiono wartość false w pliku deskryptora aplikacji, wywołanie metody launchApplication() nie przynosi żadnego skutku.

Przed wyświetleniem interfejsu użytkownika do uruchomienia aplikacji konieczne może być wywołanie metody getApplicationVersion( ) w pliku air.swf. Szczegółowe informacje zawiera sekcja Sprawdzanie ze strony internetowej, czy aplikacja AIR została zainstalowana .

Gdy aplikacja zostaje wywołana za pośrednictwem funkcji wywołania przeglądarki, wówczas obiekt NativeApplication aplikacji wywołuje obiekt BrowserInvokeEvent. Szczegółowe informacje zawiera sekcja Wywoływanie aplikacji AIR z przeglądarki (dla programistów ActionScript) oraz sekcja Wywoływanie aplikacji AIR z przeglądarki (dla programistów HTML).

Jeśli korzysta się z funkcji wywoływania z przeglądarki, należy uwzględnić kwestie zabezpieczeń. Te kwestie zostały opisane w sekcji Wywoływanie aplikacji AIR z przeglądarki (dla programistów ActionScript) oraz w sekcji Wywoływanie aplikacji AIR z przeglądarki (dla programistów HTML).

Uruchomiona aplikacja może się komunikować z treścią pliku SWF w przeglądarce — w tym celu może korzystać z klasy LocalConnection. Więcej informacji zawiera sekcja Komunikacja z innymi instancjami Flash Player i AIR (dla programistów ActionScript) oraz sekcja Komunikacja z innymi instancjami Flash Player i AIR (dla programistów HTML).