@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.
Files changed (91) hide show
  1. package/README.md +21 -0
  2. package/dist/994.js +3 -3
  3. package/dist/contexts/doubao-apps-dev/.ai/examples/common-patterns.md +600 -0
  4. package/dist/contexts/doubao-apps-dev/.ai/examples/component-basics.md +509 -0
  5. package/dist/contexts/doubao-apps-dev/.ai/guides/best-practices.md +571 -0
  6. package/dist/contexts/doubao-apps-dev/.ai/guides/component-development.md +857 -0
  7. package/dist/contexts/doubao-apps-dev/.ai/guides/performance-optimization.md +404 -0
  8. package/dist/contexts/doubao-apps-dev/.ai/guides/system-prompt.md +331 -0
  9. package/dist/contexts/doubao-apps-dev/.ai/guides/troubleshooting.md +291 -0
  10. package/dist/contexts/doubao-apps-dev/.ai/reference/components-quick-ref.md +103 -0
  11. package/dist/contexts/doubao-apps-dev/.ai/reference/framework-api-quick-ref.md +537 -0
  12. 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
  13. 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
  14. 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
  15. 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
  16. 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
  17. package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/06-/347/275/221/347/273/234.md +148 -0
  18. 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
  19. 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
  20. 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
  21. 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
  22. 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
  23. package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/12-/350/256/276/345/244/207-ibeacon.md +148 -0
  24. 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
  25. 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
  26. 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
  27. package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/16-ui-/350/276/223/345/205/245.md +65 -0
  28. 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
  29. 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
  30. 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
  31. 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
  32. 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
  33. 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
  34. 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
  35. 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
  36. 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
  37. 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
  38. 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
  39. 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
  40. package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/README.md +36 -0
  41. package/dist/contexts/doubao-apps-dev/.ai/reference/open-api.md +326 -0
  42. package/dist/contexts/doubao-apps-dev/.ai/rules/dos-and-donts.md +390 -0
  43. package/dist/{skills → contexts}/doubao-apps-dev/AGENTS.md +54 -31
  44. package/dist/manifest.json +45 -0
  45. package/dist/skills/doubao-apps-dev/.ai/examples/common-patterns.md +53 -43
  46. package/dist/skills/doubao-apps-dev/.ai/examples/component-basics.md +0 -17
  47. package/dist/skills/doubao-apps-dev/.ai/guides/component-development.md +96 -214
  48. package/dist/skills/doubao-apps-dev/.ai/guides/system-prompt.md +14 -14
  49. package/dist/skills/doubao-apps-dev/.ai/reference/framework-api-quick-ref.md +46 -85
  50. 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
  51. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/02-/345/255/230/345/202/250.md +409 -0
  52. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/03-/350/267/257/347/224/261.md +165 -0
  53. 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
  54. 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
  55. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/06-/347/275/221/347/273/234.md +148 -0
  56. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/07-/345/252/222/344/275/223.md +346 -0
  57. 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
  58. 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
  59. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/10-/350/256/276/345/244/207-wi-fi.md +277 -0
  60. 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
  61. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/12-/350/256/276/345/244/207-ibeacon.md +148 -0
  62. 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
  63. 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
  64. 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
  65. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/16-ui-/350/276/223/345/205/245.md +65 -0
  66. 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
  67. 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
  68. 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
  69. 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
  70. 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
  71. 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
  72. 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
  73. 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
  74. 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
  75. 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
  76. 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
  77. 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
  78. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/README.md +27 -11
  79. package/dist/skills/doubao-apps-dev/.ai/reference/open-api.md +282 -166
  80. package/dist/skills/doubao-apps-dev/.ai/rules/dos-and-donts.md +50 -37
  81. package/dist/skills/doubao-apps-dev/SKILL.md +55 -27
  82. package/dist/skills/douyin-to-doubao/SKILL.md +2 -2
  83. package/dist/skills/h5-to-doubao/SKILL.md +2 -2
  84. package/dist/skills/uniapp-to-doubao/SKILL.md +2 -2
  85. package/dist/skills/weixin-to-doubao/SKILL.md +2 -2
  86. package/package.json +4 -2
  87. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/05-ui-/350/276/223/345/205/245.md +0 -95
  88. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/06-network.md +0 -298
  89. package/dist/skills/doubao-apps-dev/.ai/reference/open-api/11-device-/344/274/240/346/204/237/345/231/250.md +0 -372
  90. 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
  91. /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` 的导出结构自动生成,只保留 API 名称、签名、用途、参数类型、结果类型和关键注意点。
3
+ > 公开可用的端能力 API。默认从 `@doubao-apps/framework/api` 导入;本文件根据 `packages/open-api/src` 的导出结构自动生成,按模块列出 API 名称和说明。
4
4
 
5
- 覆盖 115 个函数。详细信息请查看 [Open API 目录](open-api/README.md),精确字段也可按参数/结果类型名查看 IDE 类型提示或 `@doubao-apps/framework/api` 类型定义。
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
- | `getAccountInfo` | `getAccountInfo(params?): Promise<GetAccountInfoResult>` | 异步获取账号信息 | `params?` | `Promise<GetAccountInfoResult>` | - | [详情](open-api/01-基础-账号-系统.md#getaccountinfo) |
20
- | `getAccountInfoSync` | `getAccountInfoSync(params?): GetAccountInfoResult` | 同步获取账号信息 | `params?` | `GetAccountInfoResult` | 同步 API | [详情](open-api/01-基础-账号-系统.md#getaccountinfosync) |
21
- | `authorize` | `authorize(params): Promise<object>` | 初始化授权 | `params: AuthorizeRequest` | `Promise<object>` | 按 scope 申请授权 | [详情](open-api/01-基础-账号-系统.md#authorize) |
22
- | `canIUse` | `canIUse(params): Promise<CanIUseResult>` | 检测当前宿主是否支持指定 API 或能力 | `params: CanIUseParams` | `Promise<CanIUseResult>` | 用于兼容性判断 | [详情](open-api/01-基础-账号-系统.md#caniuse) |
23
- | `getLocation` | `getLocation(params?): Promise<GetLocationResponse>` | 获取设备当前的地理位置信息 | `params?: GetLocationParams` | `Promise<GetLocationResponse>` | 可能涉及定位授权 | [详情](open-api/01-基础-账号-系统.md#getlocation) |
24
- | `login` | `login(params?): Promise<LoginResult>` | 发起登录并获取登录凭证 | `params?: LoginRequest` | `Promise<LoginResult>` | - | [详情](open-api/01-基础-账号-系统.md#login) |
25
- | `getWindowInfoSync` | `getWindowInfoSync(_param?): GetWindowInfoResult` | 获取窗口信息 | `_param?` | `GetWindowInfoResult` | 同步 API | [详情](open-api/01-基础-账号-系统.md#getwindowinfosync) |
26
- | `getSystemSetting` | `getSystemSetting(params?): GetSystemSettingResult` | 获取设备设置 | `params?` | `GetSystemSettingResult` | - | [详情](open-api/01-基础-账号-系统.md#getsystemsetting) |
27
- | `getAppBaseInfoSync` | `getAppBaseInfoSync(_params?): GetAppBaseInfoResult` | 获取应用基础信息 | `_params?` | `GetAppBaseInfoResult` | 同步 API | [详情](open-api/01-基础-账号-系统.md#getappbaseinfosync) |
28
- | `getWindowInfo` | `getWindowInfo(_params?): Promise<GetWindowInfoResult>` | 获取窗口信息 | `_params?` | `Promise<GetWindowInfoResult>` | - | [详情](open-api/01-基础-账号-系统.md#getwindowinfo) |
29
- | `getAppBaseInfo` | `getAppBaseInfo(params?): Promise<GetAppBaseInfoResult>` | 获取应用基础信息 | `params?` | `Promise<GetAppBaseInfoResult>` | - | [详情](open-api/01-基础-账号-系统.md#getappbaseinfo) |
30
-
31
- ## Storage
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
- | `setStorage` | `setStorage<TData>(params): Promise<object>` | 将数据写入本地缓存 | `params: SetStorageParams<TData>` | `Promise<object>` | data 会 JSON 序列化 | [详情](open-api/02-storage.md#setstorage) |
38
- | `setStorageSync` | `setStorageSync<TData>(params): object` | 将数据写入本地缓存 | `params: SetStorageParams<TData>` | `object` | data 会 JSON 序列化;同步 API | [详情](open-api/02-storage.md#setstoragesync) |
39
- | `getStorage` | `getStorage<TData>(params): Promise<GetStorageResult<TData>>` | 从本地缓存读取数据 | `params: GetStorageParams` | `Promise<GetStorageResult<TData>>` | data 会 JSON 反序列化 | [详情](open-api/02-storage.md#getstorage) |
40
- | `getStorageSync` | `getStorageSync<TData>(params): GetStorageResult<TData>` | 从本地缓存同步读取数据 | `params: GetStorageParams` | `GetStorageResult<TData>` | data 会 JSON 反序列化;同步 API | [详情](open-api/02-storage.md#getstoragesync) |
41
- | `removeStorage` | `removeStorage(params): Promise<object>` | 删除本地缓存中指定 key 的数据 | `params: RemoveStorageParams` | `Promise<object>` | - | [详情](open-api/02-storage.md#removestorage) |
42
- | `removeStorageSync` | `removeStorageSync(params?): object` | 删除本地缓存中指定 key 的数据 | `params?: RemoveStorageParams` | `object` | 同步 API | [详情](open-api/02-storage.md#removestoragesync) |
43
- | `clearStorage` | `clearStorage(params?): Promise<object>` | 清空本地缓存 | `params?: object` | `Promise<object>` | - | [详情](open-api/02-storage.md#clearstorage) |
44
- | `clearStorageSync` | `clearStorageSync(params?): object` | 清空本地缓存 | `params?: object` | `object` | 同步 API | [详情](open-api/02-storage.md#clearstoragesync) |
45
- | `getStorageInfo` | `getStorageInfo(params?): Promise<GetStorageInfoResult>` | 获取本地缓存信息 | `params?` | `Promise<GetStorageInfoResult>` | - | [详情](open-api/02-storage.md#getstorageinfo) |
46
- | `getStorageInfoSync` | `getStorageInfoSync(params?): GetStorageInfoResult` | 同步获取本地缓存信息 | `params?` | `GetStorageInfoResult` | 同步 API | [详情](open-api/02-storage.md#getstorageinfosync) |
47
-
48
- ## Router
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
- | `close` | `close(params?): Promise<object>` | 关闭栈顶页面 | `params?: CloseParams` | `Promise<object>` | 已废弃,使用 navigateBack | [详情](open-api/03-router.md#close) |
55
- | `navigateTo` | `navigateTo(params): Promise<object>` | 保留当前页面,跳转到应用内的某个页面 | `params: NavigateToParams` | `Promise<object>` | - | [详情](open-api/03-router.md#navigateto) |
56
- | `redirectTo` | `redirectTo(params): Promise<object>` | 关闭当前页面,跳转到应用内的某个页面 | `params: NavigateToParams` | `Promise<object>` | - | [详情](open-api/03-router.md#redirectto) |
57
- | `reLaunch` | `reLaunch(params): Promise<object>` | 关闭所有页面并跳转到应用内页面 | `params: NavigateToParams` | `Promise<object>` | - | [详情](open-api/03-router.md#relaunch) |
58
- | `navigateBack` | `navigateBack(params?): Promise<object>` | 关闭当前页面,返回上一页面或多级页面 | `params?: NavigateBackParams` | `Promise<object>` | - | [详情](open-api/03-router.md#navigateback) |
59
- | `exitApp` | `exitApp(): Promise<object>` | 退出当前所有页面 | `-` | `Promise<object>` | 会退出当前所有页面 | [详情](open-api/03-router.md#exitapp) |
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
- ## UI / 交互
61
+ ## 界面 / 交互
62
62
 
63
63
  Toast、Loading、Modal、ActionSheet 和返回前提醒。
64
64
 
65
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 | 详情 |
66
- | --- | --- | --- | --- | --- | --- | --- |
67
- | `showModal` | `showModal(params): Promise<ShowModalResult>` | 显示模态对话框 | `params: ShowModalParams` | `Promise<ShowModalResult>` | - | [详情](open-api/04-ui-交互.md#showmodal) |
68
- | `showLoading` | `showLoading(params?): Promise<object>` | 显示 loading 提示框 | `params?: ShowLoadingParams` | `Promise<object>` | 需调用 hideLoading 关闭 | [详情](open-api/04-ui-交互.md#showloading) |
69
- | `hideToast` | `hideToast(params?): Promise<object>` | 隐藏当前 Toast | `params?: HideInteractionParams` | `Promise<object>` | - | [详情](open-api/04-ui-交互.md#hidetoast) |
70
- | `hideLoading` | `hideLoading(params?): Promise<object>` | 隐藏当前 loading | `params?: HideInteractionParams` | `Promise<object>` | - | [详情](open-api/04-ui-交互.md#hideloading) |
71
- | `showActionSheet` | `showActionSheet(params): Promise<ShowActionSheetResult>` | 显示操作菜单 | `params: ShowActionSheetParams` | `Promise<ShowActionSheetResult>` | - | [详情](open-api/04-ui-交互.md#showactionsheet) |
72
- | `getMenuButtonBoundingClientRect` | `getMenuButtonBoundingClientRect(params?): MenuButtonBoundingClientRect` | 获取菜单按钮的布局位置信息 | `params?` | `MenuButtonBoundingClientRect` | - | [详情](open-api/04-ui-交互.md#getmenubuttonboundingclientrect) |
73
- | `enableAlertBeforeUnload` | `enableAlertBeforeUnload(params): Promise<object>` | 开启页面返回前提醒 | `params: EnableAlertBeforeUnloadParams` | `Promise<object>` | 配合 disableAlertBeforeUnload 使用 | [详情](open-api/04-ui-交互.md#enablealertbeforeunload) |
74
- | `disableAlertBeforeUnload` | `disableAlertBeforeUnload(params?): Promise<object>` | 关闭页面返回前提醒 | `params?: Record<string, never>` | `Promise<object>` | - | [详情](open-api/04-ui-交互.md#disablealertbeforeunload) |
75
- | `showToast` | `showToast(params): Promise<object>` | 显示 Toast 提示 | `params: ShowToastParams` | `Promise<object>` | duration 和 icon 可控制提示表现 | [详情](open-api/04-ui-交互.md#showtoast) |
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
- ## UI / 输入
77
+ ## 界面 / 输入
78
78
 
79
79
  键盘和输入框选区能力。
80
80
 
81
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 | 详情 |
82
- | --- | --- | --- | --- | --- | --- | --- |
83
- | `onKeyboardHeightChange` | `onKeyboardHeightChange(handler): () => void` | 监听键盘高度变化事件 | `handler` | `() => void` | 返回取消监听函数 | [详情](open-api/05-ui-输入.md#onkeyboardheightchange) |
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
- ## Network
85
+ ## 网络
88
86
 
89
- 网络请求、网络类型和本机局域网 IP。
87
+ 网络请求
90
88
 
91
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 | 详情 |
92
- | --- | --- | --- | --- | --- | --- | --- |
93
- | `request` | `request(params): Promise<RequestResponse>` | 发起网络请求 | `params: RequestParams` | `Promise<RequestResponse>` | 返回 statusCode、header 和 data | [详情](open-api/06-network.md#request) |
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
- ## Media
93
+ ## 媒体
99
94
 
100
95
  图片选择、预览、保存、压缩和信息读取。
101
96
 
102
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 | 详情 |
103
- | --- | --- | --- | --- | --- | --- | --- |
104
- | `saveImageToPhotosAlbum` | `saveImageToPhotosAlbum(params): Promise<object>` | 保存图片到系统相册 | `params: SaveImageToPhotosAlbumParams` | `Promise<object>` | - | [详情](open-api/07-media.md#saveimagetophotosalbum) |
105
- | `previewImage` | `previewImage(params): Promise<object>` | 预览图片 | `params: PreviewImageParams` | `Promise<object>` | - | [详情](open-api/07-media.md#previewimage) |
106
- | `getImageInfo` | `getImageInfo(params): Promise<GetImageInfoResult>` | 获取图片信息 | `params: GetImageInfoParams` | `Promise<GetImageInfoResult>` | - | [详情](open-api/07-media.md#getimageinfo) |
107
- | `chooseImage` | `chooseImage(params?): Promise<ChooseImageResult>` | 选择图片 | `params?: ChooseImageParams` | `Promise<ChooseImageResult>` | - | [详情](open-api/07-media.md#chooseimage) |
108
- | `compressImage` | `compressImage(params): Promise<CompressImageResult>` | 压缩图片 | `params: CompressImageParams` | `Promise<CompressImageResult>` | - | [详情](open-api/07-media.md#compressimage) |
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
- ## Open / 业务能力
105
+ ## 开放能力 / 业务能力
111
106
 
112
107
  开放业务能力、支付、隐私设置、上下文和外部应用打开。
113
108
 
114
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 | 详情 |
115
- | --- | --- | --- | --- | --- | --- | --- |
116
- | `getOrderPayment` | `getOrderPayment(params): Promise<GetOrderPaymentResult>` | 查询订单支付结果 | `params: GetOrderPaymentParams` | `Promise<GetOrderPaymentResult>` | - | [详情](open-api/08-open-业务能力.md#getorderpayment) |
117
- | `postLoginResult` | `postLoginResult(params): Promise<object>` | 回传 MCP 授权登录凭证 | `params: PostLoginResultRequest` | `Promise<object>` | - | [详情](open-api/08-open-业务能力.md#postloginresult) |
118
- | `getPrivacySetting` | `getPrivacySetting(params?): Promise<PrivacySettingResult>` | 获取隐私设置状态 | `params?` | `Promise<PrivacySettingResult>` | - | [详情](open-api/08-open-业务能力.md#getprivacysetting) |
119
- | `requestOrder` | `requestOrder(params): Promise<RequestOrderResult>` | 发起订单支付流程 | `params: RequestOrderParams` | `Promise<RequestOrderResult>` | - | [详情](open-api/08-open-业务能力.md#requestorder) |
120
- | `loginWithDoubaoWidget` | `loginWithDoubaoWidget(params): Promise<LoginWithWidgetResult>` | 发起豆包 Widget 登录 | `params: LoginWithWidgetRequest` | `Promise<LoginWithWidgetResult>` | - | [详情](open-api/08-open-业务能力.md#loginwithdoubaowidget) |
121
- | `sendQueryMessage` | `sendQueryMessage(params): void` | 以用户身份发送一条消息 | `params: SendQueryMessageParams` | `void` | 返回 void,不是 Promise | [详情](open-api/08-open-业务能力.md#sendquerymessage) |
122
- | `updateModelContext` | `updateModelContext(params?): Promise<object>` | 向 Agent 捐赠上下文 | `params?: UpdateModelContextParams` | `Promise<object>` | - | [详情](open-api/08-open-业务能力.md#updatemodelcontext) |
123
- | `setAdditionalContext` | `setAdditionalContext(params): Promise<object>` | 设置全局上下文供大模型理解 | `params: SetAdditionalContextParams` | `Promise<object>` | 设置全局上下文 | [详情](open-api/08-open-业务能力.md#setadditionalcontext) |
124
- | `dispatchActionDirective` | `dispatchActionDirective(params): Promise<object>` | 描述用户行为,约束模型行为及指定执行路径 | `params: DispatchActionDirectiveParams` | `Promise<object>` | - | [详情](open-api/08-open-业务能力.md#dispatchactiondirective) |
125
- | `updateWidget` | `updateWidget(params): Promise<object>` | 更新指定卡片 | `params: UpdateWidgetParams` | `Promise<object>` | - | [详情](open-api/08-open-业务能力.md#updatewidget) |
126
- | `openApp` | `openApp(params): Promise<OpenAppResult>` | 通过 deep link 等方式打开外部应用 | `params: OpenAppRequest` | `Promise<OpenAppResult>` | - | [详情](open-api/08-open-业务能力.md#openapp) |
127
-
128
- ## Device / Bluetooth
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
- | `openBluetoothAdapter` | `openBluetoothAdapter(params?): Promise<object>` | 打开蓝牙适配器 | `params?: OpenBluetoothAdapterParams` | `Promise<object>` | 蓝牙流程入口 | [详情](open-api/09-device-bluetooth.md#openbluetoothadapter) |
135
- | `startBluetoothDevicesDiscovery` | `startBluetoothDevicesDiscovery(params?): Promise<object>` | 开始搜索附近的蓝牙设备 | `params?: StartBluetoothDevicesDiscoveryParams` | `Promise<object>` | 通常先调用 openBluetoothAdapter | [详情](open-api/09-device-bluetooth.md#startbluetoothdevicesdiscovery) |
136
- | `stopBluetoothDevicesDiscovery` | `stopBluetoothDevicesDiscovery(params?): Promise<object>` | 停止搜索附近的蓝牙设备 | `params?` | `Promise<object>` | - | [详情](open-api/09-device-bluetooth.md#stopbluetoothdevicesdiscovery) |
137
- | `getBluetoothAdapterState` | `getBluetoothAdapterState(params?): Promise<GetBluetoothAdapterStateResult>` | 获取蓝牙适配器状态 | `params?` | `Promise<GetBluetoothAdapterStateResult>` | - | [详情](open-api/09-device-bluetooth.md#getbluetoothadapterstate) |
138
- | `getBluetoothDevices` | `getBluetoothDevices(params?): Promise<GetBluetoothDevicesResult>` | 获取当前蓝牙模块发现的设备列表 | `params?` | `Promise<GetBluetoothDevicesResult>` | 通常先调用 startBluetoothDevicesDiscovery | [详情](open-api/09-device-bluetooth.md#getbluetoothdevices) |
139
- | `getConnectedBluetoothDevices` | `getConnectedBluetoothDevices(params): Promise<GetConnectedBluetoothDevicesResult>` | 获取已连接的蓝牙设备列表 | `params: GetConnectedBluetoothDevicesParams` | `Promise<GetConnectedBluetoothDevicesResult>` | - | [详情](open-api/09-device-bluetooth.md#getconnectedbluetoothdevices) |
140
- | `makeBluetoothPair` | `makeBluetoothPair(params): Promise<object>` | 发起蓝牙配对 | `params: MakeBluetoothPairParams` | `Promise<object>` | - | [详情](open-api/09-device-bluetooth.md#makebluetoothpair) |
141
- | `isBluetoothDevicePaired` | `isBluetoothDevicePaired(params): Promise<object>` | 查询蓝牙设备是否已经配对 | `params: IsBluetoothDevicePairedParams` | `Promise<object>` | - | [详情](open-api/09-device-bluetooth.md#isbluetoothdevicepaired) |
142
- | `closeBluetoothAdapter` | `closeBluetoothAdapter(params?): Promise<object>` | 关闭蓝牙适配器 | `params?` | `Promise<object>` | 会关闭蓝牙模块 | [详情](open-api/09-device-bluetooth.md#closebluetoothadapter) |
143
- | `createBLEConnection` | `createBLEConnection(params): Promise<object>` | 创建 BLE 连接 | `params: CreateBLEConnectionParams` | `Promise<object>` | 需要传入 deviceId | [详情](open-api/09-device-bluetooth.md#createbleconnection) |
144
- | `closeBLEConnection` | `closeBLEConnection(params): Promise<object>` | 关闭 BLE 连接 | `params: CloseBLEConnectionParams` | `Promise<object>` | - | [详情](open-api/09-device-bluetooth.md#closebleconnection) |
145
- | `getBLEDeviceServices` | `getBLEDeviceServices(params): Promise<GetBLEDeviceServicesResult>` | 获取 BLE 服务列表 | `params: GetBLEDeviceServicesParams` | `Promise<GetBLEDeviceServicesResult>` | 通常先调用 createBLEConnection | [详情](open-api/09-device-bluetooth.md#getbledeviceservices) |
146
- | `getBLEDeviceCharacteristics` | `getBLEDeviceCharacteristics(params): Promise<GetBLEDeviceCharacteristicsResult>` | 获取 BLE 特征值列表 | `params: GetBLEDeviceCharacteristicsParams` | `Promise<GetBLEDeviceCharacteristicsResult>` | 通常先获取 BLE 服务列表 | [详情](open-api/09-device-bluetooth.md#getbledevicecharacteristics) |
147
- | `getBLEDeviceRSSI` | `getBLEDeviceRSSI(params): Promise<GetBLEDeviceRSSIResult>` | 获取 BLE 设备 RSSI | `params: GetBLEDeviceRSSIParams` | `Promise<GetBLEDeviceRSSIResult>` | - | [详情](open-api/09-device-bluetooth.md#getbledevicerssi) |
148
- | `getBLEMTU` | `getBLEMTU(params): Promise<GetBLEMTUResult>` | 获取 BLE MTU | `params: GetBLEMTUParams` | `Promise<GetBLEMTUResult>` | - | [详情](open-api/09-device-bluetooth.md#getblemtu) |
149
- | `notifyBLECharacteristicValueChange` | `notifyBLECharacteristicValueChange(params): Promise<object>` | 订阅 BLE 特征值变化 | `params: NotifyBLECharacteristicValueChangeParams` | `Promise<object>` | 订阅指定特征值变化 | [详情](open-api/09-device-bluetooth.md#notifyblecharacteristicvaluechange) |
150
- | `readBLECharacteristicValue` | `readBLECharacteristicValue(params): Promise<object>` | 读取 BLE 特征值 | `params: ReadBLECharacteristicValueParams` | `Promise<object>` | 需要传入 serviceId 和 characteristicId | [详情](open-api/09-device-bluetooth.md#readblecharacteristicvalue) |
151
- | `setBLEMTU` | `setBLEMTU(params): Promise<SetBLEMTUResult>` | 设置 BLE MTU | `params: SetBLEMTUParams` | `Promise<SetBLEMTUResult>` | - | [详情](open-api/09-device-bluetooth.md#setblemtu) |
152
- | `writeBLECharacteristicValue` | `writeBLECharacteristicValue(params): Promise<object>` | 写入 BLE 特征值 | `params: WriteBLECharacteristicValueParams` | `Promise<object>` | value 需要是 ArrayBuffer。 ## Enumerations ### ActionDirectiveType | [详情](open-api/09-device-bluetooth.md#writeblecharacteristicvalue) |
153
-
154
- ## Device / Wi-Fi
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
- | `startWifi` | `startWifi(params?): Promise<object>` | 初始化 Wi-Fi 模块 | `params?` | `Promise<object>` | Wi-Fi 流程入口 | [详情](open-api/10-device-wi-fi.md#startwifi) |
161
- | `stopWifi` | `stopWifi(params?): Promise<object>` | 关闭 Wi-Fi 模块 | `params?` | `Promise<object>` | - | [详情](open-api/10-device-wi-fi.md#stopwifi) |
162
- | `setWifiList` | `setWifiList(params): Promise<object>` | 设置 Wi-Fi 预设列表 | `params: SetWifiListParams` | `Promise<object>` | 用于预设 Wi-Fi 列表 | [详情](open-api/10-device-wi-fi.md#setwifilist) |
163
- | `connectWifi` | `connectWifi(params): Promise<object>` | 连接指定 Wi-Fi | `params: ConnectWifiParams` | `Promise<object>` | 通常先调用 startWifi | [详情](open-api/10-device-wi-fi.md#connectwifi) |
164
- | `getConnectedWifi` | `getConnectedWifi(params?): Promise<GetConnectedWifiResult>` | 获取当前已连接 Wi-Fi 信息 | `params?: GetConnectedWifiParams` | `Promise<GetConnectedWifiResult>` | - | [详情](open-api/10-device-wi-fi.md#getconnectedwifi) |
165
- | `getWifiList` | `getWifiList(params?): Promise<GetWifiListResult>` | 获取 Wi-Fi 列表 | `params?` | `Promise<GetWifiListResult>` | 通常先调用 startWifi | [详情](open-api/10-device-wi-fi.md#getwifilist) |
166
-
167
- ## Device / 传感器
168
-
169
- 加速度、罗盘、陀螺仪、设备方向和 iBeacon。
170
-
171
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 | 详情 |
172
- | --- | --- | --- | --- | --- | --- | --- |
173
- | `startAccelerometer` | `startAccelerometer(params?): Promise<object>` | 开始监听加速度 | `params?: StartAccelerometerParams` | `Promise<object>` | 需配对调用 stopAccelerometer | [详情](open-api/11-device-传感器.md#startaccelerometer) |
174
- | `stopAccelerometer` | `stopAccelerometer(params?): Promise<object>` | 停止监听加速度 | `params?` | `Promise<object>` | - | [详情](open-api/11-device-传感器.md#stopaccelerometer) |
175
- | `startBeaconDiscovery` | `startBeaconDiscovery(params): Promise<object>` | 开始搜索附近的 iBeacon | `params: StartBeaconDiscoveryParams` | `Promise<object>` | 需配对调用 stopBeaconDiscovery | [详情](open-api/11-device-传感器.md#startbeacondiscovery) |
176
- | `stopBeaconDiscovery` | `stopBeaconDiscovery(params?): Promise<object>` | 停止搜索附近的 iBeacon | `params?` | `Promise<object>` | - | [详情](open-api/11-device-传感器.md#stopbeacondiscovery) |
177
- | `getBeacons` | `getBeacons(params?): Promise<GetBeaconsResult>` | 获取已搜索到的 iBeacon 列表 | `params?` | `Promise<GetBeaconsResult>` | - | [详情](open-api/11-device-传感器.md#getbeacons) |
178
- | `startCompass` | `startCompass(params?): Promise<object>` | 开始监听罗盘 | `params?` | `Promise<object>` | 需配对调用 stopCompass | [详情](open-api/11-device-传感器.md#startcompass) |
179
- | `stopCompass` | `stopCompass(params?): Promise<object>` | 停止监听罗盘 | `params?` | `Promise<object>` | - | [详情](open-api/11-device-传感器.md#stopcompass) |
180
- | `onCompassChange` | `onCompassChange(handler): () => void` | 监听罗盘数据变化事件 | `handler` | `() => void` | 返回取消监听函数 | [详情](open-api/11-device-传感器.md#oncompasschange) |
181
- | `startDeviceMotionListening` | `startDeviceMotionListening(params?): Promise<object>` | 开始监听设备方向变化 | `params?: StartDeviceMotionListeningParams` | `Promise<object>` | 需配对调用 stopDeviceMotionListening | [详情](open-api/11-device-传感器.md#startdevicemotionlistening) |
182
- | `stopDeviceMotionListening` | `stopDeviceMotionListening(params?): Promise<object>` | 停止监听设备方向变化 | `params?` | `Promise<object>` | - | [详情](open-api/11-device-传感器.md#stopdevicemotionlistening) |
183
- | `startGyroscope` | `startGyroscope(params?): Promise<object>` | 开始监听陀螺仪 | `params?: StartGyroscopeParams` | `Promise<object>` | 需配对调用 stopGyroscope | [详情](open-api/11-device-传感器.md#startgyroscope) |
184
- | `stopGyroscope` | `stopGyroscope(params?): Promise<object>` | 停止监听陀螺仪 | `params?` | `Promise<object>` | - | [详情](open-api/11-device-传感器.md#stopgyroscope) |
185
-
186
- ## Device / 本地能力
187
-
188
- 剪贴板、电话、联系人、日历、扫码、屏幕、震动等系统能力。
189
-
190
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 | 详情 |
191
- | --- | --- | --- | --- | --- | --- | --- |
192
- | `sendSms` | `sendSms(params?): Promise<object>` | 拉起系统短信发送面板 | `params?: SendSmsParams` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#sendsms) |
193
- | `checkIsOpenAccessibility` | `checkIsOpenAccessibility(params?): Promise<CheckIsOpenAccessibilityResult>` | 检测无障碍能力是否开启 | `params?` | `Promise<CheckIsOpenAccessibilityResult>` | - | [详情](open-api/12-device-本地能力.md#checkisopenaccessibility) |
194
- | `getBatteryInfo` | `getBatteryInfo(params?): Promise<GetBatteryInfoResult>` | 获取电池信息 | `params?` | `Promise<GetBatteryInfoResult>` | - | [详情](open-api/12-device-本地能力.md#getbatteryinfo) |
195
- | `addPhoneCalendar` | `addPhoneCalendar(params): Promise<object>` | 向系统日历添加事件 | `params: AddPhoneCalendarParams` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#addphonecalendar) |
196
- | `addPhoneRepeatCalendar` | `addPhoneRepeatCalendar(params): Promise<object>` | 向系统日历添加重复事件 | `params: AddPhoneRepeatCalendarParams` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#addphonerepeatcalendar) |
197
- | `getClipboardData` | `getClipboardData(params?): Promise<GetClipboardDataResult>` | 获取剪贴板内容 | `params?` | `Promise<GetClipboardDataResult>` | - | [详情](open-api/12-device-本地能力.md#getclipboarddata) |
198
- | `setClipboardData` | `setClipboardData(params): Promise<object>` | 设置系统剪贴板内容 | `params: SetClipboardDataParams` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#setclipboarddata) |
199
- | `chooseContact` | `chooseContact(params?): Promise<ChooseContactResult>` | 选择手机联系人 | `params?` | `Promise<ChooseContactResult>` | - | [详情](open-api/12-device-本地能力.md#choosecontact) |
200
- | `addPhoneContact` | `addPhoneContact(params): Promise<object>` | 添加手机联系人 | `params: AddPhoneContactParams` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#addphonecontact) |
201
- | `getRandomValues` | `getRandomValues(params): Promise<GetRandomValuesResult>` | 获取安全随机数 | `params: GetRandomValuesParams` | `Promise<GetRandomValuesResult>` | - | [详情](open-api/12-device-本地能力.md#getrandomvalues) |
202
- | `makePhoneCall` | `makePhoneCall(params): Promise<object>` | 拨打电话 | `params: MakePhoneCallParams` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#makephonecall) |
203
- | `scanCode` | `scanCode(params?): Promise<ScanCodeResult>` | 调起扫码能力 | `params?: ScanCodeParams` | `Promise<ScanCodeResult>` | - | [详情](open-api/12-device-本地能力.md#scancode) |
204
- | `getScreenBrightness` | `getScreenBrightness(params?): Promise<GetScreenBrightnessResult>` | 获取屏幕亮度 | `params?` | `Promise<GetScreenBrightnessResult>` | - | [详情](open-api/12-device-本地能力.md#getscreenbrightness) |
205
- | `setVisualEffectOnCapture` | `setVisualEffectOnCapture(params?): Promise<object>` | 设置截屏或录屏时的视觉表现 | `params?: SetVisualEffectOnCaptureParams` | `Promise<object>` | 控制截屏或录屏时的视觉效果 | [详情](open-api/12-device-本地能力.md#setvisualeffectoncapture) |
206
- | `setScreenBrightness` | `setScreenBrightness(params): Promise<object>` | 设置屏幕亮度 | `params: SetScreenBrightnessParams` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#setscreenbrightness) |
207
- | `setKeepScreenOn` | `setKeepScreenOn(params): Promise<object>` | 设置屏幕常亮状态 | `params: SetKeepScreenOnParams` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#setkeepscreenon) |
208
- | `onUserCaptureScreen` | `onUserCaptureScreen(handler): () => void` | 监听用户主动截屏事件 | `handler` | `() => void` | 返回取消监听函数 | [详情](open-api/12-device-本地能力.md#onusercapturescreen) |
209
- | `vibrateShort` | `vibrateShort(params?): Promise<object>` | 触发短震动 | `params?: VibrateShortParams` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#vibrateshort) |
210
- | `vibrateLong` | `vibrateLong(params?): Promise<object>` | 触发长震动 | `params?` | `Promise<object>` | - | [详情](open-api/12-device-本地能力.md#vibratelong) |
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) | 触发长震动。 |