微信小游戏开发文档-小游戏转发API wx.shareAppMessage(Object object)
wx.shareAppMessage(Object object)
主动拉起转发,进入选择通讯录界面。
wx.onShareAppMessage(function callback)
监听用户点击右上角菜单的“转发”按钮时触发的事件
参数
function callback
监听事件的回调函数
callback 回调函数
参数
Object object
属性 | 类型 | 默认值 | 是否必填 | 说明 | 支持版本 |
---|---|---|---|---|---|
title | string | 否 | 转发标题,不传则默认使用当前小游戏的昵称。 | ||
imageUrl | string | 否 | 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。 | ||
query | string | 否 | 查询字符串,从这条转发消息进入后,可通过 wx.onLaunch() 或 wx.onShow 获取启动参数中的 query。必须是 key1=val1&key2=val2 的格式。 | ||
success | function | 否 | 接口调用成功的回调函数 | ||
fail | function | 否 | 接口调用失败的回调函数 | ||
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 回调函数
参数
Object res
属性 | 类型 | 说明 | 支持版本 |
---|---|---|---|
shareTickets | Array.<string> | 每一项是一个 string 类型的 ShareTicket ,对应每个群。如果此次转发是带 shareTicket 的转发则会有回调此参数。可作为 wx.getShareInfo() 的参数来获取群 id。 | |
groupMsgInfos | Array.<GroupMsgInfo> | 群消息票据信息列表,长度与 res.shareTickets 相等 |