| Pakket | mx.messaging.messages |
| Klasse | public class AbstractMessage |
| Overerving | AbstractMessage  Object |
| Implementatie | IMessage |
| Subklassen | AsyncMessage, HTTPRequestMessage, RemotingMessage |
| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
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.
Overerfde openbare eigenschappen verbergen
Overerfde openbare eigenschappen weergeven| Eigenschap | Gedefinieerd door | ||
|---|---|---|---|
| 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 | ||
 | constructor : Object
Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie. | Object | |
| 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 | ||
| Methode | Gedefinieerd door | ||
|---|---|---|---|
Constructs an instance of an AbstractMessage with an empty body and header. | AbstractMessage | ||
|
Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd. | Object | |
|
Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven. | Object | |
|
Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd. | Object | |
|
Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in. | Object | |
|
Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies. | Object | |
Returns a string representation of the message. | AbstractMessage | ||
|
Retourneert de primitieve waarde van het opgegeven object. | Object | |
| Constante | Gedefinieerd door | ||
|---|---|---|---|
| DESTINATION_CLIENT_ID_HEADER : String = "DSDstClientId" [statisch]
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" [statisch]
Messages are tagged with the endpoint id for the Channel they are sent over. | AbstractMessage | ||
| FLEX_CLIENT_ID_HEADER : String = "DSId" [statisch]
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" [statisch]
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" [statisch]
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" [statisch]
Messages that need to set remote credentials for a destination
carry the Base64 encoded credentials in this header. | AbstractMessage | ||
| REQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout" [statisch]
Messages sent with a defined request timeout use this header. | AbstractMessage | ||
| STATUS_CODE_HEADER : String = "DSStatusCode" [statisch]
A status code can provide context about the nature of a response
message. | AbstractMessage | ||
body | eigenschap |
body:Object| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
The body of a message contains the specific data that needs to be delivered to the remote destination.
Implementatie
public function get body():Object public function set body(value:Object):voidclientId | eigenschap |
clientId:String| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
The clientId indicates which MessageAgent sent the message.
Implementatie
public function get clientId():String public function set clientId(value:String):voiddestination | eigenschap |
destination:String| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
The message destination.
Implementatie
public function get destination():String public function set destination(value:String):voidheaders | eigenschap |
headers:Object| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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.
Implementatie
public function get headers():Object public function set headers(value:Object):voidmessageId | eigenschap |
messageId:String| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
The unique id for the message.
Implementatie
public function get messageId():String public function set messageId(value:String):voidtimestamp | eigenschap |
timestamp:Number| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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.
Implementatie
public function get timestamp():Number public function set timestamp(value:Number):voidVerwante API-elementen
timeToLive | eigenschap |
timeToLive:Number| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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.
Implementatie
public function get timeToLive():Number public function set timeToLive(value:Number):voidAbstractMessage | () | Constructor |
public function AbstractMessage()| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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.
toString | () | methode |
public function toString():String| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Returns a string representation of the message.
Geretourneerde waardeString — String representation of the message.
|
DESTINATION_CLIENT_ID_HEADER | Constante |
public static const DESTINATION_CLIENT_ID_HEADER:String = "DSDstClientId"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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 | Constante |
public static const ENDPOINT_HEADER:String = "DSEndpoint"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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 | Constante |
public static const FLEX_CLIENT_ID_HEADER:String = "DSId"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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 | Constante |
public static const PRIORITY_HEADER:String = "DSPriority"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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 | Constante |
public static const REMOTE_CREDENTIALS_CHARSET_HEADER:String = "DSRemoteCredentialsCharset"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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 | Constante |
public static const REMOTE_CREDENTIALS_HEADER:String = "DSRemoteCredentials"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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 | Constante |
public static const REQUEST_TIMEOUT_HEADER:String = "DSRequestTimeout"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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 | Constante |
public static const STATUS_CODE_HEADER:String = "DSStatusCode"| Taalversie: | ActionScript 3.0 |
| Productversies: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtimeversies: | 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 Jun 13 2018, 11:42 AM Z