微信小程序API 转发（Page.onShareAppMessage）-木庄网络博客

本文整理自网络，侵删。

onShareAppMessage(options)

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

只有定义了此事件处理函数，右上角菜单才会显示“转发”按钮
用户点击转发按钮的时候会调用
此事件需要 return 一个 Object，用于自定义转发内容

options 参数说明

参数	类型	说明	最低版本
from	String	转发事件来源。button：页面内转发按钮；menu：右上角转发菜单	1.2.4
target	Object	如果 from 值是 button，则 target 是触发这次转发事件的 button，否则为 undefined	1.2.4

自定义转发字段

字段	说明	默认值	最低版本
title	转发标题	当前小程序名称
path	转发路径	当前页面 path ，必须是以 / 开头的完整路径
success	转发成功的回调函数		1.1.0
fail	转发失败的回调函数		1.1.0
complete	转发结束的回调函数（转发成功、失败都会执行		1.1.0

回调结果：

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

success回调参数说明：

参数	类型	说明	最低版本
shareTickets	StringArray	shareTicket 数组，每一项是一个 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) {
        // 转发失败
      }
    }
  }
})

wx.showShareMenu(OBJECT)

基础库版本 1.1.0 开始支持，低版本需做兼容处理

显示当前页面的转发按钮

OBJECT参数说明：

参数	类型	必填	说明
withShareTicket	Boolean	否	是否使用带 shareTicket 的转发详情
success	Function	否	接口调用成功的回调函数
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

示例代码：

wx.showShareMenu({
  withShareTicket: true
})

wx.hideShareMenu(OBJECT)

基础库版本 1.1.0 开始支持，低版本需做兼容处理

隐藏转发按钮

OBJECT参数说明：

参数	类型	必填	说明
success	Function	否	接口调用成功的回调函数
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）