@doubao-apps/create 0.0.27 → 0.0.28

package/dist/template-empty/references/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md

@@ -0,0 +1,2943 @@
+# Open API: 基础 / 账号 / 系统
+
+账号、授权、宿主基础信息、窗口信息和定位。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getAccountInfo](#getaccountinfo) | 异步获取账号信息。 |
+| [getAccountInfoSync](#getaccountinfosync) | 同步获取账号信息。<br><br>同步 API。 |
+| [authorize](#authorize) | 初始化授权。<br><br>按 scope 申请授权。 |
+| [canIUse](#caniuse) | 检测当前宿主是否支持指定 API 或能力。<br><br>用于兼容性判断。 |
+| [getLocation](#getlocation) | 获取设备当前的地理位置信息。<br><br>可能涉及定位授权。 |
+| [showModal](#showmodal) | 显示模态对话框。 |
+| [showLoading](#showloading) | 显示 loading 提示框。<br><br>需调用 hideLoading 关闭。 |
+| [hideToast](#hidetoast) | 隐藏当前 Toast。 |
+| [hideLoading](#hideloading) | 隐藏当前 loading。 |
+| [showActionSheet](#showactionsheet) | 显示操作菜单。 |
+| [getMenuButtonBoundingClientRect](#getmenubuttonboundingclientrect) | 获取菜单按钮的布局位置信息。 |
+| [enableAlertBeforeUnload](#enablealertbeforeunload) | 开启页面返回前提醒。<br><br>配合 disableAlertBeforeUnload 使用。 |
+| [disableAlertBeforeUnload](#disablealertbeforeunload) | 关闭页面返回前提醒。 |
+| [showToast](#showtoast) | 显示 Toast 提示。<br><br>duration 和 icon 可控制提示表现。 |
+| [dispatchActionDirective](#dispatchactiondirective) | 描述用户行为，约束模型行为并指定后续执行路径。<br><br>适用于卡片交互后向模型补充结构化动作上下文，例如按钮点击、选项选择或表单提交。 |
+| [expiredWidget](#expiredwidget) | 更新过期的 widget 为固定卡片。 |
+| [loginWithDoubaoWidget](#loginwithdoubaowidget) | 发起豆包 Widget 登录。 |
+| [login](#login) | 发起登录并获取登录凭证。 |
+| [postLoginResult](#postloginresult) | 回传 MCP 授权登录凭证。 |
+| [createSignOrder](#createsignorder) | 创建签约订单。 |
+| [getOrderPaymentWithSign](#getorderpaymentwithsign) | 使用签名信息拉起收银台完成订单支付。 |
+| [getOrderPayment](#getorderpayment) | 拉起收银台完成订单支付。 |
+| [requestCombineOrder](#requestcombineorder) | 请求创建合单订单。 |
+| [requestOrder](#requestorder) | 发起订单支付流程。 |
+| [sign](#sign) | 拉起签约流程。 |
+| [getPrivacySetting](#getprivacysetting) | 获取隐私设置状态。 |
+| [sendQueryMessage](#sendquerymessage) | 以用户身份发送一条消息。<br><br>返回 void，不是 Promise。 |
+| [setAdditionalContext](#setadditionalcontext) | 设置全局上下文供大模型理解。<br><br>设置全局上下文。 |
+| [updateModelContext](#updatemodelcontext) | 向 Agent 捐赠上下文。 |
+| [updateWidget](#updatewidget) | 更新指定卡片。 |
+| [saveImageToPhotosAlbum](#saveimagetophotosalbum) | 保存图片到系统相册。 |
+| [previewImage](#previewimage) | 预览图片。 |
+| [getImageInfo](#getimageinfo) | 获取图片信息。 |
+| [chooseImage](#chooseimage) | 选择图片。 |
+| [compressImage](#compressimage) | 压缩图片。 |
+| [request](#request) | 发起网络请求。<br><br>返回 statusCode、header 和 data。 |
+| [openApp](#openapp) | 通过 deep link 等方式打开外部应用。 |
+| [navigateTo](#navigateto) | 保留当前页面，跳转到应用内的某个页面。 |
+| [redirectTo](#redirectto) | 关闭当前页面，跳转到应用内的某个页面。 |
+| [reLaunch](#relaunch) | 关闭所有页面并跳转到应用内页面。 |
+| [navigateBack](#navigateback) | 关闭当前页面，返回上一页面或多级页面。 |
+| [exitApp](#exitapp) | 退出当前所有页面。<br><br>会退出当前所有页面。 |
+| [setStorage](#setstorage) | 将数据写入本地缓存。 |
+| [setStorageSync](#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API。 |
+| [getStorage](#getstorage) | 从本地缓存读取数据。 |
+| [getStorageSync](#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API。 |
+| [removeStorage](#removestorage) | 删除本地缓存中指定 key 的数据。 |
+| [removeStorageSync](#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API。 |
+| [clearStorage](#clearstorage) | 清空本地缓存。 |
+| [clearStorageSync](#clearstoragesync) | 清空本地缓存。<br><br>同步 API。 |
+| [getStorageInfo](#getstorageinfo) | 获取本地缓存信息。 |
+| [getStorageInfoSync](#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API。 |
+| [getWindowInfoSync](#getwindowinfosync) | 获取窗口信息。<br><br>同步 API。 |
+| [getSystemSetting](#getsystemsetting) | 获取设备设置。 |
+| [getAppBaseInfoSync](#getappbaseinfosync) | 获取应用基础信息。<br><br>同步 API。 |
+| [getWindowInfo](#getwindowinfo) | 获取窗口信息。 |
+| [getAppBaseInfo](#getappbaseinfo) | 获取应用基础信息。 |
+
+## API 详情
+
+<a id="getaccountinfo"></a>
+### getAccountInfo()
+
+> **getAccountInfo**(`params`?): `Promise`\<[`GetAccountInfoResult`](#getaccountinforesult)\>
+
+异步获取账号信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetAccountInfoResult`](#getaccountinforesult)\>
+
+#### Example
+
+```typescript
+import { getAccountInfo } from '@doubao-apps/framework/api';
+
+const result = await getAccountInfo();
+console.log(result.miniProgram.appId);
+```
+
+<a id="getaccountinfosync"></a>
+### getAccountInfoSync()
+
+> **getAccountInfoSync**(`params`?): [`GetAccountInfoResult`](#getaccountinforesult)
+
+同步获取账号信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`GetAccountInfoResult`](#getaccountinforesult)
+
+#### Example
+
+```typescript
+import { getAccountInfoSync } from '@doubao-apps/framework/api';
+
+const result = getAccountInfoSync();
+console.log(result.miniProgram.appId, result.miniProgram.envVersion, result.miniProgram.version);
+```
+
+<a id="authorize"></a>
+### authorize()
+
+> **authorize**(`params`): `Promise`\<`object`\>
+
+初始化授权
+
+#### Parameters
+
+• **params**: [`AuthorizeRequest`](#authorizerequest)
+
+授权参数
+
+#### Returns
+
+`Promise`\<`object`\>
+
+Promise 对象，授权成功时会返回授权结果
+
+#### Remarks
+
+按 scope 申请授权。
+
+<a id="caniuse"></a>
+### canIUse()
+
+> **canIUse**(`params`): `Promise`\<[`CanIUseResult`](#caniuseresult)\>
+
+检测当前宿主是否支持指定 API 或能力。
+
+#### Parameters
+
+• **params**: [`CanIUseParams`](#caniuseparams)
+
+#### Returns
+
+`Promise`\<[`CanIUseResult`](#caniuseresult)\>
+
+#### Remarks
+
+用于兼容性判断。
+
+<a id="getlocation"></a>
+### getLocation()
+
+> **getLocation**(`params`?): `Promise`\<[`GetLocationResponse`](#getlocationresponse)\>
+
+获取设备当前的地理位置信息。
+
+#### Parameters
+
+• **params?**: [`GetLocationParams`](#getlocationparams)
+
+#### Returns
+
+`Promise`\<[`GetLocationResponse`](#getlocationresponse)\>
+
+返回一个 Promise，成功时解析为包含地理位置信息的对象，包含：
+  - `latitude`: number - 纬度。
+  - `longitude`: number - 经度。
+  - `timestamp`: string - 时间戳。
+  - `speed`: number - 行进速度，单位：米/秒。
+  - `accuracy`: number - 定位精度，单位：米。
+  参考 [GetLocationResponse](#getlocationresponse)。
+
+#### Throws
+
+如果调用失败（例如，用户拒绝权限、定位服务关闭等），则抛出此错误。
+
+#### Remarks
+
+可能涉及定位授权。
+
+#### Example
+
+```typescript
+import { getLocation } from '@doubao-apps/framework';
+
+async function fetchLocation() {
+  try {
+    const locationData = await getLocation();
+    console.log('纬度:', locationData.latitude);
+    console.log('经度:', locationData.longitude);
+    console.log('时间戳:', locationData.timestamp);
+    console.log('行进速度:', locationData.speed);
+    console.log('定位精度:', locationData.accuracy);
+  } catch (error) {
+    console.error('获取位置失败:', error);
+    // 处理错误，例如提示用户开启定位权限
+  }
+}
+
+fetchLocation();
+```
+
+<a id="showmodal"></a>
+### showModal()
+
+> **showModal**(`params`): `Promise`\<[`ShowModalResult`](#showmodalresult)\>
+
+显示模态对话框。
+
+#### Parameters
+
+• **params**: [`ShowModalParams`](#showmodalparams)
+
+#### Returns
+
+`Promise`\<[`ShowModalResult`](#showmodalresult)\>
+
+#### Example
+
+```ts
+import { showModal } from '@doubao-apps/framework/api';
+
+const result = await showModal({
+  title: '提示',
+  content: '确认删除这条记录吗？',
+  confirmText: '删除',
+  cancelText: '取消'
+});
+
+if (result.action === 'confirm') {
+  console.log('用户确认删除');
+}
+```
+
+<a id="showloading"></a>
+### showLoading()
+
+> **showLoading**(`params`?): `Promise`\<`object`\>
+
+显示 loading 提示框。
+
+#### Parameters
+
+• **params?**: [`ShowLoadingParams`](#showloadingparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需调用 hideLoading 关闭。
+
+<a id="hidetoast"></a>
+### hideToast()
+
+> **hideToast**(`params`?): `Promise`\<`object`\>
+
+隐藏当前 Toast。
+
+#### Parameters
+
+• **params?**: [`HideInteractionParams`](#hideinteractionparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="hideloading"></a>
+### hideLoading()
+
+> **hideLoading**(`params`?): `Promise`\<`object`\>
+
+隐藏当前 loading。
+
+#### Parameters
+
+• **params?**: [`HideInteractionParams`](#hideinteractionparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="showactionsheet"></a>
+### showActionSheet()
+
+> **showActionSheet**(`params`): `Promise`\<[`ShowActionSheetResult`](#showactionsheetresult)\>
+
+显示操作菜单。
+
+#### Parameters
+
+• **params**: [`ShowActionSheetParams`](#showactionsheetparams)
+
+#### Returns
+
+`Promise`\<[`ShowActionSheetResult`](#showactionsheetresult)\>
+
+#### Example
+
+```ts
+import { showActionSheet } from '@doubao-apps/framework/api';
+
+const result = await showActionSheet({
+  itemList: ['编辑', '删除']
+});
+
+console.log(result.tapIndex);
+```
+
+<a id="getmenubuttonboundingclientrect"></a>
+### getMenuButtonBoundingClientRect()
+
+> **getMenuButtonBoundingClientRect**(`params`?): [`MenuButtonBoundingClientRect`](#menubuttonboundingclientrect)
+
+获取菜单按钮的布局位置信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`MenuButtonBoundingClientRect`](#menubuttonboundingclientrect)
+
+返回菜单按钮相对屏幕左上角的坐标和尺寸，字段见 [MenuButtonBoundingClientRect](#menubuttonboundingclientrect)。
+
+#### Example
+
+```ts
+import { getMenuButtonBoundingClientRect } from '@doubao-apps/framework/api';
+
+const rect = getMenuButtonBoundingClientRect();
+
+console.log(rect.width, rect.height);
+console.log(rect.top, rect.right, rect.bottom, rect.left);
+```
+
+<a id="enablealertbeforeunload"></a>
+### enableAlertBeforeUnload()
+
+> **enableAlertBeforeUnload**(`params`): `Promise`\<`object`\>
+
+开启页面返回前提醒。
+当用户在小程序非最底层页面点击左上角返回按钮、左上角首页按钮或 Android 系统 back 键时,弹起询问弹窗
+
+返回询问对话框只会对调用的当前页面生效，通过手势滑动返回时不会弹起询问对话框
+
+#### Parameters
+
+• **params**: [`EnableAlertBeforeUnloadParams`](#enablealertbeforeunloadparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+配合 disableAlertBeforeUnload 使用。
+
+<a id="disablealertbeforeunload"></a>
+### disableAlertBeforeUnload()
+
+> **disableAlertBeforeUnload**(`params`?): `Promise`\<`object`\>
+
+关闭页面返回前提醒。
+
+#### Parameters
+
+• **params?**: `Record`\<`string`, `never`\>
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="showtoast"></a>
+### showToast()
+
+> **showToast**(`params`): `Promise`\<`object`\>
+
+显示 Toast 提示。
+
+参数 `options` 包含以下字段：
+- `message`: 提示的内容。
+- `type`: Toast 的类型，可选值为 'success' 或 'error'。
+- `duration`: 提示的延迟时间，单位毫秒，默认为 2000。
+- `icon`: 图标，可选值为 'success', 'error', 'warn'。
+- `customIcon`: 自定义图标的 URL 或 base64 字符串。
+
+#### Parameters
+
+• **params**: [`ShowToastParams`](#showtoastparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，在 Toast 显示结束时 resolve。
+
+#### Remarks
+
+duration 和 icon 可控制提示表现。
+
+#### Example
+
+```typescript
+import { showToast } from '@doubao-apps/framework';
+
+// 显示一个成功的 Toast
+showToast({
+  message: '操作成功',
+  type: 'success',
+  icon: 'success',
+  duration: 1500
+}).then(() => {
+  console.log('Toast 显示完毕');
+});
+
+// 显示一个错误的 Toast
+showToast({
+  message: '网络错误',
+  type: 'error',
+  icon: 'error'
+});
+```
+
+<a id="dispatchactiondirective"></a>
+### dispatchActionDirective()
+
+> **dispatchActionDirective**(`params`): `Promise`\<`object`\>
+
+描述用户行为，约束模型行为并指定后续执行路径。
+
+#### Parameters
+
+• **params**: [`DispatchActionDirectiveParams`](#dispatchactiondirectiveparams)
+
+动作描述、预期行为及工具调用约束参数。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，在动作指令成功下发时解析。
+
+#### Remarks
+
+适用于卡片交互后向模型补充结构化动作上下文，例如按钮点击、选项选择或表单提交。
+
+<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="loginwithdoubaowidget"></a>
+### loginWithDoubaoWidget()
+
+> **loginWithDoubaoWidget**(`params`): `Promise`\<[`LoginWithWidgetResult`](#loginwithwidgetresult)\>
+
+发起豆包 Widget 登录。
+
+#### Parameters
+
+• **params**: [`LoginWithWidgetRequest`](#loginwithwidgetrequest)
+
+Widget 登录参数。
+
+#### Returns
+
+`Promise`\<[`LoginWithWidgetResult`](#loginwithwidgetresult)\>
+
+返回登录结果。
+
+<a id="login"></a>
+### login()
+
+> **login**(`params`?): `Promise`\<[`LoginResult`](#loginresult)\>
+
+发起登录并获取登录凭证。
+
+#### Parameters
+
+• **params?**: [`LoginRequest`](#loginrequest)
+
+登录参数。
+
+#### Returns
+
+`Promise`\<[`LoginResult`](#loginresult)\>
+
+返回包含登录凭证 code 的 Promise。
+
+<a id="postloginresult"></a>
+### postLoginResult()
+
+> **postLoginResult**(`params`): `Promise`\<`object`\>
+
+回传 MCP 授权登录凭证。
+
+#### Parameters
+
+• **params**: [`PostLoginResultRequest`](#postloginresultrequest)
+
+登录结果回传参数。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回回传完成的 Promise。
+
+<a id="createsignorder"></a>
+### createSignOrder()
+
+> **createSignOrder**(`params`): `Promise`\<[`CreateSignOrderResult`](#createsignorderresult)\>
+
+创建签约订单。
+
+#### Parameters
+
+• **params**: [`CreateSignOrderParams`](#createsignorderparams)
+
+签约订单参数
+
+#### Returns
+
+`Promise`\<[`CreateSignOrderResult`](#createsignorderresult)\>
+
+返回一个 Promise，解析为签约订单结果。
+
+<a id="getorderpaymentwithsign"></a>
+### getOrderPaymentWithSign()
+
+> **getOrderPaymentWithSign**(`params`): `Promise`\<[`GetOrderPaymentResult`](#getorderpaymentresult)\>
+
+使用签名信息拉起收银台完成订单支付。
+
+#### Parameters
+
+• **params**: [`GetOrderPaymentWithSignParams`](#getorderpaymentwithsignparams)
+
+签名支付参数
+
+#### Returns
+
+`Promise`\<[`GetOrderPaymentResult`](#getorderpaymentresult)\>
+
+返回一个 Promise，成功时解析为订单支付结果。
+
+<a id="getorderpayment"></a>
+### getOrderPayment()
+
+> **getOrderPayment**(`params`): `Promise`\<[`GetOrderPaymentResult`](#getorderpaymentresult)\>
+
+拉起收银台完成订单支付。
+
+#### Parameters
+
+• **params**: [`GetOrderPaymentParams`](#getorderpaymentparams)
+
+支付参数
+
+#### Returns
+
+`Promise`\<[`GetOrderPaymentResult`](#getorderpaymentresult)\>
+
+返回一个 Promise，成功时解析为订单支付结果。
+
+<a id="requestcombineorder"></a>
+### requestCombineOrder()
+
+> **requestCombineOrder**(`params`): `Promise`\<[`RequestCombineOrderResult`](#requestcombineorderresult)\>
+
+请求创建合单订单。
+
+#### Parameters
+
+• **params**: [`RequestCombineOrderParams`](#requestcombineorderparams)
+
+合单订单参数
+
+#### Returns
+
+`Promise`\<[`RequestCombineOrderResult`](#requestcombineorderresult)\>
+
+返回一个 Promise，解析为合单订单结果。
+
+<a id="requestorder"></a>
+### requestOrder()
+
+> **requestOrder**(`params`): `Promise`\<[`RequestOrderResult`](#requestorderresult)\>
+
+发起订单支付流程。
+
+#### Parameters
+
+• **params**: [`RequestOrderParams`](#requestorderparams)
+
+订单支付请求参数。
+
+#### Returns
+
+`Promise`\<[`RequestOrderResult`](#requestorderresult)\>
+
+返回订单支付请求结果。
+
+<a id="sign"></a>
+### sign()
+
+> **sign**(`params`): `Promise`\<[`SignResult`](#signresult)\>
+
+拉起签约流程。
+
+#### Parameters
+
+• **params**: [`SignParams`](#signparams)
+
+签约参数
+
+#### Returns
+
+`Promise`\<[`SignResult`](#signresult)\>
+
+返回一个 Promise，解析为签约结果。
+
+<a id="getprivacysetting"></a>
+### getPrivacySetting()
+
+> **getPrivacySetting**(`params`?): `Promise`\<[`PrivacySettingResult`](#privacysettingresult)\>
+
+获取隐私设置状态。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`PrivacySettingResult`](#privacysettingresult)\>
+
+返回隐私设置状态。
+
+<a id="sendquerymessage"></a>
+### sendQueryMessage()
+
+> **sendQueryMessage**(`params`): `void`
+
+以用户身份发送一条消息
+
+由于会自动获取页面上下文来确定向哪个 bot 发送消息，因此只能在卡片或页面中调用
+
+#### Parameters
+
+• **params**: [`SendQueryMessageParams`](#sendquerymessageparams)
+
+#### Returns
+
+`void`
+
+#### Example
+
+```ts
+await sendQueryMessage({ content: '订阅消息', type: 'text' })
+```
+
+<a id="setadditionalcontext"></a>
+### setAdditionalContext()
+
+> **setAdditionalContext**(`params`): `Promise`\<`object`\>
+
+设置全局上下文供大模型理解
+
+#### Parameters
+
+• **params**: [`SetAdditionalContextParams`](#setadditionalcontextparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+设置全局上下文。
+
+<a id="updatemodelcontext"></a>
+### updateModelContext()
+
+> **updateModelContext**(`params`): `Promise`\<`object`\>
+
+向 Agent 捐赠上下文
+
+#### Parameters
+
+• **params**: [`UpdateModelContextParams`](#updatemodelcontextparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="updatewidget"></a>
+### updateWidget()
+
+> **updateWidget**(`params`): `Promise`\<`object`\>
+
+更新指定卡片
+
+#### Parameters
+
+• **params**: [`UpdateWidgetParams`](#updatewidgetparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="saveimagetophotosalbum"></a>
+### saveImageToPhotosAlbum()
+
+> **saveImageToPhotosAlbum**(`params`): `Promise`\<`object`\>
+
+保存图片到系统相册。
+
+需要先确保应用已具备写入系统相册的权限。
+
+#### Parameters
+
+• **params**: [`SaveImageToPhotosAlbumParams`](#saveimagetophotosalbumparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Example
+
+```typescript
+import { saveImageToPhotosAlbum } from '@doubao-apps/framework/api';
+
+await saveImageToPhotosAlbum({
+  filePath: '/path/to/image.png'
+});
+```
+
+<a id="previewimage"></a>
+### previewImage()
+
+> **previewImage**(`params`): `Promise`\<`object`\>
+
+预览图片。
+
+#### Parameters
+
+• **params**: [`PreviewImageParams`](#previewimageparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getimageinfo"></a>
+### getImageInfo()
+
+> **getImageInfo**(`params`): `Promise`\<[`GetImageInfoResult`](#getimageinforesult)\>
+
+获取图片信息。
+
+#### Parameters
+
+• **params**: [`GetImageInfoParams`](#getimageinfoparams)
+
+#### Returns
+
+`Promise`\<[`GetImageInfoResult`](#getimageinforesult)\>
+
+<a id="chooseimage"></a>
+### chooseImage()
+
+> **chooseImage**(`params`?): `Promise`\<[`ChooseImageResult`](#chooseimageresult)\>
+
+选择图片。
+
+#### Parameters
+
+• **params?**: [`ChooseImageParams`](#chooseimageparams)
+
+#### Returns
+
+`Promise`\<[`ChooseImageResult`](#chooseimageresult)\>
+
+<a id="compressimage"></a>
+### compressImage()
+
+> **compressImage**(`params`): `Promise`\<[`CompressImageResult`](#compressimageresult)\>
+
+压缩图片。
+
+#### Parameters
+
+• **params**: [`CompressImageParams`](#compressimageparams)
+
+#### Returns
+
+`Promise`\<[`CompressImageResult`](#compressimageresult)\>
+
+<a id="request"></a>
+### request()
+
+> **request**(`params`): `Promise`\<[`RequestResponse`](#requestresponse)\>
+
+发起网络请求。
+
+#### Parameters
+
+• **params**: [`RequestParams`](#requestparams)
+
+请求参数，字段见 [RequestParams](#requestparams)。
+
+#### Returns
+
+`Promise`\<[`RequestResponse`](#requestresponse)\>
+
+返回一个 Promise，解析为 [RequestResponse](#requestresponse)。
+
+#### Remarks
+
+返回 statusCode、header 和 data。
+
+#### Example
+
+```typescript
+import { request } from '@doubao-apps/framework/api';
+
+const result = await request({
+  url: 'https://postman-echo.com/post',
+  method: 'POST',
+  dataType: 'json',
+  header: { 'content-type': 'application/json' },
+  data: { hello: 'world' }
+});
+
+console.log(result.statusCode, result.data);
+```
+
+<a id="openapp"></a>
+### openApp()
+
+> **openApp**(`params`): `Promise`\<[`OpenAppResult`](#openappresult)\>
+
+通过 deep link 等方式打开外部应用。
+
+#### Parameters
+
+• **params**: [`OpenAppRequest`](#openapprequest)
+
+外部应用打开参数。
+
+#### Returns
+
+`Promise`\<[`OpenAppResult`](#openappresult)\>
+
+返回外部应用打开结果。
+
+<a id="navigateto"></a>
+### navigateTo()
+
+> **navigateTo**(`params`): `Promise`\<`object`\>
+
+保留当前页面，跳转到应用内的某个页面。
+
+#### Parameters
+
+• **params**: [`NavigateToParams`](#navigatetoparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="redirectto"></a>
+### redirectTo()
+
+> **redirectTo**(`params`): `Promise`\<`object`\>
+
+关闭当前页面，跳转到应用内的某个页面。
+
+#### Parameters
+
+• **params**: [`NavigateToParams`](#navigatetoparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="relaunch"></a>
+### reLaunch()
+
+> **reLaunch**(`params`): `Promise`\<`object`\>
+
+关闭所有页面并跳转到应用内页面。
+
+#### Parameters
+
+• **params**: [`NavigateToParams`](#navigatetoparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="navigateback"></a>
+### navigateBack()
+
+> **navigateBack**(`params`?): `Promise`\<`object`\>
+
+关闭当前页面，返回上一页面或多级页面。
+
+#### Parameters
+
+• **params?**: [`NavigateBackParams`](#navigatebackparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="exitapp"></a>
+### exitApp()
+
+> **exitApp**(): `Promise`\<`object`\>
+
+退出当前所有页面。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+会退出当前所有页面。
+
+<a id="setstorage"></a>
+### setStorage()
+
+> **setStorage**\<`TData`\>(`params`): `Promise`\<`object`\>
+
+将数据写入本地缓存。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`SetStorageParams`](#setstorageparamstdata)\<`TData`\>
+
+存储参数，字段见 [SetStorageParams](#setstorageparamstdata)。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，写入完成后 resolve。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { setStorage } from '@doubao-apps/framework/api';
+
+await setStorage({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+<a id="setstoragesync"></a>
+### setStorageSync()
+
+> **setStorageSync**\<`TData`\>(`params`): `object`
+
+将数据写入本地缓存。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`SetStorageParams`](#setstorageparamstdata)\<`TData`\>
+
+存储参数，字段见 [SetStorageParams](#setstorageparamstdata)。
+
+#### Returns
+
+`object`
+
+同步写入完成后返回。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { setStorageSync } from '@doubao-apps/framework/api';
+
+setStorageSync({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+<a id="getstorage"></a>
+### getStorage()
+
+> **getStorage**\<`TData`\>(`params`): `Promise`\<[`GetStorageResult`](#getstorageresulttdata)\<`TData`\>\>
+
+从本地缓存读取数据。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`GetStorageParams`](#getstorageparams)
+
+查询参数，字段见 [GetStorageParams](#getstorageparams)。
+
+#### Returns
+
+`Promise`\<[`GetStorageResult`](#getstorageresulttdata)\<`TData`\>\>
+
+返回一个 Promise，解析为 [GetStorageResult](#getstorageresulttdata)。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { getStorage } from '@doubao-apps/framework/api';
+
+const result = await getStorage<{ name: string; age: number }>({
+  key: 'profile',
+});
+
+console.log(result.data.name, result.data.age);
+```
+
+<a id="getstoragesync"></a>
+### getStorageSync()
+
+> **getStorageSync**\<`TData`\>(`params`): [`GetStorageResult`](#getstorageresulttdata)\<`TData`\>
+
+从本地缓存同步读取数据。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`GetStorageParams`](#getstorageparams)
+
+查询参数，字段见 [GetStorageParams](#getstorageparams)。
+
+#### Returns
+
+[`GetStorageResult`](#getstorageresulttdata)\<`TData`\>
+
+返回 [GetStorageResult](#getstorageresulttdata)。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { getStorageSync } from '@doubao-apps/framework/api';
+
+const result = getStorageSync<{ name: string; age: number }>({
+  key: 'profile',
+});
+
+console.log(result.data.name, result.data.age);
+```
+
+<a id="removestorage"></a>
+### removeStorage()
+
+> **removeStorage**(`params`): `Promise`\<`object`\>
+
+删除本地缓存中指定 key 的数据。
+
+#### Parameters
+
+• **params**: [`RemoveStorageParams`](#removestorageparams)
+
+删除参数，字段见 [RemoveStorageParams](#removestorageparams)。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，删除完成后 resolve。
+
+#### Example
+
+```typescript
+import { removeStorage } from '@doubao-apps/framework/api';
+
+await removeStorage({ key: 'profile' });
+```
+
+<a id="removestoragesync"></a>
+### removeStorageSync()
+
+> **removeStorageSync**(`params`?): `object`
+
+删除本地缓存中指定 key 的数据。
+
+#### Parameters
+
+• **params?**: [`RemoveStorageParams`](#removestorageparams)
+
+删除参数，字段见 [RemoveStorageParams](#removestorageparams)。
+
+#### Returns
+
+`object`
+
+同步删除完成后返回。
+
+#### Example
+
+```typescript
+import { removeStorageSync } from '@doubao-apps/framework/api';
+
+removeStorageSync({ key: 'profile' });
+```
+
+<a id="clearstorage"></a>
+### clearStorage()
+
+> **clearStorage**(`params`?): `Promise`\<`object`\>
+
+清空本地缓存。
+
+#### Parameters
+
+• **params?**: `object`
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，清空完成后 resolve。
+
+#### Example
+
+```typescript
+import { clearStorage } from '@doubao-apps/framework/api';
+
+await clearStorage();
+```
+
+<a id="clearstoragesync"></a>
+### clearStorageSync()
+
+> **clearStorageSync**(`params`?): `object`
+
+清空本地缓存。
+
+#### Parameters
+
+• **params?**: `object`
+
+#### Returns
+
+`object`
+
+同步清空完成后返回。
+
+#### Example
+
+```typescript
+import { clearStorageSync } from '@doubao-apps/framework/api';
+
+clearStorageSync();
+```
+
+<a id="getstorageinfo"></a>
+### getStorageInfo()
+
+> **getStorageInfo**(`params`?): `Promise`\<[`GetStorageInfoResult`](#getstorageinforesult)\>
+
+获取本地缓存信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetStorageInfoResult`](#getstorageinforesult)\>
+
+返回一个 Promise，解析为 [GetStorageInfoResult](#getstorageinforesult)。
+
+#### Example
+
+```typescript
+import { getStorageInfo } from '@doubao-apps/framework/api';
+
+const result = await getStorageInfo();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+<a id="getstorageinfosync"></a>
+### getStorageInfoSync()
+
+> **getStorageInfoSync**(`params`?): [`GetStorageInfoResult`](#getstorageinforesult)
+
+同步获取本地缓存信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`GetStorageInfoResult`](#getstorageinforesult)
+
+返回 [GetStorageInfoResult](#getstorageinforesult)。
+
+#### Example
+
+```typescript
+import { getStorageInfoSync } from '@doubao-apps/framework/api';
+
+const result = getStorageInfoSync();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+<a id="getwindowinfosync"></a>
+### getWindowInfoSync()
+
+> **getWindowInfoSync**(`_param`?): [`GetWindowInfoResult`](#getwindowinforesult)
+
+获取窗口信息。
+
+#### Parameters
+
+• **\_param?**
+
+#### Returns
+
+[`GetWindowInfoResult`](#getwindowinforesult)
+
+返回窗口尺寸、状态栏高度和安全区域等信息，字段见 [GetWindowInfoResult](#getwindowinforesult)。
+
+#### Example
+
+```typescript
+import { getWindowInfoSync } from '@doubao-apps/framework/api';
+
+const result = getWindowInfoSync();
+
+console.log(result.windowWidth, result.windowHeight);
+console.log(result.safeArea?.top, result.screenTop);
+```
+
+<a id="getsystemsetting"></a>
+### getSystemSetting()
+
+> **getSystemSetting**(`params`?): [`GetSystemSettingResult`](#getsystemsettingresult)
+
+获取设备设置。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`GetSystemSettingResult`](#getsystemsettingresult)
+
+返回蓝牙、定位、Wi-Fi 系统开关和设备方向等字段，见 [GetSystemSettingResult](#getsystemsettingresult)。
+
+#### Example
+
+```typescript
+import { getSystemSetting } from '@doubao-apps/framework/api';
+
+const result = getSystemSetting();
+
+console.log(result.bluetoothEnabled, result.locationEnabled);
+console.log(result.wifiEnabled, result.deviceOrientation);
+```
+
+<a id="getappbaseinfosync"></a>
+### getAppBaseInfoSync()
+
+> **getAppBaseInfoSync**(`_params`?): [`GetAppBaseInfoResult`](#getappbaseinforesult)
+
+获取应用基础信息。
+
+#### Parameters
+
+• **\_params?**
+
+#### Returns
+
+[`GetAppBaseInfoResult`](#getappbaseinforesult)
+
+返回 SDK 版本、调试开关、宿主信息、语言和主题等字段，见 [GetAppBaseInfoResult](#getappbaseinforesult)。
+
+#### Example
+
+```typescript
+import { getAppBaseInfoSync } from '@doubao-apps/framework/api';
+
+const result = getAppBaseInfoSync();
+
+console.log(result.language, result.SDKVersion, result.theme);
+console.log(result.host?.appId, result.enableDebug);
+```
+
+<a id="getwindowinfo"></a>
+### getWindowInfo()
+
+> **getWindowInfo**(`_params`?): `Promise`\<[`GetWindowInfoResult`](#getwindowinforesult)\>
+
+获取窗口信息。
+
+#### Parameters
+
+• **\_params?**
+
+#### Returns
+
+`Promise`\<[`GetWindowInfoResult`](#getwindowinforesult)\>
+
+返回窗口尺寸、状态栏高度和安全区域等信息，字段见 [GetWindowInfoResult](#getwindowinforesult)。
+
+#### Example
+
+```typescript
+import { getWindowInfo } from '@doubao-apps/framework/api';
+
+const result = await getWindowInfo();
+
+console.log(result.windowWidth, result.windowHeight);
+console.log(result.safeArea?.top, result.screenTop);
+```
+
+<a id="getappbaseinfo"></a>
+### getAppBaseInfo()
+
+> **getAppBaseInfo**(`params`?): `Promise`\<[`GetAppBaseInfoResult`](#getappbaseinforesult)\>
+
+获取应用基础信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetAppBaseInfoResult`](#getappbaseinforesult)\>
+
+返回 SDK 版本、调试开关、宿主信息、语言和主题等字段，见 [GetAppBaseInfoResult](#getappbaseinforesult)。
+
+#### Example
+
+```typescript
+import { getAppBaseInfo } from '@doubao-apps/framework/api';
+
+const result = await getAppBaseInfo();
+
+console.log(result.language, result.SDKVersion, result.theme);
+console.log(result.host?.appId, result.enableDebug);
+```
+
+## 相关类型
+
+<a id="getaccountinforesult"></a>
+### GetAccountInfoResult
+
+获取当前账号信息。
+
+#### Properties
+
+##### miniProgram
+
+> **miniProgram**: [`DoubaoAppAccountInfo`](#doubaoappaccountinfo)
+
+豆包 App账号信息
+
+##### plugin?
+
+> `optional` **plugin**: [`PluginAccountInfo`](#pluginaccountinfo)
+
+插件账号信息（仅在插件中调用时包含）
+
+<a id="doubaoappaccountinfo"></a>
+### DoubaoAppAccountInfo
+
+豆包 App 账号信息。
+
+#### Properties
+
+##### appId
+
+> **appId**: `string`
+
+豆包 App appId
+
+##### envVersion
+
+> **envVersion**: `"develop"` \| `"trial"` \| `"release"`
+
+豆包 App 运行环境。
+
+- develop: 开发版
+- trial: 体验版
+- release: 正式版
+
+##### version
+
+> **version**: `string`
+
+线上豆包 App 版本号。
+
+<a id="pluginaccountinfo"></a>
+### PluginAccountInfo
+
+插件账号信息（仅在插件中调用时包含）。
+
+#### Properties
+
+##### appId
+
+> **appId**: `string`
+
+插件 appId
+
+##### version
+
+> **version**: `string`
+
+插件版本号，'a.b.c' 形式
+
+<a id="authorizerequest"></a>
+### AuthorizeRequest
+
+#### Properties
+
+##### scope
+
+> **scope**: [`Scope`](#scope-1)
+
+授权范围
+
+<a id="scope-1"></a>
+<a id="scope"></a>
+### Scope
+
+> **Scope**: `"scope.userLocation"` \| `"scope.userFuzzyLocation"` \| `"scope.userLocationBackground"` \| `"scope.payment"` \| `"scope.record"` \| `"scope.bluetooth"` \| `"scope.camera"` \| `"scope.addPhoneContact"` \| `"scope.addPhoneCalendar"`
+
+<a id="caniuseparams"></a>
+### CanIUseParams
+
+#### Properties
+
+##### schema
+
+> **schema**: `string`
+
+<a id="caniuseresult"></a>
+### CanIUseResult
+
+#### Properties
+
+##### result
+
+> **result**: `boolean`
+
+<a id="getlocationparams"></a>
+### GetLocationParams
+
+#### Properties
+
+##### maxCacheMs?
+
+> `optional` **maxCacheMs**: `number`
+
+缓存时间，单位毫秒，默认为0
+
+##### mode?
+
+> `optional` **mode**: `number`
+
+定位模式
+0：低功耗
+1：仅设备
+2：高精度（默认）
+
+##### source?
+
+> `optional` **source**: `string`
+
+调用业务方
+
+##### timeoutMs?
+
+> `optional` **timeoutMs**: `number`
+
+超时时间，单位毫秒，默认 30000
+
+<a id="getlocationresponse"></a>
+### GetLocationResponse
+
+#### Properties
+
+##### accuracy
+
+> **accuracy**: `number`
+
+定位精度，单位：米
+
+##### latitude
+
+> **latitude**: `number`
+
+纬度
+
+##### longitude
+
+> **longitude**: `number`
+
+经度
+
+##### speed
+
+> **speed**: `number`
+
+行进速度，单位：米/秒
+
+##### timestamp
+
+> **timestamp**: `string`
+
+时间戳
+
+<a id="showmodalparams"></a>
+### ShowModalParams
+
+显示模态对话框的参数。
+
+#### Properties
+
+##### cancelText?
+
+> `optional` **cancelText**: `string`
+
+取消按钮的文字。
+
+##### confirmText?
+
+> `optional` **confirmText**: `string`
+
+确认按钮的文字。
+
+##### content
+
+> **content**: `string`
+
+模态对话框的内容。
+
+##### showCancel?
+
+> `optional` **showCancel**: `boolean`
+
+是否显示取消按钮，默认 `true`。
+
+##### tapMaskToDismiss?
+
+> `optional` **tapMaskToDismiss**: `boolean`
+
+是否允许点击蒙层关闭对话框，默认 `false`。
+
+##### title?
+
+> `optional` **title**: `string`
+
+模态对话框的标题。
+
+<a id="showmodalresult"></a>
+### ShowModalResult
+
+显示模态对话框的返回结果。
+
+#### Properties
+
+##### action
+
+> **action**: `"confirm"` \| `"cancel"` \| `"mask"`
+
+用户点击的动作。
+
+<a id="showloadingparams"></a>
+### ShowLoadingParams
+
+显示 loading 提示框的参数。
+
+<a id="hideinteractionparams"></a>
+### HideInteractionParams
+
+隐藏交互提示框的公共参数。
+
+<a id="showactionsheetparams"></a>
+### ShowActionSheetParams
+
+显示操作菜单的参数。
+
+#### Properties
+
+##### itemColor?
+
+> `optional` **itemColor**: `string`
+
+按钮文字颜色。
+
+##### itemList
+
+> **itemList**: `string`[]
+
+按钮文字数组。
+
+##### title?
+
+> `optional` **title**: `string`
+
+标题
+
+<a id="showactionsheetresult"></a>
+### ShowActionSheetResult
+
+显示操作菜单的返回结果。
+
+#### Properties
+
+##### tapIndex
+
+> **tapIndex**: `number`
+
+用户点击的按钮序号，从 0 开始。
+
+<a id="menubuttonboundingclientrect"></a>
+### MenuButtonBoundingClientRect
+
+菜单按钮的布局位置信息。
+
+#### Properties
+
+##### bottom
+
+> **bottom**: `number`
+
+下边界坐标，单位 px。
+
+##### height
+
+> **height**: `number`
+
+高度，单位 px。
+
+##### left
+
+> **left**: `number`
+
+左边界坐标，单位 px。
+
+##### right
+
+> **right**: `number`
+
+右边界坐标，单位 px。
+
+##### top
+
+> **top**: `number`
+
+上边界坐标，单位 px。
+
+##### width
+
+> **width**: `number`
+
+宽度，单位 px。
+
+<a id="enablealertbeforeunloadparams"></a>
+### EnableAlertBeforeUnloadParams
+
+开启返回前提醒的参数。
+
+#### Properties
+
+##### message
+
+> **message**: `string`
+
+返回前确认弹窗的文案。
+
+<a id="showtoastparams"></a>
+### ShowToastParams
+
+#### Properties
+
+##### customIcon?
+
+> `optional` **customIcon**: `string`
+
+##### duration?
+
+> `optional` **duration**: `number`
+
+##### icon?
+
+> `optional` **icon**: `"success"` \| `"error"` \| `"warn"`
+
+##### message
+
+> **message**: `string`
+
+##### type?
+
+> `optional` **type**: `"default"` \| `"success"` \| `"error"` \| `"warning"`
+
+<a id="dispatchactiondirectiveparams"></a>
+### DispatchActionDirectiveParams
+
+下发动作指令的请求参数。
+
+#### Properties
+
+##### actionDescribe
+
+> **actionDescribe**: `string`
+
+自然语言描述，例如：用户点击支付按钮并完成话费支付
+
+##### actionType
+
+> **actionType**: [`ActionDirectiveType`](#actiondirectivetype)
+
+动作类型，参见 [ActionDirectiveType](#actiondirectivetype)
+
+##### expectedAction
+
+> **expectedAction**: `string`
+
+自然语言描述，例如：调用话费账单查询工具，基于工具返回回复用户。如果有卡片需要引用卡片
+
+##### responseHint?
+
+> `optional` **responseHint**: `string`
+
+自然语言描述，例如：严格参照提供的工具入参来调用工具，不要调用除bill_check以外的其他工具，只能严格基于bill_check工具返回结果进行回复
+
+##### toolName?
+
+> `optional` **toolName**: `string`
+
+mcp名称，如果expectedAction里预期要调用工具，需要在这里写明调用工具的mcp name
+
+##### toolParams?
+
+> `optional` **toolParams**: `Record`\<`string`, `string`\>
+
+mcp入参，如果expectedAction里预期要调用工具，需要在这里写明调用工具的入参
+
+##### 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="expiredwidgetparams"></a>
+### ExpiredWidgetParams
+
+#### Properties
+
+##### detailText?
+
+> `optional` **detailText**: `string`
+
+点击失效卡要跳转的页面 detailText
+
+##### schema?
+
+> `optional` **schema**: `string`
+
+点击失效卡要跳转的页面 schema，格式与 navigateTo 的 url 相同
+
+##### title?
+
+> `optional` **title**: `string`
+
+点击失效卡要跳转的页面 title
+
+##### widgetInstanceId
+
+> **widgetInstanceId**: `string`
+
+卡片实例 ID，在卡片环境通过getWidgetInstanceId来获取，其他环境（比如页面）需要通过传参或通信的方式传递过去
+
+<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="loginrequest"></a>
+### LoginRequest
+
+#### Properties
+
+##### timeout?
+
+> `optional` **timeout**: `number`
+
+Timeout in milliseconds
+
+<a id="loginresult"></a>
+### LoginResult
+
+#### Properties
+
+##### code
+
+> **code**: `string`
+
+Login credential code
+
+<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="createsignorderparams"></a>
+### CreateSignOrderParams
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+签约订单请求数据。
+
+##### dbAuthorization
+
+> **dbAuthorization**: `string`
+
+签约订单授权信息。
+
+<a id="createsignorderresult"></a>
+### CreateSignOrderResult
+
+> **CreateSignOrderResult**: [`CreateSignOrderSuccessResult`](#createsignordersuccessresult) \| [`CreateSignOrderFailResult`](#createsignorderfailresult)
+
+<a id="createsignorderfailresult"></a>
+### CreateSignOrderFailResult
+
+#### Properties
+
+##### errLogId?
+
+> `optional` **errLogId**: `string`
+
+用于问题排查的错误日志 ID。
+
+##### errMsg
+
+> **errMsg**: `string`
+
+错误信息。
+
+##### errNo
+
+> **errNo**: `string`
+
+错误码。
+
+<a id="createsignordersuccessresult"></a>
+### CreateSignOrderSuccessResult
+
+#### Properties
+
+##### authOrderId
+
+> **authOrderId**: `string`
+
+签约订单 ID。
+
+##### logId
+
+> **logId**: `string`
+
+用于问题排查的日志 ID。
+
+<a id="getorderpaymentresult"></a>
+### GetOrderPaymentResult
+
+#### Properties
+
+##### logId
+
+> **logId**: `string`
+
+用于问题排查的日志 ID。
+
+##### orderId
+
+> **orderId**: `string`
+
+订单 ID。
+
+<a id="getorderpaymentwithsignparams"></a>
+### GetOrderPaymentWithSignParams
+
+#### Properties
+
+##### orderId
+
+> **orderId**: `string`
+
+订单 ID。
+
+##### signData
+
+> **signData**: `string`
+
+支付签名数据。
+
+##### signDbAuthorization
+
+> **signDbAuthorization**: `string`
+
+签名支付授权信息。
+
+<a id="getorderpaymentparams"></a>
+### GetOrderPaymentParams
+
+#### Properties
+
+##### orderId
+
+> **orderId**: `string`
+
+订单 ID。
+
+<a id="requestcombineorderparams"></a>
+### RequestCombineOrderParams
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+合单订单请求数据。
+
+##### dbAuthorization
+
+> **dbAuthorization**: `string`
+
+合单订单授权信息。
+
+<a id="requestcombineorderresult"></a>
+### RequestCombineOrderResult
+
+> **RequestCombineOrderResult**: [`RequestCombineOrderSuccessResult`](#requestcombineordersuccessresult) \| [`RequestCombineOrderFailResult`](#requestcombineorderfailresult)
+
+<a id="requestcombineorderfailresult"></a>
+### RequestCombineOrderFailResult
+
+#### Properties
+
+##### errLogId?
+
+> `optional` **errLogId**: `string`
+
+用于问题排查的错误日志 ID。
+
+##### errMsg
+
+> **errMsg**: `string`
+
+错误信息。
+
+##### errNo
+
+> **errNo**: `string`
+
+错误码。
+
+<a id="requestcombineordersuccessresult"></a>
+### RequestCombineOrderSuccessResult
+
+#### Properties
+
+##### combineOrderId
+
+> **combineOrderId**: `string`
+
+合单订单 ID。
+
+##### logId
+
+> **logId**: `string`
+
+用于问题排查的日志 ID。
+
+<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="signparams"></a>
+### SignParams
+
+#### Properties
+
+##### orderId
+
+> **orderId**: `string`
+
+签约订单 ID。
+
+<a id="signresult"></a>
+### SignResult
+
+> **SignResult**: [`SignSuccessResult`](#signsuccessresult) \| [`SignFailResult`](#signfailresult)
+
+<a id="signfailresult"></a>
+### SignFailResult
+
+#### Properties
+
+##### code
+
+> **code**: `number`
+
+错误码。
+
+##### errLogId?
+
+> `optional` **errLogId**: `string`
+
+用于问题排查的错误日志 ID。
+
+##### errMsg
+
+> **errMsg**: `string`
+
+错误信息。
+
+##### errNo
+
+> **errNo**: `string`
+
+错误编号。
+
+<a id="signsuccessresult"></a>
+### SignSuccessResult
+
+> **SignSuccessResult**: `Record`\<`string`, `never`\>
+
+<a id="privacysettingresult"></a>
+### PrivacySettingResult
+
+#### Properties
+
+##### needAuthorization
+
+> **needAuthorization**: `boolean`
+
+Whether user authorization for privacy agreement is required
+
+<a id="sendquerymessageparams"></a>
+### SendQueryMessageParams
+
+#### Properties
+
+##### content
+
+> **content**: `string`
+
+要发送的消息。根据类型不同，序列化方式可能不同
+
+##### type
+
+> **type**: `"text"`
+
+消息类型，目前仅支持 text
+
+<a id="setadditionalcontextparams"></a>
+### SetAdditionalContextParams
+
+#### Properties
+
+##### additionalContext
+
+> **additionalContext**: `string`
+
+上下文内容
+
+##### botId?
+
+> `optional` **botId**: `string`
+
+指定 bot id
+
+<a id="updatemodelcontextparams"></a>
+### UpdateModelContextParams
+
+#### Properties
+
+##### content
+
+> **content**: `string`
+
+上下文内容，格式无约束，可以与 MCP 服务下发的上下文格式保持一致
+
+##### entityId?
+
+> `optional` **entityId**: `string`
+
+上下文所属的 entityID，业务侧管理
+
+##### taskId?
+
+> `optional` **taskId**: `string`
+
+上下文所属任务 ID，业务侧定义
+
+<a id="updatewidgetparams"></a>
+### UpdateWidgetParams
+
+#### Properties
+
+##### widgetData
+
+> **widgetData**: `string`
+
+卡片渲染的数据
+
+##### widgetId?
+
+> `optional` **widgetId**: `string`
+
+卡片更新的为新的widgetId
+
+##### widgetInstanceId
+
+> **widgetInstanceId**: `string`
+
+需要更新的widget 实例 ID
+
+<a id="saveimagetophotosalbumparams"></a>
+### SaveImageToPhotosAlbumParams
+
+保存图片到系统相册的请求参数。
+
+#### Properties
+
+##### filePath
+
+> **filePath**: `string`
+
+需要保存的图片文件路径。支持临时文件路径或持久文件路径，不支持网络图片路径。
+
+<a id="previewimageparams"></a>
+### PreviewImageParams
+
+预览图片的请求参数。
+
+#### Properties
+
+##### current?
+
+> `optional` **current**: `string` \| `number`
+
+当前显示图片的链接，或当前显示图片的下标，不填则默认为 urls 中的第一张
+
+##### referrerPolicy?
+
+> `optional` **referrerPolicy**: `string`
+
+预览页使用的 Referrer 策略。
+
+##### showmenu?
+
+> `optional` **showmenu**: `boolean`
+
+是否显示长按菜单，菜单支持保存图片至本地相册
+
+##### urls
+
+> **urls**: `string`[]
+
+需要预览的图片链接列表。
+
+<a id="getimageinfoparams"></a>
+### GetImageInfoParams
+
+获取图片信息的请求参数。
+
+#### Properties
+
+##### src
+
+> **src**: `string`
+
+图片路径，可以是相对路径、临时文件路径、存储文件路径或网络图片路径。
+
+<a id="getimageinforesult"></a>
+### GetImageInfoResult
+
+图片信息结果。
+
+#### Properties
+
+##### height
+
+> **height**: `number`
+
+图片原始高度，单位 px，不考虑旋转。
+
+##### orientation
+
+> **orientation**: [`ImageOrientation`](#imageorientation)
+
+图片方向。
+
+##### path
+
+> **path**: `string`
+
+图片的本地路径。
+
+##### type
+
+> **type**: `string`
+
+图片格式。
+
+##### width
+
+> **width**: `number`
+
+图片原始宽度，单位 px，不考虑旋转。
+
+<a id="imageorientation"></a>
+### ImageOrientation
+
+> **ImageOrientation**: `"up"` \| `"up-mirrored"` \| `"down"` \| `"down-mirrored"` \| `"left-mirrored"` \| `"right"` \| `"right-mirrored"` \| `"left"`
+
+图片方向枚举。
+
+<a id="chooseimageparams"></a>
+### ChooseImageParams
+
+选择图片的请求参数。
+
+#### Properties
+
+##### count?
+
+> `optional` **count**: `number`
+
+最多可选图片张数。
+
+##### imageId?
+
+> `optional` **imageId**: `string`
+
+H5 场景下可复用的 input 元素 ID。
+
+##### sizeType?
+
+> `optional` **sizeType**: [`ChooseImageSizeType`](#chooseimagesizetype)[]
+
+允许返回的图片尺寸类型。
+
+##### sourceType?
+
+> `optional` **sourceType**: [`ChooseImageSourceType`](#chooseimagesourcetype)[]
+
+允许选择的图片来源。
+
+<a id="chooseimageresult"></a>
+### ChooseImageResult
+
+选择图片结果。
+
+#### Properties
+
+##### tempFilePaths
+
+> **tempFilePaths**: `string`[]
+
+图片临时文件路径列表。
+
+##### tempFiles
+
+> **tempFiles**: [`ChooseImageFile`](#chooseimagefile)[]
+
+图片临时文件信息列表。
+
+<a id="chooseimagesizetype"></a>
+### ChooseImageSizeType
+
+> **ChooseImageSizeType**: `"original"` \| `"compressed"`
+
+可选的图片尺寸类型。
+
+<a id="chooseimagesourcetype"></a>
+### ChooseImageSourceType
+
+> **ChooseImageSourceType**: `"album"` \| `"camera"` \| `"user"` \| `"environment"`
+
+可选的图片来源类型。
+
+<a id="chooseimagefile"></a>
+### ChooseImageFile
+
+选择图片返回的单个文件信息。
+
+#### Properties
+
+##### originalFileObj?
+
+> `optional` **originalFileObj**: `File`
+
+原始浏览器 File 对象。
+
+##### path
+
+> **path**: `string`
+
+本地临时文件路径。
+
+##### size
+
+> **size**: `number`
+
+文件大小，单位 B。
+
+##### type?
+
+> `optional` **type**: `string`
+
+文件 MIME 类型。
+
+<a id="compressimageparams"></a>
+### CompressImageParams
+
+压缩图片的请求参数。
+
+#### Properties
+
+##### compressedHeight?
+
+> `optional` **compressedHeight**: `number`
+
+压缩后图片高度，单位 px。
+
+##### compressedWidth?
+
+> `optional` **compressedWidth**: `number`
+
+压缩后图片宽度，单位 px。
+
+##### quality?
+
+> `optional` **quality**: `number`
+
+压缩质量，范围 0 - 100，仅对 jpg 生效。
+
+##### src
+
+> **src**: `string`
+
+图片路径。
+
+<a id="compressimageresult"></a>
+### CompressImageResult
+
+压缩图片结果。
+
+#### Properties
+
+##### tempFilePath
+
+> **tempFilePath**: `string`
+
+压缩后图片的临时文件路径。
+
+<a id="requestparams"></a>
+### RequestParams
+
+网络请求参数。
+
+#### Properties
+
+##### data?
+
+> `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
+
+请求体数据。
+
+传给服务器的数据最终会是 `String` 或 `ArrayBuffer`：
+- 若 `data` 是 `string` 或 `ArrayBuffer`，直接使用；
+- 若 `header['content-type']` 是 `application/x-www-form-urlencoded`，会被编码为 query string，例如：`encodeURIComponent(k)=encodeURIComponent(v)`；
+- 若 `header['content-type']` 是 `application/json`，会执行 JSON 序列化；
+- 若 `data` 是普通对象且未命中上述类型，也会执行 JSON 序列化；
+- 其他类型会调用 `toString()`
+
+##### dataType?
+
+> `optional` **dataType**: `"string"` \| `"json"`
+
+期望返回的数据格式。
+- `json`: 尝试按 JSON 解析；
+- `string`: 按字符串返回。
+
+###### Default
+
+```ts
+"json"
+```
+
+##### header?
+
+> `optional` **header**: `Record`\<`string`, `string`\>
+
+请求 Header。
+
+###### Default
+
+```ts
+{"content-type": "application/json"}
+```
+
+##### method?
+
+> `optional` **method**: [`RequestMethod`](#requestmethod)
+
+请求方法。
+
+###### Default
+
+```ts
+"GET"
+```
+
+##### url
+
+> **url**: `string`
+
+请求地址，需为完整的 **HTTPS** URL。
+
+<a id="requestresponse"></a>
+### RequestResponse
+
+网络请求返回结果。
+
+#### Properties
+
+##### data?
+
+> `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
+
+响应数据，类型由 `dataType` 决定。
+
+##### header
+
+> **header**: `Record`\<`string`, `string`\>
+
+HTTP 响应头。
+
+##### statusCode
+
+> **statusCode**: `number`
+
+HTTP 状态码。
+
+<a id="requestmethod"></a>
+### RequestMethod
+
+> **RequestMethod**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"HEAD"` \| `"OPTIONS"` \| `"TRACE"` \| `"CONNECT"`
+
+<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"`
+
+<a id="navigatetoparams"></a>
+### NavigateToParams
+
+#### Properties
+
+##### url
+
+> **url**: `string`
+
+跳转的页面的路径，如 'path?key=value&key2=value2'
+
+<a id="navigatebackparams"></a>
+### NavigateBackParams
+
+#### Properties
+
+##### delta?
+
+> `optional` **delta**: `number`
+
+返回的页面数，如果 delta 大于现有页面数，则返回到页面栈中只剩一个页面为止。
+
+<a id="setstorageparamstdata"></a>
+### SetStorageParams<TData>
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Properties
+
+##### data
+
+> **data**: `TData`
+
+待存储的数据
+
+##### key
+
+> **key**: `string`
+
+本地缓存键名
+
+<a id="getstorageparams"></a>
+### GetStorageParams
+
+#### Properties
+
+##### key
+
+> **key**: `string`
+
+本地缓存键名
+
+<a id="getstorageresulttdata"></a>
+### GetStorageResult<TData>
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Properties
+
+##### data
+
+> **data**: `TData`
+
+key 对应的数据
+
+<a id="removestorageparams"></a>
+### RemoveStorageParams
+
+#### Properties
+
+##### key
+
+> **key**: `string`
+
+本地缓存键名
+
+<a id="getstorageinforesult"></a>
+### GetStorageInfoResult
+
+#### Properties
+
+##### currentSize
+
+> **currentSize**: `number`
+
+当前占用的空间大小，单位 KB
+
+##### keys
+
+> **keys**: `string`[]
+
+当前 storage 中所有的 key
+
+##### limitSize
+
+> **limitSize**: `number`
+
+限制的空间大小，单位 KB
+
+<a id="getwindowinforesult"></a>
+### GetWindowInfoResult
+
+#### Properties
+
+##### pixelRatio
+
+> **pixelRatio**: `number`
+
+设备像素比
+
+##### safeArea?
+
+> `optional` **safeArea**: [`WindowSafeArea`](#windowsafearea)
+
+安全区域
+
+##### screenHeight
+
+> **screenHeight**: `number`
+
+屏幕高度
+
+##### screenTop
+
+> **screenTop**: `number`
+
+窗口上边缘的 y 值
+
+##### screenWidth
+
+> **screenWidth**: `number`
+
+屏幕宽度
+
+##### statusBarHeight
+
+> **statusBarHeight**: `number`
+
+状态栏高度
+
+##### windowHeight
+
+> **windowHeight**: `number`
+
+可使用窗口高度
+
+##### windowWidth
+
+> **windowWidth**: `number`
+
+可使用窗口宽度
+
+<a id="windowsafearea"></a>
+### WindowSafeArea
+
+#### Properties
+
+##### bottom
+
+> **bottom**: `number`
+
+安全区域右下角纵坐标
+
+##### height
+
+> **height**: `number`
+
+安全区域高度
+
+##### left
+
+> **left**: `number`
+
+安全区域左上角横坐标
+
+##### right
+
+> **right**: `number`
+
+安全区域右下角横坐标
+
+##### top
+
+> **top**: `number`
+
+安全区域左上角纵坐标
+
+##### width
+
+> **width**: `number`
+
+安全区域宽度
+
+<a id="getsystemsettingresult"></a>
+### GetSystemSettingResult
+
+#### Properties
+
+##### bluetoothEnabled
+
+> **bluetoothEnabled**: `boolean`
+
+蓝牙的系统开关
+
+##### deviceOrientation
+
+> **deviceOrientation**: [`DeviceOrientation`](#deviceorientation-1)
+
+设备方向
+
+##### locationEnabled
+
+> **locationEnabled**: `boolean`
+
+地理位置的系统开关
+
+##### wifiEnabled
+
+> **wifiEnabled**: `boolean`
+
+Wi-Fi 的系统开关
+
+<a id="deviceorientation-1"></a>
+<a id="deviceorientation"></a>
+### DeviceOrientation
+
+> **DeviceOrientation**: `"portrait"` \| `"landscape"`
+
+<a id="getappbaseinforesult"></a>
+### GetAppBaseInfoResult
+
+#### Properties
+
+##### SDKVersion?
+
+> `optional` **SDKVersion**: `string`
+
+客户端基础库版本
+
+##### enableDebug?
+
+> `optional` **enableDebug**: `boolean`
+
+是否已打开调试
+
+##### host?
+
+> `optional` **host**: [`AppBaseInfoHost`](#appbaseinfohost)
+
+当前豆包 App运行的宿主环境
+
+##### language
+
+> **language**: `string`
+
+当前语言
+
+##### theme?
+
+> `optional` **theme**: `"light"` \| `"dark"`
+
+当前主题
+
+##### version?
+
+> `optional` **version**: `string`
+
+宿主版本号
+
+<a id="appbaseinfohost"></a>
+### AppBaseInfoHost
+
+#### Properties
+
+##### appId
+
+> **appId**: `string`
+
+宿主 app 对应的 appId