パッケージnet.user1.reactor
インターフェイスpublic interface IClient extends IEventDispatcher
実装元 Client, CustomClient

バージョン : Reactor 1.0.0

このインターフェイスはReactor APIにおいてクライアントを表す全てのクラスが実装します。 自作クライアントクラスを持たないアプリケーションでは、全てのクライアントはIClientを実装したビルトインのClientクラスを使用します。 Clientよりカスタムクラスを使用したい開発者は、Reactorアプリケーションでクライアントを表すために、IClientインターフェースを実装したクラスを作成する必要があり、次にそのクラスをClientのsetClientClass()メソッド、RoomのsetDefaultClientClass()メソッド、またはClientManagerのsetDefaultClientClass()メソッドを通してカスタムクライアントクラスとして割り当てます。

テンプレートのカスタムクライアント基底クラスについては、CustomClientクラスを参照してください。

関連項目

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


パブリック メソッド
 メソッド定義元
  
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
メソッドの詳細
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)

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
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

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

パラメータ

messageName:String
 
... rest

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)

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

パラメータ

scope:String
 
clientClass:Class
 
... fallbackClasses

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