ApplicationUpdater  - AS3

delay プロパティと updateURL プロパティの値を設定する設定ファイルの場所。このプロパティで指定したファイルが存在しない場合は、initialize() メソッドを呼び出すと Error がスローされます。

設定ファイルのサンプルを次に示します。

 <?xml version="1.0" encoding="utf-8"?> 
         <configuration xmlns="http://ns.adobe.com/air/framework/update/configuration/1.0" >
           <url>app:/server/update.xml</url>
           <delay>1</delay>
        </configuration>

設定ファイルをロードする代わりに、ActionScript コードを使用して、delay プロパティと updateURL プロパティを設定できます。

関連する API エレメント

Updater の内部状態。プロパティは、次の値に設定できます。

• "UNINITIALIZED" — Updater は初期化されていません。

• "INITIALIZING" — Updater は初期化中です。

• "READY" — Updater は初期化が済んでいます。

• "BEFORE_CHECKING" — Updater はまだ更新記述ファイルを検査していません。

• "CHECKING" — Updater は更新記述ファイルを検査しています。

• "AVAILABLE" — 更新記述ファイルは使用できます。

• "DOWNLOADING" — Updater は AIR ファイルをダウンロードしています。

• "DOWNLOADED" — Updater は AIR ファイルをダウンロードしました。

• "INSTALLING" — Updater は AIR ファイルをインストールしています。

• "PENDING_INSTALLING" — Updater は初期化を終了し、保留状態の更新があります。

アプリケーションの現在のバージョン。このプロパティは、initialize() メソッドの呼び出し時に設定されます。これは、アプリケーション記述ファイルのバージョンに設定されます。

新しい更新の周期的チェックの間隔（日数単位）。

値が 0 （デフォルト値）の場合、タイマーがアクティブでないことを示し、周期的なチェックは実行されません。この値は、このプロパティまたは設定ファイルを使用して設定できます。両方の方法を使用して値を設定すると、プロパティを使用して設定した値が使用されます。

デフォルト値： 0。

正常な更新後の最初の実行の場合は true を返し、それ以外の場合は false を返します。Updater は、initialize() メソッドの呼び出し時にこの値を設定します。あるバージョンから別のバージョンにデータを移行する必要がある場合、開発者は isFirstRun が true に設定されているかどうかを検査する必要があります。

関連する API エレメント

Updater がバージョン比較を実行するために使用する必要がある関数。デフォルトでは、更新フレームワークがバージョンの比較を行って、リモートサイトからのバージョンがインストールされているアプリケーションのバージョンより新しいかどうかを判定します。ただし、デフォルトの比較が開発者のバージョン管理方式と一致しない場合があります。このプロパティを設定して、比較を行う新しい関数を提供します。

デフォルトの比較関数は、x.y.z のようなバージョンを受け付けます。x、y、z は文字または数字です。デフォルトの比較関数によって認識される特殊な条件が存在します。テスト関数では、バージョン文字列内に "alpha"、"beta"、または "rc" を検出した場合、alpha < beta < rc の順でバージョンが大きくなるものと見なします。

appUpdate.isNewerVersionFunction = customFn; 

function customFn (currentVersion:String, updateVersion:String):Boolean 
{
    return updateVersion > currentVersion;
}

アプリケーション記憶領域ディレクトリの前の場所（更新後に変更されている場合）。アプリケーション記憶領域ディレクトリの場所は、証明書の移行を伴うアップグレード後に変更されます。証明書の移行がない場合は、ユーザーがアプリケーションを更新してもアプリケーション記憶領域ディレクトリは変更されません。このプロパティは null に設定されます。このプロパティは、initialize() メソッドの呼び出し時に設定されます。

AIR ファイルを ADT とパッケージ化するときに開発者が -migrate オプションを使用する場合、AIR アプリケーションの新しいバージョンに新しい証明書で署名できます。AIR アプリケーションの新しいバージョンが新しい署名の証明書を使用する場合、ユーザーが新しいバージョンをインストールすると、アプリケーションのローカルの記憶領域ディレクトリが変更されます。古いアプリケーション記憶領域ディレクトリから新しいアプリケーション記憶領域ディレクトリにデータを転送する場合は、このプロパティを使用します（File.applicationStorageDirectory）。詳細については、Adobe AIR 開発者ガイドの「コマンドラインツールを使用した AIR アプリケーションの作成」の章の「アプリケーション証明書を変更するための AIR ファイルへの署名」を参照してください。

