NativeApplication  - AS3

The active application window.

If the active desktop window does not belong to this application, or there is no active window, activeWindow is null.

This property is not supported on platforms that do not support the NativeWindow class.

The contents of the application descriptor file for this AIR application.

var appDescriptor:XML = NativeApplication.nativeApplication.applicationDescriptor;
var ns:Namespace = appDescriptor.namespace();
var appCopyright:String = appDescriptor.ns::copyright;
var appVersion:String = appDescriptor.ns::version;
trace("appId:", appCopyright);
trace("version:", appVersion);

The application ID of this application.

The value of this ID is set in the application descriptor file.

Specifies whether the application should automatically terminate when all windows have been closed.

When autoExit is true, which is the default, the application terminates when all windows are closed. Both exiting and exit events are dispatched. When autoExit is false, you must call NativeApplication.nativeApplication.exit() to terminate the application.

This property is not supported on platforms that do not support the NativeWindow class.

Specifies whether the application will run in background or not.

When executeInBackground is false, which is the default, the application remains in suspended state when it goes to background. When executeInBackground is true, the application may execute in background.

Note: With swf-version 21 and its earlier versions, AIR does not support background execution on iOS and Android when render mode direct is set. Due to this restriction, Stage3D based apps cannot execute background tasks like audio playback, location updates, network upload or download, etc. iOS does not allow OpenGLES or rendering of calls in the background. Applications which attempt to make OpenGL calls in the background are terminated by iOS. Android does not restrict applications from either making OpenGLES calls in the background or performing other background tasks like audio playback. With swf-version 22 and later, AIR mobile applications can execute in the background when renderMode direct is set. The AIR iOS runtime results in an ActionScript error (3768 - The Stage3D API may not be used during background execution) if OpenGLES calls are made in the background. However, there are no errors on Android because its native applications are allowed to make OpenGLES calls in the background. For optimal utilization of mobile resource, do not make rendering calls while an application is executing in the background.

This property is supported on AIR iOS and Android.

The application icon.

Use NativeApplication.supportsDockIcon and NativeApplication.supportsSystemTrayIcon to determine the icon class. The type will be one of the subclasses of InteractiveIcon. On Mac^® OS X, NativeApplication.icon is an object of type DockIcon. On Windows^®, NativeApplication.icon is an object of type SystemTrayIcon. When an application icon is not supported, NativeApplication.supportsDockIcon and NativeApplication.supportsSystemTrayIcon are both false and the icon property is null.

The icon object is automatically created, but it is not initialized with image data. On some operating systems, such as Mac OS X, a default image is supplied. On others, such as Windows, the icon is not displayed unless image data is assigned to it. To assign an icon image, set the icon.bitmaps property with an array containing at least one BitmapData object. If more than one BitmapData object is included in the array, then the operating system chooses the image that is closest in size to the icon's display dimensions, scaling the image if necessary.

Related API Elements

The number of seconds that must elapse without user input before a userIdle event is dispatched.

By default, the idle threshold is 300 seconds (5 minutes). The acceptable range of values is from 5 (5 seconds) through 86,400 (1 day), inclusive.

Related API Elements

Specifies whether the application is compiled or interpreted for the desired platform. This API returns (true) only for iOS for targets(ipa-app-store, ipa-test, ipa-debug, ipa-ad-hoc). For other AIR platforms, this API returns (false).

The application menu.

Application menus are supported when NativeApplication.supportsMenu is true. Not all operating systems support application menus. For example, application menus are supported on Mac OS X, but not on Windows or Linux. Assigning a NativeMenu object to this property when NativeApplication.supportsMenu is false is allowed, but does nothing. Be sure to use the NativeApplication.supportsMenu property to determine whether the operating system supports application menus. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

AIR profile support: This feature is not supported on mobile devices or AIR for TV devices. See AIR Profile Support for more information regarding API support across multiple profiles.

Note: On Mac OS X, the menu property references the operating-system-supplied default application menu. You can modify the existing menu structure by adding and removing items and submenus, and by adding event listeners. You can also replace the default menus entirely by assigning a new NativeMenu object to this menu property.

Related API Elements

The singleton instance of the NativeApplication object.

An array containing all the open native windows of this application.

This property is not supported on platforms that do not support the NativeWindow class.

The publisher ID of this application.

The value of this ID is set in the application's publisherid file, which is generated at installation from the certificate chain used to sign the application.

The patch level of the runtime hosting this application.

The version number of the runtime hosting this application.

