Packagecom.pushtechnology.diffusion.events
Classpublic class DiffusionConnectionEvent
InheritanceDiffusionConnectionEvent Inheritance flash.events.Event

This event is dispatched when a connection to Diffusion has been sucessful, or the connection has closed.



Public Methods
 MethodDefined By
  
DiffusionConnectionEvent(serverDetails:ServerDetails, connected:Boolean, clientID:String = null)
DiffusionConnectionEvent
  
clone():Event
[override]
DiffusionConnectionEvent
  
getClientID():String
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
isConnected():Boolean
DiffusionConnectionEvent
  
isReconnected():Boolean
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
setErrorMessage(message:String):void
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
toString():String
[override]
DiffusionConnectionEvent
  
DiffusionConnectionEvent
  
DiffusionConnectionEvent
Public Constants
 ConstantDefined By
  CONNECTION : String = DiffusionConnection
[static]
DiffusionConnectionEvent
Constructor Detail
DiffusionConnectionEvent()Constructor
public function DiffusionConnectionEvent(serverDetails:ServerDetails, connected:Boolean, clientID:String = null)



Parameters
serverDetails:ServerDetails
 
connected:Boolean
 
clientID:String (default = null)
Method Detail
clone()method
override public function clone():Event

Returns
Event
getClientID()method 
public function getClientID():String

Returns
String — clientID, this will only be set if the connection has been sucessful
getErrorMessage()method 
public function getErrorMessage():String

Returns
String — the error message. null if no error reported.
getServerDetails()method 
public function getServerDetails():ServerDetails

Returns
ServerDetails — returns the server details
hasExhaustedServerDetails()method 
public function hasExhaustedServerDetails():Boolean

Returns
Boolean — true if the list of server details has been exhausted
hasLostConnection()method 
public function hasLostConnection():Boolean

Returns
Boolean — true is the connection was lost
isConnected()method 
public function isConnected():Boolean

Returns
Boolean — returns true if the client has connected to Diffusion
isReconnected()method 
public function isReconnected():Boolean

Returns
Boolean — true if the connection was reconnected
setConnectionAborted()method 
public function setConnectionAborted():void

setConnectionLost()method 
public function setConnectionLost():void

setConnectionRejected()method 
public function setConnectionRejected():void

setErrorMessage()method 
public function setErrorMessage(message:String):void

Parameters

message:String

setExhaustedServerDetails()method 
public function setExhaustedServerDetails():void

setReconnected()method 
public function setReconnected():void

toString()method 
override public function toString():String

Returns
String
wasClientAborted()method 
public function wasClientAborted():Boolean

Returns
Boolean — true if Diffusion closed the client, or the client has been blocked
wasConnectionRejected()method 
public function wasConnectionRejected():Boolean

Returns
Boolean — true if the connection was rejected by the Diffusion Server. This may be due to invalid credentials
Constant Detail
CONNECTIONConstant
public static const CONNECTION:String = DiffusionConnection