| Pakiet | mx.data |
| Klasa | public class MessageBatch |
| Dziedziczenie | MessageBatch  EventDispatcher Object |
| Implementuje | IExternalizable |
| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Ukryj dziedziczone właściwości publiczne
Pokaż dziedziczone właściwości publiczne| Właściwość | Zdefiniowane przez | ||
|---|---|---|---|
| batchMessage : DataMessage
This is the data message used to represent the batch being sent to the server. | MessageBatch | ||
| commitRequired : Boolean [tylko do odczytu]
True if any changes are in this batch. | MessageBatch | ||
 | constructor : Object
Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu. | Object | |
| properties : Object = null
An optional set of user defined properties you can set for this batch. | MessageBatch | ||
| Metoda | Zdefiniowane przez | ||
|---|---|---|---|
Constructor. | MessageBatch | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Rejestruje obiekt detektora zdarzeń w obiekcie EventDispatcher, dzięki czemu detektor będzie otrzymywał powiadomienia o zdarzeniu. | EventDispatcher | |
Commits the changes in the batch. | MessageBatch | ||
Indicates if there are pending changes for this particular item. | MessageBatch | ||
|
Wywołuje zdarzenie, tj. kieruje je do przepływu zdarzeń. | EventDispatcher | |
Returns the message with the given id. | MessageBatch | ||
|
Sprawdza, czy obiekt EventDispatcher zawiera jakiekolwiek detektory zarejestrowane dla konkretnego typu zdarzeń. | EventDispatcher | |
|
Wskazuje, czy dla obiektu zdefiniowano określoną właściwość. | Object | |
|
Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr. | Object | |
|
Wskazuje, czy określona właściwość istnieje i jest przeliczalna. | Object | |
This method deserializes the message batch. | MessageBatch | ||
|
Usuwa detektor z obiektu 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 | ||
|
Ustawia dostępność właściwości dynamicznej używanej w pętlach. | Object | |
|
Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych. | Object | |
[przesłanianie]
Returns a String representation of this object. | MessageBatch | ||
|
Zwraca pierwotną wartość dla określonego obiektu. | Object | |
|
Sprawdza, czy detektor zdarzeń określonego typu jest zarejestrowany w tym obiekcie EventDispatcher lub jego elementach macierzystych. | 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 | ||
| Stała | Zdefiniowane przez | ||
|---|---|---|---|
| items : ArrayCollection
This stores the list of MessageCacheItem instances which represent the
changes in the batch. | MessageBatch | ||
batchMessage | właściwość |
public var batchMessage:DataMessage| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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 | właściwość |
commitRequired:Boolean [tylko do odczytu] | Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
True if any changes are in this batch. This is a bindable property.
Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .
Implementacja
public function get commitRequired():Booleanproperties | właściwość |
public var properties:Object = null| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
An optional set of user defined properties you can set for this batch.
MessageBatch | () | Konstruktor |
public function MessageBatch()| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Constructor.
commit | () | metoda |
public function commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Commits the changes in the batch. Typically called with no arguments.
Parametry
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 | () | metoda |
public function commitRequiredOn(item:Object):Boolean| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Indicates if there are pending changes for this particular item.
Parametry
item:Object — The object that might have changes.
|
Boolean — true if the item has pending changes.
|
getMessage | () | metoda |
public function getMessage(messageId:String):DataMessage| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Parametry
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 | () | metoda |
public function readExternal(input:IDataInput):void| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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
Parametry
input:IDataInput — input stream
|
removeMessage | () | metoda |
public function removeMessage(msg:DataMessage):void| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Removes the specified message from this batch.
Parametry
msg:DataMessage — message to be removed.
|
revertChanges | () | metoda |
public function revertChanges(item:IManaged = null):Boolean| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Parametry
item:IManaged (default = null) |
Boolean — true if the revert completed successfully.
|
revertChangesForCollection | () | metoda |
public function revertChangesForCollection(collection:ListCollectionView):Boolean| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Reverts the changes for all items in the specified managed collection.
Parametry
collection:ListCollectionView — The collection to revert.
|
Boolean — true if the revert completed successfully.
|
toString | () | metoda |
override public function toString():String| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Returns a String representation of this object.
ZwracaString — A String representation of this object.
|
writeExternal | () | metoda |
public function writeExternal(output:IDataOutput):void| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Parametry
output:IDataOutput — object to write serialized bytes to.
|
items | Stała |
public const items:ArrayCollection| Wersja języka: | ActionScript 3.0 |
| Wersja produktu: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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, 12:06 PM Z