Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
AbstractMessage

Package | mx.messaging.messages
Class | public class AbstractMessage
Inheritance | AbstractMessage Object
Implements | IMessage
Subclasses | AsyncMessage, HTTPRequestMessage, RemotingMessage

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Abstract base class for all messages. Messages have two customizable sections; headers and body. The `headers` property provides access to specialized meta information for a specific message instance. The `headers` property is an associative array with the specific header name as the key.

The body of a message contains the instance specific data that needs to be delivered and processed by the remote destination. The `body` is an object and is the payload for a message.

Public Properties

| Property | Defined By
--- | --- | ---
|  | body : Object The body of a message contains the specific data that needs to be delivered to the remote destination. | AbstractMessage
|  | clientId : String The clientId indicates which MessageAgent sent the message. | AbstractMessage
|  | destination : String The message destination. | AbstractMessage
|  | headers : Object The headers of a message are an associative array where the key is the header name and the value is the header value. | AbstractMessage
|  | messageId : String The unique id for the message. | AbstractMessage
|  | timestamp : Number Provides access to the time stamp for the message. | AbstractMessage
|  | timeToLive : Number The time to live value of a message indicates how long the message should be considered valid and deliverable. | AbstractMessage

Public Methods

| Method | Defined By
--- | --- | ---
|  | AbstractMessage() Constructs an instance of an AbstractMessage with an empty body and header. | AbstractMessage
|  | toString():String Returns a string representation of the message. | AbstractMessage

Public Constants

| Constant | Defined By
--- | --- | ---
|  | DESTINATION_CLIENT_ID_HEADER : String = DSDstClientId [static] Messages pushed from the server may arrive in a batch, with messages in the batch potentially targeted to different Consumer instances. | AbstractMessage
|  | ENDPOINT_HEADER : String = DSEndpoint [static] Messages are tagged with the endpoint id for the Channel they are sent over. | AbstractMessage
|  | FLEX_CLIENT_ID_HEADER : String = DSId [static] This header is used to transport the global FlexClient Id value in outbound messages once it has been assigned by the server. | AbstractMessage
|  | PRIORITY_HEADER : String = DSPriority [static] Messages sent by a MessageAgent can have a priority header with a 0-9 numerical value (0 being lowest) and the server can choose to use this numerical value to prioritize messages to clients. | AbstractMessage
|  | REMOTE_CREDENTIALS_CHARSET_HEADER : String = DSRemoteCredentialsCharset [static] Messages that need to set remote credentials for a destination may also need to report the character-set encoding that was used to create the credentials String using this header. | AbstractMessage
|  | REMOTE_CREDENTIALS_HEADER : String = DSRemoteCredentials [static] Messages that need to set remote credentials for a destination carry the Base64 encoded credentials in this header. | AbstractMessage
|  | REQUEST_TIMEOUT_HEADER : String = DSRequestTimeout [static] Messages sent with a defined request timeout use this header. | AbstractMessage
|  | STATUS_CODE_HEADER : String = DSStatusCode [static] A status code can provide context about the nature of a response message. | AbstractMessage

Property Detail

body | property

`body:Object`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The body of a message contains the specific data that needs to be delivered to the remote destination.

Implementation
`public function get body():Object`
`public function set body(value:Object):void`

clientId | property |

`clientId:String`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The clientId indicates which MessageAgent sent the message.

Implementation
`public function get clientId():String`
`public function set clientId(value:String):void`

destination | property |

`destination:String`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The message destination.

Implementation
`public function get destination():String`
`public function set destination(value:String):void`

headers | property |

`headers:Object`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The headers of a message are an associative array where the key is the header name and the value is the header value. This property provides access to the specialized meta information for the specific message instance. Core header names begin with a 'DS' prefix. Custom header names should start with a unique prefix to avoid name collisions.

Implementation
`public function get headers():Object`
`public function set headers(value:Object):void`

messageId | property |

`messageId:String`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The unique id for the message.

Implementation
`public function get messageId():String`
`public function set messageId(value:String):void`

timestamp | property |

`timestamp:Number`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Provides access to the time stamp for the message. A time stamp is the date and time that the message was sent. The time stamp is used for tracking the message through the system, ensuring quality of service levels and providing a mechanism for message expiration.

Implementation
`public function get timestamp():Number`
`public function set timestamp(value:Number):void`

See also

timeToLive

timeToLive | property |

`timeToLive:Number`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The time to live value of a message indicates how long the message should be considered valid and deliverable. This value works in conjunction with the `timestamp` value. Time to live is the number of milliseconds that this message remains valid starting from the specified `timestamp` value. For example, if the `timestamp` value is 04/05/05 1:30:45 PST and the `timeToLive` value is 5000, then this message will expire at 04/05/05 1:30:50 PST. Once a message expires it will not be delivered to any other clients.

Implementation
`public function get timeToLive():Number`
`public function set timeToLive(value:Number):void`
Constructor Detail

AbstractMessage | () | Constructor

`public function AbstractMessage()`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructs an instance of an AbstractMessage with an empty body and header. This message type should not be instantiated or used directly.

Method Detail

toString | () | method

`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 message.

Returns

| `String` — String representation of the message.

Constant Detail

DESTINATION_CLIENT_ID_HEADER | Constant

`public static const DESTINATION_CLIENT_ID_HEADER:String = DSDstClientId`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Messages pushed from the server may arrive in a batch, with messages in the batch potentially targeted to different Consumer instances. Each message will contain this header identifying the Consumer instance that will receive the message.

ENDPOINT_HEADER | Constant |

`public static const ENDPOINT_HEADER:String = DSEndpoint`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Messages are tagged with the endpoint id for the Channel they are sent over. Channels set this value automatically when they send a message.

FLEX_CLIENT_ID_HEADER | Constant |

`public static const FLEX_CLIENT_ID_HEADER:String = DSId`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

This header is used to transport the global FlexClient Id value in outbound messages once it has been assigned by the server.

PRIORITY_HEADER | Constant |

`public static const PRIORITY_HEADER:String = DSPriority`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Messages sent by a MessageAgent can have a priority header with a 0-9 numerical value (0 being lowest) and the server can choose to use this numerical value to prioritize messages to clients.

REMOTE_CREDENTIALS_CHARSET_HEADER | Constant |

`public static const REMOTE_CREDENTIALS_CHARSET_HEADER:String = DSRemoteCredentialsCharset`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Messages that need to set remote credentials for a destination may also need to report the character-set encoding that was used to create the credentials String using this header.

REMOTE_CREDENTIALS_HEADER | Constant |

`public static const REMOTE_CREDENTIALS_HEADER:String = DSRemoteCredentials`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Messages that need to set remote credentials for a destination carry the Base64 encoded credentials in this header.

REQUEST_TIMEOUT_HEADER | Constant |

`public static const REQUEST_TIMEOUT_HEADER:String = DSRequestTimeout`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Messages sent with a defined request timeout use this header. The request timeout value is set on outbound messages by services or channels and the value controls how long the corresponding MessageResponder will wait for an acknowledgement, result or fault response for the message before timing out the request.

STATUS_CODE_HEADER | Constant |

`public static const STATUS_CODE_HEADER:String = DSStatusCode`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

A status code can provide context about the nature of a response message. For example, messages received from an HTTP based channel may need to report the HTTP response status code (if available).

Wed Nov 15 2017, 09:50 AM +01:00