| Package | com.adobe.rtc.sharedManagers.descriptors |
| Class | public class UserDescriptor |
| Implements | IValueObjectEncodable |
getUserDescriptor()
. This this object is used for accessing relevent details about users
within a roster list and so on.
See also
| Property | Defined by | ||
|---|---|---|---|
| affiliation : int = -1
The permanent, database-authenticated user role at the root level.
| UserDescriptor | ||
| connection : String = "dsl"
The user's connection speed as set in RoomSettings; for example, modem, dsl, or lan.
| UserDescriptor | ||
| displayName : String
The user name displayed in the roster.
| UserDescriptor | ||
| drops : Number
The rate of packets dropped by the service on a scale of 100.
| UserDescriptor | ||
| latency : Number
The amount of latency in milliseconds between the user and the server.
| UserDescriptor | ||
| playerVersion : String
The version of the flash player this user has
| UserDescriptor | ||
| role : int = -1
The current user role for the user at the root level.
| UserDescriptor | ||
| usericonURL : String
The URL of the user's avatar.
| UserDescriptor | ||
| userID : String
Unique ID for identifying the user within the room.
| UserDescriptor | ||
| Method | Defined by | ||
|---|---|---|---|
| UserDescriptor | |||
|
Returns a new copy of a UserDescriptor.
| UserDescriptor | ||
|
createValueObject():Object
Creates a value object from the
userDescriptor which is suitable
for storage as a simple object. | UserDescriptor | ||
|
readValueObject(p_valueObject:Object):void
Fills a
userDescriptor based on a given value object. | UserDescriptor | ||
| affiliation | property |
public var affiliation:int = -1The permanent, database-authenticated user role at the root level.
| connection | property |
public var connection:String = "dsl"The user's connection speed as set in RoomSettings; for example, modem, dsl, or lan.
See also
| displayName | property |
public var displayName:StringThe user name displayed in the roster.
| drops | property |
public var drops:NumberThe rate of packets dropped by the service on a scale of 100.
| latency | property |
public var latency:NumberThe amount of latency in milliseconds between the user and the server.
| playerVersion | property |
public var playerVersion:StringThe version of the flash player this user has
| role | property |
public var role:int = -1The current user role for the user at the root level.
| usericonURL | property |
public var usericonURL:StringThe URL of the user's avatar.
| userID | property |
public var userID:StringUnique ID for identifying the user within the room.
| UserDescriptor | () | constructor |
public function UserDescriptor()
| clone | () | method |
public function clone():UserDescriptorReturns a new copy of a UserDescriptor.
ReturnsUserDescriptor |
| createValueObject | () | method |
public function createValueObject():Object
Creates a value object from the userDescriptor which is suitable
for storage as a simple object.
Object |
| readValueObject | () | method |
public function readValueObject(p_valueObject:Object):void
Fills a userDescriptor based on a given value object.
p_valueObject:Object |
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/sharedManagers/descriptors/UserDescriptor.html