ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
org.osmf.events 

NetConnectionFactoryEvent  - AS3 OSMF
Packageorg.osmf.events
Classpublic class NetConnectionFactoryEvent
InheritanceNetConnectionFactoryEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

A NetConnectionFactory dispatches a NetConnectionFactoryEvent when it has either succeeded or failed at establishing a NetConnection.


Public Properties
 PropertyDefined By
 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
  mediaError : MediaError
[read-only] Error associated with the creation attempt.
NetConnectionFactoryEvent
  netConnection : NetConnection
[read-only] NetConnection to which this event refers.
NetConnectionFactoryEvent
  resource : URLResource
[read-only] URLResource to which this event refers.
NetConnectionFactoryEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
NetConnectionFactoryEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, netConnection:NetConnection = null, resource:URLResource = null, mediaError:MediaError = null)
Constructor.
NetConnectionFactoryEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CREATION_COMPLETE : String = "creationComplete"
[static] The NetConnectionFactoryEvent.CREATION_COMPLETE constant defines the value of the type property of the event object for a NetConnectionFactoryEvent when the the class has succeeded in establishing a connected NetConnection.
NetConnectionFactoryEvent
  CREATION_ERROR : String = "creationError"
[static] The NetConnectionFactoryEvent.CREATION_ERROR constant defines the value of the type property of the event object for a NetConnectionFactoryEvent when the the class has failed at establishing a connected NetConnection.
NetConnectionFactoryEvent
Property Detail

mediaError

property
mediaError:MediaError  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

Error associated with the creation attempt. Should only be non-null when type is CREATION_ERROR.



Implementation
    public function get mediaError():MediaError

netConnection

property 
netConnection:NetConnection  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

NetConnection to which this event refers.



Implementation
    public function get netConnection():NetConnection

resource

property 
resource:URLResource  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

URLResource to which this event refers.



Implementation
    public function get resource():URLResource
Constructor Detail

NetConnectionFactoryEvent

()Constructor
public function NetConnectionFactoryEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, netConnection:NetConnection = null, resource:URLResource = null, mediaError:MediaError = null)

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Parameters
type:String — Event type.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
netConnection:NetConnection (default = null) — NetConnection to which this event refers.
 
resource:URLResource (default = null) — URLResource to which this event refers.
 
mediaError:MediaError (default = null) — Error associated with the creation attempt. Should only be non-null when type is CREATION_ERROR.
Constant Detail

CREATION_COMPLETE

Constant
public static const CREATION_COMPLETE:String = "creationComplete"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The NetConnectionFactoryEvent.CREATION_COMPLETE constant defines the value of the type property of the event object for a NetConnectionFactoryEvent when the the class has succeeded in establishing a connected NetConnection.

CREATION_ERROR

Constant 
public static const CREATION_ERROR:String = "creationError"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The NetConnectionFactoryEvent.CREATION_ERROR constant defines the value of the type property of the event object for a NetConnectionFactoryEvent when the the class has failed at establishing a connected NetConnection.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy