@doubao-apps/ai 0.0.27 → 0.0.28

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

@@ -1,326 +0,0 @@
-# Open API
-
-> 公开可用的端能力 API。默认从 `@doubao-apps/framework/api` 导入；本文件根据 `packages/open-api/src` 的导出结构自动生成，按模块列出 API 名称和说明。
-
-覆盖 119 个函数。详细参数、返回值、示例和相关类型请查看 [Open API 目录](open-api/README.md)，精确字段也可按参数/结果类型名查看 IDE 类型提示或 `@doubao-apps/framework/api` 类型定义。
-
-## 使用方式
-
-```typescript
-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。 |
-
-## 设备 / Wi-Fi
-
-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。 |
-
-## 设备 / 加速度计
-
-加速度计监听能力。
-
-| API | 说明 |
-| --- | --- |
-| [startAccelerometer](open-api/11-设备-加速度计.md#startaccelerometer) | 开始监听加速度。<br><br>需配对调用 stopAccelerometer。 |
-| [stopAccelerometer](open-api/11-设备-加速度计.md#stopaccelerometer) | 停止监听加速度。 |
-| [onAccelerometerChange](open-api/11-设备-加速度计.md#onaccelerometerchange) | 监听加速度数据变化事件。<br><br>返回取消监听函数。 |
-
-## 设备 / iBeacon
-
-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 列表。 |
-
-## 设备 / 罗盘
-
-罗盘监听能力。
-
-| API | 说明 |
-| --- | --- |
-| [startCompass](open-api/13-设备-罗盘.md#startcompass) | 开始监听罗盘。<br><br>需配对调用 stopCompass。 |
-| [stopCompass](open-api/13-设备-罗盘.md#stopcompass) | 停止监听罗盘。 |
-| [onCompassChange](open-api/13-设备-罗盘.md#oncompasschange) | 监听罗盘数据变化事件。<br><br>返回取消监听函数。 |
-
-## 设备 / 设备方向
-
-设备方向监听能力。
-
-| API | 说明 |
-| --- | --- |
-| [startDeviceMotionListening](open-api/14-设备-设备方向.md#startdevicemotionlistening) | 开始监听设备方向变化。<br><br>需配对调用 stopDeviceMotionListening。 |
-| [stopDeviceMotionListening](open-api/14-设备-设备方向.md#stopdevicemotionlistening) | 停止监听设备方向变化。 |
-
-## 设备 / 陀螺仪
-
-陀螺仪监听能力。
-
-| 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 / 输入
-
-键盘和输入框选区能力。
-
-| API | 说明 |
-| --- | --- |
-| [hideKeyboard](open-api/16-ui-输入.md#hidekeyboard) | 收起键盘。 |
-| [getSelectedTextRange](open-api/16-ui-输入.md#getselectedtextrange) | 获取当前输入框的选区范围。 |
-
-## 设备 / 网络
-
-网络类型和本机局域网 IP。
-
-| API | 说明 |
-| --- | --- |
-| [getLocalIPAddress](open-api/17-设备-网络.md#getlocalipaddress) | 获取局域网 IP 地址。 |
-| [getNetworkType](open-api/17-设备-网络.md#getnetworktype) | 获取当前网络类型。 |
-| [onNetworkStatusChange](open-api/17-设备-网络.md#onnetworkstatuschange) | 监听网络状态变化事件。<br><br>返回取消监听函数。 |
-
-## 设备 / 短信
-
-拉起系统短信发送面板。
-
-| API | 说明 |
-| --- | --- |
-| [sendSms](open-api/18-设备-短信.md#sendsms) | 拉起系统短信发送面板。 |
-
-## 设备 / 无障碍
-
-检测无障碍能力开关状态。
-
-| API | 说明 |
-| --- | --- |
-| [checkIsOpenAccessibility](open-api/19-设备-无障碍.md#checkisopenaccessibility) | 检测无障碍能力是否开启。 |
-
-## 设备 / 电池
-
-电池信息读取与变化监听。
-
-| API | 说明 |
-| --- | --- |
-| [getBatteryInfo](open-api/20-设备-电池.md#getbatteryinfo) | 获取电池信息。 |
-| [onBatteryInfoChange](open-api/20-设备-电池.md#onbatteryinfochange) | 监听电池信息变化事件。<br><br>返回取消监听函数。 |
-
-## 设备 / 日历
-
-向系统日历添加事件和重复事件。
-
-| API | 说明 |
-| --- | --- |
-| [addPhoneCalendar](open-api/21-设备-日历.md#addphonecalendar) | 向系统日历添加事件。 |
-| [addPhoneRepeatCalendar](open-api/21-设备-日历.md#addphonerepeatcalendar) | 向系统日历添加重复事件。 |
-
-## 设备 / 剪贴板
-
-读取和设置系统剪贴板内容。
-
-| API | 说明 |
-| --- | --- |
-| [getClipboardData](open-api/22-设备-剪贴板.md#getclipboarddata) | 获取剪贴板内容。 |
-| [setClipboardData](open-api/22-设备-剪贴板.md#setclipboarddata) | 设置系统剪贴板内容。 |
-
-## 设备 / 联系人
-
-选择和添加手机联系人。
-
-| API | 说明 |
-| --- | --- |
-| [chooseContact](open-api/23-设备-联系人.md#choosecontact) | 选择手机联系人。 |
-| [addPhoneContact](open-api/23-设备-联系人.md#addphonecontact) | 添加手机联系人。 |
-
-## 设备 / 加密
-
-安全随机数能力。
-
-| API | 说明 |
-| --- | --- |
-| [getRandomValues](open-api/24-设备-加密.md#getrandomvalues) | 获取安全随机数。 |
-
-## 设备 / 电话
-
-拨打电话。
-
-| API | 说明 |
-| --- | --- |
-| [makePhoneCall](open-api/25-设备-电话.md#makephonecall) | 拨打电话。 |
-
-## 设备 / 扫码
-
-调起扫码并读取扫码结果。
-
-| API | 说明 |
-| --- | --- |
-| [scanCode](open-api/26-设备-扫码.md#scancode) | 调起扫码能力。 |
-
-## 设备 / 屏幕
-
-屏幕亮度、常亮和截屏/录屏相关能力。
-
-| 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>返回取消监听函数。 |
-
-## 设备 / 震动
-
-触发短震动和长震动。
-
-| API | 说明 |
-| --- | --- |
-| [vibrateShort](open-api/28-设备-震动.md#vibrateshort) | 触发短震动。 |
-| [vibrateLong](open-api/28-设备-震动.md#vibratelong) | 触发长震动。 |