| 包 | mx.data |
| 类 | public class MessageBatch |
| 继承 | MessageBatch  EventDispatcher Object |
| 实现 | IExternalizable |
| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
DataStore.currentBatch 属性访问的打开的批次。通过数据绑定、createItem()、updateItem() 或 deleteItem() 操作自动检测到的所做的更改（如属性更改）将存储在此批次中。未提交的批次的当前列表存储在 uncommittedBatches 属性中。调用 createBatch 可创建新批次，它将添加到列表末尾。此批次自动成为 currentBatch。您每次可以提交或还原一个批次中的更改集 — 在这两种情况下，该批次都会自动从 uncommittedBatches 列表中删除。
当更改之间存在依赖关系时，您应该按顺序提交和还原更改 — 即提交列表中最早的批次 (uncommittedBatches [0]) 和还原最新的批次 — uncommittedBatches[uncommittedBatches.length - 1]。
当批次中存在任何更改（即 items.length > 0）时，commitRequired 属性设置为 true。items 属性存储此批次中的 DataMessages 集。
通过 properties 属性，您可以在 MessageBatch 中存储自定义信息。批次的保存/复原在您每次使用 saveCache 方法时进行，或者在使用脱机功能且 autoSaveCache 为 true 时自动进行。
每个批次的 batchMessage 属性中还具有与其相关联的 DataMessage。如果您需要与服务器沟通信息（并且要将批处理操作消息发送到服务器），则可以将信息存储在此消息的标头中。
公共属性
隐藏继承的公共属性
显示继承的公共属性| 属性 | 由以下参数定义 | ||
|---|---|---|---|
| batchMessage : DataMessage
这是用于表示发送到服务器的批次的数据消息。 | MessageBatch | ||
| commitRequired : Boolean [只读]
如果此批次中包含任何更改，则为 True。 | MessageBatch | ||
 | constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | |
| properties : Object = null
您可以为该批次设置的用户定义属性的可选集。 | MessageBatch | ||
公共方法
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
构造函数。 | MessageBatch | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。 | EventDispatcher | |
提交该批次中的更改。 | MessageBatch | ||
指示是否存在此特定项的挂起更改。 | MessageBatch | ||
|
将事件调度到事件流中。 | EventDispatcher | |
返回具有给定 ID 的消息。 | MessageBatch | ||
|
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。 | EventDispatcher | |
|
表示对象是否已经定义了指定的属性。 | Object | |
|
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
|
表示指定的属性是否存在、是否可枚举。 | Object | |
此方法可反序列化消息批次。 | MessageBatch | ||
|
从 EventDispatcher 对象中删除侦听器。 | EventDispatcher | |
从此批次删除指定的消息。 | MessageBatch | ||
还原此批次的更改（如果未提供任何项，则还原所有更改；如果提供了项，则仅还原指定项的更改）。 | MessageBatch | ||
还原指定托管集合中所有项的更改。 | MessageBatch | ||
|
设置循环操作动态属性的可用性。 | Object | |
|
返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。 | Object | |
[覆盖]
返回此对象的字符串表示形式。 | MessageBatch | ||
|
返回指定对象的原始值。 | Object | |
|
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。 | EventDispatcher | |
此方法使用以下结构对批次进行序列化：numberOfElements:int - 这是已序列化的元素总数 [重复元素（批次中每条消息一次）]；destination:String - 关联 DataService 的目标；uid:String - 关联项的 UID；message:DataMessage - 关联更改的消息。由于消息当前包含项的副本，因此不需要通过特殊方式对消息进行序列化。 | MessageBatch | ||
公共常量
| 常量 | 由以下参数定义 | ||
|---|---|---|---|
| items : ArrayCollection
此属性存储表示批次中更改的 MessageCacheItem 实例的列表。 | MessageBatch | ||
属性详细信息
batchMessage | 属性 |
public var batchMessage:DataMessage| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
这是用于表示发送到服务器的批次的数据消息。如果需要传递其它事务信息，可以使用此消息的标头与您的服务器代码通信（假定服务器代码实际发送该消息，而不是在客户端上进行转换）。
commitRequired | 属性 |
properties | 属性 |
public var properties:Object = null| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
您可以为该批次设置的用户定义属性的可选集.
构造函数详细信息
MessageBatch | () | 构造函数 |
public function MessageBatch()| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
构造函数。
方法详细信息
commit | () | 方法 |
public function commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
提交该批次中的更改。通常不使用任何参数进行调用。
参数
itemsOrCollections:Array (default = null)itemsOrCollections 参数，每次提交对一个项所做的更改或对一个项集合所做的更改。
| |
cascadeCommit:Boolean (default = false)true 可以确保对关联项的更改也包含在提交中。
|
mx.rpc:AsyncToken — 对标记的 AsyncToken 引用，该标记将在从此服务调度的结果或错误事件中标识此操作。
|
commitRequiredOn | () | 方法 |
getMessage | () | 方法 |
public function getMessage(messageId:String):DataMessage| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
返回具有给定 ID 的消息。如果在此批次中不存在具有给定 ID 的消息，则返回 null。
参数
messageId:String — 所需消息的 ID。
|
DataMessage — 具有给定 ID 的消息。如果在此批次中不存在具有给定 ID 的消息，则返回 null。
|
readExternal | () | 方法 |
public function readExternal(input:IDataInput):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此方法可反序列化消息批次。期望输入字节流具有以下结构：
- numberOfElements:int - 这是序列化的元素的总数 [重复元素（为批次中每个消息重复一次）] t]
- destination:String - 关联的 DataService 的目标
- uid:String - 关联的项的 UID
- message:DataMessage - 关联的更改的消息
参数
input:IDataInput — 输入流
|
removeMessage | () | 方法 |
public function removeMessage(msg:DataMessage):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
从此批次删除指定的消息。
参数
msg:DataMessage — 要删除的消息。
|
revertChanges | () | 方法 |
public function revertChanges(item:IManaged = null):Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
还原此批次的更改（如果未提供任何项，则还原所有更改；如果提供了项，则仅还原指定项的更改）。通常应该只还原最新批次的更改，因为如果还原的较早更改是之后进行的更改的依赖项，系统不能解决或修正依赖关系。
参数
item:IManaged (default = null) |
Boolean — 如果还原成功完成，则为 true。
|
revertChangesForCollection | () | 方法 |
public function revertChangesForCollection(collection:ListCollectionView):Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
还原指定托管集合中所有项的更改。
参数
collection:ListCollectionView — 要还原的集合。
|
Boolean — 如果还原成功完成，则为 true。
|
toString | () | 方法 |
writeExternal | () | 方法 |
public function writeExternal(output:IDataOutput):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此方法按照以下结构序列化批次：
- numberOfElements:int - 这是序列化的元素的总数 [重复元素（为批次中每个消息重复一次）]
- destination:String - 关联的 DataService 的目标
- uid:String - 关联的项的 UID
- message:DataMessage - 关联的更改的消息
由于消息中当前包含项的副本，因此我们无需以特殊方法序列化该消息。
参数
output:IDataOutput — 要将序列化字节写入其中的对象。
|
常量详细信息
items | 常量 |
public const items:ArrayCollection| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此属性存储表示批次中更改的 MessageCacheItem 实例的列表。此项可绑定，因此您可以侦听集合上的 change 事件，以便在发生新更改时得到通知。
Tue Jun 12 2018, 11:04 AM Z