Packagenet.user1.reactor
Classpublic class CustomClient
InheritanceCustomClient Inheritance Object
Implements IClient

Since : Reactor 1.0.0

A base class for the creation of custom client classes. To create a custom client class, either extend this class, or implement IClient directly.

Note that CustomClient's composed Client instance is not available from within the CustomClient class's constructor method. Initialization code that requires access to the composed Client instance should be placed in an init() method in the CustomClient subclass.

See also

Client.setClientClass()
IClient


Public Methods
 MethodDefined By
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
CustomClient
  
ban(duration:int, reason:String = null):void
CustomClient
  
deleteAttribute(attrName:String, attrScope:String = null):void
CustomClient
  
dispatchEvent(event:Event):Boolean
CustomClient
  
CustomClient
  
getAttribute(attrName:String, attrScope:String = null):String
CustomClient
  
getAttributes():Object
CustomClient
  
getAttributesByScope(scope:String = null):Object
CustomClient
  
getClientID():String
CustomClient
  
CustomClient
  
CustomClient
  
CustomClient
  
getIP():String
CustomClient
  
CustomClient
  
CustomClient
  
getPing():int
CustomClient
  
getTimeOnline():Number
CustomClient
  
hasEventListener(type:String):Boolean
CustomClient
  
init():void
An initialization method invoked when this CustomClient object is ready for use.
CustomClient
  
isAdmin():Boolean
CustomClient
  
isInRoom(roomID:String):Boolean
CustomClient
  
isObservingRoom(roomID:String):Boolean
CustomClient
  
isSelf():Boolean
CustomClient
  
kick():void
CustomClient
  
observe():void
CustomClient
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
CustomClient
  
sendMessage(messageName:String, ... args):void
CustomClient
  
setAttribute(attrName:String, attrValue:String, attrScope:String = null, isShared:Boolean = true, evaluate:Boolean = false):void
CustomClient
  
setClient(client:Client):void
Used internally by Reactor to associate this CustomClient object with a Client object.
CustomClient
  
setClientClass(scope:String, clientClass:Class, ... fallbackClasses):void
CustomClient
  
CustomClient
  
toString():String
CustomClient
  
willTrigger(type:String):Boolean
CustomClient
Method Descriptions
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
useWeakReference:Boolean (default = false)

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)

dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
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
hasEventListener()method 
public function hasEventListener(type:String):Boolean

Parameters

type:String

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

Since : Reactor 1.0.0

An initialization method invoked when this CustomClient object is ready for use. Subclasses wishing to perform initialization tasks that require this CustomClient's composed Client object should override this method.

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

removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

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

Parameters

messageName:String
 
... args

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)

setClient()method 
public function setClient(client:Client):void

Since : Reactor 1.0.0

Used internally by Reactor to associate this CustomClient object with a Client object.

Parameters

client:Client

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

Parameters

scope:String
 
clientClass:Class
 
... fallbackClasses

stopObserving()method 
public function stopObserving():void

toString()method 
public function toString():String

Returns
String
willTrigger()method 
public function willTrigger(type:String):Boolean

Parameters

type:String

Returns
Boolean