| 套件 | 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
property. Changes you make such as property changes detected automatically through
data binding, createItem(), updateItem(), or deleteItem() operations are stored in this
batch. The current list of uncommitted batches is stored in the uncommittedBatches property.
You call createBatch create a new batch which is added to the end of the list. This batch
is automatically made the currentBatch.
You can commit or revert the set of a changes a batch at a time - in both cases, the batch is
automatically removed from the uncommittedBatches list.
When there are dependencies between changes, you should commit and revert changes in order - i.e. commit the oldest batch in the list (uncommittedBatches[0]) and revert the most recent batch - uncommittedBatches[uncommittedBatches.length - 1].
The commitRequired property is set to true when there are any changes in the batch
(i.e. items.length > 0). The items property stores the set of DataMessages in this batch.
You can store custom information in a MessageBatch via the properties
property. Batches are saved/restored each time you use the saveCache method
or automatically when autoSaveCache is true when using the offline feature.
Each batch also has a DataMessage associated with it in the batchMessage property.
If you need to communicate information with the server (and you are sending the batch
message to the server) you can store info in the headers of this message.
隱藏繼承公用屬性
顯示繼承公用屬性| 屬性 | 定義自 | ||
|---|---|---|---|
| batchMessage : DataMessage
This is the data message used to represent the batch being sent to the server. | MessageBatch | ||
| commitRequired : Boolean [唯讀]
True if any changes are in this batch. | MessageBatch | ||
 | constructor : Object
類別物件的參照或是特定物件實體的建構函數。 | Object | |
| properties : Object = null
An optional set of user defined properties you can set for this batch. | MessageBatch | ||
| 方法 | 定義自 | ||
|---|---|---|---|
Constructor. | MessageBatch | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。 | EventDispatcher | |
Commits the changes in the batch. | MessageBatch | ||
Indicates if there are pending changes for this particular item. | MessageBatch | ||
|
會將事件傳送到事件流程。 | EventDispatcher | |
Returns the message with the given id. | MessageBatch | ||
|
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | EventDispatcher | |
|
指出物件是否有已定義的指定屬性。 | Object | |
|
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | |
|
指出指定的屬性是否存在，以及是否可列舉。 | Object | |
This method deserializes the message batch. | MessageBatch | ||
|
會從 EventDispatcher 物件移除偵聽程式。 | EventDispatcher | |
Removes the specified message from this batch. | MessageBatch | ||
Reverts the changes for this batch, either all changes if no item is supplied,
or just the changes for the specified item if it is supplied. | MessageBatch | ||
Reverts the changes for all items in the specified managed collection. | MessageBatch | ||
|
為迴圈作業設定動態屬性的可用性。 | Object | |
|
傳回代表此物件的字串，根據地區特定慣例進行格式化。 | Object | |
[覆寫]
Returns a String representation of this object. | MessageBatch | ||
|
會傳回指定之物件的基本值。 | Object | |
|
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | EventDispatcher | |
This method serializes the batch with the following stucture:
numberOfElements:int - this is the total number of elements serialized
[repeated element (once for every message in the batch)]
destination:String - the destination of the associated DataService
uid:String - the UID of the associated item
message:DataMessage - the message for the associated change
Because the message currently contains a copy of the item we don't have
to serialize the message in a special way. | MessageBatch | ||
| 常數 | 定義自 | ||
|---|---|---|---|
| items : ArrayCollection
This stores the list of MessageCacheItem instances which represent the
changes in the batch. | 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 |
This is the data message used to represent the batch being sent to the server. If you need to pass additional per-transaction information you might use the headers of this message to communicate with your server code (assuming it actually sends the message instead of converting it on the client).
commitRequired | 屬性 |
commitRequired:Boolean [唯讀] | 語言版本: | ActionScript 3.0 |
| 產品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
True if any changes are in this batch. This is a bindable property.
此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 propertyChange 事件。
實作
public function get commitRequired():Booleanproperties | 屬性 |
public var properties:Object = null| 語言版本: | ActionScript 3.0 |
| 產品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
An optional set of user defined properties you can set for this batch.
MessageBatch | () | 建構函式 |
public function MessageBatch()| 語言版本: | ActionScript 3.0 |
| 產品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Constructor.
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 |
Commits the changes in the batch. Typically called with no arguments.
參數
itemsOrCollections:Array (default = null)itemsOrCollections parameter.
| |
cascadeCommit:Boolean (default = false)true to ensure that changes to associated items
are also included in the commit.
|
mx.rpc:AsyncToken — AsyncToken reference to the token that will identify this
operation in a result or fault event dispatched from this service.
|
commitRequiredOn | () | 方法 |
public function commitRequiredOn(item:Object):Boolean| 語言版本: | ActionScript 3.0 |
| 產品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Indicates if there are pending changes for this particular item.
參數
item:Object — The object that might have changes.
|
Boolean — true if the item has pending changes.
|
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 |
Returns the message with the given id. Returns null of no message with the given id exists in this batch.
參數
messageId:String — id of desired message.
|
DataMessage — the message with the given id. Returns null of no message
with the given id exists in this batch.
|
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 |
This method deserializes the message batch. It expects the input byte stream to have the following structure:
- numberOfElements:int - this is the total number of elements serialized [repeated element (once for every message in the batch)] t]
- destination:String - the destination of the associated DataService
- uid:String - the UID of the associated item
- message:DataMessage - the message for the associated change
參數
input:IDataInput — input stream
|
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 |
Removes the specified message from this batch.
參數
msg:DataMessage — message to be removed.
|
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 |
Reverts the changes for this batch, either all changes if no item is supplied, or just the changes for the specified item if it is supplied. You should typically only revert changes in the most recent batch as the system does not resolve or fix dependencies if you revert an older change which was depended upon by a later change.
參數
item:IManaged (default = null) |
Boolean — true if the revert completed successfully.
|
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 |
Reverts the changes for all items in the specified managed collection.
參數
collection:ListCollectionView — The collection to revert.
|
Boolean — true if the revert completed successfully.
|
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 |
This method serializes the batch with the following stucture:
- numberOfElements:int - this is the total number of elements serialized [repeated element (once for every message in the batch)]
- destination:String - the destination of the associated DataService
- uid:String - the UID of the associated item
- message:DataMessage - the message for the associated change
Because the message currently contains a copy of the item we don't have to serialize the message in a special way.
參數
output:IDataOutput — object to write serialized bytes to.
|
items | 常數 |
public const items:ArrayCollection| 語言版本: | ActionScript 3.0 |
| 產品版本: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
This stores the list of MessageCacheItem instances which represent the changes in the batch. It is bindable so you can listen for change events on this collection to be notified of new changes.
Tue Jun 12 2018, 03:47 PM Z