mobage
概要
このモジュール中の機能はJavaScript SDKの初期化に関する機能が含まれています。
機能一覧
mobageモジュールには以下のメソッドがあります。
メソッド
mobage.init
JS SDKの初期化を行うメソッドです。
このメソッドは JS SDKのロードが完了した際に、SDKの初期化処理を行います。JS SDKの機能を使用せずとも NBPF のアプリであれば必ず呼び出す必要があります。
構文
mobage.init(params );
パラメータ
| property | title | type | required | description |
|---|---|---|---|---|
| clientId | Client ID | string | true | Mobage Developers で発行されたClient IDを指定して下さい。 |
| redirectUri | Redirect URI | string | true | Mobage Developersで設定したRedirectURI を指定して下さい。 |
| clientOrigin | Client Origin | string | false | Mobage DevelopersでCDNの設定をした場合は、そのOriginの値を指定して下さい。 |
| scope | Scope | array | false | 認可を求める Scope の値を配列として指定して下さい。現状Scopeとして指定出来る値はopenidとcommon_apiのみです。 |
| responseType | Response type | array | false | Response type の値を配列として指定して下さい。現状Response typeとして指定出来る値はtoken, code, id_tokenのみです。 |
説明
mobage.init() メソッドはdocumentオブジェクトに対して発火するmobageReadyイベントに対するイベントリスナ中から呼び出して下さい。
warning
JS SDK 3.1.0 より、Local Storage に書き込みができなかった場合に、mobage.init で例外をスローすることができるようになりました。
例文にあるような方法で例外をキャッチすることで、警告やゲームを継続させないような処理を書くことが可能になります。
例
典型的な初期化コードを以下に示します。
document. addEventListener (" mobageReady ", function(evt) {
try {
mobage.init ({
clientId: "12000129-4" ,
redirectUri : "https://sandbox.example.com/login_cb",
clientOrigin : "`http://example.sb-cdn.pf.mobage.jp",`
scope: ["openid", "common_api"],
responseType : ["code", "token", "id_token"]
});
}catch (e){
if (e.message === 'This browser can not use LocalStorage') {
alert("このブラウザはSafari Private Modeの可能性があります。Privateモードを解除してから再実施してください。");
}
}
}, false );