AIR.SWF ブラウザー API

SDK に付属している badge.swf ファイルの使用に加え、ブラウザーページで使用できる独自の SWF ファイルを作成できます。カスタム SWF ファイルは、次の方法でランタイムと対話できます。

• AIR アプリケーションをインストールできます。ブラウザーからの AIR アプリケーションのインストールを参照してください。

• 特定の AIR アプリケーションがインストールされているかどうかを確認できます。AIR アプリケーションがインストールされているかどうかの Web ページからの確認を参照してください。

• ランタイムがインストールされているかどうかを確認できます。ランタイムがインストールされているかどうかの確認を参照してください。

• ユーザーのシステムでインストール済みの AIR アプリケーションを起動できます。インストール済み AIR アプリケーションのブラウザーからの起動を参照してください。

これらの機能はすべて、adobe.com: air.swf にホストされている SWF ファイル内の API を呼び出して使用できます。badge.swf をカスタマイズして、独自の SWF ファイルから air.swf API を呼び出すことができます。

また、ブラウザーで実行中の SWF ファイルは、LocalConnection クラスを使用して実行されている AIR アプリケーションと通信できます。詳しくは、「Flash Player および AIR の他のインスタンスとの通信」（ActionScript 開発者用）、または「Flash Player および AIR の他のインスタンスとの通信」（HTML 開発者用）を参照してください。

AIR SDK および Flex SDK には、badge.swf ファイルが含まれています。このファイルを使用すると、シームレスインストール機能を簡単に使用できます。badge.swf では、ランタイムと AIR アプリケーションを Web ページのリンクからインストールできます。Web サイトに配布するための badge.swf ファイルとそのソースコードが提供されます。

air.swf ファイルの API を使用する独自の SWF ファイルを作成し、ブラウザー内の Web ページからランタイムおよび AIR アプリケーションを操作できます。air.swf ファイルは、http://airdownload.adobe.com/air/browserapi/air.swf にホストされています。SWF ファイルから air.swf API を参照するには、air.swf ファイルを SWF ファイルと同じアプリケーションドメインに読み込みます。次のコードは、読み込み中の SWF ファイルのアプリケーションドメインに air.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; 
}

air.swf ファイルが読み込まれたら（Loader オブジェクトの contentLoaderInfo オブジェクトが init イベントを送出した後）、以下の節で説明している air.swf API のいずれかを呼び出すことができます。

SWF ファイルでは、http://airdownload.adobe.com/air/browserapi/air.swf から読み込んだ air.swf ファイルで getStatus() メソッドを呼び出してランタイムがインストールされているかどうかを確認できます。詳しくは、air.swf ファイルの読み込みを参照してください。

air.swf ファイルが読み込まれると、SWF ファイルでは air.swf ファイルの getStatus() メソッドを呼び出すことができます。

var status:String = airSWF.getStatus();

getStatus() メソッドは、コンピューター上のランタイムのステータスに基づいて、次のストリング値のいずれか 1 つを返します。

getStatus() メソッドでは、必要なバージョンの Flash Player（Windows および Mac OS ではバージョン 9 アップデート 3 以降、Linux ではバージョン 10）がブラウザーにインストールされていない場合、エラーがスローされます。

SWF ファイルでは、http://airdownload.adobe.com/air/browserapi/air.swf から読み込んだ air.swf ファイルの getApplicationVersion() メソッドを呼び出して、AIR アプリケーション（対応するアプリケーション ID と発行者 ID を持つ）がインストールされているかどうかを確認できます。詳しくは、air.swf ファイルの読み込みを参照してください。

air.swf ファイルが読み込まれると、SWF ファイルでは air.swf ファイルの getApplicationVersion() メソッドを呼び出すことができます。

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

getApplicationVersion() メソッドには、次のパラメーターがあります。

getApplicationVersion() メソッドでは、必要なバージョンの Flash Player（Windows および Mac OS ではバージョン 9 アップデート 3 以降、Linux ではバージョン 10）がブラウザーにインストールされていない場合、エラーがスローされます。

SWF ファイルでは、http://airdownload.adobe.com/air/browserapi/air.swf から読み込んだ air.swf ファイルで installApplication() メソッドを呼び出して AIR アプリケーションをインストールできます。詳しくは、air.swf ファイルの読み込みを参照してください。

air.swf ファイルが読み込まれると、SWF ファイルでは、次のコードに示すように、air.swf ファイルの installApplication() メソッドを呼び出すことができます。

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

