| Package | flash.events |
| Class | public class InvokeEvent |
| Inheritance | InvokeEvent  Event Object |
| Language version: | ActionScript 3.0 |
| Runtime version: | 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.
See also
| Property | Defined by | ||
|---|---|---|---|
| arguments : Array
[read-only]
The array of string arguments passed during this invocation.
| InvokeEvent | ||
 | bubbles : Boolean
Indicates whether an event is a bubbling event.
| Event | |
| cancelable : Boolean
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
The object that is actively processing the Event object with an event listener.
| Event | |
| eventPhase : uint
The current phase in the event flow.
| Event | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| reason : String
[read-only]
The reason for this InvokeEvent.
| InvokeEvent | ||
| target : Object
The event target.
| Event | |
| type : String
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 | ||
|
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 | ||
|---|---|---|---|
| ACTIVATE : String = "activate" [static]
The
ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
| ADDED : String = "added" [static]
The
Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
| ADDED_TO_STAGE : String = "addedToStage" [static]
The
Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
| BROWSER_ZOOM_CHANGE : String = "browserZoomChange" [static]
The
Event.BROWSER_ZOOM_CHANGE constant defines the value of the type
property of an browserZoomChange event object. | Event | |
| CANCEL : String = "cancel" [static]
The
Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
| CHANGE : String = "change" [static]
The
Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
| CHANNEL_MESSAGE : String = "channelMessage" [static]
The
Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object. | Event | |
| CHANNEL_STATE : String = "channelState" [static]
The
Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object. | Event | |
| CLEAR : String = "clear" [static]
The
Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | |
| CLOSE : String = "close" [static]
The
Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
| CLOSING : String = "closing" [static]
The
Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
| COMPLETE : String = "complete" [static]
The
Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
| CONNECT : String = "connect" [static]
The
Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
| CONTEXT3D_CREATE : String = "context3DCreate" [static]
The
Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object. | Event | |
| COPY : String = "copy" [static]
Defines the value of the
type property of a copy event object. | Event | |
| CUT : String = "cut" [static]
Defines the value of the
type property of a cut event object. | Event | |
| DEACTIVATE : String = "deactivate" [static]
The
Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
| DISPLAYING : String = "displaying" [static]
The
Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
| ENTER_FRAME : String = "enterFrame" [static]
The
Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
| EXIT_FRAME : String = "exitFrame" [static]
The
Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
| EXITING : String = "exiting" [static]
The
Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
| FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The
Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
| FRAME_LABEL : String = "frameLabel" [static]
The
Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object. | Event | |
| FULLSCREEN : String = "fullScreen" [static]
The
Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
| HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The
Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | |
| HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The
Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | |
| HTML_RENDER : String = "htmlRender" [static]
The
Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
| ID3 : String = "id3" [static]
The
Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
| INIT : String = "init" [static]
The
Event.INIT constant defines the value of the type property of an init event object. | Event | |
| INVOKE : String = "invoke" [static]
The
InvokeEvent.INVOKE constant defines the value of the type
property of an InvokeEvent object. | InvokeEvent | ||
| LOCATION_CHANGE : String = "locationChange" [static]
The
Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
| MOUSE_LEAVE : String = "mouseLeave" [static]
The
Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
| NETWORK_CHANGE : String = "networkChange" [static]
The
Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
| OPEN : String = "open" [static]
The
Event.OPEN constant defines the value of the type property of an open event object. | Event | |
| PASTE : String = "paste" [static]
The
Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| PREPARING : String = "preparing" [static]
The
Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
| REMOVED : String = "removed" [static]
The
Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
| REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The
Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
| RENDER : String = "render" [static]
The
Event.RENDER constant defines the value of the type property of a render event object. | Event | |
| RESIZE : String = "resize" [static]
The
Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
| SCROLL : String = "scroll" [static]
The
Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | |
| SELECT : String = "select" [static]
The
Event.SELECT constant defines the value of the type property of a select event object. | Event | |
| SELECT_ALL : String = "selectAll" [static]
The
Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
| SOUND_COMPLETE : String = "soundComplete" [static]
The
Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
| STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The
Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | |
| STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The
Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | |
| STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The
Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | |
| SUSPEND : String = "suspend" [static]
The
Event.SUSPEND constant defines the value of the type property of an suspend event object. | Event | |
| TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The
Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
| TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The
Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
| TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The
Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
| TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The
Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object. | Event | |
| TEXTURE_READY : String = "textureReady" [static]
The
Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. | Event | |
| UNLOAD : String = "unload" [static]
The
Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
| USER_IDLE : String = "userIdle" [static]
The
Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
| USER_PRESENT : String = "userPresent" [static]
The
Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | |
| VIDEO_FRAME : String = "videoFrame" [static]
The
Event.VIDEO_FRAME constant defines the value of the
type property of a videoFrame event object. | Event | |
| WORKER_STATE : String = "workerState" [static]
The
Event.WORKER_STATE constant defines the value of the type property of a workerState event object. | Event | |
| arguments | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesarguments:Array [read-only]
| Runtime version: | 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:
| 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 |
| arguments | iOS | Android |
|---|---|---|
InvokeEvent.arguments.length |
3 | 2 |
InvokeEvent.arguments[0] |
url | url |
InvokeEvent.arguments[1] |
null | action id |
InvokeEvent.arguments[2] |
null | NA |
| 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.
public function get arguments():Array
| currentDirectory | property |
currentDirectory:File [read-only]
| Runtime version: | 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 version: | 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.
public function get reason():String
See also
| 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 version: | 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.)
|
See also
| clone | () | method |
public override function clone():Event
| Runtime version: | AIR 1.0 |
Creates a new copy of this event.
ReturnsEvent —
The copy of the event.
|
| INVOKE | constant |
public static const INVOKE:String = "invoke"
| Language version: | ActionScript 3.0 |
| Runtime version: | 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. |
See also
