Packagecom.adobe.photoshop.messages
Classpublic class Message
InheritanceMessage Inheritance Object
Implements IMessage
Subclasses ImageMessage, TextMessage

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

A Message is the most generic type of Message that can be sent or received, though the API doesn't do either with Messages directly. It's akin to an abstract class. Most likely, you'll want to use something that extends this class, such as ImageMessage or TextMessage.


Public Properties
 PropertyDefined By
  apiVersion : int
Message
  messageLength : int
The message length of the Photoshop message.
Message
  messageType : int
The type of message that IMessage represents.
Message
  transactionID : int
The transaction ID of the Photoshop message.
Message
Public Methods
 MethodDefined By
  
Message(apiVersion:int)
Creates a new message.
Message
  
toStream():ByteArray
Converts the message into a stream of raw data, represented as a ByteArray.
Message
Property Detail
apiVersionproperty
public var apiVersion:int

messageLengthproperty 
messageLength:int

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

The message length of the Photoshop message.


Implementation
    public function get messageLength():int
    public function set messageLength(value:int):void
messageTypeproperty 
messageType:int

The type of message that IMessage represents.


Implementation
    public function get messageType():int
    public function set messageType(value:int):void
transactionIDproperty 
transactionID:int

Runtime Versions : AIR 1.0, Flash Player 10

The transaction ID of the Photoshop message.


Implementation
    public function get transactionID():int
    public function set transactionID(value:int):void
Constructor Detail
Message()Constructor
public function Message(apiVersion:int)

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Creates a new message.

Parameters
apiVersion:int (default = NaN) — The Photoshop API version that the message is compatible with.
Method Detail
toStream()method
public function toStream():ByteArray

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Converts the message into a stream of raw data, represented as a ByteArray. Used for sending to Photoshop

Returns
ByteArray — Returns a byte-by-byte representation of this message in a ByteArray of raw data



(c) 2011 Adobe Systems Inc. All rights reserved.

Fri Oct 21 2011, 03:36 PM -04:00