| パッケージ | mx.data.messages |
| クラス | public class UpdateCollectionMessage |
| 継承 | UpdateCollectionMessage  DataMessage AsyncMessage AbstractMessage Object |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
IListView.removeItemAt() など）や SMO（Single Managed Object）API（DataService.createItem()）を使用してローカルコレクションが更新されたときに、このメッセージを送信します。リモート宛先は、リモートシーケンスが更新され、アイテムが移動されたときまたはアイテムが削除されて挿入されたときに、このメッセージを送信します。この body プロパティには、コレクションの変更内容だけを示す UpdateCollectionRange オブジェクトのリストが格納されます。コレクションの更新範囲を順に適用すると、指定したコレクションの中でアイテムの順序付けの一貫性が確立されます。
パブリックプロパティ
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
 | body : Object
メッセージの本文には、リモート宛先に配信する必要がある特定のデータが含まれます。 | AbstractMessage | |
| clientId : String
clientId は、メッセージを送信した MessageAgent を示します。 | AbstractMessage | |
| collectionId : Object
更新されたコレクションの一意な識別子です。 | UpdateCollectionMessage | ||
| constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| correlationId : String
メッセージの相関 ID へのアクセスを提供します。 | AsyncMessage | |
| destination : String
メッセージの宛先。 | AbstractMessage | |
| headers : Object
メッセージのヘッダーは、キーがヘッダー名、値がヘッダー値として格納される結合配列です。 | AbstractMessage | |
| identity : Object
DataMessage によって影響を受けるアイテムの固有 ID を定義する ID マップへのアクセスを提供します。この ID マップは作成、更新、削除操作に関連しますが、データ入力操作には関連しません。 | DataMessage | |
| messageId : String
メッセージ固有の ID。 | AbstractMessage | |
| operation : uint
この DataMessage の操作またはコマンドへのアクセスを提供します。 | DataMessage | |
| replace : Boolean
このメッセージのコンテンツでコレクション全体が置き換えられるかどうかを示します。 | UpdateCollectionMessage | ||
| timestamp : Number
メッセージの日時スタンプへのアクセスを提供します。 | AbstractMessage | |
| timeToLive : Number
メッセージの有効期間の値は、メッセージが有効で配信可能であると見なされる期間を示します。 | AbstractMessage | |
| updateMode : int
この更新の状態を示します。 | UpdateCollectionMessage | ||
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
空の UpdateCollectionMessage の新しいインスタンスを作成します。 | UpdateCollectionMessage | ||
| [静的]
指定した操作の説明を設定します。 | DataMessage | |
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
この操作が作成操作であれば、true を返します。 | DataMessage | |
|
このメッセージが更新メッセージであり、なおかつメッセージのプロパティ名リストの長さが 0 であれば、true を返します。 | DataMessage | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
メッセージのストリング表現を返します。 | AbstractMessage | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
パブリック定数
| 定数 | 定義元 | ||
|---|---|---|---|
| CLIENT_UPDATE : int = 0 [静的]
このコレクション更新メッセージがクライアントによって生成されたものであることを示します。 | UpdateCollectionMessage | ||
| SERVER_OVERRIDE : int = 2 [静的]
このコレクション更新メッセージがクライアントによって生成されたものであり、クライアント上で更新を元に戻す必要があるとリモート宛先が判断したことを示します。 | UpdateCollectionMessage | ||
| SERVER_UPDATE : int = 1 [静的]
このコレクション更新メッセージがリモートで生成されたものであり、リモートシーケンスの現在の状態に基づいていることを示します。 | UpdateCollectionMessage | ||
プロパティの詳細
collectionId | プロパティ |
public var collectionId:Object| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
更新されたコレクションの一意な識別子です。DataService.fill() メソッドによって設定されたコレクションの場合、指定したパラメーターの配列が格納されます。
replace | プロパティ |
public var replace:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このメッセージのコンテンツでコレクション全体が置き換えられるかどうかを示します。リモートシーケンスに対する変更の数が転換点に達すると、置き換えメッセージが最適化として生成されます。true の場合、body プロパティには、既存のアイテムをすべて置き換えるアイテム ID の配列が格納されます。
updateMode | プロパティ |
public var updateMode:int| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
この更新の状態を示します。リモート宛先は、次の 3 つのうちいずれかの更新モードでコレクション更新メッセージをクライアントに送信します。
UpdateCollectionMessage.SERVER_UPDATE- クライアントはこのコレクション更新を無条件に適用します。UpdateCollectionMessage.CLIENT_UPDATE- 完了中のクライアントはこのコレクション更新を処理する必要はありません。UpdateCollectionMessage.SERVER_OVERRIDEN- クライアントから送信されたコレクション更新メッセージがリモート宛先で変更されており、完了中のクライアントはこのコレクション更新を取り消す必要があります。
コンストラクターの詳細
UpdateCollectionMessage | () | コンストラクター |
public function UpdateCollectionMessage()| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
空の UpdateCollectionMessage の新しいインスタンスを作成します。
定数の詳細
CLIENT_UPDATE | 定数 |
public static const CLIENT_UPDATE:int = 0| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このコレクション更新メッセージがクライアントによって生成されたものであることを示します。
関連する API エレメント
SERVER_OVERRIDE | 定数 |
public static const SERVER_OVERRIDE:int = 2| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このコレクション更新メッセージがクライアントによって生成されたものであり、クライアント上で更新を元に戻す必要があるとリモート宛先が判断したことを示します。以降のコレクション更新メッセージには、適用する必要のある正しい値が格納され、クライアントのコレクションがリモートのコレクションと一貫した状態に戻されます。
関連する API エレメント
SERVER_UPDATE | 定数 |
public static const SERVER_UPDATE:int = 1| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このコレクション更新メッセージがリモートで生成されたものであり、リモートシーケンスの現在の状態に基づいていることを示します。
関連する API エレメント
Tue Jun 12 2018, 10:34 AM Z