mobage.event

概要

このモジュール中の機能は非同期に発生するイベントの監視に用いられます。

mobage.eventモジュールには以下のメソッドがあります。

特定のイベントを監視する為のListener関数を登録する為のメソッドです。
なおチュートリアルでもサンプルを紹介しています。

各監視するイベントは event_name （string 型）で指定することができます。event_name にはそれぞれ args オプション指定があるものとないものがあり、ある場合とない場合でそれぞれ指定方法が異なります。

string 型のパラメータです。下記の一覧から監視したいイベントに対応する event_name を指定する必要があります。

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	なし	ユーザーのゲーム内でのアクティビティイベントを監視します。

function型のパラメータで、SDK から呼び出される callback 関数です。
設定した evet_name によって、callback 関数の引数が変わります。下記はその対応表です。

event_name

callback 関数の引数

modal.beforeOpen

なし

modal.afterOpen

なし

modal.beforeClose

なし

modal.afterClose

なし

oauth.sessionStateChange

string 型のパラメータ。変更の有無が文字列で渡されます。

bank.paymentBacklog

array 型のパラメータ。未確定のトランザクションID値の配列が渡されます。

platform.unsupportedBrowser

object 型のパラメータ。 iOSのUIWebViewで開かれたかどうかの真偽値がオブジェクトとして渡されます。

analytics.userActivity

object 型のパラメータ。ユーザのアクティビティイベントについて以下のプロパティを持つオブジェクトとして渡されます。

現在取りうる actionId と event の組み合わせは以下のようになります。

actionId	event	概要
"login_form"	"load"	ゲーム画面から Mobage Connect のログイン画面への遷移イベント
"login_form"	"unload"	Mobage Connect のログイン画面からゲーム画面への遷移イベント

string型の戻り値です。mobage.event.unsubscribe() メソッドで用いるListener関数の識別子です。

mobage.event.subscribe()で登録したListener関数によるイベント監視を解除します。

string 型のパラメータで、mobage.event.subscribe()の戻り値です。