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

バージョン : Reactor 1.0.0

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

関連項目

Room.addEventListener()


パブリック メソッド
 メソッド定義元
  
RoomEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, client:IClient = null, clientID:String = null, status:String = null, changedAttr:Attribute = null, numClients:int = 0, roomID:String = null)
コンストラクタ
RoomEvent
  
clone():Event
[オーバーライド]
RoomEvent
  
変更されたルームかクライアントの属性情報を含む属性オブジェクトを返します。
RoomEvent
  
このイベントに関連するClientオブジェクトの参照を返します。
RoomEvent
  
getClientID():String
このイベントに関連するクライアントのIDを返します。
RoomEvent
  
getNumClients():Number
現在このルームに入室中のクライアント数を返します。
RoomEvent
  
getRoomID():String
RoomManagerによって送出されるRoomEventイベントについては、getRoomID()はこのイベントに関わるルームのルームIDを返します。
RoomEvent
  
getStatus():String
このイベントに関係する操作のステータスを返します。
RoomEvent
  
toString():String
[オーバーライド]
RoomEvent
パブリック 定数
 定数定義元
  ADD_OBSERVER : String = ADD_OBSERVER
[静的] クライアントがルームの観察を開始し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室か観察している、2) 現クライアントがそのルームの "観察者リスト" 更新を有効にしている (観察者リスト更新はデフォルトでは無効です)。
RoomEvent
  ADD_OCCUPANT : String = ADD_OCCUPANT
[静的] クライアントがルームに入室し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室か観察している、2) 現クライアントがそのルームの "入室者リスト" 更新を有効にしている (入室者リスト更新はデフォルトで有効です)。
RoomEvent
  DELETE_CLIENT_ATTRIBUTE : String = DELETE_CLIENT_ATTRIBUTE
[静的] 現クライアントがルームに入室しているか観察していて、現クライアントが関心を持っている属性がそのルーム内の入室者か観察者のいずれかによって除去されたときに送出されます。
RoomEvent
  JOIN : String = JOIN
[静的] サーバー側のコードか、先にルームへの入室要求を行った結果として、現クライアントがルームへの入室に成功したときに送出されます。
RoomEvent
  JOIN_RESULT : String = JOIN_RESULT
[静的] 先に行われたルーム入室要求の結果を取得したときに送出されます。
RoomEvent
  LEAVE : String = LEAVE
[静的] サーバー側のコードか、先にルームからの退室要求を行った結果として、現クライアントがルームからの退室に成功したときに送出されます。
RoomEvent
  LEAVE_RESULT : String = LEAVE_RESULT
[静的] 先に行われたルーム退室要求の結果を取得したときに送出されます。
RoomEvent
  OBSERVE : String = OBSERVE
[静的] サーバー側のコードか、先にルームの観察要求を行った結果として、現クライアントがルームの観察に成功したときに送出されます。
RoomEvent
  OBSERVER_COUNT : String = OBSERVER_COUNT
[静的] 現クライアントが入室しているか観察しているルームの観察者数が変化し、現クライアントがそのルームについて"観察者リスト"更新か"観察者カウント"更新を有効にしているときに送出されます(どちらもデフォルトでは無効になっています)。
RoomEvent
  OBSERVE_RESULT : String = OBSERVE_RESULT
[静的] 先に行われたルーム観察要求の結果を取得したときに送出されます。
RoomEvent
  OCCUPANT_COUNT : String = OCCUPANT_COUNT
[静的] 現クライアントが入室しているか観察しているルームの入室者数が変化し、現クライアントがそのルームについて"入室者リスト"更新か"入室者カウント"更新を有効にしているときに送出されます(入室者リスト更新はデフォルトで有効になっています)。
RoomEvent
  REMOVED : String = REMOVED
[静的] それまで現クライアントによって把握されていたルームが把握できなくなったときに送出されます。
RoomEvent
  REMOVE_OBSERVER : String = REMOVE_OBSERVER
[静的] クライアントがルームの観察を停止し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室か観察している、2) 現クライアントがそのルームの "観察者リスト" 更新を有効にしている (観察者リスト更新はデフォルトでは無効です)。
RoomEvent
  REMOVE_OCCUPANT : String = REMOVE_OCCUPANT
