Packagenet.user1.reactor
Interfacepublic interface IClient extends IEventDispatcher
Implementors Client, CustomClient

Since : Reactor 1.0.0

The interface implemented by all classes that wish to represent a client in the Reactor API. The built-in Client class implements IClient, and is used to represent any client in an application that does not have a custom client class specified. Developers that wish to use a custom class, rather than Client, to represent clients in a Reactor application must create a class that implements the IClient interface, and then assign that class as a custom client class via Client's setClientClass() method, Room's setDefaultClientClass() method, or ClientManager's setDefaultClientClass() method.

For a template custom-client base class, see the CustomClient class.

See also

Client.setClientClass()
ClientManager.setDefaultClientClass()
Room.setDefaultClientClass()
CustomClient


Public Methods
 MethodDefined By
  
ban(duration:int, reason:String = null):void
IClient
  
deleteAttribute(attrName:String, attrScope:String = null):void
IClient
  
IClient
  
getAttribute(attrName:String, attrScope:String = null):String
IClient
  
getAttributes():Object
IClient
  
getAttributesByScope(scope:String = null):Object
IClient
  
getClientID():String
IClient
  
IClient
  
IClient
  
IClient
  
getIP():String
IClient
  
IClient
  
IClient
  
getPing():int
IClient
  
getTimeOnline():Number
IClient
  
isAdmin():Boolean
IClient
  
isInRoom(roomID:String):Boolean
IClient
  
isObservingRoom(roomID:String):Boolean
IClient
  
isSelf():Boolean
IClient
  
kick():void
IClient
  
observe():void
IClient
  
sendMessage(messageName:String, ... rest):void
IClient
  
setAttribute(attrName:String, attrValue:String, attrScope:String = null, isShared:Boolean = true, evaluate:Boolean = false):void
IClient
  
setClientClass(scope:String, clientClass:Class, ... fallbackClasses):void
IClient
  
IClient
Method Descriptions
ban()method
public function ban(duration:int, reason:String = null):void

Parameters

duration:int
 
reason:String (default = null)

deleteAttribute()method 
public function deleteAttribute(attrName:String, attrScope:String = null):void

Parameters

attrName:String
 
attrScope:String (default = null)

getAccount()method 
public function getAccount():UserAccount

Returns
UserAccount
getAttribute()method 
public function getAttribute(attrName:String, attrScope:String = null):String

Parameters

attrName:String
 
attrScope:String (default = null)

Returns
String
getAttributes()method 
public function getAttributes():Object

Returns
Object
getAttributesByScope()method 
public function getAttributesByScope(scope:String = null):Object

Parameters

scope:String (default = null)

Returns
Object
getClientID()method 
public function getClientID():String

Returns
String
getClientManager()method 
public function getClientManager():ClientManager

Returns
ClientManager
getConnectionState()method 
public function getConnectionState():int

Returns
int
getConnectTime()method 
public function getConnectTime():Number

Returns
Number
getIP()method 
public function getIP():String

Returns
String
getObservedRoomIDs()method 
public function getObservedRoomIDs():Array

Returns
Array
getOccupiedRoomIDs()method 
public function getOccupiedRoomIDs():Array

Returns
Array
getPing()method 
public function getPing():int

Returns
int
getTimeOnline()method 
public function getTimeOnline():Number

Returns
Number
isAdmin()method 
public function isAdmin():Boolean

Returns
Boolean
isInRoom()method 
public function isInRoom(roomID:String):Boolean

Parameters

roomID:String

Returns
Boolean
isObservingRoom()method 
public function isObservingRoom(roomID:String):Boolean

Parameters

roomID:String

Returns
Boolean
isSelf()method 
public function isSelf():Boolean

Returns
Boolean
kick()method 
public function kick():void

observe()method 
public function observe():void

sendMessage()method 
public function sendMessage(messageName:String, ... rest):void

Parameters

messageName:String
 
... rest

setAttribute()method 
public function setAttribute(attrName:String, attrValue:String, attrScope:String = null, isShared:Boolean = true, evaluate:Boolean = false):void

Parameters

attrName:String
 
attrValue:String
 
attrScope:String (default = null)
 
isShared:Boolean (default = true)
 
evaluate:Boolean (default = false)

setClientClass()method 
public function setClientClass(scope:String, clientClass:Class, ... fallbackClasses):void

Parameters

scope:String
 
clientClass:Class
 
... fallbackClasses

stopObserving()method 
public function stopObserving():void