(BlazeDS のみ)
パッケージmx.messaging.messages
クラスpublic class AbstractMessage
継承AbstractMessage Inheritance Object
実装 IMessage
サブクラス AsyncMessage, HTTPRequestMessage, RemotingMessage

すべてのメッセージの抽象基本クラス。 メッセージには、2 つのカスタマイズ可能なセクション(ヘッダーおよび本文)があります。 headers プロパティは、特定のメッセージインスタンスの特化したメタ情報へのアクセスを提供します。 headers プロパティは、固有のヘッダー名をキーとして持つ結合配列です。

メッセージの本文には、リモート宛先によって配信および処理される必要があるインスタンス固有のデータが含まれます。 body はオブジェクトで、メッセージのペイロードとなります。



パブリックプロパティ
 プロパティ定義元
  body : Object
メッセージの本文には、リモート宛先に配信する必要がある特定のデータが含まれます。
AbstractMessage
  clientId : String
clientId は、メッセージを送信した MessageAgent を示します。
AbstractMessage
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  destination : String
メッセージの宛先。
AbstractMessage
  headers : Object
メッセージのヘッダーは、キーがヘッダー名、値がヘッダー値として格納される結合配列です。
AbstractMessage
  messageId : String
メッセージ固有の ID。
AbstractMessage
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  timestamp : Number
メッセージの日時スタンプへのアクセスを提供します。
AbstractMessage
  timeToLive : Number
メッセージの有効期間の値は、メッセージが有効で配信可能であると見なされる期間を示します。
AbstractMessage
パブリックメソッド
 メソッド定義元
  
本文とヘッダーが空の AbstractMessage インスタンスを作成します。
AbstractMessage
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
メッセージのストリング表現を返します。
AbstractMessage
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
パブリック定数
 定数定義元
  DESTINATION_CLIENT_ID_HEADER : String = "DSDstClientId"
[静的] サーバーからプッシュされたメッセージがバッチとして到着したとき、そのバッチ内のメッセージが複数の異なるコンシューマインスタンスをターゲットにしている可能性があります。
AbstractMessage
  ENDPOINT_HEADER : String = "DSEndpoint"
[静的] メッセージには、メッセージが送信されるチャンネルのエンドポイント ID のタグが付与されます。
AbstractMessage
  FLEX_CLIENT_ID_HEADER : String = "DSId"
[静的] サーバーによってグローバル FlexClient の ID 値が出力メッセージに割り当てられると、このヘッダーはその値の伝達に使用されます。
AbstractMessage
  PRIORITY_HEADER : String = "DSPriority"
[静的] MessageAgent が送信するメッセージには数値が 0 ~ 9(0 が最小)の優先度ヘッダーがある場合があります。サーバーはこの数値を使用して、クライアントへのメッセージに優先度を設定できます。
AbstractMessage
  REMOTE_CREDENTIALS_CHARSET_HEADER : String = "DSRemoteCredentialsCharset"
[静的] 宛先のリモート証明書を設定する必要があるメッセージは、このヘッダを使用して、資格情報ストリングの作成に使用された文字セットエンコーディングも報告する必要があります。
AbstractMessage
  REMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials"
[静的] 宛先のリモート証明書を設定する必要があるメッセージは、このヘッダー内に Base64 エンコードされた資格情報を保持します。
AbstractMessage
  REQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout"
[静的] このヘッダーは、要求タイムアウトを定義して送信されるメッセージに使用されます。
AbstractMessage
  STATUS_CODE_HEADER : String = "DSStatusCode"
[静的] ステータスコードは、応答メッセージの特徴に関するコンテキストを提供できます。
AbstractMessage
プロパティの詳細
bodyプロパティ
body:Object

メッセージの本文には、リモート宛先に配信する必要がある特定のデータが含まれます。



実装
    public function get body():Object
    public function set body(value:Object):void
clientIdプロパティ 
clientId:String

clientId は、メッセージを送信した MessageAgent を示します。



実装
    public function get clientId():String
    public function set clientId(value:String):void
destinationプロパティ 
destination:String

メッセージの宛先。



実装
    public function get destination():String
    public function set destination(value:String):void
headersプロパティ 
headers:Object

メッセージのヘッダーは、キーがヘッダー名、値がヘッダー値として格納される結合配列です。 このプロパティは、特定のメッセージインスタンスの特化したメタ情報へのアクセスを提供します。 コアヘッダー名は 'DS' の接頭辞で始まります。 カスタムのヘッダー名は、名前の競合を避けるため、固有の接頭辞で始める必要があります。



