| パッケージ | net.user1.reactor.snapshot |
| クラス | public class ClientListSnapshot |
| 継承 | ClientListSnapshot  Snapshot flash.events.EventDispatcher |
| バージョン : | Reactor 1.0.0 |
ClientListSnapshotクラスは現在サーバー上にいるクライアントのクライアントIDのリストをロードするために使用します。 このリストには、ログインしている全クライアントのクライアントIDとユーザーIDの両方が含まれます。 次のコードで実例を示します。
// スナップショットを作成します
var snapshot:ClientListSnapshot = new ClientListSnapshot();
// コールバック関数を登録します
snapshot.onLoad = function ():void {
// クライアントリスト内の最初のクライアントのクライアントIDを表示します
trace(snapshot.getClientList()[0].clientID);
// クライアントリスト内の最初のクライアントのユーザーIDを表示します
trace(snapshot.getClientList()[0].userID);
}
// あるいはリスナー関数を登録します
snapshot.addEventListener(SnapshotEvent.LOAD, loadListener);
function loadListener (e:SnapshotEvent):void {
// クライアントリスト内の最初のクライアントのクライアントIDを表示します
trace(ClientListSnapshot(e.target).getClientList()[0].clientID);
// クライアントリスト内の最初のクライアントのユーザーIDを表示します
trace(ClientListSnapshot(e.target).getClientList()[0].userID);
}
// クライアントリストをロードするために、
// スナップショットオブジェクトをReactorのupdateSnapshot()メソッドに渡します:
reactor.updateSnapshot(snapshot);
ClientListSnapshotから取得したクライアントIDのリストはサーバー状態の一時的なスナップショットであり、ロード後は最新状態には保たれません。 ClientListSnapshotオブジェクトを最新のサーバー状態と一致するように更新するには、ReactorのupdateSnapshot()メソッドにそのオブジェクトを渡してください。
関連項目
| メソッド | 定義元 | ||
|---|---|---|---|
コンストラクタ | ClientListSnapshot | ||
getClientList():Array サーバー上のクライアントのクライアントIDと、ログインしているクライアントのユーザーIDを含むジェネリックなデータオブジェクトの配列を返します。 | ClientListSnapshot | ||
 | getStatus():String 最も最近のスナップショットのロード操作のステータスを返します。 | Snapshot | |
| updateInProgress():Boolean スナップショットが現在データをロード中かどうかを示します。 | Snapshot | |
| ClientListSnapshot | () | コンストラクタ |
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示public function ClientListSnapshot()コンストラクタ
| getClientList | () | メソッド |
public function getClientList():Array| バージョン : | Reactor 1.0.0 |
サーバー上のクライアントのクライアントIDと、ログインしているクライアントのユーザーIDを含むジェネリックなデータオブジェクトの配列を返します。 各データオブジェクトの構造は次の通りです:
var o:Object = new Object();
o["clientID"] = someClientID;
o["userID"] = someUserID;
ログインしていないクライアントについては、userID変数の値はnullとなります。
戻り値Array |