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