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

バージョン : Reactor 1.0.0

RoomManagerEventはルーム管理イベントが発生したときにRoomManagerオブジェクトから登録済みのイベントリスナーに情報を渡すために使用されるシンプルなデータクラスです。 RoomManagerEventクラスは利用可能なルーム管理イベントを表す定数も定義します。

ルーム管理イベントを登録するには、次のコードで示すようにRoomManagerクラスのaddEventListener()メソッドを使用します。

var roomMan:RoomManager = reactor.getRoomManager();
   roomMan.addEventListener(RoomManagerEvent.ROOM_ADDED, addedListener)
次のコードではRoomManagerEvent.CREATE_ROOM_RESULTリスナーがgetStatus()を使用してアプリケーションのエラーメッセージを表示するかどうかを確認します。
   private function createRoomResultListener (e:RoomManagerEvent):void {
     if (e.getStatus() != Status.SUCCESS) {
       displayError();  // displayError()コードはここには示しません
     }
   }
   

関連項目

RoomManager
RoomManager.addEventListener()


パブリック メソッド
 メソッド定義元
  
RoomManagerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, roomID:String = null, status:String = null, roomIdQualifier:String = null, room:Room = null, numRooms:int = -1)
コンストラクタ
RoomManagerEvent
  
clone():Event
[オーバーライド]
RoomManagerEvent
  
getNumRooms():Number
現クライアントが把握しているルームの合計数を返します。
RoomManagerEvent
  
このイベントが関係するRoomオブジェクトへの参照を返します。
RoomManagerEvent
  
getRoomID():String
このイベントに関係するルームの完全なルームIDを返します。
RoomManagerEvent
  
このイベントに関係するルームの修飾子IDを返します。
RoomManagerEvent
  
このイベントに関係するルームの単純ルームIDを返します。
RoomManagerEvent
  
getStatus():String
このイベントに関係する操作のステータスを返します。
RoomManagerEvent
  
toString():String
[オーバーライド]
RoomManagerEvent
パブリック 定数
 定数定義元
  CREATE_ROOM_RESULT : String = CREATE_ROOM_RESULT
[静的] 現クライアントによって行われたルーム作成の試行結果をサーバーが報告するときに送出されます。
RoomManagerEvent
  REMOVE_ROOM_RESULT : String = REMOVE_ROOM_RESULT
[静的] 現クライアントによって行われたルーム除去の試行結果をサーバーが報告するときに送出されます。
RoomManagerEvent
  ROOM_ADDED : String = ROOM_ADDED
[静的] 現クライアントが新たなルームを把握したときに送出されます。
RoomManagerEvent
  ROOM_COUNT : String = ROOM_COUNT
[静的] RoomManagerEvent.ROOM_ADDED および RoomManagerEvent.ROOM_REMOVEDによって記述されるように、RoomManagerがルーム情報を得るか失うかするときに送出されます。
RoomManagerEvent
  ROOM_REMOVED : String = ROOM_REMOVED
[静的] 現クライアントが新たなルームを把握できなくなったときに送出されます。
RoomManagerEvent
  STOP_WATCHING_FOR_ROOMS_RESULT : String = STOP_WATCHING_FOR_ROOMS_RESULT
[静的] 現クライアントによって行われたルーム監視停止の試行結果をサーバーが報告するときに送出されます。
RoomManagerEvent
  WATCH_FOR_ROOMS_RESULT : String = WATCH_FOR_ROOMS_RESULT
[静的] 現クライアントによって行われたルーム監視の試行結果をサーバーが報告するときに送出されます。
RoomManagerEvent
コンストラクタの詳細
RoomManagerEvent()コンストラクタ
public function RoomManagerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, roomID:String = null, status:String = null, roomIdQualifier:String = null, room:Room = null, numRooms:int = -1)

コンストラクタ

パラメータ
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
roomID:String (default = null)
 
status:String (default = null)
 
roomIdQualifier:String (default = null)
 
room:Room (default = null)
 
numRooms:int (default = -1)
メソッドの詳細
clone()メソッド
override public function clone():Event

戻り値
Event
getNumRooms()メソッド 
public function getNumRooms():Number

バージョン : Reactor 1.0.0

現クライアントが把握しているルームの合計数を返します。

getNumRooms()メソッドはRoomManagerEvent.ROOM_COUNTイベントにのみ適用されます。

戻り値
Number

関連項目

getRoom()メソッド 
public function getRoom():Room

バージョン : Reactor 1.0.0