[静的] クライアントがルームから退室し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室か観察している、2) 現クライアントがそのルームの "入室者リスト" 更新を有効にしている (入室者リスト更新はデフォルトで有効です)。
RoomEvent
  STOP_OBSERVING : String = STOP_OBSERVING
[静的] サーバー側のコードか、先にルームの観察停止要求を行った結果として、現クライアントがルームの観察停止に成功したときに送出されます。
RoomEvent
  STOP_OBSERVING_RESULT : String = STOP_OBSERVING_RESULT
[静的] 先に行われた観察停止要求の結果を取得したときに送出されます。
RoomEvent
  SYNCHRONIZE : String = SYNCHRONIZE
[静的] ルームがサーバーの状態と同期したときに送出されます。
RoomEvent
  UPDATE_CLIENT_ATTRIBUTE : String = UPDATE_CLIENT_ATTRIBUTE
[静的] 現クライアントがルームに入室しているか観察していて、現クライアントが関心を持っている属性がそのルーム内の入室者か観察者のいずれかにおいて変更されたときに送出されます。
RoomEvent
コンストラクタの詳細
RoomEvent()コンストラクタ
public function RoomEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, client:IClient = null, clientID:String = null, status:String = null, changedAttr:Attribute = null, numClients:int = 0, roomID:String = null)

コンストラクタ

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

戻り値
Event
getChangedAttr()メソッド 
public function getChangedAttr():Attribute

バージョン : Reactor 1.0.0

変更されたルームかクライアントの属性情報を含む属性オブジェクトを返します。 このメソッドは次のイベントに適用されます。

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

バージョン : Reactor 1.0.0

このイベントに関連するClientオブジェクトの参照を返します。 このメソッドは次のイベントに適用されます。

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

バージョン : Reactor 1.0.0

このイベントに関連するクライアントのIDを返します。 このメソッドは次のイベントに適用されます。

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

バージョン : Reactor 1.0.0

現在このルームに入室中のクライアント数を返します。 このメソッドは次のイベントに適用されます。

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

バージョン : Reactor 1.0.0

RoomManagerによって送出されるRoomEventイベントについては、getRoomID()はこのイベントに関わるルームのルームIDを返します。 例えば、RoomManagerがRoomEvent.JOIN_RESULTイベントを送出するとき、getRoomID()はそのクライアントが入室を試行したルームのルームIDを返します。 個別のRoomオブジェクトによって送出されるRoomEventイベントについては、getRoomID()は常にnullを返します。 個別のルームオブジェクトによって送出されるイベントのルームIDを取得するには、そのRoomEventイベントリスナー内でそのEventクラスのtarget変数を使用してください。 例えば、

     protected function joinListener (e:RoomEvent) {
       trace(Room(e.target).getRoomID());
     }
     

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

バージョン : Reactor 1.0.0

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

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

戻り値
String

関連項目

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

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

バージョン : Reactor 1.0.0

クライアントがルームの観察を開始し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室か観察している、2) 現クライアントがそのルームの "観察者リスト" 更新を有効にしている (観察者リスト更新はデフォルトでは無効です)。 ルームの観察者リストを有効化あるいは無効化するには、UpdateLevelsオブジェクトにobserverList変数をセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:

例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける観察者リストの更新を有効化します:

     var updateLevels:UpdateLevels = new UpdateLevels();
     updateLevels.observerList = true;
     theRoom.setUpdateLevels(updateLevels);
     

関連項目

ADD_OCCUPANT定数 
public static const ADD_OCCUPANT:String = ADD_OCCUPANT

バージョン : Reactor 1.0.0

クライアントがルームに入室し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室か観察している、2) 現クライアントがそのルームの "入室者リスト" 更新を有効にしている (入室者リスト更新はデフォルトで有効です)。 ルームの入室者リストを有効化あるいは無効化するには、UpdateLevelsオブジェクトにoccupantList変数をセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:

例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける入室者リストの更新を無効化します:

     var updateLevels:UpdateLevels = new UpdateLevels();
     updateLevels.occupantList = false;
     theRoom.setUpdateLevels(updateLevels);
     

関連項目

DELETE_CLIENT_ATTRIBUTE定数 
public static const DELETE_CLIENT_ATTRIBUTE:String = DELETE_CLIENT_ATTRIBUTE

バージョン : Reactor 1.0.0

