npm - @doubao-apps/ai - Versions diffs - 0.0.25 → 0.0.27 - Mend

@doubao-apps/ai 0.0.25 → 0.0.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (87) hide show

package/dist/skills/doubao-apps-dev/.ai/reference/open-api.md CHANGED Viewed

@@ -1,4601 +1,326 @@
-**@byted-doubao-apps/open-api** • **Docs**
+# Open API
-***
+> 公开可用的端能力 API。默认从 `@doubao-apps/framework/api` 导入；本文件根据 `packages/open-api/src` 的导出结构自动生成，按模块列出 API 名称和说明。
-# @byted-doubao-apps/open-api
+覆盖 119 个函数。详细参数、返回值、示例和相关类型请查看 [Open API 目录](open-api/README.md)，精确字段也可按参数/结果类型名查看 IDE 类型提示或 `@doubao-apps/framework/api` 类型定义。
-## Functions
-### addPhoneCalendar()
-> **addPhoneCalendar**(`params`): `Promise`\<`object`\>
-向系统日历添加事件。
-#### Parameters
-• **params**: [`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### addPhoneContact()
-> **addPhoneContact**(`params`): `Promise`\<`object`\>
-添加手机联系人。
-#### Parameters
-• **params**: [`AddPhoneContactParams`](doubao-apps-sdk-open-api.md#addphonecontactparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### addPhoneRepeatCalendar()
-> **addPhoneRepeatCalendar**(`params`): `Promise`\<`object`\>
-向系统日历添加重复事件。
-#### Parameters
-• **params**: [`AddPhoneRepeatCalendarParams`](doubao-apps-sdk-open-api.md#addphonerepeatcalendarparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### authorize()
-> **authorize**(`params`): `Promise`\<`object`\>
-初始化授权
-#### Parameters
-• **params**: [`AuthorizeRequest`](doubao-apps-sdk-open-api.md#authorizerequest)
-授权参数
-#### Returns
-`Promise`\<`object`\>
-Promise 对象，授权成功时会返回授权结果
-***
-### canIUse()
-> **canIUse**(`params`): `Promise`\<[`CanIUseResult`](doubao-apps-sdk-open-api.md#caniuseresult)\>
-#### Parameters
-• **params**: [`CanIUseParams`](doubao-apps-sdk-open-api.md#caniuseparams)
-#### Returns
-`Promise`\<[`CanIUseResult`](doubao-apps-sdk-open-api.md#caniuseresult)\>
-***
-### checkIsOpenAccessibility()
-> **checkIsOpenAccessibility**(`params`?): `Promise`\<[`CheckIsOpenAccessibilityResult`](doubao-apps-sdk-open-api.md#checkisopenaccessibilityresult)\>
-检测无障碍能力是否开启。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<[`CheckIsOpenAccessibilityResult`](doubao-apps-sdk-open-api.md#checkisopenaccessibilityresult)\>
-***
-### chooseContact()
-> **chooseContact**(`params`?): `Promise`\<[`ChooseContactResult`](doubao-apps-sdk-open-api.md#choosecontactresult)\>
-选择手机联系人。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<[`ChooseContactResult`](doubao-apps-sdk-open-api.md#choosecontactresult)\>
-***
-### clearStorage()
-> **clearStorage**(`params`?): `Promise`\<`object`\>
-清空本地缓存。
-#### Parameters
-• **params?**: `object`
-#### Returns
-`Promise`\<`object`\>
-返回一个 Promise，清空完成后 resolve。
-#### Example
-```typescript
-import { clearStorage } from '@doubao-apps/framework/api';
-await clearStorage();
-```
-***
-### clearStorageSync()
-> **clearStorageSync**(`params`?): `object`
-清空本地缓存。
-#### Parameters
-• **params?**: `object`
-#### Returns
-`object`
-同步清空完成后返回。
-#### Example
-```typescript
-import { clearStorageSync } from '@doubao-apps/framework/api';
-clearStorageSync();
-```
-***
-### ~~close()~~
-> **close**(`params`?): `Promise`\<`object`\>
-关闭栈顶页面。
-#### Parameters
-• **params?**: [`CloseParams`](doubao-apps-sdk-open-api.md#closeparams)
-#### Returns
-`Promise`\<`object`\>
-返回一个 Promise，在关闭操作成功发起时解析
-#### Deprecated
-使用 [navigateBack](doubao-apps-sdk-open-api.md#navigateback)
-#### Example
-```typescript
-import { close } from '@doubao-apps/framework/api';
-async function closeTopPage() {
-  try {
-    await close();
-  } catch (e) {
-    console.error('关闭页面失败', e);
-  }
-}
-closePage();
-```
-***
-### closeBLEConnection()
-> **closeBLEConnection**(`params`): `Promise`\<`object`\>
-关闭 BLE 连接。
-#### Parameters
-• **params**: [`CloseBLEConnectionParams`](doubao-apps-sdk-open-api.md#closebleconnectionparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### closeBluetoothAdapter()
-> **closeBluetoothAdapter**(`params`?): `Promise`\<`object`\>
-关闭蓝牙适配器。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### connectWifi()
-> **connectWifi**(`params`): `Promise`\<`object`\>
-连接指定 Wi-Fi。
-#### Parameters
-• **params**: [`ConnectWifiParams`](doubao-apps-sdk-open-api.md#connectwifiparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### createBLEConnection()
-> **createBLEConnection**(`params`): `Promise`\<`object`\>
-创建 BLE 连接。
-#### Parameters
-• **params**: [`CreateBLEConnectionParams`](doubao-apps-sdk-open-api.md#createbleconnectionparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### exitApp()
-> **exitApp**(): `Promise`\<`object`\>
-退去当前所有页面
-#### Returns
-`Promise`\<`object`\>
-***
-### getAccountInfo()
-> **getAccountInfo**(`params`?): `Promise`\<[`GetAccountInfoResult`](doubao-apps-sdk-open-api.md#getaccountinforesult)\>
-异步获取账号信息。
-#### Parameters
-• **params?**
-#### Returns
-`Promise`\<[`GetAccountInfoResult`](doubao-apps-sdk-open-api.md#getaccountinforesult)\>
-#### Example
-```typescript
-import { getAccountInfo } from '@doubao-apps/framework/api';
-const result = await getAccountInfo();
-console.log(result.miniProgram.appId);
-```
-***
-### getAccountInfoSync()
-> **getAccountInfoSync**(`params`?): [`GetAccountInfoResult`](doubao-apps-sdk-open-api.md#getaccountinforesult)
-同步获取账号信息。
-#### Parameters
-• **params?**
-#### Returns
-[`GetAccountInfoResult`](doubao-apps-sdk-open-api.md#getaccountinforesult)
-#### Example
-```typescript
-import { getAccountInfoSync } from '@doubao-apps/framework/api';
-const result = getAccountInfoSync();
-console.log(result.miniProgram.appId, result.miniProgram.envVersion, result.miniProgram.version);
-```
-***
-### getAppBaseInfo()
-> **getAppBaseInfo**(`params`?): `Promise`\<[`GetAppBaseInfoResult`](doubao-apps-sdk-open-api.md#getappbaseinforesult)\>
-获取应用基础信息。
-#### Parameters
-• **params?**
-#### Returns
-`Promise`\<[`GetAppBaseInfoResult`](doubao-apps-sdk-open-api.md#getappbaseinforesult)\>
-返回 SDK 版本、调试开关、宿主信息、语言和主题等字段，见 [GetAppBaseInfoResult](doubao-apps-sdk-open-api.md#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);
-```
-***
-### getAppBaseInfoSync()
-> **getAppBaseInfoSync**(`_params`?): [`GetAppBaseInfoResult`](doubao-apps-sdk-open-api.md#getappbaseinforesult)
-获取应用基础信息。
-#### Parameters
-• **\_params?**
-#### Returns
-[`GetAppBaseInfoResult`](doubao-apps-sdk-open-api.md#getappbaseinforesult)
-返回 SDK 版本、调试开关、宿主信息、语言和主题等字段，见 [GetAppBaseInfoResult](doubao-apps-sdk-open-api.md#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);
+import { showToast, request, getStorage } from '@doubao-apps/framework/api';
 ```
-***
+## 基础 / 账号 / 系统
+账号、授权、宿主基础信息、窗口信息和定位。
+| API | 说明 |
+| --- | --- |
+| [getAccountInfo](open-api/01-基础-账号-系统.md#getaccountinfo) | 异步获取账号信息。 |
+| [getAccountInfoSync](open-api/01-基础-账号-系统.md#getaccountinfosync) | 同步获取账号信息。<br><br>同步 API。 |
+| [authorize](open-api/01-基础-账号-系统.md#authorize) | 初始化授权。<br><br>按 scope 申请授权。 |
+| [canIUse](open-api/01-基础-账号-系统.md#caniuse) | 检测当前宿主是否支持指定 API 或能力。<br><br>用于兼容性判断。 |
+| [getLocation](open-api/01-基础-账号-系统.md#getlocation) | 获取设备当前的地理位置信息。<br><br>可能涉及定位授权。 |
+| [login](open-api/01-基础-账号-系统.md#login) | 发起登录并获取登录凭证。 |
+| [getWindowInfoSync](open-api/01-基础-账号-系统.md#getwindowinfosync) | 获取窗口信息。<br><br>同步 API。 |
+| [getSystemSetting](open-api/01-基础-账号-系统.md#getsystemsetting) | 获取设备设置。 |
+| [getAppBaseInfoSync](open-api/01-基础-账号-系统.md#getappbaseinfosync) | 获取应用基础信息。<br><br>同步 API。 |
+| [getWindowInfo](open-api/01-基础-账号-系统.md#getwindowinfo) | 获取窗口信息。 |
+| [getAppBaseInfo](open-api/01-基础-账号-系统.md#getappbaseinfo) | 获取应用基础信息。 |
+## 存储
+本地缓存；带 Sync 后缀的是同步 API。
+| API | 说明 |
+| --- | --- |
+| [setStorage](open-api/02-存储.md#setstorage) | 将数据写入本地缓存。 |
+| [setStorageSync](open-api/02-存储.md#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API。 |
+| [getStorage](open-api/02-存储.md#getstorage) | 从本地缓存读取数据。 |
+| [getStorageSync](open-api/02-存储.md#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API。 |
+| [removeStorage](open-api/02-存储.md#removestorage) | 删除本地缓存中指定 key 的数据。 |
+| [removeStorageSync](open-api/02-存储.md#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API。 |
+| [clearStorage](open-api/02-存储.md#clearstorage) | 清空本地缓存。 |
+| [clearStorageSync](open-api/02-存储.md#clearstoragesync) | 清空本地缓存。<br><br>同步 API。 |
+| [getStorageInfo](open-api/02-存储.md#getstorageinfo) | 获取本地缓存信息。 |
+| [getStorageInfoSync](open-api/02-存储.md#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API。 |
+## 路由
+应用内页面跳转和关闭。
+| API | 说明 |
+| --- | --- |
+| [close](open-api/03-路由.md#close) | 关闭栈顶页面。<br><br>已废弃，使用 navigateBack。 |
+| [navigateTo](open-api/03-路由.md#navigateto) | 保留当前页面，跳转到应用内的某个页面。 |
+| [redirectTo](open-api/03-路由.md#redirectto) | 关闭当前页面，跳转到应用内的某个页面。 |
+| [reLaunch](open-api/03-路由.md#relaunch) | 关闭所有页面并跳转到应用内页面。 |
+| [navigateBack](open-api/03-路由.md#navigateback) | 关闭当前页面，返回上一页面或多级页面。 |
+| [exitApp](open-api/03-路由.md#exitapp) | 退出当前所有页面。<br><br>会退出当前所有页面。 |
+## 界面 / 交互
+Toast、Loading、Modal、ActionSheet 和返回前提醒。
+| API | 说明 |
+| --- | --- |
+| [showModal](open-api/04-界面-交互.md#showmodal) | 显示模态对话框。 |
+| [showLoading](open-api/04-界面-交互.md#showloading) | 显示 loading 提示框。<br><br>需调用 hideLoading 关闭。 |
+| [hideToast](open-api/04-界面-交互.md#hidetoast) | 隐藏当前 Toast。 |
+| [hideLoading](open-api/04-界面-交互.md#hideloading) | 隐藏当前 loading。 |
+| [showActionSheet](open-api/04-界面-交互.md#showactionsheet) | 显示操作菜单。 |
+| [getMenuButtonBoundingClientRect](open-api/04-界面-交互.md#getmenubuttonboundingclientrect) | 获取菜单按钮的布局位置信息。 |
+| [enableAlertBeforeUnload](open-api/04-界面-交互.md#enablealertbeforeunload) | 开启页面返回前提醒。<br><br>配合 disableAlertBeforeUnload 使用。 |
+| [disableAlertBeforeUnload](open-api/04-界面-交互.md#disablealertbeforeunload) | 关闭页面返回前提醒。 |
+| [showToast](open-api/04-界面-交互.md#showtoast) | 显示 Toast 提示。<br><br>duration 和 icon 可控制提示表现。 |
+## 界面 / 输入
+键盘和输入框选区能力。
+| API | 说明 |
+| --- | --- |
+| [onKeyboardHeightChange](open-api/05-界面-输入.md#onkeyboardheightchange) | 监听键盘高度变化事件。<br><br>返回取消监听函数。 |
+## 网络
+网络请求
+| API | 说明 |
+| --- | --- |
+| [request](open-api/06-网络.md#request) | 发起网络请求。<br><br>返回 statusCode、header 和 data。 |
+## 媒体
+图片选择、预览、保存、压缩和信息读取。
+| API | 说明 |
+| --- | --- |
+| [saveImageToPhotosAlbum](open-api/07-媒体.md#saveimagetophotosalbum) | 保存图片到系统相册。 |
+| [previewImage](open-api/07-媒体.md#previewimage) | 预览图片。 |
+| [getImageInfo](open-api/07-媒体.md#getimageinfo) | 获取图片信息。 |
+| [chooseImage](open-api/07-媒体.md#chooseimage) | 选择图片。 |
+| [compressImage](open-api/07-媒体.md#compressimage) | 压缩图片。 |
+## 开放能力 / 业务能力
+开放业务能力、支付、隐私设置、上下文和外部应用打开。
+| API | 说明 |
+| --- | --- |
+| [getOrderPayment](open-api/08-开放能力-业务能力.md#getorderpayment) | 查询订单支付结果。 |
+| [postLoginResult](open-api/08-开放能力-业务能力.md#postloginresult) | 回传 MCP 授权登录凭证。 |
+| [getPrivacySetting](open-api/08-开放能力-业务能力.md#getprivacysetting) | 获取隐私设置状态。 |
+| [requestOrder](open-api/08-开放能力-业务能力.md#requestorder) | 发起订单支付流程。 |
+| [loginWithDoubaoWidget](open-api/08-开放能力-业务能力.md#loginwithdoubaowidget) | 发起豆包 Widget 登录。 |
+| [sendQueryMessage](open-api/08-开放能力-业务能力.md#sendquerymessage) | 以用户身份发送一条消息。<br><br>返回 void，不是 Promise。 |
+| [updateModelContext](open-api/08-开放能力-业务能力.md#updatemodelcontext) | 向 Agent 捐赠上下文。 |
+| [setAdditionalContext](open-api/08-开放能力-业务能力.md#setadditionalcontext) | 设置全局上下文供大模型理解。<br><br>设置全局上下文。 |
+| [dispatchActionDirective](open-api/08-开放能力-业务能力.md#dispatchactiondirective) | 描述用户行为，约束模型行为及指定执行路径。 |
+| [updateWidget](open-api/08-开放能力-业务能力.md#updatewidget) | 更新指定卡片。 |
+| [expiredWidget](open-api/08-开放能力-业务能力.md#expiredwidget) | 更新过期的 widget 为固定卡片。 |
+| [openApp](open-api/08-开放能力-业务能力.md#openapp) | 通过 deep link 等方式打开外部应用。 |
+## 设备 / 蓝牙
+蓝牙和 BLE 能力；通常先打开适配器，再扫描、连接和读写。
+| API | 说明 |
+| --- | --- |
+| [openBluetoothAdapter](open-api/09-设备-蓝牙.md#openbluetoothadapter) | 打开蓝牙适配器。<br><br>蓝牙流程入口。 |
+| [startBluetoothDevicesDiscovery](open-api/09-设备-蓝牙.md#startbluetoothdevicesdiscovery) | 开始搜索附近的蓝牙设备。<br><br>通常先调用 openBluetoothAdapter。 |
+| [stopBluetoothDevicesDiscovery](open-api/09-设备-蓝牙.md#stopbluetoothdevicesdiscovery) | 停止搜索附近的蓝牙设备。 |
+| [getBluetoothAdapterState](open-api/09-设备-蓝牙.md#getbluetoothadapterstate) | 获取蓝牙适配器状态。 |
+| [getBluetoothDevices](open-api/09-设备-蓝牙.md#getbluetoothdevices) | 获取当前蓝牙模块发现的设备列表。<br><br>通常先调用 startBluetoothDevicesDiscovery。 |
+| [getConnectedBluetoothDevices](open-api/09-设备-蓝牙.md#getconnectedbluetoothdevices) | 获取已连接的蓝牙设备列表。 |
+| [makeBluetoothPair](open-api/09-设备-蓝牙.md#makebluetoothpair) | 发起蓝牙配对。 |
+| [isBluetoothDevicePaired](open-api/09-设备-蓝牙.md#isbluetoothdevicepaired) | 查询蓝牙设备是否已经配对。 |
+| [closeBluetoothAdapter](open-api/09-设备-蓝牙.md#closebluetoothadapter) | 关闭蓝牙适配器。<br><br>会关闭蓝牙模块。 |
+| [createBLEConnection](open-api/09-设备-蓝牙.md#createbleconnection) | 创建 BLE 连接。<br><br>需要传入 deviceId。 |
+| [closeBLEConnection](open-api/09-设备-蓝牙.md#closebleconnection) | 关闭 BLE 连接。 |
+| [getBLEDeviceServices](open-api/09-设备-蓝牙.md#getbledeviceservices) | 获取 BLE 服务列表。<br><br>通常先调用 createBLEConnection。 |
+| [getBLEDeviceCharacteristics](open-api/09-设备-蓝牙.md#getbledevicecharacteristics) | 获取 BLE 特征值列表。<br><br>通常先获取 BLE 服务列表。 |
+| [getBLEDeviceRSSI](open-api/09-设备-蓝牙.md#getbledevicerssi) | 获取 BLE 设备 RSSI。 |
+| [getBLEMTU](open-api/09-设备-蓝牙.md#getblemtu) | 获取 BLE MTU。 |
+| [notifyBLECharacteristicValueChange](open-api/09-设备-蓝牙.md#notifyblecharacteristicvaluechange) | 订阅 BLE 特征值变化。<br><br>订阅指定特征值变化。 |
+| [readBLECharacteristicValue](open-api/09-设备-蓝牙.md#readblecharacteristicvalue) | 读取 BLE 特征值。<br><br>需要传入 serviceId 和 characteristicId。 |
+| [setBLEMTU](open-api/09-设备-蓝牙.md#setblemtu) | 设置 BLE MTU。 |
+| [writeBLECharacteristicValue](open-api/09-设备-蓝牙.md#writeblecharacteristicvalue) | 写入 BLE 特征值。<br><br>value 需要是 ArrayBuffer。 |
-### getBLEDeviceCharacteristics()
+## 设备 / Wi-Fi
-> **getBLEDeviceCharacteristics**(`params`): `Promise`\<[`GetBLEDeviceCharacteristicsResult`](doubao-apps-sdk-open-api.md#getbledevicecharacteristicsresult)\>
+Wi-Fi 模块能力；通常先 startWifi，再获取列表或连接。
+| API | 说明 |
+| --- | --- |
+| [startWifi](open-api/10-设备-wi-fi.md#startwifi) | 初始化 Wi-Fi 模块。<br><br>Wi-Fi 流程入口。 |
+| [stopWifi](open-api/10-设备-wi-fi.md#stopwifi) | 关闭 Wi-Fi 模块。 |
+| [setWifiList](open-api/10-设备-wi-fi.md#setwifilist) | 设置 Wi-Fi 预设列表。<br><br>用于预设 Wi-Fi 列表。 |
+| [connectWifi](open-api/10-设备-wi-fi.md#connectwifi) | 连接指定 Wi-Fi。<br><br>通常先调用 startWifi。 |
+| [getConnectedWifi](open-api/10-设备-wi-fi.md#getconnectedwifi) | 获取当前已连接 Wi-Fi 信息。 |
+| [getWifiList](open-api/10-设备-wi-fi.md#getwifilist) | 获取 Wi-Fi 列表。<br><br>通常先调用 startWifi。 |
-获取 BLE 特征值列表。
+## 设备 / 加速度计
-#### Parameters
+加速度计监听能力。
-• **params**: [`GetBLEDeviceCharacteristicsParams`](doubao-apps-sdk-open-api.md#getbledevicecharacteristicsparams)
+| API | 说明 |
+| --- | --- |
+| [startAccelerometer](open-api/11-设备-加速度计.md#startaccelerometer) | 开始监听加速度。<br><br>需配对调用 stopAccelerometer。 |
+| [stopAccelerometer](open-api/11-设备-加速度计.md#stopaccelerometer) | 停止监听加速度。 |
+| [onAccelerometerChange](open-api/11-设备-加速度计.md#onaccelerometerchange) | 监听加速度数据变化事件。<br><br>返回取消监听函数。 |
-#### Returns
+## 设备 / iBeacon
-`Promise`\<[`GetBLEDeviceCharacteristicsResult`](doubao-apps-sdk-open-api.md#getbledevicecharacteristicsresult)\>
+iBeacon 搜索和结果读取能力。
-***
+| API | 说明 |
+| --- | --- |
+| [startBeaconDiscovery](open-api/12-设备-ibeacon.md#startbeacondiscovery) | 开始搜索附近的 iBeacon。<br><br>需配对调用 stopBeaconDiscovery。 |
+| [stopBeaconDiscovery](open-api/12-设备-ibeacon.md#stopbeacondiscovery) | 停止搜索附近的 iBeacon。 |
+| [getBeacons](open-api/12-设备-ibeacon.md#getbeacons) | 获取已搜索到的 iBeacon 列表。 |
-### getBLEDeviceRSSI()
+## 设备 / 罗盘
-> **getBLEDeviceRSSI**(`params`): `Promise`\<[`GetBLEDeviceRSSIResult`](doubao-apps-sdk-open-api.md#getbledevicerssiresult)\>
+罗盘监听能力。
-获取 BLE 设备 RSSI。
+| API | 说明 |
+| --- | --- |
+| [startCompass](open-api/13-设备-罗盘.md#startcompass) | 开始监听罗盘。<br><br>需配对调用 stopCompass。 |
+| [stopCompass](open-api/13-设备-罗盘.md#stopcompass) | 停止监听罗盘。 |
+| [onCompassChange](open-api/13-设备-罗盘.md#oncompasschange) | 监听罗盘数据变化事件。<br><br>返回取消监听函数。 |
-#### Parameters
+## 设备 / 设备方向
-• **params**: [`GetBLEDeviceRSSIParams`](doubao-apps-sdk-open-api.md#getbledevicerssiparams)
+设备方向监听能力。
+| API | 说明 |
+| --- | --- |
+| [startDeviceMotionListening](open-api/14-设备-设备方向.md#startdevicemotionlistening) | 开始监听设备方向变化。<br><br>需配对调用 stopDeviceMotionListening。 |
+| [stopDeviceMotionListening](open-api/14-设备-设备方向.md#stopdevicemotionlistening) | 停止监听设备方向变化。 |
+## 设备 / 陀螺仪
-#### Returns
+陀螺仪监听能力。
+| API | 说明 |
+| --- | --- |
+| [startGyroscope](open-api/15-设备-陀螺仪.md#startgyroscope) | 开始监听陀螺仪。<br><br>需配对调用 stopGyroscope。 |
+| [stopGyroscope](open-api/15-设备-陀螺仪.md#stopgyroscope) | 停止监听陀螺仪。 |
+| [onGyroscopeChange](open-api/15-设备-陀螺仪.md#ongyroscopechange) | 监听陀螺仪数据变化事件。<br><br>返回取消监听函数。 |
+## UI / 输入
+键盘和输入框选区能力。
-`Promise`\<[`GetBLEDeviceRSSIResult`](doubao-apps-sdk-open-api.md#getbledevicerssiresult)\>
+| API | 说明 |
+| --- | --- |
+| [hideKeyboard](open-api/16-ui-输入.md#hidekeyboard) | 收起键盘。 |
+| [getSelectedTextRange](open-api/16-ui-输入.md#getselectedtextrange) | 获取当前输入框的选区范围。 |
-***
+## 设备 / 网络
-### getBLEDeviceServices()
+网络类型和本机局域网 IP。
-> **getBLEDeviceServices**(`params`): `Promise`\<[`GetBLEDeviceServicesResult`](doubao-apps-sdk-open-api.md#getbledeviceservicesresult)\>
+| API | 说明 |
+| --- | --- |
+| [getLocalIPAddress](open-api/17-设备-网络.md#getlocalipaddress) | 获取局域网 IP 地址。 |
+| [getNetworkType](open-api/17-设备-网络.md#getnetworktype) | 获取当前网络类型。 |
+| [onNetworkStatusChange](open-api/17-设备-网络.md#onnetworkstatuschange) | 监听网络状态变化事件。<br><br>返回取消监听函数。 |
-获取 BLE 服务列表。
+## 设备 / 短信
-#### Parameters
-• **params**: [`GetBLEDeviceServicesParams`](doubao-apps-sdk-open-api.md#getbledeviceservicesparams)
-#### Returns
-`Promise`\<[`GetBLEDeviceServicesResult`](doubao-apps-sdk-open-api.md#getbledeviceservicesresult)\>
-***
-### getBLEMTU()
-> **getBLEMTU**(`params`): `Promise`\<[`GetBLEMTUResult`](doubao-apps-sdk-open-api.md#getblemturesult)\>
-获取 BLE MTU。
-#### Parameters
-• **params**: [`GetBLEMTUParams`](doubao-apps-sdk-open-api.md#getblemtuparams)
-#### Returns
-`Promise`\<[`GetBLEMTUResult`](doubao-apps-sdk-open-api.md#getblemturesult)\>
-***
-### getBatteryInfo()
-> **getBatteryInfo**(`params`?): `Promise`\<[`GetBatteryInfoResult`](doubao-apps-sdk-open-api.md#getbatteryinforesult)\>
-获取电池信息。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<[`GetBatteryInfoResult`](doubao-apps-sdk-open-api.md#getbatteryinforesult)\>
-***
-### getBeacons()
-> **getBeacons**(`params`?): `Promise`\<[`GetBeaconsResult`](doubao-apps-sdk-open-api.md#getbeaconsresult)\>
-获取已搜索到的 iBeacon 列表。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<[`GetBeaconsResult`](doubao-apps-sdk-open-api.md#getbeaconsresult)\>
-***
-### getBluetoothAdapterState()
-> **getBluetoothAdapterState**(`params`?): `Promise`\<[`GetBluetoothAdapterStateResult`](doubao-apps-sdk-open-api.md#getbluetoothadapterstateresult)\>
-获取蓝牙适配器状态。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<[`GetBluetoothAdapterStateResult`](doubao-apps-sdk-open-api.md#getbluetoothadapterstateresult)\>
-***
-### getBluetoothDevices()
-> **getBluetoothDevices**(`params`?): `Promise`\<[`GetBluetoothDevicesResult`](doubao-apps-sdk-open-api.md#getbluetoothdevicesresult)\>
-获取当前蓝牙模块发现的设备列表。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<[`GetBluetoothDevicesResult`](doubao-apps-sdk-open-api.md#getbluetoothdevicesresult)\>
-***
-### getClipboardData()
-> **getClipboardData**(`params`?): `Promise`\<[`GetClipboardDataResult`](doubao-apps-sdk-open-api.md#getclipboarddataresult)\>
-获取剪贴板内容。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<[`GetClipboardDataResult`](doubao-apps-sdk-open-api.md#getclipboarddataresult)\>
-***
-### getConnectedBluetoothDevices()
-> **getConnectedBluetoothDevices**(`params`): `Promise`\<[`GetConnectedBluetoothDevicesResult`](doubao-apps-sdk-open-api.md#getconnectedbluetoothdevicesresult)\>
-获取已连接的蓝牙设备列表。
-#### Parameters
-• **params**: [`GetConnectedBluetoothDevicesParams`](doubao-apps-sdk-open-api.md#getconnectedbluetoothdevicesparams)
-#### Returns
-`Promise`\<[`GetConnectedBluetoothDevicesResult`](doubao-apps-sdk-open-api.md#getconnectedbluetoothdevicesresult)\>
-***
-### getConnectedWifi()
-> **getConnectedWifi**(`params`?): `Promise`\<[`GetConnectedWifiResult`](doubao-apps-sdk-open-api.md#getconnectedwifiresult)\>
-获取当前已连接 Wi-Fi 信息。
+拉起系统短信发送面板。
-#### Parameters
+| API | 说明 |
+| --- | --- |
+| [sendSms](open-api/18-设备-短信.md#sendsms) | 拉起系统短信发送面板。 |
-• **params?**: [`GetConnectedWifiParams`](doubao-apps-sdk-open-api.md#getconnectedwifiparams)
+## 设备 / 无障碍
-#### Returns
+检测无障碍能力开关状态。
-`Promise`\<[`GetConnectedWifiResult`](doubao-apps-sdk-open-api.md#getconnectedwifiresult)\>
+| API | 说明 |
+| --- | --- |
+| [checkIsOpenAccessibility](open-api/19-设备-无障碍.md#checkisopenaccessibility) | 检测无障碍能力是否开启。 |
-***
+## 设备 / 电池
-### getHCEState()
+电池信息读取与变化监听。
-> **getHCEState**(`params`?): `Promise`\<`object`\>
+| API | 说明 |
+| --- | --- |
+| [getBatteryInfo](open-api/20-设备-电池.md#getbatteryinfo) | 获取电池信息。 |
+| [onBatteryInfoChange](open-api/20-设备-电池.md#onbatteryinfochange) | 监听电池信息变化事件。<br><br>返回取消监听函数。 |
-获取 HCE 状态。
+## 设备 / 日历
-#### Parameters
+向系统日历添加事件和重复事件。
-• **params?**: `Record`\<`string`, `never`\>
+| API | 说明 |
+| --- | --- |
+| [addPhoneCalendar](open-api/21-设备-日历.md#addphonecalendar) | 向系统日历添加事件。 |
+| [addPhoneRepeatCalendar](open-api/21-设备-日历.md#addphonerepeatcalendar) | 向系统日历添加重复事件。 |
-#### Returns
+## 设备 / 剪贴板
-`Promise`\<`object`\>
+读取和设置系统剪贴板内容。
-***
+| API | 说明 |
+| --- | --- |
+| [getClipboardData](open-api/22-设备-剪贴板.md#getclipboarddata) | 获取剪贴板内容。 |
+| [setClipboardData](open-api/22-设备-剪贴板.md#setclipboarddata) | 设置系统剪贴板内容。 |
-### getLocalIPAddress()
+## 设备 / 联系人
-> **getLocalIPAddress**(`params`?): `Promise`\<[`GetLocalIPAddressResult`](doubao-apps-sdk-open-api.md#getlocalipaddressresult)\>
+选择和添加手机联系人。
-获取局域网 IP 地址。
+| API | 说明 |
+| --- | --- |
+| [chooseContact](open-api/23-设备-联系人.md#choosecontact) | 选择手机联系人。 |
+| [addPhoneContact](open-api/23-设备-联系人.md#addphonecontact) | 添加手机联系人。 |
-#### Parameters
+## 设备 / 加密
-• **params?**: `Record`\<`string`, `never`\>
+安全随机数能力。
-#### Returns
+| API | 说明 |
+| --- | --- |
+| [getRandomValues](open-api/24-设备-加密.md#getrandomvalues) | 获取安全随机数。 |
-`Promise`\<[`GetLocalIPAddressResult`](doubao-apps-sdk-open-api.md#getlocalipaddressresult)\>
-***
-### getLocation()
-> **getLocation**(`params`?): `Promise`\<[`GetLocationResponse`](doubao-apps-sdk-open-api.md#getlocationresponse)\>
-获取设备当前的地理位置信息。
-#### Parameters
-• **params?**: [`GetLocationParams`](doubao-apps-sdk-open-api.md#getlocationparams)
-#### Returns
-`Promise`\<[`GetLocationResponse`](doubao-apps-sdk-open-api.md#getlocationresponse)\>
-返回一个 Promise，成功时解析为包含地理位置信息的对象，包含：
-  - `latitude`: number - 纬度。
-  - `longitude`: number - 经度。
-  - `timestamp`: string - 时间戳。
-  - `speed`: number - 行进速度，单位：米/秒。
-  - `accuracy`: number - 定位精度，单位：米。
-  参考 [GetLocationResponse](doubao-apps-sdk-open-api.md#getlocationresponse)。
-#### Throws
-如果调用失败（例如，用户拒绝权限、定位服务关闭等），则抛出此错误。
-#### Example
-```typescript
-import { getLocation } from '@byted-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();
-```
-***
-### getNetworkType()
-> **getNetworkType**(`params`?): `Promise`\<[`GetNetworkTypeResult`](doubao-apps-sdk-open-api.md#getnetworktyperesult)\>
-获取当前网络类型。
-#### Parameters
-• **params?**: [`GetNetworkTypeParams`](doubao-apps-sdk-open-api.md#getnetworktypeparams)
-#### Returns
-`Promise`\<[`GetNetworkTypeResult`](doubao-apps-sdk-open-api.md#getnetworktyperesult)\>
-返回一个 Promise，解析为 [GetNetworkTypeResult](doubao-apps-sdk-open-api.md#getnetworktyperesult)。
-#### Example
-```ts
-import { getNetworkType } from '@byted-doubao-apps/framework/api';
-const result = await getNetworkType();
-console.log(result.networkType);
-```
-***
-### getOrderPayment()
-> **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
-• **params?**
-#### Returns
-`Promise`\<[`PrivacySettingResult`](doubao-apps-sdk-open-api.md#privacysettingresult)\>
-Returns a Promise containing privacy setting information
-***
-### getRandomValues()
-> **getRandomValues**(`params`): `Promise`\<[`GetRandomValuesResult`](doubao-apps-sdk-open-api.md#getrandomvaluesresult)\>
-获取安全随机数。
-#### Parameters
-• **params**: [`GetRandomValuesParams`](doubao-apps-sdk-open-api.md#getrandomvaluesparams)
-#### Returns
-`Promise`\<[`GetRandomValuesResult`](doubao-apps-sdk-open-api.md#getrandomvaluesresult)\>
-***
-### getScreenBrightness()
-> **getScreenBrightness**(`params`?): `Promise`\<[`GetScreenBrightnessResult`](doubao-apps-sdk-open-api.md#getscreenbrightnessresult)\>
-获取屏幕亮度。
-#### Parameters
-• **params?**
-#### Returns
-`Promise`\<[`GetScreenBrightnessResult`](doubao-apps-sdk-open-api.md#getscreenbrightnessresult)\>
-***
-### getSelectedTextRange()
-> **getSelectedTextRange**(`params`?): `Promise`\<[`GetSelectedTextRangeResult`](doubao-apps-sdk-open-api.md#getselectedtextrangeresult)\>
-获取当前输入框的选区范围。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<[`GetSelectedTextRangeResult`](doubao-apps-sdk-open-api.md#getselectedtextrangeresult)\>
-***
-### getStorage()
-> **getStorage**\<`TData`\>(`params`): `Promise`\<[`GetStorageResult`](doubao-apps-sdk-open-api.md#getstorageresulttdata)\<`TData`\>\>
-从本地缓存读取数据。
-#### Type parameters
-• **TData** = `unknown`
-#### Parameters
-• **params**: [`GetStorageParams`](doubao-apps-sdk-open-api.md#getstorageparams)
-查询参数，字段见 [GetStorageParams](doubao-apps-sdk-open-api.md#getstorageparams)。
-#### Returns
-`Promise`\<[`GetStorageResult`](doubao-apps-sdk-open-api.md#getstorageresulttdata)\<`TData`\>\>
-返回一个 Promise，解析为 [GetStorageResult](doubao-apps-sdk-open-api.md#getstorageresulttdata)。
-#### 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);
-```
-***
-### getStorageInfo()
-> **getStorageInfo**(`params`?): `Promise`\<[`GetStorageInfoResult`](doubao-apps-sdk-open-api.md#getstorageinforesult)\>
-获取本地缓存信息。
-#### Parameters
-• **params?**
-#### Returns
-`Promise`\<[`GetStorageInfoResult`](doubao-apps-sdk-open-api.md#getstorageinforesult)\>
-返回一个 Promise，解析为 [GetStorageInfoResult](doubao-apps-sdk-open-api.md#getstorageinforesult)。
-#### Example
-```typescript
-import { getStorageInfo } from '@doubao-apps/framework/api';
-const result = await getStorageInfo();
-console.log(result.keys, result.currentSize, result.limitSize);
-```
-***
-### getStorageInfoSync()
-> **getStorageInfoSync**(`params`?): [`GetStorageInfoResult`](doubao-apps-sdk-open-api.md#getstorageinforesult)
-同步获取本地缓存信息。
-#### Parameters
-• **params?**
-#### Returns
-[`GetStorageInfoResult`](doubao-apps-sdk-open-api.md#getstorageinforesult)
-返回 [GetStorageInfoResult](doubao-apps-sdk-open-api.md#getstorageinforesult)。
-#### Example
-```typescript
-import { getStorageInfoSync } from '@doubao-apps/framework/api';
-const result = getStorageInfoSync();
-console.log(result.keys, result.currentSize, result.limitSize);
-```
-***
-### getStorageSync()
-> **getStorageSync**\<`TData`\>(`params`): [`GetStorageResult`](doubao-apps-sdk-open-api.md#getstorageresulttdata)\<`TData`\>
-从本地缓存同步读取数据。
-#### Type parameters
-• **TData** = `unknown`
-#### Parameters
-• **params**: [`GetStorageParams`](doubao-apps-sdk-open-api.md#getstorageparams)
-查询参数，字段见 [GetStorageParams](doubao-apps-sdk-open-api.md#getstorageparams)。
-#### Returns
-[`GetStorageResult`](doubao-apps-sdk-open-api.md#getstorageresulttdata)\<`TData`\>
-返回 [GetStorageResult](doubao-apps-sdk-open-api.md#getstorageresulttdata)。
-#### 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);
-```
-***
-### getWifiList()
-> **getWifiList**(`params`?): `Promise`\<[`GetWifiListResult`](doubao-apps-sdk-open-api.md#getwifilistresult)\>
-获取 Wi-Fi 列表。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<[`GetWifiListResult`](doubao-apps-sdk-open-api.md#getwifilistresult)\>
-***
-### getWindowInfo()
-> **getWindowInfo**(`_params`?): `Promise`\<[`GetWindowInfoResult`](doubao-apps-sdk-open-api.md#getwindowinforesult)\>
-获取窗口信息。
-#### Parameters
-• **\_params?**
-#### Returns
-`Promise`\<[`GetWindowInfoResult`](doubao-apps-sdk-open-api.md#getwindowinforesult)\>
-返回窗口尺寸、状态栏高度和安全区域等信息，字段见 [GetWindowInfoResult](doubao-apps-sdk-open-api.md#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);
-```
-***
-### getWindowInfoSync()
-> **getWindowInfoSync**(`_param`?): [`GetWindowInfoResult`](doubao-apps-sdk-open-api.md#getwindowinforesult)
-获取窗口信息。
-#### Parameters
-• **\_param?**
-#### Returns
-[`GetWindowInfoResult`](doubao-apps-sdk-open-api.md#getwindowinforesult)
-返回窗口尺寸、状态栏高度和安全区域等信息，字段见 [GetWindowInfoResult](doubao-apps-sdk-open-api.md#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);
-```
-***
-### hideKeyboard()
-> **hideKeyboard**(`params`?): `Promise`\<`object`\>
-收起键盘。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### isBluetoothDevicePaired()
-> **isBluetoothDevicePaired**(`params`): `Promise`\<`object`\>
-查询蓝牙设备是否已经配对。
-#### Parameters
-• **params**: [`IsBluetoothDevicePairedParams`](doubao-apps-sdk-open-api.md#isbluetoothdevicepairedparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### login()
-> **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
-***
-### loginWithDoubaoWidget()
-> **loginWithDoubaoWidget**(`params`): `Promise`\<[`LoginWithWidgetResult`](doubao-apps-sdk-open-api.md#loginwithwidgetresult)\>
-Initiate login
-#### Parameters
-• **params**: [`LoginWithWidgetRequest`](doubao-apps-sdk-open-api.md#loginwithwidgetrequest)
-Login parameters
-#### Returns
-`Promise`\<[`LoginWithWidgetResult`](doubao-apps-sdk-open-api.md#loginwithwidgetresult)\>
-Returns a Promise containing the login credential code
-***
-### makeBluetoothPair()
-> **makeBluetoothPair**(`params`): `Promise`\<`object`\>
-发起蓝牙配对。
-#### Parameters
-• **params**: [`MakeBluetoothPairParams`](doubao-apps-sdk-open-api.md#makebluetoothpairparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### makePhoneCall()
-> **makePhoneCall**(`params`): `Promise`\<`object`\>
+## 设备 / 电话
 拨打电话。
-#### Parameters
-• **params**: [`MakePhoneCallParams`](doubao-apps-sdk-open-api.md#makephonecallparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### navigateBack()
-> **navigateBack**(`params`?): `Promise`\<`object`\>
-关闭当前页面，返回上一页面或多级页面。
-#### Parameters
-• **params?**: [`NavigateBackParams`](doubao-apps-sdk-open-api.md#navigatebackparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### navigateTo()
-> **navigateTo**(`params`): `Promise`\<`object`\>
-保留当前页面，跳转到应用内的某个页面。
-#### Parameters
-• **params**: [`NavigateToParams`](doubao-apps-sdk-open-api.md#navigatetoparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### notifyBLECharacteristicValueChange()
-> **notifyBLECharacteristicValueChange**(`params`): `Promise`\<`object`\>
-订阅 BLE 特征值变化。
-#### Parameters
-• **params**: [`NotifyBLECharacteristicValueChangeParams`](doubao-apps-sdk-open-api.md#notifyblecharacteristicvaluechangeparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### 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 });
-});
-```
-***
-### openApp()
-> **openApp**(`params`): `Promise`\<[`OpenAppResult`](doubao-apps-sdk-open-api.md#openappresult)\>
-Open an external application using a deep link with fallbacks.
-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.
-Returns a Promise that resolves with an execution status and optional message.
-#### 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`\>
-***
-### postLoginResult()
-> **postLoginResult**(`params`): `Promise`\<`object`\>
-Report MCP authorization login credential
-#### Parameters
-• **params**: [`PostLoginResultRequest`](doubao-apps-sdk-open-api.md#postloginresultrequest)
-Post login result parameters
-#### Returns
-`Promise`\<`object`\>
-Returns a Promise that resolves when the report is successful
-***
-### reLaunch()
-> **reLaunch**(`params`): `Promise`\<`object`\>
-#### Parameters
-• **params**: [`NavigateToParams`](doubao-apps-sdk-open-api.md#navigatetoparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### readBLECharacteristicValue()
-> **readBLECharacteristicValue**(`params`): `Promise`\<`object`\>
-读取 BLE 特征值。
-#### Parameters
-• **params**: [`ReadBLECharacteristicValueParams`](doubao-apps-sdk-open-api.md#readblecharacteristicvalueparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### redirectTo()
-> **redirectTo**(`params`): `Promise`\<`object`\>
-关闭当前页面，跳转到应用内的某个页面。
-#### Parameters
-• **params**: [`NavigateToParams`](doubao-apps-sdk-open-api.md#navigatetoparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### removeStorage()
-> **removeStorage**(`params`): `Promise`\<`object`\>
-删除本地缓存中指定 key 的数据。
-#### Parameters
-• **params**: [`RemoveStorageParams`](doubao-apps-sdk-open-api.md#removestorageparams)
-删除参数，字段见 [RemoveStorageParams](doubao-apps-sdk-open-api.md#removestorageparams)。
-#### Returns
-`Promise`\<`object`\>
-返回一个 Promise，删除完成后 resolve。
-#### Example
-```typescript
-import { removeStorage } from '@doubao-apps/framework/api';
-await removeStorage({ key: 'profile' });
-```
-***
-### removeStorageSync()
-> **removeStorageSync**(`params`?): `object`
-删除本地缓存中指定 key 的数据。
-#### Parameters
-• **params?**: [`RemoveStorageParams`](doubao-apps-sdk-open-api.md#removestorageparams)
-删除参数，字段见 [RemoveStorageParams](doubao-apps-sdk-open-api.md#removestorageparams)。
-#### Returns
-`object`
-同步删除完成后返回。
-#### Example
-```typescript
-import { removeStorageSync } from '@doubao-apps/framework/api';
-removeStorageSync({ key: 'profile' });
-```
-***
-### request()
-> **request**(`params`): `Promise`\<[`RequestResponse`](doubao-apps-sdk-open-api.md#requestresponse)\>
-发起网络请求。
-#### Parameters
-• **params**: [`RequestParams`](doubao-apps-sdk-open-api.md#requestparams)
-请求参数，字段见 [RequestParams](doubao-apps-sdk-open-api.md#requestparams)。
-#### Returns
-`Promise`\<[`RequestResponse`](doubao-apps-sdk-open-api.md#requestresponse)\>
-返回一个 Promise，解析为 [RequestResponse](doubao-apps-sdk-open-api.md#requestresponse)。
-#### 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);
-```
-***
-### requestOrder()
-> **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()
-> **scanCode**(`params`?): `Promise`\<[`ScanCodeResult`](doubao-apps-sdk-open-api.md#scancoderesult)\>
-调起扫码能力。
-#### Parameters
-• **params?**: [`ScanCodeParams`](doubao-apps-sdk-open-api.md#scancodeparams)
-#### Returns
-`Promise`\<[`ScanCodeResult`](doubao-apps-sdk-open-api.md#scancoderesult)\>
-***
-### sendHCEMessage()
-> **sendHCEMessage**(`params`): `Promise`\<`object`\>
-发送 HCE 消息。
-#### Parameters
-• **params**: [`SendHCEMessageParams`](doubao-apps-sdk-open-api.md#sendhcemessageparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### sendQueryMessage()
-> **sendQueryMessage**(`params`): `void`
-以用户身份发送一条消息
-由于会自动获取页面上下文来确定向哪个 bot 发送消息，因此只能在卡片或页面中调用
-#### Parameters
-• **params**: [`SendQueryMessageParams`](doubao-apps-sdk-open-api.md#sendquerymessageparams)
-#### Returns
-`void`
-#### Example
-```ts
-await sendQueryMessage({ content: '订阅消息', type: 'text' })
-```
-***
-### sendSms()
-> **sendSms**(`params`?): `Promise`\<`object`\>
-拉起系统短信发送面板。
-#### Parameters
-• **params?**: [`SendSmsParams`](doubao-apps-sdk-open-api.md#sendsmsparams)
-#### Returns
-`Promise`\<`object`\>
-返回一个 Promise，在成功拉起短信发送面板时解析。
-#### Example
-```typescript
-import { sendSms } from '@doubao-apps/framework/api';
-await sendSms({
-  phoneNumber: '10086',
-  message: '查询话费'
-});
-```
-***
-### setAdditionalContext()
-> **setAdditionalContext**(`params`): `Promise`\<`object`\>
-设置全局上下文供大模型理解
-#### Parameters
-• **params**
-• **params.additionalContext**: `string`
-上下文内容
-• **params.botId?**: `string`
-指定 bot id
-#### Returns
-`Promise`\<`object`\>
-***
-### setBLEMTU()
-> **setBLEMTU**(`params`): `Promise`\<[`SetBLEMTUResult`](doubao-apps-sdk-open-api.md#setblemturesult)\>
-设置 BLE MTU。
-#### Parameters
-• **params**: [`SetBLEMTUParams`](doubao-apps-sdk-open-api.md#setblemtuparams)
-#### Returns
-`Promise`\<[`SetBLEMTUResult`](doubao-apps-sdk-open-api.md#setblemturesult)\>
-***
-### setClipboardData()
-> **setClipboardData**(`params`): `Promise`\<`object`\>
-设置系统剪贴板内容。
-#### Parameters
-• **params**: [`SetClipboardDataParams`](doubao-apps-sdk-open-api.md#setclipboarddataparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### setKeepScreenOn()
-> **setKeepScreenOn**(`params`): `Promise`\<`object`\>
-设置屏幕常亮状态。
-#### Parameters
-• **params**: [`SetKeepScreenOnParams`](doubao-apps-sdk-open-api.md#setkeepscreenonparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### setScreenBrightness()
-> **setScreenBrightness**(`params`): `Promise`\<`object`\>
-设置屏幕亮度。
-#### Parameters
-• **params**: [`SetScreenBrightnessParams`](doubao-apps-sdk-open-api.md#setscreenbrightnessparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### setStorage()
-> **setStorage**\<`TData`\>(`params`): `Promise`\<`object`\>
-将数据写入本地缓存。
-#### Type parameters
-• **TData** = `unknown`
-#### Parameters
-• **params**: [`SetStorageParams`](doubao-apps-sdk-open-api.md#setstorageparamstdata)\<`TData`\>
-存储参数，字段见 [SetStorageParams](doubao-apps-sdk-open-api.md#setstorageparamstdata)。
-#### Returns
-`Promise`\<`object`\>
-返回一个 Promise，写入完成后 resolve。
-#### Example
-```typescript
-import { setStorage } from '@doubao-apps/framework/api';
-await setStorage({
-  key: 'profile',
-  data: { name: 'Tom', age: 18 },
-});
-```
-***
-### setStorageSync()
-> **setStorageSync**\<`TData`\>(`params`): `object`
-将数据写入本地缓存。
-#### Type parameters
-• **TData** = `unknown`
-#### Parameters
-• **params**: [`SetStorageParams`](doubao-apps-sdk-open-api.md#setstorageparamstdata)\<`TData`\>
-存储参数，字段见 [SetStorageParams](doubao-apps-sdk-open-api.md#setstorageparamstdata)。
-#### Returns
-`object`
-同步写入完成后返回。
-#### Example
-```typescript
-import { setStorageSync } from '@doubao-apps/framework/api';
-setStorageSync({
-  key: 'profile',
-  data: { name: 'Tom', age: 18 },
-});
-```
-***
-### setVisualEffectOnCapture()
-> **setVisualEffectOnCapture**(`params`?): `Promise`\<`object`\>
-设置截屏或录屏时的视觉表现。
-#### Parameters
-• **params?**: [`SetVisualEffectOnCaptureParams`](doubao-apps-sdk-open-api.md#setvisualeffectoncaptureparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### setWifiList()
-> **setWifiList**(`params`): `Promise`\<`object`\>
-设置 Wi-Fi 预设列表。
-#### Parameters
-• **params**: [`SetWifiListParams`](doubao-apps-sdk-open-api.md#setwifilistparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### showToast()
-> **showToast**(`params`): `Promise`\<`object`\>
-显示 Toast 提示。
-参数 `options` 包含以下字段：
-- `message`: 提示的内容。
-- `type`: Toast 的类型，可选值为 'success' 或 'error'。
-- `duration`: 提示的延迟时间，单位毫秒，默认为 2000。
-- `icon`: 图标，可选值为 'success', 'error', 'warn'。
-- `customIcon`: 自定义图标的 URL 或 base64 字符串。
-#### Parameters
-• **params**: [`ShowToastParams`](doubao-apps-sdk-open-api.md#showtoastparams)
-#### Returns
-`Promise`\<`object`\>
-返回一个 Promise，在 Toast 显示结束时 resolve。
-#### Example
-```typescript
-import { showToast } from '@byted-doubao-apps/framework';
-// 显示一个成功的 Toast
-showToast({
-  message: '操作成功',
-  type: 'success',
-  icon: 'success',
-  duration: 1500
-}).then(() => {
-  console.log('Toast 显示完毕');
-});
-// 显示一个错误的 Toast
-showToast({
-  message: '网络错误',
-  type: 'error',
-  icon: 'error'
-});
-```
-***
-### startAccelerometer()
-> **startAccelerometer**(`params`?): `Promise`\<`object`\>
-开始监听加速度。
-#### Parameters
-• **params?**: [`StartAccelerometerParams`](doubao-apps-sdk-open-api.md#startaccelerometerparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### startBeaconDiscovery()
-> **startBeaconDiscovery**(`params`): `Promise`\<`object`\>
-开始搜索附近的 iBeacon。
-#### Parameters
-• **params**: [`StartBeaconDiscoveryParams`](doubao-apps-sdk-open-api.md#startbeacondiscoveryparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### startBluetoothDevicesDiscovery()
-> **startBluetoothDevicesDiscovery**(`params`?): `Promise`\<`object`\>
-开始搜索附近的蓝牙设备。
-#### Parameters
-• **params?**: [`StartBluetoothDevicesDiscoveryParams`](doubao-apps-sdk-open-api.md#startbluetoothdevicesdiscoveryparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### startCompass()
-> **startCompass**(`params`?): `Promise`\<`object`\>
-开始监听罗盘。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### startDeviceMotionListening()
-> **startDeviceMotionListening**(`params`?): `Promise`\<`object`\>
-开始监听设备方向变化。
-#### Parameters
-• **params?**: [`StartDeviceMotionListeningParams`](doubao-apps-sdk-open-api.md#startdevicemotionlisteningparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### startGyroscope()
-> **startGyroscope**(`params`?): `Promise`\<`object`\>
-开始监听陀螺仪。
-#### Parameters
-• **params?**: [`StartGyroscopeParams`](doubao-apps-sdk-open-api.md#startgyroscopeparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### startHCE()
-> **startHCE**(`params`): `Promise`\<`object`\>
-开启 HCE。
-#### Parameters
-• **params**: [`StartHCEParams`](doubao-apps-sdk-open-api.md#starthceparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### startWifi()
-> **startWifi**(`params`?): `Promise`\<`object`\>
-初始化 Wi-Fi 模块。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### stopAccelerometer()
-> **stopAccelerometer**(`params`?): `Promise`\<`object`\>
-停止监听加速度。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### stopBeaconDiscovery()
-> **stopBeaconDiscovery**(`params`?): `Promise`\<`object`\>
-停止搜索附近的 iBeacon。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### stopBluetoothDevicesDiscovery()
-> **stopBluetoothDevicesDiscovery**(`params`?): `Promise`\<`object`\>
-停止搜索附近的蓝牙设备。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### stopCompass()
-> **stopCompass**(`params`?): `Promise`\<`object`\>
-停止监听罗盘。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### stopDeviceMotionListening()
-> **stopDeviceMotionListening**(`params`?): `Promise`\<`object`\>
-停止监听设备方向变化。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### stopGyroscope()
-> **stopGyroscope**(`params`?): `Promise`\<`object`\>
-停止监听陀螺仪。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### stopHCE()
-> **stopHCE**(`params`?): `Promise`\<`object`\>
-停止 HCE。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### stopWifi()
-> **stopWifi**(`params`?): `Promise`\<`object`\>
-关闭 Wi-Fi 模块。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### updateModelContext()
-> **updateModelContext**(`params`?): `Promise`\<`object`\>
-前端数据捐献接口：上报当前业务状态/关键信息（blocks）。
-#### Parameters
-• **params?**: [`UpdateModelContextOptions`](doubao-apps-sdk-open-api.md#updatemodelcontextoptions)
-#### Returns
-`Promise`\<`object`\>
-***
-### vibrateLong()
-> **vibrateLong**(`params`?): `Promise`\<`object`\>
-触发长震动。
-#### Parameters
-• **params?**: `Record`\<`string`, `never`\>
-#### Returns
-`Promise`\<`object`\>
-***
-### vibrateShort()
-> **vibrateShort**(`params`?): `Promise`\<`object`\>
-触发短震动。
-#### Parameters
-• **params?**: [`VibrateShortParams`](doubao-apps-sdk-open-api.md#vibrateshortparams)
-#### Returns
-`Promise`\<`object`\>
-***
-### writeBLECharacteristicValue()
-> **writeBLECharacteristicValue**(`params`): `Promise`\<`object`\>
-写入 BLE 特征值。
-#### Parameters
-• **params**: [`WriteBLECharacteristicValueParams`](doubao-apps-sdk-open-api.md#writeblecharacteristicvalueparams)
-#### Returns
-`Promise`\<`object`\>
-## Interfaces
-### AddPhoneCalendarParams
-添加系统日历事件的请求参数。
-#### Extended by
-- [`AddPhoneRepeatCalendarParams`](doubao-apps-sdk-open-api.md#addphonerepeatcalendarparams)
-#### Properties
-##### alarm?
-> `optional` **alarm**: `boolean`
-是否提醒。
-##### alarmOffset?
-> `optional` **alarmOffset**: `number`
-提前提醒时间，单位秒。
-##### allDay?
-> `optional` **allDay**: `boolean`
-是否为全天事件。
-##### description?
-> `optional` **description**: `string`
-事件描述。
-##### endTime?
-> `optional` **endTime**: `number`
-结束时间的 Unix 秒级时间戳。
-##### location?
-> `optional` **location**: `string`
-事件位置。
-##### startTime
-> **startTime**: `number`
-开始时间的 Unix 秒级时间戳。
-##### title
-> **title**: `string`
-日历事件标题。
-***
-### AddPhoneContactParams
-添加手机联系人的请求参数。
-#### Properties
-##### addressCity?
-> `optional` **addressCity**: `string`
-家庭地址城市。
-##### addressCountry?
-> `optional` **addressCountry**: `string`
-家庭地址国家。
-##### addressPostalCode?
-> `optional` **addressPostalCode**: `string`
-家庭地址邮编。
-##### addressState?
-> `optional` **addressState**: `string`
-家庭地址省份。
-##### addressStreet?
-> `optional` **addressStreet**: `string`
-家庭地址街道。
-##### email?
-> `optional` **email**: `string`
-电子邮件。
-##### firstName
-> **firstName**: `string`
-名字。
-##### homeAddressCity?
-> `optional` **homeAddressCity**: `string`
-家庭地址城市。
-##### homeAddressCountry?
-> `optional` **homeAddressCountry**: `string`
-家庭地址国家。
-##### homeAddressPostalCode?
-> `optional` **homeAddressPostalCode**: `string`
-家庭地址邮编。
-##### homeAddressState?
-> `optional` **homeAddressState**: `string`
-家庭地址省份。
-##### homeAddressStreet?
-> `optional` **homeAddressStreet**: `string`
-家庭地址街道。
-##### homeFaxNumber?
-> `optional` **homeFaxNumber**: `string`
-家庭传真。
-##### homePhoneNumber?
-> `optional` **homePhoneNumber**: `string`
-家庭电话。
-##### hostNumber?
-> `optional` **hostNumber**: `string`
-公司电话。
-##### lastName?
-> `optional` **lastName**: `string`
-姓。
-##### middleName?
-> `optional` **middleName**: `string`
-中间名。
-##### mobilePhoneNumber?
-> `optional` **mobilePhoneNumber**: `string`
-手机号。
-##### nickName?
-> `optional` **nickName**: `string`
-昵称。
-##### organization?
-> `optional` **organization**: `string`
-公司。
-##### photoFilePath?
-> `optional` **photoFilePath**: `string`
-头像文件路径。
-##### remark?
-> `optional` **remark**: `string`
-备注。
-##### title?
-> `optional` **title**: `string`
-职位。
-##### url?
-> `optional` **url**: `string`
-个人网站。
-##### weChatNumber?
-> `optional` **weChatNumber**: `string`
-微信号。
-##### workAddressCity?
-> `optional` **workAddressCity**: `string`
-工作地址城市。
-##### workAddressCountry?
-> `optional` **workAddressCountry**: `string`
-工作地址国家。
-##### workAddressPostalCode?
-> `optional` **workAddressPostalCode**: `string`
-工作地址邮编。
-##### workAddressState?
-> `optional` **workAddressState**: `string`
-工作地址省份。
-##### workAddressStreet?
-> `optional` **workAddressStreet**: `string`
-工作地址街道。
-##### workFaxNumber?
-> `optional` **workFaxNumber**: `string`
-工作传真。
-##### workPhoneNumber?
-> `optional` **workPhoneNumber**: `string`
-工作电话。
-***
-### AddPhoneRepeatCalendarParams
-添加重复日历事件的请求参数。
-#### Extends
-- [`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams)
-#### Properties
-##### alarm?
-> `optional` **alarm**: `boolean`
-是否提醒。
-###### Inherited from
-[`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams).[`alarm`](doubao-apps-sdk-open-api.md#alarm)
-##### alarmOffset?
-> `optional` **alarmOffset**: `number`
-提前提醒时间，单位秒。
-###### Inherited from
-[`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams).[`alarmOffset`](doubao-apps-sdk-open-api.md#alarmoffset)
-##### allDay?
-> `optional` **allDay**: `boolean`
-是否为全天事件。
-###### Inherited from
-[`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams).[`allDay`](doubao-apps-sdk-open-api.md#allday)
-##### description?
-> `optional` **description**: `string`
-事件描述。
-###### Inherited from
-[`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams).[`description`](doubao-apps-sdk-open-api.md#description)
-##### endTime?
-> `optional` **endTime**: `number`
-结束时间的 Unix 秒级时间戳。
-###### Inherited from
-[`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams).[`endTime`](doubao-apps-sdk-open-api.md#endtime)
-##### location?
-> `optional` **location**: `string`
-事件位置。
-###### Inherited from
-[`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams).[`location`](doubao-apps-sdk-open-api.md#location)
-##### repeatEndTime?
-> `optional` **repeatEndTime**: `number`
-重复结束时间的 Unix 秒级时间戳。
-##### repeatInterval?
-> `optional` **repeatInterval**: [`CalendarRepeatInterval`](doubao-apps-sdk-open-api.md#calendarrepeatinterval)
-重复周期。
-##### startTime
-> **startTime**: `number`
-开始时间的 Unix 秒级时间戳。
-###### Inherited from
-[`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams).[`startTime`](doubao-apps-sdk-open-api.md#starttime)
-##### title
-> **title**: `string`
-日历事件标题。
-###### Inherited from
-[`AddPhoneCalendarParams`](doubao-apps-sdk-open-api.md#addphonecalendarparams).[`title`](doubao-apps-sdk-open-api.md#title)
-***
-### AppBaseInfoHost
-#### Properties
-##### appId
-> **appId**: `string`
-宿主 app 对应的 appId
-***
-### AuthorizeRequest
-#### Properties
-##### scope
-> **scope**: [`Scope`](doubao-apps-sdk-open-api.md#scope-1)
-授权范围
-***
-### BeaconInfo
-iBeacon 设备信息。
-#### Properties
-##### accuracy
-> **accuracy**: `number`
-距离，单位米。
-##### major
-> **major**: `string`
-主 ID。
-##### minor
-> **minor**: `string`
-次 ID。
-##### proximity
-> **proximity**: [`BeaconProximity`](doubao-apps-sdk-open-api.md#beaconproximity)
-距离等级。
-##### rssi
-> **rssi**: `number`
-RSSI 信号强度，单位 dBm。
-##### uuid
-> **uuid**: `string`
-Beacon UUID。
-***
-### BluetoothCharacteristic
-蓝牙特征值信息。
-#### Properties
-##### properties
-> **properties**: [`BluetoothCharacteristicProperties`](doubao-apps-sdk-open-api.md#bluetoothcharacteristicproperties)
-特征值能力。
-##### uuid
-> **uuid**: `string`
-特征值 UUID。
-***
-### BluetoothCharacteristicProperties
-蓝牙特征值支持的能力。
-#### Properties
-##### indicate
-> **indicate**: `boolean`
-是否支持 indicate。
-##### notify
-> **notify**: `boolean`
-是否支持 notify。
-##### read
-> **read**: `boolean`
-是否支持 read。
-##### write
-> **write**: `boolean`
-是否支持 write。
-##### writeDefault
-> **writeDefault**: `boolean`
-是否支持带响应写入。
-##### writeNoResponse
-> **writeNoResponse**: `boolean`
-是否支持无响应写入。
-***
-### BluetoothDevice
-蓝牙设备信息。
-#### Properties
-##### advertisingData
-> **advertisingData**: `ArrayBuffer`
-广播二进制数据。
-##### advertisingServiceUuids
-> **advertisingServiceUuids**: `string`[]
-广播中的服务 UUID 列表。
-##### connectable?
-> `optional` **connectable**: `boolean`
-是否可连接。
-##### deviceId
-> **deviceId**: `string`
-设备 ID。
-##### localName
-> **localName**: `string`
-广播中的本地名称。
-##### name
-> **name**: `string`
-设备名称。
-##### rssi
-> **rssi**: `number`
-RSSI 信号强度，单位 dBm。
-##### serviceData
-> **serviceData**: `Record`\<`string`, `unknown`\>
-广播中的服务数据。
-***
-### BluetoothService
-蓝牙服务信息。
-#### Properties
-##### isPrimary
-> **isPrimary**: `boolean`
-是否为主服务。
-##### uuid
-> **uuid**: `string`
-服务 UUID。
-***
-### CanIUseParams
-#### Properties
-##### schema
-> **schema**: `string`
-***
-### CanIUseResult
-#### Properties
-##### result
-> **result**: `boolean`
-***
-### CheckIsOpenAccessibilityResult
-无障碍能力检测结果。
-#### Properties
-##### open
-> **open**: `boolean`
-是否开启视觉无障碍能力。
-***
-### ChooseContactResult
-选取联系人后的返回结果。
-#### Properties
-##### displayName
-> **displayName**: `string`
-联系人名称。
-##### phoneNumber
-> **phoneNumber**: `string`
-选中的手机号。
-##### phoneNumberList
-> **phoneNumberList**: `string`[]
-联系人所有手机号。
-***
-### CloseBLEConnectionParams
-关闭 BLE 连接的请求参数。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-***
-### CloseParams
-#### Properties
-##### containerID?
-> `optional` **containerID**: `string`
-指定一个要关闭的页面
-***
-### ConnectWifiParams
-连接 Wi-Fi 的请求参数。
-#### Properties
-##### bssid?
-> `optional` **bssid**: `string`
-Wi-Fi BSSID。
-##### manual?
-> `optional` **manual**: `boolean`
-是否跳转到系统设置页连接。
-##### partialInfo?
-> `optional` **partialInfo**: `boolean`
-是否仅返回部分 Wi-Fi 信息。
-##### password
-> **password**: `string`
-Wi-Fi 密码。
-##### ssid
-> **ssid**: `string`
-Wi-Fi SSID。
-***
-### ConnectedBluetoothDevice
-已连接蓝牙设备信息。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-设备 ID。
-##### name
-> **name**: `string`
-设备名称。
-***
-### CreateBLEConnectionParams
-创建 BLE 连接的请求参数。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-##### timeout?
-> `optional` **timeout**: `number`
-超时时间，单位毫秒。
-***
-### DoubaoAppAccountInfo
-豆包 App 账号信息。
-#### Properties
-##### appId
-> **appId**: `string`
-豆包 App appId
-##### envVersion
-> **envVersion**: `"develop"` \| `"trial"` \| `"release"`
-豆包 App 运行环境。
-- develop: 开发版
-- trial: 体验版
-- release: 正式版
-##### version
-> **version**: `string`
-线上豆包 App 版本号。
-***
-### GetAccountInfoResult
-获取当前账号信息。
-#### Properties
-##### miniProgram
-> **miniProgram**: [`DoubaoAppAccountInfo`](doubao-apps-sdk-open-api.md#doubaoappaccountinfo)
-豆包 App账号信息
-##### plugin?
-> `optional` **plugin**: [`PluginAccountInfo`](doubao-apps-sdk-open-api.md#pluginaccountinfo)
-插件账号信息（仅在插件中调用时包含）
-***
-### GetAppBaseInfoResult
-#### Properties
-##### SDKVersion?
-> `optional` **SDKVersion**: `string`
-客户端基础库版本
-##### enableDebug?
-> `optional` **enableDebug**: `boolean`
-是否已打开调试
-##### host?
-> `optional` **host**: [`AppBaseInfoHost`](doubao-apps-sdk-open-api.md#appbaseinfohost)
-当前豆包 App运行的宿主环境
-##### language
-> **language**: `string`
-当前语言
-##### theme?
-> `optional` **theme**: `"light"` \| `"dark"`
-当前主题
-##### version?
-> `optional` **version**: `string`
-宿主版本号
-***
-### GetBLEDeviceCharacteristicsParams
-获取 BLE 特征值列表的请求参数。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-##### serviceId
-> **serviceId**: `string`
-服务 ID。
-***
-### GetBLEDeviceCharacteristicsResult
-获取 BLE 特征值列表的返回结果。
-#### Properties
-##### characteristics
-> **characteristics**: [`BluetoothCharacteristic`](doubao-apps-sdk-open-api.md#bluetoothcharacteristic)[]
-特征值列表。
-***
-### GetBLEDeviceRSSIParams
-获取 BLE RSSI 的请求参数。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-***
-### GetBLEDeviceRSSIResult
-获取 BLE RSSI 的返回结果。
-#### Properties
-##### rssi
-> **rssi**: `number`
-RSSI 信号强度，单位 dBm。
-***
-### GetBLEDeviceServicesParams
-获取 BLE 服务列表的请求参数。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-***
-### GetBLEDeviceServicesResult
-获取 BLE 服务列表的返回结果。
-#### Properties
-##### services
-> **services**: [`BluetoothService`](doubao-apps-sdk-open-api.md#bluetoothservice)[]
-设备服务列表。
-***
-### GetBLEMTUParams
-获取 BLE MTU 的请求参数。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-##### writeType?
-> `optional` **writeType**: [`BluetoothWriteType`](doubao-apps-sdk-open-api.md#bluetoothwritetype)
-写入模式。
-***
-### GetBLEMTUResult
-获取 BLE MTU 的返回结果。
-#### Properties
-##### mtu
-> **mtu**: `number`
-当前 MTU。
-***
-### GetBatteryInfoResult
-电池信息。
-#### Properties
-##### isCharging
-> **isCharging**: `boolean`
-是否正在充电。
-##### level
-> **level**: `number`
-当前电量，范围 1 - 100。
-***
-### GetBeaconsResult
-获取 iBeacon 列表的返回结果。
-#### Properties
-##### beacons
-> **beacons**: [`BeaconInfo`](doubao-apps-sdk-open-api.md#beaconinfo)[]
-当前搜到的 iBeacon 列表。
-***
-### GetBluetoothAdapterStateResult
-蓝牙适配器状态。
-#### Properties
-##### available
-> **available**: `boolean`
-蓝牙适配器是否可用。
-##### discovering
-> **discovering**: `boolean`
-是否正在搜索蓝牙设备。
-***
-### GetBluetoothDevicesResult
-获取蓝牙设备列表的返回结果。
-#### Properties
-##### devices
-> **devices**: [`BluetoothDevice`](doubao-apps-sdk-open-api.md#bluetoothdevice)[]
-当前蓝牙模块已发现的设备列表。
-***
-### GetClipboardDataResult
-剪贴板读取结果。
-#### Properties
-##### data
-> **data**: `string`
-当前剪贴板内容。
-***
-### GetConnectedBluetoothDevicesParams
-获取已连接蓝牙设备的请求参数。
-#### Properties
-##### services
-> **services**: `string`[]
-蓝牙主服务 UUID 列表。
-***
-### GetConnectedBluetoothDevicesResult
-获取已连接蓝牙设备的返回结果。
-#### Properties
-##### devices
-> **devices**: [`ConnectedBluetoothDevice`](doubao-apps-sdk-open-api.md#connectedbluetoothdevice)[]
-已连接设备列表。
-***
-### GetConnectedWifiParams
-获取当前已连接 Wi-Fi 的请求参数。
-#### Properties
-##### partialInfo?
-> `optional` **partialInfo**: `boolean`
-是否只返回部分 Wi-Fi 信息。
-***
-### GetConnectedWifiResult
-获取当前已连接 Wi-Fi 的返回结果。
-#### Properties
-##### wifi
-> **wifi**: [`WifiInfo`](doubao-apps-sdk-open-api.md#wifiinfo)
-当前连接的 Wi-Fi 信息。
-***
-### GetLocalIPAddressResult
-获取局域网 IP 的返回结果。
-#### Properties
-##### localIp
-> **localIp**: `string`
-本机局域网 IP 地址。
-##### netmask?
-> `optional` **netmask**: `string`
-子网掩码。
-***
-### GetLocationParams
-#### Properties
-##### maxCacheMs?
-> `optional` **maxCacheMs**: `number`
-缓存时间，单位毫秒，默认为0
-##### mode?
-> `optional` **mode**: `number`
-定位模式
-0：低功耗
-1：仅设备
-2：高精度（默认）
-##### source?
-> `optional` **source**: `string`
-调用业务方
-##### timeoutMs?
-> `optional` **timeoutMs**: `number`
-超时时间，单位毫秒，默认 30000
-***
-### GetLocationResponse
-#### Properties
-##### accuracy
-> **accuracy**: `number`
-定位精度，单位：米
-##### latitude
-> **latitude**: `number`
-纬度
-##### longitude
-> **longitude**: `number`
-经度
-##### speed
-> **speed**: `number`
-行进速度，单位：米/秒
-##### timestamp
-> **timestamp**: `string`
-时间戳
-***
-### GetNetworkTypeParams
-获取网络类型的请求参数。
-当前无需传入任何字段，预留扩展位。
-***
-### GetNetworkTypeResult
-获取网络类型的返回结果。
-#### Properties
-##### hasSystemProxy?
-> `optional` **hasSystemProxy**: `boolean`
-设备是否使用了系统代理。
-##### networkType
-> **networkType**: [`NetworkType`](doubao-apps-sdk-open-api.md#networktype-1)
-当前网络类型。
-##### signalStrength?
-> `optional` **signalStrength**: `number`
-信号强弱，单位 dBm。
-##### weakNet?
-> `optional` **weakNet**: `boolean`
-是否处于弱网环境。
-***
-### GetOrderPaymentParams
-#### Properties
-##### orderId
-> **orderId**: `string`
-***
-### GetOrderPaymentResult
-#### Properties
-##### logId
-> **logId**: `string`
-##### orderId
-> **orderId**: `string`
-***
-### GetRandomValuesParams
-获取安全随机数的请求参数。
-#### Properties
-##### length
-> **length**: `number`
-需要生成的字节数。
-***
-### GetRandomValuesResult
-获取安全随机数的返回结果。
-#### Properties
-##### randomValues
-> **randomValues**: `ArrayBuffer`
-生成的随机字节。
-***
-### GetScreenBrightnessResult
-#### Properties
-##### value
-> **value**: `number`
-屏幕亮度值，范围 0 ~ 1，0 最暗，1 最亮
-***
-### GetSelectedTextRangeResult
-获取输入框选区范围的返回结果。
-#### Properties
-##### end
-> **end**: `number`
-选区结束位置。
-##### start
-> **start**: `number`
-选区起始位置。
-***
-### GetStorageInfoResult
-#### Properties
-##### currentSize
-> **currentSize**: `number`
-当前占用的空间大小，单位 KB
-##### keys
-> **keys**: `string`[]
-当前 storage 中所有的 key
-##### limitSize
-> **limitSize**: `number`
-限制的空间大小，单位 KB
-***
-### GetStorageParams
-#### Properties
-##### key
-> **key**: `string`
-本地缓存键名
-***
-### GetStorageResult\<TData\>
-#### Type parameters
-• **TData** = `unknown`
-#### Properties
-##### data
-> **data**: `TData`
-key 对应的数据
-***
-### GetWifiListResult
-获取 Wi-Fi 列表的返回结果。
-#### Properties
-##### wifiList
-> **wifiList**: [`WifiInfo`](doubao-apps-sdk-open-api.md#wifiinfo)[]
-当前获取到的 Wi-Fi 列表。
-***
-### GetWindowInfoResult
-#### Properties
-##### pixelRatio
-> **pixelRatio**: `number`
-设备像素比
-##### safeArea?
-> `optional` **safeArea**: [`WindowSafeArea`](doubao-apps-sdk-open-api.md#windowsafearea)
-安全区域
-##### screenHeight
-> **screenHeight**: `number`
-屏幕高度
-##### screenTop
-> **screenTop**: `number`
-窗口上边缘的 y 值
-##### screenWidth
-> **screenWidth**: `number`
-屏幕宽度
-##### statusBarHeight
-> **statusBarHeight**: `number`
-状态栏高度
-##### windowHeight
-> **windowHeight**: `number`
-可使用窗口高度
-##### windowWidth
-> **windowWidth**: `number`
-可使用窗口宽度
-***
-### IsBluetoothDevicePairedParams
-查询蓝牙设备配对状态的请求参数。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-***
-### KeyboardHeightChangeEvent
-#### Properties
-##### height
-> **height**: `number`
-键盘高度，单位 px。
-***
-### LoginRequest
-#### Properties
-##### timeout?
-> `optional` **timeout**: `number`
-Timeout in milliseconds
-***
-### LoginResult
-#### Properties
-##### code
-> **code**: `string`
-Login credential code
-***
-### LoginWithWidgetRequest
-#### Properties
-##### loginType
-> **loginType**: `LoginType`
-Login type identifier
-***
-### LoginWithWidgetResult
-#### Properties
-##### result
-> **result**: `boolean`
-Whether the login is successful
-***
-### MakeBluetoothPairParams
-蓝牙配对请求参数。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-##### pin
-> **pin**: `string`
-配对 PIN 码。
-##### timeout?
-> `optional` **timeout**: `number`
-超时时间，单位毫秒。
-***
-### MakePhoneCallParams
-#### Properties
-##### phoneNumber
-> **phoneNumber**: `string`
-需要拨打的电话号码
-***
-### NavigateBackParams
-#### Properties
-##### delta?
-> `optional` **delta**: `number`
-返回的页面数，如果 delta 大于现有页面数，则返回到页面栈中只剩一个页面为止。
-***
-### NavigateToParams
-#### Properties
-##### url
-> **url**: `string`
-跳转的页面的路径，如 'path?key=value&key2=value2'
-***
-### NotifyBLECharacteristicValueChangeParams
-订阅 BLE 特征值变化的请求参数。
-#### Properties
-##### characteristicId
-> **characteristicId**: `string`
-特征值 ID。
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-##### serviceId
-> **serviceId**: `string`
-服务 ID。
-##### state
-> **state**: `boolean`
-是否启用订阅。
-##### type?
-> `optional` **type**: [`BluetoothNotifyType`](doubao-apps-sdk-open-api.md#bluetoothnotifytype)
-订阅类型。
-***
-### 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
-***
-### OpenAppResult
-#### Properties
-##### status
-> **status**: [`OpenAppStatus`](doubao-apps-sdk-open-api.md#openappstatus)
-Execution status from client
-***
-### OpenBluetoothAdapterParams
-打开蓝牙适配器的请求参数。
-#### Properties
-##### mode?
-> `optional` **mode**: [`BluetoothAdapterMode`](doubao-apps-sdk-open-api.md#bluetoothadaptermode)
-蓝牙模式。
-***
-### PluginAccountInfo
-插件账号信息（仅在插件中调用时包含）。
-#### Properties
-##### appId
-> **appId**: `string`
-插件 appId
-##### version
-> **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
-***
-### PrivacySettingResult
-#### Properties
-##### needAuthorization
-> **needAuthorization**: `boolean`
-Whether user authorization for privacy agreement is required
-***
-### ReadBLECharacteristicValueParams
-读取 BLE 特征值的请求参数。
-#### Properties
-##### characteristicId
-> **characteristicId**: `string`
-特征值 ID。
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-##### serviceId
-> **serviceId**: `string`
-服务 ID。
-***
-### RemoveStorageParams
-#### Properties
-##### key
-> **key**: `string`
-本地缓存键名
-***
-### RequestOrderParams
-#### Properties
-##### data
-> **data**: `string`
-##### dbAuthorization
-> **dbAuthorization**: `string`
-***
-### RequestOrderResult
-#### Properties
-##### logId
-> **logId**: `string`
-##### orderId
-> **orderId**: `string`
-***
-### RequestParams
-网络请求参数。
-#### Properties
-##### data?
-> `optional` **data**: `string` \| `ArrayBuffer` \| `Record`\<`string`, `any`\>
-请求体数据。
-传给服务器的数据最终会是 `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`](doubao-apps-sdk-open-api.md#requestmethod)
-请求方法。
-###### Default
-```ts
-"GET"
-```
-##### url
-> **url**: `string`
-请求地址，需为完整的 **HTTPS** URL。
-***
-### RequestResponse
-网络请求返回结果。
-#### Properties
-##### data?
-> `optional` **data**: `string` \| `ArrayBuffer` \| `Record`\<`string`, `any`\>
-响应数据，类型由 `dataType` 决定。
-##### header
-> **header**: `Record`\<`string`, `string`\>
-HTTP 响应头。
-##### statusCode
-> **statusCode**: `number`
-HTTP 状态码。
-***
-### ScanCodeParams
-扫码请求参数。
-#### Properties
-##### onlyFromCamera?
-> `optional` **onlyFromCamera**: `boolean`
-是否仅允许从相机扫码。
-##### scanType?
-> `optional` **scanType**: [`ScanCodeType`](doubao-apps-sdk-open-api.md#scancodetype)[]
-允许的扫码类型。
-***
-### ScanCodeResult
-扫码返回结果。
-#### Properties
-##### characterSet
-> **characterSet**: `string`
-字符集。
-##### path
-> **path**: `string`
-当前宿主可识别的页面路径。
-##### rawData
-> **rawData**: `string`
-原始数据，通常为 Base64 字符串。
-##### result
-> **result**: `string`
-扫码结果文本。
-##### scanType
-> **scanType**: [`ScanResultType`](doubao-apps-sdk-open-api.md#scanresulttype)
-扫码结果类型。
-***
-### SendHCEMessageParams
-发送 HCE 消息的请求参数。
-#### Properties
-##### data
-> **data**: `ArrayBuffer`
-要发送的二进制数据。
-***
-### SendQueryMessageParams
-#### Properties
-##### content
-> **content**: `string`
-要发送的消息。根据类型不同，序列化方式可能不同
-##### type
-> **type**: `"text"`
-消息类型，目前仅支持 text
-***
-### SendSmsParams
-拉起系统短信发送面板的请求参数。
-#### Properties
-##### message?
-> `optional` **message**: `string`
-预填到发送短信面板的内容。
-##### phoneNumber?
-> `optional` **phoneNumber**: `string`
-预填到发送短信面板的手机号。
-***
-### SetBLEMTUParams
-设置 BLE MTU 的请求参数。
-#### Properties
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-##### mtu
-> **mtu**: `number`
-目标 MTU。
-***
-### SetBLEMTUResult
-设置 BLE MTU 的返回结果。
-#### Properties
-##### mtu
-> **mtu**: `string` \| `number`
-最终协商得到的 MTU。
-***
-### SetClipboardDataParams
-#### Properties
-##### data
-> **data**: `string`
-需要设置的剪贴板内容
-***
-### SetKeepScreenOnParams
-设置屏幕常亮的请求参数。
-#### Properties
-##### keepScreenOn
-> **keepScreenOn**: `boolean`
-是否保持屏幕常亮。
-***
-### SetScreenBrightnessParams
-设置屏幕亮度的请求参数。
-#### Properties
-##### value
-> **value**: `number`
-屏幕亮度值，范围 0 ~ 1。
-***
-### SetStorageParams\<TData\>
-#### Type parameters
-• **TData** = `unknown`
-#### Properties
-##### data
-> **data**: `TData`
-待存储的数据
-##### key
-> **key**: `string`
-本地缓存键名
-***
-### SetVisualEffectOnCaptureParams
-设置截屏或录屏视觉效果的请求参数。
-#### Properties
-##### visualEffect?
-> `optional` **visualEffect**: [`CaptureVisualEffect`](doubao-apps-sdk-open-api.md#capturevisualeffect)
-截屏或录屏时的视觉表现。
-***
-### SetWifiListParams
-设置 Wi-Fi 预设列表的请求参数。
-#### Properties
-##### wifiList
-> **wifiList**: [`WifiListItem`](doubao-apps-sdk-open-api.md#wifilistitem)[]
-预设的 Wi-Fi 列表。
-***
-### 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"`
-***
-### StartAccelerometerParams
-开始监听加速度的请求参数。
-#### Properties
-##### interval?
-> `optional` **interval**: [`SensorInterval`](doubao-apps-sdk-open-api.md#sensorinterval)
-监听频率。
-***
-### StartBeaconDiscoveryParams
-开始搜索 iBeacon 的请求参数。
-#### Properties
-##### ignoreBluetoothAvailable?
-> `optional` **ignoreBluetoothAvailable**: `boolean`
-iOS 下是否忽略蓝牙可用性校验。
-##### uuids
-> **uuids**: `string`[]
-要搜索的 iBeacon UUID 列表。
-***
-### StartBluetoothDevicesDiscoveryParams
-开始搜索蓝牙设备的请求参数。
-#### Properties
-##### allowDuplicatesKey?
-> `optional` **allowDuplicatesKey**: `boolean`
-是否允许重复上报同一设备。
-##### interval?
-> `optional` **interval**: `number`
-上报设备的间隔，单位毫秒。
-##### powerLevel?
-> `optional` **powerLevel**: [`BluetoothPowerLevel`](doubao-apps-sdk-open-api.md#bluetoothpowerlevel)
-扫描功耗等级。
-##### services?
-> `optional` **services**: `string`[]
-按主服务 UUID 过滤搜索范围。
-***
-### StartDeviceMotionListeningParams
-开始监听设备方向变化的请求参数。
-#### Properties
-##### interval?
-> `optional` **interval**: [`SensorInterval`](doubao-apps-sdk-open-api.md#sensorinterval)
-监听频率。
-***
-### StartGyroscopeParams
-开始监听陀螺仪的请求参数。
-#### Properties
-##### interval?
-> `optional` **interval**: [`SensorInterval`](doubao-apps-sdk-open-api.md#sensorinterval)
-监听频率。
-***
-### StartHCEParams
-开启 HCE 的请求参数。
-#### Properties
-##### aidList
-> **aidList**: `string`[]
-需要注册到系统的 AID 列表。
-***
-### UpdateModelContextEntityBlock
-#### Properties
-##### entities
-> **entities**: `Record`\<`string`, `any`\>[]
-##### type
-> **type**: `"entity"`
-***
-### 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'
-        }
-      ]
-    }
-  ]
-});
-```
-#### Properties
-##### content?
-> `optional` **content**: [`UpdateModelContextBlock`](doubao-apps-sdk-open-api.md#updatemodelcontextblock)[]
-blocks 数组，支持 summary/entity 混搭。
-- 顺序不做强约束；建议把 summary 放前面，便于人类阅读。
-- 端侧生成稳定 event_id 时，会从所有 blocks 扫描 type="entity" 的 entities 来提取业务 identity（与顺序无关）。
-##### entity\_meta?
-> `optional` **entity\_meta**: `Record`\<`string`, `any`\>
-可选：业务侧补充元信息（如来源、去重锚点、时序、过期策略等）。
-字段示例：
-- mcpServer: 数据来源 app（例如 caocao）
-- create_time: 业务侧数据发生时间（用于时序）
-- expire_at: 业务侧过期时间（过期后模型不再使用；第一期可能未强制生效）
-- update_url: 预留字段（第一期暂不支持）
-- annotation.hostRestartKeep/systemRestartKeep: 预留字段（第一期可能未强制生效）
-***
-### UpdateModelContextSummaryBlock
-#### Properties
-##### text
-> **text**: `string`
-##### type
-> **type**: `"summary"`
-***
-### VibrateShortParams
-短震动请求参数。
-#### Properties
-##### type?
-> `optional` **type**: [`VibrateShortType`](doubao-apps-sdk-open-api.md#vibrateshorttype)
-震动强度类型。
-***
-### WifiInfo
-Wi-Fi 信息。
-#### Properties
-##### bssid?
-> `optional` **bssid**: `string`
-Wi-Fi BSSID。
-##### frequency?
-> `optional` **frequency**: `number`
-频段，单位 MHz。
-##### secure?
-> `optional` **secure**: `boolean`
-Wi-Fi 是否安全。
-##### signalStrength?
-> `optional` **signalStrength**: `number`
-信号强度。
-##### ssid
-> **ssid**: `string`
-Wi-Fi SSID。
-***
-### WifiListItem
-预设 Wi-Fi 条目。
-#### Properties
-##### bssid?
-> `optional` **bssid**: `string`
-Wi-Fi BSSID。
-##### password?
-> `optional` **password**: `string`
-Wi-Fi 密码。
-##### ssid?
-> `optional` **ssid**: `string`
-Wi-Fi SSID。
-***
-### WindowSafeArea
-#### Properties
-##### bottom
-> **bottom**: `number`
-安全区域右下角纵坐标
-##### height
-> **height**: `number`
-安全区域高度
-##### left
-> **left**: `number`
-安全区域左上角横坐标
-##### right
-> **right**: `number`
-安全区域右下角横坐标
-##### top
-> **top**: `number`
-安全区域左上角纵坐标
-##### width
-> **width**: `number`
-安全区域宽度
-***
-### WriteBLECharacteristicValueParams
-写入 BLE 特征值的请求参数。
-#### Properties
-##### characteristicId
-> **characteristicId**: `string`
-特征值 ID。
-##### deviceId
-> **deviceId**: `string`
-蓝牙设备 ID。
-##### serviceId
-> **serviceId**: `string`
-服务 ID。
-##### value
-> **value**: `ArrayBuffer`
-要写入的二进制数据。
-##### writeType?
-> `optional` **writeType**: [`BluetoothWriteType`](doubao-apps-sdk-open-api.md#bluetoothwritetype)
-写入模式。
-## Type Aliases
-### BeaconProximity
-> **BeaconProximity**: `0` \| `1` \| `2` \| `3`
-iBeacon 距离等级。
-***
-### BluetoothAdapterMode
-> **BluetoothAdapterMode**: `"central"` \| `"peripheral"`
-蓝牙适配器模式。
-***
-### BluetoothNotifyType
-> **BluetoothNotifyType**: `"notification"` \| `"indication"`
-蓝牙特征值订阅类型。
-***
-### BluetoothPowerLevel
-> **BluetoothPowerLevel**: `"low"` \| `"medium"` \| `"high"`
-蓝牙扫描功耗等级。
-***
-### BluetoothWriteType
-> **BluetoothWriteType**: `"write"` \| `"writeNoResponse"`
-蓝牙写入模式。
-***
-### CalendarRepeatInterval
-> **CalendarRepeatInterval**: `"day"` \| `"week"` \| `"month"` \| `"year"`
-日历重复周期。
-***
-### CaptureVisualEffect
-> **CaptureVisualEffect**: `"none"` \| `"hidden"`
-录屏或截屏时的视觉表现。
-***
-### NetworkType
-> **NetworkType**: `"wifi"` \| `"2g"` \| `"3g"` \| `"4g"` \| `"5g"` \| `"unknown"` \| `"none"`
-网络类型。
-- `wifi` - Wi-Fi 网络
-- `2g` - 2G 网络
-- `3g` - 3G 网络
-- `4g` - 4G 网络
-- `5g` - 5G 网络
-- `unknown` - Android 下不常见的网络类型
-- `none` - 无网络
-***
-### OpenAppStatus
-> **OpenAppStatus**: `"deep_link"` \| `"market"` \| `"browser"`
-***
-### RequestMethod
-> **RequestMethod**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"HEAD"` \| `"OPTIONS"` \| `"TRACE"` \| `"CONNECT"`
-***
-### ScanCodeType
-> **ScanCodeType**: `"barCode"` \| `"qrCode"` \| `"datamatrix"` \| `"pdf417"`
-扫码类型。
-***
-### ScanResultType
-> **ScanResultType**: `"QR_CODE"` \| `"AZTEC"` \| `"CODABAR"` \| `"CODE_39"` \| `"CODE_93"` \| `"CODE_128"` \| `"DATA_MATRIX"` \| `"EAN_8"` \| `"EAN_13"` \| `"ITF"` \| `"MAXICODE"` \| `"PDF_417"` \| `"RSS_14"` \| `"RSS_EXPANDED"` \| `"UPC_A"` \| `"UPC_E"` \| `"UPC_EAN_EXTENSION"` \| `"WX_CODE"` \| `"CODE_25"`
-扫码结果类型。
-***
-### Scope
-> **Scope**: `"scope.userLocation"` \| `"scope.userFuzzyLocation"` \| `"scope.userLocationBackground"` \| `"scope.payment"` \| `"scope.record"` \| `"scope.bluetooth"` \| `"scope.camera"` \| `"scope.addPhoneContact"` \| `"scope.addPhoneCalendar"`
-***
-### SensorInterval
+| API | 说明 |
+| --- | --- |
+| [makePhoneCall](open-api/25-设备-电话.md#makephonecall) | 拨打电话。 |
-> **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
+## 设备 / 扫码
-传感器监听频率。
+调起扫码并读取扫码结果。
-***
+| API | 说明 |
+| --- | --- |
+| [scanCode](open-api/26-设备-扫码.md#scancode) | 调起扫码能力。 |
-### UpdateModelContextBlock
+## 设备 / 屏幕
-> **UpdateModelContextBlock**: [`UpdateModelContextSummaryBlock`](doubao-apps-sdk-open-api.md#updatemodelcontextsummaryblock) \| [`UpdateModelContextEntityBlock`](doubao-apps-sdk-open-api.md#updatemodelcontextentityblock)
+屏幕亮度、常亮和截屏/录屏相关能力。
-***
+| API | 说明 |
+| --- | --- |
+| [getScreenBrightness](open-api/27-设备-屏幕.md#getscreenbrightness) | 获取屏幕亮度。 |
+| [setVisualEffectOnCapture](open-api/27-设备-屏幕.md#setvisualeffectoncapture) | 设置截屏或录屏时的视觉表现。<br><br>控制截屏或录屏时的视觉效果。 |
+| [setScreenBrightness](open-api/27-设备-屏幕.md#setscreenbrightness) | 设置屏幕亮度。 |
+| [setKeepScreenOn](open-api/27-设备-屏幕.md#setkeepscreenon) | 设置屏幕常亮状态。 |
+| [onUserCaptureScreen](open-api/27-设备-屏幕.md#onusercapturescreen) | 监听用户主动截屏事件。<br><br>返回取消监听函数。 |
-### VibrateShortType
+## 设备 / 震动
-> **VibrateShortType**: `"heavy"` \| `"medium"` \| `"light"`
+触发短震动和长震动。
-短震动类型。
+| API | 说明 |
+| --- | --- |
+| [vibrateShort](open-api/28-设备-震动.md#vibrateshort) | 触发短震动。 |
+| [vibrateLong](open-api/28-设备-震动.md#vibratelong) | 触发长震动。 |