パッケージnet.user1.reactor
クラスpublic class ClientEvent
継承ClientEvent Inheritance flash.events.Event

バージョン : Reactor 1.0.0

ClientEventは、クライアントイベントが発生したときにClientオブジェクトから登録済みイベントリスナーに情報を渡すために使用されるシンプルなデータクラスです。 ClientEventクラスは利用可能なクライアントイベントの定数表現も定義します。 クライアントイベントを登録するには、ClientクラスのaddEventListener()メソッドを使用します。 次のコードで実例を示します。 
   // イベント登録コード
   someClient.addEventListener(ClientEvent.JOIN_ROOM,
                               joinRoomListener);
   // イベントリスナーのコード
   protected function joinRoomListener (e:ClientEvent):void {
     trace(Client(e.target) + " joined room: " + e.getRoom());
   }

関連項目

Client

パブリック メソッド
 メソッド定義元
  
ClientEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, changedAttr:Attribute = null, room:Room = null, roomID:String = null, client:IClient = null, status:String = null, clientID:String = null)
コンストラクタ
ClientEvent
  
clone():Event
[オーバーライド]
ClientEvent
  
getClient():IClient
このクライアントイベントに関係するClientオブジェクトを返します(例えば、観察を開始されたクライアント)。
ClientEvent
  
getClientID():String
このイベントが関係するクライアントのclientIDを返します。
ClientEvent
  
getRoom():Room
このクライアントイベントに関係するRoomオブジェクトを返します(例えば、入室あるいは退室されたルーム)。
ClientEvent
  
getRoomID():String
このクライアントイベントに関係するRoomオブジェクト(例えば、入退室されたルーム)の完全修飾ルームIDを返します。
ClientEvent
  
getStatus():String
このイベントに関係する操作のステータスを返します。
ClientEvent
  
toString():String
[オーバーライド]
ClientEvent
パブリック 定数
 定数定義元
  JOIN_ROOM : String = JOIN_ROOM
[静的] このイベントをトリガーしたクライアントがルームに入室するときに送出されます。
ClientEvent
  LEAVE_ROOM : String = LEAVE_ROOM
[静的] このイベントをトリガーしたクライアントがルームから退室するときに送出されます。
ClientEvent
  OBSERVE : String = OBSERVE
[静的] 現クライアントがクライアントを観察するときに送出されます。
ClientEvent
  OBSERVE_RESULT : String = OBSERVE_RESULT
[静的] 先に行われたClient.observe()かClientManager.observeClient()要求の結果を受信したときに送出されます。
ClientEvent
  OBSERVE_ROOM : String = OBSERVE_ROOM
[静的] このイベントをトリガーしたクライアントがルームの観戦を開始するときに送出されます。
ClientEvent
  STOP_OBSERVING : String = STOP_OBSERVING
[静的] 現クライアントがクライアントの観察を停止するときに送出されます。
ClientEvent
  STOP_OBSERVING_RESULT : String = STOP_OBSERVING_RESULT
[静的] 先に行われたClient.stopObserving()かClientManager.stopObservingClient()要求の結果を受信したときに送出されます。
ClientEvent
  STOP_OBSERVING_ROOM : String = STOP_OBSERVING_ROOM
[静的] このイベントをトリガーしたクライアントがルームの観戦を停止するときに送出されます。
ClientEvent
  SYNCHRONIZE : String = SYNCHRONIZE
[静的] このイベントをトリガーしたクライアントが先に行ったobserve()要求によってサーバー状態と一致するように同期したときに送出されます。
ClientEvent
コンストラクタの詳細
ClientEvent()コンストラクタ
public function ClientEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, changedAttr:Attribute = null, room:Room = null, roomID:String = null, client:IClient = null, status:String = null, clientID:String = null)

コンストラクタ

パラメータ
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
changedAttr:Attribute (default = null)
 
room:Room (default = null)
 
roomID:String (default = null)
 
client:IClient (default = null)
 
status:String (default = null)
 
clientID:String (default = null)
メソッドの詳細
clone()メソッド
override public function clone():Event

戻り値
Event
getClient()メソッド 
public function getClient():IClient

バージョン : Reactor 1.0.0

このクライアントイベントに関係するClientオブジェクトを返します(例えば、観察を開始されたクライアント)。 getClient()メソッドはClientEventのターゲットがClientManagerのときにのみ必要となります。ClientEventのターゲットがClientオブジェクトのときは、このイベントのtargetプロパティはClientオブジェクトへのアクセスを提供します。

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

バージョン : Reactor 1.0.0

