For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/index.md.

JS API 概览

存储

API说明页面卡片
clearStorage清空本地缓存。支持支持
clearStorageSync清空本地缓存。支持支持
getStorage从本地缓存读取数据。支持支持
getStorageInfo获取本地缓存信息。支持支持
getStorageInfoSync同步获取本地缓存信息。支持支持
getStorageSync从本地缓存同步读取数据。支持支持
removeStorage删除本地缓存中指定 key 的数据。支持支持
removeStorageSync删除本地缓存中指定 key 的数据。支持支持
setStorage将数据写入本地缓存。支持支持
setStorageSync将数据写入本地缓存。支持支持

定位

API说明页面卡片
getLocation获取设备当前的地理位置信息。支持支持
onLocationChange注册地理位置变化回调。支持不支持
onLocationChangeError注册位置更新异常回调。支持不支持
startLocationUpdate开始接收位置更新。支持不支持
stopLocationUpdate停止接收位置更新。支持不支持

基础

API说明页面卡片
arrayBufferToBase64将 ArrayBuffer 转换为 Base64 字符串。支持支持
authorize提前向用户发起指定 scope 的授权;scope.healthData 仅用于选择 iOS HealthKit 系统授权路径。支持不支持
base64ToArrayBuffer将 Base64 字符串转换为 ArrayBuffer。支持支持
canIUse检测当前环境是否支持指定 API 或能力。--
getAccountInfo异步获取账号信息。支持支持
getAccountInfoSync同步获取账号信息。支持支持
getPerformance获取当前应用插件的性能数据。

Entry 由客户端保存;getEntries*() 同步查询当前快照,observer 只接收新完成的 Entry。

支持支持
getSetting获取用户当前的应用授权设置。支持支持
openSetting打开应用插件授权设置页面支持支持

基础/系统

API说明页面卡片
getAppAuthorizeSetting获取豆包客户端的系统授权设置。

调用只读取当前系统授权状态,不会申请权限或触发系统授权弹窗。原有状态字段固定返回 authorized、denied 或 not determined,精细授权字段用于区分部分、只读、只写、前后台等能力。

支持支持
getAppBaseInfo获取应用基础信息。支持支持
getAppBaseInfoSync获取应用基础信息。支持支持
getSystemInfo获取系统信息。支持支持
getSystemInfoSync同步获取系统信息。支持支持
getSystemSetting获取设备设置。支持支持
getWindowInfo获取窗口信息。支持不支持
getWindowInfoSync获取窗口信息。支持不支持
onThemeChange监听应用主题变化。

当用户在系统设置或豆包客户端内切换浅色、深色主题时触发。回调参数中的 theme 表示切换后的主题,可与 getAppBaseInfo 返回的 theme 字段配合使用。

支持支持

界面

API说明页面卡片

界面/交互

API说明页面卡片
disableAlertBeforeUnload关闭页面返回前提醒。--
enableAlertBeforeUnload开启页面返回前提醒。 当用户在应用插件的非最底层页面点击左上角返回按钮、左上角首页按钮或客户端返回键时,弹起询问弹窗

返回询问对话框只会对调用的当前页面生效,通过手势滑动返回时不会弹起询问对话框

--
getMenuButtonBoundingClientRect取菜单按钮(右上角胶囊按钮)的布局位置信息。支持不支持
hideLoading隐藏当前 loading。支持不支持
hideToast隐藏当前 Toast。支持支持
showActionSheet显示操作菜单。支持支持
showBottomSheet显示豆包底部弹窗。支持支持
showLoading显示 loading 提示框。支持不支持
showModal显示模态对话框。支持支持
showToast显示 Toast 提示。支持支持

界面/输入

API说明页面卡片
hideKeyboard收起当前键盘。支持不支持
onKeyboardHeightChange监听键盘高度变化事件。支持不支持

开放能力/登录

API说明页面卡片
login获取当前豆包用户的一次性登录凭证。支持支持
loginWithDoubaoWidget在 Widget 中拉起平台登录和隐私协议授权交互。支持支持
postLoginResult向豆包回传三方 MCP 授权登录结果。支持支持

开放能力/业务能力

API说明页面卡片
callTool调用当前应用的 Tool。

豆包会根据当前应用插件页面或会话 Widget 确定应用和版本,开发者只需传入 Tool 名称和参数。 Tool 正常结果通过 toolResult 返回,Tool 业务错误通过 toolError 返回,两者都会正常 resolve;调用前校验、鉴权或返回结构校验失败时 Promise reject。

