適用於 Adobe® Flash® Platform 的 ActionScript® 3.0 參考
首頁  |  隱藏套件和類別清單 |  套件  |  類別  |  新增內容  |  索引  |  附錄  |  為什麼顯示英文?
篩選: 從伺服器擷取資料...
從伺服器擷取資料...
mx.data.messages 

DataMessage  - AS3 ADEP Data Services

套件mx.data.messages
類別public class DataMessage
繼承DataMessage Inheritance AsyncMessage Inheritance AbstractMessage Inheritance Object
子類別 UpdateCollectionMessage

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

This message is used to transport an operation that occurred on a managed object or collection. This class of message is transmitted between clients subscribed to a remote destination as well as between server nodes within a cluster. The payload of this message describes all of the relevant details of the operation. This information is used to replicate updates and detect conflicts. The body of the message will contain different data based on the operation setting.



公用屬性
 屬性定義自
 Inheritedbody : Object
The body of a message contains the specific data that needs to be delivered to the remote destination.
AbstractMessage
 InheritedclientId : String
The clientId indicates which MessageAgent sent the message.
AbstractMessage
 Inheritedconstructor : Object
類別物件的參照或是特定物件實體的建構函數。
Object
 InheritedcorrelationId : String
Provides access to the correlation id of the message.
AsyncMessage
 Inheriteddestination : String
The message destination.
AbstractMessage
 Inheritedheaders : 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
 InheritedmessageId : String
The unique id for the message.
AbstractMessage
  operation : uint
Provides access to the operation/command of this DataMessage.
DataMessage
 Inheritedtimestamp : Number
Provides access to the time stamp for the message.
AbstractMessage
 InheritedtimeToLive : Number
The time to live value of a message indicates how long the message should be considered valid and deliverable.
AbstractMessage
公用方法
 方法定義自
  
Constructor.
DataMessage
  
[靜態] Provides a description of the operation specified.
DataMessage
 Inherited
指出物件是否有已定義的指定屬性。
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
 Inherited
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。
Object
 Inherited
指出指定的屬性是否存在,以及是否可列舉。
Object
 Inherited
為迴圈作業設定動態屬性的可用性。
Object
 Inherited
傳回代表此物件的字串,根據地區特定慣例進行格式化。
Object
 Inherited
Returns a string representation of the message.
AbstractMessage
 Inherited
會傳回指定之物件的基本值。
Object
公用常數
 常數定義自
  BATCHED_OPERATION : uint = 5
[靜態] This operation represents a set of batched operations to be performed as a single unit.
DataMessage
  COUNT_OPERATION : uint = 9
[靜態] This operation requests that a configured <count-method> be invoked on a remote destination.
DataMessage
  CREATE_AND_SEQUENCE_OPERATION : uint = 11
[靜態] This operation requests a create of the specified item from a remote destination.
DataMessage
  CREATE_OPERATION : uint = 0
[靜態] Indicates a create operation.
DataMessage
  DELETE_OPERATION : uint = 4
[靜態] This operation indicates that the specified item should be removed.
DataMessage
  FILL_OPERATION : uint = 1
[靜態] This operation requests that the remote destination create a sequence using the remote destination's adapter.
DataMessage
  FIND_ITEM_OPERATION : uint = 21
[靜態] Like the FILL_OPERATION but ensures only a single item is returned in the response array.
DataMessage
  GET_OPERATION : uint = 2
[靜態] This operation requests that the remote destination get a specific managed object based on its unique ID.
DataMessage
  GET_OR_CREATE_OPERATION : uint = 10
[靜態] This operation requests an item with the specified identity from the remote destination.
DataMessage
  GET_SEQUENCE_ID_OPERATION : uint = 12
[靜態] This operation requests a sequence id for a set of fill parameters.
DataMessage
  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.
DataMessage
  PAGE_ITEMS_OPERATION : uint = 20
[靜態] This operation indicates a request for a page of items specified by identities.
DataMessage
  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.
DataMessage
  RELEASE_COLLECTION_OPERATION : uint = 18
[靜態] This operation indicates that the client is no longer interested in receiving notification of operations performed on the specified collection.
DataMessage
  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.
DataMessage
  REMOTE_ALIAS : String = "flex.data.messages.DataMessage"
[靜態] Remote alias specifying the fully qualified server side class corresponding to this class.
DataMessage
  SYNCHRONIZE_FILL_OPERATION : uint = 13
[靜態] This operation requests that the remote destination create a sequence using the remote destination's adapter.
DataMessage
  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 transaction.
DataMessage
  UNKNOWN_OPERATION : uint = 1000
[靜態] Code for an unknown operation type.
DataMessage
  UPDATE_BODY_CHANGES : uint = 0
[靜態] This constant is used to access the list of changed property names.
DataMessage
  UPDATE_BODY_NEW : uint = 2
[靜態] This constant is used to access the new value of a changed item.
DataMessage
  UPDATE_BODY_PREV : uint = 1
[靜態] This constant is used to access the previous value of the changed item.
DataMessage
  UPDATE_COLLECTION_OPERATION : uint = 17
[靜態] This operation is sent when a local or remote sequence has been modified by insert(s) or delete(s).
DataMessage
  UPDATE_OPERATION : uint = 3
[靜態] This operation indicates an update to data object has been performed.
DataMessage
屬性詳細資訊

identity

屬性
public var identity:Object

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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).

operation

屬性 
public var operation:uint

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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.

相關 API 元素

建構函式詳細資料

DataMessage

()建構函式
public function DataMessage()

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

Constructor.

方法詳細資訊

getOperationAsString

()方法
public static function getOperationAsString(op:uint):String

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

Provides a description of the operation specified. This method is used in toString() operations on this message.

參數

op:uint — The operation.