アプリケーションの前のバージョン。このプロパティは、initialize() メソッドの呼び出し時に設定されます。アプリケーションの、アップグレードする前のバージョンを返します。isfirstRun が true の場合にのみ設定され、それ以外の場合は null に設定されます。

更新 URL からダウンロードされた更新記述ファイルのコンテンツ。Updater オブジェクトが updateStatus イベントを送出するときにのみ、このプロパティは null 以外の値になります。

更新記述ファイルの場所。URLRequest のパスとして有効な任意の場所が受け付けられます。Updater に必要な必須の設定はこれだけです。更新 URL は、このプロパティまたは設定ファイルを使用して設定できます。両方の方法を使用して値を設定すると、Updater はこのプロパティを使用して設定した値を使用します。

インストールが失敗したかどうかに関係なく、延期された更新があった場合は true を返します。それ以外の場合は false を返します。Updater は、initialize() メソッドの呼び出し時にこのプロパティを設定します。更新のインストールに失敗したかどうかを確認するには、wasPendingUpdate プロパティおよび isFirstRun プロパティを使用します（失敗した場合は wasPendingUpdate が true に、isFirstRun が false に設定されます）。

関連する API エレメント

コンストラクター関数です。

更新処理をキャンセルします。このメソッドを呼び出すと、保留状態のダウンロードがキャンセルされ、完全にダウンロードされていないファイルが削除され、周期的なチェックタイマーが再起動されます。

更新処理は、状態マシンが「UNINITIALIZED」または「INITIALIZING」状態のときを除き、いつでもキャンセルできます。「UNINITIALIZED」または「INITIALIZING」状態のときに更新処理をキャンセルしても、何も行われません。

更新記述ファイルを非同期にダウンロードして解釈します。このメソッドを呼び出すと、更新状態は「CHECKING」に移行します。このメソッドは、checkForUpdate イベントをキャンセルした場合にのみ呼び出してください。

このメソッドは、Updater が「BEFORE_CHECKING」状態の場合にのみ動作します。

更新処理を開始します。このメソッドを呼び出しても、周期的なタイマーはキャンセルされません。ただし、実行中の更新処理を検出し、現在の反復をスキップします。

このメソッドは、現在の状態が「READY」の場合にのみ動作します。

このメソッドを呼び出すと、Updater オブジェクトが次のイベントを送出する場合があります。

更新ファイルを非同期にダウンロードします。このメソッドを呼び出すと、状態マシンは「DOWNLOADING」に移行します。このメソッドは、イベントの available プロパティが true のときに StatusUpdateEvent.UPDATE_STATUS イベントをキャンセルした場合にのみ、呼び出す必要があります。

このメソッドは、現在の状態が「AVAILABLE」の場合にのみ動作します。

Updater を初期化します。このメソッドを呼び出すと、次のことが行われます。

1. 更新フレームワークが初期化され、保留されているすべての更新がサイレントで（かつ同期的に）インストールされます。このメソッドは、アプリケーションを再起動する場合があるので、アプリケーションの起動時に呼び出す必要があります。

2. 延期されている更新があるかどうかをチェックし、ある場合はインストールします。

3. 前の更新がうまくいかなかった場合は、更新ファイルとバージョン情報を記憶域からクリアします。

4. 周期的なタイマーの遅延時間が経過した場合は、更新処理を開始します。それ以外の場合は、周期的なタイマーを開始します。ただし、AIR Debug Launcher（ADL）アプリケーションを使用してアプリケーションをテストしている場合は、アプリケーションの更新を試みると IllegalOperationError 例外が発生します。

ローカル AIR ファイルを使用して Update プロセスを開始します。

更新処理が実行中の場合（状態が「DOWNLOADED」でない場合）は、このメソッドを呼び出しても何も行われません。

この機能は、アプリケーション記述ファイルで customUpdateUI 要素が true に設定されているアプリケーションに対して役に立ちます。

AIR Debug Launcher（ADL）アプリケーションを使用してアプリケーションをテストしているときに、このメソッドを呼び出すと、IllegalOperationError 例外が発生します。