現クライアントがルームに入室しているか観察していて、現クライアントが関心を持っている属性がそのルーム内の入室者か観察者のいずれかによって除去されたときに送出されます。 特に、RoomEvent.DELETE_CLIENT_ATTRIBUTE は次のいずれかが発生するとトリガーされます:

ルームの入室者または観察者の属性更新を有効化あるいは無効化するには、最初に、UpdateLevelsオブジェクト上の次の変数のいずれかをセットします:

次に、次のメソッドのいずれかにUpdateLevelsオブジェクトを渡します:

例えば、次のコードはtheRoomによって参照されるルームの入室者の全ての共有属性の更新を無効化します:

     var updateLevels:UpdateLevels = new UpdateLevels();
     updateLevels.sharedOccupantAttributesRoom = false;
     updateLevels.sharedOccupantAttributesGlobal = false;
     theRoom.setUpdateLevels(updateLevels);
     

関連項目

JOIN定数 
public static const JOIN:String = JOIN

バージョン : Reactor 1.0.0

サーバー側のコードか、先にルームへの入室要求を行った結果として、現クライアントがルームへの入室に成功したときに送出されます。

RoomEvent.JOINイベントは現クライアントにのみ適用される点に留意してください。 任意のクライアントがルームに入室するときに通知を受けるには、RoomEvent.ADD_OCCUPANTイベントを登録してください。

関連項目

JOIN_RESULT定数 
public static const JOIN_RESULT:String = JOIN_RESULT

バージョン : Reactor 1.0.0

先に行われたルーム入室要求の結果を取得したときに送出されます。 要求の結果を確認するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:

もしルーム入室要求が成功した場合、RoomEvent.JOINイベントもトリガーされます。

関連項目

LEAVE定数 
public static const LEAVE:String = LEAVE

バージョン : Reactor 1.0.0

サーバー側のコードか、先にルームからの退室要求を行った結果として、現クライアントがルームからの退室に成功したときに送出されます。

RoomEvent.LEAVEイベントは現クライアントにのみ適用される点に留意してください。 任意のクライアントがルームから退出するときに通知を受けるには、RoomEvent.REMOVE_OCCUPANTイベントを登録してください。

LEAVE_RESULT定数 
public static const LEAVE_RESULT:String = LEAVE_RESULT

バージョン : Reactor 1.0.0

先に行われたルーム退室要求の結果を取得したときに送出されます。 要求の結果を確認するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:

もしその入退室要求が成功した場合、RoomEvent.LEAVEイベントもトリガーされます。

関連項目

OBSERVE定数 
public static const OBSERVE:String = OBSERVE

バージョン : Reactor 1.0.0

サーバー側のコードか、先にルームの観察要求を行った結果として、現クライアントがルームの観察に成功したときに送出されます。 RoomEvent.OBSERVEは現クライアントにしか適用されない点に留意してください。他のクライアントがルームを観察するときに通知を受けるには、RoomEvent.ADD_OBSERVERイベントを登録してください。

関連項目

OBSERVE_RESULT定数 
public static const OBSERVE_RESULT:String = OBSERVE_RESULT

バージョン : Reactor 1.0.0

先に行われたルーム観察要求の結果を取得したときに送出されます。 要求の結果を確認するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:

関連項目

OBSERVER_COUNT定数 
public static const OBSERVER_COUNT:String = OBSERVER_COUNT

バージョン : Reactor 1.0.0

現クライアントが入室しているか観察しているルームの観察者数が変化し、現クライアントがそのルームについて"観察者リスト"更新か"観察者カウント"更新を有効にしているときに送出されます(どちらもデフォルトでは無効になっています)。 ルームの観察者リストの更新か観察者数の更新を有効化あるいは無効化するには、(それぞれ)observerList変数かobserverCount変数をUpdateLevelsオブジェクトにセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:

例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける観察者数の更新を有効化します:

     var updateLevels:UpdateLevels = new UpdateLevels();
     updateLevels.observerCount = true;
     theRoom.setUpdateLevels(updateLevels);
     

関連項目

OCCUPANT_COUNT定数 
public static const OCCUPANT_COUNT:String = OCCUPANT_COUNT

バージョン : Reactor 1.0.0

