パッケージnet.user1.reactor
クラスpublic class CustomClient
継承CustomClient Inheritance Object
実装 IClient

バージョン : Reactor 1.0.0

自作クライアントクラスを作成するための基底クラスです。 自作クライアントクラスを作成するには、このクラスを拡張するか、直接IClientを実装します。

CustomClientで構成したClientインスタンスはCustomClientクラスのコンストラクタメソッド内では利用できないことに注意してください。 構成されたClientインスタンスへのアクセスを要求する初期化コードはCustomClientサブクラス内のinit()メソッド内に配置すると良いでしょう。

関連項目

Client.setClientClass()
IClient


パブリック メソッド
 メソッド定義元
  
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
このCustomClientオブジェクトの使用準備ができたときに呼び出される初期化メソッドです。
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
Reactorによって内部的に使用され、このCustomClientオブジェクトをClientオブジェクトと関連づけます。
CustomClient
  
setClientClass(scope:String, clientClass:Class, ... fallbackClasses):void
CustomClient
  
CustomClient
  
toString():String
CustomClient
  
willTrigger(type:String):Boolean
CustomClient
メソッドの詳細
addEventListener()メソッド
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

パラメータ

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

ban()メソッド 
public function ban(duration:int, reason:String = null):void

パラメータ

duration:int
 
reason:String (default = null)

deleteAttribute()メソッド 
public function deleteAttribute(attrName:String, attrScope:String = null):void

パラメータ

attrName:String
 
attrScope:String (default = null)

dispatchEvent()メソッド 
public function dispatchEvent(event:Event):Boolean

パラメータ

event:Event

戻り値
Boolean
getAccount()メソッド 
public function getAccount():UserAccount

戻り値
UserAccount
getAttribute()メソッド 
public function getAttribute(attrName:String, attrScope:String = null):String

パラメータ

attrName:String
 
attrScope:String (default = null)

戻り値
String
getAttributes()メソッド 
public function getAttributes():Object

戻り値
Object
getAttributesByScope()メソッド 
public function getAttributesByScope(scope:String = null):Object

パラメータ

scope:String (default = null)

戻り値
Object
getClientID()メソッド 
public function getClientID():String

戻り値
String
getClientManager()メソッド 
public function getClientManager():ClientManager

戻り値
ClientManager
getConnectionState()メソッド 
public function getConnectionState():int

戻り値
int
getConnectTime()メソッド 
public function getConnectTime():Number

戻り値
Number
getIP()メソッド 
public function getIP():String

戻り値
String
getObservedRoomIDs()メソッド 
public function getObservedRoomIDs():Array

戻り値
Array
getOccupiedRoomIDs()メソッド 
public function getOccupiedRoomIDs():Array

戻り値
Array
getPing()メソッド 
public function getPing():int

戻り値
int
getTimeOnline()メソッド 
public function getTimeOnline():Number

戻り値
Number
hasEventListener()メソッド 
public function hasEventListener(type:String):Boolean

パラメータ

type:String

戻り値
Boolean
init()メソッド 
public function init():void

バージョン : Reactor 1.0.0

このCustomClientオブジェクトの使用準備ができたときに呼び出される初期化メソッドです。 サブクラスでこのCustomClientで構成されたClientオブジェクトを必要とする初期化タスクを実行したいときはこのメソッドをオーバーライドするとよいでしょう。

isAdmin()メソッド 
public function isAdmin():Boolean

戻り値
Boolean
isInRoom()メソッド 
public function isInRoom(roomID:String):Boolean

パラメータ

roomID:String

戻り値
Boolean
isObservingRoom()メソッド 
public function isObservingRoom(roomID:String):Boolean

パラメータ

roomID:String

戻り値
Boolean
isSelf()メソッド 
public function isSelf():Boolean

戻り値
Boolean
kick()メソッド 
public function kick():void

observe()メソッド 
public function observe():void

removeEventListener()メソッド 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

パラメータ

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

sendMessage()メソッド 
public function sendMessage(messageName:String, ... args):void

パラメータ

messageName:String
 
... args

setAttribute()メソッド 
public function setAttribute(attrName:String, attrValue:String, attrScope:String = null, isShared:Boolean = true, evaluate:Boolean = false):void

パラメータ

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

setClient()メソッド 
public function setClient(client:Client):void

バージョン : Reactor 1.0.0

Reactorによって内部的に使用され、このCustomClientオブジェクトをClientオブジェクトと関連づけます。

パラメータ

client:Client

setClientClass()メソッド 
public function setClientClass(scope:String, clientClass:Class, ... fallbackClasses):void

パラメータ

scope:String
 
clientClass:Class
 
... fallbackClasses

stopObserving()メソッド 
public function stopObserving():void

toString()メソッド 
public function toString():String

戻り値
String
willTrigger()メソッド 
public function willTrigger(type:String):Boolean

パラメータ

type:String

戻り値
Boolean