パラメーター

更新ファイルをインストールします。このメソッドを呼び出すと状態マシンは「INSTALLING」に進みます。このメソッドは、downLoadComplete イベントをキャンセルした場合にのみ呼び出す必要があります。

このメソッドは、Updater が「DOWNLOADED」状態のときに呼び出します。他の状態で呼び出しても何も行いません。

AIR Debug Launcher（ADL）アプリケーションを使用してアプリケーションをテストしているときに、このメソッドを呼び出すと、IllegalOperationError 例外が発生します。

更新をインストールする直前で、installUpdate() メソッドを呼び出した後に送出されます。更新をインストールするためにランタイムがアプリケーションを終了するとユーザーが行っている現在の作業が失われることがあるので、このイベントの時点で更新のインストールを中止すると便利な場合があります。

このイベントの preventDefault() メソッドを呼び出すと、インストールは次の再起動まで延期されます。preventDefault() メソッドを呼び出すと、このアプリケーションのセッションの間は（installUpdate() メソッドの呼び出しまたは周期的なチェックによる）追加の更新処理が開始されません。

ApplicationUpdater ライブラリのデフォルトの動作では、更新記述ファイルがダウンロードされます。preventDefault() メソッドを呼び出して、この動作をキャンセルできます。

このイベントには、次のプロパティがあります。

更新処理が始まる前、Updater が更新記述ファイルをダウンロードする直前に送出されます。Updater は、checkNow() メソッドの直接呼び出しの結果として、または周期的なチェックタイマーが時間切れになった場合に、このイベントを送出できます。

このイベントには、次のプロパティがあります。

更新ファイルのダウンロードが完了すると送出されます。

通常、このイベントは、更新のインストールを続けるかどうかをユーザーに確認するメッセージの表示に使用されます。

ApplicationUpdater ライブラリのデフォルトの動作では、installUpdate() メソッドが自動的に呼び出されます。

このイベントには、次のプロパティがあります。

接続中または更新ファイルのダウンロード中にエラーが発生した場合に送出されます。無効な HTTP ステータス（404 - File not found など）に対しても送出されます。

このイベントが送出されると、周期的なタイマーは自動的に再起動されます（遅延が 0 より大きい場合）。

DownloadErrorEvent オブジェクトの errorID プロパティは、エラー情報を定義する整数です（次の表を参照）。追加の subErrorID プロパティに、さらにエラー情報が含まれる場合があります。

downloadUpdate() メソッドが呼び出されてサーバーへの接続が確立された後で送出されます。ApplicationUpdater ライブラリを使用しているときは、このイベントのイベントハンドラーを使用して、ダウンロードの進捗をユーザーに示すプログレスバーを表示できます。

このイベントには、次のプロパティがあります。

初期化中または更新処理中にエラーが発生した場合（何か予期しないことが発生した場合）に送出されます。

このイベントには、次のプロパティがあります。

airFile パラメーター（installFromAIRFile() メソッドの呼び出し）として渡されたファイルの検証でエラーが発生した場合に送出されます。

installFromAIRFile() メソッドの呼び出しで Updater がファイルの検証に成功した後に送出されます。

このイベントには、次のプロパティがあります。

初期化が完了した後に送出されます。

このイベントには、次のプロパティがあります。

更新ファイルのダウンロード時に送出されます。

このイベントには、次のプロパティがあります。

更新記述ファイルをダウンロードまたは解析しようとしてエラーが発生した場合に送出されます。

Updater がこのイベントを送出すると、周期的なタイマーは自動的に再起動されます（遅延の設定が 0 より大きい場合）。Updater が新しい checkForUpdate イベントを送出した場合、アプリケーションではすべてのエラーダイアログボックスを非表示にすることを検討する必要があります。

Updater が更新記述ファイルを正常にダウンロードして解釈した後で送出されます。

StatusUpdateEvent オブジェクトの available プロパティが true に設定されている場合、デフォルトの動作では更新のダウンロードが開始されます。ApplicationUpdater クラスを使用している場合にのみ、デフォルトの動作を実行しないようにできます。ApplicationUpdatorUI クラスの使用中は、デフォルトの動作を防ぐことができません。

このイベントには、次のプロパティがあります。