分类： API

wx.showToast(Object object)

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

显示消息提示框

参数

Object object

属性 类型 默认值 必填 说明 最低版本
title string 是 提示的内容
icon string success 否 图标
合法值 说明 最低版本
success 显示成功图标，此时 title 文本最多显示 7 个汉字长度
error 显示失败图标，此时 title 文本最多显示 7 个汉字长度 2.14.1
loading 显示加载图标，此时 title 文本最多显示 7 个汉字长度
none 不显示图标，此时 title 文本最多可显示两行，1.9.0及以上版本支持
image string 否 自定义图标的本地路径，image 的优先级高于 icon 1.1.0
duration number 1500 否 提示的延迟时间
mask boolean false 否 是否显示透明蒙层，防止触摸穿透
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.showToast({
  title: '成功',
  icon: 'success',
  duration: 2000
})

注意

  • wx.showLoading 和 wx.showToast 同时只能显示一个
  • wx.showToast 应与 wx.hideToast 配对使用

wx.authPrivateMessage(Object object)

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

以 Promise 风格 调用：不支持

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 微信小程序私密消息

功能描述

验证私密消息。用法详情见 微信小程序私密消息使用指南

参数

Object object

属性 类型 默认值 必填 说明
shareTicket string 是 shareTicket。可以从 wx.getEnterOptionsSync 中获取。详情 shareTicket
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
errMsg string 错误信息
valid boolean 验证是否通过
encryptedData string 经过加密的activityId，解密后可得到原始的activityId。若解密后得到的activityId可以与开发者后台的活动id对应上则验证通过，否则表明valid字段不可靠（被篡改） 详细见加密数据解密算法
iv string 加密算法的初始向量，详细见加密数据解密算法

示例代码

wx.authPrivateMessage({
  shareTicket: 'xxxxxx',
  success(res) {
    console.log('authPrivateMessage success', res)
    // res
    // {
    //   errMsg: 'authPrivateMessage:ok'
    //   valid: true
    //   iv: 'xxxx',
    //   encryptedData: 'xxxxxx'
    // }
  },
  fail(res) {
    console.log('authPrivateMessage fail', res)
  }
})

wx.getShareInfo(Object object)

从基础库 2.17.3 开始，本接口停止维护，请使用 wx.getGroupEnterInfo 代替

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

以 Promise 风格 调用：不支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0

在微信小程序插件中使用时，只能在当前插件的页面中调用

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

获取转发详细信息（主要是获取群ID）。 从群聊内的微信小程序消息卡片打开微信小程序时，调用此接口才有效。从基础库 v2.17.3 开始，推荐用 wx.getGroupEnterInfo 替代此接口。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
shareTicket string 是 shareTicket，详见获取更多转发信息
timeout number 否 超时时间，单位 ms 1.9.90
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明 最低版本
errMsg string 错误信息
encryptedData string 包括敏感数据在内的完整转发信息的加密数据，详细见加密数据解密算法
iv string 加密算法的初始向量，详细见加密数据解密算法
cloudID string 敏感数据对应的云 ID，开通云开发的微信小程序才会返回，可通过云调用直接获取开放数据，详细见云调用直接获取开放数据 2.7.0

示例代码

敏感数据获取方式 加密数据解密算法 。 获取得到的开放数据为以下 json 结构（其中 openGId 为当前群的唯一标识）：

{
 "openGId": "OPENGID"
}

Tips

  • 如需要展示群名称，微信小程序可以使用 开放数据组件
  • 小游戏可以通过 wx.getGroupInfo 接口获取群名称

wx.hideShareMenu(Object object)

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

以 Promise 风格 调用：支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0

在微信小程序插件中使用时，只能在当前插件的页面中调用

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

隐藏当前页面的转发按钮

参数

Object object

属性 类型 默认值 必填 说明 最低版本
menus Array.<string> 否 本接口为 Beta 版本，暂只在 Android 平台支持。需要隐藏的转发按钮名称列表，默认[‘shareAppMessage’, ‘shareTimeline’]。按钮名称合法值包含 “shareAppMessage”、”shareTimeline” 两种 2.11.3
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

注意事项

  • “shareAppMessage”表示“发送给朋友”按钮，”shareTimeline”表示“分享到朋友圈”按钮
  • 隐藏“发送给朋友”按钮时必须同时隐藏“分享到朋友圈”按钮，隐藏“分享到朋友圈”按钮时则允许不隐藏“发送给朋友”按钮

示例代码

wx.hideShareMenu({
  menus: ['shareAppMessage', 'shareTimeline']
})

wx.offCopyUrl()

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

微信小程序插件：不支持

功能描述

移除用户点击右上角菜单的「复制链接」按钮时触发的事件的全部监听函数

示例代码


  // 绑定分享参数
  wx.onCopyUrl(() => {
    return { query: 'a=1&b=2' }
  })

  // 取消绑定分享参数
  wx.offCopyUrl()

wx.onCopyUrl(function listener)

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

微信小程序插件：不支持

功能描述

监听用户点击右上角菜单的「复制链接」按钮时触发的事件。

参数

function listener

用户点击右上角菜单的「复制链接」按钮时触发的事件的监听函数

参数

