QQ游戏 开放平台

欢迎来到QQ游戏开放平台 管理中心 | 注册 | 开发者论坛
GameAPI.InviteBox

4.1.1功能说明

弹出好友选择器,发送大厅feed以及Tips以邀请好友进行游戏,前端JS接口。
Tips含游戏大厅Tips和QQTips,当大厅和QQ同时在线时,会优先发送大厅Tips;当大厅不在线时,会发送QQTips;QQ也不在线时,会保存为离线QQTips,在目标QQ下次登录时会显示。
接入Tips功能或者Feed功能时,游戏侧需要提交申请至qqgame产品接口人,接口人配置后方可接入。

4.1.2调用说明

1.接口包含

页面必须包含QQGame开放平台提供的js库,才能调用各js接口,如下:
//qqgameplatcdn.qq.com/social_hall/js/jquery.js
//qqgameplatcdn.qq.com/social_hall/js/jquery.pm.js
//qqgameplatcdn.qq.com/social_hall/app_frame/qqgamelib.js
游戏方可以直接在页面头部加载上面的js库,如下图:

也可以为性能考虑,在需要调用js接口前,动态加载上面的js库,不做约束。

2.域名检查
首先保证应用所在的域名是app$appid.qqgameapp.com或s\d\d.app$appid.qqgameapp.com,或者为qqgame.app$appid.twsapp.com, $appid为开放平台部分配的应用接入id,\d代表任一0~9整数。 多区多服应用域名支持app$appid.openwebgame.qq.com

3.接入QQGame
APP接入页面均内嵌在开放平台接入页面中,Javascript API定义在父页面中,各APP通过回调函数满足定制需求,调用API前需要提供域名到QQGame平台,并在平台发布白名单后在大厅测试专区中,使用测试号码进行调试。

4.调用接口前
  请先向QQGame平台提供应用定义邀请字符串(不超过60中文字符)及应用邀请图片,通过审核后更新配置即可使用。
如:
欢迎进入xx世界。。。
并提供一张74*74链接图片URL(注:建议图片格式为png/jpg/gif)
Tips的图片,尺寸规格为80*90(注:图片格式为静态gif)

5.被邀请者接受邀请会启动游戏。游戏启动链接中会包含如下信息:
&invitor=OPENID&invkey=INVKEY¶m=GAMEPARA,其中:
invitor为邀请发起者的openid
Invkey为邀请验证字段,后续会提供api验证该invkey的正确性
param为应用自定义参数(长度上限256bytes)

4.1.3调用方式(参考FOR QQ)

GameAPI.InviteBox.show(appid, opt, close_cb, invite_cb);

参数名称 含义
appid 应用id
opt 参数对象
close_cb 用户关闭邀请框的回调
invite_cb 用户邀请完成后的回调

opt具体内容

参数名称 参数含义 可选/必选
title 组件标题 可选
intro 组件内容简介 可选
tabid 组件打开时默认展示的tab,0为"全部好友",1为"蓝钻好友",2为"玩过这个游戏的好友" 可选
gamepara 自定义参数,字符串类型,长度上限为128bytes,不能包含'|'、'&'、'\\'、'='、'%'字符 可选
tips_id 取值:1~10 邀请组件提供推送qq tips功能(该功能需要联系qqgame产品开启),本功能支持应用自定义邀请tips文本内容及tips图片,本字段为自定义tips的标识,由(由qqgame产品给到),该字段为空,则发送默认内容 可选

回调函数
回调函数由第三方自定义,其参数是邀请的结果信息。

4.1.4 范例

function close_cb(result)
{
alert(result['resultstr']);
}
function invite_cb(result)
{
alert(result['resultstr']);
}
var param = {'title':'here is title', 'intro': 'here is your instroducton', 'tabid':0, 'gamepara':'hellogame','tips_id':1};
GameAPI.InviteBox.show(
10001,
param,
close_cb,
invite_cb
);

回调函数的传入参数result举例:{'result':0, 'resultstr':'success!', 'invnum':5},应用可按此解析

好友选择器如下:


邀请成功后大厅feed展示: