| パッケージ | net.user1.reactor.snapshot |
| クラス | public class RoomSnapshot |
| 継承 | RoomSnapshot Snapshot flash.events.EventDispatcher |
| バージョン : | Reactor 1.0.0 |
// スナップショットを作成します
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()メソッドに渡してください。
関連項目
| メソッド | 定義元 | ||
|---|---|---|---|
RoomSnapshot(roomID:String, password:String = null, updateLevels:UpdateLevels = null) コンストラクタ | RoomSnapshot | ||
getAttribute(name:String):String 指定したルーム属性の値を返します。 | RoomSnapshot | ||
getAttributes():Object このスナップショットのルームにおいて共有されている属性名と値を表す変数を持つオブジェクトを返します。 | RoomSnapshot | ||
getNumObservers():int このスナップショットで表されるルーム内の観戦者数を返します。 | RoomSnapshot | ||
getNumOccupants():int このスナップショットで表されるルーム内の入室者数を返します。 | RoomSnapshot | ||
getObserver(clientID:String):ClientManifest clientIDで指定されるルーム観戦者を表すClientManifestオブジェクトを返します。 | RoomSnapshot | ||
getObservers():Array このスナップショットによって表現されるこのルームを観戦しているクライアントのリストを返します。 | RoomSnapshot | ||
getOccupant(clientID:String):ClientManifest clientIDで指定されるルーム入室者を表すClientManifestオブジェクトを返します。 | RoomSnapshot | ||
getOccupants():Array このスナップショットによって表現されるルーム内のクライアントのリストを返します。 | RoomSnapshot | ||
getRoomID():String このルームスナップショットオブジェクトの完全修飾ルームIDを返します。 | RoomSnapshot | ||
![]() | getStatus():String 最も最近のスナップショットのロード操作のステータスを返します。 | Snapshot | |
![]() | updateInProgress():Boolean スナップショットが現在データをロード中かどうかを示します。 | Snapshot | |
| RoomSnapshot | () | コンストラクタ |
public function RoomSnapshot(roomID:String, password:String = null, updateLevels:UpdateLevels = null)コンストラクタ
パラメータroomID:String | |
password:String (default = null) | |
updateLevels:UpdateLevels (default = null) |
関連項目
| 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 |
このスナップショットによって表現されるこのルームを観戦しているクライアントのリストを返します。 リスト内の各アイテムは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のストリングです。 |
関連項目