@doubao-dev/plugin-app-dev 0.0.0-stage → 0.0.40-canary-dea0ddc73-20261026073950

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/quick-reference.md

@@ -0,0 +1,436 @@
+# 豆包应用插件的端能力 API 速查（Open API）
+
+> 这是豆包应用插件运行时 API，也称 Open API。默认从 `@doubao-dev/framework/api` 导入；本文件根据 `packages/open-api/src` 的导出结构自动生成，按模块列出 API 名称和说明。
+
+覆盖 158 个函数。详细参数、返回值、示例和相关类型请查看 [豆包应用插件的端能力 API 分组目录](groups.md)，精确字段也可按参数/结果类型名查看 IDE 类型提示或 `@doubao-dev/framework/api` 类型定义。
+
+## 使用方式
+
+```typescript
+import { showToast, request, getStorage } from '@doubao-dev/framework/api';
+```
+
+## 按常见能力查找
+
+先按要实现的能力缩小范围，再进入对应 API 详情确认参数、返回值和调用时机。
+
+| 能力 | 适用场景 | 候选 API |
+| --- | --- | --- |
+| 网络请求、调用业务后端 | 发 HTTP 请求、读取接口数据、提交表单数据 | [request](10-网络.md#request) |
+| 本地缓存 | 保存、读取、删除或清空本地数据；需要同步读取时选 Sync API | [setStorage](05-存储.md#setstorage)、[getStorage](05-存储.md#getstorage)、[removeStorage](05-存储.md#removestorage)、[clearStorage](05-存储.md#clearstorage)、[setStorageSync](05-存储.md#setstoragesync)、[getStorageSync](05-存储.md#getstoragesync) |
+| 页面跳转、返回、退出 | 打开页面、替换页面、重启页面栈、返回上一页或退出应用插件 | [navigateTo](06-路由.md#navigateto)、[redirectTo](06-路由.md#redirectto)、[reLaunch](06-路由.md#relaunch)、[navigateBack](06-路由.md#navigateback)、[exitApp](06-路由.md#exitapp) |
+| Toast、Loading、弹窗和菜单 | 给用户反馈操作结果、展示确认框、底部弹窗或操作菜单 | [showToast](08-交互.md#showtoast)、[showLoading](08-交互.md#showloading)、[hideLoading](08-交互.md#hideloading)、[hideToast](08-交互.md#hidetoast)、[showModal](08-交互.md#showmodal)、[showActionSheet](08-交互.md#showactionsheet)、[showBottomSheet](08-交互.md#showbottomsheet) |
+| 更新或固定聊天卡片 | 刷新指定 Widget 卡片的数据、切换卡片类型，或把过期卡片替换成固定卡片 | [updateWidget](12-业务能力.md#updatewidget)、[expiredWidget](12-业务能力.md#expiredwidget) |
+| 影响模型后续行为 | 把页面/卡片上下文补充给模型，或以用户身份发送后续消息触发新一轮对话 | [updateModelContext](12-业务能力.md#updatemodelcontext)、[sendFollowUpMessage](12-业务能力.md#sendfollowupmessage) |
+| 任务管理 | 创建应用插件任务并关联后续业务 | [createTask](12-业务能力.md#createtask) |
+| 登录和登录结果回传 | 获取登录态、调起豆包 Widget 登录、把自定义登录页结果回传给宿主 | [login](13-登录.md#login)、[loginWithDoubaoWidget](13-登录.md#loginwithdoubaowidget)、[postLoginResult](13-登录.md#postloginresult) |
+| 支付 | 下单、签名、发起支付、查询支付结果或处理签约支付 | [requestOrder](14-支付.md#requestorder)、[sign](14-支付.md#sign)、[getOrderPayment](14-支付.md#getorderpayment)、[createSignOrder](14-支付.md#createsignorder)、[getOrderPaymentWithSign](14-支付.md#getorderpaymentwithsign) |
+| 位置 | 获取当前位置、选择位置、打开地图、持续监听位置变化 | [getLocation](04-定位.md#getlocation)、[startLocationUpdate](04-定位.md#startlocationupdate)、[onLocationChange](04-定位.md#onlocationchange) |
+| 图片和录音 | 选择、预览、保存、压缩图片，读取图片信息，或获取录音管理器 | [chooseImage](11-媒体.md#chooseimage)、[previewImage](11-媒体.md#previewimage)、[saveImageToPhotosAlbum](11-媒体.md#saveimagetophotosalbum)、[compressImage](11-媒体.md#compressimage)、[getImageInfo](11-媒体.md#getimageinfo)、[getRecorderManager](11-媒体.md#getrecordermanager) |
+| WebSocket | 创建长连接并收发消息、监听连接状态 | [connectSocket](10-网络.md#connectsocket) |
+| 系统、窗口、设备信息 | 读取系统信息、窗口信息和设备信息 | [getSystemInfo](02-系统.md#getsysteminfo)、[getWindowInfo](02-系统.md#getwindowinfo)、[getDeviceInfo](26-基础信息.md#getdeviceinfo) |
+| 剪贴板、扫码、电话和短信 | 调用常见系统能力读取/写入剪贴板、扫码、拨号或发短信 | [getClipboardData](28-剪贴板.md#getclipboarddata)、[setClipboardData](28-剪贴板.md#setclipboarddata)、[scanCode](32-扫码.md#scancode)、[makePhoneCall](31-电话.md#makephonecall)、[sendSms](24-短信.md#sendsms) |
+| 蓝牙、Wi-Fi 和传感器 | 打开蓝牙/Wi-Fi、扫描或连接设备，监听加速度计、罗盘、陀螺仪和设备方向 | [openBluetoothAdapter](16-蓝牙.md#openbluetoothadapter)、[startBluetoothDevicesDiscovery](16-蓝牙.md#startbluetoothdevicesdiscovery)、[startWifi](17-wi-fi.md#startwifi)、[connectWifi](17-wi-fi.md#connectwifi)、[startAccelerometer](18-加速度计.md#startaccelerometer)、[startCompass](20-罗盘.md#startcompass)、[startGyroscope](22-陀螺仪.md#startgyroscope)、[startDeviceMotionListening](21-设备方向.md#startdevicemotionlistening) |
+
+## 基础
+
+账号、授权、豆包客户端信息、窗口信息和能力可用性。
+
+| API | 说明 |
+| --- | --- |
+| [getAccountInfo](01-基础.md#getaccountinfo) | 异步获取账号信息。 |
+| [getAccountInfoSync](01-基础.md#getaccountinfosync) | 同步获取账号信息。<br><br>同步 API。 |
+| [authorize](01-基础.md#authorize) | 提前向用户发起指定 scope 的授权；scope.healthData 仅用于选择 iOS HealthKit 系统授权路径。 |
+| [arrayBufferToBase64](01-基础.md#arraybuffertobase64) | 将 ArrayBuffer 转换为 Base64 字符串。 |
+| [base64ToArrayBuffer](01-基础.md#base64toarraybuffer) | 将 Base64 字符串转换为 ArrayBuffer。 |
+| [canIUse](01-基础.md#caniuse) | 检测当前环境是否支持指定 API 或能力。 |
+| [getPerformance](01-基础.md#getperformance) | 获取当前应用插件的性能数据。 Entry 由客户端保存；getEntries*() 同步查询当前快照，observer 只接收新完成的 Entry。 |
+| [getSetting](01-基础.md#getsetting) | 获取用户当前的应用授权设置。 |
+| [openSetting](01-基础.md#opensetting) | 打开应用插件授权设置页面。 |
+| [getUserIdentifiers](01-基础.md#getuseridentifiers) | 获取当前用户的加密设备标识，参数可省略或传入空对象。 |
+
+## 系统
+
+豆包客户端信息、窗口信息和系统设置。
+
+| API | 说明 |
+| --- | --- |
+| [getWindowInfoSync](02-系统.md#getwindowinfosync) | 获取窗口信息。<br><br>同步 API。 |
+| [getSystemSetting](02-系统.md#getsystemsetting) | 获取设备设置。 |
+| [getAppAuthorizeSetting](02-系统.md#getappauthorizesetting) | 获取豆包客户端的系统授权设置。 调用只读取当前系统授权状态，不会申请权限或触发系统授权弹窗。原有状态字段固定返回 authorized、denied 或 not determined，精细授权字段用于区分部分、只读、只写、前后台等能力。 |
+| [getAppBaseInfoSync](02-系统.md#getappbaseinfosync) | 获取应用基础信息。<br><br>同步 API。 |
+| [getWindowInfo](02-系统.md#getwindowinfo) | 获取窗口信息。 |
+| [getAppBaseInfo](02-系统.md#getappbaseinfo) | 获取应用基础信息。 |
+| [onThemeChange](02-系统.md#onthemechange) | 监听应用主题变化。 当用户在系统设置或豆包客户端内切换浅色、深色主题时触发。回调参数中的 theme 表示切换后的主题，可与 getAppBaseInfo 返回的 theme 字段配合使用。<br><br>返回取消监听函数。 |
+| [getSystemInfo](02-系统.md#getsysteminfo) | 获取系统信息。 |
+| [getSystemInfoSync](02-系统.md#getsysteminfosync) | 同步获取系统信息。<br><br>同步 API。 |
+
+## 自定义通信
+
+在应用插件的页面或卡片实例之间发送和接收自定义事件。
+
+| API | 说明 |
+| --- | --- |
+| [createCustomEvent](03-自定义通信.md#createcustomevent) | 创建一组用于发送和监听自定义事件的函数。 |
+
+## 定位
+
+获取设备当前的地理位置信息。
+
+| API | 说明 |
+| --- | --- |
+| [getLocation](04-定位.md#getlocation) | 获取设备当前的地理位置信息。 |
+| [startLocationUpdate](04-定位.md#startlocationupdate) | 开始接收位置更新。 |
+| [stopLocationUpdate](04-定位.md#stoplocationupdate) | 停止接收位置更新。 |
+| [onLocationChange](04-定位.md#onlocationchange) | 注册地理位置变化回调。<br><br>返回取消监听函数。 |
+| [onLocationChangeError](04-定位.md#onlocationchangeerror) | 注册位置更新异常回调。<br><br>返回取消监听函数。 |
+
+## 存储
+
+本地缓存；带 Sync 后缀的是同步 API。
+
+| API | 说明 |
+| --- | --- |
+| [setStorage](05-存储.md#setstorage) | 将数据写入本地缓存。 |
+| [setStorageSync](05-存储.md#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API。 |
+| [getStorage](05-存储.md#getstorage) | 从本地缓存读取数据。 |
+| [getStorageSync](05-存储.md#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API。 |
+| [removeStorage](05-存储.md#removestorage) | 删除本地缓存中指定 key 的数据。 |
+| [removeStorageSync](05-存储.md#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API。 |
+| [clearStorage](05-存储.md#clearstorage) | 清空本地缓存。 |
+| [clearStorageSync](05-存储.md#clearstoragesync) | 清空本地缓存。<br><br>同步 API。 |
+| [getStorageInfo](05-存储.md#getstorageinfo) | 获取本地缓存信息。 |
+| [getStorageInfoSync](05-存储.md#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API。 |
+
+## 路由
+
+应用内页面跳转、返回、退出和关闭。
+
+| API | 说明 |
+| --- | --- |
+| [navigateTo](06-路由.md#navigateto) | 保留当前页面，跳转到应用内的某个页面。 |
+| [redirectTo](06-路由.md#redirectto) | 关闭当前页面，跳转到应用内的某个页面。 |
+| [reLaunch](06-路由.md#relaunch) | 关闭所有页面并跳转到应用内页面。 |
+| [navigateBack](06-路由.md#navigateback) | 关闭当前页面，返回上一页面或多级页面。 |
+| [exitApp](06-路由.md#exitapp) | 退出当前所有页面。 |
+| [navigateToDouyinMiniProgram](06-路由.md#navigatetodouyinminiprogram) | 在豆包内打开指定版本的抖音应用插件。 |
+| [openPage](06-路由.md#openpage) | 打开应用内页面。 在主对话流卡片中调用时会重新打开全页并忽略 mode；在全页或全页内 Chat UI 的卡片中调用时按照 mode 操作页面栈。 |
+| [openPageInChat](06-路由.md#openpageinchat) | 在当前关联的主对话流中以半屏形式打开应用内页面。 调用后不会创建或操作全页页面栈。需要进入全页应用插件或操作已有页面栈时，请使用 openPage。 |
+
+## 界面
+
+对话框状态、Toast、Loading、Modal、ActionSheet、BottomSheet、返回前提醒、键盘和输入框能力。
+
+| API | 说明 |
+| --- | --- |
+| [getChatPanelInfo](07-界面.md#getchatpanelinfo) | 获取当前对话框状态快照。 调用不会改变对话框状态，也不会触发高度变化事件。 |
+| [setChatPanelState](07-界面.md#setchatpanelstate) | 设置对话框展示状态。 |
+| [onChatPanelHeightChanged](07-界面.md#onchatpanelheightchanged) | 监听对话框高度或展示状态变化。 注册后不会立即回调当前值。需要当前状态时，先调用 getChatPanelInfo。<br><br>返回取消监听函数。 |
+
+## 交互
+
+Toast、Loading、Modal、ActionSheet、BottomSheet 和返回前提醒。
+
+| API | 说明 |
+| --- | --- |
+| [enableAlertBeforeUnload](08-交互.md#enablealertbeforeunload) | 开启页面返回前提醒。 当用户在应用插件的非最底层页面点击左上角返回按钮、左上角首页按钮或客户端返回键时,弹起询问弹窗 返回询问对话框只会对调用的当前页面生效，通过手势滑动返回时不会弹起询问对话框。 |
+| [disableAlertBeforeUnload](08-交互.md#disablealertbeforeunload) | 关闭页面返回前提醒。 |
+| [showModal](08-交互.md#showmodal) | 显示模态对话框。 |
+| [showLoading](08-交互.md#showloading) | 显示 loading 提示框。 |
+| [hideToast](08-交互.md#hidetoast) | 隐藏当前 Toast。 |
+| [hideLoading](08-交互.md#hideloading) | 隐藏当前 loading。 |
+| [showActionSheet](08-交互.md#showactionsheet) | 显示操作菜单。 |
+| [showBottomSheet](08-交互.md#showbottomsheet) | 显示豆包底部弹窗。 |
+| [getMenuButtonBoundingClientRect](08-交互.md#getmenubuttonboundingclientrect) | 取菜单按钮（右上角胶囊按钮）的布局位置信息。 |
+| [showToast](08-交互.md#showtoast) | 显示 Toast 提示。 |
+
+## 输入
+
+键盘和输入框选区能力。
+
+| API | 说明 |
+| --- | --- |
+| [hideKeyboard](09-输入.md#hidekeyboard) | 收起当前键盘。 |
+| [onKeyboardHeightChange](09-输入.md#onkeyboardheightchange) | 监听键盘高度变化事件。<br><br>返回取消监听函数。 |
+
+## 网络
+
+网络请求与 WebSocket。
+
+| API | 说明 |
+| --- | --- |
+| [request](10-网络.md#request) | 发起网络请求。 request 本身不接受泛型参数；如需业务数据类型，请读取 result.data 后再做类型收窄或断言。 |
+| [connectSocket](10-网络.md#connectsocket) | 创建一个 WebSocket 连接，并返回可操作该连接的 SocketTask。 该 API 会同步返回 SocketTask，但连接创建本身是异步过程。调用方应先在返回的 SocketTask 上注册事件回调，再等待 onOpen 表示连接可用。后续发送消息使用 SocketTask.send，关闭连接使用 SocketTask.close。 |
+| [uploadFile](10-网络.md#uploadfile) | 上传本地文件，并返回可用于监听进度和中断上传的 UploadTask。 |
+| [downloadFile](10-网络.md#downloadfile) | 下载文件，并返回可取消、可监听进度的 DownloadTask。 |
+
+## 媒体
+
+图片选择、预览、保存、压缩和信息读取；录音管理；背景音频和内部音频播放。
+
+| API | 说明 |
+| --- | --- |
+| [getBackgroundAudioManager](11-媒体.md#getbackgroundaudiomanager) | 获取全局唯一的背景音频管理器。 |
+| [saveImageToPhotosAlbum](11-媒体.md#saveimagetophotosalbum) | 保存图片到系统相册。 需要先确保应用已具备写入系统相册的权限。 |
+| [previewImage](11-媒体.md#previewimage) | 预览图片。 |
+| [getImageInfo](11-媒体.md#getimageinfo) | 获取图片信息。 |
+| [chooseImage](11-媒体.md#chooseimage) | 选择图片。 |
+| [compressImage](11-媒体.md#compressimage) | 压缩图片。 |
+| [createInnerAudioContext](11-媒体.md#createinneraudiocontext) | 创建一个内部音频上下文。 |
+| [getRecorderManager](11-媒体.md#getrecordermanager) | 获取全局唯一的录音管理器。 |
+
+## 业务能力
+
+开放业务能力、卡片更新、模型上下文、任务和隐私设置。
+
+| API | 说明 |
+| --- | --- |
+| [callTool](12-业务能力.md#calltool) | 调用当前应用的 Tool。 豆包会根据当前应用插件页面或会话 Widget 确定应用和版本，开发者只需传入 Tool 名称和参数。 Tool 正常结果通过 toolResult 返回，Tool 业务错误通过 toolError 返回，两者都会正常 resolve；调用前校验、鉴权或返回结构校验失败时 Promise reject。 |
+| [expiredWidget](12-业务能力.md#expiredwidget) | 更新过期的 Widget 为固定卡片。 |
+| [getPrivacySetting](12-业务能力.md#getprivacysetting) | 获取隐私设置状态。 |
+| [sendFollowUpMessage](12-业务能力.md#sendfollowupmessage) | 以用户身份发送后续消息，触发新一轮对话、API 调用或引导模型响应。 |
+| [createTask](12-业务能力.md#createtask) | 创建任务。 |
+| [updateModelContext](12-业务能力.md#updatemodelcontext) | 向 Agent 捐赠上下文。 |
+| [updateWidget](12-业务能力.md#updatewidget) | 更新指定 Widget 卡片实例的渲染数据。 用于卡片内操作后刷新卡片展示、把服务端最新结果写回卡片，或由 Page 根据传入的 widgetInstanceId 更新原卡片；需要替换卡片类型时可同时传入新的 widgetId。 widgetData 与 toolResult 二选一。传入 toolResult 时不能切换 widgetId， 结构化结果必须符合当前应用的 Entity 协议。切换 widgetId 时不能关闭重新创建。 |
+
+## 登录
+
+豆包一次性登录凭证、Widget 登录交互和 MCP 授权结果回传能力。
+
+| API | 说明 |
+| --- | --- |
+| [loginWithDoubaoWidget](13-登录.md#loginwithdoubaowidget) | 在 Widget 中拉起平台登录和隐私协议授权交互。 |
+| [login](13-登录.md#login) | 获取当前豆包用户的一次性登录凭证。 |
+| [postLoginResult](13-登录.md#postloginresult) | 向豆包回传三方 MCP 授权登录结果。 |
+
+## 支付
+
+订单创建、普通支付、平台免密支付、纯签约和支付并签约能力。
+
+| API | 说明 |
+| --- | --- |
+| [createSignOrder](14-支付.md#createsignorder) | 创建三方纯签约流程所需的签约单。 |
+| [dypay](14-支付.md#dypay) | 发起抖音支付流程。 |
+| [getOrderPaymentWithSign](14-支付.md#getorderpaymentwithsign) | 使用预下单号和签约参数拉起支付并签约收银台。 |
+| [getOrderPayment](14-支付.md#getorderpayment) | 使用预下单返回的平台交易订单号拉起用户收银台。 |
+| [requestOrder](14-支付.md#requestorder) | 交易预下单，获取拉起收银台所需的平台交易订单号。 |
+| [sign](14-支付.md#sign) | 使用三方纯签约的签约单号拉起用户签约页面。 |
+
+## 数据分析
+
+监控上报、事件和数据分析上报。
+
+| API | 说明 |
+| --- | --- |
+| [reportEvent](15-数据分析.md#reportevent) | 上报数据分析事件。 |
+
+## 蓝牙
+
+蓝牙和 BLE 能力；通常先打开适配器，再扫描、连接和读写。
+
+| API | 说明 |
+| --- | --- |
+| [openBluetoothAdapter](16-蓝牙.md#openbluetoothadapter) | 打开蓝牙适配器。 |
+| [startBluetoothDevicesDiscovery](16-蓝牙.md#startbluetoothdevicesdiscovery) | 开始搜索附近的蓝牙设备。 |
+| [stopBluetoothDevicesDiscovery](16-蓝牙.md#stopbluetoothdevicesdiscovery) | 停止搜索附近的蓝牙设备。 |
+| [getBluetoothAdapterState](16-蓝牙.md#getbluetoothadapterstate) | 获取蓝牙适配器状态。 |
+| [getBluetoothDevices](16-蓝牙.md#getbluetoothdevices) | 获取当前蓝牙模块发现的设备列表。 |
+| [getConnectedBluetoothDevices](16-蓝牙.md#getconnectedbluetoothdevices) | 获取已连接的蓝牙设备列表。 |
+| [makeBluetoothPair](16-蓝牙.md#makebluetoothpair) | 发起蓝牙配对。 |
+| [isBluetoothDevicePaired](16-蓝牙.md#isbluetoothdevicepaired) | 查询蓝牙设备是否已经配对。 |
+| [closeBluetoothAdapter](16-蓝牙.md#closebluetoothadapter) | 关闭蓝牙适配器。 |
+| [createBLEConnection](16-蓝牙.md#createbleconnection) | 创建 BLE 连接。 |
+| [closeBLEConnection](16-蓝牙.md#closebleconnection) | 关闭 BLE 连接。 |
+| [getBLEDeviceServices](16-蓝牙.md#getbledeviceservices) | 获取 BLE 服务列表。 |
+| [getBLEDeviceCharacteristics](16-蓝牙.md#getbledevicecharacteristics) | 获取 BLE 特征值列表。 |
+| [getBLEDeviceRSSI](16-蓝牙.md#getbledevicerssi) | 获取 BLE 设备 RSSI。 |
+| [getBLEMTU](16-蓝牙.md#getblemtu) | 获取 BLE MTU。 |
+| [notifyBLECharacteristicValueChange](16-蓝牙.md#notifyblecharacteristicvaluechange) | 订阅 BLE 特征值变化。 |
+| [readBLECharacteristicValue](16-蓝牙.md#readblecharacteristicvalue) | 读取 BLE 特征值。 |
+| [setBLEMTU](16-蓝牙.md#setblemtu) | 设置 BLE MTU。 |
+| [writeBLECharacteristicValue](16-蓝牙.md#writeblecharacteristicvalue) | 写入 BLE 特征值。 |
+| [onBluetoothAdapterStateChange](16-蓝牙.md#onbluetoothadapterstatechange) | 注册蓝牙适配器状态变化回调。<br><br>返回取消监听函数。 |
+| [onBluetoothDeviceFound](16-蓝牙.md#onbluetoothdevicefound) | 注册发现蓝牙设备回调。<br><br>返回取消监听函数。 |
+| [onBLEConnectionStateChange](16-蓝牙.md#onbleconnectionstatechange) | 注册 BLE 连接状态变化回调。<br><br>返回取消监听函数。 |
+| [onBLECharacteristicValueChange](16-蓝牙.md#onblecharacteristicvaluechange) | 注册 BLE 特征值变化回调。<br><br>返回取消监听函数。 |
+
+## Wi-Fi
+
+Wi-Fi 模块能力；通常先 startWifi，再获取列表或连接。
+
+| API | 说明 |
+| --- | --- |
+| [startWifi](17-wi-fi.md#startwifi) | 初始化 Wi-Fi 模块。 |
+| [stopWifi](17-wi-fi.md#stopwifi) | 关闭 Wi-Fi 模块。 |
+| [setWifiList](17-wi-fi.md#setwifilist) | 设置 Wi-Fi 预设列表（iOS 特有）。 |
+| [connectWifi](17-wi-fi.md#connectwifi) | 连接指定 Wi-Fi。 |
+| [getConnectedWifi](17-wi-fi.md#getconnectedwifi) | 获取当前已连接 Wi-Fi 信息。 |
+| [getWifiList](17-wi-fi.md#getwifilist) | 获取 Wi-Fi 列表。 |
+| [onWifiConnected](17-wi-fi.md#onwificonnected) | 监听连接上 Wi-Fi 的事件。<br><br>返回取消监听函数。 |
+
+## 加速度计
+
+加速度计监听能力。
+
+| API | 说明 |
+| --- | --- |
+| [startAccelerometer](18-加速度计.md#startaccelerometer) | 开始监听加速度。 |
+| [stopAccelerometer](18-加速度计.md#stopaccelerometer) | 停止监听加速度。 |
+| [onAccelerometerChange](18-加速度计.md#onaccelerometerchange) | 监听加速度数据变化事件。<br><br>返回取消监听函数。 |
+
+## iBeacon
+
+iBeacon 搜索和结果读取能力。
+
+| API | 说明 |
+| --- | --- |
+| [startBeaconDiscovery](19-ibeacon.md#startbeacondiscovery) | 开始搜索附近的 iBeacon。 |
+| [stopBeaconDiscovery](19-ibeacon.md#stopbeacondiscovery) | 停止搜索附近的 iBeacon。 |
+| [getBeacons](19-ibeacon.md#getbeacons) | 获取已搜索到的 iBeacon 列表。 |
+
+## 罗盘
+
+罗盘监听能力。
+
+| API | 说明 |
+| --- | --- |
+| [startCompass](20-罗盘.md#startcompass) | 开始监听罗盘。 |
+| [stopCompass](20-罗盘.md#stopcompass) | 停止监听罗盘。 |
+| [onCompassChange](20-罗盘.md#oncompasschange) | 监听罗盘数据变化事件。<br><br>返回取消监听函数。 |
+
+## 设备方向
+
+设备方向监听能力。
+
+| API | 说明 |
+| --- | --- |
+| [startDeviceMotionListening](21-设备方向.md#startdevicemotionlistening) | 开始监听设备方向变化。 |
+| [stopDeviceMotionListening](21-设备方向.md#stopdevicemotionlistening) | 停止监听设备方向变化。 |
+| [onDeviceMotionChange](21-设备方向.md#ondevicemotionchange) | 监听设备方向变化事件。<br><br>返回取消监听函数。 |
+
+## 陀螺仪
+
+陀螺仪监听能力。
+
+| API | 说明 |
+| --- | --- |
+| [startGyroscope](22-陀螺仪.md#startgyroscope) | 开始监听陀螺仪。 |
+| [stopGyroscope](22-陀螺仪.md#stopgyroscope) | 停止监听陀螺仪。 |
+| [onGyroscopeChange](22-陀螺仪.md#ongyroscopechange) | 监听陀螺仪数据变化事件。<br><br>返回取消监听函数。 |
+
+## 媒体 / 设备 / 网络
+
+网络类型和本机局域网 IP。
+
+| API | 说明 |
+| --- | --- |
+| [getNetworkType](23-媒体-设备-网络.md#getnetworktype) | 获取当前网络类型。 |
+| [onNetworkStatusChange](23-媒体-设备-网络.md#onnetworkstatuschange) | 监听网络状态变化事件。<br><br>返回取消监听函数。 |
+
+## 短信
+
+拉起系统短信发送面板。
+
+| API | 说明 |
+| --- | --- |
+| [sendSms](24-短信.md#sendsms) | 拉起系统短信发送面板。 |
+
+## 无障碍
+
+检测无障碍能力开关状态。
+
+| API | 说明 |
+| --- | --- |
+| [checkIsOpenAccessibility](25-无障碍.md#checkisopenaccessibility) | 检测无障碍能力是否开启。 |
+
+## 基础信息
+
+设备品牌、型号、系统、内存和性能等级。
+
+| API | 说明 |
+| --- | --- |
+| [getDeviceInfo](26-基础信息.md#getdeviceinfo) | 获取设备基础信息。 |
+| [getDeviceInfoSync](26-基础信息.md#getdeviceinfosync) | 同步获取设备基础信息。<br><br>同步 API。 |
+
+## 电池
+
+电池信息读取与变化监听。
+
+| API | 说明 |
+| --- | --- |
+| [getBatteryInfo](27-电池.md#getbatteryinfo) | 获取电池信息。 |
+| [onBatteryInfoChange](27-电池.md#onbatteryinfochange) | 监听电池信息变化事件。<br><br>返回取消监听函数。 |
+
+## 剪贴板
+
+读取和设置系统剪贴板内容。
+
+| API | 说明 |
+| --- | --- |
+| [getClipboardData](28-剪贴板.md#getclipboarddata) | 获取剪贴板内容。 |
+| [setClipboardData](28-剪贴板.md#setclipboarddata) | 设置系统剪贴板内容。 |
+
+## 加密
+
+安全随机数能力。
+
+| API | 说明 |
+| --- | --- |
+| [getRandomValues](29-加密.md#getrandomvalues) | 获取安全随机数。 |
+
+## 日历
+
+向系统日历添加事件和重复事件。
+
+| API | 说明 |
+| --- | --- |
+| [addPhoneCalendar](30-日历.md#addphonecalendar) | 向系统日历添加事件。 |
+| [addPhoneRepeatCalendar](30-日历.md#addphonerepeatcalendar) | 向系统日历添加重复事件。 |
+| [deletePhoneCalendar](30-日历.md#deletephonecalendar) | 按标题和原始时间删除全部匹配的系统日历事件。 |
+
+## 电话
+
+拨打电话。
+
+| API | 说明 |
+| --- | --- |
+| [makePhoneCall](31-电话.md#makephonecall) | 拨打电话。 |
+
+## 扫码
+
+调起扫码并读取扫码结果。
+
+| API | 说明 |
+| --- | --- |
+| [scanCode](32-扫码.md#scancode) | 调起扫码能力。 |
+
+## 屏幕
+
+屏幕亮度、常亮和截屏/录屏相关能力。
+
+| API | 说明 |
+| --- | --- |
+| [getScreenBrightness](33-屏幕.md#getscreenbrightness) | 获取屏幕亮度。 |
+| [setScreenBrightness](33-屏幕.md#setscreenbrightness) | 设置屏幕亮度。 |
+| [setKeepScreenOn](33-屏幕.md#setkeepscreenon) | 设置屏幕常亮状态。 |
+| [disableUserScreenRecord](33-屏幕.md#disableuserscreenrecord) | 禁止用户录屏。 |
+| [enableUserScreenRecord](33-屏幕.md#enableuserscreenrecord) | 允许用户录屏。 |
+| [onUserCaptureScreen](33-屏幕.md#onusercapturescreen) | 监听用户主动截屏事件。<br><br>返回取消监听函数。 |
+| [onUserScreenRecord](33-屏幕.md#onuserscreenrecord) | 监听用户录屏事件。<br><br>返回取消监听函数。 |
+
+## 震动
+
+触发短震动和长震动。
+
+| API | 说明 |
+| --- | --- |
+| [vibrateShort](34-震动.md#vibrateshort) | 触发短震动。 |
+| [vibrateLong](34-震动.md#vibratelong) | 触发长震动。 |
+
+## 文件系统
+
+文件读写、目录管理和文件信息操作。
+
+| API | 说明 |
+| --- | --- |
+| [getFileSystemManager](35-文件系统.md#getfilesystemmanager) | 获取文件系统管理器。 |