パッケージnet.user1.reactor
クラスpublic class AccountEvent
継承AccountEvent Inheritance flash.events.Event

バージョン : Reactor 1.0.0

AccountEventはアカウントイベントが発生するときにUserAccountオブジェクトかAccountManagerオブジェクトから登録済みイベントリスナーへ情報を渡すために使用されるシンプルなデータクラスです。 AccountEventクラスは、使用可能なアカウントイベントの定数表現も定義します。 アカウントイベントを登録するには、UserAccountクラスのaddEventListener()メソッドか、AccountManagerクラスのaddEventListener()メソッドを使用してください。 次のコードで実例を示します。
   // イベント登録コード
   reactor.getAccountManager().addEventListener(AccountEvent.LOGIN, loginListener);
   reactor.getAccountManager().login("ken", "secretPassword");
   
   // イベントリスナーのコード
   protected function login (e:AccountEvent):void {
     if (e.getAccount().isSelf()) {
       trace("ログインしました。ユーザーID: " + e.getUserID());
     }
   }

関連項目

UserAccount
AccountManager


パブリック メソッド
 メソッド定義元
  
AccountEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null, userID:String = null, clientID:String = null, role:String = null)
コンストラクタ
AccountEvent
  
clone():Event
[オーバーライド]
AccountEvent
  
このアカウントイベントに関係するUserAccountオブジェクトを返します。
AccountEvent
  
getClientID():String
有効であれば、このアカウントイベントに関するclientIDを返します。
AccountEvent
  
getRole():String
このアカウントイベントに関わるロール(役割)を返します。
AccountEvent
  
getStatus():String
このイベントに関係する操作のステータスを返します。
AccountEvent
  
getUserID():String
このアカウントイベントに関するuserIDを返します。
AccountEvent
  
toString():String
[オーバーライド]
AccountEvent
パブリック 定数
 定数定義元
  ADD_ROLE_RESULT : String = ADD_ROLE_RESULT
[静的] 先に行われた UserAccount.addRole() か AccountManager.addRole() 要求の結果を受信したときに送出されます。
AccountEvent
  CHANGE_PASSWORD : String = CHANGE_PASSWORD
[静的] 現クライアントがアカウントのパスワードを変更するときに送出されます。
AccountEvent
  CHANGE_PASSWORD_RESULT : String = CHANGE_PASSWORD_RESULT
[静的] 現クライアントが先に行われたユーザーアカウントのパスワード変更要求の結果を受信するときに送出されます。
AccountEvent
  LOGIN : String = LOGIN
[静的] 現クライアントによって把握されているクライアントのいずれかがログインするときに送出されます。
AccountEvent
  LOGIN_RESULT : String = LOGIN_RESULT
[静的] 現クライアントによって先に行われたログイン要求の結果を受信したときに送出されます。
AccountEvent
  LOGOFF : String = LOGOFF
[静的] 現クライアントによって把握されているユーザーアカウントのいずれかがログオフするときに送出されます。
AccountEvent
  LOGOFF_RESULT : String = LOGOFF_RESULT
[静的] 現クライアントが先に行われたクライアントのログオフ要求の結果を受信するときに送出されます。
AccountEvent
  OBSERVE : String = OBSERVE
[静的] 現クライアントがユーザーアカウントを観察するときに送出されます。
AccountEvent
  OBSERVE_RESULT : String = OBSERVE_RESULT
[静的] 先に行われたUserAccount.observe()かAccountManager.observeAccount()要求の結果を受信したときに送出されます。
AccountEvent
  REMOVE_ROLE_RESULT : String = REMOVE_ROLE_RESULT
[静的] 先に行われた UserAccount.removeRole() か AccountManager.removeRole() 要求の結果を受信したときに送出されます。
AccountEvent
  STOP_OBSERVING : String = STOP_OBSERVING
[静的] 現クライアントがユーザーアカウントの観察を停止するときに送出されます。
AccountEvent
  STOP_OBSERVING_RESULT : String = STOP_OBSERVING_RESULT
[静的] 先に行われたUserAccount.stopObserving()かAccountManager.stopObservingAccount()要求の結果を受信したときに送出されます。
AccountEvent
  SYNCHRONIZE : String = SYNCHRONIZE
[静的] ユーザーアカウントが同期してサーバー状態と一致したときに送出されます。
AccountEvent
コンストラクタの詳細
AccountEvent()コンストラクタ
public function AccountEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null, userID:String = null, clientID:String = null, role:String = null)

コンストラクタ

パラメータ
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
status:String (default = null)
 
userID:String (default = null)
 
clientID:String (default = null)
 
role:String (default = null)
メソッドの詳細
clone()メソッド
override public function clone():Event

戻り値
Event
getAccount()メソッド 
public function getAccount():UserAccount

バージョン : Reactor 1.0.0

このアカウントイベントに関係するUserAccountオブジェクトを返します。 例えば、AccountEvent.LOGINイベントにおいては、getAccount()はログインしたアカウントのUserAccountオブジェクトを返します。

戻り値
UserAccount
getClientID()メソッド 
public function getClientID():String

バージョン : Reactor 1.0.0

有効であれば、このアカウントイベントに関するclientIDを返します。

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

バージョン : Reactor 1.0.0

このアカウントイベントに関わるロール(役割)を返します。 このメソッドは次のイベントに適用されます。

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

バージョン : Reactor 1.0.0

このイベントに関係する操作のステータスを返します。 getStatus()メソッドの戻り値は常にStatusクラスの定数のどれかです。 例えば、もしAccountEvent.LOGIN_RESULTイベントがログイン試行成功の結果として発生すると、getStatus()はStatus.SUCCESSの値を返します。 ステータスに対応するには、getStatus()の値とStatus定数とを比較します。 例えば、