支持支持
createTask创建任务。支持支持
expiredWidget更新过期的 Widget 为固定卡片。支持支持
getPrivacySetting获取隐私设置状态。支持支持
sendFollowUpMessage以用户身份发送后续消息,触发新一轮对话、API 调用或引导模型响应。支持支持
updateModelContext向 Agent 捐赠上下文。支持支持
updateWidget更新指定 Widget 卡片实例的渲染数据。

用于卡片内操作后刷新卡片展示、把服务端最新结果写回卡片,或由 Page 根据传入的 widgetInstanceId 更新原卡片;需要替换卡片类型时可同时传入新的 widgetId。

widgetData 与 toolResult 二选一。传入 toolResult 时不能切换 widgetId, 结构化结果必须符合当前应用的 Entity 协议。切换 widgetId 时不能关闭重新创建。

支持支持

开放能力/支付

API说明页面卡片
createSignOrder创建三方纯签约流程所需的签约单。支持支持
dypay发起抖音支付流程。--
getOrderPayment使用预下单返回的平台交易订单号拉起用户收银台。支持支持
getOrderPaymentWithSign使用预下单号和签约参数拉起支付并签约收银台。支持支持
requestOrder交易预下单,获取拉起收银台所需的平台交易订单号。支持支持
sign使用三方纯签约的签约单号拉起用户签约页面。支持支持

路由

API说明页面卡片
exitApp退出当前所有页面。支持不支持
navigateBack关闭当前页面,返回上一页面或多级页面。支持不支持
navigateTo保留当前页面,跳转到应用内的某个页面。支持支持
navigateToDouyinMiniProgram在豆包内打开指定版本的抖音应用插件。支持支持
openPage打开应用内页面。

在主对话流卡片中调用时会重新打开全页并忽略 mode;在全页或全页内 Chat UI 的卡片中调用时按照 mode 操作页面栈。

--
openPageInChat在当前关联的主对话流中以半屏形式打开应用内页面。

调用后不会创建或操作全页页面栈。需要进入全页应用插件或操作已有页面栈时,请使用 openPage。

支持支持
redirectTo关闭当前页面,跳转到应用内的某个页面。支持不支持
reLaunch关闭所有页面并跳转到应用内页面。支持不支持

媒体

API说明页面卡片
chooseImage选择图片。支持不支持
compressImage压缩图片。支持不支持
createInnerAudioContext创建一个内部音频上下文。支持不支持
getBackgroundAudioManager获取全局唯一的背景音频管理器。支持不支持
getImageInfo获取图片信息。支持不支持
getRecorderManager获取全局唯一的录音管理器。支持不支持
previewImage预览图片。支持支持
saveImageToPhotosAlbum保存图片到系统相册。

需要先确保应用已具备写入系统相册的权限。

支持不支持

设备/电池

API说明页面卡片
getBatteryInfo获取电池信息。支持不支持
onBatteryInfoChange监听电池信息变化事件。支持不支持

设备/电话

API说明页面卡片
makePhoneCall拨打电话。支持支持

设备/短信

API说明页面卡片
sendSms拉起系统短信发送面板。支持支持

设备/基础信息

API说明页面卡片
getDeviceInfo获取设备基础信息。支持支持
getDeviceInfoSync同步获取设备基础信息。支持支持

设备/加密

API说明页面卡片
getRandomValues获取安全随机数。支持不支持

设备/加速度计

API说明页面卡片
onAccelerometerChange监听加速度数据变化事件。支持不支持
startAccelerometer开始监听加速度。支持不支持
stopAccelerometer停止监听加速度。支持不支持

设备/剪贴板

API说明页面卡片
getClipboardData获取剪贴板内容。支持支持
setClipboardData设置系统剪贴板内容。支持支持

设备/蓝牙

API说明页面卡片
closeBLEConnection关闭 BLE 连接。支持不支持
closeBluetoothAdapter关闭蓝牙适配器。支持不支持
createBLEConnection创建 BLE 连接。支持不支持
getBLEDeviceCharacteristics获取 BLE 特征值列表。支持不支持
getBLEDeviceRSSI获取 BLE 设备 RSSI。支持不支持
getBLEDeviceServices获取 BLE 服务列表。支持不支持
getBLEMTU获取 BLE MTU。支持不支持
getBluetoothAdapterState获取蓝牙适配器状态。支持不支持
getBluetoothDevices获取当前蓝牙模块发现的设备列表。支持不支持
getConnectedBluetoothDevices获取已连接的蓝牙设备列表。支持不支持
isBluetoothDevicePaired查询蓝牙设备是否已经配对。支持不支持
makeBluetoothPair发起蓝牙配对。支持不支持
notifyBLECharacteristicValueChange订阅 BLE 特征值变化。支持不支持
onBLECharacteristicValueChange注册 BLE 特征值变化回调。支持不支持
onBLEConnectionStateChange注册 BLE 连接状态变化回调。支持不支持
onBluetoothAdapterStateChange注册蓝牙适配器状态变化回调。支持不支持
onBluetoothDeviceFound注册发现蓝牙设备回调。支持不支持
openBluetoothAdapter打开蓝牙适配器。支持不支持
readBLECharacteristicValue读取 BLE 特征值。支持不支持
setBLEMTU设置 BLE MTU。支持不支持
startBluetoothDevicesDiscovery开始搜索附近的蓝牙设备。支持不支持
stopBluetoothDevicesDiscovery停止搜索附近的蓝牙设备。支持不支持
writeBLECharacteristicValue写入 BLE 特征值。支持不支持