Specifies whether this application is automatically launched whenever the current user logs in.

AIR profile support: This feature is supported on all desktop operating systems, but is not supported on mobile devices or AIR for TV devices. You can test for support at run time using the NativeApplication.supportsStartAtLogin property. See AIR Profile Support for more information regarding API support across multiple profiles.

The startAtLogin property reflects the status of the operating-system-defined mechanism for designating that an application should start automatically when a user logs in. The user can change the status manually by using the operating system user interface. This property reflects the current status, whether the status was last changed by the AIR application or by the operating system.

Related API Elements

Indicates whether setAsDefaultApplication(), removeAsDefaultApplication(), and isSetAsDefaultApplication() are supported on the current platform.

If true, then the above methods will work as documented. If false, then setAsDefaultApplication() and removeDefaultApplication() do nothing and isSetAsDefaultApplication() returns false.

Related API Elements

Indicates whether AIR supports dock-style application icons on the current operating system.

If true, the NativeApplication.icon property is of type DockIcon.

The Mac OS X user interface provides an application "dock" containing icons for applications that are running or are frequently used.

Be sure to use the NativeApplication.supportsDockIcon property to determine whether the operating system supports application dock icons. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

Related API Elements

Specifies whether the current operating system supports a global application menu bar.

When true, the NativeApplication.menu property can be used to define (or access) a native application menu.

Be sure to use the NativeApplication.supportsMenu property to determine whether the operating system supports the application menu bar. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

Related API Elements

Indicates whether startAtLogin is supported on the current platform.

If true, then startAtLogin works as documented. If false, then startAtLogin has no effect.

Related API Elements

Specifies whether AIR supports system tray icons on the current operating system.

If true, the NativeApplication.icon property is of type SystemTrayIcon.

The Windows user interface provides the "system tray" region of the task bar, officially called the Notification Area, in which application icons can be displayed. No default icon is shown. You must set the bitmaps array of the icon object to display an icon.

Be sure to use the NativeApplication.supportsSystemTrayIcon property to determine whether the operating system supports system tray icons. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

Related API Elements

Provides a way for applications to prevent the user interface from going into "idle" mode.

A value from the SystemIdleMode class to influence the host system's idle mode behavior. This property is only effective for the application with input focus and can only be accessed from content running in the application sandbox.

AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices. See AIR Profile Support for more information regarding API support across multiple profiles.

Related API Elements

The time, in seconds, since the last user input.

Related API Elements

Activates this application.

This method is not supported on platforms that do not support the NativeWindow class.

Under some circumstances determined by the operating system, this method does not activate an application. Most operating systems restrict the ability of an application to activate itself to prevent it from accidentally or maliciously making it impossible for a user to use other applications.

If the operating system allows activation, then the specified window is activated and brought to the desktop foreground; that is, in front of the windows of other applications. (If the window parameter is null, then any visible window of this application is activated.)

The activate() method has no effect if the application has no visible windows.

The activate operation is synchronous.

Parameters

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeListener(). Then you can register the listener again with the new priority level.

Keep in mind that after the listener is registered, subsequent calls to addEventListener() with a different type or useCapture value result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

If you no longer need an event listener, remove it by calling removeEventListener(), or memory problems could result. Event listeners are not automatically removed from memory because the garbage collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference parameter is set to true).

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is being processed on this node, the event listener is not triggered during the current phase but can be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless registered again for future processing).

Parameters

function(evt:Event):void

Invokes an internal delete command on the focused display object.

This function call is ignored if the focused object does not implement the command. Only display objects descending from the TextField or HTMLLoader classes currently implement this command.

Note: The clear() command deletes selected text. If nothing is selected, it does not clear all text.

Invokes an internal copy command on the focused display object.

This function call is ignored if the component does not implement the command. Only display objects descending from the TextField or HTMLLoader classes currently implement this command.

Invokes an internal cut command on the focused display object.

This function call is ignored if the component does not implement the command. Only display objects descending from the TextField or HTMLLoader classes currently implement this commands.

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.

Parameters

Terminates this application.

The call to the exit() method will return; the shutdown sequence does not begin until the currently executing code (such as a current event handler) has completed. Pending asynchronous operations are canceled and may or may not complete.

Note that an exiting event is not dispatched. If an exiting event is required by application logic, call NativeApplication.nativeApplication.dispatchEvent(), passing in an Event object of type exiting. For any open windows, NativeWindow objects do dispatch closing and close events. Calling the preventDefault() method of closing event object prevents the application from exiting.

