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

Package | mx.messaging.messages
Interface | public interface IMessage
Implementors | AbstractMessage

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

This interface defines the contract for message objects.

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. | IMessage
|  | clientId : String The clientId indicates which client sent the message. | IMessage
|  | destination : String The message destination. | IMessage
|  | headers : Object Provides access to the headers of the message. | IMessage
|  | messageId : String The unique id for the message. | IMessage
|  | timestamp : Number Provides access to the time stamp for the message. | IMessage
|  | timeToLive : Number The time to live value of a message indicates how long the message should be considered valid and deliverable. | IMessage

Public Methods

| Method | Defined By
--- | --- | ---
|  | toString():String This method will return a string representation of the message. | IMessage

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 client 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

Provides access to the headers of the message. The headers of a message are an associative array where the key is the header name. This property provides access to specialized meta information for the specific message instance.

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. The message id can be used to correlate a response to the original request message in request-response messaging scenarios.

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

This method will return a string representation of the message.

Returns

| `String` — String representation of the message.

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