js-apis-wifiManager.md 77.1 KB
Newer Older
1
# @ohos.wifiManager (WLAN)
X
xiaosi 已提交
2 3 4 5 6 7 8 9 10
该模块主要提供WLAN基础功能、P2P(peer-to-peer)功能和WLAN消息通知的相应服务,让应用可以通过WLAN和其他设备互联互通。

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

```js
11
import wifiManager from '@ohos.wifiManager';
X
xiaosi 已提交
12 13
```

X
xiaosi 已提交
14
## wifi.enableWifi<sup>9+</sup>
X
xiaosi 已提交
15

X
xiaosi 已提交
16
enableWifi(): void
X
xiaosi 已提交
17 18 19 20 21 22 23 24 25

使能WLAN。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.STA

26 27 28 29 30 31 32 33
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|

X
xiaosi 已提交
34

X
xiaosi 已提交
35
## wifi.disableWifi<sup>9+</sup>
X
xiaosi 已提交
36

X
xiaosi 已提交
37
disableWifi(): void
X
xiaosi 已提交
38 39 40 41 42 43 44 45 46

去使能WLAN。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.STA

47 48 49 50 51 52 53
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
54

X
xiaosi 已提交
55
## wifi.isWifiActive<sup>9+</sup>
X
xiaosi 已提交
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

isWifiActive(): boolean

查询WLAN是否已使能。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:已使能,&nbsp;false:未使能。 |

71 72 73 74 75 76 77
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
78

X
xiaosi 已提交
79
## wifi.scan<sup>9+</sup>
X
xiaosi 已提交
80

X
xiaosi 已提交
81
scan(): void
X
xiaosi 已提交
82 83 84 85 86 87 88

启动WLAN扫描。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.STA

89 90 91 92 93 94 95
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
96

X
xiaosi 已提交
97
## wifi.getScanResults<sup>9+</sup>
X
xiaosi 已提交
98

X
xiaosi 已提交
99
getScanResults(): Promise&lt;Array&lt;WifiScanInfo&gt;&gt;
X
xiaosi 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112

获取扫描结果,使用Promise异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION)

**系统能力:** SystemCapability.Communication.WiFi.STA

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | Promise&lt;&nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;&nbsp;&gt; | Promise对象。返回扫描到的热点列表。 |

113 114 115 116 117 118 119
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
120

X
xiaosi 已提交
121
## wifi.getScanResults<sup>9+</sup>
X
xiaosi 已提交
122

X
xiaosi 已提交
123
getScanResults(callback: AsyncCallback&lt;Array&lt;WifiScanInfo&gt;&gt;): void
X
xiaosi 已提交
124 125 126 127 128 129 130 131 132 133 134 135 136

获取扫描结果,使用callback异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION)

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;&nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;&gt; | 是 | 回调函数。当成功时,err为0,data为扫描到的热点;否则err为非0值,data为空。 |

137 138 139 140 141 142 143 144
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|

X
xiaosi 已提交
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
**示例:**
  ```js
  import wifi from '@ohos.wifi';
  
  wifi.getScanInfos((err, result) => {
      if (err) {
          console.error("get scan info error");
          return;
      }
  
      var len = Object.keys(result).length;
      console.log("wifi received scan info: " + len);
      for (var i = 0; i < len; ++i) {
          console.info("ssid: " + result[i].ssid);
          console.info("bssid: " + result[i].bssid);
          console.info("capabilities: " + result[i].capabilities);
          console.info("securityType: " + result[i].securityType);
          console.info("rssi: " + result[i].rssi);
          console.info("band: " + result[i].band);
          console.info("frequency: " + result[i].frequency);
          console.info("channelWidth: " + result[i].channelWidth);
          console.info("timestamp: " + result[i].timestamp);
      }
  });
  
  wifi.getScanInfos().then(result => {
      var len = Object.keys(result).length;
      console.log("wifi received scan info: " + len);
      for (var i = 0; i < len; ++i) {
          console.info("ssid: " + result[i].ssid);
          console.info("bssid: " + result[i].bssid);
          console.info("capabilities: " + result[i].capabilities);
          console.info("securityType: " + result[i].securityType);
          console.info("rssi: " + result[i].rssi);
          console.info("band: " + result[i].band);
          console.info("frequency: " + result[i].frequency);
          console.info("channelWidth: " + result[i].channelWidth);
          console.info("timestamp: " + result[i].timestamp);
      }
  });
  ```


X
xiaosi 已提交
188
## WifiScanInfo<sup>9+</sup>
X
xiaosi 已提交
189 190 191 192 193 194

WLAN热点信息。

**系统能力:** SystemCapability.Communication.WiFi.STA


