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/expiredWidget.md.

expiredWidget

更新过期的 Widget 为固定卡片。

扫码预览

扫码预览 expiredWidget

支持版本

前端库版本不低于 0.0.27。

支持平台

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

支持场景

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

接入准备

前置条件

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

使用说明

用于将状态已经过期的 Widget 实例转换为固定卡片,用户点击后可跳转到指定页面。

getWidgetInstanceId 仅在卡片环境中有效,在应用插件页面中会返回 undefined。如果需要在页面中调用, 请在 navigateTo 时通过参数传递卡片实例 ID。

  • 请在卡片状态过期后调用,将卡片转换为可点击跳转的固定卡片;建议使用 url 字段而非已废弃的 schema 字段。

调用方式

异步 API

expiredWidget(params: ExpiredWidgetParams): Promise<object>

入参

名称类型必填默认值约束说明
detailTextstring否--点击失效卡要跳转的页面 detailText。
schemastring否-已废弃:使用 url 字段替代 schema 字段,后续版本将移除 schema 字段,请尽快迁移到 url 字段。点击失效卡要跳转的页面 schema,格式与 navigateTo 的 url 参数一致。
titlestring否--点击失效卡要跳转的页面 title。
urlstring否--点击失效卡要跳转的页面 URL 或 sslocal schema。应用插件页面 URL 格式与 navigateTo 的 url 参数一致。
widgetInstanceIdstring是--卡片实例 ID。

在卡片环境可通过 `getWidgetInstanceId` 获取;在应用插件页面等非卡片环境需要通过传参或通信传递。

调用示例

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

expiredWidget({
  widgetInstanceId: getWidgetInstanceId(),
  url: '/pages/detail/index?key=value'
});

成功返回

无返回字段。