flash.events.BrowserInvokeEvent - Adobe® Flex® 4 Language Reference (Flex 4)

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.

Public Properties

Hide Inherited Public Properties

Show Inherited 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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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

Hide Inherited Public Methods

Show Inherited 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

Hide Inherited Public Constants

Show Inherited Public Constants

	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_INVOKE : String = "browserInvoke" [static] The BrowserInvokeEvent.BROWSER_INVOKE constant defines the value of the type property of a BrowserInvokeEvent object.	BrowserInvokeEvent
		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
		CLEAR : String = "clear" [static] The Event.CLEAR constant efines 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
		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
		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
		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
		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
		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
		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

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

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

BrowserInvokeEvent

()

Constructor

public function BrowserInvokeEvent(type:String, bubbles:Boolean, cancelable:Boolean, arguments:Array, sandboxType:String, securityDomain:String, isHTTPS:Boolean, isUserEvent:Boolean)

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

The constructor function for the BrowserInvokeEvent class. Generally, developers do not call the BrowserInvokeEvent() constructor directly. Only the runtime should create a BrowserInvokeEvent object.

Parameters

	`type:String` — The type of the event, accessible as `Event.type`.

	`bubbles:Boolean` — Set to `false` for a BrowserInvokeEvent object.

	`cancelable:Boolean` — Set to `false` for a BrowserInvokeEvent object.

	`arguments:Array` — An array of arguments (strings) to pass to the application.

	`sandboxType:String` — The sandbox type for the content in the browser.

	`securityDomain:String` — The security domain for the content in the browser.

	`isHTTPS:Boolean` — Whether the content in the browser uses the HTTPS URL scheme.

	`isUserEvent:Boolean` — Whether the browser invocation was the result of a user event.

Method Detail

clone

()

method

override public function clone():Event

Runtime Versions:

AIR 1.0

Creates a new copy of this event.

Returns

Event — The copy of the event.

Constant Detail

BROWSER_INVOKE

Constant

public static const BROWSER_INVOKE:String = "browserInvoke"

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

The BrowserInvokeEvent.BROWSER_INVOKE constant defines the value of the type property of a BrowserInvokeEvent object.

The BrowserInvokeEvent object has the following properties:

Properties	Values
`arguments`	The array of string arguments passed during this invocation.
`sandBoxType`	A string representing the the sandbox type for the content in the browser (either `Security.APPLICATION`, `Security.LOCAL_TRUSTED`, `Security.LOCAL_WITH_FILE`, `Security.LOCAL_LOCAL_WITH_NETWORK`, or `Security.REMOTE`).
`securityDomain`	A string representing the the security domain for the content in the browser (such as `"www.example.com"`).
`isHTTPS`	Whether the browser content uses the HTTPS URL scheme (`true`) or not (`false`)
`isUserEvent`	Whether the browser invocation resulted from a user event (always `true` in AIR 1.0).
`bubbles`	No.
`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.