| Package | com.adobe.rtc.messaging |
| Class | public class MessageItem |
| Implements | IValueObjectEncodable |
See also
| Property | Defined by | ||
|---|---|---|---|
| associatedUserID : String
For
nodeConfigurations with userDependentItems=true or
modifyAnyItem=false, this property is used to determine the user associated
with this item. | MessageItem | ||
| body : *
Value actually being sent within this message.
| MessageItem | ||
| collectionName : String
[Read-only] The name of the CollectionNode this item belongs to.
| MessageItem | ||
| itemID : String
The ID for this stored item.
| MessageItem | ||
| nodeName : String
The name of the Node within a CollectionNode that this item belongs to.
| MessageItem | ||
| publisherID : String
[Read-only]
userID of the user who published this item. | MessageItem | ||
| recipientID : String
For nodes where
allowPrivateMessages has been set to true, this field allows
messages to be received by only nerecipient. | MessageItem | ||
| timeStamp : Number = -1
[Read-only] The time this message was broadcast and written on the server.
| MessageItem | ||
| Method | Defined by | ||
|---|---|---|---|
|
MessageItem(p_nodeName:String = null, p_body:String = null, p_itemID:* = null)
| MessageItem | ||
|
createValueObject():Object
Creates a ValueObject representation of this MessageItem.
| MessageItem | ||
|
readValueObject(p_valueObject:Object):void
Takes in a
valueObject and structure the MessageItem according to the values therein. | MessageItem | ||
|
registerBodyClass(p_class:Class):void
[static]
registerBodyClass allows the AFCS services to send fully-typed objects in the body of MessageItems.
| MessageItem | ||
| Constant | Defined by | ||
|---|---|---|---|
| SINGLE_ITEM_ID : String = "item" [static]
If STORAGE_SCHEME_SINGLE_ITEM is used for a
nodeConfiguration, this is the default itemID used. | MessageItem | ||
| associatedUserID | property |
public var associatedUserID:String
For nodeConfigurations with userDependentItems=true or
modifyAnyItem=false, this property is used to determine the user associated
with this item. This is typically the publisherID of the first userID
to publish the item. Note that owners may also publish items associated with other users.
associatedUserID almost never needs to be explicitly set.
| body | property |
public var body:*Value actually being sent within this message.
| collectionName | property |
public var collectionName:String[Read-only] The name of the CollectionNode this item belongs to.
| itemID | property |
public var itemID:String
The ID for this stored item. Note this must be unique within the node.
Publishing an item with an existing itemID will overwrite the existing item.
| nodeName | property |
public var nodeName:StringThe name of the Node within a CollectionNode that this item belongs to.
| publisherID | property |
public var publisherID:String
[Read-only] userID of the user who published this item. Depending on nodeConfigurations
for this message, publishers may not be able to modify stored items they didn't publish
themselves. Note that this variable is overwritten by the server to prevent spoofing.
| recipientID | property |
public var recipientID:String
For nodes where allowPrivateMessages has been set to true, this field allows
messages to be received by only nerecipient. Note that for cases where groups of people
are recipients, you should use specialized nodes where those recipients have been promoted with
the ability to subscribe. We do want to avoid the one-to-one private message case devolving
to "one node per user," so recipientID allows this in a much simpler manner.
| timeStamp | property |
public var timeStamp:Number = -1[Read-only] The time this message was broadcast and written on the server.
| MessageItem | () | constructor |
public function MessageItem(p_nodeName:String = null, p_body:String = null, p_itemID:* = null)Parameters
p_nodeName:String (default = null) |
|
p_body:String (default = null) |
|
p_itemID:* (default = null) |
| createValueObject | () | method |
public function createValueObject():ObjectCreates a ValueObject representation of this MessageItem.
ReturnsObject — An Object which represents the non-default values for this MessageItem,
suitable for consumption by readValueObject.
|
| readValueObject | () | method |
public function readValueObject(p_valueObject:Object):void
Takes in a valueObject and structure the MessageItem according to the values therein.
p_valueObject:Object — An Object which represents the non-default values for this MessageItem.
|
| registerBodyClass | () | method |
public static function registerBodyClass(p_class:Class):voidregisterBodyClass allows the AFCS services to send fully-typed objects in the body of MessageItems. Similar to flash.net.registerClassAlias, this causes any message body of this type to be encoded as a ByteArray. Upon receipt, the body will be deserialized as a fully-typed object. Note that if your class contains other typed object as properties, those classes will need to be registered as well.
Parametersp_class:Class — The class to register as a body.
|
| SINGLE_ITEM_ID | constant |
public static const SINGLE_ITEM_ID:String = "item"
If STORAGE_SCHEME_SINGLE_ITEM is used for a nodeConfiguration, this is the default itemID used.
The value may be overriden in your items.
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/MessageItem.html