Packagecom.adobe.rtc.messaging
Interfacepublic interface IValueObjectEncodable
ImplementorsChatMessageDescriptor, FileDescriptor, MessageItem, NodeConfiguration, StreamDescriptor, UserDescriptor, UserQueueItem

IValueObjectEncodable describes a set of functions required to allow class instances to be serialized and deserialized as value objects. It is similar to flash.utils.IExternalizable, except that in this case, instead of writing directly to binary, IValueObjectEncodable classes can externalize themselves to simple Value Objects which are suitable for storage in an XML representation.

One of the key benefits of IValueObjectEncodable is that it allows a class instance to transmit itself minus its default values. As long as the recipient is aware of the same set of default values for the class, these need not be sent and could therefore reduce the burden on bandwidth.


Public Methods
 MethodDefined by
  
createValueObject():Object
Creates a ValueObject representation of the current class instance.
IValueObjectEncodable
  
readValueObject(p_valueObject:Object):void
Takes in a valueObject and structure the current class instance according to the values therein.
IValueObjectEncodable
Method detail
createValueObject()method
public function createValueObject():Object

Creates a ValueObject representation of the current class instance.

Returns
Object — An Object which represents the non-default values for this class instance that is suitable for consumption by readValueObject.
readValueObject()method 
public function readValueObject(p_valueObject:Object):void

Takes in a valueObject and structure the current class instance according to the values therein.

Parameters
p_valueObject:Object — An Object which represents the non-default values for this class instance.



2008-2009 Adobe Systems Incorporated. All rights reserved.

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/messaging/IValueObjectEncodable.html