The MessageAckEvent class is used to propagate acknowledge messages within the messaging system.
Static variables
staticfinalread onlyACKNOWLEDGE:String = "acknowledge"
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. |
Static methods
staticcreateEvent(?ack:AcknowledgeMessage, ?correlation:IMessage):MessageAckEvent
Utility method to create a new MessageAckEvent that doesn't bubble and is not cancelable.
Parameters:
ack | The AcknowledgeMessage this event should dispatch. |
|---|---|
correlation | The Message correlated with this acknowledgement. |
Returns:
New MessageAckEvent.
Constructor
new(type:String, bubbles:Bool = false, cancelable:Bool = false, ?ack:AcknowledgeMessage, ?correlation:IMessage)
Constructs an instance of this event with the specified acknowledge message and original correlated message.
Parameters:
type | The type for the MessageAckEvent. |
|---|---|
bubbles | Specifies whether the event can bubble up the display list hierarchy. |
cancelable | Indicates whether the behavior associated with the event can be prevented. |
ack | The AcknowledgeMessage this event should dispatch. |
correlation | The message correlated with this acknowledgement. |
Variables
read onlyacknowledgeMessage:AcknowledgeMessage
Utility property to get the message property from the MessageEvent as an AcknowledgeMessage.
Methods
toString():String
Returns a string representation of the MessageAckEvent.
Returns:
String representation of the MessageAckEvent.