Object res
属性 类型 说明 最低版本
query string 用短链打开微信小程序时当前页面携带的查询字符串，默认为空字符串。微信小程序中使用时，应在进入页面时调用 wx.onCopyUrl 自定义 query，退出页面时调用 wx.offCopyUrl，防止影响其它页面。
title string 短链中的自定义标题，显示在微信小程序名称之后。在基础库3.15.1之前，默认是 navigationBarTitleText 的值，在基础库3.15.1及之后，默认为空字符串。 3.15.1
promise Object 如果该参数存在且为有效的 Promise，则最终的 query 和 title 将以该 Promise 的 resolve 结果为准；如果 Promise 在 2 秒内未 resolve 或 reject，则回退使用同步传入的默认参数。 3.16.0

示例代码


  // 基础用法：同步返回分享参数
  wx.onCopyUrl(() => {
    return { query: 'a=1&b=2' }
  })

  // 使用 promise 异步返回分享参数
  wx.onCopyUrl(() => {
    return {
      query: 'a=1',  // 兜底默认参数，promise 超时时使用
      title: '默认标题',
      promise: fetchSomeInfo().then((info) => ({ query: info.query, title: info.title }))
    }
  })

  // 取消绑定分享参数
  wx.offCopyUrl()

wx.shareFileMessage(Object object)

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

以 Promise 风格 调用：支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

功能描述

转发文件到聊天

参数

Object object

属性 类型 默认值 必填 说明
filePath string 是 要分享的文件地址，必须为本地路径或临时路径
fileName string 否 自定义文件名，若留空则使用filePath中的文件名
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码


  // callback 写法
  wx.downloadFile({
    url: URL, // 下载url
    success (res) {
      // 下载完成后转发
      wx.shareFileMessage({
        filePath: res.tempFilePath,
        success() {},
        fail: console.error,
      })
    },
    fail: console.error,
  })

  // async await 写法
  const { tempFilePath } = await wx.downloadFile({
    url: URL, // 下载url
  })
  // 下载完成后转发
  await wx.shareFileMessage({
    filePath: tempFilePath,
  })

wx.shareToOfficialAccount(Object object)

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

以 Promise 风格 调用：不支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：不支持

功能描述

支持拉起贴图发表页，用户可将图片与文字内容发表为贴图。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
title string 是 贴图的标题
content string 否 贴图的正文
tags Array.<string> 否 贴图的标签，上限10个
images Array.<string> 否 贴图的图片，必须为本地路径或临时路径
recommendPath string 否 贴图链接卡片跳转页面 3.16.1
recommendTitle string 否 贴图链接卡片标题 3.16.1
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
status string 贴图发表状态
postUrl string 贴图发表后的文章链接，仅在success回调中返回，并且只有在发表成功后链接才可访问

示例代码


wx.shareToOfficialAccount({
  title: '标题',
  content: '正文',
  tags: ['标签1', '标签2'],
  success: (res) => {
    // 贴图发表成功时触发
    console.log(res)
  },
  fail: (err) => {
    // 用户主动退出贴图发表页时触发
    console.log(err)
  },
  complete: (res) => {
    // 统计接口总共调用次数
    console.log(res)
  },
})

推荐图标

推荐使用贴图品牌图标作为该功能按钮，可使用下列高清素材：

推荐图标1

推荐图标2

wx.shareVideoMessage(Object object)

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

以 Promise 风格 调用：支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

功能描述

转发视频到聊天

参数

Object object

属性 类型 默认值 必填 说明
videoPath string 是 要分享的视频地址，必须为本地路径或临时路径
thumbPath string 否 缩略图路径，若留空则使用视频首帧
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码


  // callback 写法
  wx.downloadFile({
    url: URL, // 下载url
    success (res) {
      // 下载完成后转发
      wx.shareVideoMessage({
        videoPath: res.tempFilePath,
        success() {},
        fail: console.error,
      })
    },
    fail: console.error,
  })

  // async await 写法
  const { tempFilePath } = await wx.downloadFile({
    url: URL, // 下载url
  })
  // 下载完成后转发
  await wx.shareVideoMessage({
    videoPath: res.tempFilePath,
  })

wx.showShareImageMenu(Object object)

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

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.16.0

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

打开分享图片弹窗，可以将图片发送给朋友、分享至朋友圈、收藏或下载

参数

Object object

属性 类型 默认值 必填 说明 最低版本
path string 是 要分享的图片地址，必须为本地路径或临时路径
needShowEntrance boolean true 否 分享的图片消息是否要带微信小程序入口 3.2.0
entrancePath string ” 否 发送给朋友时，微信小程序入口打开微信小程序的路径，如果当前页面允许分享给朋友，则默认为当前页面路径，否则默认为微信小程序首页 3.2.0
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码


wx.downloadFile({
  url: 'https://res.wx.qq.com/wxdoc/dist/assets/img/demo.ef5c5bef.jpg',
  success: (res) => {
    wx.showShareImageMenu({
      path: res.tempFilePath
    })
  }
})

Tips

  1. 从基础库 3.8.2 开始，style 参数废弃
  2. 从基础库 3.8.2 开始，needShowEntrance 参数默认值从 false 改为 true
  3. 从基础库 3.8.2 开始，支持分享至朋友圈，分享至朋友圈的图片不支持带有二维码（可支持微信小程序码）