MessageBatch

套件	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

Represents a group of changes: creates, updates, deletes, and update collection messages. There is always at least one open batch accessible via the 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

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		MessageBatch() Constructor.	MessageBatch
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。	EventDispatcher
		commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken Commits the changes in the batch.	MessageBatch
		commitRequiredOn(item:Object):Boolean Indicates if there are pending changes for this particular item.	MessageBatch
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	EventDispatcher
		getMessage(messageId:String):DataMessage Returns the message with the given id.	MessageBatch
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		readExternal(input:IDataInput):void This method deserializes the message batch.	MessageBatch
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	EventDispatcher
		removeMessage(msg:DataMessage):void Removes the specified message from this batch.	MessageBatch
		revertChanges(item:IManaged = null):Boolean 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
		revertChangesForCollection(collection:ListCollectionView):Boolean Reverts the changes for all items in the specified managed collection.	MessageBatch
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String [覆寫] Returns a String representation of this object.	MessageBatch
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	EventDispatcher
		writeExternal(output:IDataOutput):void 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

事件

按一下以瞭解事件的詳細資訊

隱藏繼承事件

顯示繼承事件

	事件		摘要	定義自
		activate	[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。	EventDispatcher
		deactivate	[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。	EventDispatcher

公用常數

	常數		定義自
		items : ArrayCollection This stores the list of MessageCacheItem instances which represent the changes in the batch.	MessageBatch

屬性詳細資訊

建構函式詳細資料

方法詳細資訊

常數詳細資訊

法律聲明 | 線上隱私權政策

MessageBatch - AS3 ADEP Data Services

套件x

語言元素

附錄

套件 mx.data

batchMessage

commitRequired

properties

commit

commitRequiredOn

getMessage

readExternal

removeMessage

revertChanges

revertChangesForCollection

toString

writeExternal

items

	`itemsOrCollections:Array` (default = `null`) — If you want to commit only some of the changes in the batch, you can commit changes for an item at a time or a collection of items at a time by setting the `itemsOrCollections` parameter.

	`cascadeCommit:Boolean` (default = `false`) — Set to `true` to ensure that changes to associated items are also included in the commit.