# wx.updateShareMenu(Object object)

> 基础库 1.2.0 开始支持，低版本需做[兼容处理](1003706)。

> __以 [Promise 风格](/miniprogram/dev/framework/app-service/api.md#异步-API-返回-Promise) 调用__：支持
> 
> __需要页面权限__：当前是插件页面时，宿主小程序不能调用该接口，反之亦然
> 
> __小程序插件__：支持，需要小程序基础库版本不低于 [2.1.0](1003706)
> 
>   在小程序插件中使用时，只能在当前插件的页面中调用
> 
> __微信 Windows 版__：支持
> 
> __微信 Mac 版__：支持
> 
> __微信 鸿蒙 OS 版__：支持

> 相关文档: [转发](/miniprogram/dev/framework/open-ability/share.md)、[动态消息](/miniprogram/dev/framework/open-ability/share/updatable-message.md)、[小程序私密消息](/miniprogram/dev/framework/open-ability/share/private-message.md)

## 功能描述

更新转发属性

## 参数

### Object object


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

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

## 示例代码

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