Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
MessageResponder

Package | mx.messaging
Class | public class MessageResponder
Inheritance | MessageResponder flash.net.Responder

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The MessageResponder class handles a successful result or fault from a message destination. For each message that a Channel sends, the Channel creates a MessageResponder to handle the result. Upon a response, the Channel will invoke either the `result()` or `status()` callback on the MessageResponder. MessageResponder subclasses should override these methods to perform any necessary processing. For every response, whether a successful result or an error, the MessageResponder should invoke `acknowledge()` on its agent. If the response was a fault, the MessageResponder should also invoke `fault()` on its agent.

Public Properties

| Property | Defined By
--- | --- | ---
|  | agent : MessageAgent [read-only] Provides access to the MessageAgent that sent the message. | MessageResponder
|  | channel : Channel [read-only] Provides access to the Channel used to send the message. | MessageResponder
|  | message : IMessage Provides access to the sent Message. | MessageResponder

Public Methods

| Method | Defined By
--- | --- | ---
|  | MessageResponder(agent:MessageAgent, message:IMessage, channel:Channel = null) Constructs a MessageResponder to handle the response for the specified Message for the specified MessageAgent. | MessageResponder
|  | result(message:IMessage):void Called by the channel that created this MessageResponder when a response returns from the destination. | MessageResponder
|  | status(message:IMessage):void Called by the channel that created this MessageResponder when a fault response returns from the destination. | MessageResponder

Protected Methods

| Method | Defined By
--- | --- | ---
|  | createRequestTimeoutErrorMessage():ErrorMessage Constructs an ErrorMessage that can be passed to the associated MessageAgent's callbacks upon a request timeout. | MessageResponder
|  | requestTimedOut():void Subclasses must override this method to handle a request timeout and invoke the proper callbacks on the associated MessageAgent. | MessageResponder
|  | resultHandler(message:IMessage):void Subclasses must override this method to perform custom processing of the result and invoke the proper callbacks on the associated MessageAgent. | MessageResponder
|  | statusHandler(message:IMessage):void Subclasses must override this method to perform custom processing of the status and invoke the proper callbacks on the associated MessageAgent. | MessageResponder

Property Detail

agent | property

`agent:MessageAgent` [read-only]

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Provides access to the MessageAgent that sent the message.

Implementation
`public function get agent():MessageAgent`

channel | property |

`channel:Channel` [read-only]

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Provides access to the Channel used to send the message.

Implementation
`public function get channel():Channel`

message | property |

`message:IMessage`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Provides access to the sent Message.

Implementation
`public function get message():IMessage`
`public function set message(value:IMessage):void`
Constructor Detail

MessageResponder | () | Constructor

`public function MessageResponder(agent:MessageAgent, message:IMessage, channel:Channel = null)`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructs a MessageResponder to handle the response for the specified Message for the specified MessageAgent.

Parameters

| `agent:MessageAgent` — The MessageAgent sending the Message.
| `message:IMessage` — The Message being sent.
| `channel:Channel` (default = `null`)`` — The Channel used to send.

Method Detail

createRequestTimeoutErrorMessage | () | method

`protected function createRequestTimeoutErrorMessage():ErrorMessage`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructs an ErrorMessage that can be passed to the associated MessageAgent's callbacks upon a request timeout.

Returns

| `ErrorMessage` — Returns an ErrorMessage that can be passed to the associated MessageAgent's callbacks upon a request timeout.

requestTimedOut | () | method |

`protected function requestTimedOut():void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Subclasses must override this method to handle a request timeout and invoke the proper callbacks on the associated MessageAgent.

result | () | method |

`public final function result(message:IMessage):void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Called by the channel that created this MessageResponder when a response returns from the destination. This method performs core result processing and then invokes the `resultHandler()` method that subclasses may override to perform any necessary custom processing.

Parameters

| `message:IMessage` — The result Message returned by the destination.

resultHandler | () | method |

`protected function resultHandler(message:IMessage):void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Subclasses must override this method to perform custom processing of the result and invoke the proper callbacks on the associated MessageAgent.

Parameters

| `message:IMessage` — The result Message returned by the destination.

status | () | method |

`public final function status(message:IMessage):void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Called by the channel that created this MessageResponder when a fault response returns from the destination. This method performs core result processing and then invokes the `statusHandler()` method that subclasses may override to perform any necessary custom processing.

Parameters

| `message:IMessage` — The fault Message returned by the destination.

statusHandler | () | method |

`protected function statusHandler(message:IMessage):void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Subclasses must override this method to perform custom processing of the status and invoke the proper callbacks on the associated MessageAgent.

Parameters

| `message:IMessage` — The fault Message returned by the destination.

Sun Mar 5 2017, 03:42 PM +11:00