mx.messaging.messages.ISmallMessage - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.messaging.messages
Interface	public interface ISmallMessage extends IMessage
Implementors	AcknowledgeMessage, AsyncMessage

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

A marker interface that is used to indicate that an IMessage has an alternative smaller form for serialization.

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.	IMessage
		clientId : String The clientId indicates which client sent the message.	IMessage
		destination : String The message destination.	IMessage
		headers : Object Provides access to the headers of the message.	IMessage
		messageId : String The unique id for the message.	IMessage
		timestamp : Number Provides access to the time stamp for the message.	IMessage
		timeToLive : Number The time to live value of a message indicates how long the message should be considered valid and deliverable.	IMessage

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		getSmallMessage():IMessage This method must be implemented by subclasses that have a "small" form, typically achieved through the use of flash.utils.IExternalizable.	ISmallMessage
		toString():String This method will return a string representation of the message.	IMessage

Method Detail

getSmallMessage

()

method

public function getSmallMessage():IMessage

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

This method must be implemented by subclasses that have a "small" form, typically achieved through the use of flash.utils.IExternalizable. If a small form is not available this method should return null.

Returns

IMessage — Returns An alternative representation of an flex.messaging.messages.IMessage so that the serialized form is smaller than the regular message.