@doubao-apps/create 0.0.25 → 0.0.27

package/dist/template-empty/.ai/reference/open-api.md

@@ -72,12 +72,18 @@
 
 Promise 对象，授权成功时会返回授权结果
 
+#### Remarks
+
+按 scope 申请授权。
+
 ***
 
 ### canIUse()
 
 > **canIUse**(`params`): `Promise`\<[`CanIUseResult`](doubao-apps-sdk-open-api.md#caniuseresult)\>
 
+检测当前宿主是否支持指定 API 或能力。
+
 #### Parameters
 
 • **params**: [`CanIUseParams`](doubao-apps-sdk-open-api.md#caniuseparams)
@@ -86,6 +92,10 @@ Promise 对象，授权成功时会返回授权结果
 
 `Promise`\<[`CanIUseResult`](doubao-apps-sdk-open-api.md#caniuseresult)\>
 
+#### Remarks
+
+用于兼容性判断。
+
 ***
 
 ### checkIsOpenAccessibility()
@@ -96,7 +106,7 @@ Promise 对象，授权成功时会返回授权结果
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -112,7 +122,7 @@ Promise 对象，授权成功时会返回授权结果
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -120,6 +130,22 @@ Promise 对象，授权成功时会返回授权结果
 
 ***
 
+### chooseImage()
+
+> **chooseImage**(`params`?): `Promise`\<[`ChooseImageResult`](doubao-apps-sdk-open-api.md#chooseimageresult)\>
+
+选择图片。
+
+#### Parameters
+
+• **params?**: [`ChooseImageParams`](doubao-apps-sdk-open-api.md#chooseimageparams)
+
+#### Returns
+
+`Promise`\<[`ChooseImageResult`](doubao-apps-sdk-open-api.md#chooseimageresult)\>
+
+***
+
 ### clearStorage()
 
 > **clearStorage**(`params`?): `Promise`\<`object`\>
@@ -234,12 +260,32 @@ closePage();
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+会关闭蓝牙模块。
+
+***
+
+### compressImage()
+
+> **compressImage**(`params`): `Promise`\<[`CompressImageResult`](doubao-apps-sdk-open-api.md#compressimageresult)\>
+
+压缩图片。
+
+#### Parameters
+
+• **params**: [`CompressImageParams`](doubao-apps-sdk-open-api.md#compressimageparams)
+
+#### Returns
+
+`Promise`\<[`CompressImageResult`](doubao-apps-sdk-open-api.md#compressimageresult)\>
+
 ***
 
 ### connectWifi()
@@ -256,6 +302,10 @@ closePage();
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+通常先调用 startWifi。
+
 ***
 
 ### createBLEConnection()
@@ -272,18 +322,110 @@ closePage();
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+需要传入 deviceId。
+
+***
+
+### disableAlertBeforeUnload()
+
+> **disableAlertBeforeUnload**(`params`?): `Promise`\<`object`\>
+
+关闭页面返回前提醒。
+
+#### Parameters
+
+• **params?**: `Record`\<`string`, `never`\>
+
+#### Returns
+
+`Promise`\<`object`\>
+
+***
+
+### dispatchActionDirective()
+
+> **dispatchActionDirective**(`params`): `Promise`\<`object`\>
+
+描述用户行为，约束模型行为及指定执行路径
+
+#### Parameters
+
+• **params**: [`DispatchActionDirectiveParams`](doubao-apps-sdk-open-api.md#dispatchactiondirectiveparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+***
+
+### enableAlertBeforeUnload()
+
+> **enableAlertBeforeUnload**(`params`): `Promise`\<`object`\>
+
+开启页面返回前提醒。
+当用户在小程序非最底层页面点击左上角返回按钮、左上角首页按钮或 Android 系统 back 键时,弹起询问弹窗
+
+返回询问对话框只会对调用的当前页面生效，通过手势滑动返回时不会弹起询问对话框
+
+#### Parameters
+
+• **params**: [`EnableAlertBeforeUnloadParams`](doubao-apps-sdk-open-api.md#enablealertbeforeunloadparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+配合 disableAlertBeforeUnload 使用。
+
 ***
 
 ### exitApp()
 
 > **exitApp**(): `Promise`\<`object`\>
 
-退去当前所有页面
+退出当前所有页面。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+会退出当前所有页面。
+
+***
+
+### expiredWidget()
+
+> **expiredWidget**(`__namedParameters`): `Promise`\<`object`\>
+
+更新过期的 widget 为固定卡片
+
+#### Parameters
+
+• **\_\_namedParameters**: [`ExpiredWidgetParams`](doubao-apps-sdk-open-api.md#expiredwidgetparams)
 
 #### Returns
 
 `Promise`\<`object`\>
 
+#### Description
+
+用于将状态已经过期的 widget 实例转换为固定的卡片
+
+#### Example
+
+```ts
+expiredWidget({
+  widgetInstanceId: 'instance_123',
+  schema: '${pageId}?key=value'
+});
+```
+
 ***
 
 ### getAccountInfo()
@@ -408,6 +550,10 @@ console.log(result.host?.appId, result.enableDebug);
 
 `Promise`\<[`GetBLEDeviceCharacteristicsResult`](doubao-apps-sdk-open-api.md#getbledevicecharacteristicsresult)\>
 
+#### Remarks
+
+通常先获取 BLE 服务列表。
+
 ***
 
 ### getBLEDeviceRSSI()
@@ -440,6 +586,10 @@ console.log(result.host?.appId, result.enableDebug);
 
 `Promise`\<[`GetBLEDeviceServicesResult`](doubao-apps-sdk-open-api.md#getbledeviceservicesresult)\>
 
+#### Remarks
+
+通常先调用 createBLEConnection。
+
 ***
 
 ### getBLEMTU()
@@ -466,7 +616,7 @@ console.log(result.host?.appId, result.enableDebug);
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -482,7 +632,7 @@ console.log(result.host?.appId, result.enableDebug);
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -498,7 +648,7 @@ console.log(result.host?.appId, result.enableDebug);
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -514,12 +664,16 @@ console.log(result.host?.appId, result.enableDebug);
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
 `Promise`\<[`GetBluetoothDevicesResult`](doubao-apps-sdk-open-api.md#getbluetoothdevicesresult)\>
 
+#### Remarks
+
+通常先调用 startBluetoothDevicesDiscovery。
+
 ***
 
 ### getClipboardData()
@@ -530,7 +684,7 @@ console.log(result.host?.appId, result.enableDebug);
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -570,19 +724,19 @@ console.log(result.host?.appId, result.enableDebug);
 
 ***
 
-### getHCEState()
+### getImageInfo()
 
-> **getHCEState**(`params`?): `Promise`\<`object`\>
+> **getImageInfo**(`params`): `Promise`\<[`GetImageInfoResult`](doubao-apps-sdk-open-api.md#getimageinforesult)\>
 
-获取 HCE 状态。
+获取图片信息。
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params**: [`GetImageInfoParams`](doubao-apps-sdk-open-api.md#getimageinfoparams)
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<[`GetImageInfoResult`](doubao-apps-sdk-open-api.md#getimageinforesult)\>
 
 ***
 
@@ -594,7 +748,7 @@ console.log(result.host?.appId, result.enableDebug);
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -628,6 +782,10 @@ console.log(result.host?.appId, result.enableDebug);
 
 如果调用失败（例如，用户拒绝权限、定位服务关闭等），则抛出此错误。
 
+#### Remarks
+
+可能涉及定位授权。
+
 #### Example
 
 ```typescript
@@ -652,6 +810,35 @@ fetchLocation();
 
 ***
 
+### getMenuButtonBoundingClientRect()
+
+> **getMenuButtonBoundingClientRect**(`params`?): [`MenuButtonBoundingClientRect`](doubao-apps-sdk-open-api.md#menubuttonboundingclientrect)
+
+获取菜单按钮的布局位置信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`MenuButtonBoundingClientRect`](doubao-apps-sdk-open-api.md#menubuttonboundingclientrect)
+
+返回菜单按钮相对屏幕左上角的坐标和尺寸，字段见 [MenuButtonBoundingClientRect](doubao-apps-sdk-open-api.md#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);
+```
+
+***
+
 ### getNetworkType()
 
 > **getNetworkType**(`params`?): `Promise`\<[`GetNetworkTypeResult`](doubao-apps-sdk-open-api.md#getnetworktyperesult)\>
@@ -683,21 +870,27 @@ console.log(result.networkType);
 
 > **getOrderPayment**(`params`): `Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
 
+查询订单支付结果。
+
 #### Parameters
 
 • **params**: [`GetOrderPaymentParams`](doubao-apps-sdk-open-api.md#getorderpaymentparams)
 
+订单支付查询参数。
+
 #### Returns
 
 `Promise`\<[`GetOrderPaymentResult`](doubao-apps-sdk-open-api.md#getorderpaymentresult)\>
 
+返回订单支付结果。
+
 ***
 
 ### getPrivacySetting()
 
 > **getPrivacySetting**(`params`?): `Promise`\<[`PrivacySettingResult`](doubao-apps-sdk-open-api.md#privacysettingresult)\>
 
-Get privacy setting information
+获取隐私设置状态。
 
 #### Parameters
 
@@ -707,7 +900,7 @@ Get privacy setting information
 
 `Promise`\<[`PrivacySettingResult`](doubao-apps-sdk-open-api.md#privacysettingresult)\>
 
-Returns a Promise containing privacy setting information
+返回隐私设置状态。
 
 ***
 
@@ -751,7 +944,7 @@ Returns a Promise containing privacy setting information
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -781,6 +974,8 @@ Returns a Promise containing privacy setting information
 
 返回一个 Promise，解析为 [GetStorageResult](doubao-apps-sdk-open-api.md#getstorageresulttdata)。
 
+#### Remarks
+
 #### Example
 
 ```typescript
@@ -873,6 +1068,8 @@ console.log(result.keys, result.currentSize, result.limitSize);
 
 返回 [GetStorageResult](doubao-apps-sdk-open-api.md#getstorageresulttdata)。
 
+#### Remarks
+
 #### Example
 
 ```typescript
@@ -887,6 +1084,35 @@ console.log(result.data.name, result.data.age);
 
 ***
 
+### getSystemSetting()
+
+> **getSystemSetting**(`params`?): [`GetSystemSettingResult`](doubao-apps-sdk-open-api.md#getsystemsettingresult)
+
+获取设备设置。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`GetSystemSettingResult`](doubao-apps-sdk-open-api.md#getsystemsettingresult)
+
+返回蓝牙、定位、Wi-Fi 系统开关和设备方向等字段，见 [GetSystemSettingResult](doubao-apps-sdk-open-api.md#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);
+```
+
+***
+
 ### getWifiList()
 
 > **getWifiList**(`params`?): `Promise`\<[`GetWifiListResult`](doubao-apps-sdk-open-api.md#getwifilistresult)\>
@@ -895,12 +1121,16 @@ console.log(result.data.name, result.data.age);
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
 `Promise`\<[`GetWifiListResult`](doubao-apps-sdk-open-api.md#getwifilistresult)\>
 
+#### Remarks
+
+通常先调用 startWifi。
+
 ***
 
 ### getWindowInfo()
@@ -969,7 +1199,39 @@ console.log(result.safeArea?.top, result.screenTop);
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+***
+
+### hideLoading()
+
+> **hideLoading**(`params`?): `Promise`\<`object`\>
+
+隐藏当前 loading。
+
+#### Parameters
+
+• **params?**: [`HideInteractionParams`](doubao-apps-sdk-open-api.md#hideinteractionparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+***
+
+### hideToast()
+
+> **hideToast**(`params`?): `Promise`\<`object`\>
+
+隐藏当前 Toast。
+
+#### Parameters
+
+• **params?**: [`HideInteractionParams`](doubao-apps-sdk-open-api.md#hideinteractionparams)
 
 #### Returns
 
@@ -997,19 +1259,19 @@ console.log(result.safeArea?.top, result.screenTop);
 
 > **login**(`params`?): `Promise`\<[`LoginResult`](doubao-apps-sdk-open-api.md#loginresult)\>
 
-Initiate login
+发起登录并获取登录凭证。
 
 #### Parameters
 
 • **params?**: [`LoginRequest`](doubao-apps-sdk-open-api.md#loginrequest)
 
-Login parameters
+登录参数。
 
 #### Returns
 
 `Promise`\<[`LoginResult`](doubao-apps-sdk-open-api.md#loginresult)\>
 
-Returns a Promise containing the login credential code
+返回包含登录凭证 code 的 Promise。
 
 ***
 
@@ -1017,19 +1279,19 @@ Returns a Promise containing the login credential code
 
 > **loginWithDoubaoWidget**(`params`): `Promise`\<[`LoginWithWidgetResult`](doubao-apps-sdk-open-api.md#loginwithwidgetresult)\>
 
-Initiate login
+发起豆包 Widget 登录。
 
 #### Parameters
 
 • **params**: [`LoginWithWidgetRequest`](doubao-apps-sdk-open-api.md#loginwithwidgetrequest)
 
-Login parameters
+Widget 登录参数。
 
 #### Returns
 
 `Promise`\<[`LoginWithWidgetResult`](doubao-apps-sdk-open-api.md#loginwithwidgetresult)\>
 
-Returns a Promise containing the login credential code
+返回登录结果。
 
 ***
 
@@ -1111,13 +1373,17 @@ Returns a Promise containing the login credential code
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+订阅指定特征值变化。
+
 ***
 
-### onKeyboardHeightChange()
+### onAccelerometerChange()
 
-> **onKeyboardHeightChange**(`handler`): () => `void`
+> **onAccelerometerChange**(`handler`): () => `void`
 
-监听键盘高度变化事件。
+监听加速度数据变化事件。
 
 #### Parameters
 
@@ -1127,92 +1393,315 @@ Returns a Promise containing the login credential code
 
 `Function`
 
+返回取消当前监听函数的函数。
+
 ##### Returns
 
 `void`
 
 #### Example
 
-```typescript
-import { onKeyboardHeightChange } from '@doubao-apps/framework/api';
+```ts
+import { onAccelerometerChange } from '@doubao-apps/framework/api';
 
-const unsubscribe = onKeyboardHeightChange(({ height }) => {
-  console.log('Keyboard height change event:', { height });
+const off = onAccelerometerChange(({ x, y, z, timestamp }) => {
+  console.log(x, y, z, timestamp);
 });
+
+off();
 ```
 
 ***
 
-### openApp()
-
-> **openApp**(`params`): `Promise`\<[`OpenAppResult`](doubao-apps-sdk-open-api.md#openappresult)\>
-
-Open an external application using a deep link with fallbacks.
+### onBatteryInfoChange()
 
-Params (see OpenAppRequest):
-- uri: required deep link URI to open.
-- targetPackage?: preferred Android package name.
-- fallbackUrl?: URL to open via market or browser when deep link fails.
+> **onBatteryInfoChange**(`handler`): () => `void`
 
-Returns a Promise that resolves with an execution status and optional message.
+监听电池信息变化事件。
 
 #### Parameters
 
-• **params**: [`OpenAppRequest`](doubao-apps-sdk-open-api.md#openapprequest)
+• **handler**
 
 #### Returns
 
-`Promise`\<[`OpenAppResult`](doubao-apps-sdk-open-api.md#openappresult)\>
-
-***
+`Function`
 
-### openBluetoothAdapter()
+返回取消当前监听函数的函数。
 
-> **openBluetoothAdapter**(`params`?): `Promise`\<`object`\>
+##### Returns
 
-打开蓝牙适配器。
+`void`
 
-#### Parameters
+#### Example
 
-• **params?**: [`OpenBluetoothAdapterParams`](doubao-apps-sdk-open-api.md#openbluetoothadapterparams)
+```ts
+import { onBatteryInfoChange } from '@doubao-apps/framework/api';
 
-#### Returns
+const off = onBatteryInfoChange(({ isLowPowerModeEnabled }) => {
+  console.log(isLowPowerModeEnabled);
+});
 
-`Promise`\<`object`\>
+off();
+```
 
 ***
 
-### postLoginResult()
+### onCompassChange()
 
-> **postLoginResult**(`params`): `Promise`\<`object`\>
+> **onCompassChange**(`handler`): () => `void`
 
-Report MCP authorization login credential
+监听罗盘数据变化事件。
 
 #### Parameters
 
-• **params**: [`PostLoginResultRequest`](doubao-apps-sdk-open-api.md#postloginresultrequest)
-
-Post login result parameters
+• **handler**
 
 #### Returns
 
-`Promise`\<`object`\>
-
-Returns a Promise that resolves when the report is successful
+`Function`
 
-***
+返回取消当前监听函数的函数。
 
-### reLaunch()
+##### Returns
 
-> **reLaunch**(`params`): `Promise`\<`object`\>
+`void`
 
-#### Parameters
+#### Example
 
-• **params**: [`NavigateToParams`](doubao-apps-sdk-open-api.md#navigatetoparams)
+```ts
+import { onCompassChange } from '@doubao-apps/framework/api';
 
-#### Returns
+const off = onCompassChange(({ direction }) => {
+  console.log(direction);
+});
 
-`Promise`\<`object`\>
+off();
+```
+
+***
+
+### onGyroscopeChange()
+
+> **onGyroscopeChange**(`handler`): () => `void`
+
+监听陀螺仪数据变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onGyroscopeChange } from '@doubao-apps/framework/api';
+
+const off = onGyroscopeChange(({ x, y, z, timestamp }) => {
+  console.log(x, y, z, timestamp);
+});
+
+off();
+```
+
+***
+
+### onKeyboardHeightChange()
+
+> **onKeyboardHeightChange**(`handler`): () => `void`
+
+监听键盘高度变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+##### Returns
+
+`void`
+
+#### Example
+
+```typescript
+import { onKeyboardHeightChange } from '@doubao-apps/framework/api';
+
+const unsubscribe = onKeyboardHeightChange(({ height }) => {
+  console.log('Keyboard height change event:', { height });
+});
+```
+
+***
+
+### onNetworkStatusChange()
+
+> **onNetworkStatusChange**(`handler`): () => `void`
+
+监听网络状态变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onNetworkStatusChange } from '@doubao-apps/framework/api';
+
+const off = onNetworkStatusChange(({ isConnected, networkType }) => {
+  console.log(isConnected, networkType);
+});
+
+off();
+```
+
+***
+
+### onUserCaptureScreen()
+
+> **onUserCaptureScreen**(`handler`): () => `void`
+
+监听用户主动截屏事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onUserCaptureScreen } from '@doubao-apps/framework/api';
+
+const off = onUserCaptureScreen(() => {
+  console.log('用户截屏了');
+});
+
+off();
+```
+
+***
+
+### openApp()
+
+> **openApp**(`params`): `Promise`\<[`OpenAppResult`](doubao-apps-sdk-open-api.md#openappresult)\>
+
+通过 deep link 等方式打开外部应用。
+
+#### Parameters
+
+• **params**: [`OpenAppRequest`](doubao-apps-sdk-open-api.md#openapprequest)
+
+外部应用打开参数。
+
+#### Returns
+
+`Promise`\<[`OpenAppResult`](doubao-apps-sdk-open-api.md#openappresult)\>
+
+返回外部应用打开结果。
+
+***
+
+### openBluetoothAdapter()
+
+> **openBluetoothAdapter**(`params`?): `Promise`\<`object`\>
+
+打开蓝牙适配器。
+
+#### Parameters
+
+• **params?**: [`OpenBluetoothAdapterParams`](doubao-apps-sdk-open-api.md#openbluetoothadapterparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+蓝牙流程入口。
+
+***
+
+### postLoginResult()
+
+> **postLoginResult**(`params`): `Promise`\<`object`\>
+
+回传 MCP 授权登录凭证。
+
+#### Parameters
+
+• **params**: [`PostLoginResultRequest`](doubao-apps-sdk-open-api.md#postloginresultrequest)
+
+登录结果回传参数。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回回传完成的 Promise。
+
+***
+
+### previewImage()
+
+> **previewImage**(`params`): `Promise`\<`object`\>
+
+预览图片。
+
+#### Parameters
+
+• **params**: [`PreviewImageParams`](doubao-apps-sdk-open-api.md#previewimageparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+***
+
+### reLaunch()
+
+> **reLaunch**(`params`): `Promise`\<`object`\>
+
+关闭所有页面并跳转到应用内页面。
+
+#### Parameters
+
+• **params**: [`NavigateToParams`](doubao-apps-sdk-open-api.md#navigatetoparams)
+
+#### Returns
+
+`Promise`\<`object`\>
 
 ***
 
@@ -1230,6 +1719,10 @@ Returns a Promise that resolves when the report is successful
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+需要传入 serviceId 和 characteristicId。
+
 ***
 
 ### redirectTo()
@@ -1322,6 +1815,10 @@ removeStorageSync({ key: 'profile' });
 
 返回一个 Promise，解析为 [RequestResponse](doubao-apps-sdk-open-api.md#requestresponse)。
 
+#### Remarks
+
+返回 statusCode、header 和 data。
+
 #### Example
 
 ```typescript
@@ -1344,45 +1841,63 @@ console.log(result.statusCode, result.data);
 
 > **requestOrder**(`params`): `Promise`\<[`RequestOrderResult`](doubao-apps-sdk-open-api.md#requestorderresult)\>
 
+发起订单支付流程。
+
 #### Parameters
 
 • **params**: [`RequestOrderParams`](doubao-apps-sdk-open-api.md#requestorderparams)
 
+订单支付请求参数。
+
 #### Returns
 
 `Promise`\<[`RequestOrderResult`](doubao-apps-sdk-open-api.md#requestorderresult)\>
 
+返回订单支付请求结果。
+
 ***
 
-### scanCode()
+### saveImageToPhotosAlbum()
 
-> **scanCode**(`params`?): `Promise`\<[`ScanCodeResult`](doubao-apps-sdk-open-api.md#scancoderesult)\>
+> **saveImageToPhotosAlbum**(`params`): `Promise`\<`object`\>
 
-调起扫码能力。
+保存图片到系统相册。
+
+需要先确保应用已具备写入系统相册的权限。
 
 #### Parameters
 
-• **params?**: [`ScanCodeParams`](doubao-apps-sdk-open-api.md#scancodeparams)
+• **params**: [`SaveImageToPhotosAlbumParams`](doubao-apps-sdk-open-api.md#saveimagetophotosalbumparams)
 
 #### Returns
 
-`Promise`\<[`ScanCodeResult`](doubao-apps-sdk-open-api.md#scancoderesult)\>
+`Promise`\<`object`\>
+
+#### Example
+
+```typescript
+import { saveImageToPhotosAlbum } from '@doubao-apps/framework/api';
+
+await saveImageToPhotosAlbum({
+  filePath: '/path/to/image.png'
+});
+```
 
 ***
 
-### sendHCEMessage()
+### scanCode()
 
-> **sendHCEMessage**(`params`): `Promise`\<`object`\>
+> **scanCode**(`params`?): `Promise`\<[`ScanCodeResult`](doubao-apps-sdk-open-api.md#scancoderesult)\>
 
-发送 HCE 消息。
+调起扫码能力。
 
 #### Parameters
 
-• **params**: [`SendHCEMessageParams`](doubao-apps-sdk-open-api.md#sendhcemessageparams)
+• **params?**: [`ScanCodeParams`](doubao-apps-sdk-open-api.md#scancodeparams)
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<[`ScanCodeResult`](doubao-apps-sdk-open-api.md#scancoderesult)\>
 
 ***
 
@@ -1447,20 +1962,16 @@ await sendSms({
 
 #### Parameters
 
-• **params**
-
-• **params.additionalContext**: `string`
-
-上下文内容
-
-• **params.botId?**: `string`
-
-指定 bot id
+• **params**: [`SetAdditionalContextParams`](doubao-apps-sdk-open-api.md#setadditionalcontextparams)
 
 #### Returns
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+设置全局上下文。
+
 ***
 
 ### setBLEMTU()
@@ -1549,6 +2060,8 @@ await sendSms({
 
 返回一个 Promise，写入完成后 resolve。
 
+#### Remarks
+
 #### Example
 
 ```typescript
@@ -1584,6 +2097,8 @@ await setStorage({
 
 同步写入完成后返回。
 
+#### Remarks
+
 #### Example
 
 ```typescript
@@ -1611,6 +2126,10 @@ setStorageSync({
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+控制截屏或录屏时的视觉效果。
+
 ***
 
 ### setWifiList()
@@ -1627,6 +2146,91 @@ setStorageSync({
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+用于预设 Wi-Fi 列表。
+
+***
+
+### showActionSheet()
+
+> **showActionSheet**(`params`): `Promise`\<[`ShowActionSheetResult`](doubao-apps-sdk-open-api.md#showactionsheetresult)\>
+
+显示操作菜单。
+
+#### Parameters
+
+• **params**: [`ShowActionSheetParams`](doubao-apps-sdk-open-api.md#showactionsheetparams)
+
+#### Returns
+
+`Promise`\<[`ShowActionSheetResult`](doubao-apps-sdk-open-api.md#showactionsheetresult)\>
+
+#### Example
+
+```ts
+import { showActionSheet } from '@doubao-apps/framework/api';
+
+const result = await showActionSheet({
+  itemList: ['编辑', '删除']
+});
+
+console.log(result.tapIndex);
+```
+
+***
+
+### showLoading()
+
+> **showLoading**(`params`?): `Promise`\<`object`\>
+
+显示 loading 提示框。
+
+#### Parameters
+
+• **params?**: [`ShowLoadingParams`](doubao-apps-sdk-open-api.md#showloadingparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需调用 hideLoading 关闭。
+
+***
+
+### showModal()
+
+> **showModal**(`params`): `Promise`\<[`ShowModalResult`](doubao-apps-sdk-open-api.md#showmodalresult)\>
+
+显示模态对话框。
+
+#### Parameters
+
+• **params**: [`ShowModalParams`](doubao-apps-sdk-open-api.md#showmodalparams)
+
+#### Returns
+
+`Promise`\<[`ShowModalResult`](doubao-apps-sdk-open-api.md#showmodalresult)\>
+
+#### Example
+
+```ts
+import { showModal } from '@doubao-apps/framework/api';
+
+const result = await showModal({
+  title: '提示',
+  content: '确认删除这条记录吗？',
+  confirmText: '删除',
+  cancelText: '取消'
+});
+
+if (result.action === 'confirm') {
+  console.log('用户确认删除');
+}
+```
+
 ***
 
 ### showToast()
@@ -1652,6 +2256,10 @@ setStorageSync({
 
 返回一个 Promise，在 Toast 显示结束时 resolve。
 
+#### Remarks
+
+duration 和 icon 可控制提示表现。
+
 #### Example
 
 ```typescript
@@ -1691,6 +2299,10 @@ showToast({
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+需配对调用 stopAccelerometer。
+
 ***
 
 ### startBeaconDiscovery()
@@ -1707,6 +2319,10 @@ showToast({
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+需配对调用 stopBeaconDiscovery。
+
 ***
 
 ### startBluetoothDevicesDiscovery()
@@ -1723,6 +2339,10 @@ showToast({
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+通常先调用 openBluetoothAdapter。
+
 ***
 
 ### startCompass()
@@ -1733,12 +2353,16 @@ showToast({
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+需配对调用 stopCompass。
+
 ***
 
 ### startDeviceMotionListening()
@@ -1755,6 +2379,10 @@ showToast({
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+需配对调用 stopDeviceMotionListening。
+
 ***
 
 ### startGyroscope()
@@ -1771,21 +2399,9 @@ showToast({
 
 `Promise`\<`object`\>
 
-***
-
-### startHCE()
+#### Remarks
 
-> **startHCE**(`params`): `Promise`\<`object`\>
-
-开启 HCE。
-
-#### Parameters
-
-• **params**: [`StartHCEParams`](doubao-apps-sdk-open-api.md#starthceparams)
-
-#### Returns
-
-`Promise`\<`object`\>
+需配对调用 stopGyroscope。
 
 ***
 
@@ -1797,12 +2413,16 @@ showToast({
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+Wi-Fi 流程入口。
+
 ***
 
 ### stopAccelerometer()
@@ -1813,7 +2433,7 @@ showToast({
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -1829,7 +2449,7 @@ showToast({
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -1845,7 +2465,7 @@ showToast({
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -1861,7 +2481,7 @@ showToast({
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -1877,7 +2497,7 @@ showToast({
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -1893,7 +2513,7 @@ showToast({
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -1901,15 +2521,15 @@ showToast({
 
 ***
 
-### stopHCE()
+### stopWifi()
 
-> **stopHCE**(`params`?): `Promise`\<`object`\>
+> **stopWifi**(`params`?): `Promise`\<`object`\>
 
-停止 HCE。
+关闭 Wi-Fi 模块。
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -1917,15 +2537,15 @@ showToast({
 
 ***
 
-### stopWifi()
+### updateModelContext()
 
-> **stopWifi**(`params`?): `Promise`\<`object`\>
+> **updateModelContext**(`params`?): `Promise`\<`object`\>
 
-关闭 Wi-Fi 模块。
+向 Agent 捐赠上下文
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**: [`UpdateModelContextParams`](doubao-apps-sdk-open-api.md#updatemodelcontextparams)
 
 #### Returns
 
@@ -1933,15 +2553,15 @@ showToast({
 
 ***
 
-### updateModelContext()
+### updateWidget()
 
-> **updateModelContext**(`params`?): `Promise`\<`object`\>
+> **updateWidget**(`params`): `Promise`\<`object`\>
 
-前端数据捐献接口：上报当前业务状态/关键信息（blocks）。
+更新指定卡片
 
 #### Parameters
 
-• **params?**: [`UpdateModelContextOptions`](doubao-apps-sdk-open-api.md#updatemodelcontextoptions)
+• **params**: [`UpdateWidgetParams`](doubao-apps-sdk-open-api.md#updatewidgetparams)
 
 #### Returns
 
@@ -1957,7 +2577,7 @@ showToast({
 
 #### Parameters
 
-• **params?**: `Record`\<`string`, `never`\>
+• **params?**
 
 #### Returns
 
@@ -1995,8 +2615,68 @@ showToast({
 
 `Promise`\<`object`\>
 
+#### Remarks
+
+value 需要是 ArrayBuffer。
+
+## Enumerations
+
+### ActionDirectiveType
+
+#### Enumeration Members
+
+##### BUTTON\_CLICK
+
+> **BUTTON\_CLICK**: `"button_click"`
+
+按钮点击
+
+##### FORM\_SUBMIT
+
+> **FORM\_SUBMIT**: `"form_submit"`
+
+表单提交（复杂的信息提交场景）
+
+##### OPTION\_SELECT
+
+> **OPTION\_SELECT**: `"option_select"`
+
+选择（下拉列表场景）
+
 ## Interfaces
 
+### AccelerometerChangeEvent
+
+加速度数据变化事件。
+
+#### Properties
+
+##### timestamp
+
+> **timestamp**: `number`
+
+数据采集时间戳，单位纳秒。
+
+##### x
+
+> **x**: `number`
+
+X 轴加速度，单位 m/s²。
+
+##### y
+
+> **y**: `number`
+
+Y 轴加速度，单位 m/s²。
+
+##### z
+
+> **z**: `number`
+
+Z 轴加速度，单位 m/s²。
+
+***
+
 ### AddPhoneCalendarParams
 
 添加系统日历事件的请求参数。
@@ -2385,6 +3065,20 @@ showToast({
 
 ***
 
+### BatteryInfoChangeEvent
+
+电池信息变化事件。
+
+#### Properties
+
+##### isLowPowerModeEnabled
+
+> **isLowPowerModeEnabled**: `boolean`
+
+是否处于省电模式。
+
+***
+
 ### BeaconInfo
 
 iBeacon 设备信息。
@@ -2583,75 +3277,297 @@ RSSI 信号强度，单位 dBm。
 
 #### Properties
 
-##### result
+##### result
+
+> **result**: `boolean`
+
+***
+
+### CheckIsOpenAccessibilityResult
+
+无障碍能力检测结果。
+
+#### Properties
+
+##### open
+
+> **open**: `boolean`
+
+是否开启视觉无障碍能力。
+
+***
+
+### ChooseContactResult
+
+选取联系人后的返回结果。
+
+#### Properties
+
+##### displayName
+
+> **displayName**: `string`
+
+联系人名称。
+
+##### phoneNumber
+
+> **phoneNumber**: `string`
+
+选中的手机号。
+
+##### phoneNumberList
+
+> **phoneNumberList**: `string`[]
+
+联系人所有手机号。
+
+***
+
+### ChooseImageFile
+
+选择图片返回的单个文件信息。
+
+#### Properties
+
+##### originalFileObj?
+
+> `optional` **originalFileObj**: `File`
+
+原始浏览器 File 对象。
+
+##### path
+
+> **path**: `string`
+
+本地临时文件路径。
+
+##### size
+
+> **size**: `number`
+
+文件大小，单位 B。
+
+##### type?
+
+> `optional` **type**: `string`
+
+文件 MIME 类型。
+
+***
+
+### ChooseImageParams
+
+选择图片的请求参数。
+
+#### Properties
+
+##### count?
+
+> `optional` **count**: `number`
+
+最多可选图片张数。
+
+##### imageId?
+
+> `optional` **imageId**: `string`
+
+H5 场景下可复用的 input 元素 ID。
+
+##### sizeType?
+
+> `optional` **sizeType**: [`ChooseImageSizeType`](doubao-apps-sdk-open-api.md#chooseimagesizetype)[]
+
+允许返回的图片尺寸类型。
+
+##### sourceType?
+
+> `optional` **sourceType**: [`ChooseImageSourceType`](doubao-apps-sdk-open-api.md#chooseimagesourcetype)[]
+
+允许选择的图片来源。
+
+***
+
+### ChooseImageResult
+
+选择图片结果。
+
+#### Properties
+
+##### tempFilePaths
+
+> **tempFilePaths**: `string`[]
+
+图片临时文件路径列表。
+
+##### tempFiles
+
+> **tempFiles**: [`ChooseImageFile`](doubao-apps-sdk-open-api.md#chooseimagefile)[]
+
+图片临时文件信息列表。
+
+***
+
+### ChooseMessageFile
+
+选择消息文件返回的单个文件信息。
+
+#### Properties
+
+##### name
+
+> **name**: `string`
+
+文件名称。
+
+##### path
+
+> **path**: `string`
+
+本地临时文件路径。
+
+##### size
+
+> **size**: `number`
+
+文件大小，单位 B。
+
+##### time
+
+> **time**: `number`
+
+会话发送时间，Unix 时间戳。
+
+##### type
+
+> **type**: [`SelectedMessageFileType`](doubao-apps-sdk-open-api.md#selectedmessagefiletype)
+
+文件类型。
+
+***
+
+### ChooseMessageFileParams
+
+选择消息文件的请求参数。
+
+#### Properties
+
+##### count
+
+> **count**: `number`
+
+最多可选文件个数。
+
+##### extension?
+
+> `optional` **extension**: `string`[]
+
+基于文件扩展名的过滤条件，仅在 `type` 为 `file` 时生效。
+
+##### type?
+
+> `optional` **type**: [`ChooseMessageFileType`](doubao-apps-sdk-open-api.md#choosemessagefiletype)
+
+允许选择的文件类型。
+
+***
+
+### ChooseMessageFileResult
+
+选择消息文件结果。
+
+#### Properties
+
+##### tempFiles
+
+> **tempFiles**: [`ChooseMessageFile`](doubao-apps-sdk-open-api.md#choosemessagefile)[]
+
+本地临时文件对象数组。
+
+***
+
+### CloseBLEConnectionParams
+
+关闭 BLE 连接的请求参数。
+
+#### Properties
+
+##### deviceId
+
+> **deviceId**: `string`
+
+蓝牙设备 ID。
+
+***
+
+### CloseParams
+
+#### Properties
+
+##### containerID?
+
+> `optional` **containerID**: `string`
 
-> **result**: `boolean`
+指定一个要关闭的页面
 
 ***
 
-### CheckIsOpenAccessibilityResult
+### CompassChangeEvent
 
-无障碍能力检测结果。
+罗盘数据变化事件。
 
 #### Properties
 
-##### open
+##### direction
 
-> **open**: `boolean`
+> **direction**: `number`
 
-是否开启视觉无障碍能力。
+面对的方向度数，范围 0 到 360。
 
 ***
 
-### ChooseContactResult
+### CompressImageParams
 
-选取联系人后的返回结果。
+压缩图片的请求参数。
 
 #### Properties
 
-##### displayName
-
-> **displayName**: `string`
-
-联系人名称。
-
-##### phoneNumber
-
-> **phoneNumber**: `string`
+##### compressedHeight?
 
-选中的手机号。
+> `optional` **compressedHeight**: `number`
 
-##### phoneNumberList
+压缩后图片高度，单位 px。
 
-> **phoneNumberList**: `string`[]
+##### compressedWidth?
 
-联系人所有手机号。
+> `optional` **compressedWidth**: `number`
 
-***
+压缩后图片宽度，单位 px。
 
-### CloseBLEConnectionParams
+##### quality?
 
-关闭 BLE 连接的请求参数。
+> `optional` **quality**: `number`
 
-#### Properties
+压缩质量，范围 0 - 100，仅对 jpg 生效。
 
-##### deviceId
+##### src
 
-> **deviceId**: `string`
+> **src**: `string`
 
-蓝牙设备 ID。
+图片路径。
 
 ***
 
-### CloseParams
+### CompressImageResult
+
+压缩图片结果。
 
 #### Properties
 
-##### containerID?
+##### tempFilePath
 
-> `optional` **containerID**: `string`
+> **tempFilePath**: `string`
 
-指定一个要关闭的页面
+压缩后图片的临时文件路径。
 
 ***
 
@@ -2733,6 +3649,30 @@ Wi-Fi SSID。
 
 ***
 
+### DispatchActionDirectiveParams
+
+#### Properties
+
+##### actionDescribe
+
+> **actionDescribe**: `string`
+
+自然语言描述，例如：用户点击支付按钮并完成话费支付
+
+##### actionType
+
+> **actionType**: [`ActionDirectiveType`](doubao-apps-sdk-open-api.md#actiondirectivetype)
+
+动作类型，参见 [ActionDirectiveType](doubao-apps-sdk-open-api.md#actiondirectivetype)
+
+##### widgetInstanceId
+
+> **widgetInstanceId**: `string`
+
+会话消息关联的卡片ID
+
+***
+
 ### DoubaoAppAccountInfo
 
 豆包 App 账号信息。
@@ -2763,6 +3703,38 @@ Wi-Fi SSID。
 
 ***
 
+### EnableAlertBeforeUnloadParams
+
+开启返回前提醒的参数。
+
+#### Properties
+
+##### message
+
+> **message**: `string`
+
+返回前确认弹窗的文案。
+
+***
+
+### ExpiredWidgetParams
+
+#### Properties
+
+##### schema?
+
+> `optional` **schema**: `string`
+
+点击失效卡要跳转的页面 schema，格式与 navigateTo 的 url 相同
+
+##### widgetInstanceId
+
+> **widgetInstanceId**: `string`
+
+卡片实例 ID，在卡片环境通过getWidgetInstanceId来获取，其他环境（比如页面）需要通过传参或通信的方式传递过去
+
+***
+
 ### GetAccountInfoResult
 
 获取当前账号信息。
@@ -3087,6 +4059,58 @@ RSSI 信号强度，单位 dBm。
 
 ***
 
+### GetImageInfoParams
+
+获取图片信息的请求参数。
+
+#### Properties
+
+##### src
+
+> **src**: `string`
+
+图片路径，可以是相对路径、临时文件路径、存储文件路径或网络图片路径。
+
+***
+
+### GetImageInfoResult
+
+图片信息结果。
+
+#### Properties
+
+##### height
+
+> **height**: `number`
+
+图片原始高度，单位 px，不考虑旋转。
+
+##### orientation
+
+> **orientation**: [`ImageOrientation`](doubao-apps-sdk-open-api.md#imageorientation)
+
+图片方向。
+
+##### path
+
+> **path**: `string`
+
+图片的本地路径。
+
+##### type
+
+> **type**: `string`
+
+图片格式。
+
+##### width
+
+> **width**: `number`
+
+图片原始宽度，单位 px，不考虑旋转。
+
+***
+
 ### GetLocalIPAddressResult
 
 获取局域网 IP 的返回结果。
@@ -3198,7 +4222,7 @@ RSSI 信号强度，单位 dBm。
 
 ##### networkType
 
-> **networkType**: [`NetworkType`](doubao-apps-sdk-open-api.md#networktype-1)
+> **networkType**: [`NetworkType`](doubao-apps-sdk-open-api.md#networktype-2)
 
 当前网络类型。
 
@@ -3352,6 +4376,36 @@ key 对应的数据
 
 ***
 
+### GetSystemSettingResult
+
+#### Properties
+
+##### bluetoothEnabled
+
+> **bluetoothEnabled**: `boolean`
+
+蓝牙的系统开关
+
+##### deviceOrientation
+
+> **deviceOrientation**: [`DeviceOrientation`](doubao-apps-sdk-open-api.md#deviceorientation-1)
+
+设备方向
+
+##### locationEnabled
+
+> **locationEnabled**: `boolean`
+
+地理位置的系统开关
+
+##### wifiEnabled
+
+> **wifiEnabled**: `boolean`
+
+Wi-Fi 的系统开关
+
+***
+
 ### GetWifiListResult
 
 获取 Wi-Fi 列表的返回结果。
@@ -3420,6 +4474,44 @@ key 对应的数据
 
 ***
 
+### GyroscopeChangeEvent
+
+陀螺仪数据变化事件。
+
+#### Properties
+
+##### timestamp
+
+> **timestamp**: `number`
+
+数据采集时间戳，单位纳秒。
+
+##### x
+
+> **x**: `number`
+
+绕 X 轴旋转的角速度，单位 rad/s。
+
+##### y
+
+> **y**: `number`
+
+绕 Y 轴旋转的角速度，单位 rad/s。
+
+##### z
+
+> **z**: `number`
+
+绕 Z 轴旋转的角速度，单位 rad/s。
+
+***
+
+### HideInteractionParams
+
+隐藏交互提示框的公共参数。
+
+***
+
 ### IsBluetoothDevicePairedParams
 
 查询蓝牙设备配对状态的请求参数。
@@ -3476,7 +4568,7 @@ Login credential code
 
 ##### loginType
 
-> **loginType**: `LoginType`
+> **loginType**: [`LoginType`](doubao-apps-sdk-open-api.md#logintype-1)
 
 Login type identifier
 
@@ -3532,6 +4624,50 @@ Whether the login is successful
 
 ***
 
+### 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。
+
+***
+
 ### NavigateBackParams
 
 #### Properties
@@ -3556,6 +4692,26 @@ Whether the login is successful
 
 ***
 
+### NetworkStatusChangeEvent
+
+网络状态变化事件。
+
+#### Properties
+
+##### isConnected
+
+> **isConnected**: `boolean`
+
+当前是否有可用网络连接。
+
+##### networkType
+
+> **networkType**: [`NetworkType`](doubao-apps-sdk-open-api.md#networktype-2)
+
+当前网络类型。
+
+***
+
 ### NotifyBLECharacteristicValueChangeParams
 
 订阅 BLE 特征值变化的请求参数。
@@ -3658,27 +4814,117 @@ Execution status from client
 
 ##### version
 
-> **version**: `string`
+> **version**: `string`
+
+插件版本号，'a.b.c' 形式
+
+***
+
+### 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
+
+***
+
+### PreviewImageParams
+
+预览图片的请求参数。
+
+#### Properties
+
+##### current?
+
+> `optional` **current**: `string` \| `number`
+
+当前显示图片的链接，或当前显示图片的下标，不填则默认为 urls 中的第一张
+
+##### referrerPolicy?
+
+> `optional` **referrerPolicy**: `string`
+
+预览页使用的 Referrer 策略。
+
+##### showmenu?
+
+> `optional` **showmenu**: `boolean`
+
+是否显示长按菜单，菜单支持保存图片至本地相册
+
+##### urls
+
+> **urls**: `string`[]
+
+需要预览的图片链接列表。
+
+***
+
+### PreviewMediaParams
+
+预览图片和视频的请求参数。
+
+#### Properties
+
+##### current?
+
+> `optional` **current**: `number`
+
+当前显示资源的下标。
+
+##### referrerPolicy?
+
+> `optional` **referrerPolicy**: `string`
+
+预览页使用的 Referrer 策略。
+
+##### showmenu?
+
+> `optional` **showmenu**: `boolean`
+
+是否显示长按菜单。
+
+##### sources
+
+> **sources**: [`PreviewMediaSource`](doubao-apps-sdk-open-api.md#previewmediasource)[]
 
-插件版本号，'a.b.c' 形式
+需要预览的资源列表。
 
 ***
 
-### PostLoginResultRequest
+### PreviewMediaSource
+
+预览媒体资源项。
 
 #### Properties
 
-##### code?
+##### poster?
 
-> `optional` **code**: `string`
+> `optional` **poster**: `string`
 
-Authorization login credential, valid when login result is true
+视频封面图地址。
 
-##### result
+##### type?
 
-> **result**: `boolean`
+> `optional` **type**: `"image"` \| `"video"`
 
-Login result, true means success, false means failure
+资源类型。
+
+##### url
+
+> **url**: `string`
+
+图片或视频的地址。
 
 ***
 
@@ -3768,7 +5014,7 @@ Whether user authorization for privacy agreement is required
 
 ##### data?
 
-> `optional` **data**: `string` \| `ArrayBuffer` \| `Record`\<`string`, `any`\>
+> `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
 
 请求体数据。
 
@@ -3833,7 +5079,7 @@ Whether user authorization for privacy agreement is required
 
 ##### data?
 
-> `optional` **data**: `string` \| `ArrayBuffer` \| `Record`\<`string`, `any`\>
+> `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
 
 响应数据，类型由 `dataType` 决定。
 
@@ -3851,6 +5097,20 @@ HTTP 状态码。
 
 ***
 
+### SaveImageToPhotosAlbumParams
+
+保存图片到系统相册的请求参数。
+
+#### Properties
+
+##### filePath
+
+> **filePath**: `string`
+
+需要保存的图片文件路径。支持临时文件路径或持久文件路径，不支持网络图片路径。
+
+***
+
 ### ScanCodeParams
 
 扫码请求参数。
@@ -3909,20 +5169,6 @@ HTTP 状态码。
 
 ***
 
-### SendHCEMessageParams
-
-发送 HCE 消息的请求参数。
-
-#### Properties
-
-##### data
-
-> **data**: `ArrayBuffer`
-
-要发送的二进制数据。
-
-***
-
 ### SendQueryMessageParams
 
 #### Properties
@@ -3961,6 +5207,24 @@ HTTP 状态码。
 
 ***
 
+### SetAdditionalContextParams
+
+#### Properties
+
+##### additionalContext
+
+> **additionalContext**: `string`
+
+上下文内容
+
+##### botId?
+
+> `optional` **botId**: `string`
+
+指定 bot id
+
+***
+
 ### SetBLEMTUParams
 
 设置 BLE MTU 的请求参数。
@@ -4085,6 +5349,110 @@ HTTP 状态码。
 
 ***
 
+### ShowActionSheetParams
+
+显示操作菜单的参数。
+
+#### Properties
+
+##### itemColor?
+
+> `optional` **itemColor**: `string`
+
+按钮文字颜色。
+
+##### itemList
+
+> **itemList**: `string`[]
+
+按钮文字数组。
+
+##### title?
+
+> `optional` **title**: `string`
+
+标题
+
+***
+
+### ShowActionSheetResult
+
+显示操作菜单的返回结果。
+
+#### Properties
+
+##### tapIndex
+
+> **tapIndex**: `number`
+
+用户点击的按钮序号，从 0 开始。
+
+***
+
+### ShowLoadingParams
+
+显示 loading 提示框的参数。
+
+***
+
+### 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`
+
+模态对话框的标题。
+
+***
+
+### ShowModalResult
+
+显示模态对话框的返回结果。
+
+#### Properties
+
+##### action
+
+> **action**: `"confirm"` \| `"cancel"` \| `"mask"`
+
+用户点击的动作。
+
+***
+
 ### ShowToastParams
 
 #### Properties
@@ -4205,114 +5573,57 @@ iOS 下是否忽略蓝牙可用性校验。
 
 ***
 
-### StartHCEParams
-
-开启 HCE 的请求参数。
+### UpdateModelContextParams
 
 #### Properties
 
-##### aidList
-
-> **aidList**: `string`[]
+##### content?
 
-需要注册到系统的 AID 列表。
+> `optional` **content**: `string`
 
-***
+上下文内容，格式无约束，可以与 MCP 服务下发的上下文格式保持一致
 
-### UpdateModelContextEntityBlock
+##### entityId?
 
-#### Properties
+> `optional` **entityId**: `string`
 
-##### entities
+上下文所属的 entityID，业务侧管理
 
-> **entities**: `Record`\<`string`, `any`\>[]
+##### taskId?
 
-##### type
+> `optional` **taskId**: `string`
 
-> **type**: `"entity"`
+上下文所属任务 ID，业务侧定义
 
 ***
 
-### UpdateModelContextOptions
-
-前端数据捐献接口入参。
-
-用于把“当前业务状态/关键信息”以统一 blocks 结构上报给端侧。
-
-建议触发时机：
-- 关键状态变化：例如订单创建/接单/到达/完成
-- 关键 UI 展示：例如弹出重要提示、展示核心摘要
-
-#### Example
-
-```ts
-await updateModelContext({
-  entity_meta: {
-    mcpServer: 'caocao',
-    data_type: '',
-    create_time: '2026-01-05 10:00:00',
-    expire_at: '2026-01-05 10:00:00',
-    update_url: 'uri://data/taxi/1',
-    annotation: {
-      hostRestartKeep: true,
-      systemRestartKeep: true
-    }
-  },
-  content: [
-    {
-      type: 'summary',
-      text: '王师傅已到达上车点，请尽快上车，车牌京A12345'
-    },
-    {
-      type: 'entity',
-      entities: [
-        {
-          orderId: '$E_17',
-          status: '待提交',
-          channel: 'personal'
-        }
-      ]
-    }
-  ]
-});
-```
+### UpdateWidgetParams
 
 #### Properties
 
-##### content?
-
-> `optional` **content**: [`UpdateModelContextBlock`](doubao-apps-sdk-open-api.md#updatemodelcontextblock)[]
+##### widgetData
 
-blocks 数组，支持 summary/entity 混搭。
-- 顺序不做强约束；建议把 summary 放前面，便于人类阅读。
-- 端侧生成稳定 event_id 时，会从所有 blocks 扫描 type="entity" 的 entities 来提取业务 identity（与顺序无关）。
+> **widgetData**: `string`
 
-##### entity\_meta?
+卡片渲染的数据
 
-> `optional` **entity\_meta**: `Record`\<`string`, `any`\>
+##### widgetId?
 
-可选：业务侧补充元信息（如来源、去重锚点、时序、过期策略等）。
+> `optional` **widgetId**: `string`
 
-字段示例：
-- mcpServer: 数据来源 app（例如 caocao）
-- create_time: 业务侧数据发生时间（用于时序）
-- expire_at: 业务侧过期时间（过期后模型不再使用；第一期可能未强制生效）
-- update_url: 预留字段（第一期暂不支持）
-- annotation.hostRestartKeep/systemRestartKeep: 预留字段（第一期可能未强制生效）
+卡片更新的为新的widgetId
 
-***
-
-### UpdateModelContextSummaryBlock
+##### widgetInstanceId
 
-#### Properties
+> **widgetInstanceId**: `string`
 
-##### text
+需要更新的widget 实例 ID
 
-> **text**: `string`
+***
 
-##### type
+### UserCaptureScreenEvent
 
-> **type**: `"summary"`
+用户主动截屏事件。
 
 ***
 
@@ -4474,6 +5785,38 @@ Wi-Fi SSID。
 
 ## Type Aliases
 
+### AccelerometerChangeListener()
+
+> **AccelerometerChangeListener**: (`event`) => `void`
+
+加速度数据变化事件监听函数。
+
+#### Parameters
+
+• **event**: [`AccelerometerChangeEvent`](doubao-apps-sdk-open-api.md#accelerometerchangeevent)
+
+#### Returns
+
+`void`
+
+***
+
+### BatteryInfoChangeListener()
+
+> **BatteryInfoChangeListener**: (`event`) => `void`
+
+电池信息变化事件监听函数。
+
+#### Parameters
+
+• **event**: [`BatteryInfoChangeEvent`](doubao-apps-sdk-open-api.md#batteryinfochangeevent)
+
+#### Returns
+
+`void`
+
+***
+
 ### BeaconProximity
 
 > **BeaconProximity**: `0` \| `1` \| `2` \| `3`
@@ -4530,6 +5873,105 @@ iBeacon 距离等级。
 
 ***
 
+### ChooseImageSizeType
+
+> **ChooseImageSizeType**: `"original"` \| `"compressed"`
+
+可选的图片尺寸类型。
+
+***
+
+### ChooseImageSourceType
+
+> **ChooseImageSourceType**: `"album"` \| `"camera"` \| `"user"` \| `"environment"`
+
+可选的图片来源类型。
+
+***
+
+### ChooseMessageFileType
+
+> **ChooseMessageFileType**: `"all"` \| `"video"` \| `"image"` \| `"file"`
+
+选择消息文件的文件类型。
+
+***
+
+### CompassChangeListener()
+
+> **CompassChangeListener**: (`event`) => `void`
+
+罗盘数据变化事件监听函数。
+
+#### Parameters
+
+• **event**: [`CompassChangeEvent`](doubao-apps-sdk-open-api.md#compasschangeevent)
+
+#### Returns
+
+`void`
+
+***
+
+### DeviceOrientation
+
+> **DeviceOrientation**: `"portrait"` \| `"landscape"`
+
+***
+
+### GyroscopeChangeListener()
+
+> **GyroscopeChangeListener**: (`event`) => `void`
+
+陀螺仪数据变化事件监听函数。
+
+#### Parameters
+
+• **event**: [`GyroscopeChangeEvent`](doubao-apps-sdk-open-api.md#gyroscopechangeevent)
+
+#### Returns
+
+`void`
+
+***
+
+### ImageOrientation
+
+> **ImageOrientation**: `"up"` \| `"up-mirrored"` \| `"down"` \| `"down-mirrored"` \| `"left-mirrored"` \| `"right"` \| `"right-mirrored"` \| `"left"`
+
+图片方向枚举。
+
+***
+
+### LoginType
+
+> **LoginType**: `0` \| `1` \| `2` \| `3`
+
+Widget 登录类型。
+
+- `0`: 隐私协议登录
+- `1`: 仅登录
+- `2`: 先登录再隐私协议，两次弹窗
+- `3`: 登录和隐私协议合并，一次弹窗
+
+***
+
+### NetworkStatusChangeListener()
+
+> **NetworkStatusChangeListener**: (`event`) => `void`
+
+网络状态变化事件监听函数。
+
+#### Parameters
+
+• **event**: [`NetworkStatusChangeEvent`](doubao-apps-sdk-open-api.md#networkstatuschangeevent)
+
+#### Returns
+
+`void`
+
+***
+
 ### NetworkType
 
 > **NetworkType**: `"wifi"` \| `"2g"` \| `"3g"` \| `"4g"` \| `"5g"` \| `"unknown"` \| `"none"`
@@ -4580,6 +6022,14 @@ iBeacon 距离等级。
 
 ***
 
+### SelectedMessageFileType
+
+> **SelectedMessageFileType**: `"video"` \| `"image"` \| `"file"`
+
+选择消息文件后返回的文件类型。
+
+***
+
 ### SensorInterval
 
 > **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
@@ -4588,9 +6038,19 @@ iBeacon 距离等级。
 
 ***
 
-### UpdateModelContextBlock
+### UserCaptureScreenListener()
 
-> **UpdateModelContextBlock**: [`UpdateModelContextSummaryBlock`](doubao-apps-sdk-open-api.md#updatemodelcontextsummaryblock) \| [`UpdateModelContextEntityBlock`](doubao-apps-sdk-open-api.md#updatemodelcontextentityblock)
+> **UserCaptureScreenListener**: (`event`) => `void`
+
+用户主动截屏事件监听函数。
+
+#### Parameters
+
+• **event**: [`UserCaptureScreenEvent`](doubao-apps-sdk-open-api.md#usercapturescreenevent)
+
+#### Returns
+
+`void`
 
 ***
 
@@ -4599,3 +6059,35 @@ iBeacon 距离等级。
 > **VibrateShortType**: `"heavy"` \| `"medium"` \| `"light"`
 
 短震动类型。
+
+## Variables
+
+### LoginType
+
+> **LoginType**: `object`
+
+#### Type declaration
+
+##### Login
+
+> **Login**: `number` = `1`
+
+仅登录
+
+##### LoginThenPrivacy
+
+> **LoginThenPrivacy**: `number` = `2`
+
+先登录再隐私协议，两次弹窗
+
+##### LoginWithPrivacy
+
+> **LoginWithPrivacy**: `number` = `3`
+
+登录和隐私协议合并，一次弹窗
+
+##### Privacy
+
+> **Privacy**: `number` = `0`
+
+隐私协议登录