アップデート設定ファイルは XML ファイルです。このファイルには、次のエレメントを含めることができます。
-
updateURL
- String 値です。リモートサーバー上のアップデート記述ファイルの場所を表します。任意の有効な URLRequest の場所を指定できます。
updateURL
プロパティは、設定ファイルまたはスクリプトで定義する必要があります(
アップデート記述ファイルの定義と Web サーバーへの AIR ファイルの追加
を参照してください)。このプロパティは、Updater を使用する前(Updater オブジェクトの
initialize()
メソッドを呼び出す前。詳しくは、
アップデートフレームワークの初期化
を参照してください)に定義する必要があります。
-
delay
- Number 値です。アップデートをチェックする間隔(日数)を表します(
0.25
のような値を指定できます)。値 0(デフォルト値)は、Updater で定期的なチェックが自動的に行われないことを示します。
ApplicationUpdaterUI の設定ファイルには、
updateURL
エレメントと
delay
エレメントに加えて次のエレメントを含めることができます。
-
defaultUI
-
dialog
エレメントのリストです。各
dialog
エレメントには、ユーザーインターフェイスのダイアログボックスに対応する
name
属性があります。各
dialog
エレメントには、ダイアログボックスを表示するかどうかを定義する
visible
属性があります。デフォルト値は
true
です。
name
属性で使用できる値は次のとおりです。
-
checkForUpdate
- アップデートの有無をチェックダイアログボックス、アップデートなしダイアログボックスおよびアップデートエラーダイアログボックスに対応
-
downloadUpdate
- アップデートのダウンロードダイアログボックスに対応
-
downloadProgress
- ダウンロードの進捗状況ダイアログボックスとダウンロードエラーダイアログボックスに対応
-
installUpdate
- アップデートのインストールダイアログボックスに対応
-
fileUpdate
- ファイルのアップデートダイアログボックス、ファイルのアップデートなしダイアログボックスおよびファイルエラーダイアログボックスに対応
-
unexpectedError
- 予期しないエラーダイアログボックスに対応
false
に設定した場合、対応するダイアログボックスはアップデート時に表示されません。
次に ApplicationUpdater フレームワークの設定ファイルの例を示します。
<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns="http://ns.adobe.com/air/framework/update/configuration/1.0">
<url>http://example.com/updates/update.xml</url>
<delay>1</delay>
</configuration>
次に、
defaultUI
エレメントの定義を含む、ApplicationUpdaterUI フレームワークの設定ファイルの例を示します。
<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns="http://ns.adobe.com/air/framework/update/configuration/1.0">
<url>http://example.com/updates/update.xml</url>
<delay>1</delay>
<defaultUI>
<dialog name="checkForUpdate" visible="false" />
<dialog name="downloadUpdate" visible="false" />
<dialog name="downloadProgress" visible="false" />
</defaultUI>
</configuration>
configurationFile
プロパティでは、次に示すように設定ファイルの場所を指定します。
ActionScript の例:
appUpdater.configurationFile = new File("app:/cfg/updateConfig.xml");
JavaScript の例:
appUpdater.configurationFile = new air.File("app:/cfg/updateConfig.xml");
アップデートフレームワークの templates ディレクトリには、config-template.xml という名前のサンプルの設定ファイルがあります。