Packagemx.rpc.events
Classpublic class ResultEvent
InheritanceResultEvent Inheritance AbstractEvent Inheritance MessageEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The event that indicates an RPC operation has successfully returned a result.


Public Properties
 PropertyDefined By
  headers : Object
In certain circumstances, headers may also be returned with a result to provide further context.
ResultEvent
 Inheritedmessage : IMessage
The Message associated with this event.
MessageEvent
  result : Object
[read-only] Result that the RPC call returns.
ResultEvent
  statusCode : int
[read-only] 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.
ResultEvent
 Inheritedtoken : AsyncToken
[read-only] The token that represents the call to the method.
AbstractEvent
Public Methods
 MethodDefined By
  
ResultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, result:Object = null, token:AsyncToken = null, message:IMessage = null)
Creates a new ResultEvent.
ResultEvent
 Inherited
clone():Event
[override] Clones the MessageEvent.
MessageEvent
 Inherited
createEvent(type:String, msg:IMessage):MessageEvent
[static] Utility method to create a new MessageEvent that doesn't bubble and is not cancelable.
MessageEvent
  
toString():String
[override] Returns a string representation of the ResultEvent.
ResultEvent
Public Constants
 ConstantDefined By
 InheritedMESSAGE : String = message
[static] The MESSAGE event type; dispatched upon receipt of a message.
MessageEvent
  RESULT : String = result
[static] The RESULT event type.
ResultEvent
Property Detail
headersproperty
headers:Object

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

In certain circumstances, headers may also be returned with a result to provide further context.


Implementation
    public function get headers():Object
    public function set headers(value:Object):void
resultproperty 
result:Object  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Result that the RPC call returns.


Implementation
    public function get result():Object
statusCodeproperty 
statusCode:int  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

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.


Implementation
    public function get statusCode():int
Constructor Detail
ResultEvent()Constructor
public function ResultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, result:Object = null, token:AsyncToken = null, message:IMessage = null)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Creates a new ResultEvent.

Parameters
type:String — The event type; indicates the action that triggered the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = true) — Specifies whether the behavior associated with the event can be prevented.
 
result:Object (default = null) — Object that holds the actual result of the call.
 
token:AsyncToken (default = null) — Token that represents the call to the method. Used in the asynchronous completion token pattern.
 
message:IMessage (default = null) — Source Message of the result.
Method Detail
toString()method
override public function toString():String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Returns a string representation of the ResultEvent.

Returns
String — String representation of the ResultEvent.
Constant Detail
RESULTConstant
public static const RESULT:String = result

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The RESULT event type.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue, preventDefault() from the associated token's responder.result method will prevent the service or operation from dispatching this event
currentTargetThe 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.
targetThe 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.
resultResult that the RPC call returns.
tokenThe token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.





Mon Dec 24 2012, 01:18 PM +11:00