このイベントが関係するRoomオブジェクトへの参照を返します。 例えば、RoomManagerEvent.ROOM_ADDEDイベントでは、getRoom()が追加されたルームへの参照を返します。

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

バージョン : Reactor 1.0.0

このイベントに関係するルームの完全なルームIDを返します。 "完全ルームID"はこのルームの修飾されたIDです。 例えば、修飾されたIDが"examples.chat"のルームに対して、このメソッドは"examples.chat"を返します。

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

バージョン : Reactor 1.0.0

このイベントに関係するルームの修飾子IDを返します。 たとえば、完全修飾IDが"examples.chat"のルームについては、このメソッドは"examples"を返します。

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

バージョン : Reactor 1.0.0

このイベントに関係するルームの単純ルームIDを返します。 "単純ルームID"はルームの修飾されていないIDです。 たとえば、完全修飾IDが"examples.chat"のルームに対して、このメソッドは"chat"を返します。

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

バージョン : Reactor 1.0.0

このイベントに関係する操作のステータスを返します。 getStatus()メソッドの戻り値は常にStatusクラスの定数のどれかです。 例えば、RoomManagerEvent.WATCH_FOR_ROOMS_RESULT イベントが現クライアントが既に監視しているルームにおいて発生するとき、getStatus()は Status.ALREADY_WATCHING の値を返します。 特定のRoomManagerEventイベントにおいて指定される有効なステータス値の一覧については、RoomManagerEventイベントのドキュメントを参照してください。

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

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

バージョン : Reactor 1.0.0

現クライアントによって行われたルーム作成の試行結果をサーバーが報告するときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。

RoomManagerEvent.CREATE_ROOM_RESULTは現クライアントがルーム生成を試行するときにのみトリガーされ、他のクライアントのルーム生成試行や、現クライアントが新たなルームを把握したときにはトリガーされないことに注意してください。 他のクライアントによるルーム生成に応答するには、watchForRooms()とRoomManagerEvent.ROOM_ADDEDイベントを使用してください。

関連項目

RoomManagerEvent.ROOM_ADDED
RoomManager.watchForRooms()
REMOVE_ROOM_RESULT定数 
public static const REMOVE_ROOM_RESULT:String = REMOVE_ROOM_RESULT

バージョン : Reactor 1.0.0

現クライアントによって行われたルーム除去の試行結果をサーバーが報告するときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。

関連項目

ROOM_ADDED定数 
public static const ROOM_ADDED:String = ROOM_ADDED

バージョン : Reactor 1.0.0

現クライアントが新たなルームを把握したときに送出されます。 現クライアントは次の状況でルームを把握できるようになります。

ROOM_ADDEDとCREATE_ROOM_RESULTとの間の違いに注意してください: ROOM_ADDEDはRoomManagerがルームを把握したことを示します。 CREATE_ROOM_RESULTはサーバー側がルーム生成を試行した結果を現クライアントに単に通知します。

関連項目

ROOM_COUNT定数 
public static const ROOM_COUNT:String = ROOM_COUNT

バージョン : Reactor 1.0.0

RoomManagerEvent.ROOM_ADDED および RoomManagerEvent.ROOM_REMOVEDによって記述されるように、RoomManagerがルーム情報を得るか失うかするときに送出されます。 新しいルーム数を調べるには、RoomManagerEventのgetNumRooms()メソッドかRoomManagerのgetNumRooms()メソッドを使用してください。

関連項目

RoomManager.getNumRooms()
getNumRooms()
RoomManagerEvent.ROOM_ADDED
RoomManagerEvent.ROOM_REMOVED
ROOM_REMOVED定数 
public static const ROOM_REMOVED:String = ROOM_REMOVED

バージョン : Reactor 1.0.0

現クライアントが新たなルームを把握できなくなったときに送出されます。 現クライアントは次の状況でルームを把握できなくなります。

関連項目

STOP_WATCHING_FOR_ROOMS_RESULT定数 
public static const STOP_WATCHING_FOR_ROOMS_RESULT:String = STOP_WATCHING_FOR_ROOMS_RESULT

バージョン : Reactor 1.0.0

現クライアントによって行われたルーム監視停止の試行結果をサーバーが報告するときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。

関連項目

WATCH_FOR_ROOMS_RESULT定数 
public static const WATCH_FOR_ROOMS_RESULT:String = WATCH_FOR_ROOMS_RESULT

バージョン : Reactor 1.0.0

現クライアントによって行われたルーム監視の試行結果をサーバーが報告するときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。

関連項目