| パッケージ | net.user1.reactor.snapshot |
| クラス | public class ClientSnapshot |
| 継承 | ClientSnapshot Snapshot flash.events.EventDispatcher |
| バージョン : | Reactor 1.0.0 |
// スナップショットを作成します
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);
関連項目
| メソッド | 定義元 | ||
|---|---|---|---|
ClientSnapshot(clientID:String) | ClientSnapshot | ||
getAttribute(name:String, scope:String = null):String 指定したクライアント属性の値を返します。 | ClientSnapshot | ||
getAttributes():Object このスナップショットのクライアントが共有している属性名と値を表す変数を持つオブジェクトを返します。 | ClientSnapshot | ||
getClientID():String このクライアントスナップショットオブジェクトのクライアントIDを返します。 | ClientSnapshot | ||
getObservedRoomIDs():Array このスナップショットが表すクライアントによって観戦中のルームのリストを返します。 | ClientSnapshot | ||
getOccupiedRoomIDs():Array このスナップショットが表すクライアントを含むルームのリストを返します。 | ClientSnapshot | ||
![]() | getStatus():String 最も最近のスナップショットのロード操作のステータスを返します。 | Snapshot | |
getUserID():String もしこのスナップショットオブジェクトが表すクライアントがユーザーアカウントを使用してログインしている場合は、getUserID()はそのアカウントを返します。そうでない場合は、getUserID()はnullを返します。 | ClientSnapshot | ||
![]() | updateInProgress():Boolean スナップショットが現在データをロード中かどうかを示します。 | 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のストリングです。 |
関連項目