傳回值
String — A String representation of the operation, or "unknown" if the operation is undefined.

範例  ( 如何使用本範例 )
         var msg:DataMessage = DataMessage(event.message);
         trace("Current operation -'"+
                DataMessage.getOperationAsString(msg.operation)+ "'.");
      

isCreate

()方法 
public function isCreate():Boolean

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

Returns true if this is a create operation.

傳回值
Boolean — Boolean indicating if this is a create operation.

相關 API 元素

isEmptyUpdate

()方法 
public function isEmptyUpdate():Boolean

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

Returns true if this message is both an update and its list of property names has a length of zero.

傳回值
Boolean — Boolean indicating if this message is both an update and has a zero length list of property names.
常數詳細資訊

BATCHED_OPERATION

常數
public static const BATCHED_OPERATION:uint = 5

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

This operation represents a set of batched operations to be performed as a single unit. Clients send a batch when DataManager.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

常數 
public static const COUNT_OPERATION:uint = 9

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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 DataManager.count() method is invoked.

相關 API 元素

CREATE_AND_SEQUENCE_OPERATION

常數 
public static const CREATE_AND_SEQUENCE_OPERATION:uint = 11

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

This operation requests a create of the specified item from a remote destination. Clients send this operation when the DataManager.createItem() method is invoked. The body property contains the item that should be created.

相關 API 元素

CREATE_OPERATION

常數 
public static const CREATE_OPERATION:uint = 0

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

Indicates a create operation. The body property will contain the new item to be created. When the operation is performed outside of an association a corresponding UpdateCollectionMessage is delivered indicating the location/index the item should be added at. Clients will send this operation when a collection under management of a DataService uses the IList.addItemAt(), IList.addItem() or IViewCursor.insert() methods.

相關 API 元素

DELETE_OPERATION

常數 
public static const DELETE_OPERATION:uint = 4

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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 DataManager.deleteItem() or when a collection under managemenet of a data manager uses the IList.removeItemAt() or IViewCursor.remove() method.

相關 API 元素

FILL_OPERATION

常數 
public static const FILL_OPERATION:uint = 1

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.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.

FIND_ITEM_OPERATION

常數 
public static const FIND_ITEM_OPERATION:uint = 21

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

Like the FILL_OPERATION but ensures only a single item is returned in the response array.

GET_OPERATION

常數 
public static const GET_OPERATION:uint = 2

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

This operation requests that the remote destination get a specific managed object based on its unique ID. The identity property contains the desired object's identity.

相關 API 元素

GET_OR_CREATE_OPERATION

常數 
public static const GET_OR_CREATE_OPERATION:uint = 10

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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 DataManager.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.

相關 API 元素

GET_SEQUENCE_ID_OPERATION

常數 
public static const GET_SEQUENCE_ID_OPERATION:uint = 12

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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.

相關 API 元素

MULTI_BATCH_OPERATION

常數 
public static const MULTI_BATCH_OPERATION:uint = 6

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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 DataManager.commit() is invoked and there are associations configured for that destination. Messages in this batch will be sent to multiple destinations.

PAGE_ITEMS_OPERATION

常數 
public static const PAGE_ITEMS_OPERATION:uint = 20

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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

常數 
public static const PAGE_OPERATION:uint = 8

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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

常數 
public static const RELEASE_COLLECTION_OPERATION:uint = 18

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

This operation indicates that the client is no longer interested in receiving notification of operations performed on the specified collection. Clients send this operation when DataManager.releaseCollection() is invoked or if DataManager.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.

相關 API 元素

RELEASE_ITEM_OPERATION

常數 
public static const RELEASE_ITEM_OPERATION:uint = 19

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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.

相關 API 元素

REMOTE_ALIAS

常數 
public static const REMOTE_ALIAS:String = "flex.data.messages.DataMessage"

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

Remote alias specifying the fully qualified server side class corresponding to this class.

SYNCHRONIZE_FILL_OPERATION

常數 
public static const SYNCHRONIZE_FILL_OPERATION:uint = 13

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 4.5
執行階段版本: Flash Player 10.1, AIR 2.0

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.

TRANSACTED_OPERATION

常數 
public static const TRANSACTED_OPERATION:uint = 7

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

This operation is similar to the MULTI_BATCH_OPERATION with the addition that the server should encapsulate the multiple batches of messages within a transaction. 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

常數 
public static const UNKNOWN_OPERATION:uint = 1000

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

Code for an unknown operation type.

UPDATE_BODY_CHANGES

常數 
public static const UPDATE_BODY_CHANGES:uint = 0

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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.

相關 API 元素


範例  ( 如何使用本範例 )
         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

常數 
public static const UPDATE_BODY_NEW:uint = 2

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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.

相關 API 元素


範例  ( 如何使用本範例 )
         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

常數 
public static const UPDATE_BODY_PREV:uint = 1

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.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.

相關 API 元素


範例  ( 如何使用本範例 )
         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

常數 
public static const UPDATE_COLLECTION_OPERATION:uint = 17

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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 in order will establish a consistent ordering of the items within the specified collection.

UPDATE_OPERATION

常數 
public static const UPDATE_OPERATION:uint = 3

語言版本: ActionScript 3.0
產品版本: Adobe Digital Enterprise Platform Data Services for Java EE 3
執行階段版本: Flash Player 9, AIR 1.1

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] +
                      "'.");
            }
         }
      




[ X ]為什麼顯示英文?
「ActionScript 3.0 參考」的內容是以英文顯示

並非所有「ActionScript 3.0 參考」的內容都翻譯為所有語言。當語言元素未翻譯時,就會以英文顯示。例如,ga.controls.HelpBox 類別並沒有翻譯為任何語言。因此在參考的繁體中文版本中,ga.controls.HelpBox 類別就會以英文顯示。