The event that indicates an RPC operation has successfully returned a result.
Static variables
staticfinalread onlyRESULT:EventType<ResultEvent> = "result"
The RESULT event type.
The properties of the event object have the following values:
| Property | Value |
|---|---|
| `bubbles` | false |
| `cancelable` | true, preventDefault() from the associated token's responder.result method will prevent the service or operation from dispatching this event |
| `currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`. |
| `message` | The Message associated with this event. |
| `target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event. |
| `result` | Result that the RPC call returns. |
| `token` | The token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern. |
Static methods
Constructor
new(type:String, bubbles:Bool = false, cancelable:Bool = true, ?result:Dynamic, ?token:AsyncToken, ?message:IMessage)
Creates a new ResultEvent.
Parameters:
type | The event type; indicates the action that triggered the event. |
|---|---|
bubbles | Specifies whether the event can bubble up the display list hierarchy. |
cancelable | Specifies whether the behavior associated with the event can be prevented. |
result | Object that holds the actual result of the call. |
token | Token that represents the call to the method. Used in the asynchronous completion token pattern. |
message | Source Message of the result. |
Variables
headers:Dynamic
In certain circumstances, headers may also be returned with a result to provide further context.
read onlystatusCode:Int
If the source message was sent via HTTP, this property provides access to the HTTP response status code (if available), otherwise the value is 0.
Methods
clone():Event
Because this event can be re-dispatched we have to implement clone to return the appropriate type, otherwise we will get just the standard event type.
toString():String
Returns a string representation of the ResultEvent.
Returns:
String representation of the ResultEvent.