onShareAppMessage-设置该页面的转发信息

onShareAppMessage(options)

在 Page 中定义 onShareAppMessage 函数,设置该页面的转发信息。

  • 只有定义了此事件处理函数,右上角菜单才会显示 “转发” 按钮

  • 用户点击转发按钮的时候会调用

  • 此事件需要 return 一个 Object,用于自定义转发内容


options 参数说明

参数类型说明最低版本
fromString转发事件来源。button:页面内转发按钮;menu:右上角转发菜单1.2.4
targetObject如果 from 值是 button,则 target 是触发这次转发事件的 button,否则为 undefined1.2.4


自定义转发字段

字段说明默认值最低版本
title转发标题当前小程序名称
path转发路径当前页面 path ,必须是以 / 开头的完整路径
imageUrl自定义图片路径,可以是本地文件路径、代码包文件路径或者网络图片路径,支持PNG及JPG,不传入 imageUrl 则使用默认截图。显示图片长宽比是 5:4
1.5.0
success转发成功的回调函数
1.1.0
fail转发失败的回调函数
1.1.0
complete转发结束的回调函数(转发成功、失败都会执行
1.1.0


回调结果:

回调类型errMsg说明
successshareAppMessage:ok转发成功
failshareAppMessage:fail cancel用户取消转发
failshareAppMessage:fail (detail message)转发失败,其中 detail message 为详细失败信息


success回调参数说明:

参数类型说明最低版本
shareTicketsStringArrayshareTicket 数组,每一项是一个 shareTicket ,对应一个转发对象1.1.0


示例代码:

Page({
  onShareAppMessage: function (res) {
    if (res.from === 'button') {
      // 来自页面内转发按钮
      console.log(res.target)
    }
    return {
      title: '自定义转发标题',
      path: '/page/user?id=123',
      success: function(res) {
        // 转发成功
      },
      fail: function(res) {
        // 转发失败
      }
    }
  }
})