パッケージnet.user1.reactor.snapshot
クラスpublic class ClientSnapshot
継承ClientSnapshot Inheritance Snapshot Inheritance flash.events.EventDispatcher

バージョン : Reactor 1.0.0

ClientSnapshotクラスはサーバー上のクライアントの"スナップショット"をロードするために使用します。 そのスナップショットはそのクライアントの全ての属性、そのクライアントが入室している全てのルーム、そしてそのクライアントが観察している全てのルームを含みます。 クライアントが現在ユーザーアカウントを使用してログインしている場合は、そのアカウントのユーザーIDも含みます。 例えば、次のコードはクライアントID"1"のクライアントのスナップショットを取得します。 もしクライアントID"1"のクライアントがもうサーバー上にいない場合は、そのスナップショットはStatus.CLIENT_NOT_FOUNDステータスをのSnapshotEvent.STATUSイベントをトリガーします。
   // スナップショットを作成します
   var snapshot:ClientSnapshot = new ClientSnapshot("1");
   
   // コールバック関数を登録します
   snapshot.onLoad = function ():void { 
     // クライアントが入室しているルームのリストを表示します
     trace(snapshot.getOccupiedRoomIDs());
   }
   
   // あるいはリスナー関数を登録します
   snapshot.addEventListener(SnapshotEvent.LOAD, loadListener);
   function loadListener (e:SnapshotEvent):void {
     // クライアントが入室しているルームのリストを表示します
     trace(ClientSnapshot(e.target).getOccupiedRoomIDs());
   }
   
   // ステータス更新用のリスナー関数を登録します
   snapshot.addEventListener(SnapshotEvent.STATUS, statusListener);
   function statusListener (e:SnapshotEvent):void {
     trace("Client snapshot load status: " + ClientSnapshot(e.target).getStatus());
   }
   
   // クライアントのデータをロードするために、 
   // スナップショットオブジェクトをReactorのupdateSnapshot()メソッドに渡します:
   reactor.updateSnapshot(snapshot);
   

関連項目

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


パブリック プロパティ
 プロパティ定義元
 InheritedonLoad : Function
このスナップショットのデータがロードされたときに呼び出されるコールバック関数です。
Snapshot
パブリック メソッド
 メソッド定義元
  
ClientSnapshot(clientID:String)
ClientSnapshot
  
getAttribute(name:String, scope:String = null):String
指定したクライアント属性の値を返します。
ClientSnapshot
  
getAttributes():Object
このスナップショットのクライアントが共有している属性名と値を表す変数を持つオブジェクトを返します。
ClientSnapshot
  
getClientID():String
このクライアントスナップショットオブジェクトのクライアントIDを返します。
ClientSnapshot
  
このスナップショットが表すクライアントによって観察中のルームのリストを返します。
ClientSnapshot
  
このスナップショットが表すクライアントを含むルームのリストを返します。
ClientSnapshot
 Inherited
getStatus():String
最も最近のスナップショットのロード操作のステータスを返します。
Snapshot
  
getUserID():String
もしこのスナップショットオブジェクトが表すクライアントがユーザーアカウントを使用してログインしている場合は、getUserID()はそのアカウントを返します。そうでない場合は、getUserID()はnullを返します。
ClientSnapshot
 Inherited
スナップショットが現在データをロード中かどうかを示します。
Snapshot
Events
 Event Summary 定義元
 Inherited 先に呼び出されたReactorのupdateSnapshot()メソッドによってスナップショットオブジェクトが更新されたときに送出されます。Snapshot
 Inherited スナップショットオブジェクトが更新リクエストの結果を受信したときに送出されます。Snapshot
コンストラクタの詳細
ClientSnapshot()コンストラクタ
public function ClientSnapshot(clientID:String)



パラメータ
clientID:String
メソッドの詳細
getAttribute()メソッド
public function getAttribute(name:String, scope:String = null):String

バージョン : Reactor 1.0.0

指定したクライアント属性の値を返します。

パラメータ

name:String — 属性の名称です。
 
scope:String (default = null) — 属性のスコープです。 グローバルクライアント属性の場合は、スコープをnullに指定してください。 ルームをスコープとした属性の場合はルームのIDを指定してください。

戻り値
String — 属性値です。

関連項目

getAttributes()メソッド 
public function getAttributes():Object

バージョン : Reactor 1.0.0

このスナップショットのクライアントが共有している属性名と値を表す変数を持つオブジェクトを返します。 このオブジェクトは完全に修飾された属性名/値のペアのマップです。 詳細と例については、ClientクラスのgetAttributes()メソッドを参照してください。このメソッドは同じフォーマットのオブジェクトを返します。

戻り値
Object

関連項目

getClientID()メソッド 
public function getClientID():String

バージョン : Reactor 1.0.0

このクライアントスナップショットオブジェクトのクライアントIDを返します。

戻り値
String — クライアントIDのストリングです。

関連項目

getObservedRoomIDs()メソッド 
public function getObservedRoomIDs():Array

バージョン : Reactor 1.0.0

このスナップショットが表すクライアントによって観察中のルームのリストを返します。 リスト内の各アイテムは完全修飾されたルームIDのストリングです。

戻り値
Array
getOccupiedRoomIDs()メソッド 
public function getOccupiedRoomIDs():Array

バージョン : Reactor 1.0.0

このスナップショットが表すクライアントを含むルームのリストを返します。 リスト内の各アイテムは完全修飾されたルームIDのストリングです。

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

バージョン : Reactor 1.0.0

もしこのスナップショットオブジェクトが表すクライアントがユーザーアカウントを使用してログインしている場合は、getUserID()はそのアカウントを返します。そうでない場合は、getUserID()はnullを返します。

戻り値
String — ユーザーIDのストリングです。

関連項目