現クライアントが入室しているか観察しているルームの入室者数が変化し、現クライアントがそのルームについて"入室者リスト"更新か"入室者カウント"更新を有効にしているときに送出されます(入室者リスト更新はデフォルトで有効になっています)。 ルームの入室者リストの更新か入室者数の更新を有効化あるいは無効化するには、(それぞれ)occupantList変数かoccupantCount変数をUpdateLevelsオブジェクトにセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:

例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける入室者リストの更新を無効化し、入室者数の更新を有効化します:

     var updateLevels:UpdateLevels = new UpdateLevels();
     updateLevels.occupantList = false;
     updateLevels.occupantCount = true;
     theRoom.setUpdateLevels(updateLevels);
     

関連項目

REMOVE_OBSERVER定数 
public static const REMOVE_OBSERVER:String = REMOVE_OBSERVER

バージョン : Reactor 1.0.0

クライアントがルームの観察を停止し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室か観察している、2) 現クライアントがそのルームの "観察者リスト" 更新を有効にしている (観察者リスト更新はデフォルトでは無効です)。 ルームの観察者リストを有効化あるいは無効化するには、UpdateLevelsオブジェクトにobserverList変数をセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:

例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける観察者リストの更新を有効化します:

     var updateLevels:UpdateLevels = new UpdateLevels();
     updateLevels.observerList = true;
     theRoom.setUpdateLevels(updateLevels);
     

関連項目

REMOVE_OCCUPANT定数 
public static const REMOVE_OCCUPANT:String = REMOVE_OCCUPANT

バージョン : Reactor 1.0.0

クライアントがルームから退室し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室か観察している、2) 現クライアントがそのルームの "入室者リスト" 更新を有効にしている (入室者リスト更新はデフォルトで有効です)。 ルームの入室者リストを有効化あるいは無効化するには、UpdateLevelsオブジェクトにoccupantList変数をセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:

例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける入室者リストの更新を無効化します:

     var updateLevels:UpdateLevels = new UpdateLevels();
     updateLevels.occupantList = false;
     theRoom.setUpdateLevels(updateLevels);
     

関連項目

REMOVED定数 
public static const REMOVED:String = REMOVED

バージョン : Reactor 1.0.0

それまで現クライアントによって把握されていたルームが把握できなくなったときに送出されます。 ルームはキャッシュされたか、入室したか、観察を開始したか、または監視されたときに現クライアントによって把握されます。 現クライアントのルームキャッシュについての情報については、RoomManagerのdisposeChachedRooms()メソッドを参照してください。

関連項目

STOP_OBSERVING定数 
public static const STOP_OBSERVING:String = STOP_OBSERVING

バージョン : Reactor 1.0.0

サーバー側のコードか、先にルームの観察停止要求を行った結果として、現クライアントがルームの観察停止に成功したときに送出されます。

関連項目

STOP_OBSERVING_RESULT定数 
public static const STOP_OBSERVING_RESULT:String = STOP_OBSERVING_RESULT

バージョン : Reactor 1.0.0

先に行われた観察停止要求の結果を取得したときに送出されます。 要求の結果を確認するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:

関連項目

SYNCHRONIZE定数 
public static const SYNCHRONIZE:String = SYNCHRONIZE

バージョン : Reactor 1.0.0

ルームがサーバーの状態と同期したときに送出されます。 ルームは現クライアントが入室か観察を開始するときに同期されます。

関連項目

UPDATE_CLIENT_ATTRIBUTE定数 
public static const UPDATE_CLIENT_ATTRIBUTE:String = UPDATE_CLIENT_ATTRIBUTE

バージョン : Reactor 1.0.0

現クライアントがルームに入室しているか観察していて、現クライアントが関心を持っている属性がそのルーム内の入室者か観察者のいずれかにおいて変更されたときに送出されます。 特に、RoomEvent.UPDATE_CLIENT_ATTRIBUTE は次のいずれかが発生するとトリガーされます:

ルームの入室者または観察者の属性更新を有効化あるいは無効化するには、最初に、UpdateLevelsオブジェクト上の次の変数のいずれかをセットします:

次に、次のメソッドのいずれかにUpdateLevelsオブジェクトを渡します:

例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける観察者のルームをスコープとした共有属性の更新を有効化します:

     var updateLevels:UpdateLevels = new UpdateLevels();
     updateLevels.sharedObserverAttributesRoom = true;
     theRoom.setUpdateLevels(updateLevels);
     

関連項目