Package | flash.net |
Class | public final class ObjectEncoding |
Inheritance | ObjectEncoding Object |
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Object encoding controls how objects are represented in Action Message Format (AMF). Flash Player uses AMF to enable efficient communication between an application and a remote server. AMF encodes remote procedure calls into a compact binary representation that can be transferred over HTTP/HTTPS or the RTMP/RTMPS protocol used by Flash Media Server. Objects and data values are serialized into this binary format, which is generally more compact than other representations, such as XML.
Adobe AIR and Flash Player 9 can serialize in two different formats: AMF3 and AMF0.
AMF3, the default serialization developed for ActionScript 3.0, provides various advantages
over AMF0, which is used for ActionScript 1.0 and 2.0. AMF3 sends data over
the network more efficiently than AMF0. AMF3 supports
sending int
and uint
objects as integers and supports data types that are available only in ActionScript 3.0, such as ByteArray,
XML, and IExternalizable. It is available only in ActionScript 3.0 and with servers
that use AMF3 encoding, such as Flex 2.
The ByteArray, FileStream, NetConnection, NetStream, SharedObject,
Socket, and URLStream classes contain an objectEncoding
property that is assigned
a constant from the ObjectEncoding class.
The behavior of the objectEncoding
property differs depending
on the object; each class's objectEncoding
property
description explains the behavior more thoroughly.
Property | Defined By | ||
---|---|---|---|
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
dynamicPropertyWriter : IDynamicPropertyWriter [static]
Allows greater control over the serialization of dynamic properties of dynamic objects. | ObjectEncoding | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object |
Constant | Defined By | ||
---|---|---|---|
AMF0 : uint = 0 [static]
Specifies that objects are serialized using the Action Message Format for ActionScript 1.0 and 2.0. | ObjectEncoding | ||
AMF3 : uint = 3 [static]
Specifies that objects are serialized using the Action Message Format for ActionScript 3.0. | ObjectEncoding | ||
DEFAULT : uint = 3 [static]
Specifies the default (latest) format for the current runtime (either Flash
Player or AIR). | ObjectEncoding |
dynamicPropertyWriter | property |
dynamicPropertyWriter:IDynamicPropertyWriter
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Allows greater control over the serialization of dynamic properties of dynamic objects.
When this property is set to null
,
the default value, dynamic properties are serialized using native code, which writes
all dynamic properties excluding those whose value is a function.
This value is called only for properties of a dynamic object (objects declared
within a dynamic class) or for objects declared using the
new
operator.
You can use this property to exclude properties of dynamic objects from serialization; to write values to properties of dynamic objects; or to create new properties for dynamic objects. To do so, set this property to an object that implements the IDynamicPropertyWriter interface. For more information, see the IDynamicPropertyWriter interface.
Implementation
public static function get dynamicPropertyWriter():IDynamicPropertyWriter
public static function set dynamicPropertyWriter(value:IDynamicPropertyWriter):void
Related API Elements
AMF0 | Constant |
public static const AMF0:uint = 0
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Specifies that objects are serialized using the Action Message Format for ActionScript 1.0 and 2.0.
AMF3 | Constant |
public static const AMF3:uint = 3
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Specifies that objects are serialized using the Action Message Format for ActionScript 3.0.
DEFAULT | Constant |
public static const DEFAULT:uint = 3
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Specifies the default (latest) format for the current runtime (either Flash Player or AIR). Because object encoding control is only available in Flash Player 9 and later and Adobe AIR, the earliest format used will be the Action Message Format for ActionScript 3.0.
For example, if an object has the objectEncoding
property set to
ObjectEncoding.DEFAULT
, AMF3 encoding is used.
If, in the future, a later version of Flash Player or Adobe AIR introduces a new AMF version
and you republish your content, the application will use that new AMF version.
You can use this constant only if you're not concerned at all about interoperability
with previous versions.
Mon Nov 28 2011, 06:48 AM -08:00