onShareAppMessage

WARNING

请注意,当前域名 https://dev.weixin.qq.com/docs/framework 文档已不维护,请前往微信文档中心open in new window 找到对应的新文档继续使用

补充:多端模式下「分享」的能力是基于 wx.miniapp.shareMiniProgramMessage 实现,因此需按照 wx.miniapp.shareMiniProgramMessageopen in new window完成相关初始化配置(即,需要绑定移动应用账号,勾选 opensdk 扩展能力等)

小程序模式下的自定义转发内容

字段说明默认值
title转发标题当前小程序名称
path转发路径当前页面 path ,必须是以 / 开头的完整路径
imageUrl自定义图片路径,可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4。使用默认截图
promise如果该参数存在,则以 resolve 结果为准,如果三秒内不 resolve,分享会使用上面传入的默认参数

多端应用模式下转发的内容

下列参数同 wx.miniapp.shareMiniProgramMessageopen in new window

字段说明是否必填
userName小程序原始ID,如 gh_d43f693ca31f,点击查看获取方式open in new window
path小程序页面路径;只支持本地路径,不支持网络路径
title标题
description描述
imagePath分享小程序相关缩略图,支持代码包图片资源路径或者本地临时、缓存、用户文件(不支持网络地址)
webpageUrl兼容低版本的网页链接 url
withShareTicket通常开发者希望分享出去的小程序被二次打开时可以获取到更多信息,例如群的标识。
miniprogramType0-正式版,1-开发版,2-体验版
scene发送的目标场景,只支持会话,0=分享到会话
promise如果该参数存在,则以 resolve 结果为准,如果三秒内不 resolve,分享会使用上面传入的默认参数

示例代码

Page({
  onShareAppMessage() {
    const promise = new Promise(resolve => {
      setTimeout(() => {
        resolve({
          userName: '小程序原始id',  
          path: 'pages/index/index',
          title: '标题',
          imagePath: '/pages/thumb.png',
          webpageUrl: 'www.qq.com',
          withShareTicket: true,
          miniprogramType: 0,
          scene: 0, 
        })
      }, 2000)
    })
    return {
      userName: '小程序原始id',  
      path: 'pages/index/index',
      title: '标题',
      imagePath: '/pages/thumb.png',
      webpageUrl: 'www.qq.com',
      withShareTicket: true,
      miniprogramType: 0,
      scene: 0, 
      promise 
    }
  }
})