wx.miniapp.shareImageMessage
WARNING
请注意,当前域名 https://dev.weixin.qq.com/docs/framework
文档已不维护,请前往微信文档中心 找到对应的新文档继续使用
分享图片到微信
注:
1、该接口需要申请和初始化微信 open 能力,需要客户端进行相关配置
2、该接口不支持在「移动应用助手」中调试,开发者需构建 apk 或者 ipa 安装到手机后才能调试
接入前注意事项
- 该能力依赖微信 Open SDK ,需按照指引在微信开放平台创建移动应用账号,以完成相关初始化配置,详情可查看微信移动应用能力初始化指引
参数
方便开发者理解,wx.miniapp.shareImageMessage 参数与微信开放平台 opensdk 分享接口参数一致
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
imagePath | string | - | 是 | 分享图片,支持代码包图片资源路径或者本地临时、缓存、用户文件;不支持网络图片路径 |
thumbPath | string | - | 是 | 分享缩略图,支持代码包图片资源路径或者本地临时、缓存、用户文件;不支持网络图片路径 |
scene | number | - | 是 | 发送的目标场景,0=分享到会话,1=分享到朋友圈,2=分享到收藏 |
entranceMiniProgramUsername | string | - | 否 | 启动小程序username(小程序的原始id,gh_xxx);iOS SDK >=1.3.36;Android SDK >=1.3.26 |
entranceMiniProgramPath | string | - | 否 | 启动小程路径;iOS SDK >=1.3.36;Android SDK >=1.3.26 |
备注:
- entranceMiniProgramUsername:表示分享的图片消息是否要带小程序入口,非空则显示;
- entranceMiniProgramPath:分享的图片消息显示的小程序入口可以跳转的小程序路径;
调用示例
wx.miniapp.shareImageMessage({
imagePath: '/pages/share.png',
thumbPath: '/pages/thumb.png',
scene: 0,
success(res) {
wx.showToast({
title: '成功:分享图片',
})
},
fail() {
wx.showToast({
title: '失败:分享图片',
})
}
})