套件 | mx.messaging.messages |
類別 | public class AbstractMessage |
繼承 | AbstractMessage Object |
實作 | IMessage |
子類別 | AsyncMessage, HTTPRequestMessage, RemotingMessage |
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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.
屬性 | 定義自 | ||
---|---|---|---|
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
類別物件的參照或是特定物件實體的建構函數。 | 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 |
方法 | 定義自 | ||
---|---|---|---|
Constructs an instance of an AbstractMessage with an empty body and header. | AbstractMessage | ||
指出物件是否有已定義的指定屬性。 | Object | ||
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | ||
指出指定的屬性是否存在,以及是否可列舉。 | Object | ||
為迴圈作業設定動態屬性的可用性。 | Object | ||
傳回代表此物件的字串,根據地區特定慣例進行格式化。 | Object | ||
Returns a string representation of the message. | AbstractMessage | ||
會傳回指定之物件的基本值。 | Object |
常數 | 定義自 | ||
---|---|---|---|
DESTINATION_CLIENT_ID_HEADER : String = "DSDstClientId" [靜態]
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" [靜態]
Messages are tagged with the endpoint id for the Channel they are sent over. | AbstractMessage | ||
FLEX_CLIENT_ID_HEADER : String = "DSId" [靜態]
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" [靜態]
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" [靜態]
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" [靜態]
Messages that need to set remote credentials for a destination
carry the Base64 encoded credentials in this header. | AbstractMessage | ||
REQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout" [靜態]
Messages sent with a defined request timeout use this header. | AbstractMessage | ||
STATUS_CODE_HEADER : String = "DSStatusCode" [靜態]
A status code can provide context about the nature of a response
message. | AbstractMessage |
body | 屬性 |
body:Object
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | Flash Player 9, AIR 1.1 |
The body of a message contains the specific data that needs to be delivered to the remote destination.
實作
public function get body():Object
public function set body(value:Object):void
clientId | 屬性 |
destination | 屬性 |
headers | 屬性 |
headers:Object
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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.
實作
public function get headers():Object
public function set headers(value:Object):void
messageId | 屬性 |
timestamp | 屬性 |
timestamp:Number
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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.
實作
public function get timestamp():Number
public function set timestamp(value:Number):void
相關 API 元素
timeToLive | 屬性 |
timeToLive:Number
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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.
實作
public function get timeToLive():Number
public function set timeToLive(value:Number):void
AbstractMessage | () | 建構函式 |
public function AbstractMessage()
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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 | () | 方法 |
DESTINATION_CLIENT_ID_HEADER | 常數 |
public static const DESTINATION_CLIENT_ID_HEADER:String = "DSDstClientId"
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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 | 常數 |
public static const ENDPOINT_HEADER:String = "DSEndpoint"
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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 | 常數 |
public static const FLEX_CLIENT_ID_HEADER:String = "DSId"
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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 | 常數 |
public static const PRIORITY_HEADER:String = "DSPriority"
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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 | 常數 |
public static const REMOTE_CREDENTIALS_CHARSET_HEADER:String = "DSRemoteCredentialsCharset"
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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 | 常數 |
public static const REMOTE_CREDENTIALS_HEADER:String = "DSRemoteCredentials"
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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 | 常數 |
public static const REQUEST_TIMEOUT_HEADER:String = "DSRequestTimeout"
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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 | 常數 |
public static const STATUS_CODE_HEADER:String = "DSStatusCode"
語言版本: | ActionScript 3.0 |
產品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
執行階段版本: | 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).
Tue Jun 12 2018, 03:47 PM Z