@doubao-apps/create 0.0.27 → 0.0.28

package/dist/template-starter/.ai/reference/open-api/08-/345/274/200/346/224/276/350/203/275/345/212/233-/344/270/232/345/212/241/350/203/275/345/212/233.md

@@ -1,546 +0,0 @@
-# Open API: 开放能力 / 业务能力
-
-开放业务能力、支付、隐私设置、上下文和外部应用打开。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [getOrderPayment](#getorderpayment) | 查询订单支付结果。 |
-| [postLoginResult](#postloginresult) | 回传 MCP 授权登录凭证。 |
-| [getPrivacySetting](#getprivacysetting) | 获取隐私设置状态。 |
-| [requestOrder](#requestorder) | 发起订单支付流程。 |
-| [loginWithDoubaoWidget](#loginwithdoubaowidget) | 发起豆包 Widget 登录。 |
-| [sendQueryMessage](#sendquerymessage) | 以用户身份发送一条消息。<br><br>返回 void，不是 Promise。 |
-| [updateModelContext](#updatemodelcontext) | 向 Agent 捐赠上下文。 |
-| [setAdditionalContext](#setadditionalcontext) | 设置全局上下文供大模型理解。<br><br>设置全局上下文。 |
-| [dispatchActionDirective](#dispatchactiondirective) | 描述用户行为，约束模型行为及指定执行路径。 |
-| [updateWidget](#updatewidget) | 更新指定卡片。 |
-| [expiredWidget](#expiredwidget) | 更新过期的 widget 为固定卡片。 |
-| [openApp](#openapp) | 通过 deep link 等方式打开外部应用。 |
-
-## API 详情
-
-<a id="getorderpayment"></a>
-### getOrderPayment()
-
-> **getOrderPayment**(`params`): `Promise`\<[`GetOrderPaymentResult`](#getorderpaymentresult)\>
-
-查询订单支付结果。
-
-#### Parameters
-
-• **params**: [`GetOrderPaymentParams`](#getorderpaymentparams)
-
-订单支付查询参数。
-
-#### Returns
-
-`Promise`\<[`GetOrderPaymentResult`](#getorderpaymentresult)\>
-
-返回订单支付结果。
-
-<a id="postloginresult"></a>
-### postLoginResult()
-
-> **postLoginResult**(`params`): `Promise`\<`object`\>
-
-回传 MCP 授权登录凭证。
-
-#### Parameters
-
-• **params**: [`PostLoginResultRequest`](#postloginresultrequest)
-
-登录结果回传参数。
-
-#### Returns
-
-`Promise`\<`object`\>
-
-返回回传完成的 Promise。
-
-<a id="getprivacysetting"></a>
-### getPrivacySetting()
-
-> **getPrivacySetting**(`params`?): `Promise`\<[`PrivacySettingResult`](#privacysettingresult)\>
-
-获取隐私设置状态。
-
-#### Parameters
-
-• **params?**
-
-#### Returns
-
-`Promise`\<[`PrivacySettingResult`](#privacysettingresult)\>
-
-返回隐私设置状态。
-
-<a id="requestorder"></a>
-### requestOrder()
-
-> **requestOrder**(`params`): `Promise`\<[`RequestOrderResult`](#requestorderresult)\>
-
-发起订单支付流程。
-
-#### Parameters
-
-• **params**: [`RequestOrderParams`](#requestorderparams)
-
-订单支付请求参数。
-
-#### Returns
-
-`Promise`\<[`RequestOrderResult`](#requestorderresult)\>
-
-返回订单支付请求结果。
-
-<a id="loginwithdoubaowidget"></a>
-### loginWithDoubaoWidget()
-
-> **loginWithDoubaoWidget**(`params`): `Promise`\<[`LoginWithWidgetResult`](#loginwithwidgetresult)\>
-
-发起豆包 Widget 登录。
-
-#### Parameters
-
-• **params**: [`LoginWithWidgetRequest`](#loginwithwidgetrequest)
-
-Widget 登录参数。
-
-#### Returns
-
-`Promise`\<[`LoginWithWidgetResult`](#loginwithwidgetresult)\>
-
-返回登录结果。
-
-<a id="sendquerymessage"></a>
-### sendQueryMessage()
-
-> **sendQueryMessage**(`params`): `void`
-
-以用户身份发送一条消息
-
-由于会自动获取页面上下文来确定向哪个 bot 发送消息，因此只能在卡片或页面中调用
-
-#### Parameters
-
-• **params**: [`SendQueryMessageParams`](#sendquerymessageparams)
-
-#### Returns
-
-`void`
-
-#### Example
-
-```ts
-await sendQueryMessage({ content: '订阅消息', type: 'text' })
-```
-
-<a id="updatemodelcontext"></a>
-### updateModelContext()
-
-> **updateModelContext**(`params`?): `Promise`\<`object`\>
-
-向 Agent 捐赠上下文
-
-#### Parameters
-
-• **params?**: [`UpdateModelContextParams`](#updatemodelcontextparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="setadditionalcontext"></a>
-### setAdditionalContext()
-
-> **setAdditionalContext**(`params`): `Promise`\<`object`\>
-
-设置全局上下文供大模型理解
-
-#### Parameters
-
-• **params**: [`SetAdditionalContextParams`](#setadditionalcontextparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-#### Remarks
-
-设置全局上下文。
-
-<a id="dispatchactiondirective"></a>
-### dispatchActionDirective()
-
-> **dispatchActionDirective**(`params`): `Promise`\<`object`\>
-
-描述用户行为，约束模型行为及指定执行路径
-
-#### Parameters
-
-• **params**: [`DispatchActionDirectiveParams`](#dispatchactiondirectiveparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="updatewidget"></a>
-### updateWidget()
-
-> **updateWidget**(`params`): `Promise`\<`object`\>
-
-更新指定卡片
-
-#### Parameters
-
-• **params**: [`UpdateWidgetParams`](#updatewidgetparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="expiredwidget"></a>
-### expiredWidget()
-
-> **expiredWidget**(`__namedParameters`): `Promise`\<`object`\>
-
-更新过期的 widget 为固定卡片
-
-#### Parameters
-
-• **\_\_namedParameters**: [`ExpiredWidgetParams`](#expiredwidgetparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-#### Description
-
-用于将状态已经过期的 widget 实例转换为固定的卡片
-
-#### Example
-
-```ts
-expiredWidget({
-  widgetInstanceId: 'instance_123',
-  schema: '${pageId}?key=value'
-});
-```
-
-<a id="openapp"></a>
-### openApp()
-
-> **openApp**(`params`): `Promise`\<[`OpenAppResult`](#openappresult)\>
-
-通过 deep link 等方式打开外部应用。
-
-#### Parameters
-
-• **params**: [`OpenAppRequest`](#openapprequest)
-
-外部应用打开参数。
-
-#### Returns
-
-`Promise`\<[`OpenAppResult`](#openappresult)\>
-
-返回外部应用打开结果。
-
-## 相关类型
-
-<a id="getorderpaymentparams"></a>
-### GetOrderPaymentParams
-
-#### Properties
-
-##### orderId
-
-> **orderId**: `string`
-
-<a id="getorderpaymentresult"></a>
-### GetOrderPaymentResult
-
-#### Properties
-
-##### logId
-
-> **logId**: `string`
-
-##### orderId
-
-> **orderId**: `string`
-
-<a id="postloginresultrequest"></a>
-### PostLoginResultRequest
-
-#### Properties
-
-##### code?
-
-> `optional` **code**: `string`
-
-Authorization login credential, valid when login result is true
-
-##### result
-
-> **result**: `boolean`
-
-Login result, true means success, false means failure
-
-<a id="privacysettingresult"></a>
-### PrivacySettingResult
-
-#### Properties
-
-##### needAuthorization
-
-> **needAuthorization**: `boolean`
-
-Whether user authorization for privacy agreement is required
-
-<a id="requestorderparams"></a>
-### RequestOrderParams
-
-#### Properties
-
-##### data
-
-> **data**: `string`
-
-##### dbAuthorization
-
-> **dbAuthorization**: `string`
-
-<a id="requestorderresult"></a>
-### RequestOrderResult
-
-#### Properties
-
-##### logId
-
-> **logId**: `string`
-
-##### orderId
-
-> **orderId**: `string`
-
-<a id="loginwithwidgetrequest"></a>
-### LoginWithWidgetRequest
-
-#### Properties
-
-##### loginType
-
-> **loginType**: [`LoginType`](#logintype-1)
-
-Login type identifier
-
-<a id="loginwithwidgetresult"></a>
-### LoginWithWidgetResult
-
-#### Properties
-
-##### result
-
-> **result**: `boolean`
-
-Whether the login is successful
-
-<a id="logintype-1"></a>
-<a id="logintype"></a>
-### LoginType
-
-> **LoginType**: `0` \| `1` \| `2` \| `3`
-
-Widget 登录类型。
-
-- `0`: 隐私协议登录
-- `1`: 仅登录
-- `2`: 先登录再隐私协议，两次弹窗
-- `3`: 登录和隐私协议合并，一次弹窗
-
-<a id="sendquerymessageparams"></a>
-### SendQueryMessageParams
-
-#### Properties
-
-##### content
-
-> **content**: `string`
-
-要发送的消息。根据类型不同，序列化方式可能不同
-
-##### type
-
-> **type**: `"text"`
-
-消息类型，目前仅支持 text
-
-<a id="updatemodelcontextparams"></a>
-### UpdateModelContextParams
-
-#### Properties
-
-##### content?
-
-> `optional` **content**: `string`
-
-上下文内容，格式无约束，可以与 MCP 服务下发的上下文格式保持一致
-
-##### entityId?
-
-> `optional` **entityId**: `string`
-
-上下文所属的 entityID，业务侧管理
-
-##### taskId?
-
-> `optional` **taskId**: `string`
-
-上下文所属任务 ID，业务侧定义
-
-<a id="setadditionalcontextparams"></a>
-### SetAdditionalContextParams
-
-#### Properties
-
-##### additionalContext
-
-> **additionalContext**: `string`
-
-上下文内容
-
-##### botId?
-
-> `optional` **botId**: `string`
-
-指定 bot id
-
-<a id="dispatchactiondirectiveparams"></a>
-### DispatchActionDirectiveParams
-
-#### Properties
-
-##### actionDescribe
-
-> **actionDescribe**: `string`
-
-自然语言描述，例如：用户点击支付按钮并完成话费支付
-
-##### actionType
-
-> **actionType**: [`ActionDirectiveType`](#actiondirectivetype)
-
-动作类型，参见 [ActionDirectiveType](#actiondirectivetype)
-
-##### widgetInstanceId
-
-> **widgetInstanceId**: `string`
-
-会话消息关联的卡片ID
-
-<a id="actiondirectivetype"></a>
-### ActionDirectiveType
-
-#### Enumeration Members
-
-##### BUTTON\_CLICK
-
-> **BUTTON\_CLICK**: `"button_click"`
-
-按钮点击
-
-##### FORM\_SUBMIT
-
-> **FORM\_SUBMIT**: `"form_submit"`
-
-表单提交（复杂的信息提交场景）
-
-##### OPTION\_SELECT
-
-> **OPTION\_SELECT**: `"option_select"`
-
-选择（下拉列表场景）
-
-<a id="updatewidgetparams"></a>
-### UpdateWidgetParams
-
-#### Properties
-
-##### widgetData
-
-> **widgetData**: `string`
-
-卡片渲染的数据
-
-##### widgetId?
-
-> `optional` **widgetId**: `string`
-
-卡片更新的为新的widgetId
-
-##### widgetInstanceId
-
-> **widgetInstanceId**: `string`
-
-需要更新的widget 实例 ID
-
-<a id="expiredwidgetparams"></a>
-### ExpiredWidgetParams
-
-#### Properties
-
-##### schema?
-
-> `optional` **schema**: `string`
-
-点击失效卡要跳转的页面 schema，格式与 navigateTo 的 url 相同
-
-##### widgetInstanceId
-
-> **widgetInstanceId**: `string`
-
-卡片实例 ID，在卡片环境通过getWidgetInstanceId来获取，其他环境（比如页面）需要通过传参或通信的方式传递过去
-
-<a id="openapprequest"></a>
-### OpenAppRequest
-
-#### Properties
-
-##### fallbackUrl?
-
-> `optional` **fallbackUrl**: `string`
-
-Optional fallback URL when deep link fails
-
-##### targetPackage?
-
-> `optional` **targetPackage**: `string`
-
-Optional target package name for Android
-
-##### uri
-
-> **uri**: `string`
-
-Target URI to open, e.g. scheme://path?query
-
-<a id="openappresult"></a>
-### OpenAppResult
-
-#### Properties
-
-##### status
-
-> **status**: [`OpenAppStatus`](#openappstatus)
-
-Execution status from client
-
-<a id="openappstatus"></a>
-### OpenAppStatus
-
-> **OpenAppStatus**: `"deep_link"` \| `"market"` \| `"browser"`

package/dist/template-starter/.ai/reference/open-api/README.md

@@ -1,36 +0,0 @@
-# Open API 目录
-
-> 这里是系统能力 Open API 的分组目录。先用 [速查索引](../open-api.md) 找 API，再进入对应分组查看完整参数、返回值、示例和相关类型。
-
-## 分组
-
-| 分组 | 说明 | API 数量 | 详细文档 |
-| --- | --- | ---: | --- |
-| 基础 / 账号 / 系统 | 账号、授权、宿主基础信息、窗口信息和定位。 | 11 | [查看](./01-基础-账号-系统.md) |
-| 存储 | 本地缓存；带 Sync 后缀的是同步 API。 | 10 | [查看](./02-存储.md) |
-| 路由 | 应用内页面跳转和关闭。 | 6 | [查看](./03-路由.md) |
-| 界面 / 交互 | Toast、Loading、Modal、ActionSheet 和返回前提醒。 | 9 | [查看](./04-界面-交互.md) |
-| 界面 / 输入 | 键盘和输入框选区能力。 | 1 | [查看](./05-界面-输入.md) |
-| 网络 | 网络请求 | 1 | [查看](./06-网络.md) |
-| 媒体 | 图片选择、预览、保存、压缩和信息读取。 | 5 | [查看](./07-媒体.md) |
-| 开放能力 / 业务能力 | 开放业务能力、支付、隐私设置、上下文和外部应用打开。 | 12 | [查看](./08-开放能力-业务能力.md) |
-| 设备 / 蓝牙 | 蓝牙和 BLE 能力；通常先打开适配器，再扫描、连接和读写。 | 19 | [查看](./09-设备-蓝牙.md) |
-| 设备 / Wi-Fi | Wi-Fi 模块能力；通常先 startWifi，再获取列表或连接。 | 6 | [查看](./10-设备-wi-fi.md) |
-| 设备 / 加速度计 | 加速度计监听能力。 | 3 | [查看](./11-设备-加速度计.md) |
-| 设备 / iBeacon | iBeacon 搜索和结果读取能力。 | 3 | [查看](./12-设备-ibeacon.md) |
-| 设备 / 罗盘 | 罗盘监听能力。 | 3 | [查看](./13-设备-罗盘.md) |
-| 设备 / 设备方向 | 设备方向监听能力。 | 2 | [查看](./14-设备-设备方向.md) |
-| 设备 / 陀螺仪 | 陀螺仪监听能力。 | 3 | [查看](./15-设备-陀螺仪.md) |
-| UI / 输入 | 键盘和输入框选区能力。 | 2 | [查看](./16-ui-输入.md) |
-| 设备 / 网络 | 网络类型和本机局域网 IP。 | 3 | [查看](./17-设备-网络.md) |
-| 设备 / 短信 | 拉起系统短信发送面板。 | 1 | [查看](./18-设备-短信.md) |
-| 设备 / 无障碍 | 检测无障碍能力开关状态。 | 1 | [查看](./19-设备-无障碍.md) |
-| 设备 / 电池 | 电池信息读取与变化监听。 | 2 | [查看](./20-设备-电池.md) |
-| 设备 / 日历 | 向系统日历添加事件和重复事件。 | 2 | [查看](./21-设备-日历.md) |
-| 设备 / 剪贴板 | 读取和设置系统剪贴板内容。 | 2 | [查看](./22-设备-剪贴板.md) |
-| 设备 / 联系人 | 选择和添加手机联系人。 | 2 | [查看](./23-设备-联系人.md) |
-| 设备 / 加密 | 安全随机数能力。 | 1 | [查看](./24-设备-加密.md) |
-| 设备 / 电话 | 拨打电话。 | 1 | [查看](./25-设备-电话.md) |
-| 设备 / 扫码 | 调起扫码并读取扫码结果。 | 1 | [查看](./26-设备-扫码.md) |
-| 设备 / 屏幕 | 屏幕亮度、常亮和截屏/录屏相关能力。 | 5 | [查看](./27-设备-屏幕.md) |
-| 设备 / 震动 | 触发短震动和长震动。 | 2 | [查看](./28-设备-震动.md) |