mobage.event
概要
このモジュール中の機能は非同期に発生するイベントの監視に用いられます。
機能一覧
mobage.eventモジュールには以下のメソッドがあります。
メソッド
mobage.event.subscribe
特定のイベントを監視する為のListener関数を登録する為のメソッドです。
なおチュートリアルでもサンプルを紹介しています。
構文
各監視するイベントは event_name (string 型)で指定することができます。event_name にはそれぞれ args オプション指定があるものとないものがあり、ある場合とない場合でそれぞれ指定方法が異なります。
-
args の指定が無い場合
subscriberId = mobage.event.subscribe ("event_name", callback); -
args の指定がある場合
subscriberId = mobage.event.subscribe ("event_name", args, callback);
event_name
string 型のパラメータです。下記の一覧から監視したいイベントに対応する event_name を指定する必要があります。
args
event_name の値ごとに指定可能な可変引数です。下記に event_name ごとに設定する値を記載しています。
| event_name | args | description |
|---|---|---|
| modal.beforeOpen | なし | Mobage JS SDKの modal window が開く直前に実行されます。 Game 側で開く modal window と Mobage JS SDK で開く mobdal window が 重なってしまうことを防ぐためにこのメソッドを利用してください。 |
| modal.afterOpen | なし | Mobage JS SDKの modal window が開いた直後に実行されます。 |
| modal.beforeClose | なし | Mobage JS SDKの modal window が閉じる直前に実行されます。 |
| modal.afterClose | なし | Mobage JS SDKの modal window が閉じた直後に実行されます。 Game 側で開く modal window と Mobage JS SDK で開く mobdal window が 重なってしまうことを防ぐためにこのメソッドを利用してください。 |
| oauth.sessionStateChange | session_state | Authorization Responseから得たGame Serverのログインセッションに紐づくsession_stateの値を指定し、ログアウトイベントを監視します。 |
| bank.paymentBacklog | なし | 未確定のトランザクションを監視します。 |
| platform.unsupportedBrowser | なし | iOS のUIWebView で開かれてしまったかどうかを監視します。 |
| analytics.userActivity | なし | ユーザーのゲーム内でのアクティビティイベントを監視します。 |
callback
function型のパラメータで、SDK から呼び出される callback 関数です。
設定した evet_name によって、callback 関数の引数が変わります。下記はその対応表です。
| event_name | callback 関数の引数 |
|---|---|
| modal.beforeOpen | なし |
| modal.afterOpen | なし |
| modal.beforeClose | なし |
| modal.afterClose | なし |
| oauth.sessionStateChange | string 型のパラメータ。変更の有無が文字列で渡されます。 javascript "changed" or "unchanged" |
| bank.paymentBacklog | array 型のパラメータ。未確定のトランザクションID値の配列が渡されます。 javascript [transactionId1, transactionId2, ...] |
| platform.unsupportedBrowser | object 型のパラメータ。 iOSのUIWebViewで開かれたかどうかの真偽値がオブジェクトとして渡されます。 javascript {unsupported: Boolean} |
| analytics.userActivity | object 型のパラメータ。ユーザのアクティビティイベントについて以下のプロパティを持つオブジェクトとして渡されます。 javascript { action_id: "アクション", event: "イベント", userId: "アクティビティを起動したユーザーのID", fireadAt: "アクティビティ起動時のタイムスタンプ" } 現在取りうる actionId と event の組み合わせは以下のようになります。 |
subscriberId
string型の戻り値です。mobage.event.unsubscribe() メソッドで用いるListener関数の識別子です。
mobage.event.unsubscribe
mobage.event.subscribe()で登録したListener関数によるイベント監視を解除します。
構文
mobage.event.unsubscribe (subscriberId);
subscriberId
string 型のパラメータで、mobage.event.subscribe()の戻り値です。