Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flash.events 
BrowserInvokeEvent 
Packageflash.events
Classpublic class BrowserInvokeEvent
InheritanceBrowserInvokeEvent Inheritance Event Inheritance 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.

See also



Public Properties
 PropertyDefined By
  AIR-only arguments : Array
[read-only] An array of arguments (strings) to pass to the application.
BrowserInvokeEvent
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  AIR-only isHTTPS : Boolean
[read-only] Whether the content in the browser uses the HTTPS URL scheme (true) or not (false).
BrowserInvokeEvent
  AIR-only isUserEvent : Boolean
[read-only] Whether the browser invocation resulted in a user event (such as a mouse click).
BrowserInvokeEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  AIR-only sandboxType : String
[read-only] The sandbox type for the content in the browser.
BrowserInvokeEvent
  AIR-only securityDomain : String
[read-only] The security domain for the content in the browser, such as "www.adobe.com" or "www.example.org".
BrowserInvokeEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
AIR-only 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
  
[override] Creates a new copy of this event.
BrowserInvokeEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
 InheritedACTIVATE : String = "activate"
[static] The ACTIVATE constant defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] The Event.ADDED constant defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.
Event
  AIR-only BROWSER_INVOKE : String = "browserInvoke"
[static] The BrowserInvokeEvent.BROWSER_INVOKE constant defines the value of the type property of a BrowserInvokeEvent object.
BrowserInvokeEvent
 InheritedCANCEL : String = "cancel"
[static] The Event.CANCEL constant defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] The Event.CHANGE constant defines the value of the type property of a change event object.
Event
 InheritedCLEAR : String = "clear"
[static] The Event.CLEAR constant efines the value of the type property of a clear event object.
Event
 InheritedCLOSE : String = "close"
[static] The Event.CLOSE constant defines the value of the type property of a close event object.
Event
 InheritedAIR-only CLOSING : String = "closing"
[static] The Event.CLOSING constant defines the value of the type property of a closing event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] The Event.COMPLETE constant defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] The Event.CONNECT constant defines the value of the type property of a connect event object.
Event
 InheritedCOPY : String = "copy"
[static] Defines the value of the type property of a copy event object.
Event
 InheritedCUT : String = "cut"
[static] Defines the value of the type property of a cut event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
Event
 InheritedAIR-only DISPLAYING : String = "displaying"
[static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
Event
 InheritedAIR-only EXITING : String = "exiting"
[static] The Event.EXITING constant defines the value of the type property of an exiting event object.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
Event
 InheritedAIR-only 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
 InheritedAIR-only 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
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] The Event.ID3 constant defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] The Event.INIT constant defines the value of the type property of an init event object.
Event
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] The Event.OPEN constant defines the value of the type property of an open event object.
Event
 InheritedPASTE : String = "paste"
[static] The Event.PASTE constant defines the value of the type property of a paste event object.
Event
 InheritedREMOVED : String = "removed"
[static] The Event.REMOVED constant defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] The Event.RENDER constant defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] The Event.RESIZE constant defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] The Event.SCROLL constant defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] The Event.SELECT constant defines the value of the type property of a select event object.
Event
 InheritedSELECT_ALL : String = "selectAll"
[static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
Event
 InheritedAIR-only 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
 InheritedAIR-only 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
 InheritedAIR-only 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
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] The Event.UNLOAD constant defines the value of the type property of an unload event object.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
Event
 InheritedAIR-only 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
AIR-only 

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
AIR-only 

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
AIR-only 

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
AIR-only 

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

See also

AIR-only 

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
AIR-only 

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

AIR-only 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
AIR-only 

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:

PropertiesValues
argumentsThe array of string arguments passed during this invocation.
sandBoxTypeA 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).
securityDomainA string representing the the security domain for the content in the browser (such as "www.example.com").
isHTTPSWhether the browser content uses the HTTPS URL scheme (true) or not (false)
isUserEventWhether the browser invocation resulted from a user event (always true in AIR 1.0).
bubblesNo.
cancelablefalse; There is no default behavior to cancel.
currentTargetIndicates the object that is actively processing this InvokeEvent object with an event listener.
targetAlways the NativeApplication object.

See also