Packagecom.electrotank.electroserver5.user
Classpublic class User
InheritanceUser Inheritance Object

This class represents a user on the server. It stores information about that user such as their name and user variables. Some information is only tracked and updated if you are in a room with that user and have the appropriate subscriptions. For example, you will only know about user variables for users in your room if you specified receivingUserVariableUpdates when joining that room - which is 'true' by default.


Public Properties
 PropertyDefined By
  buddyVariable : EsObject
Gets the optional buddy variable set when the buddy was added via the AddBuddyRequest.
User
  isBuddy : Boolean
Returns 'true' if this user is also a buddy of yours.
User
  isLoggedIn : Boolean
Used if this user is a buddy of yours.
User
  isMe : Boolean
Returns 'true' if this user represents you.
User
  isSendingVideo : Boolean
Returns 'true' if the user is currently publishing video to the server (Flash only).
User
  userName : String
Gets the userName of this user.
User
  userVariables : Array
[read-only] Gets the list of user variables.
User
  videoStreamName : String
Gets the name of the video stream.
User
Public Methods
 MethodDefined By
  
User()
Creates a new instance of the User class.
User
  
userVariableByName(name:String):UserVariable
Gets a user variable by its name and returns it.
User
Property Detail
buddyVariableproperty
buddyVariable:EsObject

Gets the optional buddy variable set when the buddy was added via the AddBuddyRequest.


Implementation
    public function get buddyVariable():EsObject
    public function set buddyVariable(value:EsObject):void
isBuddyproperty 
isBuddy:Boolean

Returns 'true' if this user is also a buddy of yours.


Implementation
    public function get isBuddy():Boolean
    public function set isBuddy(value:Boolean):void
isLoggedInproperty 
isLoggedIn:Boolean

Used if this user is a buddy of yours. It returns 'true' if the buddy is logged in.


Implementation
    public function get isLoggedIn():Boolean
    public function set isLoggedIn(value:Boolean):void
isMeproperty 
isMe:Boolean

Returns 'true' if this user represents you.


Implementation
    public function get isMe():Boolean
    public function set isMe(value:Boolean):void
isSendingVideoproperty 
isSendingVideo:Boolean

Returns 'true' if the user is currently publishing video to the server (Flash only). The videoStreamName property contains the name of the stream.


Implementation
    public function get isSendingVideo():Boolean
    public function set isSendingVideo(value:Boolean):void
userNameproperty 
userName:String

Gets the userName of this user.


Implementation
    public function get userName():String
    public function set userName(value:String):void
userVariablesproperty 
userVariables:Array  [read-only]

Gets the list of user variables.


Implementation
    public function get userVariables():Array
videoStreamNameproperty 
videoStreamName:String

Gets the name of the video stream. It is only non-null if isSendingVideo is true.


Implementation
    public function get videoStreamName():String
    public function set videoStreamName(value:String):void
Constructor Detail
User()Constructor
public function User()

Creates a new instance of the User class.

Method Detail
userVariableByName()method
public function userVariableByName(name:String):UserVariable

Gets a user variable by its name and returns it.

Parameters

name:String — of the variable to get.

Returns
UserVariable — The UserVariable object



ElectroServer 5 Client AS3 API compiled using Ant and ASDOC (build.xml and build.properties) @electrotank.com

Fri Apr 19 2013, 03:39 PM Z