(Preview)
| Package | mx.data.messages |
| Class | public class PagedMessage |
| Inheritance | PagedMessage  SequencedMessage AcknowledgeMessage AsyncMessage AbstractMessage Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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
Hide Inherited Public Properties
Show Inherited Public Properties| 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 | |
| dynamicSizing : int
1 denotes that this sequence is dynamically sized; 0 denotes that its not
| SequencedMessage | |
| 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 | |
| messageId : 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 | ||
| sequenceId : int
Provides access to the sequence id for this message. | SequencedMessage | |
| sequenceSize : int
Provides access to the sequence size for this message. | SequencedMessage | |
| 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 | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of an empty PagedMessage. | PagedMessage | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
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 the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string representation of the message. | AbstractMessage | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
Property Detail
pageCount | property |
public var pageCount:int| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to the number of total pages in a sequence based on the current page size.
pageIndex | property |
public var pageIndex:int| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to the index of the current page in a sequence.
Constructor Detail
PagedMessage | () | Constructor |
public function PagedMessage()| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a new instance of an empty PagedMessage.
Wed Nov 21 2018, 06:34 AM -08:00