| Package | com.adobe.rtc.sharedModel.descriptors |
| Class | public class ChatMessageDescriptor |
| Implements | IValueObjectEncodable |
| Property | Defined by | ||
|---|---|---|---|
| color : uint
The chat message sender-specified color.
| ChatMessageDescriptor | ||
| displayName : String
Display name of the chat message sender.
| ChatMessageDescriptor | ||
| msg : String
The chat message contents.
| ChatMessageDescriptor | ||
| publisherID : String
[Read-only] The sender's
userID. | ChatMessageDescriptor | ||
| recipient : String
For private messages intended for a specific recipient, an optional
recipient
userID. | ChatMessageDescriptor | ||
| recipientDisplayName : String
For private messages intended for a specific recipient, the recipient's
displayName. | ChatMessageDescriptor | ||
| role : int = 10
For public messages intended for a role group rather than a specific recipient,
role specifies the minimum role level required to receive the message. | ChatMessageDescriptor | ||
| timeStamp : Number
[Read-only] The time the message was sent.
| ChatMessageDescriptor | ||
| Method | Defined by | ||
|---|---|---|---|
|
ChatMessageDescriptor(p_msg:String = "")
Constructor.
| ChatMessageDescriptor | ||
| color | property |
public var color:uintThe chat message sender-specified color.
| displayName | property |
public var displayName:StringDisplay name of the chat message sender.
| msg | property |
public var msg:StringThe chat message contents. The contents should not contain any HTML formatting Since formatting is done by using .color at the receiving end.
| publisherID | property |
public var publisherID:String
[Read-only] The sender's userID.
| recipient | property |
public var recipient:String
For private messages intended for a specific recipient, an optional
recipient userID. For messages sent to all recipients of a
particular role level, see role.
| recipientDisplayName | property |
public var recipientDisplayName:String
For private messages intended for a specific recipient, the recipient's
displayName. For messages sent to all recipients of a
particular role level, see role.
By default, when a user is present, their display name appears next to
their message. When they leave, recipientDisplayName enables
the chat window to continue displaying their name along with the old messages.
| role | property |
public var role:int = 10
For public messages intended for a role group rather than a specific recipient,
role specifies the minimum role level required to receive the message.
For example, instead of using userID to limit recipients to a single
specified user, you can use role to send a message to everyone with
a minimum role level or above as follows:
| timeStamp | property |
public var timeStamp:Number[Read-only] The time the message was sent.
| ChatMessageDescriptor | () | constructor |
public function ChatMessageDescriptor(p_msg:String = "")Constructor.
Parametersp_msg:String (default = " |
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/sharedModel/descriptors/ChatMessageDescriptor.html