Packagecom.electrotank.electroserver4.message.request
Classpublic class GetUserVariablesRequest
InheritanceGetUserVariablesRequest Inheritance com.electrotank.electroserver4.message.request.RequestImpl

This class is used to load user variables for a user. You can specify which variables you are interested in.


Public Methods
 MethodDefined by
  
GetUserVariablesRequest()
Creates a new instance of the GetUserVariablesRequest class.
GetUserVariablesRequest
  
addUserVariableName(name:String):void
Add a user variable name that you are interested in.
GetUserVariablesRequest
  
getUserName():String
The name of the user you want to know about.
GetUserVariablesRequest
  
getUserVariableNames():Array
The list of names that you've added.
GetUserVariablesRequest
  
setUserName(userName:String):void
Sets the name of the user you want to know about.
GetUserVariablesRequest
  
validate():ValidationResponse
GetUserVariablesRequest
Constructor detail
GetUserVariablesRequest()constructor
public function GetUserVariablesRequest()

Creates a new instance of the GetUserVariablesRequest class.

Method detail
addUserVariableName()method
public function addUserVariableName(name:String):void

Add a user variable name that you are interested in.

Parameters
name:String — User variable name that you are interested in.
getUserName()method 
public function getUserName():String

The name of the user you want to know about.

Returns
String — The name of the user you want to know about.
getUserVariableNames()method 
public function getUserVariableNames():Array

The list of names that you've added.

Returns
Array — The list of names that you've added.
setUserName()method 
public function setUserName(userName:String):void

Sets the name of the user you want to know about.

Parameters
userName:String — The name of the user you want to know about.
validate()method 
public override function validate():ValidationResponse

Returns
ValidationResponse