User Guide

316 Chapter 6: Components Dictionary

Description

Property; returns a delta packet that contains all of the change operations made to the dataSet

collection and its items. This property is

null until DataSet.applyUpdates() is called on

dataSet.

When

DataSet.applyUpdates() is called, a transaction ID is assigned to the delta packet. This

transaction ID is used to identify the delta packet on an update round trip from the server and

back to the client. Any subsequent assignment to the

deltaPacket property by a delta packet

with a matching transaction ID is assumed to be the server’s response to the changes previously

sent. A delta packet with a matching ID is used to update the collection and report errors

specified within the packet.

Errors or server messages are reported to listeners of the

DataSet.resolveDelta event. Note that

the

DataSet.logChanges settings are ignored when a delta packet with a matching ID is

assigned to

DataSet.deltaPacket. A delta packet without a matching transaction ID updates

the collection, as if the DataSet API were used directly. This may create additional delta entries,

depending on the current

DataSet.logChanges setting of dataSet and the delta packet.

DataSetError exception is thrown if a delta packet is assigned with a matching transaction ID

and one of the items in the newly assigned delta packet cannot be found in the original delta

packet.