mobage.oauth
概要
此模块中的功能,主要用于与Mobage Connect关联。
功能列表
mobage.oauth模块中有以下方法。
方法
mobage.oauth.getConnectedStatus
不向用户显示UI,检查登录状态和安装状态所需的方法。处于登录且安装状态时,默认进行Authorization Request。结果传递给指定的Callback函数。
语法
mobage.oauth.getConnectedStatus (params , cb); |
参数
params
Object 型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| state | State | string | true | 请指定由游戏服务器生成并与会话绑定的state字符串。 |
| scope | Scope | array | false | 请指定要求验证的数组 Scope 值。目前可指定的Scope值只有openid和common_api。 |
| responseType | Response type | array | false | 请指定数组的Response type值。目前可指定的Response type值只有token, code, id_token。 |
cb
Function 型的参数。
说明
当无游戏服务器发行的登录会话时,默认检查UserAgent登录和安装状态所需的功能。调用此方法不会向用户显示UI,也可像其他方法一样,在点击按键时等事件处理程序中执行。另外,cb参数的Function是前项所述Callback函数。此Callback函数的error, result参数是Object,都带有相同的字段。
login
是Boolean型的属性,根据UserAgent有无登录Mobage Connect,设置相应的值。
connected
是Boolean型的属性,根据UserAgent有无安装此Client,设置相应的值。
response
是Object型的属性,对error参数,设置error, error_description属性。对result参数,设置code, state, session_state属性。
传递给Callback函数的error属性列表
| error | description |
|---|---|
| invalid_request | 请求参数有误时 |
| login_required | UserAgent 未登录 Mobage Connect 时 |
| access_denied | 验证被Mobage Connect服务器或用户拒绝时 |
| unauthorized_client | 不是Mobage Connect服务器认为适当的 Client 时 |
| consent_required | 显示同意画面并需要同意安装时 |
| server_error | Mobage Connect 服务器端发生系统错误时 |
error, result 对象双方存在 login, connected 属性,因此实际视此值进行处理。
例
在已安装状态下,游戏服务器新发行登录会话,在已登录Mobage Connect但未安装状态下,显示安装键。上述分支处理的示例如下。
var params = { state : state , responseType : [``" token"``, "code "``] }; var cb = function (error , result) { if (error) { if (error.login) { // 在 登 录 状 态 下,显 示 安 装 键 showInstallButton (error ); } // 继 续 访 客 试 玩 return``; } // 在 游 戏 服 务 器 进 行 登 录 会 话 发 行 手 续 startSession (result.response ); }; mobage.oauth.getConnectedStatus (params , cb); |
关于针对各响应的状态
根据用户的状态,mobage.oauth.getConnectedStatus() 方法的响应有以下变化。
| \ | 已登录Mobage Connect | 未登录Mobage Connect |
| 已安装游戏 | 反馈result 响应, 反馈 "login":true, "connected":true | ー |
| 未安装游戏 | 反馈error 响应, 反馈 "login":true, "connected":false | 反馈error 响应, 反馈 "login":false, "connected":false |
mobage.oauth.connect
如果需要用户同意安装,则显示请求登录 Mobage Connect 的UI,向 Callback 函数反馈登录状态、安装状态等执行结果。
请在点击事件等通过浏览器开始的事件处理程序中调用此方法。
语法
mobage.oauth.connect(params , cb); |
参数
params
Object型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| state | State | string | true | 请指定由游戏服务器生成并与会话绑定的state字符串。 |
| scope | Scope | array | false | 请指定要求验证的数组 Scope 值。目前可指定的Scope值只有openid和common_api。如无指定,则默认同时指定openid和common_api。 |
| responseType | Response type | array | false | 请指定数组的Response type值。目前可指定的 Response type值只有token, code, id_token。 |
| loginCustomTheme | 登录画面用自定义主题 | string | false | 可用字符串来指定登录画面自定义主题。请在开发者网站中指定自定义主题。 ※从JS SDK 3.1.0 起可指定。 |
| loginAppearanceVersion | 登录画面用自定义主题的版本 | number | false | 可指定登录画面用自定义主题的版本。自定义主题的版本请见开发者网站。※从JS SDK 3.1.0 起可指定。 |
| authCustomTheme | NBPF 验证画面用自定义主题 | string | false | 可用字符串来指定NBPF 验证用自定义主题。请在开发者网站中指定自定义主题。※ 从JS SDK 3.1.0 起可指定。 |
| authAppearanceVersion | NBPF 验证画面用自定义主题的版本 | number | false | 可指定NBPF 验证画面用自定义主题的版本。自定义主题的版本请见开发者网站。※从JS SDK 3.1.0 起可指定。 |
cb
Function型的参数。
说明
此方法是显示UI并要求用户同意安装或登录所需的方法。界面与上述mobage.oauth.getConnectedStatus()基本相同,但此方法在非登录状态或非安装状态下必须显示UI。特别在非登录状态下,出于安全考虑,会在新选项卡中显示登录表。
在登录状态下未安装时,会以画面覆盖方式显示同意画面。
例
此方法可能会通过window.open()打开新选项卡,因此需要从点击事件等通过浏览器开始的事件处理等进行调用。此时如果从 XMLHttpRequest 等非同步处理的回叫等进行调用,那么在调用window.open()时可能由于浏览器阻止弹出等原因而导致新window创建失败。点击安装键时,调用此方法开始游戏服务器登录会话的示例如下。
var installButton = document.getElementById (``" installButton "``); installButton.addEventListener (``" click"``, function(evt) { var params = { state: state , responseType : [``" token"``, "code "``], authCustomTheme: "new_theme_1"``, authAppearanceVersion: 1``, loginCustomTheme: "new_theme_1"``, loginAppearanceVersion: 1 }; var cb = function(error , result) { if (error) { // 继 续 访 客 试 玩 return``; } // 在 游 戏 服 务 器 进 行 登 录 会 话 发 行 手 续 startSession (result.response ); }; mobage.oauth.connect(params , cb); }, false ); |
mobage.oauth.disconnect
向用户显示卸载此Client所需的UI,将执行结果反馈至Callback函数。
语法
mobage.oauth. disconnect (params , cb); |
参数
params
Object型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| theme | 主题 | string | false | 预设的设计主题。目前从 default 或 dark 中选择。如果省略,则为 default。 |
cb
Function型的参数。
此Callback函数的error参数是Object,属性有error, error_description。
传递给Callback函数的error属性列表
| error | description |
|---|---|
| not_connected | 非安装状态 |
| user_canceled | 用户取消卸载时 |
| server_error | Mobage Connect 服务器端发生系统错误时 |
说明
此方法向用户显示卸载此Client所需的UI,并反馈执行结果。
为了保护用户,请务必将此功能载入游戏中。
例
游戏卸载示例如下。
var disconnectButton = document.getElementById (``" disconnectButton "``); disconnectButton.addEventLister (``" click"``, function (evt) { var params = { theme : "default" }; var cb = function (error , result) { if (! error) { window.alert (``" 卸 载 完 成。 "``); // 游 戏 服 务 器 会 话 进 入 非 登 录 状 态 restartSession (); } }; }, false ); |
mobage.oauth.logout
此方法用于打开从Mobage Connect退出UserAgent所需的UI。通过Callback函数接收反馈值。
通常情况下,当退出成功时,还需要在游戏服务器上明确退出UserAgent。
语法
mobage.oauth.logout(params , cb); |
参数
params
Object型的参数。可设置如下所示的属性。
cb
Function型的参数。
params
Object型的参数。可设置如下所示的属性。
| property | title | type | required | description |
|---|---|---|---|---|
| theme | 主题 | string | false | 预设的设计主题。目前从default或dark中选择。如果省略,则为default。 |
此Callback函数的error参数为Object,属性有error, error_description。成功时的result参数无属性。
传递给Callback函数的error属性列表
| error | description |
|---|---|
| not_login | 非登录状态时 |
| user_canceled | 用户取消卸载时 |
| server_error | Mobage Connect 服务器端发生系统错误时 |
想要明确从游戏中将Mobage Connect上的UserAgent登录会话注销时,使用此项。另外,通常此时还需要注销游戏服务器发行的登录会话。
例
在Mobage Connect上退出成功时,游戏服务器的登录会话注销示例如下。
var logoutButton = document.getElementById (``" logoutButton "``); logoutButton . addEventLister (``" click"``, function (evt) { var cb = function (error , result) { if (error) { window.alert (``" Error Code: " + error.error + ", Error Description : " + error. description ); return``; } // 注 销 游 戏 服 务 器 的 登 录 会 话 revokeSession (); }; mobage.oauth.logout ({ theme : "dark" }, cb); }, false ); |