if (e.getStatus() != Status.SUCCESS) {
       showLoggedInScreen();
     }
特定のイベントが発生したときに返されうるステータス値のリストについては、そのイベントのドキュメントを参照してください。

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

バージョン : Reactor 1.0.0

このアカウントイベントに関するuserIDを返します。

戻り値
String
toString()メソッド 
override public function toString():String

戻り値
String
定数の詳細
ADD_ROLE_RESULT定数
public static const ADD_ROLE_RESULT:String = ADD_ROLE_RESULT

バージョン : Reactor 1.0.0

先に行われた UserAccount.addRole() か AccountManager.addRole() 要求の結果を受信したときに送出されます。

関連項目

CHANGE_PASSWORD定数 
public static const CHANGE_PASSWORD:String = CHANGE_PASSWORD

バージョン : Reactor 1.0.0

現クライアントがアカウントのパスワードを変更するときに送出されます。 ユーザーはAccountManagerのchangePassword()メソッドかUserAccountオブジェクトのchangePassword()メソッドを通して自分自身のパスワードを変更できます。 十分な権限があれば、現クライアントは他ユーザーのパスワードを変更できます。 サーバーサイドのコードは任意のユーザーのパスワードを変更できます。

関連項目

CHANGE_PASSWORD_RESULT定数 
public static const CHANGE_PASSWORD_RESULT:String = CHANGE_PASSWORD_RESULT

バージョン : Reactor 1.0.0

現クライアントが先に行われたユーザーアカウントのパスワード変更要求の結果を受信するときに送出されます。 パスワード変更要求の結果を調べるには、getStatus()を使用してください。このメソッドの戻り値は次のどれかになります:

関連項目

LOGIN定数 
public static const LOGIN:String = LOGIN

バージョン : Reactor 1.0.0

現クライアントによって把握されているクライアントのいずれかがログインするときに送出されます。 クライアントが現クライアントによって把握される状況のリストについては、ClientManagerのclientIsKnown()メソッドを参照してください。 しかしながら、RoomクラスのsetUpdateLevels()メソッドを通して"入室者ログインログオフ更新"と"観察者ログインログオフ更新"を無効化することで、現クライアントがルーム入室者とルーム観察者のログイン通知を受けないようにもできる点に留意してください。

AccountEvent.LOGINイベントはログインしたクライアントのClientオブジェクトを通して送出され、次にログインしたアカウントのUserAccountオブジェクト、次にAccountManagerからも送出されます。

関連項目

LOGIN_RESULT定数 
public static const LOGIN_RESULT:String = LOGIN_RESULT

バージョン : Reactor 1.0.0

現クライアントによって先に行われたログイン要求の結果を受信したときに送出されます。 ログイン要求の結果を調べるには、getStatus()を使用してください。このメソッドの戻り値は次のどれかになります。

関連項目

LOGOFF定数 
public static const LOGOFF:String = LOGOFF

バージョン : Reactor 1.0.0

現クライアントによって把握されているユーザーアカウントのいずれかがログオフするときに送出されます。 クライアントが現クライアントによって把握される状況のリストについては、ClientManagerのclientIsKnown()メソッドを参照してください。 しかしながら、RoomクラスのsetUpdateLevels()メソッドを通して"入室者ログインログオフ更新"と"観察者ログインログオフ更新"を無効化することで、現クライアントがルーム入室者とルーム観察者のログオフ通知を受けないようにもできる点に留意してください。

AccountEvent.LOGOFFイベントはログオフしたクライアントのClientオブジェクトを通して送出され、次にログオフしたアカウントのUserAccountオブジェクト、次にAccountManagerからも送出されます。

関連項目

LOGOFF_RESULT定数 
public static const LOGOFF_RESULT:String = LOGOFF_RESULT

バージョン : Reactor 1.0.0

現クライアントが先に行われたクライアントのログオフ要求の結果を受信するときに送出されます。 ログオフ要求の結果を調べるには、getStatus()を使用してください。このメソッドの戻り値は次のどれかになります。

関連項目

OBSERVE定数 
public static const OBSERVE:String = OBSERVE

バージョン : Reactor 1.0.0

現クライアントがユーザーアカウントを観察するときに送出されます。 完全な詳細については、AccountManagerのobserveAccount()メソッドを参照してください。

関連項目

OBSERVE_RESULT定数 
public static const OBSERVE_RESULT:String = OBSERVE_RESULT

バージョン : Reactor 1.0.0

先に行われたUserAccount.observe()かAccountManager.observeAccount()要求の結果を受信したときに送出されます。

関連項目

REMOVE_ROLE_RESULT定数 
public static const REMOVE_ROLE_RESULT:String = REMOVE_ROLE_RESULT

バージョン : Reactor 1.0.0

先に行われた UserAccount.removeRole() か AccountManager.removeRole() 要求の結果を受信したときに送出されます。

関連項目

STOP_OBSERVING定数 
public static const STOP_OBSERVING:String = STOP_OBSERVING

バージョン : Reactor 1.0.0

現クライアントがユーザーアカウントの観察を停止するときに送出されます。

関連項目

STOP_OBSERVING_RESULT定数 
public static const STOP_OBSERVING_RESULT:String = STOP_OBSERVING_RESULT

バージョン : Reactor 1.0.0

先に行われたUserAccount.stopObserving()かAccountManager.stopObservingAccount()要求の結果を受信したときに送出されます。

関連項目

SYNCHRONIZE定数 
public static const SYNCHRONIZE:String = SYNCHRONIZE

バージョン : Reactor 1.0.0

ユーザーアカウントが同期してサーバー状態と一致したときに送出されます。