パッケージnet.user1.reactor.snapshot
クラスpublic class ClientListSnapshot
継承ClientListSnapshot Inheritance Snapshot Inheritance 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()メソッドにそのオブジェクトを渡してください。

関連項目

Snapshot
net.user1.reactor.Reactor.updateSnapshot()


パブリック プロパティ
 プロパティ定義元
 InheritedonLoad : Function
このスナップショットのデータがロードされたときに呼び出されるコールバック関数です。
Snapshot
パブリック メソッド
 メソッド定義元
  
コンストラクタ
ClientListSnapshot
  
サーバー上のクライアントのクライアントIDと、ログインしているクライアントのユーザーIDを含むジェネリックなデータオブジェクトの配列を返します。
ClientListSnapshot
 Inherited
getStatus():String
最も最近のスナップショットのロード操作のステータスを返します。
Snapshot
 Inherited
スナップショットが現在データをロード中かどうかを示します。
Snapshot
Events
 Event Summary 定義元
 Inherited 先に呼び出されたReactorのupdateSnapshot()メソッドによってスナップショットオブジェクトが更新されたときに送出されます。Snapshot
 Inherited スナップショットオブジェクトが更新リクエストの結果を受信したときに送出されます。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