| パッケージ | flash.events |
| クラス | public class InvokeEvent |
| 継承 | InvokeEvent  Event Object |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.0 |
invoke イベントは、AIR アプリケーションが呼び出されたときに、アプリケーションの NativeApplication オブジェクトによって送出されます。
invoke イベントはアプリケーションが起動されたときに NativeApplication オブジェクトによって必ず送出されますが、それ以外のときにも送出されることがあります。例えば、ユーザーがアプリケーションに関連付けられたファイルをアクティブ化すると、実行中のアプリケーションは追加の InvokeEvent を受け取ります。
特定のアプリケーションの単一のインスタンスのみを起動できます。その後で同じアプリケーションをさらに起動しようとすると、実行中のインスタンスの NativeApplication オブジェクトによって新しい invoke イベントが送出されます。このイベントを処理して適切なアクション（例えば、新しいアプリケーションウィンドウを開いてファイルのデータを表示するなど）を実行するのはアプリケーションの役割です。
InvokeEvent オブジェクトは、NativeApplication オブジェクト（NativeApplication.nativeApplication）によって送出されます。invoke イベントを受け取るには、NativeApplication オブジェクトの addEventListener() メソッドを呼び出します。invoke イベントのイベントリスナーを登録すると、そのイベントリスナーは、登録の前に発生した invoke イベントもすべて受け取ります。これらの以前のイベントは、addEventListener() の呼び出しが戻った後に送出されますが、必ずしも登録後に送出される可能性のある新しい invoke イベントよりも前に送出されるとは限りません。このため、送出順序に依存しないでください。
関連する API エレメント
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
| arguments : Array [読み取り専用]
この呼び出し中に渡されるストリング引数の配列です。 | InvokeEvent | ||
 | bubbles : Boolean [読み取り専用]
