| パッケージ | net.user1.reactor.snapshot |
| クラス | public class RoomListSnapshot |
| 継承 | RoomListSnapshot Snapshot flash.events.EventDispatcher |
| バージョン : | Reactor 1.0.0 |
// サーバー上の全ルームを含むroomIDのスナップショットを生成
var snapshot:RoomListSnapshot = new RoomListSnapshot(null, true);
// コールバック関数を登録します
snapshot.onLoad = function ():void {
trace("Here is the room list: " + snapshot.getRoomList());
}
// あるいはリスナー関数を登録します
snapshot.addEventListener(SnapshotEvent.LOAD, loadListener);
function loadListener (e:SnapshotEvent):void {
var snapshot:RoomListSnapshot = RoomListSnapshot(e.target);
trace("Here are the rooms on the server: " + snapshot.getRoomList());
}
// ルームリストをロードするために、
// スナップショットオブジェクトをReactorのupdateSnapshot()メソッドに渡します:
reactor.updateSnapshot(snapshot);
RoomListSnapshotによって取得するルームIDのリストはサーバー状態の一時的なスナップショットであり、ロード後は最新状態には保たれません。 RoomListSnapshotオブジェクトを最新のサーバー状態と一致するように更新するには、ReactorのupdateSnapshot()メソッドにそのオブジェクトを渡してください。
関連項目
| メソッド | 定義元 | ||
|---|---|---|---|
RoomListSnapshot(qualifier:String = null, recursive:Boolean = false) コンストラクタ | RoomListSnapshot | ||
getQualifier():String このスナップショットに含まれているルームの修飾子を返します。 | RoomListSnapshot | ||
getRecursive():Boolean このスナップショットのルームリストが指定された修飾子によって直接修飾されているルームのみを含んでいるか、さらに子の修飾子によって修飾される全てのルームを含んでいるかを示します。 | RoomListSnapshot | ||
getRoomList():Array このスナップショットで指定される修飾子をもつルームの完全修飾ルームIDの配列を返します。 | RoomListSnapshot | ||
![]() | getStatus():String 最も最近のスナップショットのロード操作のステータスを返します。 | Snapshot | |
![]() | updateInProgress():Boolean スナップショットが現在データをロード中かどうかを示します。 | Snapshot | |
| RoomListSnapshot | () | コンストラクタ |
public function RoomListSnapshot(qualifier:String = null, recursive:Boolean = false)コンストラクタ
パラメータqualifier:String (default = null) — リストに含むルームのルームIDの修飾子です。 サーバー全体のルームリストを得るには、修飾子にnull、recursiveにtrueを渡してください。 修飾子のないルームのリストを得るには、修飾子にnull、recursiveにfalseを渡してください。 "chat.sports"という修飾子のルームのリストを得るには、修飾子に"chat.suports"、recursiveにfalseを渡してください。 Reactor 1.0.0では、recursionはqualifierがnullのときのみサポートされます。 | |
recursive:Boolean (default = false) — このスナップショットのルームリストが指定された修飾子によって直接修飾されているルームのみを含むか、さらに子の修飾子によって修飾される全てのルームを含むかを指定します。 Reactor 1.0.0では、このパラメータは修飾子が無い場合(つまり、qualifierパラメータがnullのとき)にのみ適用されます。 |
| getQualifier | () | メソッド |
public function getQualifier():String| バージョン : | Reactor 1.0.0 |
このスナップショットに含まれているルームの修飾子を返します。
戻り値String |
| getRecursive | () | メソッド |
public function getRecursive():Boolean| バージョン : | Reactor 1.0.0 |
このスナップショットのルームリストが指定された修飾子によって直接修飾されているルームのみを含んでいるか、さらに子の修飾子によって修飾される全てのルームを含んでいるかを示します。
戻り値Boolean |
| getRoomList | () | メソッド |
public function getRoomList():Array| バージョン : | Reactor 1.0.0 |
このスナップショットで指定される修飾子をもつルームの完全修飾ルームIDの配列を返します。
戻り値Array |