@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,4 +1,4 @@
1
- # Open API: Storage
1
+ # Open API: 存储
2
2
 
3
3
  本地缓存;带 Sync 后缀的是同步 API。
4
4
 
@@ -6,18 +6,18 @@
6
6
 
7
7
  ## 速查
8
8
 
9
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
10
- | --- | --- | --- | --- | --- | --- |
11
- | [`setStorage`](#setstorage) | `setStorage<TData>(params): Promise<object>` | 将数据写入本地缓存 | `params: SetStorageParams<TData>` | `Promise<object>` | data 会 JSON 序列化 |
12
- | [`setStorageSync`](#setstoragesync) | `setStorageSync<TData>(params): object` | 将数据写入本地缓存 | `params: SetStorageParams<TData>` | `object` | data 会 JSON 序列化;同步 API |
13
- | [`getStorage`](#getstorage) | `getStorage<TData>(params): Promise<GetStorageResult<TData>>` | 从本地缓存读取数据 | `params: GetStorageParams` | `Promise<GetStorageResult<TData>>` | data 会 JSON 反序列化 |
14
- | [`getStorageSync`](#getstoragesync) | `getStorageSync<TData>(params): GetStorageResult<TData>` | 从本地缓存同步读取数据 | `params: GetStorageParams` | `GetStorageResult<TData>` | data 会 JSON 反序列化;同步 API |
15
- | [`removeStorage`](#removestorage) | `removeStorage(params): Promise<object>` | 删除本地缓存中指定 key 的数据 | `params: RemoveStorageParams` | `Promise<object>` | - |
16
- | [`removeStorageSync`](#removestoragesync) | `removeStorageSync(params?): object` | 删除本地缓存中指定 key 的数据 | `params?: RemoveStorageParams` | `object` | 同步 API |
17
- | [`clearStorage`](#clearstorage) | `clearStorage(params?): Promise<object>` | 清空本地缓存 | `params?: object` | `Promise<object>` | - |
18
- | [`clearStorageSync`](#clearstoragesync) | `clearStorageSync(params?): object` | 清空本地缓存 | `params?: object` | `object` | 同步 API |
19
- | [`getStorageInfo`](#getstorageinfo) | `getStorageInfo(params?): Promise<GetStorageInfoResult>` | 获取本地缓存信息 | `params?` | `Promise<GetStorageInfoResult>` | - |
20
- | [`getStorageInfoSync`](#getstorageinfosync) | `getStorageInfoSync(params?): GetStorageInfoResult` | 同步获取本地缓存信息 | `params?` | `GetStorageInfoResult` | 同步 API |
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [setStorage](#setstorage) | 将数据写入本地缓存。 |
12
+ | [setStorageSync](#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API |
13
+ | [getStorage](#getstorage) | 从本地缓存读取数据。 |
14
+ | [getStorageSync](#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API |
15
+ | [removeStorage](#removestorage) | 删除本地缓存中指定 key 的数据。 |
16
+ | [removeStorageSync](#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API |
17
+ | [clearStorage](#clearstorage) | 清空本地缓存。 |
18
+ | [clearStorageSync](#clearstoragesync) | 清空本地缓存。<br><br>同步 API |
19
+ | [getStorageInfo](#getstorageinfo) | 获取本地缓存信息。 |
20
+ | [getStorageInfoSync](#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API |
21
21
 
22
22
  ## API 详情
23
23
 
@@ -46,8 +46,6 @@
46
46
 
47
47
  #### Remarks
48
48
 
49
- data 会 JSON 序列化。
50
-
51
49
  #### Example
52
50
 
53
51
  ```typescript
@@ -84,8 +82,6 @@ await setStorage({
84
82
 
85
83
  #### Remarks
86
84
 
87
- data 会 JSON 序列化。
88
-
89
85
  #### Example
90
86
 
91
87
  ```typescript
@@ -122,8 +118,6 @@ setStorageSync({
122
118
 
123
119
  #### Remarks
124
120
 
125
- data 会 JSON 反序列化。
126
-
127
121
  #### Example
128
122
 
129
123
  ```typescript
@@ -161,8 +155,6 @@ console.log(result.data.name, result.data.age);
161
155
 
162
156
  #### Remarks
163
157
 
164
- data 会 JSON 反序列化。
165
-
166
158
  #### Example
167
159
 
168
160
  ```typescript
@@ -1,4 +1,4 @@
1
- # Open API: Router
1
+ # Open API: 路由
2
2
 
3
3
  应用内页面跳转和关闭。
4
4
 
@@ -6,14 +6,14 @@
6
6
 
7
7
  ## 速查
8
8
 
9
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
10
- | --- | --- | --- | --- | --- | --- |
11
- | [`close`](#close) | `close(params?): Promise<object>` | 关闭栈顶页面 | `params?: CloseParams` | `Promise<object>` | 已废弃,使用 navigateBack |
12
- | [`navigateTo`](#navigateto) | `navigateTo(params): Promise<object>` | 保留当前页面,跳转到应用内的某个页面 | `params: NavigateToParams` | `Promise<object>` | - |
13
- | [`redirectTo`](#redirectto) | `redirectTo(params): Promise<object>` | 关闭当前页面,跳转到应用内的某个页面 | `params: NavigateToParams` | `Promise<object>` | - |
14
- | [`reLaunch`](#relaunch) | `reLaunch(params): Promise<object>` | 关闭所有页面并跳转到应用内页面 | `params: NavigateToParams` | `Promise<object>` | - |
15
- | [`navigateBack`](#navigateback) | `navigateBack(params?): Promise<object>` | 关闭当前页面,返回上一页面或多级页面 | `params?: NavigateBackParams` | `Promise<object>` | - |
16
- | [`exitApp`](#exitapp) | `exitApp(): Promise<object>` | 退出当前所有页面 | `-` | `Promise<object>` | 会退出当前所有页面 |
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [close](#close) | 关闭栈顶页面。<br><br>已废弃,使用 navigateBack |
12
+ | [navigateTo](#navigateto) | 保留当前页面,跳转到应用内的某个页面。 |
13
+ | [redirectTo](#redirectto) | 关闭当前页面,跳转到应用内的某个页面。 |
14
+ | [reLaunch](#relaunch) | 关闭所有页面并跳转到应用内页面。 |
15
+ | [navigateBack](#navigateback) | 关闭当前页面,返回上一页面或多级页面。 |
16
+ | [exitApp](#exitapp) | 退出当前所有页面。<br><br>会退出当前所有页面。 |
17
17
 
18
18
  ## API 详情
19
19
 
@@ -1,4 +1,4 @@
1
- # Open API: UI / 交互
1
+ # Open API: 界面 / 交互
2
2
 
3
3
  Toast、Loading、Modal、ActionSheet 和返回前提醒。
4
4
 
@@ -6,17 +6,17 @@ Toast、Loading、Modal、ActionSheet 和返回前提醒。
6
6
 
7
7
  ## 速查
8
8
 
9
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
10
- | --- | --- | --- | --- | --- | --- |
11
- | [`showModal`](#showmodal) | `showModal(params): Promise<ShowModalResult>` | 显示模态对话框 | `params: ShowModalParams` | `Promise<ShowModalResult>` | - |
12
- | [`showLoading`](#showloading) | `showLoading(params?): Promise<object>` | 显示 loading 提示框 | `params?: ShowLoadingParams` | `Promise<object>` | 需调用 hideLoading 关闭 |
13
- | [`hideToast`](#hidetoast) | `hideToast(params?): Promise<object>` | 隐藏当前 Toast | `params?: HideInteractionParams` | `Promise<object>` | - |
14
- | [`hideLoading`](#hideloading) | `hideLoading(params?): Promise<object>` | 隐藏当前 loading | `params?: HideInteractionParams` | `Promise<object>` | - |
15
- | [`showActionSheet`](#showactionsheet) | `showActionSheet(params): Promise<ShowActionSheetResult>` | 显示操作菜单 | `params: ShowActionSheetParams` | `Promise<ShowActionSheetResult>` | - |
16
- | [`getMenuButtonBoundingClientRect`](#getmenubuttonboundingclientrect) | `getMenuButtonBoundingClientRect(params?): MenuButtonBoundingClientRect` | 获取菜单按钮的布局位置信息 | `params?` | `MenuButtonBoundingClientRect` | - |
17
- | [`enableAlertBeforeUnload`](#enablealertbeforeunload) | `enableAlertBeforeUnload(params): Promise<object>` | 开启页面返回前提醒 | `params: EnableAlertBeforeUnloadParams` | `Promise<object>` | 配合 disableAlertBeforeUnload 使用 |
18
- | [`disableAlertBeforeUnload`](#disablealertbeforeunload) | `disableAlertBeforeUnload(params?): Promise<object>` | 关闭页面返回前提醒 | `params?: Record<string, never>` | `Promise<object>` | - |
19
- | [`showToast`](#showtoast) | `showToast(params): Promise<object>` | 显示 Toast 提示 | `params: ShowToastParams` | `Promise<object>` | duration 和 icon 可控制提示表现 |
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [showModal](#showmodal) | 显示模态对话框。 |
12
+ | [showLoading](#showloading) | 显示 loading 提示框。<br><br>需调用 hideLoading 关闭。 |
13
+ | [hideToast](#hidetoast) | 隐藏当前 Toast |
14
+ | [hideLoading](#hideloading) | 隐藏当前 loading |
15
+ | [showActionSheet](#showactionsheet) | 显示操作菜单。 |
16
+ | [getMenuButtonBoundingClientRect](#getmenubuttonboundingclientrect) | 获取菜单按钮的布局位置信息。 |
17
+ | [enableAlertBeforeUnload](#enablealertbeforeunload) | 开启页面返回前提醒。<br><br>配合 disableAlertBeforeUnload 使用。 |
18
+ | [disableAlertBeforeUnload](#disablealertbeforeunload) | 关闭页面返回前提醒。 |
19
+ | [showToast](#showtoast) | 显示 Toast 提示。<br><br>duration 和 icon 可控制提示表现。 |
20
20
 
21
21
  ## API 详情
22
22
 
@@ -0,0 +1,42 @@
1
+ # Open API: 界面 / 输入
2
+
3
+ 键盘和输入框选区能力。
4
+
5
+ [返回目录](./README.md) | [返回速查](../open-api.md)
6
+
7
+ ## 速查
8
+
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [onKeyboardHeightChange](#onkeyboardheightchange) | 监听键盘高度变化事件。<br><br>返回取消监听函数。 |
12
+
13
+ ## API 详情
14
+
15
+ <a id="onkeyboardheightchange"></a>
16
+ ### onKeyboardHeightChange()
17
+
18
+ > **onKeyboardHeightChange**(`handler`): () => `void`
19
+
20
+ 监听键盘高度变化事件。
21
+
22
+ #### Parameters
23
+
24
+ • **handler**
25
+
26
+ #### Returns
27
+
28
+ `Function`
29
+
30
+ ##### Returns
31
+
32
+ `void`
33
+
34
+ #### Example
35
+
36
+ ```typescript
37
+ import { onKeyboardHeightChange } from '@doubao-apps/framework/api';
38
+
39
+ const unsubscribe = onKeyboardHeightChange(({ height }) => {
40
+ console.log('Keyboard height change event:', { height });
41
+ });
42
+ ```
@@ -0,0 +1,148 @@
1
+ # Open API: 网络
2
+
3
+ 网络请求
4
+
5
+ [返回目录](./README.md) | [返回速查](../open-api.md)
6
+
7
+ ## 速查
8
+
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [request](#request) | 发起网络请求。<br><br>返回 statusCode、header 和 data。 |
12
+
13
+ ## API 详情
14
+
15
+ <a id="request"></a>
16
+ ### request()
17
+
18
+ > **request**(`params`): `Promise`\<[`RequestResponse`](#requestresponse)\>
19
+
20
+ 发起网络请求。
21
+
22
+ #### Parameters
23
+
24
+ • **params**: [`RequestParams`](#requestparams)
25
+
26
+ 请求参数,字段见 [RequestParams](#requestparams)。
27
+
28
+ #### Returns
29
+
30
+ `Promise`\<[`RequestResponse`](#requestresponse)\>
31
+
32
+ 返回一个 Promise,解析为 [RequestResponse](#requestresponse)。
33
+
34
+ #### Remarks
35
+
36
+ 返回 statusCode、header 和 data。
37
+
38
+ #### Example
39
+
40
+ ```typescript
41
+ import { request } from '@doubao-apps/framework/api';
42
+
43
+ const result = await request({
44
+ url: 'https://postman-echo.com/post',
45
+ method: 'POST',
46
+ dataType: 'json',
47
+ header: { 'content-type': 'application/json' },
48
+ data: { hello: 'world' }
49
+ });
50
+
51
+ console.log(result.statusCode, result.data);
52
+ ```
53
+
54
+ ## 相关类型
55
+
56
+ <a id="requestparams"></a>
57
+ ### RequestParams
58
+
59
+ 网络请求参数。
60
+
61
+ #### Properties
62
+
63
+ ##### data?
64
+
65
+ > `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
66
+
67
+ 请求体数据。
68
+
69
+ 传给服务器的数据最终会是 `String` 或 `ArrayBuffer`:
70
+ - 若 `data` 是 `string` 或 `ArrayBuffer`,直接使用;
71
+ - 若 `header['content-type']` 是 `application/x-www-form-urlencoded`,会被编码为 query string,例如:`encodeURIComponent(k)=encodeURIComponent(v)`;
72
+ - 若 `header['content-type']` 是 `application/json`,会执行 JSON 序列化;
73
+ - 若 `data` 是普通对象且未命中上述类型,也会执行 JSON 序列化;
74
+ - 其他类型会调用 `toString()`
75
+
76
+ ##### dataType?
77
+
78
+ > `optional` **dataType**: `"string"` \| `"json"`
79
+
80
+ 期望返回的数据格式。
81
+ - `json`: 尝试按 JSON 解析;
82
+ - `string`: 按字符串返回。
83
+
84
+ ###### Default
85
+
86
+ ```ts
87
+ "json"
88
+ ```
89
+
90
+ ##### header?
91
+
92
+ > `optional` **header**: `Record`\<`string`, `string`\>
93
+
94
+ 请求 Header。
95
+
96
+ ###### Default
97
+
98
+ ```ts
99
+ {"content-type": "application/json"}
100
+ ```
101
+
102
+ ##### method?
103
+
104
+ > `optional` **method**: [`RequestMethod`](#requestmethod)
105
+
106
+ 请求方法。
107
+
108
+ ###### Default
109
+
110
+ ```ts
111
+ "GET"
112
+ ```
113
+
114
+ ##### url
115
+
116
+ > **url**: `string`
117
+
118
+ 请求地址,需为完整的 **HTTPS** URL。
119
+
120
+ <a id="requestresponse"></a>
121
+ ### RequestResponse
122
+
123
+ 网络请求返回结果。
124
+
125
+ #### Properties
126
+
127
+ ##### data?
128
+
129
+ > `optional` **data**: `string` \| `Record`\<`string`, `any`\> \| `ArrayBuffer`
130
+
131
+ 响应数据,类型由 `dataType` 决定。
132
+
133
+ ##### header
134
+
135
+ > **header**: `Record`\<`string`, `string`\>
136
+
137
+ HTTP 响应头。
138
+
139
+ ##### statusCode
140
+
141
+ > **statusCode**: `number`
142
+
143
+ HTTP 状态码。
144
+
145
+ <a id="requestmethod"></a>
146
+ ### RequestMethod
147
+
148
+ > **RequestMethod**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"HEAD"` \| `"OPTIONS"` \| `"TRACE"` \| `"CONNECT"`
@@ -1,4 +1,4 @@
1
- # Open API: Media
1
+ # Open API: 媒体
2
2
 
3
3
  图片选择、预览、保存、压缩和信息读取。
4
4
 
@@ -6,13 +6,13 @@
6
6
 
7
7
  ## 速查
8
8
 
9
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
10
- | --- | --- | --- | --- | --- | --- |
11
- | [`saveImageToPhotosAlbum`](#saveimagetophotosalbum) | `saveImageToPhotosAlbum(params): Promise<object>` | 保存图片到系统相册 | `params: SaveImageToPhotosAlbumParams` | `Promise<object>` | - |
12
- | [`previewImage`](#previewimage) | `previewImage(params): Promise<object>` | 预览图片 | `params: PreviewImageParams` | `Promise<object>` | - |
13
- | [`getImageInfo`](#getimageinfo) | `getImageInfo(params): Promise<GetImageInfoResult>` | 获取图片信息 | `params: GetImageInfoParams` | `Promise<GetImageInfoResult>` | - |
14
- | [`chooseImage`](#chooseimage) | `chooseImage(params?): Promise<ChooseImageResult>` | 选择图片 | `params?: ChooseImageParams` | `Promise<ChooseImageResult>` | - |
15
- | [`compressImage`](#compressimage) | `compressImage(params): Promise<CompressImageResult>` | 压缩图片 | `params: CompressImageParams` | `Promise<CompressImageResult>` | - |
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [saveImageToPhotosAlbum](#saveimagetophotosalbum) | 保存图片到系统相册。 |
12
+ | [previewImage](#previewimage) | 预览图片。 |
13
+ | [getImageInfo](#getimageinfo) | 获取图片信息。 |
14
+ | [chooseImage](#chooseimage) | 选择图片。 |
15
+ | [compressImage](#compressimage) | 压缩图片。 |
16
16
 
17
17
  ## API 详情
18
18
 
@@ -1,4 +1,4 @@
1
- # Open API: Open / 业务能力
1
+ # Open API: 开放能力 / 业务能力
2
2
 
3
3
  开放业务能力、支付、隐私设置、上下文和外部应用打开。
4
4
 
@@ -6,19 +6,20 @@
6
6
 
7
7
  ## 速查
8
8
 
9
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
10
- | --- | --- | --- | --- | --- | --- |
11
- | [`getOrderPayment`](#getorderpayment) | `getOrderPayment(params): Promise<GetOrderPaymentResult>` | 查询订单支付结果 | `params: GetOrderPaymentParams` | `Promise<GetOrderPaymentResult>` | - |
12
- | [`postLoginResult`](#postloginresult) | `postLoginResult(params): Promise<object>` | 回传 MCP 授权登录凭证 | `params: PostLoginResultRequest` | `Promise<object>` | - |
13
- | [`getPrivacySetting`](#getprivacysetting) | `getPrivacySetting(params?): Promise<PrivacySettingResult>` | 获取隐私设置状态 | `params?` | `Promise<PrivacySettingResult>` | - |
14
- | [`requestOrder`](#requestorder) | `requestOrder(params): Promise<RequestOrderResult>` | 发起订单支付流程 | `params: RequestOrderParams` | `Promise<RequestOrderResult>` | - |
15
- | [`loginWithDoubaoWidget`](#loginwithdoubaowidget) | `loginWithDoubaoWidget(params): Promise<LoginWithWidgetResult>` | 发起豆包 Widget 登录 | `params: LoginWithWidgetRequest` | `Promise<LoginWithWidgetResult>` | - |
16
- | [`sendQueryMessage`](#sendquerymessage) | `sendQueryMessage(params): void` | 以用户身份发送一条消息 | `params: SendQueryMessageParams` | `void` | 返回 void,不是 Promise |
17
- | [`updateModelContext`](#updatemodelcontext) | `updateModelContext(params?): Promise<object>` | 向 Agent 捐赠上下文 | `params?: UpdateModelContextParams` | `Promise<object>` | - |
18
- | [`setAdditionalContext`](#setadditionalcontext) | `setAdditionalContext(params): Promise<object>` | 设置全局上下文供大模型理解 | `params: SetAdditionalContextParams` | `Promise<object>` | 设置全局上下文 |
19
- | [`dispatchActionDirective`](#dispatchactiondirective) | `dispatchActionDirective(params): Promise<object>` | 描述用户行为,约束模型行为及指定执行路径 | `params: DispatchActionDirectiveParams` | `Promise<object>` | - |
20
- | [`updateWidget`](#updatewidget) | `updateWidget(params): Promise<object>` | 更新指定卡片 | `params: UpdateWidgetParams` | `Promise<object>` | - |
21
- | [`openApp`](#openapp) | `openApp(params): Promise<OpenAppResult>` | 通过 deep link 等方式打开外部应用 | `params: OpenAppRequest` | `Promise<OpenAppResult>` | - |
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [getOrderPayment](#getorderpayment) | 查询订单支付结果。 |
12
+ | [postLoginResult](#postloginresult) | 回传 MCP 授权登录凭证。 |
13
+ | [getPrivacySetting](#getprivacysetting) | 获取隐私设置状态。 |
14
+ | [requestOrder](#requestorder) | 发起订单支付流程。 |
15
+ | [loginWithDoubaoWidget](#loginwithdoubaowidget) | 发起豆包 Widget 登录。 |
16
+ | [sendQueryMessage](#sendquerymessage) | 以用户身份发送一条消息。<br><br>返回 void,不是 Promise |
17
+ | [updateModelContext](#updatemodelcontext) | 向 Agent 捐赠上下文。 |
18
+ | [setAdditionalContext](#setadditionalcontext) | 设置全局上下文供大模型理解。<br><br>设置全局上下文。 |
19
+ | [dispatchActionDirective](#dispatchactiondirective) | 描述用户行为,约束模型行为及指定执行路径。 |
20
+ | [updateWidget](#updatewidget) | 更新指定卡片。 |
21
+ | [expiredWidget](#expiredwidget) | 更新过期的 widget 为固定卡片。 |
22
+ | [openApp](#openapp) | 通过 deep link 等方式打开外部应用。 |
22
23
 
23
24
  ## API 详情
24
25
 
@@ -202,6 +203,34 @@ await sendQueryMessage({ content: '订阅消息', type: 'text' })
202
203
 
203
204
  `Promise`\<`object`\>
204
205
 
206
+ <a id="expiredwidget"></a>
207
+ ### expiredWidget()
208
+
209
+ > **expiredWidget**(`__namedParameters`): `Promise`\<`object`\>
210
+
211
+ 更新过期的 widget 为固定卡片
212
+
213
+ #### Parameters
214
+
215
+ • **\_\_namedParameters**: [`ExpiredWidgetParams`](#expiredwidgetparams)
216
+
217
+ #### Returns
218
+
219
+ `Promise`\<`object`\>
220
+
221
+ #### Description
222
+
223
+ 用于将状态已经过期的 widget 实例转换为固定的卡片
224
+
225
+ #### Example
226
+
227
+ ```ts
228
+ expiredWidget({
229
+ widgetInstanceId: 'instance_123',
230
+ schema: '${pageId}?key=value'
231
+ });
232
+ ```
233
+
205
234
  <a id="openapp"></a>
206
235
  ### openApp()
207
236
 
@@ -414,6 +443,29 @@ Widget 登录类型。
414
443
 
415
444
  会话消息关联的卡片ID
416
445
 
446
+ <a id="actiondirectivetype"></a>
447
+ ### ActionDirectiveType
448
+
449
+ #### Enumeration Members
450
+
451
+ ##### BUTTON\_CLICK
452
+
453
+ > **BUTTON\_CLICK**: `"button_click"`
454
+
455
+ 按钮点击
456
+
457
+ ##### FORM\_SUBMIT
458
+
459
+ > **FORM\_SUBMIT**: `"form_submit"`
460
+
461
+ 表单提交(复杂的信息提交场景)
462
+
463
+ ##### OPTION\_SELECT
464
+
465
+ > **OPTION\_SELECT**: `"option_select"`
466
+
467
+ 选择(下拉列表场景)
468
+
417
469
  <a id="updatewidgetparams"></a>
418
470
  ### UpdateWidgetParams
419
471
 
@@ -437,6 +489,23 @@ Widget 登录类型。
437
489
 
438
490
  需要更新的widget 实例 ID
439
491
 
492
+ <a id="expiredwidgetparams"></a>
493
+ ### ExpiredWidgetParams
494
+
495
+ #### Properties
496
+
497
+ ##### schema?
498
+
499
+ > `optional` **schema**: `string`
500
+
501
+ 点击失效卡要跳转的页面 schema,格式与 navigateTo 的 url 相同
502
+
503
+ ##### widgetInstanceId
504
+
505
+ > **widgetInstanceId**: `string`
506
+
507
+ 卡片实例 ID,在卡片环境通过getWidgetInstanceId来获取,其他环境(比如页面)需要通过传参或通信的方式传递过去
508
+
440
509
  <a id="openapprequest"></a>
441
510
  ### OpenAppRequest
442
511
 
@@ -1,4 +1,4 @@
1
- # Open API: Device / Bluetooth
1
+ # Open API: 设备 / 蓝牙
2
2
 
3
3
  蓝牙和 BLE 能力;通常先打开适配器,再扫描、连接和读写。
4
4
 
@@ -6,27 +6,27 @@
6
6
 
7
7
  ## 速查
8
8
 
9
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
10
- | --- | --- | --- | --- | --- | --- |
11
- | [`openBluetoothAdapter`](#openbluetoothadapter) | `openBluetoothAdapter(params?): Promise<object>` | 打开蓝牙适配器 | `params?: OpenBluetoothAdapterParams` | `Promise<object>` | 蓝牙流程入口 |
12
- | [`startBluetoothDevicesDiscovery`](#startbluetoothdevicesdiscovery) | `startBluetoothDevicesDiscovery(params?): Promise<object>` | 开始搜索附近的蓝牙设备 | `params?: StartBluetoothDevicesDiscoveryParams` | `Promise<object>` | 通常先调用 openBluetoothAdapter |
13
- | [`stopBluetoothDevicesDiscovery`](#stopbluetoothdevicesdiscovery) | `stopBluetoothDevicesDiscovery(params?): Promise<object>` | 停止搜索附近的蓝牙设备 | `params?` | `Promise<object>` | - |
14
- | [`getBluetoothAdapterState`](#getbluetoothadapterstate) | `getBluetoothAdapterState(params?): Promise<GetBluetoothAdapterStateResult>` | 获取蓝牙适配器状态 | `params?` | `Promise<GetBluetoothAdapterStateResult>` | - |
15
- | [`getBluetoothDevices`](#getbluetoothdevices) | `getBluetoothDevices(params?): Promise<GetBluetoothDevicesResult>` | 获取当前蓝牙模块发现的设备列表 | `params?` | `Promise<GetBluetoothDevicesResult>` | 通常先调用 startBluetoothDevicesDiscovery |
16
- | [`getConnectedBluetoothDevices`](#getconnectedbluetoothdevices) | `getConnectedBluetoothDevices(params): Promise<GetConnectedBluetoothDevicesResult>` | 获取已连接的蓝牙设备列表 | `params: GetConnectedBluetoothDevicesParams` | `Promise<GetConnectedBluetoothDevicesResult>` | - |
17
- | [`makeBluetoothPair`](#makebluetoothpair) | `makeBluetoothPair(params): Promise<object>` | 发起蓝牙配对 | `params: MakeBluetoothPairParams` | `Promise<object>` | - |
18
- | [`isBluetoothDevicePaired`](#isbluetoothdevicepaired) | `isBluetoothDevicePaired(params): Promise<object>` | 查询蓝牙设备是否已经配对 | `params: IsBluetoothDevicePairedParams` | `Promise<object>` | - |
19
- | [`closeBluetoothAdapter`](#closebluetoothadapter) | `closeBluetoothAdapter(params?): Promise<object>` | 关闭蓝牙适配器 | `params?` | `Promise<object>` | 会关闭蓝牙模块 |
20
- | [`createBLEConnection`](#createbleconnection) | `createBLEConnection(params): Promise<object>` | 创建 BLE 连接 | `params: CreateBLEConnectionParams` | `Promise<object>` | 需要传入 deviceId |
21
- | [`closeBLEConnection`](#closebleconnection) | `closeBLEConnection(params): Promise<object>` | 关闭 BLE 连接 | `params: CloseBLEConnectionParams` | `Promise<object>` | - |
22
- | [`getBLEDeviceServices`](#getbledeviceservices) | `getBLEDeviceServices(params): Promise<GetBLEDeviceServicesResult>` | 获取 BLE 服务列表 | `params: GetBLEDeviceServicesParams` | `Promise<GetBLEDeviceServicesResult>` | 通常先调用 createBLEConnection |
23
- | [`getBLEDeviceCharacteristics`](#getbledevicecharacteristics) | `getBLEDeviceCharacteristics(params): Promise<GetBLEDeviceCharacteristicsResult>` | 获取 BLE 特征值列表 | `params: GetBLEDeviceCharacteristicsParams` | `Promise<GetBLEDeviceCharacteristicsResult>` | 通常先获取 BLE 服务列表 |
24
- | [`getBLEDeviceRSSI`](#getbledevicerssi) | `getBLEDeviceRSSI(params): Promise<GetBLEDeviceRSSIResult>` | 获取 BLE 设备 RSSI | `params: GetBLEDeviceRSSIParams` | `Promise<GetBLEDeviceRSSIResult>` | - |
25
- | [`getBLEMTU`](#getblemtu) | `getBLEMTU(params): Promise<GetBLEMTUResult>` | 获取 BLE MTU | `params: GetBLEMTUParams` | `Promise<GetBLEMTUResult>` | - |
26
- | [`notifyBLECharacteristicValueChange`](#notifyblecharacteristicvaluechange) | `notifyBLECharacteristicValueChange(params): Promise<object>` | 订阅 BLE 特征值变化 | `params: NotifyBLECharacteristicValueChangeParams` | `Promise<object>` | 订阅指定特征值变化 |
27
- | [`readBLECharacteristicValue`](#readblecharacteristicvalue) | `readBLECharacteristicValue(params): Promise<object>` | 读取 BLE 特征值 | `params: ReadBLECharacteristicValueParams` | `Promise<object>` | 需要传入 serviceId 和 characteristicId |
28
- | [`setBLEMTU`](#setblemtu) | `setBLEMTU(params): Promise<SetBLEMTUResult>` | 设置 BLE MTU | `params: SetBLEMTUParams` | `Promise<SetBLEMTUResult>` | - |
29
- | [`writeBLECharacteristicValue`](#writeblecharacteristicvalue) | `writeBLECharacteristicValue(params): Promise<object>` | 写入 BLE 特征值 | `params: WriteBLECharacteristicValueParams` | `Promise<object>` | value 需要是 ArrayBuffer。 ## Enumerations ### ActionDirectiveType |
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [openBluetoothAdapter](#openbluetoothadapter) | 打开蓝牙适配器。<br><br>蓝牙流程入口。 |
12
+ | [startBluetoothDevicesDiscovery](#startbluetoothdevicesdiscovery) | 开始搜索附近的蓝牙设备。<br><br>通常先调用 openBluetoothAdapter |
13
+ | [stopBluetoothDevicesDiscovery](#stopbluetoothdevicesdiscovery) | 停止搜索附近的蓝牙设备。 |
14
+ | [getBluetoothAdapterState](#getbluetoothadapterstate) | 获取蓝牙适配器状态。 |
15
+ | [getBluetoothDevices](#getbluetoothdevices) | 获取当前蓝牙模块发现的设备列表。<br><br>通常先调用 startBluetoothDevicesDiscovery |
16
+ | [getConnectedBluetoothDevices](#getconnectedbluetoothdevices) | 获取已连接的蓝牙设备列表。 |
17
+ | [makeBluetoothPair](#makebluetoothpair) | 发起蓝牙配对。 |
18
+ | [isBluetoothDevicePaired](#isbluetoothdevicepaired) | 查询蓝牙设备是否已经配对。 |
19
+ | [closeBluetoothAdapter](#closebluetoothadapter) | 关闭蓝牙适配器。<br><br>会关闭蓝牙模块。 |
20
+ | [createBLEConnection](#createbleconnection) | 创建 BLE 连接。<br><br>需要传入 deviceId |
21
+ | [closeBLEConnection](#closebleconnection) | 关闭 BLE 连接。 |
22
+ | [getBLEDeviceServices](#getbledeviceservices) | 获取 BLE 服务列表。<br><br>通常先调用 createBLEConnection |
23
+ | [getBLEDeviceCharacteristics](#getbledevicecharacteristics) | 获取 BLE 特征值列表。<br><br>通常先获取 BLE 服务列表。 |
24
+ | [getBLEDeviceRSSI](#getbledevicerssi) | 获取 BLE 设备 RSSI |
25
+ | [getBLEMTU](#getblemtu) | 获取 BLE MTU |
26
+ | [notifyBLECharacteristicValueChange](#notifyblecharacteristicvaluechange) | 订阅 BLE 特征值变化。<br><br>订阅指定特征值变化。 |
27
+ | [readBLECharacteristicValue](#readblecharacteristicvalue) | 读取 BLE 特征值。<br><br>需要传入 serviceId 和 characteristicId |
28
+ | [setBLEMTU](#setblemtu) | 设置 BLE MTU |
29
+ | [writeBLECharacteristicValue](#writeblecharacteristicvalue) | 写入 BLE 特征值。<br><br>value 需要是 ArrayBuffer。 |
30
30
 
31
31
  ## API 详情
32
32
 
@@ -355,30 +355,6 @@
355
355
 
356
356
  value 需要是 ArrayBuffer。
357
357
 
358
- ## Enumerations
359
-
360
- ### ActionDirectiveType
361
-
362
- #### Enumeration Members
363
-
364
- ##### BUTTON\_CLICK
365
-
366
- > **BUTTON\_CLICK**: `"button_click"`
367
-
368
- 按钮点击
369
-
370
- ##### FORM\_SUBMIT
371
-
372
- > **FORM\_SUBMIT**: `"form_submit"`
373
-
374
- 表单提交(复杂的信息提交场景)
375
-
376
- ##### OPTION\_SELECT
377
-
378
- > **OPTION\_SELECT**: `"option_select"`
379
-
380
- 选择(下拉列表场景)
381
-
382
358
  ## 相关类型
383
359
 
384
360
  <a id="openbluetoothadapterparams"></a>
@@ -1,4 +1,4 @@
1
- # Open API: Device / Wi-Fi
1
+ # Open API: 设备 / Wi-Fi
2
2
 
3
3
  Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。
4
4
 
@@ -6,14 +6,14 @@ Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。
6
6
 
7
7
  ## 速查
8
8
 
9
- | API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
10
- | --- | --- | --- | --- | --- | --- |
11
- | [`startWifi`](#startwifi) | `startWifi(params?): Promise<object>` | 初始化 Wi-Fi 模块 | `params?` | `Promise<object>` | Wi-Fi 流程入口 |
12
- | [`stopWifi`](#stopwifi) | `stopWifi(params?): Promise<object>` | 关闭 Wi-Fi 模块 | `params?` | `Promise<object>` | - |
13
- | [`setWifiList`](#setwifilist) | `setWifiList(params): Promise<object>` | 设置 Wi-Fi 预设列表 | `params: SetWifiListParams` | `Promise<object>` | 用于预设 Wi-Fi 列表 |
14
- | [`connectWifi`](#connectwifi) | `connectWifi(params): Promise<object>` | 连接指定 Wi-Fi | `params: ConnectWifiParams` | `Promise<object>` | 通常先调用 startWifi |
15
- | [`getConnectedWifi`](#getconnectedwifi) | `getConnectedWifi(params?): Promise<GetConnectedWifiResult>` | 获取当前已连接 Wi-Fi 信息 | `params?: GetConnectedWifiParams` | `Promise<GetConnectedWifiResult>` | - |
16
- | [`getWifiList`](#getwifilist) | `getWifiList(params?): Promise<GetWifiListResult>` | 获取 Wi-Fi 列表 | `params?` | `Promise<GetWifiListResult>` | 通常先调用 startWifi |
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [startWifi](#startwifi) | 初始化 Wi-Fi 模块。<br><br>Wi-Fi 流程入口。 |
12
+ | [stopWifi](#stopwifi) | 关闭 Wi-Fi 模块。 |
13
+ | [setWifiList](#setwifilist) | 设置 Wi-Fi 预设列表。<br><br>用于预设 Wi-Fi 列表。 |
14
+ | [connectWifi](#connectwifi) | 连接指定 Wi-Fi。<br><br>通常先调用 startWifi |
15
+ | [getConnectedWifi](#getconnectedwifi) | 获取当前已连接 Wi-Fi 信息。 |
16
+ | [getWifiList](#getwifilist) | 获取 Wi-Fi 列表。<br><br>通常先调用 startWifi |
17
17
 
18
18
  ## API 详情
19
19