| Package | mx.data.messages |
| Class | public class DataMessage |
| Inheritance | DataMessage AsyncMessage AbstractMessage Object |
| Subclasses | DataAssociationMessage, UpdateCollectionMessage |
| Property | Defined by | ||
|---|---|---|---|
![]() | body : Object
The body of a message contains the specific data that needs to be
delivered to the remote destination.
| AbstractMessage | |
![]() | clientId : String
The clientId indicates which MessageAgent sent the message.
| AbstractMessage | |
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
![]() | correlationId : String
Provides access to the correlation id of the message.
| AsyncMessage | |
![]() | destination : String
The message destination.
| AbstractMessage | |
![]() | headers : Object
The headers of a message are an associative array where the key is the
header name and the value is the header value.
| AbstractMessage | |
| identity : Object
Provides access to the identity map which defines the unique
identity of the item affected by this DataMessage (relevant for
create/update/delete but not fill operations).
| DataMessage | ||
![]() | messageId : String
The unique id for the message.
| AbstractMessage | |
| operation : uint
Provides access to the operation/command of this DataMessage.
| DataMessage | ||
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
![]() | timestamp : Number
Provides access to the time stamp for the message.
| AbstractMessage | |
![]() | timeToLive : Number
The time to live value of a message indicates how long the message
should be considered valid and deliverable.
| AbstractMessage | |
| Method | Defined by | ||
|---|---|---|---|
|
Creates a new instance of an empty DataMessage.
| DataMessage | ||
|
[static]
Provides a description of the operation specified.
| DataMessage | ||
![]() |
Indicates whether an object has a specified property defined.
| Object | |
|
Returns
true if this is a create operation. | DataMessage | ||
|
Returns
true if this message is both an update and its list
of property names has a length of zero. | DataMessage | ||
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
![]() |
Indicates whether the specified property exists and is enumerable.
| Object | |
![]() |
Sets the availability of a dynamic property for loop operations.
| Object | |
![]() |
Returns a string representation of the message.
| AbstractMessage | |
![]() |
Returns the primitive value of the specified object.
| Object | |
| Constant | Defined by | ||
|---|---|---|---|
| ASSOCIATION_ADD_OPERATION : uint = 13 [static]
This operation requests the remote destination add a new association
between the specified instances.
| DataMessage | ||
| ASSOCIATION_REMOVE_OPERATION : uint = 14 [static]
This operation requests the remote destination remove an association
between the specified instances.
| DataMessage | ||
| BATCHED_OPERATION : uint = 5 [static]
This operation represents a set of batched operations to be performed
as a single unit.
| DataMessage | ||
| COUNT_OPERATION : uint = 9 [static]
This operation requests that a configured <count-method> be
invoked on a remote destination.
| DataMessage | ||
| CREATE_AND_SEQUENCE_OPERATION : uint = 11 [static]
This operation requests a create of the specified item from a remote
destination.
| DataMessage | ||
| CREATE_OPERATION : uint = 0 [static]
Indicates a create operation.
| DataMessage | ||
| DELETE_OPERATION : uint = 4 [static]
This operation indicates that the specified item should be removed.
| DataMessage | ||
![]() | DESTINATION_CLIENT_ID_HEADER : String = "DSDstClientId" [static]
Messages pushed from the server may arrive in a batch, with messages in the
batch potentially targeted to different Consumer instances.
| AbstractMessage | |
![]() | ENDPOINT_HEADER : String = "DSEndpoint" [static]
Messages are tagged with the endpoint id for the Channel they are sent over.
| AbstractMessage | |
| FILL_OPERATION : uint = 1 [static]
This operation requests that the remote destination create a sequence
using the remote destination's adapter.
| DataMessage | ||
| GET_OPERATION : uint = 2 [static]
This operation requests that the remote destination get a specific
managed object based on its unique ID.
| DataMessage | ||
| GET_OR_CREATE_OPERATION : uint = 10 [static]
This operation requests an item with the specified identity from the
remote destination.
| DataMessage | ||
| GET_SEQUENCE_ID_OPERATION : uint = 12 [static]
This operation requests a sequence id for a set of fill parameters.
| DataMessage | ||
| MULTI_BATCH_OPERATION : uint = 6 [static]
This operation represents a set of operations to be performed as a
single unit but which may contain multiple batched, create, update or
delete operations that involve more than one destination, that is,
more than one remote adapter.
| DataMessage | ||
| PAGE_ITEMS_OPERATION : uint = 20 [static]
This operation indicates a request for a page of items specified by
identities.
| DataMessage | ||
| PAGE_OPERATION : uint = 8 [static]
This operation is used to retrieve a page of sequenced content that is
delivered across several messages instead of in a single message.
| DataMessage | ||
| RELEASE_COLLECTION_OPERATION : uint = 18 [static]
This operation indicates that the client is no longer interested in
receiving notificaion of operations performed on the specified collection.
| DataMessage | ||
| RELEASE_ITEM_OPERATION : uint = 19 [static]
This operation indicates that the client is no longer interested in
receiving notification of operations performed on the specified item.
| DataMessage | ||
![]() | REMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials" [static]
Messages that need to set remote credentials for a destination
carry the Base64 encoded credentials in this header.
| AbstractMessage | |
![]() | REQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout" [static]
Messages sent with a defined request timeout use this header.
| AbstractMessage | |
![]() | SUBTOPIC_HEADER : String = "DSSubtopic" [static]
Messages sent by a MessageAgent with a defined
subtopic
property indicate their target subtopic in this header. | AsyncMessage | |
| TRANSACTED_OPERATION : uint = 7 [static]
This operation is similar to the MULTI_BATCH_OPERATION with the addition
that the server should encapsulate the multiple batches of messages
within a transacation.
| DataMessage | ||
| UNKNOWN_OPERATION : uint = 1000 [static]
Code for an unknown operation type.
| DataMessage | ||
| UPDATE_BODY_CHANGES : uint = 0 [static]
This constant is used to access the list of changed property names.
| DataMessage | ||
| UPDATE_BODY_NEW : uint = 2 [static]
This constant is used to access the new value of a changed item.
| DataMessage | ||
| UPDATE_BODY_PREV : uint = 1 [static]
This constant is used to access the previous value of the changed item.
| DataMessage | ||
| UPDATE_COLLECTION_OPERATION : uint = 17 [static]
This operation is sent when a local or remote sequence has been modified
by insert(s) or delete(s).
| DataMessage | ||
| UPDATE_OPERATION : uint = 3 [static]
This operation indicates an update to data object has been performed.
| DataMessage | ||
| identity | property |
public var identity:ObjectProvides access to the identity map which defines the unique identity of the item affected by this DataMessage (relevant for create/update/delete but not fill operations).
| operation | property |
public var operation:uint
Provides access to the operation/command of this DataMessage.
Operations indicate how the remote destination should process this
message.
To display a description of operation type use the
getOperationAsString method.
See also
| DataMessage | () | constructor |
public function DataMessage()Creates a new instance of an empty DataMessage.
| getOperationAsString | () | method |
public static function getOperationAsString(op:uint):String
Provides a description of the operation specified.
This method is used in toString() operations on this
message.
op:uint |
String |
var msg:DataMessage = DataMessage(event.message);
trace("Current operation -'"+
DataMessage.getOperationAsString(msg.operation)+ "'.");
| isCreate | () | method |
public function isCreate():Boolean
Returns true if this is a create operation.
Boolean —
Boolean indicating if this is a create operation.
|
See also
| isEmptyUpdate | () | method |
public function isEmptyUpdate():Boolean
Returns true if this message is both an update and its list
of property names has a length of zero.
Boolean |
| ASSOCIATION_ADD_OPERATION | constant |
public static const ASSOCIATION_ADD_OPERATION:uint = 13
This operation requests the remote destination add a new association
between the specified instances.
The body property will contain a reference to the item
that will be added.
Clients send this operation when a one-to-many or many-to-many
association's many side has an item added to it.
The many side of the association is represented by a collection under
managemenet of a DataService and calls to the
IList.addItemAt(), IList.addItem() or IViewCursor.insert()
methods will generate this operation.
See also
| ASSOCIATION_REMOVE_OPERATION | constant |
public static const ASSOCIATION_REMOVE_OPERATION:uint = 14
This operation requests the remote destination remove an association
between the specified instances.
The body property will contain a reference to the item
that will be removed.
Clients send this operation when a one-to-many or many-to-many
association's many side has an item removed from it.
The many side of the association is represented by a collection under
managemenet of a DataService and calls to the
IList.removeItemAt() or IViewCursor.remove()
methods will generate this operation.
See also
| BATCHED_OPERATION | constant |
public static const BATCHED_OPERATION:uint = 5
This operation represents a set of batched operations to be performed
as a single unit.
Clients send a batch when DataService.commit() is invoked.
All messages in the batch are intended for the same destination.
The body property contains all of the messages that belong
within this batch.
| COUNT_OPERATION | constant |
public static const COUNT_OPERATION:uint = 9
This operation requests that a configured <count-method> be
invoked on a remote destination.
The body property of the message will contain the arguments
that should be passed to the remote destination when invoking the method.
Clients send this operation when the DataService.count()
method is invoked.
See also
| CREATE_AND_SEQUENCE_OPERATION | constant |
public static const CREATE_AND_SEQUENCE_OPERATION:uint = 11
This operation requests a create of the specified item from a remote
destination.
Clients send this operation when the DataService.createItem()
method is invoked.
The body property contains the item that should be created.
See also
| CREATE_OPERATION | constant |
public static const CREATE_OPERATION:uint = 0
Indicates a create operation.
The body property will contain the new item to be created.
When the operation is perfomed outside of an association a corresponding
UpdateCollectionMessage will be delivered indicating the
location/index the item should be added at.
Clients will send this operation when a collection under managemenet of
a DataService uses the IList.addItemAt(),
IList.addItem() or IViewCursor.insert() methods.
See also
| DELETE_OPERATION | constant |
public static const DELETE_OPERATION:uint = 4
This operation indicates that the specified item should be removed.
Clients will receive and send this operation when the item is removed.
Clients will send this operation when DataService.deleteItem()
or when a collection under managemenet of a DataService
uses the IList.removeItemAt() or IViewCursor.remove() method.
See also
| FILL_OPERATION | constant |
public static const FILL_OPERATION:uint = 1
This operation requests that the remote destination create a sequence
using the remote destination's adapter.
The body property of the message will contain the fill
arguments that should be used when creating the remote sequence.
| GET_OPERATION | constant |
public static const GET_OPERATION:uint = 2
This operation requests that the remote destination get a specific
managed object based on its unique ID.
The identity property contain's the desired object's
identity.
See also
| GET_OR_CREATE_OPERATION | constant |
public static const GET_OR_CREATE_OPERATION:uint = 10
This operation requests an item with the specified identity from the
remote destination.
If no item exists with the identity, a create operation will be performed.
Clients send this operation when the DataService.getItem()
method is called with non-null default values for the item.
The body property contains the default values of the item
should it need to be created.
See also
| GET_SEQUENCE_ID_OPERATION | constant |
public static const GET_SEQUENCE_ID_OPERATION:uint = 12
This operation requests a sequence id for a set of fill parameters.
If the sequence exists, it will not be recreated.
If it does not exist, it will be recreated remotely.
Clients send this operation when reconnecting to a remote destination or
when failing over to a new node within a cluster.
This operation is only used if the fetch attribute of the
<reconnect> tag in the remote destination's configuration xml file
is set to IDENTITY.
See also
| MULTI_BATCH_OPERATION | constant |
public static const MULTI_BATCH_OPERATION:uint = 6
This operation represents a set of operations to be performed as a
single unit but which may contain multiple batched, create, update or
delete operations that involve more than one destination, that is,
more than one remote adapter.
Clients send a multi-batch when DataService.commit() is
invoked and there are associations configured for that destination.
Messages in this batch will be sent to multiple destinations.
| PAGE_ITEMS_OPERATION | constant |
public static const PAGE_ITEMS_OPERATION:uint = 20
This operation indicates a request for a page of items specified by
identities.
This is operation is similar to a PAGE_OPERATION except
the page index is not needed.
Clients send this operation when fetching lazily loaded items for
associations configured using one-to-many and many-to-many.
| PAGE_OPERATION | constant |
public static const PAGE_OPERATION:uint = 8
This operation is used to retrieve a page of sequenced content that is
delivered across several messages instead of in a single message.
It represents a request for a portion of a remote sequence.
Clients send this operation when an item or property is requested that is
not resident locally.
This operation is only performed if either the <paging> tag under
<network> tag has its enabled attribute set to
true with a non-zero pageSize attribute or if
an association is configured with the lazy attribute set to
true.
| RELEASE_COLLECTION_OPERATION | constant |
public static const RELEASE_COLLECTION_OPERATION:uint = 18
This operation indicates that the client is no longer interested in
receiving notificaion of operations performed on the specified collection.
Clients send this operation when DataService.releaseCollection()
is invoked or if DataService.fill() is invoked with an
ArrayCollection which was previously filled with different
parameters or if a one-to-many association's owning item is released.
See also
| RELEASE_ITEM_OPERATION | constant |
public static const RELEASE_ITEM_OPERATION:uint = 19
This operation indicates that the client is no longer interested in
receiving notification of operations performed on the specified item.
Clients send this operation when DataService.releaseItem()
or ItemReference.releaseItem() is invoked.
See also
| TRANSACTED_OPERATION | constant |
public static const TRANSACTED_OPERATION:uint = 7
This operation is similar to the MULTI_BATCH_OPERATION with the addition
that the server should encapsulate the multiple batches of messages
within a transacation.
This operation is only performed when the remote destination has the
<use-transactions> tag under the <properties>
tag within the destination configuration xml set with a value of
true
| UNKNOWN_OPERATION | constant |
public static const UNKNOWN_OPERATION:uint = 1000Code for an unknown operation type.
| UPDATE_BODY_CHANGES | constant |
public static const UPDATE_BODY_CHANGES:uint = 0
This constant is used to access the list of changed property names.
Use this property with bracket notation on the body
property of a message with an operation of
UPDATE_OPERATION.
See also
var msg:DataMessage = DataMessage(event.message);
if (msg.operation == DataMessage.UPDATE_OPERATION)
{
// look at each change and display the old and new values
var propertyNames:Array = msg.body[DataMessage.UPDATE_BODY_CHANGES];
var newValues:Object = msg.body[DataMessage.UPDATE_BODY_NEW];
var oldValues:Object = msg.body[DataMessage.UPDATE_BODY_PREV];
var propertyName:String;
for (var i:int=0; i<propertyNames.length; i++)
{
propertyName = propertyNames[i];
trace("Property '"+ propertyName + "' was changed from '" +
oldValues[propertyName] + "' to '"+ newValues[propertyName] +
"'.");
}
}
| UPDATE_BODY_NEW | constant |
public static const UPDATE_BODY_NEW:uint = 2
This constant is used to access the new value of a changed item.
Use this property with bracket notation on the body
property of a message with an operation of
UPDATE_OPERATION.
See also
var msg:DataMessage = DataMessage(event.message);
if (msg.operation == DataMessage.UPDATE_OPERATION)
{
// look at each change and display the old and new values
var propertyNames:Array = msg.body[DataMessage.UPDATE_BODY_CHANGES];
var newValues:Object = msg.body[DataMessage.UPDATE_BODY_NEW];
var oldValues:Object = msg.body[DataMessage.UPDATE_BODY_PREV];
var propertyName:String;
for (var i:int=0; i<propertyNames.length; i++)
{
propertyName = propertyNames[i];
trace("Property '"+ propertyName + "' was changed from '" +
oldValues[propertyName] + "' to '"+ newValues[propertyName] +
"'.");
}
}
| UPDATE_BODY_PREV | constant |
public static const UPDATE_BODY_PREV:uint = 1
This constant is used to access the previous value of the changed item.
Use this property with bracket notation on the body
property of a message with an operation of
UPDATE_OPERATION.
See also
var msg:DataMessage = DataMessage(event.message);
if (msg.operation == DataMessage.UPDATE_OPERATION)
{
// look at each change and display the old and new values
var propertyNames:Array = msg.body[DataMessage.UPDATE_BODY_CHANGES];
var newValues:Object = msg.body[DataMessage.UPDATE_BODY_NEW];
var oldValues:Object = msg.body[DataMessage.UPDATE_BODY_PREV];
var propertyName:String;
for (var i:int=0; i<propertyNames.length; i++)
{
propertyName = propertyNames[i];
trace("Property '"+ propertyName + "' was changed from '" +
oldValues[propertyName] + "' to '"+ newValues[propertyName] +
"'.");
}
}
| UPDATE_COLLECTION_OPERATION | constant |
public static const UPDATE_COLLECTION_OPERATION:uint = 17
This operation is sent when a local or remote sequence has been modified
by insert(s) or delete(s).
This operation provides information about the locations of all insert(s)
and delete(s) such that the state of the collection order can be
restored.
The body contains an Array of
UpdateCollectionRanges indicating what items have been
removed and added.
Applying the update collection ranges inorder will establish a consistent
ordering of the items within the specified collection.
| UPDATE_OPERATION | constant |
public static const UPDATE_OPERATION:uint = 3
This operation indicates an update to data object has been performed.
Clients will receive and send this operation when an item has been
updated.
The body property of the message is an Array containing
specific information about the update that occured.
The DataMessage.UPDATE_BODY_CHANGES location within the
array contains an array of property names that were changed during the
update.
The DataMessage.UPDATE_BODY_NEW location within the array
contains the object in its new modified state.
The DataMessage.UPDATE_BODY_PREV location within the array
contains the object in its state prior to the updates.
var msg:DataMessage = DataMessage(event.message);
if (msg.operation == DataMessage.UPDATE_OPERATION)
{
// look at each change and display the old and new values
var propertyNames:Array = msg.body[DataMessage.UPDATE_BODY_CHANGES];
var newValues:Object = msg.body[DataMessage.UPDATE_BODY_NEW];
var oldValues:Object = msg.body[DataMessage.UPDATE_BODY_PREV];
var propertyName:String;
for (var i:int=0; i<propertyNames.length; i++)
{
propertyName = propertyNames[i];
trace("Property '"+ propertyName + "' was changed from '" +
oldValues[propertyName] + "' to '"+ newValues[propertyName] +
"'.");
}
}
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/flex/2/langref/mx/data/messages/DataMessage.html