1## wifiManager使用说明文档
2
3​		本文档主要介绍Wifi专项测试程序的WifiManager部分(@ohos.wifiManager.d.ts)的功能使用说明。
4
5#### 从主界面跳转到WIFIManager部分
6
7---
8
9#### setting界面
10
11点击"switch"按钮,设置本设备的wifi参数配置。
12
13
14
15WifiManager配置信息包括:
16
17>#### WifiDeviceConfig  WLAN配置信息
18>
19>|   **名称**    |       **类型**       |               默认值设置                | **说明**                                                   |
20>| :-----------: | :------------------: | :-------------------------------------: | :--------------------------------------------------------- |
21>|     ssid      |        string        |              TP-LINK_6365               | 热点的SSID,编码格式为UTF-8。                              |
22>|     bssid     |        string        |            6c:b1:58:75:63:67            | 热点的BSSID。                                              |
23>| preSharedKey  |        string        |               kaihong123                | 热点的密钥。                                               |
24>| isHiddenSsid  |       boolean        |                  false                  | 是否是隐藏网络。                                           |
25>| securityType  | **WifiSecurityType** |                    3                    | 加密类型。                                                 |
26>|  creatorUid   |        number        |                    1                    | 创建用户的ID。 **系统接口:** 此接口为系统接口。           |
27>| disableReason |        number        |                    0                    | 禁用原因。 **系统接口:** 此接口为系统接口。               |
28>|     netId     |        number        |                    0                    | 分配的网络ID。 **系统接口:** 此接口为系统接口。           |
29>| randomMacType |        number        |                    0                    | 随机MAC类型。 **系统接口:** 此接口为系统接口。            |
30>| randomMacAddr |        string        |            xx:xx:xx:xx:xx:xx            | 随机MAC地址。 **系统接口:** 此接口为系统接口。            |
31>|    ipType     |      **IpType**      |                    1                    | IP地址类型。 **系统接口:** 此接口为系统接口。             |
32>|   staticIp    |     **IpConfig**     | ipAddress;gateway;dnsServers;domains | 静态IP配置信息。 **系统接口:** 此接口为系统接口。         |
33>|  eapConfig9+  |  **WifiEapConfig**   |                                         | 可扩展身份验证协议配置。 **系统接口:** 此接口为系统接口。 |
34>
35>
36>
37>#### IpType   表示IP类型的枚举
38>
39>| 名称    | 值   | 说明           |
40>| :------ | :--- | :------------- |
41>| STATIC  | 0    | 静态IP。       |
42>| DHCP    | 1    | 通过DHCP获取。 |
43>| UNKNOWN | 2    | 未指定。       |
44>
45>
46>
47>#### IpConfig   IP配置信息
48>
49>| **名称**     | **类型**      | **可读** | **可写** | **说明**    |
50>| :----------- | :------------ | :------- | :------- | :---------- |
51>| ipAddress    | number        | 是       | 否       | IP地址。    |
52>| gateway      | number        | 是       | 否       | 网关。      |
53>| prefixLength | number        | 是       | 否       | 掩码。      |
54>| dnsServers   | number[]      | 是       | 否       | DNS服务器。 |
55>| domains      | Array<string> | 是       | 否       | 域信息。    |
56>
57>
58>
59>#### WifiEapConfig  可扩展身份验证协议配置信息
60>
61>| **名称**          | **类型**         | **可读** | **可写** | **说明**                         |
62>| :---------------- | :--------------- | :------- | :------- | :------------------------------- |
63>| eapMethod         | **EapMethod**    | 是       | 否       | EAP认证方式。                    |
64>| phase2Method      | **Phase2Method** | 是       | 否       | 第二阶段认证方式。               |
65>| identity          | string           | 是       | 否       | 身份信息。                       |
66>| anonymousIdentity | string           | 是       | 否       | 匿名身份。                       |
67>| password          | string           | 是       | 否       | 密码。                           |
68>| caCertAliases     | string           | 是       | 否       | CA 证书别名。                    |
69>| caPath            | string           | 是       | 否       | CA 证书路径。                    |
70>| clientCertAliases | string           | 是       | 否       | 客户端证书别名。                 |
71>| altSubjectMatch   | string           | 是       | 否       | 替代主题匹配。                   |
72>| domainSuffixMatch | string           | 是       | 否       | 域后缀匹配。                     |
73>| realm             | string           | 是       | 否       | 通行证凭证的领域。               |
74>| plmn              | string           | 是       | 否       | 公共陆地移动网的直通凭证提供商。 |
75>| eapSubId          | number           | 是       | 否       | SIM卡的子ID。                    |
76>
77>
78>
79>#### EapMethod   表示EAP认证方式的枚举
80>
81>| 名称           | 值   | 说明             |
82>| :------------- | :--- | :--------------- |
83>| EAP_NONE       | 0    | 不指定。         |
84>| EAP_PEAP       | 1    | PEAP类型。       |
85>| EAP_TLS        | 2    | TLS类型。        |
86>| EAP_TTLS       | 3    | TTLS类型。       |
87>| EAP_PWD        | 4    | PWD类型。        |
88>| EAP_SIM        | 5    | SIM类型。        |
89>| EAP_AKA        | 6    | AKA类型。        |
90>| EAP_AKA_PRIME  | 7    | AKA Prime类型。  |
91>| EAP_UNAUTH_TLS | 8    | UNAUTH TLS类型。 |
92>
93>
94>
95>#### Phase2Method   表示第二阶段认证方式的枚举
96>
97>| 名称             | 值   | 说明            |
98>| :--------------- | :--- | :-------------- |
99>| PHASE2_NONE      | 0    | 不指定。        |
100>| PHASE2_PAP       | 1    | PAP类型。       |
101>| PHASE2_MSCHAP    | 2    | MSCHAP类型。    |
102>| PHASE2_MSCHAPV2  | 3    | MSCHAPV2类型。  |
103>| PHASE2_GTC       | 4    | GTC类型。       |
104>| PHASE2_SIM       | 5    | SIM类型。       |
105>| PHASE2_AKA       | 6    | AKA类型。       |
106>| PHASE2_AKA_PRIME | 7    | AKA Prime类型。 |
107
108
109
110#### wifiManager(@ohos.wifiManager.d.ts)的主要接口
111
112|        method名称         |             API名称             |           所需参数           |                  返回值                   | 备注 |
113| :-----------------------: | :-----------------------------: | :--------------------------: | :---------------------------------------: | :--: |
114|         使能WIFI          |           enableWifi            |              ()              |                   void                    |      |
115|        去使能WIFI         |           disableWifi           |              ()              |                   void                    |      |
116|        是否已使能         |          isWifiActive           |              ()              |                  boolean                  |      |
117|       启动WLAN扫描        |              scan               |              ()              |                   void                    |      |
118|       获取扫描信息        |         getScanInfoList         |              ()              |            Array<WifiScanInfo>            |      |
119|   添加网络配置,promise    |    addDeviceConfig(promise)     |  (config: WifiDeviceConfig)  |              Promise<number>              |      |
120|   添加网络配置,callback   |    addDeviceConfig(callback)    |  (config: WifiDeviceConfig)  |     (callback: AsyncCallback<number>)     |      |
121|   添加候选配置,promise    |   addCandidateConfig(promise)   | (config: WifiDeviceConfig) |              Promise<number>              |      |
122|   添加候选配置,callback   |  addCandidateConfig(callback)   | (config: WifiDeviceConfig)  |      callback: AsyncCallback<number>      |      |
123|   移除候选配置,promise   | removeCandidateConfig(promise)  |     (networkId: number)      |               Promise<void>               |      |
124|  移除候选配置,callback   | removeCandidateConfig(callback) |     (networkId: number)     |       callback: AsyncCallback<void>       |      |
125|       获取候选配置        |       getCandidateConfigs       |             ()             |          Array<WifiDeviceConfig>          |      |
126|      连接到候选配置       |    connectToCandidateConfig     |     (networkId: number)      |                   void                    |      |
127|      连接到指定网络       |        connectToNetwork         |     (networkId: number)      |                   void                    |      |
128|      连接到指定网络       |         connectToDevice         |  (config: WifiDeviceConfig)  |                   void                    |      |
129|      断开连接的网络       |           disconnect            |              ()              |                   void                    |      |
130|     查询WLAN信号强度      |         getSignalLevel          | (rssi: number, band: number) |                  number                   |      |
131| 获取WLAN连接信息,promise  |     getLinkedInfo(promise)      |              ()              |          Promise<WifiLinkedInfo>          |      |
132| 获取WLAN连接信息,callback |     getLinkedInfo(callback)     |              ()              | (callback: AsyncCallback<WifiLinkedInfo>) |      |
133|      WLAN是否已连接       |           isConnected           |              ()              |                  boolean                  |      |
134|    查询设备支持的特性     |      getSupportedFeatures       |              ()              |                  number                   |      |
135|   是否支持相关WLAN特性    |       isFeatureSupported        |     (featureId: number)      |                  boolean                  |      |
136|     获取设备的MAC地址     |       getDeviceMacAddress       |              ()              |                 string[]                  |      |
137|        获取IP信息         |            getIpInfo            |              ()              |                  IpInfo                   |      |
138|      获取国家码信息       |         getCountryCode          |              ()              |                  string                   |      |
139|       重新关联网络        |           reassociate           |              ()              |                   void                    |      |
140|       重新连接网络        |            reConnect            |              ()              |                   void                    |      |
141|       获取网络配置        |        getDeviceConfigs         |              ()              |          Array<WifiDeviceConfig>          |      |
142|     更新指定Wifi配置      |       updateDeviceConfig        |  (config: WifiDeviceConfig)  |                  number                   |      |
143|     禁用指定设备配置      |       disableDeviceConfig       |     (networkId: number)      |                   void                    |      |
144|     移除所有网络配置      |     removeAllDeviceConfigs      |              ()              |                   void                    |      |
145|    移除指定的网络配置     |       removeDeviceConfig        |     (networkId: number)      |                   void                    |      |
146|   注册WLAN状态改变事件    |       on.wifiStateChange        |                              |       (callback: Callback<number>)        |      |
147| 注册WLAN连接状态改变事件  |     on.wifiConnectionChange     |                              |       (callback: Callback<number>)        |      |
148|   注册扫描状态改变事件    |     on.wifiScanStateChange      |                              |       (callback: Callback<number>)        |      |
149|   注册RSSI状态改变事件    |        on.wifiRssiChange        |                              |       (callback: Callback<number>)        |      |
150|      注册流改变事件       |         on.streamChange         |                              |       (callback: Callback<number>)        |      |
151|   注册设备配置改变事件    |      on.deviceConfigChange      |                              |       (callback: Callback<number>)        |      |
152|                           |                                 |                              |                                           |      |
153
154
155
156#### 返回值介绍
157
158>#### WifiScanInfo    WLAN热点信息
159>
160>| **名称**         | **类型**                | **可读** | **可写** | **说明**                                                     |
161>| :--------------- | :---------------------- | :------- | :------- | :----------------------------------------------------------- |
162>| ssid             | string                  | 是       | 否       | 热点的SSID,编码格式为UTF-8。                                |
163>| bssid            | string                  | 是       | 否       | 热点的BSSID。                                                |
164>| capabilities     | string                  | 是       | 否       | 热点能力。                                                   |
165>| securityType     | **WifiSecurityType**    | 是       | 否       | WLAN加密类型。                                               |
166>| rssi             | number                  | 是       | 否       | 热点的信号强度(dBm)。                                        |
167>| band             | number                  | 是       | 否       | WLAN接入点的频段。                                           |
168>| frequency        | number                  | 是       | 否       | WLAN接入点的频率。                                           |
169>| channelWidth     | number                  | 是       | 否       | WLAN接入点的带宽。                                           |
170>| centerFrequency0 | number                  | 是       | 否       | 热点的中心频率。                                             |
171>| centerFrequency1 | number                  | 是       | 否       | 热点的中心频率。如果热点使用两个不重叠的WLAN信道,则返回两个中心频率,分别用centerFrequency0和centerFrequency1表示。 |
172>| infoElems        | Array**<WifiInfoElem>** | 是       | 否       | 信息元素。                                                   |
173>| timestamp        | number                  | 是       | 否       | 时间戳。                                                     |
174>
175>
176>
177>#### WifiSecurityType   表示加密类型的枚举
178>
179>| **名称**                    | **值** | **说明**                                              |
180>| :-------------------------- | :----- | :---------------------------------------------------- |
181>| WIFI_SEC_TYPE_INVALID       | 0      | 无效加密类型。                                        |
182>| WIFI_SEC_TYPE_OPEN          | 1      | 开放加密类型。                                        |
183>| WIFI_SEC_TYPE_WEP           | 2      | Wired Equivalent Privacy (WEP)加密类型。              |
184>| WIFI_SEC_TYPE_PSK           | 3      | Pre-shared key (PSK)加密类型。                        |
185>| WIFI_SEC_TYPE_SAE           | 4      | Simultaneous Authentication of Equals (SAE)加密类型。 |
186>| WIFI_SEC_TYPE_EAP9+         | 5      | EAP加密类型。                                         |
187>| WIFI_SEC_TYPE_EAP_SUITE_B9+ | 6      | Suite-B 192位加密类型。                               |
188>| WIFI_SEC_TYPE_OWE9+         | 7      | 机会性无线加密类型。                                  |
189>| WIFI_SEC_TYPE_WAPI_CERT9+   | 8      | WAPI-Cert加密类型。                                   |
190>| WIFI_SEC_TYPE_WAPI_PSK9+    | 9      | WAPI-PSK加密类型。                                    |
191>
192>
193>
194>#### WifiInfoElem    WLAN热点信息
195>
196>| **名称** | **类型**   | **可读** | **可写** | **说明**   |
197>| :------- | :--------- | :------- | :------- | :--------- |
198>| eid      | number     | 是       | 否       | 元素ID。   |
199>| content  | Uint8Array | 是       | 否       | 元素内容。 |
200>
201>
202>
203>#### WifiLinkedInfo  提供WLAN连接的相关信息
204>
205>| 名称         | 类型          | 可读 | 可写 | 说明                                                         |
206>| :----------- | :------------ | :--- | :--- | :----------------------------------------------------------- |
207>| ssid         | string        | 是   | 否   | 热点的SSID,编码格式为UTF-8。                                |
208>| bssid        | string        | 是   | 否   | 热点的BSSID。                                                |
209>| networkId    | number        | 是   | 否   | 网络配置ID。 **系统接口:** 此接口为系统接口。               |
210>| rssi         | number        | 是   | 否   | 热点的信号强度(dBm)。                                        |
211>| band         | number        | 是   | 否   | WLAN接入点的频段。                                           |
212>| linkSpeed    | number        | 是   | 否   | WLAN接入点的速度。                                           |
213>| frequency    | number        | 是   | 否   | WLAN接入点的频率。                                           |
214>| isHidden     | boolean       | 是   | 否   | WLAN接入点是否是隐藏网络。                                   |
215>| isRestricted | boolean       | 是   | 否   | WLAN接入点是否限制数据量。                                   |
216>| chload       | number        | 是   | 否   | 连接负载,值越大表示负载约高。 **系统接口:** 此接口为系统接口。 |
217>| snr          | number        | 是   | 否   | 信噪比。 **系统接口:** 此接口为系统接口。                   |
218>| macType9+    | number        | 是   | 否   | MAC地址类型。                                                |
219>| macAddress   | string        | 是   | 否   | 设备的MAC地址。                                              |
220>| ipAddress    | number        | 是   | 否   | WLAN连接的IP地址。                                           |
221>| suppState    | **SuppState** | 是   | 否   | 请求状态。 **系统接口:** 此接口为系统接口。                 |
222>| connState    | **ConnState** | 是   | 否   | WLAN连接状态。                                               |
223>
224>
225>
226>#### ConnState  表示WLAN连接状态的枚举
227>
228>| 名称             | 值   | 说明                       |
229>| :--------------- | :--- | :------------------------- |
230>| SCANNING         | 0    | 设备正在搜索可用的AP。     |
231>| CONNECTING       | 1    | 正在建立WLAN连接。         |
232>| AUTHENTICATING   | 2    | WLAN连接正在认证中。       |
233>| OBTAINING_IPADDR | 3    | 正在获取WLAN连接的IP地址。 |
234>| CONNECTED        | 4    | WLAN连接已建立。           |
235>| DISCONNECTING    | 5    | WLAN连接正在断开。         |
236>| DISCONNECTED     | 6    | WLAN连接已断开。           |
237>| UNKNOWN          | 7    | WLAN连接建立失败。         |
238>
239>
240>
241>#### SuppState  表示请求状态的枚举
242>
243>| 名称               | 值   | 说明             |
244>| :----------------- | :--- | :--------------- |
245>| DISCONNECTED       | 0    | 已断开。         |
246>| INTERFACE_DISABLED | 1    | 接口禁用。       |
247>| INACTIVE           | 2    | 未激活。         |
248>| SCANNING           | 3    | 扫描中。         |
249>| AUTHENTICATING     | 4    | 认证中。         |
250>| ASSOCIATING        | 5    | 关联中。         |
251>| ASSOCIATED         | 6    | 已关联。         |
252>| FOUR_WAY_HANDSHAKE | 7    | 四次握手。       |
253>| GROUP_HANDSHAKE    | 8    | 组握手。         |
254>| COMPLETED          | 9    | 所有认证已完成。 |
255>| UNINITIALIZED      | 10   | 连接建立失败。   |
256>| INVALID            | 11   | 无效值。         |
257>
258>
259>
260>#### IpInfo  IP信息
261>
262>| **名称**      | **类型** | **可读** | **可写** | **说明**            |
263>| :------------ | :------- | :------- | :------- | :------------------ |
264>| ipAddress     | number   | 是       | 否       | IP地址。            |
265>| gateway       | number   | 是       | 否       | 网关。              |
266>| netmask       | number   | 是       | 否       | 掩码。              |
267>| primaryDns    | number   | 是       | 否       | 主DNS服务器IP地址。 |
268>| secondDns     | number   | 是       | 否       | 备DNS服务器IP地址。 |
269>| serverIp      | number   | 是       | 否       | DHCP服务端IP地址。  |
270>| leaseDuration | number   | 是       | 否       | IP地址租用时长。    |
271>
272>
273>
274>#### WifiDeviceConfig  WLAN配置信息  (内容类型同上)
275
276
277
278**热点和WiFi是无法同时打开的,只要有一个打开着,另一个就无法打开**
279
280
281
282#### 功能
283
284**"Wifi打开"是其他功能测试的前提**
285
2861. 开/关Wifi
287
288   - 使用指导:点击后,在设备上启动/关闭Wifi;根据设备的Wifi情况,显示返回信息。
289
290   - 限制条件:
291
292     - 返回值为void
293     - @throws {BusinessError} 201 - Permission denied.
294     * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
295     * @throws {BusinessError} 801 - Capability not supported.
296     * @throws {BusinessError} 2501000 - Operation failed.
297     - @throws {BusinessError} 2501004 - Failed for wifi is opening.
298
299   - 验证方法:可在设备的设置中查看Wifi的开关情况
300
301
302
3032.  获取状态
304
305    - 使用指导:点击后,基于Wifi的开关状态,判断Wifi当时的状态。
306
307    - 限制条件:
308
309      - 若本地Wifi打开,返回值为true
310      - 若本地Wifi关闭,返回值为false
311      - @throws {BusinessError} 201 - Permission denied.
312      - @throws {BusinessError} 801 - Capability not supported.
313      - @throws {BusinessError} 2501000 - Operation failed.
314
315    - 验证方法:可在设备设置中查看Wifi的当前状态
316
317
318
3193.  启动WLAN扫描
320
321    - 使用指导:点击后,扫描Wi-Fi热点。
322
323    - 限制条件:
324
325      - 返回值为void
326      - @throws {BusinessError} 201 - Permission denied.
327      - @throws {BusinessError} 801 - Capability not supported.
328      - @throws {BusinessError} 2501000 - Operation failed.
329
330    - 验证方法:查看扫描的结果判断是否扫描成功,利用on.wifiScanStateChange()和getScanInfos()查看返回的结果。
331
332
333
3344.  获取扫描信息  getScanInfoList
335
336    - 使用指导:点击后,返回有关扫描的Wi-Fi热点的信息(如果有的话)
337
338    - 限制条件:
339
340      - 返回值为:Array<WifiScanInfo>
341      - @throws {BusinessError} 201 - Permission denied.
342      * @throws {BusinessError} 801 - Capability not supported.
343      * @throws {BusinessError} 2501000 - Operation failed.
344
345    - 验证方法:查看返回的信息
346
347
348
3495.  添加网络配置  addDeviceConfig  ( promise/callback350
351    - 使用指导:将 Wi-Fi 连接配置添加到设备。
352
353    - 限制条件:
354
355      - WiFi已使能,且配置的参数 (config: WifiDeviceConfig) 都正确。
356      - 添加配置时,配置将更新。配置 表示连接到 Wi-Fi 网络的设备配置。
357      - @throws {BusinessError} 201 - Permission denied.
358      * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
359      * @throws {BusinessError} 401 - Invalid parameters.
360      * @throws {BusinessError} 801 - Capability not supported.
361      * @throws {BusinessError} 2501000 - Operation failed.
362
363    - 验证方法:查看返回的信息。如果添加了配置,则返回code:networkId;否则返回code: -1。
364
365
366
3676.  添加候选配置   addCandidateConfig ( promise/callback368
369    - 使用指导:添加指定的候选热点配置并返回 networkId
370
371    - 限制条件:
372
373      - 此方法一次添加一个配置。添加此配置后,设备将决定是否连接到热点。
374      - 配置 - 候选配置。
375      - @throws {BusinessError} 201 - Permission denied.
376      - @throws {BusinessError} 401 - Invalid parameters.
377      - @throws {BusinessError} 801 - Capability not supported.
378      - @throws {BusinessError} 2501000 - Operation failed.
379
380    - 验证方法:查看返回信息,如果添加了配置,则返回 {code :networkId};否则返回 {code: -1}。
381
382
383
3847.  移除候选配置   removeCandidateConfig ( promise/callback )
385
386    - 使用指导:删除指定的候选热点配置,只允许自己添加的配置
387
388    - 限制条件:
389
390      - networkId - 将被删除的网络 ID
391      - 只能获取在自己的应用程序上创建的 Wi-Fi 配置。
392      - @throws {BusinessError} 201 - Permission denied.
393      - @throws {BusinessError} 401 - Invalid parameters.
394      - @throws {BusinessError} 801 - Capability not supported.
395      - @throws {BusinessError} 2501000 - Operation failed.
396
397    - 验证方法:查看返回信息,如果删除候选热点配置,返回 {code: true} ,否则返回 {code: false}
398
399
400
4017.  获取候选配置  ( getCandidateConfigs )
402
403    - 使用指导:获取我们自己添加的所有现有候选 Wi-Fi 配置的列表
404
405    - 限制条件:
406
407      - WiFi已使能,networkId参数配置成功
408      - 只能获取在自己的应用程序上创建的 Wi-Fi 配置。
409      - @throws {BusinessError} 201 - Permission denied.
410      - @throws {BusinessError} 801 - Capability not supported.
411      - @throws {BusinessError} 2501000 - Operation failed.
412
413    - 验证方法:查看返回信息,返回在应用程序上创建的所有现有 Wi-Fi 配置的列表。
414
415
416
4178.  连接到候选配置  ( connectToCandidateConfig )
418
419    - 使用指导:通过networkId连接到指定的候选热点,只有我们自己添加的配置
420
421    - 限制条件:
422
423      - WiFi已使能,networkId参数配置成功
424      - 此方法一次连接到一个配置
425      - @throws {BusinessError} 201 - Permission denied.
426      - @throws {BusinessError} 401 - Invalid parameters.
427      - @throws {BusinessError} 801 - Capability not supported.
428      - @throws {BusinessError} 2501000 - Operation failed.
429      - @throws {BusinessError} 2501001 - Wifi is closed.
430      - 返回值为void
431
432    - 验证方法:查看连接信息。
433
434
435
4369.  连接到指定网络  ( connectToNetwork )
437
438    - 使用指导:连接到networkId的指定Wi-Fi网络
439
440    - 限制条件:
441
442      - WiFi已使能,networkId参数配置成功
443      - @throws {BusinessError} 201 - Permission denied.
444      - @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
445      - @throws {BusinessError} 401 - Invalid parameters.
446      - @throws {BusinessError} 801 - Capability not supported.
447      - @throws {BusinessError} 2501000 - Operation failed.
448      - @throws {BusinessError} 2501001 - Wifi is closed.
449      - 返回值为void
450
451    - 验证方法:查看连接信息。
452
453
454
45510.  连接到指定网络  ( connectToDevice )
456
457     - 使用指导:连接到WiFi设备配置的指定Wi-Fi网络
458
459     - 限制条件:
460
461       - WiFi已使能,Wifi参数配置 (config: WifiDeviceConfig) 成功
462       - @throws {BusinessError} 201 - Permission denied.
463       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
464       * @throws {BusinessError} 401 - Invalid parameters.
465       * @throws {BusinessError} 801 - Capability not supported.
466       * @throws {BusinessError} 2501000 - Operation failed.
467       * @throws {BusinessError} 2501001 - Wifi is closed.
468       * 返回值为void
469
470     - 验证方法:查看连接信息。
471
472
473
47411.  断开连接的网络  ( disconnect )
475
476     - 使用指导:断开Wi-Fi网络连接
477
478     - 限制条件:
479
480       - 设备已经连接上了WiFi
481       - @throws {BusinessError} 201 - Permission denied.
482       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
483       * @throws {BusinessError} 801 - Capability not supported.
484       * @throws {BusinessError} 2501000 - Operation failed.
485       * 返回值为void
486
487     - 验证方法:查看连接情况。
488
489
490
49112.  查询WLAN信号强度 ( getSignalLevel )
492
493     - 使用指导:基于Wi-Fi的RSSI和频段( band )来计算Wi-Fi信号强度
494
495     - 限制条件:
496
497       - 设备已经连接上了WiFi
498       - 且获得了rssi(热点的信号强度)和band(WLAN接入点的频段)
499       - @throws {BusinessError} 201 - Permission denied.
500       * @throws {BusinessError} 401 - Invalid parameters.
501       * @throws {BusinessError} 801 - Capability not supported.
502       * @throws {BusinessError} 2501000 - Operation failed.
503
504     - 验证方法:查看返回的信息。返回范围从0到4的Wi-Fi信号强度。
505
506
507
50813.  获取WLAN连接信息  getLinkedInfo ( promise/callback )
509
510     - 使用指导:获取有关Wi-Fi连接的信息
511
512     - 限制条件:
513
514       - 设备已经连接上了WiFi验证方法:查看返回的信息。返回Wi-Fi连接信息  ( WifiLinkedInfo )。
515       - @throws {BusinessError} 201 - Permission denied.
516       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
517       * @throws {BusinessError} 801 - Capability not supported.
518       * @throws {BusinessError} 2501000 - Operation failed.
519       * @throws {BusinessError} 2501001 - Wifi is closed.
520
521     - 验证方法:查看返回的信息。与设备的wifi连接是否一样
522
523
524
52514.  WLAN是否已连接  ( isConnected )
526
527     - 使用指导:连接到Wi-Fi网络
528
529     - 限制条件:
530
531       - WiFi已使能
532       - @throws {BusinessError} 201 - Permission denied.
533       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
534       * @throws {BusinessError} 801 - Capability not supported.
535       * @throws {BusinessError} 2501000 - Operation failed.
536
537     - 验证方法:查看返回的信息。如果Wi-Fi已经连接,则返回code:true,否则返回code:false。
538
539540
54115.  查询设备支持的特性 ( getSupportedFeatures )
542
543     - 使用指导:获取此设备支持的功能特性
544
545     - 限制条件:
546
547       - 无
548       - @throws {BusinessError} 201 - Permission denied.
549       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
550       * @throws {BusinessError} 801 - Capability not supported.
551       * @throws {BusinessError} 2401000 - Operation failed.
552
553     - 验证方法:查看返回的信息。返回此设备支持的特性Id
554
555
556
55716.  是否支持相关WLAN特性 ( isFeatureSupported)
558
559     - 使用指导:检查此设备是否支持指定功能
560
561     - 限制条件:
562
563       - 参数为特性功能Id (featureId: number)
564       - @throws {BusinessError} 201 - Permission denied.
565       * @throws {BusinessError} 401 - Invalid parameters.
566       * @throws {BusinessError} 801 - Capability not supported.
567       * @throws {BusinessError} 2401000 - Operation failed.
568
569     - 验证方法:查看返回的信息。如果此设备支持指定的功能,则返回code:true,否则返回ode:false。
570
571
572
57317.  获取设备的MAC地址  ( getDeviceMacAddress )
574
575     - 使用指导:获取 Wi-Fi 设备的 MAC 地址
576
577     - 限制条件:
578
579       - 必须启用 Wi-Fi。
580       - MAC 地址是唯一的,无法更改。
581       - @throws {BusinessError} 201 - Permission denied.
582       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
583       * @throws {BusinessError} 801 - Capability not supported.
584       * @throws {BusinessError} 2501000 - Operation failed.
585       - @throws {BusinessError} 2501001 - Wifi is closed.
586
587     - 验证方法:查看返回的信息。
588
589
590
59118.  获取IP信息  ( getIpInfo )
592
593     - 使用指导:获取 Wi-Fi 连接的 IP 信息。
594
595     - 限制条件:
596
597       - 设备已经连接上了WiFi。
598       - 获取的IP 信息包括主机 IP 地址、网关地址和 DNS 信息。
599       - @throws {BusinessError} 201 - Permission denied.
600       * @throws {BusinessError} 801 - Capability not supported.
601       * @throws {BusinessError} 2501000 - Operation failed.
602
603     - 验证方法:查看返回的信息。返回 Wi-Fi 连接的 IP 信息。
604
605
606
60719.  获取国家码信息  ( getCountryCode )
608
609     - 使用指导:获取此设备的国家/地区代码。
610
611     - 限制条件:
612
613       - 设备已经连接上了WiFi
614       - @throws {BusinessError} 201 - Permission denied.
615       * @throws {BusinessError} 801 - Capability not supported.
616       * @throws {BusinessError} 2401000 - Operation failed.
617
618     - 验证方法:查看返回的信息。返回此设备的国家/地区代码。
619
620
621
62220.  重新关联网络 ( reassociate )
623
624     - 使用指导: 重新关联到当前网络
625
626     - 限制条件:
627
628       - 与当前网络取消关联
629
630       - @throws {BusinessError} 201 - Permission denied.
631
632       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
633       * @throws {BusinessError} 801 - Capability not supported.
634       * @throws {BusinessError} 2501000 - Operation failed.
635       - @throws {BusinessError} 2501001 - Wifi is closed.
636       - 返回值为void
637
638     - 验证方法: 查看关联信息。
639
640
641
64221.  重新连接网络  ( reConnect )
643
644     - 使用指导: 当前网络重新连接
645
646     - 限制条件:
647
648       - 与当前网络断开连接
649       - @throws {BusinessError} 201 - Permission denied.
650       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
651       * @throws {BusinessError} 801 - Capability not supported.
652       * @throws {BusinessError} 2501000 - Operation failed.
653       * @throws {BusinessError} 2501001 - Wifi is closed.
654       * 返回值为void
655
656     - 验证方法: 查看连接情况。
657
658
659
66022.  获取网络配置  ( getDeviceConfigs )
661
662     - 使用指导: 获取所有现有 Wi-Fi 配置的列表
663
664     - 限制条件:
665
666       - 只能获取在自己的应用程序上创建的 Wi-Fi 配置。
667       - @throws {BusinessError} 201 - Permission denied.
668       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
669       * @throws {BusinessError} 801 - Capability not supported.
670       * @throws {BusinessError} 2501000 - Operation failed.
671
672     - 验证方法: 查看返回的信息。返回在应用程序上创建的所有现有 Wi-Fi 配置的列表。
673
674
675
67624.  更新指定Wifi配置  ( updateDeviceConfig )
677
678     - 使用指导: 更新指定的 Wi-Fi 配置
679
680     - 限制条件:
681
682       - 参数: (config: WifiDeviceConfig) ,表示要更新的 Wi-Fi 配置
683       - @throws {BusinessError} 201 - Permission denied.
684       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
685       * @throws {BusinessError} 401 - Invalid parameters.
686       * @throws {BusinessError} 801 - Capability not supported.
687       * @throws {BusinessError} 2501000 - Operation failed.
688
689     - 验证方法: 查看返回的信息。如果更新成功,则返回更新后的 Wi-Fi 配置中的网络 ID ;  如果列表中未包含指定的 Wi-Fi 配置,则返回code:-1。
690
691
692
69325.  禁用指定设备配置  ( disableDeviceConfig )
694
695     - 使用指导: 禁用指定的网络
696
697     - 限制条件:
698
699       - 参数:networkId,标识要禁用的网络。禁用的网络将不会再次关联。
700       - @throws {BusinessError} 201 - Permission denied.
701        * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
702        * @throws {BusinessError} 401 - Invalid parameters.
703        - @throws {BusinessError} 801 - Capability not supported
704        - 返回值为void
705
706     - 验证方法: 查看设备配置信息。
707
708
709
71026.  移除所有网络配置  ( removeAllDeviceConfigs )
711
712     - 使用指导: 删除所有已保存的 Wi-Fi 配置。
713
714     - 限制条件:
715
716       - 无,返回值为void
717       - @throws {BusinessError} 201 - Permission denied.
718       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
719       * @throws {BusinessError} 801 - Capability not supported.
720       * @throws {BusinessError} 2501000 - Operation failed.
721       * 返回值为void
722
723     - 验证方法: 查看网络配置信息。
724
725
726
72727.  移除指定的网络配置  ( removeDeviceConfig )
728
729     - 使用指导: 删除具有指定 ID 的 Wi-Fi 网络。
730
731       - 删除 Wi-Fi 网络后,其配置将从 Wi-Fi 配置列表中删除。
732       - 如果正在连接Wi-Fi网络,则连接将中断
733       - 应用程序只能删除它创建的 Wi-Fi 网络。
734
735     - 限制条件:
736
737       - 参数:id ,表示 Wi-Fi 网络的 ID (可以使用 {addDeviceConfig} 或 {getLinkedInfo} 方法获得。)
738
739       - @throws {BusinessError} 201 - Permission denied.
740
741       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
742       * @throws {BusinessError} 401 - Invalid parameters.
743       * @throws {BusinessError} 801 - Capability not supported.
744       - @throws {BusinessError} 2501000 - Operation failed.
745       - 返回值为void
746
747     - 验证方法: 查看网络配置
748
749
750
75128.  订阅/取消订阅注册WLAN状态改变事件 ( on/off.wifiStateChange )
752
753     - 使用指导:为回调函数,用来监听相关类型事件的变化,并弹窗显示信息。
754
755     - 限制条件:需要在相关类型事件发生改变前,开启监听。
756
757       > 注册状态变化:
758       >
759       > - 订阅Wifi状态更改时报告的事件。
760       >
761       > - type为要侦听的Wifi状态更改事件的类型。
762       >
763       >
764       > - callback回调用于侦听Wifi状态事件。
765
766       - 若本地Wifi已关闭,返回值为0,显示信息为"inactive";
767       - 若本地Wifi已打开,返回值为1,显示信息为"active";
768       - 若本地Wifi正在打开,返回值为2,显示信息为"activating";
769       - 若本地Wifi正在关闭,返回值为3,显示信息为"de-activating";
770       - @throws {BusinessError} 201 - Permission denied.
771       - @throws {BusinessError} 401 - Invalid parameters.
772       - @throws {BusinessError} 801 - Capability not supported.
773       - @throws {BusinessError} 2501000 - Operation failed.
774
775     - 验证方法:在事件变化后,查看是否有弹窗信息显示。
776
777
778
77929.  订阅/取消订阅注册WLAN连接状态改变事件 ( on/off.wifiConnectionChange )
780
781     - 使用指导:为回调函数,用来监听相关类型事件的变化,并弹窗显示信息。
782
783     - 限制条件:需要在相关类型事件发生改变前,开启监听。
784
785       > 注册状态变化:
786       >
787       > - 订阅Wifi连接状态更改时报告的事件。
788       >
789       > - type为要侦听的Wifi连接状态更改事件的类型。
790       >
791       >
792       > - callback回调用于侦听Wifi连接状态事件。
793
794       - 若未连接,返回值为0,显示信息为"disconnected";
795       - 若已连接,返回值为1,显示信息为"connected";
796       - @throws {BusinessError} 201 - Permission denied.
797       * @throws {BusinessError} 401 - Invalid parameters.
798       * @throws {BusinessError} 801 - Capability not supported.
799       - @throws {BusinessError} 2501000 - Operation failed.
800
801     - 验证方法:在事件变化后,查看是否有弹窗信息显示。
802
803
804
80530.  订阅/取消订阅注册扫描状态改变事件  ( on/off.wifiScanStateChange )
806
807     - 使用指导:为回调函数,用来监听相关类型事件的变化,并弹窗显示信息。
808
809     - 限制条件:需要在相关类型事件发生改变前,开启监听。
810
811       > 注册状态变化:
812       >
813       > - 订阅Wifi scan状态更改时报告的事件。
814       >
815       > - type为要侦听的Wifi scan状态更改事件的类型。
816       >
817       >
818       > - callback回调用于侦听Wifi scan状态事件。
819
820       - 若scan失败,返回值为0,显示信息为"scan fail";
821       - 若scan成功,返回值为1,显示信息为"scan success";
822       - @throws {BusinessError} 201 - Permission denied.
823       - @throws {BusinessError} 401 - Invalid parameters.
824       - @throws {BusinessError} 801 - Capability not supported.
825       - @throws {BusinessError} 2501000 - Operation failed.
826
827     - 验证方法:在事件变化后,查看是否有弹窗信息显示。
828
829
830
83131.  订阅/取消订阅注册RSSI状态改变事件   ( on/off.wifiRssiChange)
832
833     - 使用指导:为回调函数,用来监听相关类型事件的变化,并弹窗显示信息。
834
835     - 限制条件:需要在相关类型事件发生改变前,开启监听。
836
837       > 注册状态变化:
838       >
839       > - 订阅WifiRssi状态更改时报告的事件。
840       >
841       > - type为要侦听的WifiRssi状态更改事件的类型。
842       >
843       >
844       > - callback回调用于侦听WifiRssi状态事件。
845
846       - 返回以 dBm 为单位的 RSSI 值
847       - @throws {BusinessError} 201 - Permission denied.
848       * @throws {BusinessError} 401 - Invalid parameters.
849       * @throws {BusinessError} 801 - Capability not supported.
850       - @throws {BusinessError} 2501000 - Operation failed.
851
852     - 验证方法:在事件变化后,查看是否有弹窗信息显示。
853
854
855
85632.  订阅/取消订阅注册流改变事件   ( on/off.streamChange)
857
858     - 使用指导:为回调函数,用来监听相关类型事件的变化,并弹窗显示信息。
859
860     - 限制条件:需要在相关类型事件发生改变前,开启监听。
861
862       > 注册状态变化:
863       >
864       > - 订阅流状态更改时报告的事件。
865       >
866       > - type为要侦听的流状态更改事件的类型。
867       >
868       >
869       > - callback回调用于侦听流状态事件。
870
871       - 若流无,返回值为0,显示信息为"stream none";
872       - 若流向下,返回值为1,显示信息为"stream down";
873       - 若流向上,返回值为2,显示信息为"stream up";
874       - 若双向流,返回值为3,显示信息为"stream bidirectional";
875       - @throws {BusinessError} 201 - Permission denied.
876       * @throws {BusinessError} 202 - System API is not allowed called by Non-system application.
877       * @throws {BusinessError} 401 - Invalid parameters.
878       * @throws {BusinessError} 801 - Capability not supported.
879       - @throws {BusinessError} 2501000 - Operation failed.
880
881     - 验证方法:在事件变化后,查看是否有弹窗信息显示。
882
883
884
88533.  订阅/取消订阅注册设备配置改变事件  ( on/off.deviceConfigChange )
886
887     - 使用指导:为回调函数,用来监听相关类型事件的变化,并弹窗显示信息。
888
889     - 限制条件:需要在相关类型事件发生改变前,开启监听。
890
891       > 注册状态变化:
892       >
893       > - 订阅设备配置更改时报告的事件。
894       >
895       > - type为要侦听的设备配置更改事件的类型。
896       >
897       >
898       > - callback回调用于侦听设备配置更改事件。
899
900       - 若添加配置,返回值为0,显示信息为"config is added";
901       - 若配置更改,返回值为1,显示信息为"config is changed";
902       - 若配置被删除,返回值为2,显示信息为"config is removed";
903
904     - 验证方法:在事件变化后,查看是否有弹窗信息显示。
905