Packagecom.ucompass.ucompos.sdk.events
Classpublic class SDKEvent
InheritanceSDKEvent Inheritance flash.events.Event

This is class that provides a basis for event objects that may be dispatched by the SDKServer, or one of its disciples.



Public Properties
 PropertyDefined By
  data : Object
[read-only] Retrieve the data object that is associated with this EventObject.
SDKEvent
  proxyComponent : IProxyComponent
[read-only] This is the IProxyComponent instance that the SDKEvent applies to.
SDKEvent
  reflection : XML
[read-only] Retrieve the XML description of all the public API methods sponsored by the remote player that initiated this event.
SDKEvent
  transactionId : String
[read-only] Retrieve the transactionId associated with this event.
SDKEvent
Public Methods
 MethodDefined By
  
SDKEvent(type:String, data:Object = null, reflection:XML = null, proxyComponent:IProxyComponent = null, transactionId:String = null)
Constructor receives as input the necessary parameters it needs to instantiate itself.
SDKEvent
  
clone():Event
[override]
SDKEvent
Public Constants
 ConstantDefined By
  AWAKE : String = awake
[static] Generic event type that indicates a server player is awake.
SDKEvent
  COMPLETE : String = complete
[static] Generic event type that indicates a request that was made to a remote player was successfully carried out and data was returned.
SDKEvent
  ERROR : String = error
[static] Indicates there was an error encountered in the request that was made to a remote player and the remote player has returned an ErrorObject.
SDKEvent
  TRANSACTION_COMPLETE : String = transactionComplete
[static] Indicates a transaction across the SDK Tunnel has come to completion.
SDKEvent
  VOID : Object
[static] Suppress return transaction object.
SDKEvent
Property Detail
dataproperty
data:Object  [read-only]

Retrieve the data object that is associated with this EventObject.


Implementation
    public function get data():Object
proxyComponentproperty 
proxyComponent:IProxyComponent  [read-only]

This is the IProxyComponent instance that the SDKEvent applies to.


Implementation
    public function get proxyComponent():IProxyComponent
reflectionproperty 
reflection:XML  [read-only]

Retrieve the XML description of all the public API methods sponsored by the remote player that initiated this event.


Implementation
    public function get reflection():XML
transactionIdproperty 
transactionId:String  [read-only]

Retrieve the transactionId associated with this event.


Implementation
    public function get transactionId():String
Constructor Detail
SDKEvent()Constructor
public function SDKEvent(type:String, data:Object = null, reflection:XML = null, proxyComponent:IProxyComponent = null, transactionId:String = null)

Constructor receives as input the necessary parameters it needs to instantiate itself.

Parameters
type:String — Indicates the type of event
 
data:Object (default = null) — All SDKEvent instances will have data associated that was generated by the remote player that initiated the event. This data will be housed in the data Object.
 
reflection:XML (default = null) — This is an XML description of all the public API methods sponsored by the remote player that initiated this event
 
proxyComponent:IProxyComponent (default = null)
 
transactionId:String (default = null)
Method Detail
clone()method
override public function clone():Event

Returns
Event
Constant Detail
AWAKEConstant
public static const AWAKE:String = awake

Generic event type that indicates a server player is awake.

COMPLETEConstant 
public static const COMPLETE:String = complete

Generic event type that indicates a request that was made to a remote player was successfully carried out and data was returned.

ERRORConstant 
public static const ERROR:String = error

Indicates there was an error encountered in the request that was made to a remote player and the remote player has returned an ErrorObject.

TRANSACTION_COMPLETEConstant 
public static const TRANSACTION_COMPLETE:String = transactionComplete

Indicates a transaction across the SDK Tunnel has come to completion.

VOIDConstant 
public static const VOID:Object

Suppress return transaction object.