Note: This method is not supported on the iOS operating system.

Parameters

Gets the default application for opening files with the specified extension.

Note: This method can only be used with file types declared in the fileTypes statement of the application descriptor.

This method is not applicable for AIR for TV devices. If you call it with a file type declared in the application descriptor, it returns null.

Parameters

Related API Elements

Specifies whether this application is currently the default application for opening files with the specified extension.

AIR profile support: This feature is supported on all desktop operating systems, but is not supported on mobile devices or AIR for TV devices. You can test for support at run time using the NativeApplication.supportsDefaultApplication property. See AIR Profile Support for more information regarding API support across multiple profiles.

Parameters

Related API Elements

Invokes an internal paste command on the focused display object.

This function call is ignored if the component does not implement the command. Only display objects descending from the TextField or HTMLLoader classes currently implement this command.

Removes this application as the default for opening files with the specified extension.

Note: This method can only be used with file types listed in the fileTypes statement in the application descriptor.

Parameters

Related API Elements

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

Invokes an internal selectAll command on the focused display object.

This function call is ignored if the component does not implement the command. Only display objects descending from the TextField or HTMLLoader classes currently implement this command.

Sets this application as the default application for opening files with the specified extension.

Note: This method can only be used with file types declared in the fileTypes statement in the application descriptor.

Parameters

Related API Elements

Dispatched when this application becomes the active desktop application.

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

This event has the following properties:

Dispatched when an application is invoked by a SWF file running in the user's browser.

Browser invocation is permitted only if an application specifies the following in the application descriptor file:

<allowBrowserInvocation>true</allowBrowserInvocation>

Dispatched when the desktop focus is switched to a different application.

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

This event has the following properties:

Dispatched when the application exit sequence is started.

The exiting event is dispatched when application exit is initiated by the operating system; for example, when a user issues the Cmd-Q key sequence on Mac OS X, or when the autoExit property of the NativeApplication object is true and the last application window is closed. Canceling this event prevents the application from exiting.

AIR for TV devices never dispatch the exiting event.

Note: Calling the NativeApplication exit() method does not cause an exiting event to be dispatched. To warn components of an impending exit, dispatch the exiting event before calling exit().

This event has the following properties:

Dispatched when an application is invoked.

When an application is invoked a second time, another instance of the application is not started. Instead, the first instance receives an additional invoke event. It is the responsibility of the application to handle subsequent invoke events appropriately.

Note: All invoke events are queued. When a listener for this event is registered, it receives all events in the queue as well as any new events. Queued events may be delivered before or after any new invoke events.

The InvokeEvent object has the following properties:

Dispatched when the user presses a key. The NativeApplication instance provides this event to support keyboard accelerators. This keyboard event is dispatched first to the NativeApplication. Canceling this event also cancels NativeWindow menu accelerators. This event occurs before the keyUp event.

This event has the following properties:

Related API Elements

Dispatched when the user releases a key. The NativeApplication instance provides this event to support keyboard accelerators. This keyboard event is dispatched first to the NativeApplication. Canceling this event has no effects on other objects (such as NativeWindow menu accelerators). This event occurs after a keyDown event.

This event has the following properties:

Related API Elements

Dispatched when either a new network connection becomes available or an existing network connection is lost.

A networkChange event does not necessarily mean that the host computer has gone online or offline; it may just be transitioning from one type of connection to another. Applications can use this event to help optimize the task of monitoring remote resource availability. The dispatch of a networkChange event is often a good time to verify the availability of any remote resources.

Notes:

• There may be a short delay between a network change and the delivery of this event.
• On Android, the NativeApplication object may dispatch more than one networkChange event for each change in a network connection.

This event has the following properties:

Dispatched when the application is about to be suspended by the operating system.

This event has the following properties:

Dispatched when the user has been idle.

Specify the period of time for which a user must be idle before this event is dispatched using the idleThreshold property. The amount of time that the user has been idle can be determined from the timeSinceLastUserInput property.

Note: This event is not dispatched on mobile devices or AIR for TV devices.

This event has the following properties:

Related API Elements

Dispatched when the operating system detects mouse or keyboard activity after an idle period.

Note: This event is not dispatched on mobile devices or AIR for TV devices.

The period of time that is considered idle is configurable with the idleThreshold property. The amount of time that the user has been idle can be determined from the timeSinceLastUserInput property.

This event has the following properties:

Related API Elements