アップデート記述ファイルの定義と Web サーバーへの AIR ファイルの追加

AIR アップデートフレームワークを使用するときは、使用できるアップデートに関する基本情報を、Web サーバーに格納されるアップデート記述ファイルに定義します。アップデート記述ファイルは単純な XML ファイルです。アプリケーションに含まれているアップデートフレームワークは、このファイルをチェックして、新しいバージョンがアップロードされているかどうかを調べます。

アップデート記述ファイルの形式は、AIR 2.5 で変更されました。新しい形式では、別の名前空間が使用されます。元の名前空間は、「http://ns.adobe.com/air/framework/update/description/1.0」です。AIR 2.5 の名前空間は、「http://ns.adobe.com/air/framework/update/description/2.5」です。

AIR 2.5 より前に作成された AIR アプリケーションは、バージョン 1.0 アップデート記述子のみを読み取ることができます。AIR 2.5 以降に含まれるアップデータフレームワークを使用して作成された AIR アプリケーションは、バージョン 2.5 アップデート記述子のみを読み取ることができます。バージョンの互換性がないので、2 つのアップデート記述ファイルを作成することが必要になる場合があります。AIR 2.5 バージョンのアプリケーションのアップデートロジックは、新しい形式を使用するアップデート記述子をダウンロードする必要があります。以前のバージョンの AIR アプリケーションでは、元の形式を使用し続ける必要があります。どちらのファイルも、アップデートをリリースするたびに変更する必要があります(AIR 2.5 より前に作成されたバージョンのサポートを停止するまで)。

アップデート記述ファイルには次のデータが含まれます。

  • versionNumber version:新しいバージョンの AIR アプリケーションです。AIR 2.5 アプリケーションのアップデートに使用されるアップデート記述子の versionNumber エレメントを使用します。値は、新しい AIR アプリケーション記述ファイルの versionNumber エレメントで使用されるストリングと同じであることが必要です。アップデート記述ファイルのバージョン番号がアップデート AIR ファイルのバージョン番号と一致しない場合、アップデートフレームワークは例外をスローします。

  • version :AIR アプリケーションの新しいバージョンです。AIR 2.5 より前に作成されたアプリケーションのアップデートに使用されるアップデート記述子の version エレメントを使用します。値は、新しい AIR アプリケーション記述ファイルの version エレメントで使用されるストリングと同じであることが必要です。アップデート記述ファイルのバージョンがアップデート AIR ファイルのバージョンと一致しない場合、アップデートフレームワークは例外をスローします。

  • versionLabel :ユーザーに表示する、人が読めるバージョンストリングです。 versionLabel は省略可能ですが、バージョン 2.5 アップデート記述ファイルでのみ指定できます。アプリケーション記述子で versionLabel を使用し、同じ値に設定する場合にのみ使用します。

  • url :アップデート AIR ファイルの場所です。これは、アップデートバージョンの AIR アプリケーションが含まれるファイルです。

  • description :新しいバージョンに関する詳細です。この情報を、アップデートプロセスの間にユーザーに表示できます。

version エレメントと url エレメントは必須です。 description エレメントはオプションです。

次にバージョン 2.5 アップデート記述ファイルのサンプルを示します。

<?xml version="1.0" encoding="utf-8"?> 
     <update xmlns="http://ns.adobe.com/air/framework/update/description/2.5"> 
       <versionNumber>1.1.1</versionNumber> 
       <url>http://example.com/updates/sample_1.1.1.air</url> 
       <description>This is the latest version of the Sample application.</description> 
    </update>

次にバージョン 1.0 アップデート記述ファイルのサンプルを示します。

<?xml version="1.0" encoding="utf-8"?> 
     <update xmlns="http://ns.adobe.com/air/framework/update/description/1.0"> 
       <version>1.1.1</version> 
       <url>http://example.com/updates/sample_1.1.1.air</url> 
       <description>This is the latest version of the Sample application.</description> 
    </update>

複数の言語を使用して description タグを定義する必要がある場合は、複数の text エレメントを使用して lang 属性を定義します。

<?xml version="1.0" encoding="utf-8"?> 
     <update xmlns="http://ns.adobe.com/air/framework/update/description/2.5"> 
       <versionNumber>1.1.1</versionNumber> 
       <url>http://example.com/updates/sample_1.1.1.air</url> 
       <description> 
           <text xml:lang="en">English description</text> 
           <text xml:lang="fr">French description</text> 
           <text xml:lang="ro">Romanian description</text> 
       </description> 
    </update>

アップデート記述ファイルをアップデート AIR ファイルと共に Web サーバーに配置します。

アップデートフレームワークの templates ディレクトリには、サンプルのアップデート記述ファイルがあります。このサンプルには、単一言語と複数言語の両方のバージョンが含まれています。