X
xiaosi 已提交
195
| **名称** | **类型** | **可读** | **可写** | **说明** |
196
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
197 198 199 200 201 202 203 204
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
| capabilities | string | 是 | 否 | 热点能力。 |
| securityType | [WifiSecurityType](#wifisecuritytype) | 是 | 否 | WLAN加密类型。 |
| rssi | number | 是 | 否 | 热点的信号强度(dBm)。 |
| band | number | 是 | 否 | WLAN接入点的频段。 |
| frequency | number | 是 | 否 | WLAN接入点的频率。 |
| channelWidth | number | 是 | 否 | WLAN接入点的带宽。 |
X
xiaosi 已提交
205 206 207
| centerFrequency0 | number | 是 | 否 | 热点的中心频率。 |
| centerFrequency1 | number | 是 | 否 | 热点的中心频率。如果热点使用两个不重叠的WLAN信道,则返回两个中心频率,分别用centerFrequency0和centerFrequency1表示。 |
| infoElems | Array&lt;[WifiInfoElem](#wifiinfoelem9)&gt; | 是 | 否 | 信息元素。 |
X
xiaosi 已提交
208 209 210
| timestamp | number | 是 | 否 | 时间戳。 |


X
xiaosi 已提交
211
## WifiSecurityType<sup>9+</sup>
X
xiaosi 已提交
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

表示加密类型的枚举。

**系统能力:** SystemCapability.Communication.WiFi.Core


| **名称** | **值** | **说明** |
| -------- | -------- | -------- |
| WIFI_SEC_TYPE_INVALID | 0 | 无效加密类型。 |
| WIFI_SEC_TYPE_OPEN | 1 | 开放加密类型。 |
| WIFI_SEC_TYPE_WEP | 2 | Wired&nbsp;Equivalent&nbsp;Privacy&nbsp;(WEP)加密类型。 |
| WIFI_SEC_TYPE_PSK | 3 | Pre-shared&nbsp;key&nbsp;(PSK)加密类型。 |
| WIFI_SEC_TYPE_SAE | 4 | Simultaneous&nbsp;Authentication&nbsp;of&nbsp;Equals&nbsp;(SAE)加密类型。 |
| WIFI_SEC_TYPE_EAP<sup>9+</sup> | 5 | EAP加密类型。 |
| WIFI_SEC_TYPE_EAP_SUITE_B<sup>9+</sup> | 6 | Suite-B 192位加密类型。 |
| WIFI_SEC_TYPE_OWE<sup>9+</sup> | 7 | 机会性无线加密类型。 |
| WIFI_SEC_TYPE_WAPI_CERT<sup>9+</sup> | 8 | WAPI-Cert加密类型。 |
| WIFI_SEC_TYPE_WAPI_PSK<sup>9+</sup> | 9 | WAPI-PSK加密类型。 |


## WifiInfoElem<sup>9+</sup>

WLAN热点信息。

**系统能力:** SystemCapability.Communication.WiFi.STA


X
xiaosi 已提交
239 240
| **名称** | **类型** | **可读** | **可写** | **说明** |
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
241 242
| eid | number | 是 | 否 | 元素ID。 |
| content | Uint8Array | 是 | 否 | 元素内容。 |
X
xiaosi 已提交
243 244 245 246 247 248 249 250 251


## WifiChannelWidth<sup>9+</sup>

表示带宽类型的枚举。

**系统能力:** SystemCapability.Communication.WiFi.STA


X
xiaosi 已提交
252
| **名称** | **值** | **说明** |
X
xiaosi 已提交
253 254 255 256 257 258 259 260 261
| -------- | -------- | -------- |
| WIDTH_20MHZ | 0 | 20MHZ。 |
| WIDTH_40MHZ | 1 | 40MHZ。 |
| WIDTH_80MHZ | 2 | 80MHZ。 |
| WIDTH_160MHZ | 3 | 160MHZ。 |
| WIDTH_80MHZ_PLUS | 4 | 80MHZ<sup>+</sup>。 |
| WIDTH_INVALID | 5 | 无效值 |


X
xiaosi 已提交
262
## wifi.getScanResultsSync<sup>9+</sup>
X
xiaosi 已提交
263

X
xiaosi 已提交
264
getScanResultsSync(): &nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;
X
xiaosi 已提交
265 266 267 268 269 270 271 272 273 274 275 276 277

获取扫描结果,使用同步方式返回结果。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION)

**系统能力:** SystemCapability.Communication.WiFi.STA

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | &nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt; | 扫描结果数组。 |

278 279 280 281 282 283 284
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
285

X
xiaosi 已提交
286
## wifi.addDeviceConfig<sup>9+</sup>
X
xiaosi 已提交
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309

addDeviceConfig(config: WifiDeviceConfig): Promise&lt;number&gt;

添加网络配置,使用Promise异步回调。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | Promise&lt;number&gt; | Promise对象。返回添加的网络配置ID,如果值为-1表示添加失败。 |

310 311 312 313 314 315 316 317
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|

X
xiaosi 已提交
318
## WifiDeviceConfig<sup>9+</sup>
X
xiaosi 已提交
319 320 321 322 323 324

WLAN配置信息。

**系统能力:** SystemCapability.Communication.WiFi.STA


X
xiaosi 已提交
325
| **名称** | **类型** | **可读** | **可写** | **说明** |
326
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
327 328 329 330 331 332 333 334 335 336
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
| preSharedKey | string | 是 | 否 | 热点的密钥。 |
| isHiddenSsid | boolean | 是 | 否 | 是否是隐藏网络。 |
| securityType | [WifiSecurityType](#wifisecuritytype) | 是 | 否 | 加密类型。 |
| creatorUid | number | 是 | 否 | 创建用户的ID。 <br /> **系统接口:** 此接口为系统接口。 |
| disableReason | number | 是 | 否 | 禁用原因。 <br /> **系统接口:** 此接口为系统接口。 |
| netId | number | 是 | 否 | 分配的网络ID。 <br /> **系统接口:** 此接口为系统接口。 |
| randomMacType | number | 是 | 否 | 随机MAC类型。 <br /> **系统接口:** 此接口为系统接口。 |
| randomMacAddr | string | 是 | 否 | 随机MAC地址。 <br /> **系统接口:** 此接口为系统接口。 |
X
xiaosi 已提交
337 338
| ipType | [IpType](#iptype9) | 是 | 否 | IP地址类型。 <br /> **系统接口:** 此接口为系统接口。 |
| staticIp | [IpConfig](#ipconfig9) | 是 | 否 | 静态IP配置信息。 <br /> **系统接口:** 此接口为系统接口。 |
X
xiaosi 已提交
339 340 341
| eapConfig<sup>9+</sup> | [WifiEapConfig](#wifieapconfig9) | 是 | 否 | 可扩展身份验证协议配置。 <br /> **系统接口:** 此接口为系统接口。 |


X
xiaosi 已提交
342
## IpType<sup>9+</sup>
X
xiaosi 已提交
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357

表示IP类型的枚举。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Communication.WiFi.STA


| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| STATIC | 0 | 静态IP。 |
| DHCP | 1 | 通过DHCP获取。 |
| UNKNOWN | 2 | 未指定。 |


X
xiaosi 已提交
358
## IpConfig<sup>9+</sup>
X
xiaosi 已提交
359 360 361 362 363 364 365

IP配置信息。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Communication.WiFi.STA

X
xiaosi 已提交
366
| **名称** | **类型** | **可读** | **可写** | **说明** |
367
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
368 369
| ipAddress | number | 是 | 否 | IP地址。 |
| gateway | number | 是 | 否 | 网关。 |
X
xiaosi 已提交
370
| prefixLength | number | 是 | 否 | 掩码。 |
X
xiaosi 已提交
371 372 373 374 375 376 377 378 379 380 381 382
| dnsServers | number[] | 是 | 否 | DNS服务器。 |
| domains | Array&lt;string&gt; | 是 | 否 | 域信息。 |


## WifiEapConfig<sup>9+</sup>

可扩展身份验证协议配置信息。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Communication.WiFi.STA

X
xiaosi 已提交
383
| **名称** | **类型** | **可读** | **可写** | **说明** |
X
xiaosi 已提交
384
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
385 386 387 388 389 390 391 392
| eapMethod | [EapMethod](#eapmethod9) | 是 | 否 | EAP认证方式。 |
| phase2Method | [Phase2Method](#phase2method9) | 是 | 否 | 第二阶段认证方式。 |
| identity | string | 是 | 否 | 身份信息。 |
| anonymousIdentity | string | 是 | 否 | 匿名身份。 |
| password | string | 是 | 否 | 密码。 |
| caCertAliases | string | 是 | 否 | CA 证书别名。 |
| caPath | string | 是 | 否 | CA 证书路径。 |
| clientCertAliases | string | 是 | 否 | 客户端证书别名。 |
393 394
| certEntry | Uint8Array | 是 | 是 | CA 证书内容。 |
| certPassword | string | 是 | 是 | CA证书密码。 |
X
xiaosi 已提交
395 396 397 398 399
| altSubjectMatch | string | 是 | 否 | 替代主题匹配。 |
| domainSuffixMatch | string | 是 | 否 | 域后缀匹配。 |
| realm | string | 是 | 否 | 通行证凭证的领域。 |
| plmn | string | 是 | 否 | 公共陆地移动网的直通凭证提供商。 |
| eapSubId | number | 是 | 否 | SIM卡的子ID。 |
X
xiaosi 已提交
400 401 402 403 404 405 406 407 408 409


## EapMethod<sup>9+</sup>

表示EAP认证方式的枚举。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Communication.WiFi.STA

X
xiaosi 已提交
410
| 名称 | 值 | 说明 |
X
xiaosi 已提交
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
| -------- | -------- | -------- |
| EAP_NONE | 0 | 不指定。 |
| EAP_PEAP | 1 | PEAP类型。 |
| EAP_TLS | 2 | TLS类型。 |
| EAP_TTLS | 3 | TTLS类型。 |
| EAP_PWD | 4 | PWD类型。 |
| EAP_SIM | 5 | SIM类型。 |
| EAP_AKA | 6 | AKA类型。 |
| EAP_AKA_PRIME | 7 | AKA Prime类型。 |
| EAP_UNAUTH_TLS | 8 | UNAUTH TLS类型。 |


## Phase2Method<sup>9+</sup>

表示第二阶段认证方式的枚举。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Communication.WiFi.STA

X
xiaosi 已提交
431
| 名称 | 值 | 说明 |
X
xiaosi 已提交
432 433 434 435 436 437 438 439 440 441 442
| -------- | -------- | -------- |
| PHASE2_NONE | 0 | 不指定。 |
| PHASE2_PAP | 1 | PAP类型。 |
| PHASE2_MSCHAP | 2 | MSCHAP类型。 |
| PHASE2_MSCHAPV2 | 3 | MSCHAPV2类型。 |
| PHASE2_GTC | 4 | GTC类型。 |
| PHASE2_SIM | 5 | SIM类型。 |
| PHASE2_AKA | 6 | AKA类型。 |
| PHASE2_AKA_PRIME | 7 | AKA Prime类型。 |


X
xiaosi 已提交
443
## wifi.addDeviceConfig<sup>9+</sup>
X
xiaosi 已提交
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461

addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;number&gt;): void

添加网络配置,使用callback异步回调。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
  | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当操作成功时,err为0,data为添加的网络配置ID,如果data值为-1,表示添加失败。当error为非0,表示处理出现错误。 |

462 463 464 465 466 467 468
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491

## wifi.addCandidateConfig<sup>9+</sup>

addCandidateConfig(config: WifiDeviceConfig): Promise&lt;number&gt;

添加候选网络配置,使用Promise异步回调。

**需要权限:** ohos.permission.SET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | Promise&lt;number&gt; | Promise对象。表示网络配置ID。 |

492 493 494 495 496 497 498
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516

## wifi.addCandidateConfig<sup>9+</sup>

addCandidateConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;number&gt;): void

添加候选网络配置,使用callback异步回调。

**需要权限:** ohos.permission.SET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
  | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当操作成功时,err为0,data为添加的网络配置ID,如果data值为-1,表示添加失败。如果操作出现错误,err为非0值。 |

517 518 519 520 521 522 523
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546

## wifi.removeCandidateConfig<sup>9+</sup>

removeCandidateConfig(networkId: number): Promise&lt;void&gt;

移除候选网络配置,使用Promise异步回调。

**需要权限:** ohos.permission.SET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | networkId | number | 是 | 网络配置ID。 |

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise对象。 |

547 548 549 550 551 552 553
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571

## wifi.removeCandidateConfig<sup>9+</sup>

removeCandidateConfig(networkId: number, callback: AsyncCallback&lt;void&gt;): void

移除候选网络配置,使用callback异步回调。

**需要权限:** ohos.permission.SET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | networkId | number | 是 | 网络配置ID。 |
  | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当操作成功时,err为0。如果error为非0,表示处理出现错误。 |

572 573 574 575 576 577 578
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595

## wifi.getCandidateConfigs<sup>9+</sup>

getCandidateConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;

获取候选网络配置。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.STA

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt; | 候选网络配置数组。 |

596 597 598 599 600 601 602
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619

## wifi.connectToCandidateConfig<sup>9+</sup>

connectToCandidateConfig(networkId: number): void

连接到候选网络。

**需要权限:** ohos.permission.SET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | networkId | number | 是 | 候选网络配置的ID。 |

620 621 622 623 624 625 626 627
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
| 2501001  | Wifi is closed.|
X
xiaosi 已提交
628

X
xiaosi 已提交
629
## wifi.connectToNetwork<sup>9+</sup>
X
xiaosi 已提交
630

X
xiaosi 已提交
631
connectToNetwork(networkId: number): void
X
xiaosi 已提交
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646

连接到指定网络。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | networkId | number | 是 | 待连接的网络配置ID。 |

647
**错误码:**
X
xiaosi 已提交
648

649
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
650

651 652 653 654
| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
| 2501001  | Wifi is closed.|
X
xiaosi 已提交
655

X
xiaosi 已提交
656
## wifi.connectToDevice<sup>9+</sup>
X
xiaosi 已提交
657

X
xiaosi 已提交
658
connectToDevice(config: WifiDeviceConfig): void
X
xiaosi 已提交
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674

连接到指定网络。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG 和 ohos.permissio.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:**
  SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |

675
**错误码:**
X
xiaosi 已提交
676

677
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
678

679 680 681 682
| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
| 2501001  | Wifi is closed.|
X
xiaosi 已提交
683

X
xiaosi 已提交
684
## wifi.disconnect<sup>9+</sup>
X
xiaosi 已提交
685

X
xiaosi 已提交
686
disconnect(): void
X
xiaosi 已提交
687 688 689 690 691 692 693 694 695 696

断开连接的网络。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:**
  SystemCapability.Communication.WiFi.STA

697
**错误码:**
X
xiaosi 已提交
698

699
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
700

701 702 703
| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
704

X
xiaosi 已提交
705
## wifi.getSignalLevel<sup>9+</sup>
X
xiaosi 已提交
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727

getSignalLevel(rssi: number, band: number): number

查询WLAN信号强度。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | rssi | number | 是 | 热点的信号强度(dBm)。 |
  | band | number | 是 | WLAN接入点的频段。 |

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | number | 信号强度,取值范围为[0,&nbsp;4]。 |

728 729 730 731 732 733 734
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
735

X
xiaosi 已提交
736
## wifi.getLinkedInfo<sup>9+</sup>
X
xiaosi 已提交
737 738 739 740 741

getLinkedInfo(): Promise&lt;WifiLinkedInfo&gt;

获取WLAN连接信息,使用Promise异步回调。

742
**需要权限:** ohos.permission.GET_WIFI_INFO 。 获取 macAddress 还需申请ohos.permission.GET_WIFI_LOCAL_MAC权限,无该权限时,macAddress 返回空字符串。
X
xiaosi 已提交
743 744 745 746 747 748 749 750 751

**系统能力:** SystemCapability.Communication.WiFi.STA

**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
  | Promise&lt;[WifiLinkedInfo](#wifilinkedinfo)&gt; | Promise对象。表示WLAN连接信息。 |

752 753 754 755 756 757 758 759
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
| 2501001  | Wifi is closed.|
X
xiaosi 已提交
760

X
xiaosi 已提交
761
## wifi.getLinkedInfo<sup>9+</sup>
X
xiaosi 已提交
762 763 764 765 766

getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void

获取WLAN连接信息,使用callback异步回调。

767
**需要权限:** ohos.permission.GET_WIFI_INFO 。 获取 macAddress 还需申请ohos.permission.GET_WIFI_LOCAL_MAC权限,无该权限时,macAddress 返回空字符串。
X
xiaosi 已提交
768 769 770 771 772 773 774 775 776

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;[WifiLinkedInfo](#wifilinkedinfo)&gt; | 是 | 回调函数。当获取成功时,err为0,data表示WLAN连接信息。如果error为非0,表示处理出现错误。 |

777 778 779 780 781 782 783 784 785
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
| 2501001  | Wifi is closed.|

X
xiaosi 已提交
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
**示例:**
  ```js
  import wifi from '@ohos.wifi';
  
  wifi.getLinkedInfo((err, data) => {
      if (err) {
          console.error("get linked info error");
          return;
      }
      console.info("get wifi linked info: " + JSON.stringify(data));
  });
  
  wifi.getLinkedInfo().then(data => {
      console.info("get wifi linked info: " + JSON.stringify(data));
  }).catch(error => {
      console.info("get linked info error");
  });
  ```


X
xiaosi 已提交
806
## WifiLinkedInfo<sup>9+</sup>
X
xiaosi 已提交
807 808 809 810 811

提供WLAN连接的相关信息。

**系统能力:** SystemCapability.Communication.WiFi.STA

X
xiaosi 已提交
812
| 名称 | 类型 | 可读 | 可写 | 说明 |
813
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
| networkId | number | 是 | 否 | 网络配置ID。 <br /> **系统接口:** 此接口为系统接口。 |
| rssi | number | 是 | 否 | 热点的信号强度(dBm)。 |
| band | number | 是 | 否 | WLAN接入点的频段。 |
| linkSpeed | number | 是 | 否 | WLAN接入点的速度。 |
| frequency | number | 是 | 否 | WLAN接入点的频率。 |
| isHidden | boolean | 是 | 否 | WLAN接入点是否是隐藏网络。 |
| isRestricted | boolean | 是 | 否 | WLAN接入点是否限制数据量。 |
| chload | number | 是 | 否 | 连接负载,值越大表示负载约高。 <br /> **系统接口:** 此接口为系统接口。 |
| snr | number | 是 | 否 | 信噪比。 <br /> **系统接口:** 此接口为系统接口。 |
| macType<sup>9+</sup> | number | 是 | 否 | MAC地址类型。 |
| macAddress | string | 是 | 否 | 设备的MAC地址。 |
| ipAddress | number | 是 | 否 | WLAN连接的IP地址。 |
| suppState | [SuppState](#suppstate) | 是 | 否 | 请求状态。 <br /> **系统接口:** 此接口为系统接口。 |
| connState | [ConnState](#connstate) | 是 | 否 | WLAN连接状态。 |


X
xiaosi 已提交
832
## ConnState<sup>9+</sup>
X
xiaosi 已提交
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849

表示WLAN连接状态的枚举。

**系统能力:** SystemCapability.Communication.WiFi.STA

| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| SCANNING | 0 | 设备正在搜索可用的AP。 |
| CONNECTING | 1 | 正在建立WLAN连接。 |
| AUTHENTICATING | 2 | WLAN连接正在认证中。 |
| OBTAINING_IPADDR | 3 | 正在获取WLAN连接的IP地址。 |
| CONNECTED | 4 | WLAN连接已建立。 |
| DISCONNECTING | 5 | WLAN连接正在断开。 |
| DISCONNECTED | 6 | WLAN连接已断开。 |
| UNKNOWN | 7 | WLAN连接建立失败。 |


X
xiaosi 已提交
850
## SuppState<sup>9+</sup>
X
xiaosi 已提交
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873

表示请求状态的枚举。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Communication.WiFi.STA

| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| DISCONNECTED | 0 | 已断开。 |
| INTERFACE_DISABLED | 1 | 接口禁用。 |
| INACTIVE | 2 | 未激活。 |
| SCANNING | 3 | 扫描中。 |
| AUTHENTICATING | 4 | 认证中。 |
| ASSOCIATING | 5 | 关联中。 |
| ASSOCIATED | 6 | 已关联。 |
| FOUR_WAY_HANDSHAKE | 7 | 四次握手。 |
| GROUP_HANDSHAKE | 8 | 组握手。 |
| COMPLETED | 9 | 所有认证已完成。 |
| UNINITIALIZED | 10 | 连接建立失败。 |
| INVALID | 11 | 无效值。 |


X
xiaosi 已提交
874
## wifi.isConnected<sup>9+</sup>
X
xiaosi 已提交
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889

isConnected(): boolean

查询WLAN是否已连接。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:已连接,&nbsp;false:未连接。 |

890 891 892 893 894 895 896
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
897

X
xiaosi 已提交
898
## wifi.getSupportedFeatures<sup>9+</sup>
X
xiaosi 已提交
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930

getSupportedFeatures(): number

查询设备支持的特性。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.Core

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | number | 支持的特性值。 |

**特性ID值枚举:**

| 枚举值 | 说明 |
| -------- | -------- |
| 0x0001 | 基础结构模式特性。 |
| 0x0002 | 5&nbsp;GHz带宽特性。 |
| 0x0004 | GAS/ANQP特性。 |
| 0x0008 | Wifi-Direct特性。 |
| 0x0010 | Soft&nbsp;AP特性。 |
| 0x0040 | Wi-Fi&nbsp;AWare组网特性。 |
| 0x8000 | AP&nbsp;STA共存特性。 |
| 0x8000000 | WPA3-Personal&nbsp;SAE特性。 |
| 0x10000000 | WPA3-Enterprise&nbsp;Suite-B |
| 0x20000000 | 增强开放特性。 |

931 932 933 934 935 936 937
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2401000  | Operation failed.|
X
xiaosi 已提交
938

X
xiaosi 已提交
939
## wifi.isFeatureSupported<sup>9+</sup>
X
xiaosi 已提交
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961

isFeatureSupported(featureId: number): boolean

判断设备是否支持相关WLAN特性。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.Core

**参数:**


  | **参数名** | **类型** | 必填 | **说明** |
  | -------- | -------- | -------- | -------- |
  | featureId | number | 是 | 特性ID值。 |

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:支持,&nbsp;false:不支持。 |

962 963 964 965 966 967 968
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2401000  | Operation failed.|
X
xiaosi 已提交
969

X
xiaosi 已提交
970
## wifi.getDeviceMacAddress<sup>9+</sup>
X
xiaosi 已提交
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987

getDeviceMacAddress(): string[]

获取设备的MAC地址。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.GET_WIFI_LOCAL_MAC 和 ohos.permission.GET_WIFI_INFO,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.STA

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | string[] | MAC地址。 |

988 989 990 991 992 993 994
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
995

X
xiaosi 已提交
996
## wifi.getIpInfo<sup>9+</sup>
X
xiaosi 已提交
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009

getIpInfo(): IpInfo

获取IP信息。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
X
xiaosi 已提交
1010
  | [IpInfo](#ipinfo9) | IP信息。 |
X
xiaosi 已提交
1011

1012 1013 1014 1015 1016 1017 1018
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
1019

X
xiaosi 已提交
1020
## IpInfo<sup>9+</sup>
X
xiaosi 已提交
1021 1022 1023 1024 1025

IP信息。

**系统能力:** SystemCapability.Communication.WiFi.STA

X
xiaosi 已提交
1026
| **名称** | **类型** | **可读** | **可写** | **说明** |
1027
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1028 1029 1030 1031 1032 1033 1034 1035 1036
| ipAddress | number | 是 | 否 | IP地址。 |
| gateway | number | 是 | 否 | 网关。 |
| netmask | number | 是 | 否 | 掩码。 |
| primaryDns | number | 是 | 否 | 主DNS服务器IP地址。 |
| secondDns | number | 是 | 否 | 备DNS服务器IP地址。 |
| serverIp | number | 是 | 否 | DHCP服务端IP地址。 |
| leaseDuration | number | 是 | 否 | IP地址租用时长。 |


X
xiaosi 已提交
1037
## wifi.getCountryCode<sup>9+</sup>
X
xiaosi 已提交
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052

getCountryCode(): string

获取国家码信息。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.Core

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | string | 国家码。 |

1053 1054 1055 1056 1057 1058 1059
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2401000  | Operation failed.|
X
xiaosi 已提交
1060

X
xiaosi 已提交
1061
## wifi.reassociate<sup>9+</sup>
X
xiaosi 已提交
1062

X
xiaosi 已提交
1063
reassociate(): void
X
xiaosi 已提交
1064 1065 1066 1067 1068 1069 1070 1071 1072

重新关联网络。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.STA

1073
**错误码:**
X
xiaosi 已提交
1074

1075
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1076

1077 1078 1079 1080
| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
| 2501001  | Wifi is closed.|
X
xiaosi 已提交
1081

X
xiaosi 已提交
1082
## wifi.reconnect<sup>9+</sup>
X
xiaosi 已提交
1083

X
xiaosi 已提交
1084
reconnect(): void
X
xiaosi 已提交
1085 1086 1087 1088 1089 1090 1091 1092 1093

重新连接网络。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.STA

1094
**错误码:**
X
xiaosi 已提交
1095

1096
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1097

1098 1099 1100 1101
| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
| 2501001  | Wifi is closed.|
X
xiaosi 已提交
1102

X
xiaosi 已提交
1103
## wifi.getDeviceConfigs<sup>9+</sup>
X
xiaosi 已提交
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120

getDeviceConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;

获取网络配置。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.GET_WIFI_CONFIG

**系统能力:** SystemCapability.Communication.WiFi.STA

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt; | 网络配置信息的数组。 |

1121 1122 1123 1124 1125 1126 1127
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
1128

X
xiaosi 已提交
1129
## wifi.updateNetwork<sup>9+</sup>
X
xiaosi 已提交
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152

updateNetwork(config: WifiDeviceConfig): number

更新网络配置。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
  | number | 返回更新的网络配置ID,如果值为-1表示更新失败。 |

1153 1154 1155 1156 1157 1158 1159
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
1160

X
xiaosi 已提交
1161
## wifi.disableNetwork<sup>9+</sup>
X
xiaosi 已提交
1162

X
xiaosi 已提交
1163
disableNetwork(netId: number): void
X
xiaosi 已提交
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178

去使能网络配置。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | netId | number | 是 | 网络配置ID。 |

1179
**错误码:**
X
xiaosi 已提交
1180

1181
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1182

1183 1184 1185
| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
1186

X
xiaosi 已提交
1187
## wifi.removeAllNetwork<sup>9+</sup>
X
xiaosi 已提交
1188

X
xiaosi 已提交
1189
removeAllNetwork(): void
X
xiaosi 已提交
1190 1191 1192 1193 1194 1195 1196 1197 1198

移除所有网络配置。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.STA

1199
**错误码:**
X
xiaosi 已提交
1200

1201
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1202

1203 1204 1205
| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
1206

X
xiaosi 已提交
1207
## wifi.removeDevice<sup>9+</sup>
X
xiaosi 已提交
1208

X
xiaosi 已提交
1209
removeDevice(id: number): void
X
xiaosi 已提交
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224

移除指定的网络配置。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | id | number | 是 | 网络配置ID。 |

1225
**错误码:**
X
xiaosi 已提交
1226

1227
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1228

1229 1230 1231
| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
1232

X
xiaosi 已提交
1233
## wifi.enableHotspot<sup>9+</sup>
X
xiaosi 已提交
1234

X
xiaosi 已提交
1235
enableHotspot(): void
X
xiaosi 已提交
1236 1237 1238 1239 1240 1241 1242 1243 1244

使能热点。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

1245
**错误码:**
X
xiaosi 已提交
1246

1247
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1248

1249 1250 1251
| **类型** | **说明** |
  | -------- | -------- |
| 2601000  | Operation failed.|
X
xiaosi 已提交
1252

X
xiaosi 已提交
1253
## wifi.disableHotspot<sup>9+</sup>
X
xiaosi 已提交
1254

X
xiaosi 已提交
1255
disableHotspot(): void
X
xiaosi 已提交
1256 1257 1258 1259 1260 1261 1262 1263 1264

去使能热点。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

1265
**错误码:**
X
xiaosi 已提交
1266

1267
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1268

1269 1270 1271
| **类型** | **说明** |
  | -------- | -------- |
| 2601000  | Operation failed.|
X
xiaosi 已提交
1272

X
xiaosi 已提交
1273
## wifi.isHotspotDualBandSupported<sup>9+</sup>
X
xiaosi 已提交
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288

isHotspotDualBandSupported(): boolean

热点是否支持双频。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
1289
  | boolean | true:支持,&nbsp;false:不支持.|
X
xiaosi 已提交
1290

1291 1292 1293 1294 1295 1296 1297
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2601000  | Operation failed.|
X
xiaosi 已提交
1298

X
xiaosi 已提交
1299
## wifi.isHotspotActive<sup>9+</sup>
X
xiaosi 已提交
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314

isHotspotActive(): boolean

热点是否已使能。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
1315 1316 1317
  | boolean | true:已使能,&nbsp;false:未使能.|

**错误码:**
X
xiaosi 已提交
1318

1319 1320 1321 1322 1323
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2601000  | Operation failed.|
X
xiaosi 已提交
1324

X
xiaosi 已提交
1325
## wifi.setHotspotConfig<sup>9+</sup>
X
xiaosi 已提交
1326

X
xiaosi 已提交
1327
setHotspotConfig(config: HotspotConfig): void
X
xiaosi 已提交
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340

设置热点配置信息。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1341
  | config | [HotspotConfig](#hotspotconfig9) | 是 | 热点配置信息。 |
X
xiaosi 已提交
1342

1343
**错误码:**
X
xiaosi 已提交
1344

1345
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1346

1347 1348 1349
| **类型** | **说明** |
  | -------- | -------- |
| 2601000  | Operation failed.|
X
xiaosi 已提交
1350

X
xiaosi 已提交
1351
## HotspotConfig<sup>9+</sup>
X
xiaosi 已提交
1352 1353 1354 1355 1356 1357 1358

热点配置信息。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

X
xiaosi 已提交
1359
| **名称** | **类型** | **可读** | **可写** | **说明** |
1360
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1361 1362 1363 1364 1365 1366 1367
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| securityType | [WifiSecurityType](#wifisecuritytype) | 是 | 否 | 加密类型。 |
| band | number | 是 | 否 | 热点的带宽。1: 2.4G, 2: 5G, 3: 双模频段 |
| preSharedKey | string | 是 | 否 | 热点的密钥。 |
| maxConn | number | 是 | 否 | 最大设备连接数。 |


X
xiaosi 已提交
1368
## wifi.getHotspotConfig<sup>9+</sup>
X
xiaosi 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383

getHotspotConfig(): HotspotConfig

获取热点配置信息。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
X
xiaosi 已提交
1384
  | [HotspotConfig](#hotspotconfig9) | 热点的配置信息。 |
X
xiaosi 已提交
1385

1386 1387 1388 1389 1390 1391 1392
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2601000  | Operation failed.|
X
xiaosi 已提交
1393

X
xiaosi 已提交
1394
## wifi.getStations<sup>9+</sup>
X
xiaosi 已提交
1395

X
xiaosi 已提交
1396
getStations(): &nbsp;Array&lt;[StationInfo](#stationinfo9)&gt;
X
xiaosi 已提交
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409

获取连接的设备。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

**返回值:**

  | **类型** | **说明** |
  | -------- | -------- |
X
xiaosi 已提交
1410
  | &nbsp;Array&lt;[StationInfo](#stationinfo9)&gt; | 连接的设备数组。 |
X
xiaosi 已提交
1411

1412 1413 1414 1415 1416 1417 1418
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2601000  | Operation failed.|
X
xiaosi 已提交
1419

X
xiaosi 已提交
1420
## StationInfo<sup>9+</sup>
X
xiaosi 已提交
1421 1422 1423 1424 1425 1426 1427

接入的设备信息。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

X
xiaosi 已提交
1428
| **名称** | **类型** | **可读** | **可写** | **说明** |
1429
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1430 1431 1432 1433 1434
| name | string | 是 | 否 | 设备名称。 |
| macAddress | string | 是 | 否 | MAC地址。 |
| ipAddress | string | 是 | 否 | IP地址。 |


X
xiaosi 已提交
1435
## wifi.getP2pLinkedInfo<sup>9+</sup>
X
xiaosi 已提交
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448

getP2pLinkedInfo(): Promise&lt;WifiP2pLinkedInfo&gt;

获取P2P连接信息,使用Promise异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
X
xiaosi 已提交
1449
  | Promise&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo9)&gt; | Promise对象。表示P2P连接信息。 |
X
xiaosi 已提交
1450

1451
**错误码:**
X
xiaosi 已提交
1452

1453 1454 1455 1456 1457
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1458

X
xiaosi 已提交
1459
## WifiP2pLinkedInfo<sup>9+</sup>
X
xiaosi 已提交
1460 1461 1462 1463 1464

提供WLAN连接的相关信息。

**系统能力:** SystemCapability.Communication.WiFi.P2P

X
xiaosi 已提交
1465
| 名称 | 类型 | 可读 | 可写 | 说明 |
1466
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1467
| connectState | [P2pConnectState](#p2pconnectstate9) | 是 | 否 | P2P连接状态。 |
X
xiaosi 已提交
1468 1469 1470 1471
| isGroupOwner | boolean | 是 | 否 | 是否是群主。 |
| groupOwnerAddr | string | 是 | 否 | 群组MAC地址。 


X
xiaosi 已提交
1472
## P2pConnectState<sup>9+</sup>
X
xiaosi 已提交
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483

表示P2P连接状态的枚举。

**系统能力:** SystemCapability.Communication.WiFi.P2P

| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| DISCONNECTED | 0 | 断开状态。 |
| CONNECTED | 1 | 连接状态。 |


X
xiaosi 已提交
1484
## wifi.getP2pLinkedInfo<sup>9+</sup>
X
xiaosi 已提交
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497

getP2pLinkedInfo(callback: AsyncCallback&lt;WifiP2pLinkedInfo&gt;): void

获取P2P连接信息,使用callback异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1498
  | callback | AsyncCallback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo9)&gt; | 是 | 回调函数。当操作成功时,err为0,data表示P2P连接信息。如果error为非0,表示处理出现错误。 |
X
xiaosi 已提交
1499 1500


X
xiaosi 已提交
1501
## wifi.getCurrentGroup<sup>9+</sup>
X
xiaosi 已提交
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514

getCurrentGroup(): Promise&lt;WifiP2pGroupInfo&gt;

获取P2P当前组信息,使用Promise异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
X
xiaosi 已提交
1515
  | Promise&lt;[WifiP2pGroupInfo](#wifip2pgroupinfo9)&gt; | Promise对象。表示当前组信息。 |
X
xiaosi 已提交
1516

1517 1518 1519 1520 1521 1522 1523
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1524

X
xiaosi 已提交
1525
## wifi.getCurrentGroup<sup>9+</sup>
X
xiaosi 已提交
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538

getCurrentGroup(callback: AsyncCallback&lt;WifiP2pGroupInfo&gt;): void

获取P2P当前组信息,使用callback异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1539
  | callback | AsyncCallback&lt;[WifiP2pGroupInfo](#wifip2pgroupinfo9)&gt; | 是 | 回调函数。当操作成功时,err为0,data表示当前组信息。如果error为非0,表示处理出现错误。 |
X
xiaosi 已提交
1540

1541 1542 1543 1544 1545 1546 1547
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1548

X
xiaosi 已提交
1549
## wifi.getP2pPeerDevices<sup>9+</sup>
X
xiaosi 已提交
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562

getP2pPeerDevices(): Promise&lt;WifiP2pDevice[]&gt;

获取P2P对端设备列表信息,使用Promise异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
X
xiaosi 已提交
1563
  | Promise&lt;[WifiP2pDevice[]](#wifip2pdevice9)&gt; | Promise对象。表示对端设备列表信息。 |
X
xiaosi 已提交
1564

1565 1566 1567 1568 1569 1570 1571
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1572

X
xiaosi 已提交
1573
## wifi.getP2pPeerDevices<sup>9+</sup>
X
xiaosi 已提交
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586

getP2pPeerDevices(callback: AsyncCallback&lt;WifiP2pDevice[]&gt;): void

获取P2P对端设备列表信息,使用callback异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1587
  | callback | AsyncCallback&lt;[WifiP2pDevice[]](#wifip2pdevice9)&gt; | 是 | 回调函数。当操作成功时,err为0,data表示对端设备列表信息。如果error为非0,表示处理出现错误。 |
X
xiaosi 已提交
1588

1589 1590 1591 1592 1593 1594 1595
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1596

X
xiaosi 已提交
1597
## WifiP2pDevice<sup>9+</sup>
X
xiaosi 已提交
1598 1599 1600 1601 1602

表示P2P设备信息。

**系统能力:** SystemCapability.Communication.WiFi.P2P

X
xiaosi 已提交
1603
| 名称 | 类型 | 可读 | 可写 | 说明 |
1604
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1605 1606 1607
| deviceName | string | 是 | 否 | 设备名称。 |
| deviceAddress | string | 是 | 否 | 设备MAC地址。 |
| primaryDeviceType | string | 是 | 否 | 主设备类型。 |
X
xiaosi 已提交
1608
| deviceStatus | [P2pDeviceStatus](#p2pdevicestatus9) | 是 | 否 | 设备状态。 |
X
xiaosi 已提交
1609
| groupCapabilities | number | 是 | 否 | 群组能力。 |
X
xiaosi 已提交
1610 1611


X
xiaosi 已提交
1612
## P2pDeviceStatus<sup>9+</sup>
X
xiaosi 已提交
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640

表示设备状态的枚举。

**系统能力:** SystemCapability.Communication.WiFi.P2P

| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| CONNECTED | 0 | 连接状态。 |
| INVITED | 1 | 邀请状态。 |
| FAILED | 2 | 失败状态。 |
| AVAILABLE | 3 | 可用状态。 |
| UNAVAILABLE | 4 | 不可用状态。 |


## wifi.getP2pLocalDevice<sup>9+</sup>

getP2pLocalDevice(): Promise&lt;WifiP2pDevice&gt;

获取P2P本端设备信息,使用Promise异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

**系统能力:** SystemCapability.Communication.WiFi.P2P

**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
X
xiaosi 已提交
1641
  | Promise&lt;[WifiP2pDevice](#wifip2pdevice9)&gt; | Promise对象。表示本端设备信息。 |
X
xiaosi 已提交
1642

1643 1644 1645 1646 1647 1648 1649
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664

## wifi.getP2pLocalDevice<sup>9+</sup>

getP2pLocalDevice(callback: AsyncCallback&lt;WifiP2pDevice&gt;): void

获取P2P本端设备信息,使用callback异步回调。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1665
  | callback | AsyncCallback&lt;[WifiP2pDevice](#wifip2pdevice9)&gt; | 是 | 回调函数。当操作成功时,err为0,data表示本端设备信息。如果error为非0,表示处理出现错误。 |
X
xiaosi 已提交
1666 1667


X
xiaosi 已提交
1668
## wifi.createGroup<sup>9+</sup>
X
xiaosi 已提交
1669

X
xiaosi 已提交
1670
createGroup(config: WifiP2PConfig): void
X
xiaosi 已提交
1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681

创建群组。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | 必填 | **说明** |
  | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1682
  | config | [WifiP2PConfig](#wifip2pconfig9) | 是 | 群组配置信息。 |
X
xiaosi 已提交
1683

1684
**错误码:**
X
xiaosi 已提交
1685

1686
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1687

1688 1689 1690
| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1691

X
xiaosi 已提交
1692
## WifiP2PConfig<sup>9+</sup>
X
xiaosi 已提交
1693 1694 1695 1696 1697

表示P2P配置信息。

**系统能力:** SystemCapability.Communication.WiFi.P2P

X
xiaosi 已提交
1698
| 名称 | 类型 | 可读 | 可写 | 说明 |
1699
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1700 1701 1702 1703
| deviceAddress | string | 是 | 否 | 设备地址。 |
| netId | number | 是 | 否 | 网络ID。创建群组时-1表示创建临时组,-2表示创建永久组。 |
| passphrase | string | 是 | 否 | 群组密钥。 |
| groupName | string | 是 | 否 | 群组名称。 |
X
xiaosi 已提交
1704
| goBand | [GroupOwnerBand](#groupownerband9) | 是 | 否 | 群组带宽。 |
X
xiaosi 已提交
1705 1706


X
xiaosi 已提交
1707
## GroupOwnerBand<sup>9+</sup>
X
xiaosi 已提交
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719

表示群组带宽的枚举。

**系统能力:** SystemCapability.Communication.WiFi.P2P

| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| GO_BAND_AUTO | 0 | 自动模式。 |
| GO_BAND_2GHZ | 1 | 2GHZ。 |
| GO_BAND_5GHZ | 2 | 5GHZ。 |


X
xiaosi 已提交
1720
## wifi.removeGroup<sup>9+</sup>
X
xiaosi 已提交
1721

X
xiaosi 已提交
1722
removeGroup(): void
X
xiaosi 已提交
1723 1724 1725 1726 1727 1728 1729

移除群组。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

1730
**错误码:**
X
xiaosi 已提交
1731

1732
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1733

1734 1735 1736
| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1737

X
xiaosi 已提交
1738
## wifi.p2pConnect<sup>9+</sup>
X
xiaosi 已提交
1739

X
xiaosi 已提交
1740
p2pConnect(config: WifiP2PConfig): void
X
xiaosi 已提交
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752

执行P2P连接。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**


  | **参数名** | **类型** | 必填 | **说明** |
  | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1753
  | config | [WifiP2PConfig](#wifip2pconfig9) | 是 | 连接配置信息。 |
X
xiaosi 已提交
1754

1755
**错误码:**
X
xiaosi 已提交
1756

1757
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1758

1759 1760 1761
| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829

**示例:**
  ```js
  import wifi from '@ohos.wifi';
  
  var recvP2pConnectionChangeFunc = result => {
      console.info("p2p connection change receive event: " + JSON.stringify(result));
      wifi.getP2pLinkedInfo((err, data) => {
          if (err) {
              console.error('failed to get getP2pLinkedInfo: ' + JSON.stringify(err));
              return;
          }
          console.info("get getP2pLinkedInfo: " + JSON.stringify(data));
      });
  }
  wifi.on("p2pConnectionChange", recvP2pConnectionChangeFunc);
  
  var recvP2pDeviceChangeFunc = result => {
      console.info("p2p device change receive event: " + JSON.stringify(result));
  }
  wifi.on("p2pDeviceChange", recvP2pDeviceChangeFunc);
  
  var recvP2pPeerDeviceChangeFunc = result => {
      console.info("p2p peer device change receive event: " + JSON.stringify(result));
      wifi.getP2pPeerDevices((err, data) => {
          if (err) {
              console.error('failed to get peer devices: ' + JSON.stringify(err));
              return;
          }
          console.info("get peer devices: " + JSON.stringify(data));
          var len = Object.keys(data).length;
          for (var i = 0; i < len; ++i) {
              if (data[i].deviceName === "my_test_device") {
                  console.info("p2p connect to test device: " + data[i].deviceAddress);
                  var config = {
                      "deviceAddress":data[i].deviceAddress,
                      "netId":-2,
                      "passphrase":"",
                      "groupName":"",
                      "goBand":0,
                  }
                  wifi.p2pConnect(config);
              }
          }
      });
  }
  wifi.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);
  
  var recvP2pPersistentGroupChangeFunc = () => {
      console.info("p2p persistent group change receive event");
  
      wifi.getCurrentGroup((err, data) => {
          if (err) {
              console.error('failed to get current group: ' + JSON.stringify(err));
              return;
          }
          console.info("get current group: " + JSON.stringify(data));
      });
  }
  wifi.on("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);
  
  setTimeout(function() {wifi.off("p2pConnectionChange", recvP2pConnectionChangeFunc);}, 125 * 1000);
  setTimeout(function() {wifi.off("p2pDeviceChange", recvP2pDeviceChangeFunc);}, 125 * 1000);
  setTimeout(function() {wifi.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);}, 125 * 1000);
  setTimeout(function() {wifi.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);}, 125 * 1000);
  console.info("start discover devices -> " + wifi.startDiscoverDevices());
  ```

X
xiaosi 已提交
1830
## wifi.p2pCancelConnect<sup>9+</sup>
X
xiaosi 已提交
1831

X
xiaosi 已提交
1832
p2pCancelConnect(): void
X
xiaosi 已提交
1833 1834 1835 1836 1837 1838 1839

取消P2P连接。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

1840
**错误码:**
X
xiaosi 已提交
1841

1842
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1843

1844 1845 1846
| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1847

X
xiaosi 已提交
1848
## wifi.startDiscoverDevices<sup>9+</sup>
X
xiaosi 已提交
1849

X
xiaosi 已提交
1850
startDiscoverDevices(): void
X
xiaosi 已提交
1851 1852 1853 1854 1855 1856 1857

开始发现设备。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

1858
**错误码:**
X
xiaosi 已提交
1859

1860
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1861

1862 1863 1864
| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1865

X
xiaosi 已提交
1866
## wifi.stopDiscoverDevices<sup>9+</sup>
X
xiaosi 已提交
1867

X
xiaosi 已提交
1868
stopDiscoverDevices(): void
X
xiaosi 已提交
1869 1870 1871 1872 1873 1874 1875

停止发现设备。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

1876
**错误码:**
X
xiaosi 已提交
1877

1878
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1879

1880 1881 1882
| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1883

X
xiaosi 已提交
1884
## wifi.deletePersistentGroup<sup>9+</sup>
X
xiaosi 已提交
1885

X
xiaosi 已提交
1886
deletePersistentGroup(netId: number): void
X
xiaosi 已提交
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902

删除永久组。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**


  | **参数名** | **类型** | 必填 | **说明** |
  | -------- | -------- | -------- | -------- |
  | netId | number | 是 | 组的ID。 |

1903
**错误码:**
X
xiaosi 已提交
1904

1905
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
1906

1907 1908 1909
| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926

## wifi.getP2pGroups<sup>9+</sup>

getP2pGroups(): Promise&lt;Array&lt;WifiP2pGroupInfo&gt;&gt;

获取创建的所有P2P群组信息,使用Promise异步回调。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
X
xiaosi 已提交
1927
  | Promise&lt;&nbsp;Array&lt;[WifiP2pGroupInfo](#wifip2pgroupinfo9)&gt;&nbsp;&gt; | Promise对象。表示所有群组信息。 |
X
xiaosi 已提交
1928

1929 1930 1931 1932 1933 1934 1935
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1936

X
xiaosi 已提交
1937
## WifiP2pGroupInfo<sup>9+</sup>
X
xiaosi 已提交
1938 1939 1940 1941 1942

表示P2P群组相关信息。

**系统能力:** SystemCapability.Communication.WiFi.P2P

X
xiaosi 已提交
1943
| 名称 | 类型 | 可读 | 可写 | 说明 |
1944
| -------- | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1945
| isP2pGo | boolean | 是 | 否 | 是否是群主。 |
X
xiaosi 已提交
1946
| ownerInfo | [WifiP2pDevice](#wifip2pdevice9) | 是 | 否 | 群组的设备信息。 |
X
xiaosi 已提交
1947 1948 1949 1950 1951
| passphrase | string | 是 | 否 | 群组密钥。 |
| interface | string | 是 | 否 | 接口名称。 |
| groupName | string | 是 | 否 | 群组名称。 |
| networkId | number | 是 | 否 | 网络ID。 |
| frequency | number | 是 | 否 | 群组的频率。 |
X
xiaosi 已提交
1952
| clientDevices | [WifiP2pDevice[]](#wifip2pdevice9) | 是 | 否 | 接入的设备列表信息。 |
X
xiaosi 已提交
1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971
| goIpAddress | string | 是 | 否 | 群组IP地址。 |


## wifi.getP2pGroups<sup>9+</sup>

getP2pGroups(callback: AsyncCallback&lt;Array&lt;WifiP2pGroupInfo&gt;&gt;): void

获取创建的所有P2P群组信息,使用callback方式作为异步方法。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
X
xiaosi 已提交
1972
  | callback | AsyncCallback&lt;&nbsp;Array&lt;[WifiP2pGroupInfo](#wifip2pgroupinfo9)&gt;&gt; | 是 | 回调函数。当操作成功时,err为0,data表示所有群组信息。如果error为非0,表示处理出现错误。 |
X
xiaosi 已提交
1973

1974 1975 1976 1977 1978 1979 1980
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
1981

X
xiaosi 已提交
1982
## wifi.setDeviceName<sup>9+</sup>
X
xiaosi 已提交
1983

X
xiaosi 已提交
1984
setDeviceName(devName: string): void
X
xiaosi 已提交
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999

设置设备名称。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | devName | string | 是 | 设备名称。 |

2000
**错误码:**
X
xiaosi 已提交
2001

2002
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)
X
xiaosi 已提交
2003

2004 2005 2006
| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2007

X
xiaosi 已提交
2008
## wifi.on('wifiStateChange')<sup>9+</sup>
X
xiaosi 已提交
2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024

on(type: "wifiStateChange", callback: Callback&lt;number&gt;): void

注册WLAN状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"wifiStateChange"字符串。 |
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

2025 2026 2027 2028 2029 2030 2031 2032
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|

X
xiaosi 已提交
2033 2034 2035 2036 2037 2038 2039 2040 2041 2042
**状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 未激活。 |
| 1 | 已激活。 |
| 2 | 激活中。 |
| 3 | 去激活中。 |


X
xiaosi 已提交
2043
## wifi.off('wifiStateChange')<sup>9+</sup>
X
xiaosi 已提交
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059

off(type: "wifiStateChange", callback?: Callback&lt;number&gt;): void

取消注册WLAN状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"wifiStateChange"字符串。 |
  | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |

2060 2061 2062 2063 2064 2065 2066 2067
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|

X
xiaosi 已提交
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083
**示例:**
  ```js
  import wifi from '@ohos.wifi';
  
  var recvPowerNotifyFunc = result => {
      console.info("Receive power state change event: " + result);
  }
  
  // Register event
  wifi.on("wifiStateChange", recvPowerNotifyFunc);
  
  // Unregister event
  wifi.off("wifiStateChange", recvPowerNotifyFunc);
  ```


X
xiaosi 已提交
2084
## wifi.on('wifiConnectionChange')<sup>9+</sup>
X
xiaosi 已提交
2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107

on(type: "wifiConnectionChange", callback: Callback&lt;number&gt;): void

注册WLAN连接状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"wifiConnectionChange"字符串。 |
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

**连接状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 已断开。 |
| 1 | 已连接。 |

2108 2109 2110 2111 2112 2113 2114
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
2115

X
xiaosi 已提交
2116
## wifi.off('wifiConnectionChange')<sup>9+</sup>
X
xiaosi 已提交
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132

off(type: "wifiConnectionChange", callback?: Callback&lt;number&gt;): void

取消注册WLAN连接状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"wifiConnectionChange"字符串。 |
  | callback | Callback&lt;number&gt; | 否 | 连接状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |

2133 2134 2135 2136 2137 2138 2139
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
2140

X
xiaosi 已提交
2141
## wifi.on('wifiScanStateChange')<sup>9+</sup>
X
xiaosi 已提交
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164

on(type: "wifiScanStateChange", callback: Callback&lt;number&gt;): void

注册扫描状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"wifiScanStateChange"字符串。 |
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

**扫描状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 扫描失败。 |
| 1 | 扫描成功。 |

2165 2166 2167 2168 2169 2170 2171
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
2172

X
xiaosi 已提交
2173
## wifi.off('wifiScanStateChange')<sup>9+</sup>
X
xiaosi 已提交
2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189

off(type: "wifiScanStateChange", callback?: Callback&lt;number&gt;): void

取消注册扫描状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiScanStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |

2190 2191 2192 2193 2194 2195 2196
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
2197

X
xiaosi 已提交
2198
## wifi.on('wifiRssiChange')<sup>9+</sup>
X
xiaosi 已提交
2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214

on(type: "wifiRssiChange", callback: Callback&lt;number&gt;): void

注册RSSI状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"wifiRssiChange"字符串。 |
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数,返回以dBm为单位的RSSI值。 |

2215 2216 2217 2218 2219 2220 2221
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
2222

X
xiaosi 已提交
2223
## wifi.off('wifiRssiChange')<sup>9+</sup>
X
xiaosi 已提交
2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239

off(type: "wifiRssiChange", callback?: Callback&lt;number&gt;): void

取消注册RSSI状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.STA

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"wifiRssiChange"字符串。 |
  | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |

2240 2241 2242 2243 2244 2245 2246
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2501000  | Operation failed.|
X
xiaosi 已提交
2247

X
xiaosi 已提交
2248
## wifi.on('hotspotStateChange')<sup>9+</sup>
X
xiaosi 已提交
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273

on(type: "hotspotStateChange", callback: Callback&lt;number&gt;): void

注册热点状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"hotspotStateChange"字符串。 |
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

**热点状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 未激活。 |
| 1 | 已激活。 |
| 2 | 激活中。 |
| 3 | 去激活中。 |

2274 2275 2276 2277 2278 2279 2280
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2601000  | Operation failed.|
X
xiaosi 已提交
2281

X
xiaosi 已提交
2282
## wifi.off('hotspotStateChange')<sup>9+</sup>
X
xiaosi 已提交
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298

off(type: "hotspotStateChange", callback?: Callback&lt;number&gt;): void

取消注册热点状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.AP.Core

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"hotspotStateChange"字符串。 |
  | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |

2299 2300 2301 2302 2303 2304 2305
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2601000  | Operation failed.|
X
xiaosi 已提交
2306

X
xiaosi 已提交
2307
## wifi.on('p2pStateChange')<sup>9+</sup>
X
xiaosi 已提交
2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333

on(type: "p2pStateChange", callback: Callback&lt;number&gt;): void

注册P2P开关状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pStateChange"字符串。 |
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

**P2P状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 1 | 空闲。 |
| 2 | 打开中。 |
| 3 | 已打开。 |
| 4 | 关闭中。 |
| 5 | 已关闭。 |

2334 2335 2336 2337 2338 2339 2340 2341
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|

X
xiaosi 已提交
2342
## wifi.off('p2pStateChange')<sup>9+</sup>
X
xiaosi 已提交
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358

off(type: "p2pStateChange", callback?: Callback&lt;number&gt;): void

取消注册P2P开关状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pStateChange"字符串。 |
  | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |

2359 2360 2361 2362 2363 2364 2365
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2366

X
xiaosi 已提交
2367
  ## wifi.on('p2pConnectionChange')<sup>9+</sup>
X
xiaosi 已提交
2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381

on(type: "p2pConnectionChange", callback: Callback&lt;WifiP2pLinkedInfo&gt;): void

注册P2P连接状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
X
xiaosi 已提交
2382
  | callback | Callback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo9)&gt; | 是 | 状态改变回调函数。 |
X
xiaosi 已提交
2383

2384 2385 2386 2387 2388 2389 2390
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2391

X
xiaosi 已提交
2392
## wifi.off('p2pConnectionChange')<sup>9+</sup>
X
xiaosi 已提交
2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406

off(type: "p2pConnectionChange", callback?: Callback&lt;WifiP2pLinkedInfo&gt;): void

取消注册P2P连接状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
X
xiaosi 已提交
2407
  | callback | Callback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo9)&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
X
xiaosi 已提交
2408

2409 2410 2411 2412 2413 2414 2415
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2416

X
xiaosi 已提交
2417
## wifi.on('p2pDeviceChange')<sup>9+</sup>
X
xiaosi 已提交
2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431

on(type: "p2pDeviceChange", callback: Callback&lt;WifiP2pDevice&gt;): void

注册P2P设备状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
X
xiaosi 已提交
2432
  | callback | Callback&lt;[WifiP2pDevice](#wifip2pdevice9)&gt; | 是 | 状态改变回调函数。 |
X
xiaosi 已提交
2433

2434 2435 2436 2437 2438 2439 2440
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2441

X
xiaosi 已提交
2442
## wifi.off('p2pDeviceChange')<sup>9+</sup>
X
xiaosi 已提交
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456

off(type: "p2pDeviceChange", callback?: Callback&lt;WifiP2pDevice&gt;): void

取消注册P2P设备状态改变事件。

**需要权限:** ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
X
xiaosi 已提交
2457
  | callback | Callback&lt;[WifiP2pDevice](#wifip2pdevice9)&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
X
xiaosi 已提交
2458

2459 2460 2461 2462 2463 2464 2465
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2466

X
xiaosi 已提交
2467
## wifi.on('p2pPeerDeviceChange')<sup>9+</sup>
X
xiaosi 已提交
2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481

on(type: "p2pPeerDeviceChange", callback: Callback&lt;WifiP2pDevice[]&gt;): void

注册P2P对端设备状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
X
xiaosi 已提交
2482
  | callback | Callback&lt;[WifiP2pDevice[]](#wifip2pdevice9)&gt; | 是 | 状态改变回调函数。 |
X
xiaosi 已提交
2483

2484 2485 2486 2487 2488 2489 2490
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2491

X
xiaosi 已提交
2492
## wifi.off('p2pPeerDeviceChange')<sup>9+</sup>
X
xiaosi 已提交
2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506

off(type: "p2pPeerDeviceChange", callback?: Callback&lt;WifiP2pDevice[]&gt;): void

取消注册P2P对端设备状态改变事件。

**需要权限:** ohos.permission.LOCATION

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
X
xiaosi 已提交
2507
  | callback | Callback&lt;[WifiP2pDevice[]](#wifip2pdevice9)&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
X
xiaosi 已提交
2508

2509 2510 2511 2512 2513 2514 2515
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2516

X
xiaosi 已提交
2517
## wifi.on('p2pPersistentGroupChange')<sup>9+</sup>
X
xiaosi 已提交
2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533

on(type: "p2pPersistentGroupChange", callback: Callback&lt;void&gt;): void

注册P2P永久组状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 |
  | callback | Callback&lt;void&gt; | 是 | 状态改变回调函数。 |

2534 2535 2536 2537 2538 2539 2540
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2541

X
xiaosi 已提交
2542
## wifi.off('p2pPersistentGroupChange')<sup>9+</sup>
X
xiaosi 已提交
2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558

off(type: "p2pPersistentGroupChange", callback?: Callback&lt;void&gt;): void

取消注册P2P永久组状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 |
  | callback | Callback&lt;void&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |

2559 2560 2561 2562 2563 2564 2565
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2566

X
xiaosi 已提交
2567
## wifi.on('p2pDiscoveryChange')<sup>9+</sup>
X
xiaosi 已提交
2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590

on(type: "p2pDiscoveryChange", callback: Callback&lt;number&gt;): void

注册发现设备状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pDiscoveryChange"字符串。 |
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

**发现设备状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 初始状态。 |
| 1 | 发现成功。 |

2591 2592 2593 2594 2595 2596 2597
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|
X
xiaosi 已提交
2598

X
xiaosi 已提交
2599
## wifi.off('p2pDiscoveryChange')<sup>9+</sup>
X
xiaosi 已提交
2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615

off(type: "p2pDiscoveryChange", callback?: Callback&lt;number&gt;): void

取消注册发现设备状态改变事件。

**需要权限:** ohos.permission.GET_WIFI_INFO

**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**

  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pDiscoveryChange"字符串。 |
  | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |

2616 2617 2618 2619 2620 2621 2622
**错误码:**

以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)

| **类型** | **说明** |
  | -------- | -------- |
| 2801000  | Operation failed.|