@doubao-apps/ai 0.0.29 → 0.0.30
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.
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +118 -2535
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/02-/345/256/232/344/275/215.md +135 -0
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/03-/345/255/230/345/202/250.md +409 -0
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/04-/350/267/257/347/224/261.md +165 -0
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/05-/347/225/214/351/235/242-/344/272/244/344/272/222.md +432 -0
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/07-/347/275/221/347/273/234.md +468 -0
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/08-/345/252/222/344/275/223.md +346 -0
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/09-/345/274/200/346/224/276/350/203/275/345/212/233-/344/270/232/345/212/241/350/203/275/345/212/233.md +929 -0
- package/dist/{skills/doubao-apps-dev/references/reference/open-api/04- → contexts/doubao-apps-dev/references/reference/open-api/10-}/346/225/260/346/215/256/345/210/206/346/236/220.md +1 -1
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/README.md +30 -24
- package/dist/contexts/doubao-apps-dev/references/reference/open-api.md +163 -120
- package/dist/manifest.json +2 -2
- package/dist/skills/doubao-apps-dev/references/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +118 -2535
- package/dist/skills/doubao-apps-dev/references/reference/open-api/02-/345/256/232/344/275/215.md +135 -0
- package/dist/skills/doubao-apps-dev/references/reference/open-api/03-/345/255/230/345/202/250.md +409 -0
- package/dist/skills/doubao-apps-dev/references/reference/open-api/04-/350/267/257/347/224/261.md +165 -0
- package/dist/skills/doubao-apps-dev/references/reference/open-api/05-/347/225/214/351/235/242-/344/272/244/344/272/222.md +432 -0
- package/dist/skills/doubao-apps-dev/references/reference/open-api/07-/347/275/221/347/273/234.md +468 -0
- package/dist/skills/doubao-apps-dev/references/reference/open-api/08-/345/252/222/344/275/223.md +346 -0
- package/dist/skills/doubao-apps-dev/references/reference/open-api/09-/345/274/200/346/224/276/350/203/275/345/212/233-/344/270/232/345/212/241/350/203/275/345/212/233.md +929 -0
- package/dist/{contexts/doubao-apps-dev/references/reference/open-api/04- → skills/doubao-apps-dev/references/reference/open-api/10-}/346/225/260/346/215/256/345/210/206/346/236/220.md +1 -1
- package/dist/skills/doubao-apps-dev/references/reference/open-api/README.md +30 -24
- package/dist/skills/doubao-apps-dev/references/reference/open-api.md +163 -120
- package/package.json +2 -2
- package/dist/contexts/doubao-apps-dev/references/reference/open-api/02-/350/267/257/347/224/261.md +0 -63
- package/dist/skills/doubao-apps-dev/references/reference/open-api/02-/350/267/257/347/224/261.md +0 -63
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{03- → 06-}/347/225/214/351/235/242-/350/276/223/345/205/245.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{05- → 11-}/350/256/276/345/244/207-/350/223/235/347/211/231.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{06- → 12-}/350/256/276/345/244/207-wi-fi.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{07- → 13-}/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{08- → 14-}/350/256/276/345/244/207-ibeacon.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{09- → 15-}/350/256/276/345/244/207-/347/275/227/347/233/230.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{10- → 16-}/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{11- → 17-}/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{12-ui- → 18-ui-}/350/276/223/345/205/245.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{13- → 19-}/350/256/276/345/244/207-/347/275/221/347/273/234.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{14- → 20-}/350/256/276/345/244/207-/347/237/255/344/277/241.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{15- → 21-}/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{16- → 22-}/350/256/276/345/244/207-/347/224/265/346/261/240.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{17- → 23-}/350/256/276/345/244/207-/346/227/245/345/216/206.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{18- → 24-}/350/256/276/345/244/207-/345/211/252/350/264/264/346/235/277.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{19- → 25-}/350/256/276/345/244/207-/350/201/224/347/263/273/344/272/272.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{20- → 26-}/350/256/276/345/244/207-/345/212/240/345/257/206.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{21- → 27-}/350/256/276/345/244/207-/347/224/265/350/257/235.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{22- → 28-}/350/256/276/345/244/207-/346/211/253/347/240/201.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{23- → 29-}/350/256/276/345/244/207-/345/261/217/345/271/225.md" +0 -0
- /package/dist/contexts/doubao-apps-dev/references/reference/open-api/{24- → 30-}/350/256/276/345/244/207-/351/234/207/345/212/250.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{03- → 06-}/347/225/214/351/235/242-/350/276/223/345/205/245.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{05- → 11-}/350/256/276/345/244/207-/350/223/235/347/211/231.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{06- → 12-}/350/256/276/345/244/207-wi-fi.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{07- → 13-}/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{08- → 14-}/350/256/276/345/244/207-ibeacon.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{09- → 15-}/350/256/276/345/244/207-/347/275/227/347/233/230.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{10- → 16-}/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{11- → 17-}/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{12-ui- → 18-ui-}/350/276/223/345/205/245.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{13- → 19-}/350/256/276/345/244/207-/347/275/221/347/273/234.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{14- → 20-}/350/256/276/345/244/207-/347/237/255/344/277/241.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{15- → 21-}/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{16- → 22-}/350/256/276/345/244/207-/347/224/265/346/261/240.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{17- → 23-}/350/256/276/345/244/207-/346/227/245/345/216/206.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{18- → 24-}/350/256/276/345/244/207-/345/211/252/350/264/264/346/235/277.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{19- → 25-}/350/256/276/345/244/207-/350/201/224/347/263/273/344/272/272.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{20- → 26-}/350/256/276/345/244/207-/345/212/240/345/257/206.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{21- → 27-}/350/256/276/345/244/207-/347/224/265/350/257/235.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{22- → 28-}/350/256/276/345/244/207-/346/211/253/347/240/201.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{23- → 29-}/350/256/276/345/244/207-/345/261/217/345/271/225.md" +0 -0
- /package/dist/skills/doubao-apps-dev/references/reference/open-api/{24- → 30-}/350/256/276/345/244/207-/351/234/207/345/212/250.md" +0 -0
|
@@ -6,27 +6,33 @@
|
|
|
6
6
|
|
|
7
7
|
| 分组 | 说明 | API 数量 | 详细文档 |
|
|
8
8
|
| --- | --- | ---: | --- |
|
|
9
|
-
| 基础 / 账号 / 系统 |
|
|
10
|
-
|
|
|
11
|
-
|
|
|
12
|
-
|
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
17
|
-
|
|
|
18
|
-
|
|
|
19
|
-
| 设备 /
|
|
20
|
-
|
|
|
21
|
-
| 设备 /
|
|
22
|
-
| 设备 /
|
|
23
|
-
| 设备 /
|
|
24
|
-
| 设备 /
|
|
25
|
-
| 设备 /
|
|
26
|
-
|
|
|
27
|
-
| 设备 /
|
|
28
|
-
| 设备 /
|
|
29
|
-
| 设备 /
|
|
30
|
-
| 设备 /
|
|
31
|
-
| 设备 /
|
|
32
|
-
| 设备 /
|
|
9
|
+
| 基础 / 账号 / 系统 | 账号、授权、宿主基础信息、窗口信息和能力可用性。 | 9 | [查看](./01-基础-账号-系统.md) |
|
|
10
|
+
| 定位 | 获取设备当前的地理位置信息。 | 1 | [查看](./02-定位.md) |
|
|
11
|
+
| 存储 | 本地缓存;带 Sync 后缀的是同步 API。 | 10 | [查看](./03-存储.md) |
|
|
12
|
+
| 路由 | 应用内页面跳转、返回、退出和关闭。 | 6 | [查看](./04-路由.md) |
|
|
13
|
+
| 界面 / 交互 | Toast、Loading、Modal、ActionSheet 和返回前提醒。 | 9 | [查看](./05-界面-交互.md) |
|
|
14
|
+
| 界面 / 输入 | 键盘和输入框选区能力。 | 2 | [查看](./06-界面-输入.md) |
|
|
15
|
+
| 网络 | 网络请求与 WebSocket。 | 2 | [查看](./07-网络.md) |
|
|
16
|
+
| 媒体 | 图片选择、预览、保存、压缩和信息读取。 | 5 | [查看](./08-媒体.md) |
|
|
17
|
+
| 开放能力 / 业务能力 | 开放业务能力、支付、隐私设置、上下文和外部应用打开。 | 17 | [查看](./09-开放能力-业务能力.md) |
|
|
18
|
+
| 数据分析 | 监控上报、事件和数据分析上报。 | 1 | [查看](./10-数据分析.md) |
|
|
19
|
+
| 设备 / 蓝牙 | 蓝牙和 BLE 能力;通常先打开适配器,再扫描、连接和读写。 | 19 | [查看](./11-设备-蓝牙.md) |
|
|
20
|
+
| 设备 / Wi-Fi | Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。 | 6 | [查看](./12-设备-wi-fi.md) |
|
|
21
|
+
| 设备 / 加速度计 | 加速度计监听能力。 | 3 | [查看](./13-设备-加速度计.md) |
|
|
22
|
+
| 设备 / iBeacon | iBeacon 搜索和结果读取能力。 | 3 | [查看](./14-设备-ibeacon.md) |
|
|
23
|
+
| 设备 / 罗盘 | 罗盘监听能力。 | 3 | [查看](./15-设备-罗盘.md) |
|
|
24
|
+
| 设备 / 设备方向 | 设备方向监听能力。 | 3 | [查看](./16-设备-设备方向.md) |
|
|
25
|
+
| 设备 / 陀螺仪 | 陀螺仪监听能力。 | 3 | [查看](./17-设备-陀螺仪.md) |
|
|
26
|
+
| UI / 输入 | 键盘和输入框选区能力。 | 1 | [查看](./18-ui-输入.md) |
|
|
27
|
+
| 设备 / 网络 | 网络类型和本机局域网 IP。 | 3 | [查看](./19-设备-网络.md) |
|
|
28
|
+
| 设备 / 短信 | 拉起系统短信发送面板。 | 1 | [查看](./20-设备-短信.md) |
|
|
29
|
+
| 设备 / 无障碍 | 检测无障碍能力开关状态。 | 1 | [查看](./21-设备-无障碍.md) |
|
|
30
|
+
| 设备 / 电池 | 电池信息读取与变化监听。 | 2 | [查看](./22-设备-电池.md) |
|
|
31
|
+
| 设备 / 日历 | 向系统日历添加事件和重复事件。 | 2 | [查看](./23-设备-日历.md) |
|
|
32
|
+
| 设备 / 剪贴板 | 读取和设置系统剪贴板内容。 | 2 | [查看](./24-设备-剪贴板.md) |
|
|
33
|
+
| 设备 / 联系人 | 选择和添加手机联系人。 | 2 | [查看](./25-设备-联系人.md) |
|
|
34
|
+
| 设备 / 加密 | 安全随机数能力。 | 1 | [查看](./26-设备-加密.md) |
|
|
35
|
+
| 设备 / 电话 | 拨打电话。 | 1 | [查看](./27-设备-电话.md) |
|
|
36
|
+
| 设备 / 扫码 | 调起扫码并读取扫码结果。 | 1 | [查看](./28-设备-扫码.md) |
|
|
37
|
+
| 设备 / 屏幕 | 屏幕亮度、常亮和截屏/录屏相关能力。 | 5 | [查看](./29-设备-屏幕.md) |
|
|
38
|
+
| 设备 / 震动 | 触发短震动和长震动。 | 2 | [查看](./30-设备-震动.md) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> 公开可用的端能力 API。默认从 `@doubao-apps/framework/api` 导入;本文件根据 `packages/open-api/src` 的导出结构自动生成,按模块列出 API 名称和说明。
|
|
4
4
|
|
|
5
|
-
覆盖
|
|
5
|
+
覆盖 126 个函数。详细参数、返回值、示例和相关类型请查看 [Open API 目录](open-api/README.md),精确字段也可按参数/结果类型名查看 IDE 类型提示或 `@doubao-apps/framework/api` 类型定义。
|
|
6
6
|
|
|
7
7
|
## 使用方式
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ import { showToast, request, getStorage } from '@doubao-apps/framework/api';
|
|
|
12
12
|
|
|
13
13
|
## 基础 / 账号 / 系统
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
账号、授权、宿主基础信息、窗口信息和能力可用性。
|
|
16
16
|
|
|
17
17
|
| API | 说明 |
|
|
18
18
|
| --- | --- |
|
|
@@ -20,67 +20,65 @@ import { showToast, request, getStorage } from '@doubao-apps/framework/api';
|
|
|
20
20
|
| [getAccountInfoSync](open-api/01-基础-账号-系统.md#getaccountinfosync) | 同步获取账号信息。<br><br>同步 API。 |
|
|
21
21
|
| [authorize](open-api/01-基础-账号-系统.md#authorize) | 初始化授权。<br><br>按 scope 申请授权。 |
|
|
22
22
|
| [canIUse](open-api/01-基础-账号-系统.md#caniuse) | 检测当前宿主是否支持指定 API 或能力。<br><br>用于兼容性判断。 |
|
|
23
|
-
| [getLocation](open-api/01-基础-账号-系统.md#getlocation) | 获取设备当前的地理位置信息。<br><br>可能涉及定位授权。 |
|
|
24
|
-
| [showModal](open-api/01-基础-账号-系统.md#showmodal) | 显示模态对话框。 |
|
|
25
|
-
| [showLoading](open-api/01-基础-账号-系统.md#showloading) | 显示 loading 提示框。<br><br>需调用 hideLoading 关闭。 |
|
|
26
|
-
| [hideToast](open-api/01-基础-账号-系统.md#hidetoast) | 隐藏当前 Toast。 |
|
|
27
|
-
| [hideLoading](open-api/01-基础-账号-系统.md#hideloading) | 隐藏当前 loading。 |
|
|
28
|
-
| [showActionSheet](open-api/01-基础-账号-系统.md#showactionsheet) | 显示操作菜单。 |
|
|
29
|
-
| [getMenuButtonBoundingClientRect](open-api/01-基础-账号-系统.md#getmenubuttonboundingclientrect) | 获取菜单按钮的布局位置信息。 |
|
|
30
|
-
| [enableAlertBeforeUnload](open-api/01-基础-账号-系统.md#enablealertbeforeunload) | 开启页面返回前提醒。<br><br>配合 disableAlertBeforeUnload 使用。 |
|
|
31
|
-
| [disableAlertBeforeUnload](open-api/01-基础-账号-系统.md#disablealertbeforeunload) | 关闭页面返回前提醒。 |
|
|
32
|
-
| [showToast](open-api/01-基础-账号-系统.md#showtoast) | 显示 Toast 提示。<br><br>duration 和 icon 可控制提示表现。 |
|
|
33
|
-
| [dispatchActionDirective](open-api/01-基础-账号-系统.md#dispatchactiondirective) | 描述用户行为,约束模型行为并指定后续执行路径。<br><br>适用于卡片交互后向模型补充结构化动作上下文,例如按钮点击、选项选择或表单提交。 |
|
|
34
|
-
| [expiredWidget](open-api/01-基础-账号-系统.md#expiredwidget) | 更新过期的 widget 为固定卡片。 |
|
|
35
|
-
| [loginWithDoubaoWidget](open-api/01-基础-账号-系统.md#loginwithdoubaowidget) | 发起豆包 Widget 登录。 |
|
|
36
|
-
| [login](open-api/01-基础-账号-系统.md#login) | 发起登录并获取登录凭证。 |
|
|
37
|
-
| [postLoginResult](open-api/01-基础-账号-系统.md#postloginresult) | 回传 MCP 授权登录凭证。 |
|
|
38
|
-
| [createSignOrder](open-api/01-基础-账号-系统.md#createsignorder) | 创建签约订单。 |
|
|
39
|
-
| [getOrderPaymentWithSign](open-api/01-基础-账号-系统.md#getorderpaymentwithsign) | 使用签名信息拉起收银台完成订单支付。 |
|
|
40
|
-
| [getOrderPayment](open-api/01-基础-账号-系统.md#getorderpayment) | 拉起收银台完成订单支付。 |
|
|
41
|
-
| [requestCombineOrder](open-api/01-基础-账号-系统.md#requestcombineorder) | 请求创建合单订单。 |
|
|
42
|
-
| [requestOrder](open-api/01-基础-账号-系统.md#requestorder) | 发起订单支付流程。 |
|
|
43
|
-
| [sign](open-api/01-基础-账号-系统.md#sign) | 拉起签约流程。 |
|
|
44
|
-
| [getPrivacySetting](open-api/01-基础-账号-系统.md#getprivacysetting) | 获取隐私设置状态。 |
|
|
45
|
-
| [sendQueryMessage](open-api/01-基础-账号-系统.md#sendquerymessage) | 以用户身份发送一条消息。<br><br>返回 void,不是 Promise。 |
|
|
46
|
-
| [setAdditionalContext](open-api/01-基础-账号-系统.md#setadditionalcontext) | 设置全局上下文供大模型理解。<br><br>设置全局上下文。 |
|
|
47
|
-
| [updateModelContext](open-api/01-基础-账号-系统.md#updatemodelcontext) | 向 Agent 捐赠上下文。 |
|
|
48
|
-
| [updateWidget](open-api/01-基础-账号-系统.md#updatewidget) | 更新指定卡片。 |
|
|
49
|
-
| [saveImageToPhotosAlbum](open-api/01-基础-账号-系统.md#saveimagetophotosalbum) | 保存图片到系统相册。 |
|
|
50
|
-
| [previewImage](open-api/01-基础-账号-系统.md#previewimage) | 预览图片。 |
|
|
51
|
-
| [getImageInfo](open-api/01-基础-账号-系统.md#getimageinfo) | 获取图片信息。 |
|
|
52
|
-
| [chooseImage](open-api/01-基础-账号-系统.md#chooseimage) | 选择图片。 |
|
|
53
|
-
| [compressImage](open-api/01-基础-账号-系统.md#compressimage) | 压缩图片。 |
|
|
54
|
-
| [request](open-api/01-基础-账号-系统.md#request) | 发起网络请求。<br><br>返回 statusCode、header 和 data。 |
|
|
55
|
-
| [openApp](open-api/01-基础-账号-系统.md#openapp) | 通过 deep link 等方式打开外部应用。 |
|
|
56
|
-
| [navigateTo](open-api/01-基础-账号-系统.md#navigateto) | 保留当前页面,跳转到应用内的某个页面。 |
|
|
57
|
-
| [redirectTo](open-api/01-基础-账号-系统.md#redirectto) | 关闭当前页面,跳转到应用内的某个页面。 |
|
|
58
|
-
| [reLaunch](open-api/01-基础-账号-系统.md#relaunch) | 关闭所有页面并跳转到应用内页面。 |
|
|
59
|
-
| [navigateBack](open-api/01-基础-账号-系统.md#navigateback) | 关闭当前页面,返回上一页面或多级页面。 |
|
|
60
|
-
| [exitApp](open-api/01-基础-账号-系统.md#exitapp) | 退出当前所有页面。<br><br>会退出当前所有页面。 |
|
|
61
|
-
| [setStorage](open-api/01-基础-账号-系统.md#setstorage) | 将数据写入本地缓存。 |
|
|
62
|
-
| [setStorageSync](open-api/01-基础-账号-系统.md#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API。 |
|
|
63
|
-
| [getStorage](open-api/01-基础-账号-系统.md#getstorage) | 从本地缓存读取数据。 |
|
|
64
|
-
| [getStorageSync](open-api/01-基础-账号-系统.md#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API。 |
|
|
65
|
-
| [removeStorage](open-api/01-基础-账号-系统.md#removestorage) | 删除本地缓存中指定 key 的数据。 |
|
|
66
|
-
| [removeStorageSync](open-api/01-基础-账号-系统.md#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API。 |
|
|
67
|
-
| [clearStorage](open-api/01-基础-账号-系统.md#clearstorage) | 清空本地缓存。 |
|
|
68
|
-
| [clearStorageSync](open-api/01-基础-账号-系统.md#clearstoragesync) | 清空本地缓存。<br><br>同步 API。 |
|
|
69
|
-
| [getStorageInfo](open-api/01-基础-账号-系统.md#getstorageinfo) | 获取本地缓存信息。 |
|
|
70
|
-
| [getStorageInfoSync](open-api/01-基础-账号-系统.md#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API。 |
|
|
71
23
|
| [getWindowInfoSync](open-api/01-基础-账号-系统.md#getwindowinfosync) | 获取窗口信息。<br><br>同步 API。 |
|
|
72
24
|
| [getSystemSetting](open-api/01-基础-账号-系统.md#getsystemsetting) | 获取设备设置。 |
|
|
73
25
|
| [getAppBaseInfoSync](open-api/01-基础-账号-系统.md#getappbaseinfosync) | 获取应用基础信息。<br><br>同步 API。 |
|
|
74
26
|
| [getWindowInfo](open-api/01-基础-账号-系统.md#getwindowinfo) | 获取窗口信息。 |
|
|
75
27
|
| [getAppBaseInfo](open-api/01-基础-账号-系统.md#getappbaseinfo) | 获取应用基础信息。 |
|
|
76
28
|
|
|
29
|
+
## 定位
|
|
30
|
+
|
|
31
|
+
获取设备当前的地理位置信息。
|
|
32
|
+
|
|
33
|
+
| API | 说明 |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| [getLocation](open-api/02-定位.md#getlocation) | 获取设备当前的地理位置信息。<br><br>可能涉及定位授权。 |
|
|
36
|
+
|
|
37
|
+
## 存储
|
|
38
|
+
|
|
39
|
+
本地缓存;带 Sync 后缀的是同步 API。
|
|
40
|
+
|
|
41
|
+
| API | 说明 |
|
|
42
|
+
| --- | --- |
|
|
43
|
+
| [setStorage](open-api/03-存储.md#setstorage) | 将数据写入本地缓存。 |
|
|
44
|
+
| [setStorageSync](open-api/03-存储.md#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API。 |
|
|
45
|
+
| [getStorage](open-api/03-存储.md#getstorage) | 从本地缓存读取数据。 |
|
|
46
|
+
| [getStorageSync](open-api/03-存储.md#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API。 |
|
|
47
|
+
| [removeStorage](open-api/03-存储.md#removestorage) | 删除本地缓存中指定 key 的数据。 |
|
|
48
|
+
| [removeStorageSync](open-api/03-存储.md#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API。 |
|
|
49
|
+
| [clearStorage](open-api/03-存储.md#clearstorage) | 清空本地缓存。 |
|
|
50
|
+
| [clearStorageSync](open-api/03-存储.md#clearstoragesync) | 清空本地缓存。<br><br>同步 API。 |
|
|
51
|
+
| [getStorageInfo](open-api/03-存储.md#getstorageinfo) | 获取本地缓存信息。 |
|
|
52
|
+
| [getStorageInfoSync](open-api/03-存储.md#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API。 |
|
|
53
|
+
|
|
77
54
|
## 路由
|
|
78
55
|
|
|
79
|
-
|
|
56
|
+
应用内页面跳转、返回、退出和关闭。
|
|
57
|
+
|
|
58
|
+
| API | 说明 |
|
|
59
|
+
| --- | --- |
|
|
60
|
+
| [navigateTo](open-api/04-路由.md#navigateto) | 保留当前页面,跳转到应用内的某个页面。 |
|
|
61
|
+
| [redirectTo](open-api/04-路由.md#redirectto) | 关闭当前页面,跳转到应用内的某个页面。 |
|
|
62
|
+
| [reLaunch](open-api/04-路由.md#relaunch) | 关闭所有页面并跳转到应用内页面。 |
|
|
63
|
+
| [navigateBack](open-api/04-路由.md#navigateback) | 关闭当前页面,返回上一页面或多级页面。 |
|
|
64
|
+
| [exitApp](open-api/04-路由.md#exitapp) | 退出当前所有页面。<br><br>会退出当前所有页面。 |
|
|
65
|
+
| [close](open-api/04-路由.md#close) | 关闭栈顶页面。<br><br>已废弃,使用 navigateBack。 |
|
|
66
|
+
|
|
67
|
+
## 界面 / 交互
|
|
68
|
+
|
|
69
|
+
Toast、Loading、Modal、ActionSheet 和返回前提醒。
|
|
80
70
|
|
|
81
71
|
| API | 说明 |
|
|
82
72
|
| --- | --- |
|
|
83
|
-
| [
|
|
73
|
+
| [showModal](open-api/05-界面-交互.md#showmodal) | 显示模态对话框。 |
|
|
74
|
+
| [showLoading](open-api/05-界面-交互.md#showloading) | 显示 loading 提示框。<br><br>需调用 hideLoading 关闭。 |
|
|
75
|
+
| [hideToast](open-api/05-界面-交互.md#hidetoast) | 隐藏当前 Toast。 |
|
|
76
|
+
| [hideLoading](open-api/05-界面-交互.md#hideloading) | 隐藏当前 loading。 |
|
|
77
|
+
| [showActionSheet](open-api/05-界面-交互.md#showactionsheet) | 显示操作菜单。 |
|
|
78
|
+
| [getMenuButtonBoundingClientRect](open-api/05-界面-交互.md#getmenubuttonboundingclientrect) | 获取菜单按钮的布局位置信息。 |
|
|
79
|
+
| [enableAlertBeforeUnload](open-api/05-界面-交互.md#enablealertbeforeunload) | 开启页面返回前提醒。<br><br>配合 disableAlertBeforeUnload 使用。 |
|
|
80
|
+
| [disableAlertBeforeUnload](open-api/05-界面-交互.md#disablealertbeforeunload) | 关闭页面返回前提醒。 |
|
|
81
|
+
| [showToast](open-api/05-界面-交互.md#showtoast) | 显示 Toast 提示。<br><br>duration 和 icon 可控制提示表现。 |
|
|
84
82
|
|
|
85
83
|
## 界面 / 输入
|
|
86
84
|
|
|
@@ -88,16 +86,61 @@ import { showToast, request, getStorage } from '@doubao-apps/framework/api';
|
|
|
88
86
|
|
|
89
87
|
| API | 说明 |
|
|
90
88
|
| --- | --- |
|
|
91
|
-
| [hideKeyboard](open-api/
|
|
92
|
-
| [onKeyboardHeightChange](open-api/
|
|
89
|
+
| [hideKeyboard](open-api/06-界面-输入.md#hidekeyboard) | 收起当前键盘。 |
|
|
90
|
+
| [onKeyboardHeightChange](open-api/06-界面-输入.md#onkeyboardheightchange) | 监听键盘高度变化事件。<br><br>返回取消监听函数。 |
|
|
91
|
+
|
|
92
|
+
## 网络
|
|
93
|
+
|
|
94
|
+
网络请求与 WebSocket。
|
|
95
|
+
|
|
96
|
+
| API | 说明 |
|
|
97
|
+
| --- | --- |
|
|
98
|
+
| [request](open-api/07-网络.md#request) | 发起网络请求。<br><br>返回 statusCode、header 和 data。 |
|
|
99
|
+
| [connectSocket](open-api/07-网络.md#connectsocket) | 创建一个 WebSocket 连接,并返回可操作该连接的 SocketTask。<br><br>- 返回 SocketTask 不代表连接已经成功,连接成功以 onOpen 为准。 - send 必须接收对象参数,并把要发送的内容放在 data 字段中。 - 如果 protocols 非空,需要服务端支持并返回匹配的子协议。 - 多次调用会创建多条连接,旧连接不会自动关闭;不再使用时应主动调用 close。 - 连接失败、发送失败或关闭失败会通过 SocketTask.onError 通知。 |
|
|
100
|
+
|
|
101
|
+
## 媒体
|
|
102
|
+
|
|
103
|
+
图片选择、预览、保存、压缩和信息读取。
|
|
104
|
+
|
|
105
|
+
| API | 说明 |
|
|
106
|
+
| --- | --- |
|
|
107
|
+
| [saveImageToPhotosAlbum](open-api/08-媒体.md#saveimagetophotosalbum) | 保存图片到系统相册。 |
|
|
108
|
+
| [previewImage](open-api/08-媒体.md#previewimage) | 预览图片。 |
|
|
109
|
+
| [getImageInfo](open-api/08-媒体.md#getimageinfo) | 获取图片信息。 |
|
|
110
|
+
| [chooseImage](open-api/08-媒体.md#chooseimage) | 选择图片。 |
|
|
111
|
+
| [compressImage](open-api/08-媒体.md#compressimage) | 压缩图片。 |
|
|
112
|
+
|
|
113
|
+
## 开放能力 / 业务能力
|
|
114
|
+
|
|
115
|
+
开放业务能力、支付、隐私设置、上下文和外部应用打开。
|
|
116
|
+
|
|
117
|
+
| API | 说明 |
|
|
118
|
+
| --- | --- |
|
|
119
|
+
| [dispatchActionDirective](open-api/09-开放能力-业务能力.md#dispatchactiondirective) | 描述用户行为,约束模型行为并指定后续执行路径。<br><br>适用于卡片交互后向模型补充结构化动作上下文,例如按钮点击、选项选择或表单提交。 |
|
|
120
|
+
| [expiredWidget](open-api/09-开放能力-业务能力.md#expiredwidget) | 更新过期的 widget 为固定卡片。 |
|
|
121
|
+
| [loginWithDoubaoWidget](open-api/09-开放能力-业务能力.md#loginwithdoubaowidget) | 发起豆包 Widget 登录。 |
|
|
122
|
+
| [login](open-api/09-开放能力-业务能力.md#login) | 发起登录并获取登录凭证。 |
|
|
123
|
+
| [postLoginResult](open-api/09-开放能力-业务能力.md#postloginresult) | 回传 MCP 授权登录凭证。 |
|
|
124
|
+
| [createSignOrder](open-api/09-开放能力-业务能力.md#createsignorder) | 创建签约订单。 |
|
|
125
|
+
| [getOrderPaymentWithSign](open-api/09-开放能力-业务能力.md#getorderpaymentwithsign) | 使用签名信息拉起收银台完成订单支付。 |
|
|
126
|
+
| [getOrderPayment](open-api/09-开放能力-业务能力.md#getorderpayment) | 拉起收银台完成订单支付。 |
|
|
127
|
+
| [requestCombineOrder](open-api/09-开放能力-业务能力.md#requestcombineorder) | 请求创建合单订单。 |
|
|
128
|
+
| [requestOrder](open-api/09-开放能力-业务能力.md#requestorder) | 发起订单支付流程。 |
|
|
129
|
+
| [sign](open-api/09-开放能力-业务能力.md#sign) | 拉起签约流程。 |
|
|
130
|
+
| [getPrivacySetting](open-api/09-开放能力-业务能力.md#getprivacysetting) | 获取隐私设置状态。 |
|
|
131
|
+
| [sendQueryMessage](open-api/09-开放能力-业务能力.md#sendquerymessage) | 以用户身份发送一条消息。<br><br>返回 void,不是 Promise。 |
|
|
132
|
+
| [setAdditionalContext](open-api/09-开放能力-业务能力.md#setadditionalcontext) | 设置全局上下文供大模型理解。<br><br>设置全局上下文。 |
|
|
133
|
+
| [updateModelContext](open-api/09-开放能力-业务能力.md#updatemodelcontext) | 向 Agent 捐赠上下文。 |
|
|
134
|
+
| [updateWidget](open-api/09-开放能力-业务能力.md#updatewidget) | 更新指定卡片。 |
|
|
135
|
+
| [openApp](open-api/09-开放能力-业务能力.md#openapp) | 通过 deep link 等方式打开外部应用。 |
|
|
93
136
|
|
|
94
137
|
## 数据分析
|
|
95
138
|
|
|
96
|
-
|
|
139
|
+
监控上报、事件和数据分析上报。
|
|
97
140
|
|
|
98
141
|
| API | 说明 |
|
|
99
142
|
| --- | --- |
|
|
100
|
-
| [reportEvent](open-api/
|
|
143
|
+
| [reportEvent](open-api/10-数据分析.md#reportevent) | 上报数据分析事件。 |
|
|
101
144
|
|
|
102
145
|
## 设备 / 蓝牙
|
|
103
146
|
|
|
@@ -105,25 +148,25 @@ import { showToast, request, getStorage } from '@doubao-apps/framework/api';
|
|
|
105
148
|
|
|
106
149
|
| API | 说明 |
|
|
107
150
|
| --- | --- |
|
|
108
|
-
| [openBluetoothAdapter](open-api/
|
|
109
|
-
| [startBluetoothDevicesDiscovery](open-api/
|
|
110
|
-
| [stopBluetoothDevicesDiscovery](open-api/
|
|
111
|
-
| [getBluetoothAdapterState](open-api/
|
|
112
|
-
| [getBluetoothDevices](open-api/
|
|
113
|
-
| [getConnectedBluetoothDevices](open-api/
|
|
114
|
-
| [makeBluetoothPair](open-api/
|
|
115
|
-
| [isBluetoothDevicePaired](open-api/
|
|
116
|
-
| [closeBluetoothAdapter](open-api/
|
|
117
|
-
| [createBLEConnection](open-api/
|
|
118
|
-
| [closeBLEConnection](open-api/
|
|
119
|
-
| [getBLEDeviceServices](open-api/
|
|
120
|
-
| [getBLEDeviceCharacteristics](open-api/
|
|
121
|
-
| [getBLEDeviceRSSI](open-api/
|
|
122
|
-
| [getBLEMTU](open-api/
|
|
123
|
-
| [notifyBLECharacteristicValueChange](open-api/
|
|
124
|
-
| [readBLECharacteristicValue](open-api/
|
|
125
|
-
| [setBLEMTU](open-api/
|
|
126
|
-
| [writeBLECharacteristicValue](open-api/
|
|
151
|
+
| [openBluetoothAdapter](open-api/11-设备-蓝牙.md#openbluetoothadapter) | 打开蓝牙适配器。<br><br>蓝牙流程入口。 |
|
|
152
|
+
| [startBluetoothDevicesDiscovery](open-api/11-设备-蓝牙.md#startbluetoothdevicesdiscovery) | 开始搜索附近的蓝牙设备。<br><br>通常先调用 openBluetoothAdapter。 |
|
|
153
|
+
| [stopBluetoothDevicesDiscovery](open-api/11-设备-蓝牙.md#stopbluetoothdevicesdiscovery) | 停止搜索附近的蓝牙设备。 |
|
|
154
|
+
| [getBluetoothAdapterState](open-api/11-设备-蓝牙.md#getbluetoothadapterstate) | 获取蓝牙适配器状态。 |
|
|
155
|
+
| [getBluetoothDevices](open-api/11-设备-蓝牙.md#getbluetoothdevices) | 获取当前蓝牙模块发现的设备列表。<br><br>通常先调用 startBluetoothDevicesDiscovery。 |
|
|
156
|
+
| [getConnectedBluetoothDevices](open-api/11-设备-蓝牙.md#getconnectedbluetoothdevices) | 获取已连接的蓝牙设备列表。 |
|
|
157
|
+
| [makeBluetoothPair](open-api/11-设备-蓝牙.md#makebluetoothpair) | 发起蓝牙配对。 |
|
|
158
|
+
| [isBluetoothDevicePaired](open-api/11-设备-蓝牙.md#isbluetoothdevicepaired) | 查询蓝牙设备是否已经配对。 |
|
|
159
|
+
| [closeBluetoothAdapter](open-api/11-设备-蓝牙.md#closebluetoothadapter) | 关闭蓝牙适配器。<br><br>会关闭蓝牙模块。 |
|
|
160
|
+
| [createBLEConnection](open-api/11-设备-蓝牙.md#createbleconnection) | 创建 BLE 连接。<br><br>需要传入 deviceId。 |
|
|
161
|
+
| [closeBLEConnection](open-api/11-设备-蓝牙.md#closebleconnection) | 关闭 BLE 连接。 |
|
|
162
|
+
| [getBLEDeviceServices](open-api/11-设备-蓝牙.md#getbledeviceservices) | 获取 BLE 服务列表。<br><br>通常先调用 createBLEConnection。 |
|
|
163
|
+
| [getBLEDeviceCharacteristics](open-api/11-设备-蓝牙.md#getbledevicecharacteristics) | 获取 BLE 特征值列表。<br><br>通常先获取 BLE 服务列表。 |
|
|
164
|
+
| [getBLEDeviceRSSI](open-api/11-设备-蓝牙.md#getbledevicerssi) | 获取 BLE 设备 RSSI。 |
|
|
165
|
+
| [getBLEMTU](open-api/11-设备-蓝牙.md#getblemtu) | 获取 BLE MTU。 |
|
|
166
|
+
| [notifyBLECharacteristicValueChange](open-api/11-设备-蓝牙.md#notifyblecharacteristicvaluechange) | 订阅 BLE 特征值变化。<br><br>订阅指定特征值变化。 |
|
|
167
|
+
| [readBLECharacteristicValue](open-api/11-设备-蓝牙.md#readblecharacteristicvalue) | 读取 BLE 特征值。<br><br>需要传入 serviceId 和 characteristicId。 |
|
|
168
|
+
| [setBLEMTU](open-api/11-设备-蓝牙.md#setblemtu) | 设置 BLE MTU。 |
|
|
169
|
+
| [writeBLECharacteristicValue](open-api/11-设备-蓝牙.md#writeblecharacteristicvalue) | 写入 BLE 特征值。<br><br>value 需要是 ArrayBuffer。 |
|
|
127
170
|
|
|
128
171
|
## 设备 / Wi-Fi
|
|
129
172
|
|
|
@@ -131,12 +174,12 @@ Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。
|
|
|
131
174
|
|
|
132
175
|
| API | 说明 |
|
|
133
176
|
| --- | --- |
|
|
134
|
-
| [startWifi](open-api/
|
|
135
|
-
| [stopWifi](open-api/
|
|
136
|
-
| [setWifiList](open-api/
|
|
137
|
-
| [connectWifi](open-api/
|
|
138
|
-
| [getConnectedWifi](open-api/
|
|
139
|
-
| [getWifiList](open-api/
|
|
177
|
+
| [startWifi](open-api/12-设备-wi-fi.md#startwifi) | 初始化 Wi-Fi 模块。<br><br>Wi-Fi 流程入口。 |
|
|
178
|
+
| [stopWifi](open-api/12-设备-wi-fi.md#stopwifi) | 关闭 Wi-Fi 模块。 |
|
|
179
|
+
| [setWifiList](open-api/12-设备-wi-fi.md#setwifilist) | 设置 Wi-Fi 预设列表。<br><br>用于预设 Wi-Fi 列表。 |
|
|
180
|
+
| [connectWifi](open-api/12-设备-wi-fi.md#connectwifi) | 连接指定 Wi-Fi。<br><br>通常先调用 startWifi。 |
|
|
181
|
+
| [getConnectedWifi](open-api/12-设备-wi-fi.md#getconnectedwifi) | 获取当前已连接 Wi-Fi 信息。 |
|
|
182
|
+
| [getWifiList](open-api/12-设备-wi-fi.md#getwifilist) | 获取 Wi-Fi 列表。<br><br>通常先调用 startWifi。 |
|
|
140
183
|
|
|
141
184
|
## 设备 / 加速度计
|
|
142
185
|
|
|
@@ -144,9 +187,9 @@ Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。
|
|
|
144
187
|
|
|
145
188
|
| API | 说明 |
|
|
146
189
|
| --- | --- |
|
|
147
|
-
| [startAccelerometer](open-api/
|
|
148
|
-
| [stopAccelerometer](open-api/
|
|
149
|
-
| [onAccelerometerChange](open-api/
|
|
190
|
+
| [startAccelerometer](open-api/13-设备-加速度计.md#startaccelerometer) | 开始监听加速度。<br><br>需配对调用 stopAccelerometer。 |
|
|
191
|
+
| [stopAccelerometer](open-api/13-设备-加速度计.md#stopaccelerometer) | 停止监听加速度。 |
|
|
192
|
+
| [onAccelerometerChange](open-api/13-设备-加速度计.md#onaccelerometerchange) | 监听加速度数据变化事件。<br><br>返回取消监听函数。 |
|
|
150
193
|
|
|
151
194
|
## 设备 / iBeacon
|
|
152
195
|
|
|
@@ -154,9 +197,9 @@ iBeacon 搜索和结果读取能力。
|
|
|
154
197
|
|
|
155
198
|
| API | 说明 |
|
|
156
199
|
| --- | --- |
|
|
157
|
-
| [startBeaconDiscovery](open-api/
|
|
158
|
-
| [stopBeaconDiscovery](open-api/
|
|
159
|
-
| [getBeacons](open-api/
|
|
200
|
+
| [startBeaconDiscovery](open-api/14-设备-ibeacon.md#startbeacondiscovery) | 开始搜索附近的 iBeacon。<br><br>需配对调用 stopBeaconDiscovery。 |
|
|
201
|
+
| [stopBeaconDiscovery](open-api/14-设备-ibeacon.md#stopbeacondiscovery) | 停止搜索附近的 iBeacon。 |
|
|
202
|
+
| [getBeacons](open-api/14-设备-ibeacon.md#getbeacons) | 获取已搜索到的 iBeacon 列表。 |
|
|
160
203
|
|
|
161
204
|
## 设备 / 罗盘
|
|
162
205
|
|
|
@@ -164,9 +207,9 @@ iBeacon 搜索和结果读取能力。
|
|
|
164
207
|
|
|
165
208
|
| API | 说明 |
|
|
166
209
|
| --- | --- |
|
|
167
|
-
| [startCompass](open-api/
|
|
168
|
-
| [stopCompass](open-api/
|
|
169
|
-
| [onCompassChange](open-api/
|
|
210
|
+
| [startCompass](open-api/15-设备-罗盘.md#startcompass) | 开始监听罗盘。<br><br>需配对调用 stopCompass。 |
|
|
211
|
+
| [stopCompass](open-api/15-设备-罗盘.md#stopcompass) | 停止监听罗盘。 |
|
|
212
|
+
| [onCompassChange](open-api/15-设备-罗盘.md#oncompasschange) | 监听罗盘数据变化事件。<br><br>返回取消监听函数。 |
|
|
170
213
|
|
|
171
214
|
## 设备 / 设备方向
|
|
172
215
|
|
|
@@ -174,9 +217,9 @@ iBeacon 搜索和结果读取能力。
|
|
|
174
217
|
|
|
175
218
|
| API | 说明 |
|
|
176
219
|
| --- | --- |
|
|
177
|
-
| [startDeviceMotionListening](open-api/
|
|
178
|
-
| [stopDeviceMotionListening](open-api/
|
|
179
|
-
| [onDeviceMotionChange](open-api/
|
|
220
|
+
| [startDeviceMotionListening](open-api/16-设备-设备方向.md#startdevicemotionlistening) | 开始监听设备方向变化。<br><br>需配对调用 stopDeviceMotionListening。 |
|
|
221
|
+
| [stopDeviceMotionListening](open-api/16-设备-设备方向.md#stopdevicemotionlistening) | 停止监听设备方向变化。 |
|
|
222
|
+
| [onDeviceMotionChange](open-api/16-设备-设备方向.md#ondevicemotionchange) | 监听设备方向变化事件。<br><br>返回取消监听函数。 |
|
|
180
223
|
|
|
181
224
|
## 设备 / 陀螺仪
|
|
182
225
|
|
|
@@ -184,9 +227,9 @@ iBeacon 搜索和结果读取能力。
|
|
|
184
227
|
|
|
185
228
|
| API | 说明 |
|
|
186
229
|
| --- | --- |
|
|
187
|
-
| [startGyroscope](open-api/
|
|
188
|
-
| [stopGyroscope](open-api/
|
|
189
|
-
| [onGyroscopeChange](open-api/
|
|
230
|
+
| [startGyroscope](open-api/17-设备-陀螺仪.md#startgyroscope) | 开始监听陀螺仪。<br><br>需配对调用 stopGyroscope。 |
|
|
231
|
+
| [stopGyroscope](open-api/17-设备-陀螺仪.md#stopgyroscope) | 停止监听陀螺仪。 |
|
|
232
|
+
| [onGyroscopeChange](open-api/17-设备-陀螺仪.md#ongyroscopechange) | 监听陀螺仪数据变化事件。<br><br>返回取消监听函数。 |
|
|
190
233
|
|
|
191
234
|
## UI / 输入
|
|
192
235
|
|
|
@@ -194,7 +237,7 @@ iBeacon 搜索和结果读取能力。
|
|
|
194
237
|
|
|
195
238
|
| API | 说明 |
|
|
196
239
|
| --- | --- |
|
|
197
|
-
| [getSelectedTextRange](open-api/
|
|
240
|
+
| [getSelectedTextRange](open-api/18-ui-输入.md#getselectedtextrange) | 获取当前输入框的选区范围。 |
|
|
198
241
|
|
|
199
242
|
## 设备 / 网络
|
|
200
243
|
|
|
@@ -202,9 +245,9 @@ iBeacon 搜索和结果读取能力。
|
|
|
202
245
|
|
|
203
246
|
| API | 说明 |
|
|
204
247
|
| --- | --- |
|
|
205
|
-
| [getLocalIPAddress](open-api/
|
|
206
|
-
| [getNetworkType](open-api/
|
|
207
|
-
| [onNetworkStatusChange](open-api/
|
|
248
|
+
| [getLocalIPAddress](open-api/19-设备-网络.md#getlocalipaddress) | 获取局域网 IP 地址。 |
|
|
249
|
+
| [getNetworkType](open-api/19-设备-网络.md#getnetworktype) | 获取当前网络类型。 |
|
|
250
|
+
| [onNetworkStatusChange](open-api/19-设备-网络.md#onnetworkstatuschange) | 监听网络状态变化事件。<br><br>返回取消监听函数。 |
|
|
208
251
|
|
|
209
252
|
## 设备 / 短信
|
|
210
253
|
|
|
@@ -212,7 +255,7 @@ iBeacon 搜索和结果读取能力。
|
|
|
212
255
|
|
|
213
256
|
| API | 说明 |
|
|
214
257
|
| --- | --- |
|
|
215
|
-
| [sendSms](open-api/
|
|
258
|
+
| [sendSms](open-api/20-设备-短信.md#sendsms) | 拉起系统短信发送面板。 |
|
|
216
259
|
|
|
217
260
|
## 设备 / 无障碍
|
|
218
261
|
|
|
@@ -220,7 +263,7 @@ iBeacon 搜索和结果读取能力。
|
|
|
220
263
|
|
|
221
264
|
| API | 说明 |
|
|
222
265
|
| --- | --- |
|
|
223
|
-
| [checkIsOpenAccessibility](open-api/
|
|
266
|
+
| [checkIsOpenAccessibility](open-api/21-设备-无障碍.md#checkisopenaccessibility) | 检测无障碍能力是否开启。 |
|
|
224
267
|
|
|
225
268
|
## 设备 / 电池
|
|
226
269
|
|
|
@@ -228,8 +271,8 @@ iBeacon 搜索和结果读取能力。
|
|
|
228
271
|
|
|
229
272
|
| API | 说明 |
|
|
230
273
|
| --- | --- |
|
|
231
|
-
| [getBatteryInfo](open-api/
|
|
232
|
-
| [onBatteryInfoChange](open-api/
|
|
274
|
+
| [getBatteryInfo](open-api/22-设备-电池.md#getbatteryinfo) | 获取电池信息。 |
|
|
275
|
+
| [onBatteryInfoChange](open-api/22-设备-电池.md#onbatteryinfochange) | 监听电池信息变化事件。<br><br>返回取消监听函数。 |
|
|
233
276
|
|
|
234
277
|
## 设备 / 日历
|
|
235
278
|
|
|
@@ -237,8 +280,8 @@ iBeacon 搜索和结果读取能力。
|
|
|
237
280
|
|
|
238
281
|
| API | 说明 |
|
|
239
282
|
| --- | --- |
|
|
240
|
-
| [addPhoneCalendar](open-api/
|
|
241
|
-
| [addPhoneRepeatCalendar](open-api/
|
|
283
|
+
| [addPhoneCalendar](open-api/23-设备-日历.md#addphonecalendar) | 向系统日历添加事件。 |
|
|
284
|
+
| [addPhoneRepeatCalendar](open-api/23-设备-日历.md#addphonerepeatcalendar) | 向系统日历添加重复事件。 |
|
|
242
285
|
|
|
243
286
|
## 设备 / 剪贴板
|
|
244
287
|
|
|
@@ -246,8 +289,8 @@ iBeacon 搜索和结果读取能力。
|
|
|
246
289
|
|
|
247
290
|
| API | 说明 |
|
|
248
291
|
| --- | --- |
|
|
249
|
-
| [getClipboardData](open-api/
|
|
250
|
-
| [setClipboardData](open-api/
|
|
292
|
+
| [getClipboardData](open-api/24-设备-剪贴板.md#getclipboarddata) | 获取剪贴板内容。 |
|
|
293
|
+
| [setClipboardData](open-api/24-设备-剪贴板.md#setclipboarddata) | 设置系统剪贴板内容。 |
|
|
251
294
|
|
|
252
295
|
## 设备 / 联系人
|
|
253
296
|
|
|
@@ -255,8 +298,8 @@ iBeacon 搜索和结果读取能力。
|
|
|
255
298
|
|
|
256
299
|
| API | 说明 |
|
|
257
300
|
| --- | --- |
|
|
258
|
-
| [chooseContact](open-api/
|
|
259
|
-
| [addPhoneContact](open-api/
|
|
301
|
+
| [chooseContact](open-api/25-设备-联系人.md#choosecontact) | 选择手机联系人。 |
|
|
302
|
+
| [addPhoneContact](open-api/25-设备-联系人.md#addphonecontact) | 添加手机联系人。 |
|
|
260
303
|
|
|
261
304
|
## 设备 / 加密
|
|
262
305
|
|
|
@@ -264,7 +307,7 @@ iBeacon 搜索和结果读取能力。
|
|
|
264
307
|
|
|
265
308
|
| API | 说明 |
|
|
266
309
|
| --- | --- |
|
|
267
|
-
| [getRandomValues](open-api/
|
|
310
|
+
| [getRandomValues](open-api/26-设备-加密.md#getrandomvalues) | 获取安全随机数。 |
|
|
268
311
|
|
|
269
312
|
## 设备 / 电话
|
|
270
313
|
|
|
@@ -272,7 +315,7 @@ iBeacon 搜索和结果读取能力。
|
|
|
272
315
|
|
|
273
316
|
| API | 说明 |
|
|
274
317
|
| --- | --- |
|
|
275
|
-
| [makePhoneCall](open-api/
|
|
318
|
+
| [makePhoneCall](open-api/27-设备-电话.md#makephonecall) | 拨打电话。 |
|
|
276
319
|
|
|
277
320
|
## 设备 / 扫码
|
|
278
321
|
|
|
@@ -280,7 +323,7 @@ iBeacon 搜索和结果读取能力。
|
|
|
280
323
|
|
|
281
324
|
| API | 说明 |
|
|
282
325
|
| --- | --- |
|
|
283
|
-
| [scanCode](open-api/
|
|
326
|
+
| [scanCode](open-api/28-设备-扫码.md#scancode) | 调起扫码能力。 |
|
|
284
327
|
|
|
285
328
|
## 设备 / 屏幕
|
|
286
329
|
|
|
@@ -288,11 +331,11 @@ iBeacon 搜索和结果读取能力。
|
|
|
288
331
|
|
|
289
332
|
| API | 说明 |
|
|
290
333
|
| --- | --- |
|
|
291
|
-
| [getScreenBrightness](open-api/
|
|
292
|
-
| [setVisualEffectOnCapture](open-api/
|
|
293
|
-
| [setScreenBrightness](open-api/
|
|
294
|
-
| [setKeepScreenOn](open-api/
|
|
295
|
-
| [onUserCaptureScreen](open-api/
|
|
334
|
+
| [getScreenBrightness](open-api/29-设备-屏幕.md#getscreenbrightness) | 获取屏幕亮度。 |
|
|
335
|
+
| [setVisualEffectOnCapture](open-api/29-设备-屏幕.md#setvisualeffectoncapture) | 设置截屏或录屏时的视觉表现。<br><br>控制截屏或录屏时的视觉效果。 |
|
|
336
|
+
| [setScreenBrightness](open-api/29-设备-屏幕.md#setscreenbrightness) | 设置屏幕亮度。 |
|
|
337
|
+
| [setKeepScreenOn](open-api/29-设备-屏幕.md#setkeepscreenon) | 设置屏幕常亮状态。 |
|
|
338
|
+
| [onUserCaptureScreen](open-api/29-设备-屏幕.md#onusercapturescreen) | 监听用户主动截屏事件。<br><br>返回取消监听函数。 |
|
|
296
339
|
|
|
297
340
|
## 设备 / 震动
|
|
298
341
|
|
|
@@ -300,5 +343,5 @@ iBeacon 搜索和结果读取能力。
|
|
|
300
343
|
|
|
301
344
|
| API | 说明 |
|
|
302
345
|
| --- | --- |
|
|
303
|
-
| [vibrateShort](open-api/
|
|
304
|
-
| [vibrateLong](open-api/
|
|
346
|
+
| [vibrateShort](open-api/30-设备-震动.md#vibrateshort) | 触发短震动。 |
|
|
347
|
+
| [vibrateLong](open-api/30-设备-震动.md#vibratelong) | 触发长震动。 |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@doubao-apps/ai",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.30",
|
|
4
4
|
"description": "Doubao Apps SDK AI tools with context and skills management",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -34,6 +34,6 @@
|
|
|
34
34
|
"registry": "https://registry.npmjs.org/"
|
|
35
35
|
},
|
|
36
36
|
"scripts": {
|
|
37
|
-
"build": "
|
|
37
|
+
"build": "rslib build && node scripts/copy-assets.cjs"
|
|
38
38
|
}
|
|
39
39
|
}
|
package/dist/contexts/doubao-apps-dev/references/reference/open-api/02-/350/267/257/347/224/261.md
DELETED
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# Open API: 路由
|
|
2
|
-
|
|
3
|
-
应用内页面跳转和关闭。
|
|
4
|
-
|
|
5
|
-
[返回目录](./README.md) | [返回速查](../open-api.md)
|
|
6
|
-
|
|
7
|
-
## 速查
|
|
8
|
-
|
|
9
|
-
| API | 说明 |
|
|
10
|
-
| --- | --- |
|
|
11
|
-
| [close](#close) | 关闭栈顶页面。<br><br>已废弃,使用 navigateBack。 |
|
|
12
|
-
|
|
13
|
-
## API 详情
|
|
14
|
-
|
|
15
|
-
<a id="close"></a>
|
|
16
|
-
### close()
|
|
17
|
-
|
|
18
|
-
> **close**(`params`?): `Promise`\<`object`\>
|
|
19
|
-
|
|
20
|
-
关闭栈顶页面。
|
|
21
|
-
|
|
22
|
-
#### Parameters
|
|
23
|
-
|
|
24
|
-
• **params?**: [`CloseParams`](#closeparams)
|
|
25
|
-
|
|
26
|
-
#### Returns
|
|
27
|
-
|
|
28
|
-
`Promise`\<`object`\>
|
|
29
|
-
|
|
30
|
-
返回一个 Promise,在关闭操作成功发起时解析
|
|
31
|
-
|
|
32
|
-
#### Deprecated
|
|
33
|
-
|
|
34
|
-
使用 [navigateBack](#navigateback)
|
|
35
|
-
|
|
36
|
-
#### Example
|
|
37
|
-
|
|
38
|
-
```typescript
|
|
39
|
-
import { close } from '@doubao-apps/framework/api';
|
|
40
|
-
|
|
41
|
-
async function closeTopPage() {
|
|
42
|
-
try {
|
|
43
|
-
await close();
|
|
44
|
-
} catch (e) {
|
|
45
|
-
console.error('关闭页面失败', e);
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
closePage();
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
## 相关类型
|
|
53
|
-
|
|
54
|
-
<a id="closeparams"></a>
|
|
55
|
-
### CloseParams
|
|
56
|
-
|
|
57
|
-
#### Properties
|
|
58
|
-
|
|
59
|
-
##### containerID?
|
|
60
|
-
|
|
61
|
-
> `optional` **containerID**: `string`
|
|
62
|
-
|
|
63
|
-
指定一个要关闭的页面
|