# wx.updateShareMenu(Object object)

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

以 Promise 风格 调用:支持

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

小程序插件:支持,需要小程序基础库版本不低于 2.1.0

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

微信 Windows 版:支持

微信 Mac 版:支持

微信 鸿蒙 OS 版:支持

相关文档: 转发、动态消息、小程序私密消息

# 功能描述

更新转发属性

# 参数

# Object object

属性 类型 默认值 必填 说明 最低版本
withShareTicket boolean false 否 是否使用带 shareTicket 的转发详情
isUpdatableMessage boolean false 否 是否是动态消息,详见动态消息 2.4.0
activityId string 否 动态消息的 activityId。通过 updatableMessage.createActivityId 接口获取 2.4.0
toDoActivityId string 否 群待办消息的id,通过toDoActivityId可以把多个群待办消息聚合为同一个。通过 updatableMessage.createActivityId 接口获取。详见群待办消息 2.11.0
templateInfo Object 否 动态消息的模板信息 2.4.0
结构属性 类型 默认值 必填 说明
parameterList Array.<Object> 是 参数列表
结构属性 类型 默认值 必填 说明
name string 是 参数名
value string 是 参数值
templateId string 是 模板ID
isPrivateMessage boolean 否 是否是私密消息。详见 小程序私密消息 2.13.0
participant Array.<string> [] 否 参与用户此聊天室下的 group_openid 列表
useForChatTool boolean false 否 聊天工具模式特殊动态消息 3.7.8
chooseType number 1 否 指定成员的方式 3.7.8
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)

# 注意事项

  • bug:在iOS上,如果 withShareTicket 传了 true ,同时 isUpdatableMessage 传了 false,会导致 withShareTicket 失效。解决办法:当 withShareTicket 传了 true 的时候,isUpdatableMessage 传 true 或者不传都可以,但不要传 false。如果需要关掉动态消息设置,则另外单独调用一次 wx.updateShareMenu({ isUpdatableMessage: false }) 即可。

# 示例代码

wx.updateShareMenu({
  withShareTicket: true,
  success () { }
})
// 转发私密消息
wx.updateShareMenu({
  isPrivateMessage: true,
  activityId: 'xxx',
  templateInfo: {},
  success () { },
  fail () {}
})