小程序开放平台

文档中心
基础
转发
showShareMenu
shareAppMessage
onShareAppMessage
offShareAppMessage
onShareTimeline
offShareTimeline
onShareChat
offShareChat
界面
网络
数据缓存
渲染
媒体
文件
开放接口
设备
跳转
位置
支付

xhs.onShareChat

开发
>
JS API
>
转发
>
onShareChat
>
更新时间:2024-11-14 11:47:47

监听用户点击右上角菜单的「分享到微信好友」按钮时触发的事件。

参数

function listener

用户点击右上角菜单的「分享到微信好友」按钮时触发的事件的监听函数

参数

Object object

属性
类型
必填
说明
titlestring转发标题,不传则默认使用当前小游戏的昵称。
imageUrlstring转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径
querystring查询字符串,从这条转发消息进入后,可通过 xhs.getLaunchOptionsSync() 或 xhs.onShow() 获取启动参数中的 query。必须是 key1=val1&key2=val2 的格式。
pathstring独立分包路径

示例代码

  // 绑定分享参数
  xhs.onShareChat(() => {
    return {
      title: '转发标题',
      imageUrl: '', // 图片 URL
      query: 'a=1&b=2'
    }
  })
  // 取消绑定分享参数
  xhs.offShareChat()