installApplication() メソッドは、指定されたアプリケーションをユーザーのマシンにインストールします。このメソッドのパラメーターは次のとおりです。

installApplication() メソッドは、マウスのクリックなどのユーザーイベントのイベントハンドラーで呼び出されたときにのみ動作できます。

installApplication() メソッドでは、必要なバージョンの Flash Player（Windows および Mac OS ではバージョン 9 アップデート 3 以降、Linux ではバージョン 10）がブラウザーにインストールされていない場合、エラーがスローされます。

Mac OS でアプリケーションのアップデートバージョンをインストールするには、アプリケーションディレクトリにインストールするための適切なシステム権限（アプリケーションでランタイムをアップデートする場合は管理権限も）が必要です。Windows では、管理権限が必要です。

また、air.swf ファイルの getApplicationVersion() メソッドを呼び出して、アプリケーションが既にインストールされているかどうかを確認することもできます。このメソッドは、アプリケーションのインストールプロセスの開始前、またはインストールの開始後に呼び出すことができます。詳しくは、AIR アプリケーションがインストールされているかどうかの Web ページからの確認を参照してください。実行中のアプリケーションは、LocalConnection クラスを使用してブラウザーで SWF コンテンツと通信できます。詳しくは、「Flash Player および AIR の他のインスタンスとの通信」（ActionScript 開発者用）、または「Flash Player および AIR の他のインスタンスとの通信」（HTML 開発者用）を参照してください。

ブラウザー呼び出し機能を使用するには（ブラウザーから起動できるようにするには）、対象アプリケーションのアプリケーション記述ファイルに次の設定を含める必要があります。

<allowBrowserInvocation>true</allowBrowserInvocation>

アプリケーション記述ファイルについて詳しくは、AIR アプリケーション記述ファイルを参照してください。

ブラウザーの SWF ファイルでは、http://airdownload.adobe.com/air/browserapi/air.swf から読み込んだ air.swf ファイルで launchApplication() メソッドを呼び出して AIR アプリケーションを起動できます。詳しくは、air.swf ファイルの読み込みを参照してください。

air.swf ファイルが読み込まれると、SWF ファイルでは、次のコードに示すように、air.swf ファイルの launchApplication() メソッドを呼び出すことができます。

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

launchApplication() メソッドは、air.swf ファイルのトップレベルで定義されます（ユーザーインターフェイス SWF ファイルのアプリケーションドメインに読み込まれます）。このメソッドを呼び出すと、AIR で指定されたアプリケーションが起動します（アプリケーションがインストール済みで、アプリケーション記述ファイルの allowBrowserInvocation 設定でブラウザー呼び出しが許可されている場合）。このメソッドのパラメーターは次のとおりです。

launchApplication() メソッドは、マウスのクリックなどのユーザーイベントのイベントハンドラーで呼び出されたときにのみ動作できます。

launchApplication() メソッドでは、必要なバージョンの Flash Player（Windows および Mac OS ではバージョン 9 アップデート 3 以降、Linux ではバージョン 10）がブラウザーにインストールされていない場合、エラーがスローされます。

アプリケーション記述ファイルで allowBrowserInvocation エレメントが false に設定されている場合、launchApplication() メソッドを呼び出してもアプリケーションは起動されません。

アプリケーションを起動するためのユーザーインターフェイスを示す前に、air.swf ファイルで getApplicationVersion() メソッドを呼び出す必要があります。詳しくは、AIR アプリケーションがインストールされているかどうかの Web ページからの確認を参照してください。

ブラウザー呼び出し機能によりアプリケーションが呼び出されると、アプリケーションの NativeApplication オブジェクトは BrowserInvokeEvent オブジェクトを送出します。詳しくは、「ブラウザーからの AIR アプリケーションの呼び出し」（ActionScript 開発者用）または「ブラウザーからの AIR アプリケーションの呼び出し」（HTML 開発者用）を参照してください。

ブラウザー呼び出し機能を使用する場合は、セキュリティ上の影響を考慮してください。セキュリティ上の影響については、「ブラウザーからの AIR アプリケーションの呼び出し」（ActionScript 開発者用）および「ブラウザーからの AIR アプリケーションの呼び出し」（HTML 開発者用）で説明しています。

実行中のアプリケーションは、LocalConnection クラスを使用してブラウザーで SWF コンテンツと通信できます。詳しくは、「Flash Player および AIR の他のインスタンスとの通信」（ActionScript 開発者用）、または「Flash Player および AIR の他のインスタンスとの通信」（HTML 開発者用）を参照してください。