| 包 | 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() 等）或单一托管对象 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（与创建/更新/删除操作相关，但与填充操作无关）影响的项的唯一标识。 | 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 | |
|
如果此消息是一个更新并且其属性名称列表的长度为零，则返回 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 属性包含的项标识数组应该替换任何现有项。
updateMode | 属性 |
public var updateMode:int| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
指示此更新的状态。远程目标以下列三种更新模式之一向客户端发送更新集合消息：
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, 11:04 AM Z