イベントがバブリングイベントかどうかを示します。 | Event | |
| cancelable : Boolean [読み取り専用]
イベントに関連付けられた動作を回避できるかどうかを示します。 | Event | |
| constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| currentDirectory : File [読み取り専用]
arguments 配列内の相対パスの解決に使用されるディレクトリです。 | InvokeEvent | ||
| currentTarget : Object [読み取り専用]
イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 | Event | |
| eventPhase : uint [読み取り専用]
イベントフローの現在の段階です。 | Event | |
| reason : String [読み取り専用]
この InvokeEvent の理由です。 | InvokeEvent | ||
| target : Object [読み取り専用]
イベントターゲットです。 | Event | |
| type : String [読み取り専用]
イベントのタイプです。 | Event | |
| メソッド | 定義元 | ||
|---|---|---|---|
InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null, reason:String = "standard")
InvokeEvent クラスのコンストラクター関数です。 | InvokeEvent | ||
[オーバーライド]
このイベントの新しいコピーを作成します。 | InvokeEvent | ||
|
カスタム ActionScript 3.0 Event クラスに toString() メソッドを実装するためのユーティリティ関数です。 | Event | |
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
イベントで preventDefault() メソッドが呼び出されたかどうかを確認します。 | Event | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
イベントのデフォルト動作をキャンセルできる場合に、その動作をキャンセルします。 | Event | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。 | Event | |
|
イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。 | Event | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
Event オブジェクトのすべてのプロパティを含むストリングを返します。 | Event | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
| 定数 | 定義元 | ||
|---|---|---|---|
| INVOKE : String = "invoke" [静的]
InvokeEvent.INVOKE 定数は、InvokeEvent オブジェクトの type プロパティの値を定義します。 | InvokeEvent | ||
arguments | プロパティ |
arguments:Array [読み取り専用] | ランタイムバージョン: | AIR 1.0 |
この呼び出し中に渡されるストリング引数の配列です。これがコマンドラインからの呼び出しの場合、この配列は、プロセス名を除くコマンドライン引数になります。
モバイルプラットフォームでは、このプロパティには、アプリケーションが起動された際に使用された、コマンドライン引数でないオプションの配列が含まれます。さらに、モバイルプラットフォームでは、reason が InvokeEventReason.OPEN_URL の場合、arguments の Array の内容は場合によって次のように異なります。
- 別のアプリケーションまたはブラウザーがカスタム URL を使用してアプリケーションを起動する場合（iOS と Android）：
arguments iOS Android InvokeEvent.arguments.length3 2 InvokeEvent.arguments[0]url url InvokeEvent.arguments[1]ソースアプリケーション ID アクション ID InvokeEvent.arguments[2]null N/A - システムが関連するファイルタイプを開くためにアプリケーションを起動する場合（iOS と Android）：
arguments iOS Android InvokeEvent.arguments.length3 2 InvokeEvent.arguments[0]url url InvokeEvent.arguments[1]null アクション ID InvokeEvent.arguments[2]null N/A - 別のアプリケーションがドキュメントインタラクションコントローラーを使用してアプリケーションを起動する場合（iOS のみ）：
arguments iOS InvokeEvent.arguments.length3 InvokeEvent.arguments[0]url InvokeEvent.arguments[1]ソースアプリケーション ID InvokeEvent.arguments[2]注釈
注意：Mac® OS X で複数のファイルを選択して開くと、AIR によって単一の invoke イベント（選択したすべてのファイルの名前を arguments 配列に含む）が送出されます。ただし Windows® および Linux では、AIR は別々の invoke イベントを送出します（arguments 配列にあるファイル名のみを含んだ選択済みのファイルごとに送出します）。
実装
public function get arguments():Array currentDirectory | プロパティ |
reason | プロパティ |
reason:String [読み取り専用] | ランタイムバージョン: | AIR 1.5.1 |
この InvokeEvent の理由です。このプロパティは、アプリケーションがユーザーの手動によって起動されたか、ログイン時に自動的に起動されたかを示します。使用される値は、InvokeEventReason クラス内に列挙されている次の定数です。
| InvokeEventReason 定数 | 説明 |
|---|---|
LOGIN | ログイン時に自動的に起動されたことを示します。 |
NOTIFICATION | 通知へのレスポンスとして起動されたことを示します（iOS のみ）。 |
OPEN_URL | アプリケーションが別のアプリケーションから起動されたことを示します。 |
STANDARD | その他の理由により起動されたことを示します。 |
注意：モバイルプラットフォームでは、reason プロパティが LOGIN に設定されることはありません。
実装
public function get reason():String関連する API エレメント
InvokeEvent | () | コンストラクター |
public function InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null, reason:String = "standard")| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.0 |
InvokeEvent クラスのコンストラクター関数です。
パラメーターtype:String — Event.type としてアクセス可能なイベントタイプです。
| |
bubbles:Boolean (default = false)false に設定します。
| |
cancelable:Boolean (default = false)false に設定します。
| |
dir:File (default = null)arguments 配列内の相対パスの解決に使用されるディレクトリです。
| |
argv:Array (default = null) | |
reason:String (default = "standard")InvokeEventReason.LOGIN、InvokeEventReason.STANDARD、InvokeEventReason.OPEN_URL または InvokeEventReason.NOTIFICATION（このパラメーターは AIR バージョン 1.5.1 より利用できます。OPEN_URL および NOTIFICATION は AIR バージョン 3.5 より利用できます）。
|
関連する API エレメント
clone | () | メソッド |
INVOKE | 定数 |
public static const INVOKE:String = "invoke"| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.0 |
InvokeEvent.INVOKE 定数は、InvokeEvent オブジェクトの type プロパティの値を定義します。
InvokeEvent オブジェクトには、次のプロパティがあります。
| プロパティ | 値 |
|---|---|
arguments | この呼び出し中に渡されるストリング引数の配列です。 |
currentDirectory | arguments 配列内の相対パスの解決に使用されるディレクトリを表す File オブジェクトです。 |
reason | invoke イベントが送出された原因を示すコード。アプリケーションがログイン時に自動的に開始した（InvokeEventReason.LOGIN）、リモート通知へのレスポンスとして開始した（InvokeEventReason.NOTIFICATION - iOS のみ）、アプリケーションが別のアプリケーションによって起動された（InvokeEventReason.OPEN_URL）またはその他の理由（InvokeEventReason.STANDARD）のいずれかです。AIR バージョン 1.5.1 から使用できます。 |
bubbles | false |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
currentTarget | イベントリスナーで InvokeEvent オブジェクトをアクティブに処理しているオブジェクトを示します。 |
target | 常に NativeApplication object オブジェクトです。 |
関連する API エレメント
Tue Jun 12 2018, 10:34 AM Z