| パッケージ | net.user1.reactor |
| クラス | public class RoomManager |
| 継承 | RoomManager  flash.events.EventDispatcher |
| バージョン : | Reactor 1.0.0 |
reactor.getRoomManager()
reactor.getRoomManager().getRoom("examples.chat");
var room:Room = reactor.getRoomManager().createRoom("examples.chat");
room.join();
関連項目
| メソッド | 定義元 | ||
|---|---|---|---|
RoomManager(reactor:Reactor) コンストラクタ | RoomManager | ||
createRoom(roomID:String = null, roomSettings:RoomSettings = null, attributes:XML = null, modules:RoomModules = null):Room createRoom()メソッドはこのクライアント上で新しいRoomオブジェクトを生成し、それに一致するルームをサーバー側でも生成しようと試みます。 | RoomManager | ||
disposeCachedRooms():void このRoomManagerのルームキャッシュから全てのルームを強制的に除去します。 | RoomManager | ||
getNumRooms(qualifier:String = null):int 現在RoomManagerが把握している範囲で指定の修飾子をもつルームの数を返します。 | RoomManager | ||
roomIDによって指定されるRoomインスタンスへの参照を返します。 | RoomManager | ||
RoomManagerのRoomClassRegistryオブジェクトを返します。これは全てのクライアント側のルームクラスを網羅します。 | RoomManager | ||
getRoomIDs():Array このRoomManagerが把握しているRoomオブジェクトのルームIDの配列を返します。 | RoomManager | ||
getRooms():Array このRoomManagerが把握しているRoomオブジェクトの配列を返します。 | RoomManager | ||
getRoomsWithQualifier(qualifier:String = null):Array 指定したルーム修飾子を持つRoomオブジェクトの配列を返します。 | RoomManager | ||
hasCachedRoom(roomID:String):Boolean もしRoomManagerがそのルームキャッシュリスト内に指定のroomIDのRoomオブジェクトを保持している場合はtrueを、そうでない場合はfalseを返します。 | RoomManager | ||
hasObservedRoom(roomID:String):Boolean もし現クライアントが指定のルームを観戦していることが把握できていればtrueを、そうでない場合はfalseを返します。 | RoomManager | ||
hasOccupiedRoom(roomID:String):Boolean もし現クライアントが指定のルーム内にいることが把握できていればtrueを、そうでない場合はfalseを返します。 | RoomManager | ||
hasWatchedRoom(roomID:String):Boolean もしRoomManagerがその監視中のルームリスト内に指定のroomIDのRoomオブジェクトを保持している場合はtrueを、そうでない場合はfalseを返します。 | RoomManager | ||
isWatchingQualifier(qualifier:String):Boolean 現クライアントが指定した修飾子を監視するかどうかを指定します。 | RoomManager | ||
現クライアントをサーバー側のルームに配置するようにサーバーに要求します。 | RoomManager | ||
observeRoom()メソッドはクライアントがルームに入室することなくその状態と活動を監視するための手段を提供します。 | RoomManager | ||
removeRoom(roomID:String, password:String = null):void 指定したルームの除去をサーバーに要求します。 | RoomManager | ||
roomIsKnown(roomID:String):Boolean もし指定したルームがRoomManagerによって把握されていればtrueを返します。 | RoomManager | ||
sendMessage(messageName:String, rooms:Array, includeSelf:Boolean = false, filters:IFilter = null, ... rest):void roomsで指定したルーム内のクライアントにメッセージを送信します。 | RoomManager | ||
stopWatchingForRooms(roomQualifier:String = null):void サーバーにルームの監視停止を要求します。 | RoomManager | ||
watchForRooms(roomQualifier:String = null):void 指定の修飾子を持つルームが生成または除去されたときにはいつでも通知を送るようにサーバーに要求します。 | RoomManager | ||
| Event | Summary | 定義元 | ||
|---|---|---|---|---|
| 現クライアントによって行われたルーム作成の試行結果をサーバーが報告するときに送出されます。 | RoomManager | |||
| 先に行われたルーム入室要求の結果を取得したときに送出されます。 | RoomManager | |||
| 先に行われたルーム退室要求の結果を取得したときに送出されます。 | RoomManager | |||
| 先に行われたルーム観察要求の結果を取得したときに送出されます。 | RoomManager | |||
| 現クライアントによって行われたルーム除去の試行結果をサーバーが報告するときに送出されます。 | RoomManager | |||
| 現クライアントが新たなルームを把握したときに送出されます。これは次の環境で発生します: 現クライアントがまだ観戦していないルームに入室する 現クライアントがまだ入室していないルームを観戦する 現クライアントによって監視されている修飾子をもつルームがサーバーに追加される ROOM_ADDEDとCREATE_ROOM_RESULTとの間の違いに注意してください: ROOM_ADDEDはRoomManagerがルームを把握できたことを示します。 CREATE_ROOM_RESULTはサーバー側がルーム生成を試行した結果を現クライアントに単に通知します。 | RoomManager | |||
| RoomManagerEvent.ROOM_ADDED および RoomManagerEvent.ROOM_REMOVEDによって記述されるように、RoomManagerがルーム情報を得るか失うかするときに送出されます。 | RoomManager | |||
| 現クライアントがルームを把握できなくなったときに送出されます。これは次の環境で発生します。 現クライアントが観戦していないルームから退室する 現クライアントが入室していないルームの観戦を停止する 現クライアントによって監視されている修飾子を持つルームがサーバーから除去される 現クライアントによるルーム除去の試行が成功する | RoomManager | |||
| 先に行われた観察停止要求の結果を取得したときに送出されます。 | RoomManager | |||
| 現クライアントによって行われたルーム監視停止の試行結果をサーバーが報告するときに送出されます。 | RoomManager | |||
| 現クライアントによって行われたルーム監視の試行結果をサーバーが報告するときに送出されます。 | RoomManager | |||
| RoomManager | () | コンストラクタ |
public function RoomManager(reactor:Reactor)コンストラクタ
パラメータreactor:Reactor — このRoomManagerを生成したReactorのインスタンスです。 |
| createRoom | () | メソッド |
public function createRoom(roomID:String = null, roomSettings:RoomSettings = null, attributes:XML = null, modules:RoomModules = null):Room| バージョン : | Reactor 1.0.0 |
createRoom()メソッドはこのクライアント上で新しいRoomオブジェクトを生成し、それに一致するルームをサーバー側でも生成しようと試みます。 roomIDが指定されると、新しいルームにはそのIDが与えられます。 指定がない場合、サーバーは自動的にルームIDを生成します。 ルーム生成試行の結果はRoomManagerEvent.CREATE_ROOM_RESULTイベントを通して返されます。
パラメータ
roomID:String (default = null) | |
roomSettings:RoomSettings (default = null) | |
attributes:XML (default = null)
<ATTRIBUTES>
<ATTRIBUTE>
<NAME>attrName</NAME>
<VALUE>attrValue</VALUE>
<SHARED>true|false</SHARED>
<PERSISTENT>true|false</PERSISTENT>
<IMMUTABLE>true|false</IMMUTABLE>
</ATTRIBUTE>
</ATTRIBUTES>
| |
modules:RoomModules (default = null) |
Room — もしroomIDパラメータがnullでない場合、クライアントが作成しようとしているルームを表すRoomオブジェクトを返します。 もしroomIDパラメータがnullの場合、nullを返します(この場合、現クライアントはRoomManagerEvent.CREATE_ROOM_RESULTを通して動的に生成されたroomIDが返されたあとにルームへのアクセスを取得できるはずです)。 |
関連項目
var settings:RoomSettings = new RoomSettings();
settings.dieOnEmpty = false;
settings.maxClients = 50;
var room:Room = connection.getRoomManager().createRoom(roomID,
settings);| disposeCachedRooms | () | メソッド |
public function disposeCachedRooms():void| バージョン : | Reactor 1.0.0 |
このRoomManagerのルームキャッシュから全てのルームを強制的に除去します。 ルームは次の状況でルームキャッシュに追加される可能性があります:
reactor.getRoomManager().joinRoom("examples.chat");
関連項目
| getNumRooms | () | メソッド |
public function getNumRooms(qualifier:String = null):int| バージョン : | Reactor 1.0.0 |
現在RoomManagerが把握している範囲で指定の修飾子をもつルームの数を返します。 サーバーに存在していてもクライアント側のルームマネージャーに把握されていないルームはgetNumRooms()が返す値に反映されません。 RoomManagerをサーバーのルームリストに同期させるには、watchForRooms()を使用してください(これはRoomManagerを自動的にサーバーのルームリストに同期させます)。
パラメータ
qualifier:String (default = null) |
int — 指定の修飾子を持ち、RoomManagerが把握しているルーム数を示すint値です。 |
関連項目
| getRoom | () | メソッド |
public function getRoom(roomID:String):Room| バージョン : | Reactor 1.0.0 |
roomIDによって指定されるRoomインスタンスへの参照を返します。 該当するRoomインスタンスが存在しない場合はnullを返します。
パラメータ
roomID:String — 取り出すRoomオブジェクトの完全修飾IDです。 |
Room |
reactor.getRoomManager().getRoom("chatrooms.sportschat");| getRoomClassRegistry | () | メソッド |
public function getRoomClassRegistry():RoomClassRegistry| バージョン : | Reactor 1.0.0 |
RoomManagerのRoomClassRegistryオブジェクトを返します。これは全てのクライアント側のルームクラスを網羅します。
戻り値RoomClassRegistry |
関連項目
| getRoomIDs | () | メソッド |
public function getRoomIDs():Array| バージョン : | Reactor 1.0.0 |
このRoomManagerが把握しているRoomオブジェクトのルームIDの配列を返します。 配列はRoomManagerが把握しているルームリスト内のルームIDのコピーであり、getRoomIDs()を呼び出した後は更新されません。 ルームIDのかわりにRoomインスタンスの配列を取り出すには、RoomManagerのgetRoom()メソッドを使用してください。
戻り値Array — ルームIDのストリング値の配列です。 |
関連項目
| getRooms | () | メソッド |
public function getRooms():Array| バージョン : | Reactor 1.0.0 |
このRoomManagerが把握しているRoomオブジェクトの配列を返します。 リストにはRoomManagerが存在を確認したルームのみが含まれ、RoomManagerがjoinRoom()呼び出しのような未完の操作によって先を見越して生成されたルームは含みません。 配列はRoomManagerが把握しているルームリストの一時的なコピーであり、getRooms()を呼び出した後は更新されません。
戻り値Array |
関連項目
| getRoomsWithQualifier | () | メソッド |
public function getRoomsWithQualifier(qualifier:String = null):Array| バージョン : | Reactor 1.0.0 |
指定したルーム修飾子を持つRoomオブジェクトの配列を返します。 この配列は一時的なスナップショットであり、getAllRooms()の呼び出し後には更新されません。 修飾子が指定されない場合、全てのルームを返します(getRooms()と同様です)。
パラメータ
qualifier:String (default = null) |
Array — Roomインスタンス（またはRoomのサブクラスのインスタンス）を含む配列です。 |
関連項目
| hasCachedRoom | () | メソッド |
public function hasCachedRoom(roomID:String):Boolean| バージョン : | Reactor 1.0.0 |
もしRoomManagerがそのルームキャッシュリスト内に指定のroomIDのRoomオブジェクトを保持している場合はtrueを、そうでない場合はfalseを返します。 watchForRooms()を参照してください。
パラメータ
roomID:String — "eaxmples.chat"のような完全修飾ルームIDです。 |
Boolean |
関連項目
| hasObservedRoom | () | メソッド |
public function hasObservedRoom(roomID:String):Boolean| バージョン : | Reactor 1.0.0 |
もし現クライアントが指定のルームを観戦していることが把握できていればtrueを、そうでない場合はfalseを返します。 observeRoom()を参照してください。
パラメータ
roomID:String — "eaxmples.chat"のような完全修飾ルームIDです。 |
Boolean |
関連項目
| hasOccupiedRoom | () | メソッド |
public function hasOccupiedRoom(roomID:String):Boolean| バージョン : | Reactor 1.0.0 |
もし現クライアントが指定のルーム内にいることが把握できていればtrueを、そうでない場合はfalseを返します。 joinRoom()を参照してください。
パラメータ
roomID:String — "eaxmples.chat"のような完全修飾ルームIDです。 |
Boolean |
関連項目
| hasWatchedRoom | () | メソッド |
public function hasWatchedRoom(roomID:String):Boolean| バージョン : | Reactor 1.0.0 |
もしRoomManagerがその監視中のルームリスト内に指定のroomIDのRoomオブジェクトを保持している場合はtrueを、そうでない場合はfalseを返します。 watchForRooms()を参照してください。
パラメータ
roomID:String — "eaxmples.chat"のような完全修飾ルームIDです。 |
Boolean |
関連項目
| isWatchingQualifier | () | メソッド |
public function isWatchingQualifier(qualifier:String):Boolean| バージョン : | Reactor 1.0.0 |
現クライアントが指定した修飾子を監視するかどうかを指定します。
パラメータ
qualifier:String |
Boolean |
関連項目
| joinRoom | () | メソッド |
public function joinRoom(roomID:String, password:String = null, updateLevels:UpdateLevels = null):Room| バージョン : | Reactor 1.0.0 |
現クライアントをサーバー側のルームに配置するようにサーバーに要求します。 ルームが既にクライアント側のルームオブジェクトによって現されていない場合は、生成して返します。 その試行結果を受信したとき、RoomEvent.JOIN_RESULTイベントがRoomManagerと入室したRoomの両方を通して送出されます。 もしその要求試行が成功すると、Roomを通してRoomEvent.JOINイベントも送出されます。 続いてRoomオブジェクトは現クライアントに指定された更新レベルに基づいて最新状態に保たれます(UpdateLevelsクラスを参照してください)。
RoomManagerのjoinRoom()メソッドは機能的にRoomのjoin()メソッドと等価ですが、Roomオブジェクトが存在していなくても使用できる点が異なります。
パラメータ
roomID:String — 入室するルームの完全修飾ルームIDです。 | |
password:String (default = null) | |
updateLevels:UpdateLevels (default = null) |
Room — 入室されるルームです。 |
関連項目
| observeRoom | () | メソッド |
public function observeRoom(roomID:String, password:String = null, updateLevels:UpdateLevels = null):Room| バージョン : | Reactor 1.0.0 |
observeRoom()メソッドはクライアントがルームに入室することなくその状態と活動を監視するための手段を提供します。 例えば、チャットモデレーターのクライアントが実際に参加せずともチャットを監視するためにチャットルームを観察することができます。
observeRoom()が実行されるとき、クライアントは指定したルームの観察開始要求を送信します。 もしその要求が成功すると、対応するクライアント側のRoomオブジェクトはサーバーと同期され、その後は指定の更新レベルに対応して最新の状態に保たれます(UpdateLevelsクラスを参照してください)。
ルームの観戦要求が完了するとき、RoomEvent.OBSERVE_RESULTイベントがRoomManagerと観戦されるRoomを通して送出されます。 もしその要求が成功すると、RoomEvent.OBSERVEもRoomを通して送出されます。
クライアントはルームを観察でき、すると観察状態に影響を及ぶことなく任意にそのルームへ入退室できます。
RoomManagerのobserveRoom()メソッドは機能的にRoomのobserve()メソッドと等価ですが、Roomオブジェクトが存在していなくても使用できる点が異なります。
パラメータ
roomID:String — 観察するルームの完全修飾IDです。 | |
password:String (default = null) | |
updateLevels:UpdateLevels (default = null) |
Room — 観察されているルームへの参照ですが、観察要求が送信できなかった場合にはnullです。 |
関連項目
| removeRoom | () | メソッド |
public function removeRoom(roomID:String, password:String = null):void| バージョン : | Reactor 1.0.0 |
指定したルームの除去をサーバーに要求します。 この試行の結果は現クライアント上でRoomManagerEvent.REMOVE_ROOM_RESULTイベントをトリガーします。 ルーム除去が成功して、対応するルームが不明になったクライアント側のRoomオブジェクトがあるとき、そのRoomオブジェクトは自動的に除去されます。
除去時にルームに入室しているクライアントは自動的にルームから強制退出され、RoomEvent.LEAVEイベントがトリガーされます。
パラメータ
roomID:String — 除去するルームの完全修飾IDです。 たとえば、"examples.chat"です。 | |
password:String (default = null) |
関連項目
| roomIsKnown | () | メソッド |
public function roomIsKnown(roomID:String):Boolean| バージョン : | Reactor 1.0.0 |
もし指定したルームがRoomManagerによって把握されていればtrueを返します。 ルームは現クライアントが入室か観戦に成功するか、RoomManagerの監視ルームリスト(watchForRooms()を参照)内にあるときに把握されます。
パラメータ
roomID:String |
Boolean |
関連項目
| sendMessage | () | メソッド |
public function sendMessage(messageName:String, rooms:Array, includeSelf:Boolean = false, filters:IFilter = null, ... rest):void| バージョン : | Reactor 1.0.0 |
roomsで指定したルーム内のクライアントにメッセージを送信します。 一つだけのルーム内のクライアントにメッセージを送信するには、RoomのsendMessage()メソッドを使用します。
ルームについてのメッセージを受信したくないクライアントは、RoomクラスのsetUpdateLevels()メソッドによってメッセージを止めることができます。
メッセージを受信するには、受信するクライアントはMessageManagerのaddMessageListener()メソッドを通してメッセージリスナーを登録する必要があります。 例えば、
msgManager.addMessageListener("CHAT_MESSAGE", centralChatListener);このメッセージリスナーは必須パラメータを定義する必要があります。詳細については、MessageManagerクラスのaddMessageListener()を参照してください。 次のコードは、現クライアントが入室あるいは監視しているいずれかのルームに"CHAT_MESSAGE"メッセージが送信されたときにいつでも呼び出されるメッセージリスナー、centralChatListener()の例を示します:
public function centralChatListener (fromClient:IClient,
toRoom:Room,
chatMessage:String):void {
与えられた修飾子によって直接修飾される(再帰しない)IDを持つ全てのルームにメッセージを送信するためには、sendMessage()のroomsパラメータに修飾子を指定し、アスタリスクを追記します。 例えば、次のコードは"examples"で修飾される全ルームに"CHAT_MESSAGE"を送信します。
reactor.getRoomManager().sendMessage("CHAT_MESSAGE",
["examples.],
true,
null,
"hi there");
サーバー上の全クライアントにメッセージを送信するには、ServerクラスのsendMessage()メソッドを使用します。
パラメータ
messageName:String — 送信するメッセージ名です。 | |
rooms:Array — メッセージを送信するルーム（複数可）です。 ルーム配列中の各エントリーは完全修飾ルームIDか、ルームIDの修飾子のどちらかです。 | |
includeSelf:Boolean (default = false) | |
filters:IFilter (default = null)rooms内の全てのリスナー登録済みクライアントはメッセージを受信します。 | |
... rest — オプションです。引数のストリング値をカンマで区切ったリストとしてこのメッセージに付与します。 これらのメッセージはメッセージの受信を登録している全てのリスナーに渡されることになります。 RoomのaddMessageListener()メソッドとMessageManagerのaddMessageListener()メソッドを参照してください。 |
関連項目
| stopWatchingForRooms | () | メソッド |
public function stopWatchingForRooms(roomQualifier:String = null):void| バージョン : | Reactor 1.0.0 |
サーバーにルームの監視停止を要求します。 応答として、サーバーは指定したroomQualifierを持つルームが追加または除去されるときにもう通知を送信しません。 stopWatchingForRooms()要求の結果はRoomManagerEvent.STOP_WATCHING_FOR_ROOMS_RESULTイベントを通して返されます。
パラメータ
roomQualifier:String (default = null) |
関連項目
| watchForRooms | () | メソッド |
public function watchForRooms(roomQualifier:String = null):void| バージョン : | Reactor 1.0.0 |
指定の修飾子を持つルームが生成または除去されたときにはいつでも通知を送るようにサーバーに要求します。 この通知はRoomManagerEvent.ROOM_ADDEDかRoomManagerEvent.ROOM_REMOVEDのどちらかのイベントをトリガします。 クライアントは通常はアプリケーションのロビーを作るためにwatchForRooms()を使用します。これはユーザーのルーム選択用に動的なルームリストを提供します。 watchForRooms()要求の結果はRoomManagerEvent.WATCH_FOR_ROOMS_RESULTを通して返されます。
パラメータ
roomQualifier:String (default = null) |
関連項目
| CREATE_ROOM_RESULT | イベント |
RoomManagerEventnet.user1.reactor.RoomManagerEvent.CREATE_ROOM_RESULT
現クライアントによって行われたルーム作成の試行結果をサーバーが報告するときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。
関連項目
| JOIN_RESULT | イベント |
RoomEventnet.user1.reactor.RoomEvent.JOIN_RESULT先に行われたルーム入室要求の結果を取得したときに送出されます。 要求の結果を究明するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:
もしルーム入室要求が成功した場合、RoomEvent.JOINイベントもトリガーされます。
関連項目
| LEAVE_RESULT | イベント |
RoomEventnet.user1.reactor.RoomEvent.LEAVE_RESULT先に行われたルーム退室要求の結果を取得したときに送出されます。 要求の結果を究明するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:
もしその入退室要求が成功した場合、RoomEvent.LEAVEイベントもトリガーされます。
関連項目
| OBSERVE_RESULT | イベント |
RoomEventnet.user1.reactor.RoomEvent.OBSERVE_RESULT先に行われたルーム観察要求の結果を取得したときに送出されます。 要求の結果を究明するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:
関連項目
| REMOVE_ROOM_RESULT | イベント |
RoomManagerEventnet.user1.reactor.RoomManagerEvent.REMOVE_ROOM_RESULT現クライアントによって行われたルーム除去の試行結果をサーバーが報告するときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。
関連項目
| ROOM_ADDED | イベント |
RoomManagerEventnet.user1.reactor.RoomManagerEvent.ROOM_ADDED現クライアントが新たなルームを把握したときに送出されます。これは次の環境で発生します:
関連項目
| ROOM_COUNT | イベント |
RoomManagerEventnet.user1.reactor.RoomManagerEvent.ROOM_COUNTRoomManagerEvent.ROOM_ADDED および RoomManagerEvent.ROOM_REMOVEDによって記述されるように、RoomManagerがルーム情報を得るか失うかするときに送出されます。 新しいルーム数を調べるには、RoomManagerEventのgetNumRooms()メソッドかRoomManagerのgetNumRooms()メソッドを使用してください。
関連項目
| ROOM_REMOVED | イベント |
RoomManagerEventnet.user1.reactor.RoomManagerEvent.ROOM_REMOVED現クライアントがルームを把握できなくなったときに送出されます。これは次の環境で発生します。
関連項目
| STOP_OBSERVING_RESULT | イベント |
RoomEventnet.user1.reactor.RoomEvent.STOP_OBSERVING_RESULT先に行われた観察停止要求の結果を取得したときに送出されます。 要求の結果を究明するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:
関連項目
| STOP_WATCHING_FOR_ROOMS_RESULT | イベント |
RoomManagerEventnet.user1.reactor.RoomManagerEvent.STOP_WATCHING_FOR_ROOMS_RESULT現クライアントによって行われたルーム監視停止の試行結果をサーバーが報告するときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。
関連項目
| WATCH_FOR_ROOMS_RESULT | イベント |
RoomManagerEventnet.user1.reactor.RoomManagerEvent.WATCH_FOR_ROOMS_RESULT現クライアントによって行われたルーム監視の試行結果をサーバーが報告するときに送出されます。 試行結果を診断するには、getStatus()を使用します。これは次の値をとる可能性があります。
関連項目