设备/罗盘

API说明页面卡片
onCompassChange监听罗盘数据变化事件。支持不支持
startCompass开始监听罗盘。支持不支持
stopCompass停止监听罗盘。支持不支持

设备/屏幕

API说明页面卡片
disableUserScreenRecord禁止用户录屏。支持不支持
enableUserScreenRecord允许用户录屏。支持不支持
getScreenBrightness获取屏幕亮度。支持不支持
onUserCaptureScreen监听用户主动截屏事件。支持不支持
onUserScreenRecord监听用户录屏事件。支持不支持
setKeepScreenOn设置屏幕常亮状态。支持不支持
setScreenBrightness设置屏幕亮度。支持不支持

设备/日历

API说明页面卡片
addPhoneCalendar向系统日历添加事件。支持支持
addPhoneRepeatCalendar向系统日历添加重复事件。支持支持
deletePhoneCalendar按标题和原始时间删除全部匹配的系统日历事件。支持支持

设备/扫码

API说明页面卡片
scanCode调起扫码能力。支持支持

设备/设备方向

API说明页面卡片
onDeviceMotionChange监听设备方向变化事件。支持不支持
startDeviceMotionListening开始监听设备方向变化。支持不支持
stopDeviceMotionListening停止监听设备方向变化。支持不支持

设备/陀螺仪

API说明页面卡片
onGyroscopeChange监听陀螺仪数据变化事件。支持不支持
startGyroscope开始监听陀螺仪。支持不支持
stopGyroscope停止监听陀螺仪。支持不支持

设备/网络

API说明页面卡片
getNetworkType获取当前网络类型。支持不支持
onNetworkStatusChange监听网络状态变化事件。支持不支持

设备/无障碍

API说明页面卡片
checkIsOpenAccessibility检测无障碍能力是否开启。支持-

设备/震动

API说明页面卡片
vibrateLong触发长震动。支持支持
vibrateShort触发短震动。支持支持

设备/iBeacon

API说明页面卡片
getBeacons获取已搜索到的 iBeacon 列表。支持不支持
startBeaconDiscovery开始搜索附近的 iBeacon。支持不支持
stopBeaconDiscovery停止搜索附近的 iBeacon。支持不支持

设备/Wi-Fi

API说明页面卡片
connectWifi连接指定 Wi-Fi。支持不支持
getConnectedWifi获取当前已连接 Wi-Fi 信息。支持不支持
getWifiList获取 Wi-Fi 列表。支持不支持
onWifiConnected监听连接上 Wi-Fi 的事件。支持不支持
setWifiList设置 Wi-Fi 预设列表(iOS 特有)。支持不支持
startWifi初始化 Wi-Fi 模块。支持不支持
stopWifi关闭 Wi-Fi 模块。支持不支持

数据分析

API说明页面卡片
reportEvent上报数据分析事件。支持支持

网络

API说明页面卡片
connectSocket创建一个 WebSocket 连接,并返回可操作该连接的 SocketTask。

该 API 会同步返回 SocketTask,但连接创建本身是异步过程。调用方应先在返回的 SocketTask 上注册事件回调,再等待 onOpen 表示连接可用。后续发送消息使用 SocketTask.send,关闭连接使用 SocketTask.close。

支持不支持
downloadFile下载文件,并返回可取消、可监听进度的 DownloadTask。支持不支持
request发起网络请求。

request 本身不接受泛型参数;如需业务数据类型,请读取 result.data 后再做类型收窄或断言。

支持支持
uploadFile上传本地文件,并返回可用于监听进度和中断上传的 UploadTask。支持不支持

文件系统

API说明页面卡片
getFileSystemManager获取文件系统管理器。支持不支持

自定义通信

API说明页面卡片
createCustomEvent创建一组用于发送和监听自定义事件的函数。支持支持