mx.data.messages.SequencedMessage - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.data.messages
Class	public class SequencedMessage
Inheritance	SequencedMessage AcknowledgeMessage AsyncMessage AbstractMessage Object
Subclasses	PagedMessage

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Clients receive this message in response to DataService.fill() request. The body of the message is an Array of items that were returned from the remote destination based on the fill parameters.

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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SequencedMessage() Creates a new instance of an empty SequencedMessage.	SequencedMessage
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string representation of the message.	AbstractMessage
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		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
		ERROR_HINT_HEADER : String = "DSErrorHint" [static] Header name for the error hint header.	AcknowledgeMessage
		FLEX_CLIENT_ID_HEADER : String = "DSId" [static] This header is used to transport the global FlexClient Id value in outbound messages once it has been assigned by the server.	AbstractMessage
		PRIORITY_HEADER : String = "DSPriority" [static] Messages sent by a MessageAgent can have a priority header with a 0-9 numerical value (0 being lowest) and the server can choose to use this numerical value to prioritize messages to clients.	AbstractMessage
		REMOTE_CREDENTIALS_CHARSET_HEADER : String = "DSRemoteCredentialsCharset" [static] Messages that need to set remote credentials for a destination may also need to report the character-set encoding that was used to create the credentials String using this header.	AbstractMessage
		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
		STATUS_CODE_HEADER : String = "DSStatusCode" [static] A status code can provide context about the nature of a response message.	AbstractMessage
		SUBTOPIC_HEADER : String = "DSSubtopic" [static] Messages sent by a MessageAgent with a defined subtopic property indicate their target subtopic in this header.	AsyncMessage

Property Detail

dynamicSizing

property

public var dynamicSizing:int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

1 denotes that this sequence is dynamically sized; 0 denotes that its not

sequenceId

property

public var sequenceId:int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Provides access to the sequence id for this message. The sequence id is a unique identifier for a sequence within a remote destination. This value is only unique for the endpoint and destination contacted.

sequenceSize

property

public var sequenceSize:int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Provides access to the sequence size for this message. The sequence size indicates how many items reside in the remote sequence.

Constructor Detail

SequencedMessage

()

Constructor

public function SequencedMessage()

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Creates a new instance of an empty SequencedMessage.