Packagemx.messaging.events
Classpublic class MessageAckEvent
InheritanceMessageAckEvent Inheritance MessageEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

The MessageAckEvent class is used to propagate acknowledge messages within the messaging system.


Public Properties
 PropertyDefined By
  acknowledgeMessage : AcknowledgeMessage
[read-only] Utility property to get the message property from the MessageEvent as an AcknowledgeMessage.
MessageAckEvent
  correlation : IMessage
The original Message correlated with this acknowledgement.
MessageAckEvent
 Inheritedmessage : IMessage
The Message associated with this event.
MessageEvent
Public Methods
 MethodDefined By
  
MessageAckEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, ack:AcknowledgeMessage = null, correlation:IMessage = null)
Constructs an instance of this event with the specified acknowledge message and original correlated message.
MessageAckEvent
  
clone():Event
[override] Clones the MessageAckEvent.
MessageAckEvent
  
createEvent(ack:AcknowledgeMessage = null, correlation:IMessage = null):MessageAckEvent
[static] Utility method to create a new MessageAckEvent that doesn't bubble and is not cancelable.
MessageAckEvent
  
toString():String
[override] Returns a string representation of the MessageAckEvent.
MessageAckEvent
Public Constants
 ConstantDefined By
  ACKNOWLEDGE : String = acknowledge
[static] The ACKNOWLEDGE event type; dispatched upon receipt of an acknowledgement.
MessageAckEvent
 InheritedMESSAGE : String = message
[static] The MESSAGE event type; dispatched upon receipt of a message.
MessageEvent
 InheritedRESULT : String = result
[static] The RESULT event type; dispatched when an RPC agent receives a result from a remote service destination.
MessageEvent
Property Detail
acknowledgeMessageproperty
acknowledgeMessage:AcknowledgeMessage  [read-only]

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

Utility property to get the message property from the MessageEvent as an AcknowledgeMessage.


Implementation
    public function get acknowledgeMessage():AcknowledgeMessage
correlationproperty 
public var correlation:IMessage

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

The original Message correlated with this acknowledgement.

Constructor Detail
MessageAckEvent()Constructor
public function MessageAckEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, ack:AcknowledgeMessage = null, correlation:IMessage = null)

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructs an instance of this event with the specified acknowledge message and original correlated message.

Parameters
type:String — The type for the MessageAckEvent.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Indicates whether the behavior associated with the event can be prevented.
 
ack:AcknowledgeMessage (default = null) — The AcknowledgeMessage this event should dispatch.
 
correlation:IMessage (default = null) — The message correlated with this acknowledgement.
Method Detail
clone()method
override public function clone():Event

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

Clones the MessageAckEvent.

Returns
Event — Copy of this MessageAckEvent.
createEvent()method 
public static function createEvent(ack:AcknowledgeMessage = null, correlation:IMessage = null):MessageAckEvent

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

Utility method to create a new MessageAckEvent that doesn't bubble and is not cancelable.

Parameters

ack:AcknowledgeMessage (default = null) — The AcknowledgeMessage this event should dispatch.
 
correlation:IMessage (default = null) — The Message correlated with this acknowledgement.

Returns
MessageAckEvent — New MessageAckEvent.
toString()method 
override public function toString():String

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

Returns a string representation of the MessageAckEvent.

Returns
String — String representation of the MessageAckEvent.
Constant Detail
ACKNOWLEDGEConstant
public static const ACKNOWLEDGE:String = acknowledge

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

The ACKNOWLEDGE event type; dispatched upon receipt of an acknowledgement.

The value of this constant is "acknowledge".

The properties of the event object have the following values:

PropertyValue
acknowledgeMessage Utility property to get the message property from MessageEvent as an AcknowledgeMessage.
bubblesfalse
cancelablefalse
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.
correlate The original Message correlated with this acknowledgement.
messageThe 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.





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