| パッケージ | air.update |
| クラス | public class ApplicationUpdater |
| 継承 | ApplicationUpdater EventDispatcher Object |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
このクラスは、Adobe ® Flex™ SDK に含まれる applicationupdater_ui.swc ファイルに含まれています。
アプリケーションの更新の管理は複雑な場合があります。AIR 更新フレームワークでは、開発者が AIR アプリケーションで適切な更新機能を提供できるように支援する API が用意されています。AIR 更新フレームワークの機能が開発者の役に立つのは、次のような場合です。
一定の間隔に基づいて、またはユーザーの要求時に更新を定期的にチェックするとき
Web ソースから AIR ファイル(更新)をダウンロードするとき
新しくインストールされたバージョンを初めて実行する際にユーザーに警告するとき
ユーザーが更新をチェックするかどうかを確認するとき
新しい更新バージョンに関する情報をユーザーに表示するとき
ダウンロードの進行状況とエラー情報をユーザーに表示するとき
AIR 更新フレームワークを使用すると、単純な XML 設定ファイルに AIR アプリケーションの更新バージョンに関する情報を保存できます。ほとんどのアプリケーションでは、これらの設定ファイルを設定して基本コードを含めると、エンドユーザーに適切な更新機能が提供されます。
AIR 更新フレームワークで使用する独自のユーザーインターフェイスを定義する場合は、AIRUpdater クラスを使用します。
更新処理には連続する状態が含まれます。Updater オブジェクトの currentState プロパティは、Updater の現在の状態を反映します。
| currentState 値 | 説明 |
|---|---|
| UNINITIALIZED | Updater は初期化されていません。 |
| INITIALIZING | Updater は初期化中です。 |
| READY | Updater は初期化が済んでいます。 |
| BEFORE_CHECKING | Updater はまだ更新記述ファイルを検査していません。 |
| CHECKING | Updater は更新記述ファイルを検査しています。 |
| AVAILABLE | 更新記述ファイルは使用できます。 |
| DOWNLOADING | Updater は AIR ファイルをダウンロードしています。 |
| DOWNLOADED | Updater は AIR ファイルをダウンロードしました。 |
| INSTALLING | Updater は AIR ファイルをインストールしています。 |
| PENDING_INSTALLING | Updater は初期化を終了し、保留状態の更新があります。 |
AIR 更新フレームワークの使用について詳しくは、『Adobe Flash での Adobe AIR アプリケーションの開発』の「AIR アプリケーションのアップデート」の章を参照してください。
関連項目
| プロパティ | 定義元 | ||
|---|---|---|---|
delay プロパティと updateURL プロパティの値を設定する設定ファイルの場所。 | ApplicationUpdater | ||
![]() | constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。 | Object | |
[読み取り専用] Updater の内部状態です。 | ApplicationUpdater | ||
[読み取り専用] アプリケーションの現在のバージョンです。 | ApplicationUpdater | ||
新しい更新を周期的にチェックする間隔(日)。 | ApplicationUpdater | ||
[読み取り専用] これが正常な更新の後で最初の実行(true)か、それ以外(false)かを指定します。 | ApplicationUpdater | ||
バージョン比較を実行するために Updater が使用する必要がある関数です。 | ApplicationUpdater | ||
[読み取り専用] アプリケーションの記憶領域ディレクトリの以前の場所です(更新後に変更された場合)。 | ApplicationUpdater | ||
[読み取り専用] アプリケーションの前のバージョンです。 | ApplicationUpdater | ||
![]() | prototype : Object [静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。 | Object | |
[読み取り専用] 更新 URL からダウンロードされた更新記述ファイルの内容です。 | ApplicationUpdater | ||
更新記述ファイルの場所。 | ApplicationUpdater | ||
[読み取り専用] インストールが失敗した(true)かどうかに関係なく、延期された更新があったかどうかを指定します。それ以外の場合は false を指定します。 | ApplicationUpdater | ||
| メソッド | 定義元 | ||
|---|---|---|---|
コンストラクタ関数です。 | ApplicationUpdater | ||
![]() | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | EventDispatcher | |
更新処理をキャンセルします。 | ApplicationUpdater | ||
更新記述ファイルを非同期にダウンロードして解釈します。 | ApplicationUpdater | ||
更新処理を開始します。 | ApplicationUpdater | ||
![]() | イベントをイベントフローに送出します。 | EventDispatcher | |
更新ファイルを非同期にダウンロードします。 | ApplicationUpdater | ||
![]() | EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | |
![]() | オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
Updater を初期化します。 | ApplicationUpdater | ||
ローカル AIR ファイルを使用して Update プロセスを開始します。 | ApplicationUpdater | ||
更新ファイルをインストールします。 | ApplicationUpdater | ||
![]() | Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
![]() | 指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
![]() | EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | |
![]() | ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
![]() | 指定されたオブジェクトのストリング表現を返します。 | Object | |
![]() | 指定されたオブジェクトのプリミティブな値を返します。 | Object | |
![]() | 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher | |
| イベント | 概要 | 定義元 | ||
|---|---|---|---|---|
![]() | 「ブロードキャスト イベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。 | EventDispatcher | ||
| 更新をインストールする直前で、installUpdate() メソッドを呼び出した後に送出されます。 | ApplicationUpdater | |||
| 更新処理が開始される前、Updater が更新記述ファイルをダウンロードしようとする直前に送出されます。 | ApplicationUpdater | |||
![]() | 「ブロードキャストイベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。 | EventDispatcher | ||
| 更新ファイルのダウンロードが完了すると送出されます。 | ApplicationUpdater | |||
| 接続中または更新ファイルのダウンロード中にエラーが発生した場合に送出されます。 | ApplicationUpdater | |||
| downloadUpdate() メソッドが呼び出されてサーバーへの接続が確立された後で送出されます。 | ApplicationUpdater | |||
| 初期化中または更新処理中にエラーが発生した場合(何か予期しないことが発生した場合)に送出されます。 | ApplicationUpdater | |||
| airFile パラメータ(installFromAIRFile() メソッドの呼び出し)として渡されたファイルの検証でエラーが発生した場合に送出されます。 | ApplicationUpdater | |||
| installFromAIRFile() メソッドの呼び出しで Updater がファイルの検証に成功した後に送出されます。 | ApplicationUpdater | |||
| 初期化が完了した後に送出されます。 | ApplicationUpdater | |||
| 初期化が完了した後に送出されます。 | ApplicationUpdater | |||
| 更新記述ファイルをダウンロードまたは解析しようとしてエラーが発生した場合に送出されます。 | ApplicationUpdater | |||
| Updater が更新記述ファイルを正常にダウンロードして解釈した後で送出されます。 | ApplicationUpdater | |||
| プロパティ |
configurationFile:File [読み書き可能] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
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 プロパティを設定できます。
public function get configurationFile():File public function set configurationFile(value:File):void関連項目
| プロパティ |
currentState:String [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
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 は初期化を終了し、保留状態の更新があります。
public function get currentState():String| プロパティ |
currentVersion:String [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
アプリケーションの現在のバージョンです。このプロパティは、initialize() メソッドの呼び出し中に設定されます。アプリケーション記述ファイルのバージョンに設定されます。
public function get currentVersion():String| プロパティ |
delay:Number [読み書き可能] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
新しい更新を周期的にチェックする間隔(日)。
値 0(デフォルト値)は、タイマーがアクティブではないため、周期的なチェックが行われないことを示します。この値は、このプロパティまたは設定ファイルを使用して設定できます。両方の方法を使用して値を設定すると、プロパティを使用して設定した値が使用されます。
デフォルト値 : 0.
public function get delay():Number public function set delay(value:Number):void| プロパティ |
isFirstRun:Boolean [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
これが正常な更新の後で最初の実行(true)か、それ以外(false)かを指定します。Updater は、initialize() メソッドの呼び出し中にこの値を設定します。あるバージョンから別のバージョンにデータを移行する必要がある場合、開発者は isFirstRun が true に設定されているかどうかを検査する必要があります。
public function get isFirstRun():Boolean関連項目
| プロパティ |
isNewerVersionFunction:Function [読み書き可能] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
バージョン比較を実行するために Updater が使用する必要がある関数です。デフォルトでは、更新フレームワークがバージョンの比較を行って、リモートサイトからのバージョンがインストールされているアプリケーションのバージョンより新しいかどうかを判定します。ただし、デフォルトの比較が開発者のバージョン管理方式と一致しない場合があります。このプロパティを使用して、比較を行う新しい関数を指定します。
デフォルトの比較関数は、x.y.z のようなバージョンを受け付けます。x、y、z は文字または数字です。デフォルトの比較関数が認識するいくつかの特別な条件があります。テスト関数がバージョン文字列で 「alpha」、「beta」、または 「rc」 を検出した場合、順序は alpha < beta < rc になります。
public function get isNewerVersionFunction():Function public function set isNewerVersionFunction(value:Function):voidcustomFn(appUpdate Updater オブジェクト)を定義します。サンプルの関数は意図的に単純になっています。カスタム関数は、バージョン管理方式の規則に基づいてブール値を返す必要があります。
appUpdate.isNewerVersionFunction = customFn;
function customFn (currentVersion:String, updateVersion:String):Boolean
{
return updateVersion > currentVersion;
}| プロパティ |
previousApplicationStorageDirectory:File [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
アプリケーションの記憶領域ディレクトリの以前の場所です(更新後に変更された場合)。アプリケーションの記憶領域ディレクトリの場所は、証明書が移行されるアップグレードの後に変更されます。証明書が移行されない場合、ユーザーがアプリケーションを更新してもアプリケーションの記憶領域ディレクトリは変更されません。このプロパティは null に設定されます。このプロパティは、initialize() メソッドの呼び出し中に設定されます。
開発者は AIR ファイルと ADT をパッケージ化するときに -migrate オプションを使用すると、新しい証明書を使用して AIR アプリケーションの新しいバージョンに署名できます。新しいバージョンの AIR アプリケーションが新しい署名証明書を使用する場合、ユーザーが新しいバージョンをインストールするときに、アプリケーションのローカルの記憶領域ディレクトリが変更されます。アプリケーションの古い記憶領域ディレクトリから新しい記憶領域ディレクトリにデータを転送するには、このプロパティを使用します(File.applicationStorageDirectory)。詳細については、Adobe AIR 開発者ガイドの「コマンドラインツールを使用した AIR アプリケーションの作成」の章の「アプリケーション証明書を変更するための AIR ファイルへの署名」を参照してください。
public function get previousApplicationStorageDirectory():File| プロパティ |
previousVersion:String [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
アプリケーションの前のバージョンです。このプロパティは、initialize() メソッドの呼び出し中に設定されます。アップグレード前のアプリケーションの以前のバージョンを返します(isfirstRun が true の場合にのみ設定されます)。それ以外の場合は null に設定されます。
public function get previousVersion():String| プロパティ |
updateDescriptor:XML [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新 URL からダウンロードされた更新記述ファイルの内容です。このプロパティは、Updater オブジェクトが updateStatus イベントを送出した後にのみ null 以外になります。
public function get updateDescriptor():XML| プロパティ |
updateURL:String [読み書き可能] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新記述ファイルの場所。URLRequest のパスとして有効な任意の場所が受け付けられます。Updater に必要な必須の設定はこれだけです。更新 URL は、このプロパティまたは設定ファイルを使用して設定できます。両方の方法を使用して値を設定すると、Updater はこのプロパティを使用して設定した値を使用します。
public function get updateURL():String public function set updateURL(value:String):void| プロパティ |
wasPendingUpdate:Boolean [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
インストールが失敗した(true)かどうかに関係なく、延期された更新があったかどうかを指定します。それ以外の場合は false を指定します。Updater は、initialize() メソッドの呼び出し中にこのプロパティを設定します。wasPendingUpdate プロパティと isFirstRun プロパティを使用して、更新のインストールに失敗したかどうかをチェックします(失敗した場合、wasPendingUpdate は true に設定され、isFirstRun は false に設定されます)。
public function get wasPendingUpdate():Boolean関連項目
| () | コンストラクタ |
public function ApplicationUpdater()| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
コンストラクタ関数です。
| () | メソッド |
public function cancelUpdate():void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新処理をキャンセルします。このメソッドを呼び出すと、保留状態のダウンロードがキャンセルされ、完全にダウンロードされていないファイルが削除され、周期的なチェックタイマーが再起動されます。
更新処理は、状態マシンが「UNINITIALIZED」または「INITIALIZING」状態のときを除き、いつでもキャンセルできます。「UNINITIALIZED」または「INITIALIZING」状態のときに更新処理をキャンセルしても、何も行われません。
| () | メソッド |
public function checkForUpdate():void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新記述ファイルを非同期にダウンロードして解釈します。このメソッドを呼び出すと、更新状態は「CHECKING」に移行します。このメソッドは、checkForUpdate イベントをキャンセルした場合にのみ呼び出してください。
このメソッドは、Updater が「BEFORE_CHECKING」状態の場合にのみ動作します。
updateStatus: — Updater が正常にダウンロードされ、更新記述ファイルが解釈されました。 | |
updateError: — 更新記述ファイルをダウンロードまたは解析しようとしてエラーが発生しました。 |
| () | メソッド |
public function checkNow():void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新処理を開始します。このメソッドを呼び出しても、周期的タイマーはキャンセルされません。ただし、実行中の更新処理を検出し、現在の反復をスキップします。
このメソッドは、現在の状態が「READY」の場合にのみ動作します。
このメソッドを呼び出すと、Updater オブジェクトが次のイベントを送出する場合があります。
checkForUpdate: — 更新処理が開始する直前に送出されます。 |
| () | メソッド |
public function downloadUpdate():void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新ファイルを非同期にダウンロードします。このメソッドを呼び出すと、更新状態は「DOWNLOADING」に移行します。イベントの available プロパティが true のときに StatusUpdateEvent.UPDATE_STATUS イベントをキャンセルした場合にのみ、このメソッドを呼び出す必要があります。
このメソッドは、現在の状態が「AVAILABLE」の場合にのみ動作します。
downloadStart — サーバーへの接続が確立された後に送出されます。 | |
progress: — 初期化が完了した後に送出されます。 | |
downloadError — 接続中または更新ファイルのダウンロード中にエラーが発生した場合に送出されます。無効な HTTP ステータス(404 - File not found など)に対しても送出されます。 |
| () | メソッド |
public function initialize():void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
Updater を初期化します。このメソッドを呼び出すと、次のことが行われます。
更新フレームワークが初期化され、保留されているすべての更新がサイレントで(かつ同期的に)インストールされます。このメソッドは、アプリケーションを再起動する場合があるので、アプリケーションの起動時に呼び出す必要があります。
延期されている更新があるかどうかをチェックし、ある場合はインストールします。
前の更新がうまくいかなかった場合は、更新ファイルとバージョン情報を記憶域からクリアします。
周期的なタイマーの遅延時間が経過した場合は、更新処理を開始します。それ以外の場合は、周期タイマーを開始します。ただし、AIR Debug Launcher(ADL)アプリケーションを使用してアプリケーションをテストしているときに、アプリケーションを更新しようとすると、IllegalOperationError 例外が発生します。
initialized: — 初期化が完了しました。 | |
error: — 初期化中にエラーが発生しました。 |
| () | メソッド |
public function installFromAIRFile(file:File):void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
ローカル AIR ファイルを使用して Update プロセスを開始します。
更新処理が実行中の場合(状態が「DOWNLOADED」でない場合)、このメソッドを呼び出しても何も行われません。
この機能は、アプリケーション記述ファイルで customUpdateUI 要素が true に設定されているアプリケーションに対して役に立ちます。
AIR Debug Launcher(ADL)アプリケーションを使用してアプリケーションをテストしているときに、このメソッドを呼び出すと、IllegalOperationError 例外が発生します。
パラメータ
file:File — インストールするローカルの AIR ファイルです。 |
fileUpdateStatus: — Updater が AIR ファイルの検証に成功した後に送出されます。 | |
updateError: — 更新記述ファイルを解析しようとしてエラーが発生した場合に送出されます。 |
| () | メソッド |
public function installUpdate():void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新ファイルをインストールします。このメソッドを呼び出すと状態マシンは「INSTALLING」に進み、downLoadComplete イベントをキャンセルした場合にのみ呼び出す必要があります。
このメソッドは、Updater が「DOWNLOADED」状態のときに呼び出します。他の状態で呼び出しても何も行いません。
AIR Debug Launcher(ADL)アプリケーションを使用してアプリケーションをテストしているときに、このメソッドを呼び出すと、IllegalOperationError 例外が発生します。
beforeInstall: — 更新をインストールする直前に送出されます。ランタイムがアプリケーションへの更新のインストールを終了するとユーザーが行っている現在の作業が失われるので、このイベントの時点で更新のインストールを中止すると便利な場合があります。 |
| イベント |
air.update.events.UpdateEventair.update.events.UpdateEvent.BEFORE_INSTALL| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新をインストールする直前で、installUpdate() メソッドを呼び出した後に送出されます。 ランタイムがアプリケーションへの更新のインストールを終了するとユーザーが行っている現在の作業が失われるので、このイベントの時点で更新のインストールを中止すると便利な場合があります。
このイベントの preventDefault() メソッドを呼び出すと、インストールは次の再起動まで延期されます。preventDefault() メソッドを呼び出すと、(installUpdate() メソッドの呼び出しまたは周期的なチェックによって)このアプリケーションセッション中に追加の更新処理は開始されません。
ApplicationUpdater ライブラリのデフォルトの動作では、更新記述ファイルがダウンロードされます。preventDefault() メソッドを呼び出して、この動作をキャンセルできます。
UpdateEvent.BEFORE_INSTALL 定数により、イベントオブジェクトの type プロパティ値が beforeInstall イベント用に定義されます。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
bubbles
|
false
|
cancelable
|
false は、キャンセルするデフォルトの動作がないことを示します。
|
currentTarget
| イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target
| Updater オブジェクトです。 |
| イベント |
air.update.events.UpdateEventair.update.events.UpdateEvent.CHECK_FOR_UPDATE| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新処理が開始される前、Updater が更新記述ファイルをダウンロードしようとする直前に送出されます。Updater は、checkNow() メソッドの直接呼び出しの結果として、または周期的なチェックタイマーが時間切れになった場合に、このイベントを送出できます。
UpdateEvent.CHECK_FOR_UPDATE 定数により、イベントオブジェクトの type プロパティ値が checkForUpdate イベント用に定義されます。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
bubbles
|
false
|
cancelable
|
false は、キャンセルするデフォルトの動作がないことを示します。
|
currentTarget
| イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target
| Updater オブジェクトです。 |
| イベント |
air.update.events.UpdateEventair.update.events.UpdateEvent.DOWNLOAD_COMPLETE| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新ファイルのダウンロードが完了すると送出されます。
通常は、更新のインストールを続行するかどうかをユーザーに確認するメッセージを表示する場合に、このイベントを使用します。
ApplicationUpdater ライブラリのデフォルトの動作では、installUpdate() メソッドが自動的に呼び出されます。
UpdateEvent.DOWNLOAD_COMPLETE 定数により、イベントオブジェクトの type プロパティ値が downloadComplete イベント用に定義されます。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
bubbles
|
false
|
cancelable
|
false は、キャンセルするデフォルトの動作がないことを示します。
|
currentTarget
| イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target
| Updater オブジェクト。 |
| イベント |
air.update.events.DownloadErrorEventair.update.events.DownloadErrorEvent.DOWNLOAD_ERROR| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
接続中または更新ファイルのダウンロード中にエラーが発生した場合に送出されます。無効な HTTP ステータス(404 - File not found など)に対しても送出されます。
このイベントが送出されると、周期的なタイマーは自動的に再起動されます(遅延が 0 より大きい場合)。
DownloadErrorEvent.DOWNLOAD_ERROR 定数により、イベントオブジェクトの type プロパティ値が downloadError イベント用に定義されます。
DownloadErrorEvent オブジェクトの errorID プロパティは、エラー情報を定義する整数です(次の表を参照)。追加の subErrorID プロパティに、さらにエラー情報が含まれる場合があります。
| errorID のエラーコード | 説明 |
|---|---|
| 16800 |
ダウンロードされた更新ファイルの検証中に発生します。subErrorID プロパティに、追加情報が含まれる場合があります。
|
| 16801 | 無効な Adobe AIR ファイル (application.xml がない)。 |
| 16802 | 無効な Adobe AIR ファイル(MIME タイプがない)。 |
| 16807 | 無効な Adobe AIR ファイル (形式)。 |
| 16804 | 無効な Adobe AIR ファイル (無効なフラグ)。 |
| 16805 | 無効な Adobe AIR ファイル (不明な圧縮)。 |
| 16806 | 無効な Adobe AIR ファイル (無効なファイル名)。 |
| 16807 | 無効な Adobe AIR ファイル (破損)。 |
| 16808 | 設定ファイルがありません。 |
| 16809 |
updateURL プロパティが設定されていません。
|
| 16810 | 予約。 |
| 16811 | 無効な設定ファイル (不明の設定バージョン)。 |
| 16812 | 無効な設定ファイル (URL がない)。 |
| 16813 | 無効な設定ファイル (遅延形式)。 |
| 16814 | 無効な設定ファイル (無効なデフォルト defaultUI 値)。 |
| 16815 | 無効な更新記述子 (不明な記述子バージョン)。 |
| 16816 | 無効な更新記述子 (更新バージョンがない)。 |
| 16817 | 無効な更新記述子 (無効な説明)。 |
| 16818 |
ディスクへのデータ保存中の IO エラー。subErrorID プロパティでさらに情報が提供される場合があります。
|
| 16819 |
ダウンロード中のセキュリティエラー。subErrorID プロパティでさらに情報が提供される場合があります。
|
| 16820 |
無効な HTTP ステータスコード。subErrorID プロパティに、無効なステータスコードが含まれる場合があります。
|
| 16821 | 予約。 |
| 16822 |
ダウンロード中の I/O エラー。subErrorID プロパティでさらに情報が提供される場合があります。
|
| 16823 |
ディスクへのデータ保存中のファイル終端エラー。subErrorID プロパティでさらに情報が提供される場合があります。
|
| 16824 |
無効な更新記述子。subErrorID プロパティでさらに情報が提供される場合があります。
|
| 16825 | 更新ファイルに異なるアプリケーション ID のアプリケーションが含まれています。 |
| 16826 | 更新ファイルに新しいバージョンのアプリケーションが含まれていません。 |
| 16827 | 更新ファイルに含まれるバージョンが、更新記述子のバージョンと一致しません。 |
| 16828 | アプリケーションを更新できません。通常これは、アプリケーションが AIR Debug Launcher (ADL) で実行しているためです。 |
| 16829 | インストール時に更新ファイルがありません。 |
| イベント |
air.update.events.UpdateEventair.update.events.UpdateEvent.DOWNLOAD_START| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
downloadUpdate() メソッドが呼び出されてサーバーへの接続が確立された後で送出されます。ApplicationUpdater ライブラリを使用しているときは、このイベントのイベントハンドラを使用して、ダウンロードの進捗をユーザーに示すプログレスバーを表示できます。
UpdateEvent.DOWNLOAD_START 定数により、イベントオブジェクトの type プロパティ値が downloadStart イベント用に定義されます。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
bubbles
|
false
|
cancelable
|
false は、キャンセルするデフォルトの動作がないことを示します。
|
currentTarget
| イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target
| Updater オブジェクトです。 |
| イベント |
flash.events.ErrorEventflash.events.ErrorEvent.ERROR| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
初期化中または更新処理中にエラーが発生した場合 (何か予期しないことが発生した場合) に送出されます。
type プロパティ(error イベントオブジェクト)の値を定義します。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
bubbles
|
false
|
cancelable
|
false は、キャンセルするデフォルトの動作がないことを示します。
|
currentTarget
| イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target
| ネットワーク操作エラーが発生したオブジェクトです。 |
text
| エラーメッセージとして表示されるテキストです。 |
| イベント |
air.update.events.StatusFileUpdateErrorEventair.update.events.StatusFileUpdateErrorEvent.FILE_UPDATE_ERROR| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
airFile パラメータ(installFromAIRFile() メソッドの呼び出し)として渡されたファイルの検証でエラーが発生した場合に送出されます。
StatusUpdateErrorEvent.UPDATE_ERROR 定数により、イベントオブジェクトの type プロパティ値が statusUpdateError イベント用に定義されます。
| イベント |
air.update.events.StatusFileUpdateEventair.update.events.StatusFileUpdateEvent.FILE_UPDATE_STATUS| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
installFromAIRFile() メソッドの呼び出しで Updater がファイルの検証に成功した後に送出されます。
StatusUpdateEvent.UPDATE_STATUS 定数により、イベントオブジェクトの type プロパティ値が updateStatus イベント用に定義されます。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
available
|
現在のアプリケーションとは異なるバージョンを使用できるかどうかを示します。使用できる場合は true、それ以外(同じバージョン)の場合は false を返します。
|
path
|
更新 File オブジェクトの nativePath プロパティ。この File オブジェクトは、airFile パラメータ(installFromAIRFile() メソッドへの呼び出しで使用)で指定されます。
|
version
| 新しい更新のバージョンを示します。 |
| イベント |
air.update.events.UpdateEventair.update.events.UpdateEvent.INITIALIZED| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
初期化が完了した後に送出されます。
UpdateEvent.INITIALIZED 定数により、イベントオブジェクトの type プロパティ値が initialized イベント用に定義されます。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
bubbles
|
false
|
cancelable
|
false は、キャンセルするデフォルトの動作がないことを示します。
|
currentTarget
| イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target
| Updater オブジェクトです。 |
| イベント |
flash.events.ProgressEventflash.events.ProgressEvent.PROGRESS| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
初期化が完了した後に送出されます。
type プロパティ(progress イベントオブジェクト)の値を定義します。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
bubbles
|
false
|
bytesLoaded
| リスナーがイベントを処理しているときに読み込まれたアイテム数またはバイト数です。 |
bytesTotal
| 読み込みプロセスが成功した場合に最終的に読み込まれるアイテムまたはバイトの総数です。 |
cancelable
|
false は、キャンセルするデフォルトの動作がないことを示します。
|
currentTarget
| イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target
| 進行状況をレポートする オブジェクトです。 |
| イベント |
air.update.events.StatusUpdateErrorEventair.update.events.StatusUpdateErrorEvent.UPDATE_ERROR| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
更新記述ファイルをダウンロードまたは解析しようとしてエラーが発生した場合に送出されます。
Updater がこのイベントを送出すると、周期的なタイマーは自動的に再起動されます(遅延の設定が 0 より大きい場合)。Updater が新しい checkForUpdate イベントを送出した場合、アプリケーションではすべてのエラーダイアログボックスを非表示にすることを検討する必要があります。
StatusUpdateErrorEvent.UPDATE_ERROR 定数により、イベントオブジェクトの type プロパティ値が statusUpdateError イベント用に定義されます。
| イベント |
air.update.events.StatusUpdateEventair.update.events.StatusUpdateEvent.UPDATE_STATUS| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.5 |
Updater が更新記述ファイルを正常にダウンロードして解釈した後で送出されます。
StatusUpdateEvent オブジェクトの使用可能なプロパティの available が true に設定されている場合、デフォルトの動作では更新のダウンロードが開始されます。デフォルトの動作を回避できるのは、ApplicationUpdatorUI クラスを使用している場合ではなく、ApplicationUpdater クラスを使用している場合のみです。
StatusUpdateEvent.UPDATE_STATUS 定数により、イベントオブジェクトの type プロパティ値が updateStatus イベント用に定義されます。
このイベントには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
available
|
更新記述ファイルで現在のアプリケーションとは異なるバージョンが指定されている場合は true、それ以外の(バージョンが同じ)場合は false に設定されます。
|
details
|
サポートされる各言語の details 文字列を定義する配列。ローカライズされた説明がない場合は、最初の要素が空の文字列("")で 2 番目の要素が details 文字列の配列として定義されます。 ローカライズされた説明がある場合は、配列の各要素が、2 つの要素を持つ配列自体になります。最初の要素はロケールコードで、2 番目の要素は説明です。例えば、["en-US", "Hello World"], ["fr", "Bonjour monde"] という配列には、2 つの言語(米国英語とフランス語)のサブ配列が含まれます。 言語は、更新記述子と同じ順序でリストされます。
|
version
| 使用可能な新しいバージョンを表す文字列。 |