| Package | com.ucompass.ucompos.sdk.events |
| Class | public class SDKEvent |
| Inheritance | SDKEvent  flash.events.Event |
SDKServer, or one of its disciples.
| Property | Defined 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 | ||
| Method | Defined 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 | ||
| Constant | Defined 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 | ||
| data | property |
data:Object [read-only]
Retrieve the data object that is associated with this EventObject.
public function get data():Object| proxyComponent | property |
proxyComponent:IProxyComponent [read-only]
This is the IProxyComponent instance that the SDKEvent applies to.
public function get proxyComponent():IProxyComponent| reflection | property |
reflection:XML [read-only] Retrieve the XML description of all the public API methods sponsored by the remote player that initiated this event.
public function get reflection():XML| transactionId | property |
transactionId:String [read-only]
Retrieve the transactionId associated with this event.
public function get transactionId():String| 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.
Parameterstype:String — Indicates the type of event
| |
data:Object (default = null)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) | |
proxyComponent:IProxyComponent (default = null) | |
transactionId:String (default = null) |
| clone | () | method |
override public function clone():EventReturnsEvent |
| AWAKE | Constant |
public static const AWAKE:String = awakeGeneric event type that indicates a server player is awake.
| COMPLETE | Constant |
public static const COMPLETE:String = completeGeneric event type that indicates a request that was made to a remote player was successfully carried out and data was returned.
| ERROR | Constant |
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_COMPLETE | Constant |
public static const TRANSACTION_COMPLETE:String = transactionCompleteIndicates a transaction across the SDK Tunnel has come to completion.
| VOID | Constant |
public static const VOID:ObjectSuppress return transaction object.