mobage.ui
概要
此模块中的功能,包括与Widget Service 关联的相关功能。
功能列表
mobage.ui 模块中有以下方法。根据各方法中可指定的 service 参数,可调用的 Widget 有所不同。
mobage.ui.open()
通过对话形式调用Widget Service 的方法。
请在点击事件等通过浏览器开始的事件处理程序中调用此方法。
语法
mobage.ui.open(service , params , callback ); |
参数
service
string 型的参数。详情如下所示。
service | description | 详细service |
|---|---|---|
| payment | 启动使用已创建的事务进行物品收费所需的 Widget Service。 | |
| user_upgrade | 启动用户升级所需的 Widget Service。 | |
| invitation | 启动邀请好友进入游戏所需的 Widget Service。 | invitation |
| client_configuration | 提供设置更改画面的功能。 |
params
object 型的参数。
callback
function 型的参数。
return
可接收object 作为 return ,对mobage.ui.open 打开的 tab/iframe 进行如下所示的关闭操作。
var handle = mobage.ui.open(``"payment"``, {}, callback); handle.dispose(); |
说明
此方法可通过对话形式调用各服务,并通过callback 参数指定的回叫函数来接收响应。
可指定的参数和通过回叫函数传递的参数详情,请参见各服务页面。
例
此方法可能会通过window.open()打开新选项卡,因此需要在点击事件等通过浏览器开始的事件处理程序等进行调用。
此时如果从 XMLHttpRequest 等非同步处理的回叫等进行调用,那么在调用window.open()时可能由于浏览器阻止弹出等原因而导致新window创建失败。
以此为前提,样例代码如下所示。
var openUILink = document.getElementById (``"openUILink"``); openUILink.addEventListener (``"click"``, function(evt) { var openUILink = event.srcElement; var dataSet = openUILink.dataSet; mobage.ui.open( "payment"``, { transactionId : dataSet.transactionId , orderId: dataSet.orderId }, function(error , result) { // handle callback } ); }, false ); |
mobage.ui.show()
打开Widget Service 所需的方法。
请在点击事件等通过浏览器开始的事件处理程序中调用此方法。
语法
mobage.ui.show(service , params ); |
参数
service
string 型的参数。可指定的值如下。
service | description | 详细service |
|---|---|---|
| redirect | 跳转至外部网站时,对用户提供确认画面的功能。 | |
| client_agreement | 显示用户同意事项。 | |
| client_community | 打开官方圈。 | |
| commercial_transaction | 打开特定商务交易法标识 | |
| inquiry | 打开垂询 | |
| mygame | 打开我的游戏 | |
| mypage | 打开我的页面 | |
| portal | 打开Mobage 首页 | |
| browser_switch_guide | 在Facebook 或 Twitter 等 iOS 官方应用软件的UIWebView 中打开 JavaScript SDK 创建的标题时,显示请用Safari 打开的提示画面所需的服务。 | |
| shortcut_icon | 提示用户在 iOS 或 Android 终端的主屏幕中设置游戏快捷图标所需的服务。 |
在Shell App SDK for iOS 1.4.1 之前,请勿调用mobage.ui.show() 的 client_community(官方圈), my game(我的游戏), my page(我的页面), portal(Mobage 首页)。仅限Shell App SDK for iOS 1.4.1 之前,调用或不调用这些API需要游戏端的支持。
从Shell App SDK for iOS 1.4.1 以后,可任意调用这些 API。从Shell App SDK 1.4.1 以后,调用这些 API ,会从使用 Shell App SDK 的应用跳转至终端浏览器。
params
object 型的参数。
return
可接收object 作为 return ,对mobage.ui.show 打开的 tab/iframe 进行如下所示的关闭操作。
var handle = mobage.ui.show(``"client_agreement"``); handle.dispose(); |
说明
此功能主要用于在新选项卡中打开 Mobage 上的功能。规定上有几项服务,需要在游戏启动画面开始跳转 2 次以内的地方设置引导线。
例
此方法会通过 window.open() 打开新选项卡,因此需要在点击事件等通过浏览器开始的事件处理程序等中进行调用。
此时如果从 XMLHttpRequest 等非同步处理的回叫等进行调用,那么在调用window.open()时可能由于浏览器阻止弹出等原因而导致新window创建失败。
在此前提下,打开用户同意事项的样例代码如下所示。
var showUILink = document.getElementById (``"showUILink"``); showUILink.addEventListener (``"click"``, function(evt) { var service = "client_agreement"``; mobage.ui.open( service , {} ); }, false ); |
另外,移动至外部网站时,显示确认画面的样例代码如下所示。
var showUILink = document.getElementById (``"showUILink"``); showUILink.addEventListener (``"click"``, function(evt) { var service = "redirect"``; mobage.ui.open( service , { uri: showUILink.getAttribute (``"href"``) } ); }, false ); |
mobage.ui.embed()
是植入Widget Service 所需的方法。
语法
mobage.ui.embed(service , params ); |
参数
service
string 型的参数。可指定的值如下。
| service | description | 详细service |
|---|---|---|
| chat | 是植入Chat Widget 的功能。 | chat |
params
object 型的参数。
说明
此功能主要用于将 Mobage 上的功能植入指定 id 的 DOM。
例
此方法是 getConnectedStatus() 方法,需要在确认了已登录且已安装的状态后进行调用。
在此前提下,植入 Widget Service 的样例代码如下所示。
mobage.oauth.getConnectedStatus({state: clientData.state}, function``(err, result) { if (result) { mobage.ui.embed(``'chat'``, { targetId: 'mobage-sample-chat'``, channelId: 12345 }); } else { console.log(err); } }); |
另外,通过在HTML文件进行如下记载,可进行 Widget SDervice 的植入。
植入前
<``div id``=``"mobage-sample-chat"``> </``div``> |
植入后
<``div id``=``"mobage-sample-chat" class``=``"mbga-game-chat" data-plugins-type``=``"mbga-game-chat" data-talk-id``=``12345``"> <``iframe``> ... </``iframe``> </``div``> |
服务列表
在mobage.ui.open()方法中操作的 WidgetService 如下。
在mobage.ui.show()方法中操作的 WidgetService 如下。
- redirect
- client_agreement
- client_community
- commercial_transaction
- inquiry
- mygame
- mypage
- portal
- browser_switch_guide
- shortcut_icon
在mobage.ui.embed()方法中操作的 WidgetService 如下。
mobage.ui.open() payment
对于指定的事务,向用户提供物品购买功能的服务。
语法
在mobage.ui.open() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定payment |
| params | object | true | |
| params.zIndex | string | false | 指定弹出的 z-index 值 |
| params.transactionId | string | true | 指定Transaction ID |
| params.orderId | string | false | 指定Order ID |
| params.customTheme | string | false | 可用字符串来指定物品购买画面用的自定义主题。请在开发者网站中指定自定义主题。 ※从 JS SDK 2.15.0 起可指定。 |
| params.appearanceVersion | number | false | 可指定物品购买画面用的自定义主题的版本。自定义主题的版本请见开发者网站。※从 JS SDK 2.15.0 起可指定。 |
| params.closeTimeout | number | false | 可指定过几秒后关闭装备购买完成画面。如果设置为 0 ,在显示完成画面后立即关闭。 |
| callback | Function | true | 指定Callback 函数。 |
传递至Callback 函数的 error, result 对象如下。
| field | title | type | description |
|---|---|---|---|
| error | 错误代码 | string | 反馈错误代码 |
| errorDescription | 错误说明 | string | 反馈错误说明 |
传递至Callback 函数的 result 对象如下。
| property | title | type | description |
|---|---|---|---|
| response | 执行结果 | object | 含有Bank Debit API 资源和 OrderID 的对象 |
| signedResponse | 用 JWT来表示执行结果 | string | 用 JWT 来表示response 中指定 JSON Object的字符串 |
response 的值如下。
| property | title | type | required | description |
|---|---|---|---|---|
| service | 服务名 | string | true | 设置有payment |
| response.result | 结果对象 | object | true | |
| response.result.payment | 事务 | object | true | |
| response.result.payment.id | Transaction ID | string | true | 用Bank Debit API 创建的事务的标识符 |
| response.result.payment.items | 购买装备列表 | array | true | 用Bank Debit API 创建的事务中含有的购买装备列表 |
| response.result.payment.items.0.item.id | 装备 ID | string | true | 装备的标识符 |
| response.result.payment.items.0.item.name | 装备名 | string | true | 装备的名称 |
| response.result.payment.items.0.item.price | 装备单价 | integer | true | 装备的单价 |
| response.result.payment.items.0.item.description | 装备说明 | string | true | 装备的说明 |
| response.result.payment.items.0.item.imageUrl | 装备图片URL | string | true | 装备图片的URL |
| response.result.payment.state | 状态 | string | true | 事务的状态。new,authorized, open, closed, error 中的任意一种。 |
| response.result.payment.comment | 备注 | string | true | 事务绑定的备注 |
| response.result.payment.published | 创建时间 | string | true | 事务的创建时间 |
| response.result.payment.updated | 更新时间 | string | true | 事务的创建时间 |
| response.result.order_id | Order ID | string | false |
error.error 属性的列表
| error | description |
|---|---|
| invalid_request | 请求参数不当时 |
| access_denied | 表格发送时间过长时 |
| canceled | 装备结算处理被取消时 |
| conflict | 事务存在,但state 不当时 |
| transction_is_not_found | 事务不存在时 |
| system_error | 发生系统错误时 |
画面示例
调用后,会显示如下所示的画面。

说明
详情请见 使用梦宝币进行装备收费 。
mobage.ui.open() user_upgrade
是执行用户升级所需的服务。
语法
在mobage.ui.open() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定user_upgrade |
| params | object | true | |
| params.requiredGrade | string | true | 指定升级等级 2 或 3 |
| callback | Function | true | 指定Callback 函数 |
传递至Callback 函数的 error, result 对象如下。
| field | title | type | description |
|---|---|---|---|
| error | 错误代码 | string | "already_sufficient_grade" 和 "user_canceled" 等表示错误类型的标识符 |
| errorDescription | 错误说明 | string | 反馈错误说明 |
传递至Callback 函数的 result 对象如下。
| property | title | type | description |
|---|---|---|---|
| grade | 等级 | string | 升级后的用户等级 |
调用mobage.ui.open user_upgrade 前,请务必调用 People API ,在确认等级后升级至适当的等级。
在requiredGrade 中可设置 2 和 3 ,通常可进行“1 → 2”和“2 → 3”的升级,如果进行“1 → 3”“2 → 2”“3 → 2”“3 → 3”的升级,会显示错误画面,敬请注意。
画面示例
调用后,会显示如下所示的画面。

说明
详情请见 用户升级功能的实装 。
mobage.ui.open() invitation
是邀请好友进入游戏所需的服务。
语法
在mobage.ui.open() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定user_upgrade |
| callback | Function | true | 指定Callback 函数 |
传递至Callback 函数的 error, result 对象如下。(对Shell App SDK ,触摸“返回至应用”时,不会反馈回叫)
| field | title | type | description |
|---|---|---|---|
| error | 错误代码 | string | 反馈错误代码 |
| errorDescription | 错误说明 | string | 反馈错误说明 |
传递至Callback 函数的 result 对象如下。
| property | title | type | description |
|---|---|---|---|
| response | 执行结果 | object | 含有Invitation, Message, Mygame 等设置结果的对象 |
| signedResponse | 用 JWT来表示执行结果 | string | 用 JWT 来表示response 中指定 JSON Object的字符串 |
response 的值如下。
| property | title | type | required | description |
|---|---|---|---|---|
| response.service | 服务名 | string | true | 设置有initation |
| response.result | 结果对象 | object | true | |
| response.result.channel | 邀请通道 | string | true | 通过什么邀请方法进行的邀请 |
| response.result.invitee | 邀请人 ID | array | false | 梦宝友邀请人的 userId 。非梦宝友邀请无此参数。 |
| response.result.inviteeUserId | 邀请人 ID | array | false | 梦宝友邀请人的 userId 。非梦宝友邀请无此参数。 |
画面示例
调用后,会显示如下所示的画面。

说明
详情请见 好友邀请服务 。
mobage.ui.open() client_configuration
是提供给用户在各游戏中变更 Mobage上可设置内容所需的服务。
语法
在mobage.ui.open() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定client_configuration |
| params | object | true | |
| params.requiredInvitation | integer | false | 要显示邀请设置时,指定1。不要显示时,指定0。默认为1。 |
| params.requiredMessage | integer | false | 要显示游戏通知 (Message API) 接收设置时,指定1。不要显示时,指定0。默认为1。 |
| params.requiredMygame | integer | false | 要显示我的游戏设置时,显示1,不要显示时,指定0。默认为1。 |
| callback | Function | true | 指定Callback 函数。 |
传递至Callback 函数的 error, result 对象如下。
| field | title | type | description |
|---|---|---|---|
| error | 错误代码 | string | 反馈错误代码 |
| errorDescription | 错误说明 | string | 反馈错误说明 |
传递至Callback 函数的 result 对象如下。
| property | title | type | description |
|---|---|---|---|
| response | 执行结果 | object | 含有Invitation, Message, Mygame 等设置结果的对象 |
| signedResponse | 用 JWT来表示执行结果 | string | 用 JWT 来表示response 中指定 JSON Object的字符串 |
response 值如下。
| property | title | type | description |
|---|---|---|---|
| response.service | 服务名 | string | 设置有client_configuration |
| response.result | 结果对象 | object | |
| response.result.invitation | 可否发送邀请? | boolean | |
| response.result.message | 是否接收游戏通知? | boolean | |
| response.result.mygame | 是否添加至我的游戏? | boolean |
error.error 属性的列表
| error | description |
|---|---|
| impossible_to_continue_process | 无可设置的项目时 |
| canceled | 用户取消设置更新时 |
| invalid_request | 请求参数不当时 |
| invalid_client | 无适当的 client 时 |
| system_error | 发生系统错误时 |
说明
用户可在各游戏中设置的 Mobage 设置如下所示。
-
接受邀请设置
-
“游戏通知”接收设置
-
添加/删除我的游戏
可从中选择游戏所需要的设置项目,为用户提供设置画面。例
设置项目只显示“游戏通知”接收设置和添加/删除我的游戏的示例如下。
var openButton = document.getElementById (``"openClientConfiguration"``);openButton.addEventListener (``"click"``, function(evt) {mobage.ui.open("client_configuration"``,{requiredMessage :1``,requiredMygame :1},function(error , result) {// handle callback});},false);画面示例
调用后,会显示如下所示的画面。

mobage.ui.show() redirect
在链接至外部网站时,为请求用户同意所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定redirect |
| params | object | true | |
| params.uri | string | true | 指定外部网站的 URI |
说明
使用Mobage JS SDK创建应用软件时,如果使用Mobage的子域名(*.mobage.jp, *.mbga.jp等) ,
那么需要按照外部链接指南做中间页面和AD 标识。如果使用独立域名提供,那么无需做中间页面和 AD 标识。
为了显示中间页面,需要对外部链接使用redirect 服务。
用户按“在新窗口中打开”键时,外部网站在新窗口中打开。按取消时,模态窗口自动消失。
例
在链接中使用 redirect 服务的示例如下。
var outLink = document.getElementById (``"out"``); out.addEventListener (``"click"``, function(evt) { var outLink = event.srcElement ; mobage.ui.show( "redirect"``, { uri: outLink.href } ); }, false ); |
画面示例
调用后,会显示如下所示的画面。

说明
详情请见 Client 端的处理概要 。
mobage.ui.show() client_agreement
打开同意事项所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定client_agreement |
| params | object | false |
说明
打开用户同意事项。
例
var clientAgreementLink = document.getElementById (``"clientAgreement"``); clientAgreementLink.addEventListener (``"click"``, function(evt) { mobage.ui.show (``"client_agreement"``); }, false ); |
画面示例
调用后,会显示如下所示的画面。

mobage.ui.show() client_community
在Shell App SDK for iOS 1.4.1 之前,请勿调用mobage.ui.show() 的 client_community(官方圈), my game(我的游戏), my page(我的页面), portal(Mobage 首页)。仅限Shell App SDK for iOS 1.4.1 之前,调用或不调用这些API需要游戏端的支持。
从Shell App SDK for iOS 1.4.1 以后,可任意调用这些 API。从Shell App SDK 1.4.1 以后,调用这些 API 后,会从使用 Shell App SDK 的应用跳转至终端浏览器。
打开官方圈所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定client_community |
| params | object | false |
说明
在新 window 中打开官方圈。
例
var clientCommunityLink = document.getElementById (``"clientCommunity"``); clientCommunityLink.addEventListener (``"click"``, function(evt) { mobage.ui.show (``"client_community"``); }, false ); |
画面示例
调用后,会显示如下所示的画面。

mobage.ui.show() commercial_transaction
打开特定商务交易法标识所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定commercial_transaction |
| params | object | false |
说明
在新 window 中打开特定商务交易法标识。
例
var commercialTransactionLink = document.getElementById (``"commercialTransaction"``); commercialTransactionLink.addEventListener (``"click"``, function(evt) { mobage.ui.show (``"commercial_transaction"``); }, false ); |
画面示例
调用后,会显示如下所示的画面。

mobage.ui.show() inquiry
打开用户向开发者垂询所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定inquiry |
| params | object | false |
说明
打开用户向开发者垂询所需的服务。
例
var inquiryLink = document.getElementById (``"inquiry"``); inquiryLink.addEventListener (``"click"``, function (evt) { mobage.ui.show (``"inquiry"``); }, false ); |
画面示例
调用后,会显示如下所示的画面。

mobage.ui.show() mygame
在Shell App SDK for iOS 1.4.1 之前,请勿调用mobage.ui.show() 的 client_community(官方圈), my game(我的游戏), my page(我的页面), portal(Mobage 首页)。仅限Shell App SDK for iOS 1.4.1 之前,调用或不调用这些API需要游戏端的支持。
从Shell App SDK for iOS 1.4.1 以后,可任意调用这些 API。从Shell App SDK 1.4.1 以后,调用这些 API 后,会从使用 Shell App SDK 的应用跳转至终端浏览器。
打开我的游戏所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定mygame |
| params | object | false |
说明
打开我的游戏所需的服务。
例
var mygameLink = document.getElementById (``"mygame"``); mygameLink.addEventListener (``"click"``, function(evt) { mobage.ui.show (``"mygame"``); }, false ); |
画面示例
调用后,会显示如下所示的画面。

mobage.ui.show() mypage
在Shell App SDK for iOS 1.4.1 之前,请勿调用mobage.ui.show() 的 client_community(官方圈), my game(我的游戏), my page(我的页面), portal(Mobage 首页)。仅限Shell App SDK for iOS 1.4.1 之前,调用或不调用这些API需要游戏端的支持。
从Shell App SDK for iOS 1.4.1 以后,可任意调用这些 API。从Shell App SDK 1.4.1 以后,调用这些 API 后,会从使用 Shell App SDK 的应用跳转至终端浏览器。
打开我的页面所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定mypage |
| params | object | true |
说明
打开我的游戏所需的服务。
例
var mypageLink = document.getElementById (``"mypage"``); mypageLink.addEventListener (``"click"``, function(evt) { mobage.ui.show (``"mypage"``); }, false ); |
画面示例
调用后,会显示如下所示的画面。

mobage.ui.show() portal
在Shell App SDK for iOS 1.4.1 之前,请勿调用mobage.ui.show() 的 client_community(官方圈), my game(我的游戏), my page(我的页面), portal(Mobage 首页)。仅限Shell App SDK for iOS 1.4.1 之前,调用或不调用这些API需要游戏端的支持。
从Shell App SDK for iOS 1.4.1 以后,可任意调用这些 API。从Shell App SDK 1.4.1 以后,调用这些 API 后,会从使用 Shell App SDK 的应用跳转至终端浏览器。
打开Mobage 首页所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定portal |
| params | object | false |
说明
打开 Mobage 首页所需的服务。
例
var portalLink = document.getElementById (``"portal"``); portalLink.addEventListener (``"click"``, function(evt) { mobage.ui.show (``"portal"``); }, false ); |
画面示例
调用后,会显示如下所示的画面。
mobage.ui.show() browser_switch_guide
是在Facebook 或 Twitter 等 iOS 官方应用软件 UIWebView 中打开 JavaScript SDK 创建的标题时,显示请用Safari 打开的提示画面所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定browser_switch_guide |
| params | object | false |
说明
在Facebook 或 Twitter 的iOS 官方应用软件 UIWebView 中打开 JavaScript SDK 创建的标题时,显示请用Safari 打开的提示画面所需的服务。此 UI 服务并非由客户端应用软件自行判别和调用 UserAgent 等,而是当mobage.init() 的第一参数的对象 showBrowserSwitchGuide 字段设置为false 时,在mobage.event.subscribe() 中接收platform.unsupportedBrowser 事件时进行明确调用。当UI 无问题或对在 UIWebView 中打开的事件不想夹带任何处理时,只要将showBrowserSwitchGuide 字段设置为 true 即可停用此服务,在 UIWebView 中打开时自动显示此服务。
例
mobage.event.subscribe (``"platform.unsupportedBrowser"``, function(event) { mobage.ui.show(``"browser_switch_guide"``); }); |
画面示例
调用后,会显示如下所示的画面。

说明
详情请见 在非支持浏览器中显示向导 。
mobage.ui.show() shortcut_icon
提示用户在 iOS 或 Android 终端的主屏幕中设置游戏快捷图标所需的服务。
语法
在mobage.ui.show() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定browser_switch_guide |
| params | object | true | |
| params.shortcutType | string | true | 指定快捷图标的标识符 |
说明
提示用户在 iOS 或 Android 终端的主屏幕中设置游戏快捷图标所需的服务。使用此功能创建的快捷图标,不仅可以跳转至事先指定的URL,还可以判断是否通过快捷方式启动。
例
showShortcut = document.getElementById(``'show_shortcut'``); showShortcut.addEventListener(``'click'``, function() { mobage.ui.show(``'shortcut_icon'``, {shortcutType : 'top'``}); }, false``); |
画面示例
调用后,会显示如下所示的画面。

说明
详情请见 快捷图标创建辅助功能 。
mobage.ui.embed() chat
是将 Chat 的Widget从Mobage JS SDK 植入应用软件的功能。
语法
在mobage.ui.embed() 中使用服务时,要指定的参数如下。
| field | type | required | description |
|---|---|---|---|
| service | string | true | 请指定chat |
| params | object | true | |
| params.targetId | string | true | Chat 化标签的 id |
| params.channelId | number | true | 已生成Chat 的通道 ID |
| params.productName | string | false | 标题名 |
| params.widgetId | string | false | 生成微件要素 (iframe) 的 ID (DOM的id) |
| params.widgetMode | string | false | 游戏聊天的类型 (可设置的值: "simple_message_list", "message_list", "preview") |
| params.useStream | boolean | false | 实时聊天 (可设置的值: true, false) |
| params.previewLimit | number | false | 预览时最多显示的信息条数 |
| params.stampSize | string | false | 表情大小 (可设置的值: "small", "large") |
| params.limit | number | false | 最多显示的信息条数 |
| params.theme | string | false | 主题 (可设置的值: "dark", "light") |
| params.defaultMessage | string | false | 输入显示的默认信息 |
| params.successCallback | string | false | 信息发帖成功时的重定向目标URL |
| params.showHeader | boolean | false | 显示/隐藏报头部分 (可设置的值: true, false) |
| params.showLink | boolean | false | 显示/隐藏下方按键部分 (可设置的值: true, false) |
| params.showPostform | boolean | false | 显示/隐藏发帖的输入表 (可设置的值: true, false) |
| params.styleSheet | string | false | 定义游戏独有风格的 CSS 文件 |
说明
将 Chat 的Widget从Mobage JS SDK 植入应用软件。与Mobage 的通常 Chat 同样,会对发帖信息进行审查。
要使用此功能,需要在 RESTful API 中生成 Chat 通道。
请参见关于Chat Widget。
例
mobage.oauth.getConnectedStatus({state: clientData.state}, function``(err, result) { if (result) { mobage.ui.embed(``'chat'``, { targetId: 'mobage-sample-chat'``, channelId: 12345 }); } else { console.log(err); } }); |
另外,通过在HTML文件进行如下记载,进行 Widget SDervice 的植入。
植入前
<``div id``=``"mobage-sample-chat"``> </``div``> |
植入后
<``div id``=``"mobage-sample-chat" class``=``"mbga-game-chat" data-plugins-type``=``"mbga-game-chat" data-talk-id``=``12345``"> <``iframe``> ... </``iframe``> </``div``> |
更新履历
- 2016/06/06
- 在传递给mobage.ui.open() payment 的参数中补充 zIndex
- 2016/05/08
- 补充mobage.ui.open() payment 的 closeTimeout 相关描述
- 2015/12/22
- 无mobage.ui.open() payment 的定制主题相关描述,故补充
- 2015/08/17
- 存在不能使用User Upgrade 的情况,故补充注意事项
- 2015/08/11
- 在Shell App SDK for iOS 中不能调用官方圈、我的游戏、我的页面、Mobage 首页,故补充注意事项