BrowserInvokeEvent

Package	flash.events
Class	public class BrowserInvokeEvent
Inheritance	BrowserInvokeEvent Event Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

The NativeApplication object of an AIR application dispatches a browserInvoke event when the application is invoked as the result of a SWF file in the browser using the browser invocation feature. The NativeApplication object also dispatches a browserInvoke event when a user instantiates the seamless installation feature in the browser and the SWF file in the browser passes an array to the arguments parameter of the launchApplication() method of the air.swf file. (For details, see "Distributing, installing and running AIR applications" in the AIR developer's guide.)

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

<allowBrowserInvocation>true</allowBrowserInvocation>

If the application is not running, the NativeApplication object dispatches both an InvokeEvent event and a browserInvoke event when launched from the browser. Otherwise, if the application is already running, the NativeApplication object dispatches only a browserInvoke event when launched from the browser.

If the application is launched as the result of a seamless installation from the browser (with the user choosing to launch upon installation), the NativeApplication object dispatches a BrowserInvoke event only if arguments were passed (via the SWF file in the browser passing an array to the arguments parameter of the installApplication() method of the air.swf file). For details, see "Distributing, installing, and running AIR applications" in the AIR developer's guide.

Like the invokeEvent events, browserInvokeEvent events are dispatched by the NativeApplication object (NativeApplication.nativeApplication). To receive browserInvoke events, call the addEventListener() method of the NativeApplication object. When an event listener registers for a browserInvoke event, it will also receive all browserInvoke events that occurred before the registration. These are dispatched after the call to addEventListener() returns, but not necessarily before other browserInvoke events that might be received after registration. This allows you to handle browserInvoke events that have occurred before your initialization code is executed (such as when the application was initially invoked from the browser). Keep in mind that if you add an event listener later in execution (after application initialization), it still receives all browserInvoke events that have occurred since the application started.

Related API Elements

flash.events.InvokeEvent
flash.desktop.NativeApplication

Public Properties

	Property		Defined By
		arguments : Array [read-only] An array of arguments (strings) to pass to the application.	BrowserInvokeEvent
		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
		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
		isHTTPS : Boolean [read-only] Whether the content in the browser uses the HTTPS URL scheme (true) or not (false).	BrowserInvokeEvent
		isUserEvent : Boolean [read-only] Whether the browser invocation resulted in a user event (such as a mouse click).	BrowserInvokeEvent
		sandboxType : String [read-only] The sandbox type for the content in the browser.	BrowserInvokeEvent
		securityDomain : String [read-only] The security domain for the content in the browser, such as "www.adobe.com" or "www.example.org".	BrowserInvokeEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		BrowserInvokeEvent(type:String, bubbles:Boolean, cancelable:Boolean, arguments:Array, sandboxType:String, securityDomain:String, isHTTPS:Boolean, isUserEvent:Boolean) The constructor function for the BrowserInvokeEvent class.	BrowserInvokeEvent
		clone():Event [override] Creates a new copy of this event.	BrowserInvokeEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		BROWSER_INVOKE : String = "browserInvoke" [static] The BrowserInvokeEvent.BROWSER_INVOKE constant defines the value of the type property of a BrowserInvokeEvent object.	BrowserInvokeEvent

Property Detail

arguments

property

arguments:Array [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

An array of arguments (strings) to pass to the application.

Implementation
public function get arguments():Array

isHTTPS

property

isHTTPS:Boolean [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

Whether the content in the browser uses the HTTPS URL scheme (true) or not (false).

Implementation
public function get isHTTPS():Boolean

isUserEvent

property

isUserEvent:Boolean [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

Whether the browser invocation resulted in a user event (such as a mouse click). In AIR 1.0, this is always set to true; AIR requires a user event to initiate a call to the browser invocation feature.

Implementation
public function get isUserEvent():Boolean

sandboxType

property

sandboxType:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

The sandbox type for the content in the browser. This can be set to one of the following values:

Security.APPLICATION — The content is in the application security sandbox.
Security.LOCAL_TRUSTED — The content is in the local-trusted security sandbox.
Security.LOCAL_WITH_FILE — The content is in the local-with-filesystem security sandbox.
Security.LOCAL_WITH_NETWORK — The content is in the local-with-networking security sandbox.
Security.REMOTE — The content is in a remote (network) domain

Implementation
public function get sandboxType():String

Related API Elements

flash.system.Security.sandboxType

securityDomain

property

securityDomain:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

The security domain for the content in the browser, such as "www.adobe.com" or "www.example.org". This property is set only for content in the remote security sandbox (for content from a network domain), not for content in a local or application security sandbox.

Implementation
public function get securityDomain():String

Constructor Detail