このイベントが関係するクライアントのclientIDを返します。 例えば、ClientEvent.JOIN_ROOMイベントにおいては、getClientID()はルームに入室したクライアントのIDを返します。

戻り値
String
getRoom()メソッド 
public function getRoom():Room

バージョン : Reactor 1.0.0

このクライアントイベントに関係するRoomオブジェクトを返します(例えば、入室あるいは退室されたルーム)。

戻り値
Room
getRoomID()メソッド 
public function getRoomID():String

バージョン : Reactor 1.0.0

このクライアントイベントに関係するRoomオブジェクト(例えば、入退室されたルーム)の完全修飾ルームIDを返します。

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

バージョン : Reactor 1.0.0

このイベントに関係する操作のステータスを返します。 getStatus()メソッドの戻り値は常にStatusクラスの定数のどれかになります。 例えば、 もし入室の試行が成功し、その反映としてClientEvent.JOIN_RESULTイベントが発生したとすると、getStatus()はStatus.SUCCESS値を返します。 ステータスに対応するには、getStatus()の値とStatus定数とを比較します。 例えば、 

if (e.getStatus() != Status.SUCCESS) {
       showJoinFailedScreen();
     }
特定のイベントが発生したときに返されうるステータス値のリストについては、そのイベントのドキュメントを参照してください。

戻り値
String
toString()メソッド 
override public function toString():String

戻り値
String
定数の詳細
JOIN_ROOM定数
public static const JOIN_ROOM:String = JOIN_ROOM

バージョン : Reactor 1.0.0

このイベントをトリガーしたクライアントがルームに入室するときに送出されます。

関連項目

RoomEvent.JOIN
LEAVE_ROOM定数 
public static const LEAVE_ROOM:String = LEAVE_ROOM

バージョン : Reactor 1.0.0

このイベントをトリガーしたクライアントがルームから退室するときに送出されます。 このイベントは対象のクライアントを含むルームが除去され、クライアントが退室を強制されるときにも発生します。

関連項目

RoomEvent.LEAVE
OBSERVE定数 
public static const OBSERVE:String = OBSERVE

バージョン : Reactor 1.0.0

現クライアントがクライアントを観察するときに送出されます。 観察されるようになったクライアントにはClientEventのgetClient()メソッドを通してアクセスできます。

関連項目

Client.observe()
ClientManager.observeClient()
OBSERVE_RESULT定数 
public static const OBSERVE_RESULT:String = OBSERVE_RESULT

バージョン : Reactor 1.0.0

先に行われたClient.observe()かClientManager.observeClient()要求の結果を受信したときに送出されます。

関連項目

ClientEvent.OBSERVE
OBSERVE_ROOM定数 
public static const OBSERVE_ROOM:String = OBSERVE_ROOM

バージョン : Reactor 1.0.0

このイベントをトリガーしたクライアントがルームの観戦を開始するときに送出されます。

関連項目

RoomEvent.OBSERVE
STOP_OBSERVING定数 
public static const STOP_OBSERVING:String = STOP_OBSERVING

バージョン : Reactor 1.0.0

現クライアントがクライアントの観察を停止するときに送出されます。 もはや観察されていないクライアントにはClientEventのgetClient()メソッドを通してアクセスできます。

関連項目

Client.stopObserving()
STOP_OBSERVING_RESULT定数 
public static const STOP_OBSERVING_RESULT:String = STOP_OBSERVING_RESULT

バージョン : Reactor 1.0.0

先に行われたClient.stopObserving()かClientManager.stopObservingClient()要求の結果を受信したときに送出されます。

関連項目

ClientEvent.STOP_OBSERVING
STOP_OBSERVING_ROOM定数 
public static const STOP_OBSERVING_ROOM:String = STOP_OBSERVING_ROOM

バージョン : Reactor 1.0.0

このイベントをトリガーしたクライアントがルームの観戦を停止するときに送出されます。 このイベントはそのクライアントを含むルームを除去するときにも発生し、クライアントにそのルームの観戦を強制的に停止させます。

関連項目

RoomEvent.STOP_OBSERVING
SYNCHRONIZE定数 
public static const SYNCHRONIZE:String = SYNCHRONIZE

バージョン : Reactor 1.0.0

このイベントをトリガーしたクライアントが先に行ったobserve()要求によってサーバー状態と一致するように同期したときに送出されます。

関連項目

Client.observe()
ClientManager.observeClient()



Copyright USER1 Subsystems Corporation

Sun Apr 11 2010, 08:51 PM -04:00