For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/open/business/updateWidget.md.

updateWidget

更新指定 Widget 卡片实例的渲染数据。

用于卡片内操作后刷新卡片展示、把服务端最新结果写回卡片,或由 Page 根据传入的 widgetInstanceId 更新原卡片;需要替换卡片类型时可同时传入新的 widgetId。

widgetData 与 toolResult 二选一。传入 toolResult 时不能切换 widgetId, 结构化结果必须符合当前应用的 Entity 协议。切换 widgetId 时不能关闭重新创建。

扫码预览

扫码预览 updateWidget

支持版本

前端库版本不低于 0.0.26。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

接入准备

前置条件

  • Android:在卡片或消息环境中调用,需传入有效的 widgetInstanceId
  • iOS:在卡片或消息环境中调用,需传入有效的 widgetInstanceId

使用说明

  • widgetData 和 toolResult 互斥;应用插件支持 toolResult 和 reloadWidget,旧版 Applet Widget 仅支持 widgetData。toolResult 更新模型上下文并须符合 Entity 协议,不能同时切换 widgetId。reloadWidget 默认为 true;切换 widgetId 时不能设为 false。

调用方式

异步 API

updateWidget(params: UpdateWidgetParams): Promise<object>

入参

名称类型必填默认值约束说明
reloadWidgetboolean否true-是否重新创建 Widget 组件;设为 `false` 时仅更新同一 Widget 的数据。
仅应用插件支持;旧版 Applet Widget 使用 IM 更新,不支持此参数。
widgetInstanceIdstring是--需要更新的 Widget 实例 ID。

卡片内可通过 `getWidgetInstanceId()` 获取;页面中需要由路由参数或业务数据传入。
widgetDatastring否--新的卡片渲染数据,通常传入 `JSON.stringify(viewData)`;不会更新模型上下文。
widgetIdstring否--可选的新 widgetId。传入后会把当前实例切换成另一个已注册的 Widget。
toolResultToolResult否--符合 Entity 协议的 ToolResult;仅应用插件支持,更新卡片并同步模型上下文。
toolResult.contentRecord<string, unknown>[]否--Tool 返回的内容块。
toolResult.isErrorboolean否false-Tool 执行是否返回错误结果。
toolResult.structuredContentunknown否--Tool 返回的结构化内容。

调用示例

import { updateWidget } from '@doubao-dev/framework/api';
import { getWidgetInstanceId } from '@doubao-dev/framework';

await updateWidget({
  widgetInstanceId: getWidgetInstanceId(),
  widgetData: JSON.stringify({ title: '更新后的标题', status: 'done' })
});

成功返回

无返回字段。

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

{
  "errNo": 104,
  "errMsg": "invalid parameter"
}

错误码

errNoerrMsg平台触发条件处理建议
103feature not supportAndroid、iOS当前豆包环境未提供消息更新能力,或旧版 Applet Widget 传入 reloadWidget/toolResult在支持的环境调用;旧版 Applet Widget 只传 widgetData。
104invalid parameterAndroid、iOSwidgetInstanceId 为空、widgetData 与 toolResult 未二选一、reloadWidget 类型错误,或切换 widgetId 时关闭重建修正参数后重试。
116resource not foundAndroid、iOS依据 widgetInstanceId 找不到对应消息,或依据 widgetId 找不到已注册的 Widget确认 widgetInstanceId 与 widgetId 有效后重试。

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android、iOS

平台差异

  • 参数为空返回 104;消息或 Widget 未找到返回 116;当前豆包环境未提供消息更新能力时返回 103;其他失败统一返回 102。