updateWidget
更新指定 Widget 卡片实例的渲染数据。
用于卡片内操作后刷新卡片展示、把服务端最新结果写回卡片,或由 Page 根据传入的
widgetInstanceId 更新原卡片;需要替换卡片类型时可同时传入新的 widgetId。
widgetData 与 toolResult 二选一。传入 toolResult 时不能切换 widgetId,
结构化结果必须符合当前应用的 Entity 协议。切换 widgetId 时不能关闭重新创建。
扫码预览
支持版本
前端库版本不低于 0.0.26。
支持平台
支持场景
接入准备
前置条件
- Android:在卡片或消息环境中调用,需传入有效的 widgetInstanceId
- iOS:在卡片或消息环境中调用,需传入有效的 widgetInstanceId
使用说明
- widgetData 和 toolResult 互斥;应用插件支持 toolResult 和 reloadWidget,旧版 Applet Widget 仅支持 widgetData。toolResult 更新模型上下文并须符合 Entity 协议,不能同时切换 widgetId。reloadWidget 默认为 true;切换 widgetId 时不能设为 false。
调用方式
异步 API
入参
调用示例
成功返回
无返回字段。
错误处理
错误对象和通用错误码见 通用错误处理。
失败示例
错误码
通用错误码
平台差异
- 参数为空返回 104;消息或 Widget 未找到返回 116;当前豆包环境未提供消息更新能力时返回 103;其他失败统一返回 102。