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.
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
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.
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.
|
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.
|
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.
|
Returnsoverride 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.
|
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:
Property | Value |
---|
acknowledgeMessage | Utility property to get
the message property from MessageEvent as an AcknowledgeMessage. |
bubbles | false |
cancelable | false |
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 . |
correlate | The original Message correlated with
this acknowledgement. |
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. |
Mon Jul 9 2012, 07:18 PM -04:00