(Preview)
| Package | mx.messaging.events |
| Class | public class MessageAckEvent |
| Inheritance | MessageAckEvent  MessageEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| acknowledgeMessage : AcknowledgeMessage [read-only]
Utility property to get the message property from the MessageEvent as an AcknowledgeMessage. | MessageAckEvent | ||
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| correlation : IMessage
The original Message correlated with this acknowledgement. | MessageAckEvent | ||
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| message : IMessage
The Message associated with this event. | MessageEvent | |
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined 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 | ||
[override]
Clones the MessageAckEvent. | MessageAckEvent | ||
[static]
Utility method to create a new MessageAckEvent that doesn't bubble and
is not cancelable. | MessageAckEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string representation of the MessageAckEvent. | MessageAckEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ACKNOWLEDGE : String = "acknowledge" [static]
The ACKNOWLEDGE event type; dispatched upon receipt of an acknowledgement. | MessageAckEvent | ||
Property Detail
acknowledgeMessage | property |
acknowledgeMessage:AcknowledgeMessage [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 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():AcknowledgeMessagecorrelation | property |
public var correlation:IMessage| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 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, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructs an instance of this event with the specified acknowledge message and original correlated message.
Parameterstype:String — The type for the MessageAckEvent.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
ack:AcknowledgeMessage (default = null) | |
correlation:IMessage (default = null) |
Method Detail
clone | () | method |
createEvent | () | method |
public static function createEvent(ack:AcknowledgeMessage = null, correlation:IMessage = null):MessageAckEvent| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 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) | |
correlation:IMessage (default = null) |
MessageAckEvent — New MessageAckEvent.
|
toString | () | method |
override public function toString():String| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a string representation of the MessageAckEvent.
ReturnsString — String representation of the MessageAckEvent.
|
Constant Detail
ACKNOWLEDGE | Constant |
public static const ACKNOWLEDGE:String = "acknowledge"| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 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. |
Wed Nov 21 2018, 06:34 AM -08:00