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

バージョン : Reactor 1.0.0

RoomSnapshotクラスはサーバー上のルームの "スナップショット" をロードするために使用します。 このスナップショットは全ルームの属性に加えて、そのルームに入室しているクライアントのリストとルームを観察しているクライアントのリストを含みます。 例えば、次のコードはroomIDが "examples.chat" のルームのスナップショットを取得します。
   // スナップショットを作成します
   var snapshot:RoomSnapshot = new RoomSnapshot("examples.chat");
   
   // コールバック関数を登録します
   snapshot.onLoad = function ():void { 
     // ルーム内のクライアントリストを表示
     trace("Occupants: " + snapshot.getOccupants());
   }
   
   // あるいはリスナー関数を登録します
   snapshot.addEventListener(SnapshotEvent.LOAD, loadListener);
   function loadListener (e:SnapshotEvent):void {
     // ルーム内のクライアントリストを表示
     trace("Occupants: " + RoomSnapshot(e.target).getOccupants());
   }
   
   // ルームのデータをロードするために、
   // スナップショットオブジェクトをReactorのupdateSnapshot()メソッドに渡します:
   reactor.updateSnapshot(snapshot);
   

RoomSnapshotオブジェクトはロード後は最新状態には保たれません。 RoomSnapshotオブジェクトをサーバーの最新状態に一致するように更新するには、そのオブジェクトをReactorのupdateSnapshot()メソッドに渡してください。

関連項目

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


パブリック プロパティ
 プロパティ定義元
 InheritedonLoad : Function
このスナップショットのデータがロードされたときに呼び出されるコールバック関数です。
Snapshot
パブリック メソッド
 メソッド定義元
  
RoomSnapshot(roomID:String, password:String = null, updateLevels:UpdateLevels = null)
コンストラクタ
RoomSnapshot
  
getAttribute(name:String):String
指定したルーム属性の値を返します。
RoomSnapshot
  
getAttributes():Object
このスナップショットのルームにおいて共有されている属性名と値を表す変数を持つオブジェクトを返します。
RoomSnapshot
  
このスナップショットで表されるルーム内の観察者数を返します。
RoomSnapshot
  
このスナップショットで表されるルーム内の入室者数を返します。
RoomSnapshot
  
getObserver(clientID:String):ClientManifest
clientIDで指定されるルーム観察者を表すClientManifestオブジェクトを返します。
RoomSnapshot
  
getObservers():Array
Returns a list of the clients observing the room represented by this snapshot.
RoomSnapshot
  
getOccupant(clientID:String):ClientManifest
clientIDで指定されるルーム入室者を表すClientManifestオブジェクトを返します。
RoomSnapshot
  
getOccupants():Array
このスナップショットによって表現されるルーム内のクライアントのリストを返します。
RoomSnapshot
  
getRoomID():String
このルームスナップショットオブジェクトの完全修飾ルームIDを返します。
RoomSnapshot
 Inherited
getStatus():String
最も最近のスナップショットのロード操作のステータスを返します。
Snapshot
 Inherited
スナップショットが現在データをロード中かどうかを示します。
Snapshot
Events
 Event Summary 定義元
 Inherited 先に呼び出されたReactorのupdateSnapshot()メソッドによってスナップショットオブジェクトが更新されたときに送出されます。Snapshot
 Inherited スナップショットオブジェクトが更新リクエストの結果を受信したときに送出されます。Snapshot
コンストラクタの詳細
RoomSnapshot()コンストラクタ
public function RoomSnapshot(roomID:String, password:String = null, updateLevels:UpdateLevels = null)

コンストラクタ

パラメータ
roomID:String
 
password:String (default = null)
 
updateLevels:UpdateLevels (default = null)

関連項目

UpdateLevels
メソッドの詳細
getAttribute()メソッド
public function getAttribute(name:String):String

バージョン : Reactor 1.0.0

指定したルーム属性の値を返します。

パラメータ

name:String — 属性の名称です。

戻り値
String — 属性値です。

関連項目

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

バージョン : Reactor 1.0.0

このスナップショットのルームにおいて共有されている属性名と値を表す変数を持つオブジェクトを返します。 詳細と例については、RoomクラスのgetAttributes()メソッドを参照してください。このメソッドは同じフォーマットのオブジェクトを返します。

戻り値
Object

関連項目

getNumObservers()メソッド 
public function getNumObservers():int

バージョン : Reactor 1.0.0

このスナップショットで表されるルーム内の観察者数を返します。

戻り値
int
getNumOccupants()メソッド 
public function getNumOccupants():int

バージョン : Reactor 1.0.0

このスナップショットで表されるルーム内の入室者数を返します。

戻り値
int
getObserver()メソッド 
public function getObserver(clientID:String):ClientManifest

バージョン : Reactor 1.0.0

clientIDで指定されるルーム観察者を表すClientManifestオブジェクトを返します。

パラメータ

clientID:String

戻り値
ClientManifest

関連項目

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

バージョン : Reactor 1.0.0

Returns a list of the clients observing the room represented by this snapshot. リスト内の各アイテムはclientIDのストリングです。

戻り値
Array
getOccupant()メソッド 
public function getOccupant(clientID:String):ClientManifest

バージョン : Reactor 1.0.0

clientIDで指定されるルーム入室者を表すClientManifestオブジェクトを返します。

パラメータ

clientID:String

戻り値
ClientManifest

関連項目

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

バージョン : Reactor 1.0.0

このスナップショットによって表現されるルーム内のクライアントのリストを返します。 リスト内の各アイテムはclientIDのストリングです。

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

バージョン : Reactor 1.0.0

このルームスナップショットオブジェクトの完全修飾ルームIDを返します。

戻り値
String — roomIDのストリングです。

関連項目