The NativeApplication object of an AIR application dispatches an invoke event when the
application is invoked.

The NativeApplication object always dispatches an invoke event
when an application is launched, but the event may be dispatched
at other times as well. For example, a running application dispatches an
additional InvokeEvent when a user activates a file associated with the
application.

Only a single instance of a particular application can be launched. Subsequent attempts to
launch the application will result in a new invoke event dispatched by
the NativeApplication object of the running instance.
It is an application's responsibility to handle this event and take the appropriate
action, such as opening a new application window to display the data in a file.

InvokeEvent objects are dispatched by the NativeApplication object
(NativeApplication.nativeApplication). To receive invoke events,
call the addEventListener() method of the NativeApplication object.
When an event listener registers for an invoke event, it will also receive all
invoke events that occurred before the registration. These earlier events are dispatched
after the call to addEventListener() returns, but not necessarily before
a new invoke event that might be might be dispatched after registration. Thus,
you should not rely on dispatch order.

arguments

The array of string arguments passed during this invocation. If this is a
command line invocation, the array contains the command line arguments
(excluding the process name).

On mobile platforms, this property contains the array of options with which the application was launched, not the command-line arguments.
Additionally, on mobile platforms, when reason is InvokeEventReason.OPEN_URL, the contents of the arguments Array
vary, as follows:

Another application or browser invokes the application with a custom URL (iOS and Android):

arguments

iOS

Android

InvokeEvent.arguments.length

3

2

InvokeEvent.arguments[0]

url

url

InvokeEvent.arguments[1]

source app id

action id

InvokeEvent.arguments[2]

null

NA

The system invokes the application to open an associated file type (iOS and Android):

arguments

iOS

Android

InvokeEvent.arguments.length

3

2

InvokeEvent.arguments[0]

url

url

InvokeEvent.arguments[1]

null

action id

InvokeEvent.arguments[2]

null

NA

Another application invokes the application using the document interaction controller (iOS only):

arguments

iOS

InvokeEvent.arguments.length

3

InvokeEvent.arguments[0]

url

InvokeEvent.arguments[1]

source app id

InvokeEvent.arguments[2]

annotation

Note: When multiple files are selected and opened on Mac® OS X, AIR
dispatches a single invoke event containing the names of all the
selected files in the arguments array. On Windows® and Linux, however, AIR
dispatches a separate invoke event for each selected file containing only that
filename in the arguments array.

currentDirectory

The directory that should be used to resolve any relative paths in the arguments
array.

If an application is started from the command line, this property is
typically set to the current working directory of the command line shell from which
the application was started. If an application is launched from the GUI shell,
this is typically the file system root.

reason

The reason for this InvokeEvent. This property indicates whether the application was launched manually
by the user or automatically at login. Possible values are enumerated as constants in
the InvokeEventReason class:

bubbles:Boolean (default = false) — Set to false for an InvokeEvent object.

cancelable:Boolean (default = false) — Set to false for an InvokeEvent object.

dir:File (default = null) — The directory that should be used to resolve any relative paths in
the arguments array.

argv:Array (default = null) — An array of arguments (strings) to pass to the application.

reason:String (default = "standard") — the cause of the event: InvokeEventReason.LOGIN, InvokeEventReason.STANDARD,
InvokeEventReason.OPEN_URL, or InvokeEventReason.NOTIFICATION.
(This parameter is available as of AIR version 1.5.1. OPEN_URL and NOTIFICATION are available as of AIR version 3.5.)

INVOKE

The InvokeEvent.INVOKE constant defines the value of the type
property of an InvokeEvent object.

The InvokeEvent object has the following properties:

Properties

Values

arguments

The array of string arguments passed
during this invocation.

currentDirectory

a File object representing the
directory that should be used to resolve any relative paths in the arguments array.

reason

a code indicating whether the invoke event was dispatched
because the application started automatically at login (InvokeEventReason.LOGIN), started
as a response to a remote notification (InvokeEventReason.NOTIFICATION - iOS only),
because the application was invoked by another application (InvokeEventReason.OPEN_URL), or
for another reason (InvokeEventReason.STANDARD). Available as of AIR version 1.5.1.

bubbles

false.

cancelable

false;
there is no default behavior to cancel.

currentTarget

Indicates the object that is
actively processing this InvokeEvent object with an event listener.