実装
    public function get headers():Object
    public function set headers(value:Object):void
messageIdプロパティ 
messageId:String

メッセージ固有の ID。



実装
    public function get messageId():String
    public function set messageId(value:String):void
timestampプロパティ 
timestamp:Number

メッセージの日時スタンプへのアクセスを提供します。 日時スタンプは、メッセージが送信された日付と時間です。 日時スタンプは、システム内でメッセージを追跡し、サービスレベルの品質の保証およびメッセージの有効期限のメカニズムを提供するために使用されます。



実装
    public function get timestamp():Number
    public function set timestamp(value:Number):void

関連項目

timeToLiveプロパティ 
timeToLive:Number

メッセージの有効期間の値は、メッセージが有効で配信可能であると見なされる期間を示します。 この値は、timestamp 値と組み合わせて使用します。 有効期間は、このメッセージが有効な状態を維持する、指定された timestamp 値からのミリ秒数です。 例えば、timestamp 値が 04/05/05 1:30:45 PST で timeToLive 値が 5000 の場合、このメッセージは 04/05/05 1:30:50 PST で期限切れになります。 有効期限が切れたメッセージは、他のどのクライアントにも配信されません。



実装
    public function get timeToLive():Number
    public function set timeToLive(value:Number):void
コンストラクタの詳細
AbstractMessage()コンストラクタ
public function AbstractMessage()

本文とヘッダーが空の AbstractMessage インスタンスを作成します。 このメッセージタイプは、直接インスタンス化したり使用したりしないでください。

メソッドの詳細
toString()メソッド
public function toString():String

メッセージのストリング表現を返します。

戻り値
String — メッセージのストリング表現です。
定数の詳細
DESTINATION_CLIENT_ID_HEADER定数
public static const DESTINATION_CLIENT_ID_HEADER:String = "DSDstClientId"

サーバーからプッシュされたメッセージがバッチとして到着したとき、そのバッチ内のメッセージが複数の異なるコンシューマインスタンスをターゲットにしている可能性があります。 各メッセージにはこのヘッダーが含まれており、メッセージを受信するコンシューマインスタンスが識別されます。

ENDPOINT_HEADER定数 
public static const ENDPOINT_HEADER:String = "DSEndpoint"

メッセージには、メッセージが送信されるチャンネルのエンドポイント ID のタグが付与されます。 各チャンネルではメッセージの送信時にこの値が自動的に設定されます。

FLEX_CLIENT_ID_HEADER定数 
public static const FLEX_CLIENT_ID_HEADER:String = "DSId"

サーバーによってグローバル FlexClient の ID 値が出力メッセージに割り当てられると、このヘッダーはその値の伝達に使用されます。

PRIORITY_HEADER定数 
public static const PRIORITY_HEADER:String = "DSPriority"

MessageAgent が送信するメッセージには数値が 0 ~ 9(0 が最小)の優先度ヘッダーがある場合があります。サーバーはこの数値を使用して、クライアントへのメッセージに優先度を設定できます。

REMOTE_CREDENTIALS_CHARSET_HEADER定数 
public static const REMOTE_CREDENTIALS_CHARSET_HEADER:String = "DSRemoteCredentialsCharset"

宛先のリモート証明書を設定する必要があるメッセージは、このヘッダを使用して、資格情報ストリングの作成に使用された文字セットエンコーディングも報告する必要があります。

REMOTE_CREDENTIALS_HEADER定数 
public static const REMOTE_CREDENTIALS_HEADER:String = "DSRemoteCredentials"

宛先のリモート証明書を設定する必要があるメッセージは、このヘッダー内に Base64 エンコードされた資格情報を保持します。

REQUEST_TIMEOUT_HEADER定数 
public static const REQUEST_TIMEOUT_HEADER:String = "DSRequestTimeout"

このヘッダーは、要求タイムアウトを定義して送信されるメッセージに使用されます。 要求タイムアウトの値はサービスまたはチャンネルによって出力メッセージに設定され、対応する MessageResponder が要求をタイムアウトするまでに承認、結果、またはフォルトの応答を待つ時間を制御します。

STATUS_CODE_HEADER定数 
public static const STATUS_CODE_HEADER:String = "DSStatusCode"

ステータスコードは、応答メッセージの特徴に関するコンテキストを提供できます。例えば、HTTP ベースのチャネルから受信したメッセージは、HTTP 応答ステータスコード(使用できる場合)を報告する必要があることがあります。





 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/messaging/messages/AbstractMessage.html