Packagecom.developmentarc.framework.utils.events
Classpublic class LocalConnectionEvent
InheritanceLocalConnectionEvent Inheritance flash.events.Event

The LocalConnectionEvent is used by the LocalConnectionManager as a single communication Event to handle the basic events that can occur duing use. This Event type helps consolidate the different events that are dispatched by the Flash LocalConnection.


Public Properties
 PropertyDefined by
  errorID : int
Stores the error ID if provided.
LocalConnectionEvent
  errorMessage : String
Contains the error message that has been generated or received.
LocalConnectionEvent
  status : String
Contains the simple status string.
LocalConnectionEvent
  statusCode : String
Contains the status code for a status message.
LocalConnectionEvent
  statusMessage : String
Stores the sting verison of the status message that contains the instance name that reported the error.
LocalConnectionEvent
Public Methods
 MethodDefined by
  
LocalConnectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
LocalConnectionEvent
Public Constants
 ConstantDefined by
  CONNECTION_ERROR : String = "CONNECTION_ERROR"
[static] Dispatched when the LocalConnectionManager can not connect to the requested application name.
LocalConnectionEvent
  SENT_MESSAGE_ERROR : String = "SENT_MESSAGE_ERROR"
[static] When a message can not be sent properly by the LocalConnectionManager this error is dispatched.
LocalConnectionEvent
  STATUS_MESSAGE : String = "STATUS_MESSAGE"
[static] Dispatched when a status message has been sent.
LocalConnectionEvent
Property detail
errorIDproperty
public var errorID:int

Stores the error ID if provided.

errorMessageproperty 
public var errorMessage:String

Contains the error message that has been generated or received.

statusproperty 
public var status:String

Contains the simple status string.

statusCodeproperty 
public var statusCode:String

Contains the status code for a status message.

statusMessageproperty 
public var statusMessage:String

Stores the sting verison of the status message that contains the instance name that reported the error.

Constructor detail
LocalConnectionEvent()constructor
public function LocalConnectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Constructor. Same as the base Event Class.

Parameters
type:String — The Event Type
 
bubbles:Boolean (default = false) — Defines if the event should bubble.
 
cancelable:Boolean (default = false) — Defines if the event can be cancelled.
Constant detail
CONNECTION_ERRORconstant
public static const CONNECTION_ERROR:String = "CONNECTION_ERROR"

Dispatched when the LocalConnectionManager can not connect to the requested application name. This is usually caused by another application already connected via the provided name.

SENT_MESSAGE_ERRORconstant 
public static const SENT_MESSAGE_ERROR:String = "SENT_MESSAGE_ERROR"

When a message can not be sent properly by the LocalConnectionManager this error is dispatched. If the error is caused by a callback from another application using the LCM protocol then the event will contain details about the cause of the error.

STATUS_MESSAGEconstant 
public static const STATUS_MESSAGE:String = "STATUS_MESSAGE"

Dispatched when a status message has been sent.