(Adobe® Flex™ Data Services 2 only)
Packagemx.data.messages
Classpublic class PagedMessage
InheritancePagedMessage Inheritance SequencedMessage Inheritance AcknowledgeMessage Inheritance AsyncMessage Inheritance AbstractMessage Inheritance Object

This messsage provides information about a partial sequence result. When paging is enabled for a destination and DataService.fill() or a page request is made the remote destination will return this message as a response. The body property is an Array containing the items for the requested page with a length of the configured page size.


Public Properties
 PropertyDefined by
 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
A reference to the class object or constructor function for a given object instance.
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
 InheritedmessageId : String
The unique id for the message.
AbstractMessage
  pageCount : int
Provides access to the number of total pages in a sequence based on the current page size.
PagedMessage
  pageIndex : int
Provides access to the index of the current page in a sequence.
PagedMessage
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedsequenceId : int
Provides access to the sequence id for this message.
SequencedMessage
 InheritedsequenceSize : int
Provides access to the sequence size for this message.
SequencedMessage
 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
Public Methods
 MethodDefined by
  
PagedMessage()
Creates a new instance of an empty PagedMessage.
PagedMessage
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns a string representation of the message.
AbstractMessage
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedDESTINATION_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
 InheritedENDPOINT_HEADER : String = "DSEndpoint"
[static] Messages are tagged with the endpoint id for the Channel they are sent over.
AbstractMessage
 InheritedERROR_HINT_HEADER : String = "DSErrorHint"
[static] Header name for the error hint header.
AcknowledgeMessage
 InheritedREMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials"
[static] Messages that need to set remote credentials for a destination carry the Base64 encoded credentials in this header.
AbstractMessage
 InheritedREQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout"
[static] Messages sent with a defined request timeout use this header.
AbstractMessage
 InheritedSUBTOPIC_HEADER : String = "DSSubtopic"
[static] Messages sent by a MessageAgent with a defined subtopic property indicate their target subtopic in this header.
AsyncMessage
Property detail
pageCountproperty
public var pageCount:int

Provides access to the number of total pages in a sequence based on the current page size.

pageIndexproperty 
public var pageIndex:int

Provides access to the index of the current page in a sequence.

Constructor detail
PagedMessage()constructor
public function PagedMessage()

Creates a new instance of an empty PagedMessage.




© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

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/PagedMessage.html