| Package | flash.events |
| Class | public class InvokeEvent |
| Inheritance | InvokeEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
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.
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| arguments : Array [read-only]
The array of string arguments passed during this invocation. | InvokeEvent | ||
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentDirectory : File [read-only]
The directory that should be used to resolve any relative paths in the arguments
array. | InvokeEvent | ||
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| reason : String [read-only]
The reason for this InvokeEvent. | InvokeEvent | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
| Method | Defined By | ||
|---|---|---|---|
InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null, reason:String = "standard")
The constructor function for the InvokeEvent class. | InvokeEvent | ||
[override]
Creates a new copy of this event. | InvokeEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| INVOKE : String = "invoke" [static]
The InvokeEvent.INVOKE constant defines the value of the type
property of an InvokeEvent object. | InvokeEvent | ||
arguments | property |
arguments:Array [read-only] | Runtime Versions: | AIR 1.0 |
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.length3 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.length3 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.length3 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.
Implementation
public function get arguments():Array currentDirectory | property |
currentDirectory:File [read-only] | Runtime Versions: | AIR 1.0 |
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.
Implementation
public function get currentDirectory():File reason | property |
reason:String [read-only] | Runtime Versions: | AIR 1.5.1 |
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:
| InvokeEventReason constant | Meaning |
|---|---|
LOGIN | Launched automatically at at login. |
NOTIFICATION | Launched in reponse to a notification (iOS only). |
OPEN_URL | Launched because the application was invoked by another application. |
STANDARD | Launched for any other reason. |
Note: On mobile platforms, the reason property is never set to
LOGIN.
Implementation
public function get reason():StringRelated API Elements
InvokeEvent | () | Constructor |
public function InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null, reason:String = "standard")| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
The constructor function for the InvokeEvent class.
Parameterstype:String — The type of the event, accessible as Event.type.
| |
bubbles:Boolean (default = false)false for an InvokeEvent object.
| |
cancelable:Boolean (default = false)false for an InvokeEvent object.
| |
dir:File (default = null)arguments array.
| |
argv:Array (default = null) | |
reason:String (default = "standard")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.)
|
Related API Elements
clone | () | method |
INVOKE | Constant |
public static const INVOKE:String = "invoke"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
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. |
target | Always the NativeApplication object. |
Related API Elements
Thu Dec 6 2018, 01:12 PM -08:00