空间H5游戏-客户端接口
mqq.ui.shareMessage
结合版
>= IOS 4.7.2
>=android 4.7.2
独立版
>= IOS 7.3
>=android 7.3
使用说明
调用客户端的分享接口,分享内容给好友/群/空间/微信,调用后会弹出联系人选择列表 建议在mqq.ui.setOnShareHandler的回调中配合使用
注意
在PC侧retcode=100004代表命中了安全打击,此时请仔细检查分享的文案内容
参数说明
mqq.ui.shareMessage(params, callback)
名称 | 类型 | 描述 |
---|---|---|
params | Object | 必选:是 说明:参数 |
callback(result) | Function | 必选:是 说明:注册回调 |
参数:
params
独立版仅支持 title/desc/share_url/image_url/share_type 字段
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
title | String | 是 | 必填,消息标题,最长45字节 |
desc | String | 是 | 必填,消息摘要,最长60字节。 |
share_type | Number | 是 | 分享的目标类型,默认为 0 0:QQ好友; 1:QQ空间; 2:微信好友; 3:微信朋友圈。 |
share_url | String | 是 | 点击消息后的跳转url,最长120字节。原 targetUrl 参数,可以继续使用 targetUrl |
image_url | String | 是 | 消息左侧缩略图url。图片推荐使用正方形,宽高不够时等比例撑满,不会变形。原 imageUrl 参数,可以继续使用 imageUrl。注意:图片最小需要200 * 200,否则分享到Qzone时会被Qzone过滤掉。 |
back | Boolean | 是 | >= IOS 5.0 >= android 4.7.2 发送消息之后是否返回到web页面,默认false,直接到AIO,注:该参数只对share_type=0时起作用 |
shareElement | String | 是 | >= IOS 5.0 >= android 5.0 分享的类型,目前支持图文和音乐分享。默认为news news:图文分享类型, audio:音乐分享类型, video:视频分享类型。 |
flash_url | String | 是 | >= IOS 5.0 >= android 5.0 如果分享类型是音乐或者视频类型,则填写流媒体url |
puin | String | 是 | >= IOS 5.0 >= android 5.0 公众帐号uin,用于自定义结构化消息尾巴,只在公众账号分享的时候填写,若不是请不要填,当puin没有索引到本地记录,则显示sourceName字段的文本,若没有sourceName字段,则直接显示puin数字 |
appid | String | 是 | >= IOS 5.0 >= android 5.0 来源 appid,在QQ互联申请的的 appid,如果有,可以填上 |
sourceName | String | 是 | 消息来源名称,默认为空,优先读取 appid 对应的名字,如果没有则读取 puin 对应的公众账号名称 |
toUin | String | 是 | >= IOS 5.0 >= android 5.0 分享给指定的好友或群,如果存在这个参数,则不拉起好友选择界面 (针对分享给好友) |
toOpenid | String | 否 | >= IOS 5.0 >= android 5.0 分享给指定的好友,如果存在这个参数,则不拉起好友选择界面 (针对小游戏分享/邀请好友中替代toUin所用) |
uinType | String | 是 | >= IOS 5.0 >= android 5.0 分享给指定的好友或群的uin类型: 0:好友; 1:群 (针对分享给好友) |
回调:
callback(result)
独立版7.3 IOS分享到qzone没有回调,将在7.4修复
独立版7.3 Android玩吧分享到qq没有回调,正在调整,预计7.4修复
独立版7.3 Android分享到微信好友、微信朋友圈回调有两次,正在调整,预计7.4修复
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
result | Object | 是 | 返回对象 |
回调参数
result
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
retCode | Number | 是 | 返回码 |
返回码
retCode
- 0 -- 用户点击发送,完成整个分享流程
- 1 -- 用户点击取消,中断分享流程
- 2 -- IOS端分享到微信或朋友圈时,手动取消分享将返回-2
Example
mqq.invoke('ui','setOnShareHandler',function(type){
mqq.invoke('ui','shareMessage',{
title: '自定义的分享标题',
desc: '自定义的分享描述',
share_type: type,
share_url: window.OPEN_DATA.shareurl,
image_url: 'http://i.gtimg.cn/open/app_icon/05/58/35/77/1105583577_100_m.png',
back: true
},function(result){
//result
});
});
注意:share_url必须是window.OPEN_DATA.shareurl(可以拼接自定义参数)