js-apis-wifi.md 66.4 KB
Newer Older
Z
zengyawen 已提交
1
# WLAN
Z
zhangfeng 已提交
2
该模块主要提供WLAN基础功能、P2P(peer-to-peer)功能和WLAN消息通知的相应服务,让应用可以通过WLAN和其他设备互联互通。
Z
zengyawen 已提交
3

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

Z
zengyawen 已提交
7 8

## 导入模块
Z
zengyawen 已提交
9

Z
zhangfeng 已提交
10
```js
Z
zengyawen 已提交
11
import wifi from '@ohos.wifi';
Z
zengyawen 已提交
12 13
```

Z
zhangfeng 已提交
14 15 16 17 18
## wifi.enableWifi

enableWifi(): boolean

使能WLAN。
19 20

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
21 22 23 24 25 26

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

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

**返回值:**
B
bmeangel 已提交
27

Z
zhangfeng 已提交
28 29 30 31 32 33 34 35 36 37
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功, false:操作失败。|


## wifi.disableWifi

disableWifi(): boolean

去使能WLAN。
38 39

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
40 41 42 43 44 45

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

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

**返回值:**
B
bmeangel 已提交
46

Z
zhangfeng 已提交
47 48 49 50 51
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功, false:操作失败。|


Z
zengyawen 已提交
52
## wifi.isWifiActive
Z
zengyawen 已提交
53

Z
zengyawen 已提交
54
isWifiActive(): boolean
Z
zengyawen 已提交
55

Z
zhangfeng 已提交
56
查询WLAN是否已使能。
Z
zengyawen 已提交
57

Z
zengyawen 已提交
58
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
59

Z
zengyawen 已提交
60
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
61

Z
zengyawen 已提交
62
**返回值:**
B
bmeangel 已提交
63

Z
zengyawen 已提交
64 65
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
66
  | boolean | true:已使能, false:未使能。 |
Z
zengyawen 已提交
67 68 69 70 71 72 73 74


## wifi.scan

scan(): boolean

启动WLAN扫描。

Z
zhangfeng 已提交
75
**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.LOCATION
Z
zhangfeng 已提交
76

Z
zengyawen 已提交
77
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
78

Z
zengyawen 已提交
79
**返回值:**
B
bmeangel 已提交
80

Z
zengyawen 已提交
81 82
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
83
  | boolean | true:扫描操作执行成功, false:扫描操作执行失败。 |
Z
zengyawen 已提交
84 85 86 87 88 89


## wifi.getScanInfos

getScanInfos(): Promise<Array<WifiScanInfo>>

Z
zhangfeng 已提交
90
获取扫描结果,使用Promise异步回调。
Z
zengyawen 已提交
91

Z
zhangfeng 已提交
92
**需要权限:** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION)
Z
zhangfeng 已提交
93

Z
zengyawen 已提交
94
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
95

Z
zengyawen 已提交
96
**返回值:**
B
bmeangel 已提交
97

Z
zengyawen 已提交
98 99
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
100
  | Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | Promise对象。返回扫描到的热点列表。 |
Z
zengyawen 已提交
101 102 103 104 105 106


## wifi.getScanInfos

getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void

Z
zhangfeng 已提交
107
获取扫描结果,使用callback异步回调。
Z
zengyawen 已提交
108

Z
zhangfeng 已提交
109
**需要权限:** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION)
Z
zhangfeng 已提交
110

Z
zengyawen 已提交
111
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
112

Z
zengyawen 已提交
113
**参数:**
B
bmeangel 已提交
114

Z
zengyawen 已提交
115 116
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
117
  | callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | 是 | 回调函数。当成功时,err为0,data为扫描到的热点;否则err为非0值,data为空。 |
Z
zengyawen 已提交
118

Z
zengyawen 已提交
119
**示例:**
Z
zhangfeng 已提交
120
  ```js
Z
zengyawen 已提交
121 122
  import wifi from '@ohos.wifi';
  
Z
zhangfeng 已提交
123 124 125 126 127 128
  wifi.getScanInfos((err, result) => {
      if (err) {
          console.error("get scan info error");
          return;
      }
  
Z
zengyawen 已提交
129
      var len = Object.keys(result).length;
Z
zhangfeng 已提交
130
      console.log("wifi received scan info: " + len);
Z
zengyawen 已提交
131 132 133
      for (var i = 0; i < len; ++i) {
          console.info("ssid: " + result[i].ssid);
          console.info("bssid: " + result[i].bssid);
Z
zhangfeng 已提交
134
          console.info("capabilities: " + result[i].capabilities);
Z
zengyawen 已提交
135 136 137 138
          console.info("securityType: " + result[i].securityType);
          console.info("rssi: " + result[i].rssi);
          console.info("band: " + result[i].band);
          console.info("frequency: " + result[i].frequency);
Z
zhangfeng 已提交
139
          console.info("channelWidth: " + result[i].channelWidth);
Z
zengyawen 已提交
140 141 142 143 144 145
          console.info("timestamp: " + result[i].timestamp);
      }
  });
  
  wifi.getScanInfos().then(result => {
      var len = Object.keys(result).length;
Z
zhangfeng 已提交
146
      console.log("wifi received scan info: " + len);
Z
zengyawen 已提交
147 148 149
      for (var i = 0; i < len; ++i) {
          console.info("ssid: " + result[i].ssid);
          console.info("bssid: " + result[i].bssid);
Z
zhangfeng 已提交
150
          console.info("capabilities: " + result[i].capabilities);
Z
zengyawen 已提交
151 152 153 154
          console.info("securityType: " + result[i].securityType);
          console.info("rssi: " + result[i].rssi);
          console.info("band: " + result[i].band);
          console.info("frequency: " + result[i].frequency);
Z
zhangfeng 已提交
155
          console.info("channelWidth: " + result[i].channelWidth);
Z
zengyawen 已提交
156 157 158 159 160 161 162 163 164 165
          console.info("timestamp: " + result[i].timestamp);
      }
  });
  ```


## WifiScanInfo

WLAN热点信息。

Z
zhangfeng 已提交
166 167
**系统能力:** SystemCapability.Communication.WiFi.STA

B
bmeangel 已提交
168

Z
zengyawen 已提交
169 170 171 172
| **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
| ssid | string | 只读 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 只读 | 热点的BSSID。 |
Z
zhangfeng 已提交
173
| capabilities | string | 只读 | 热点能力。 |
174
| securityType | [WifiSecurityType](#wifisecuritytype) | 只读 | WLAN加密类型。 |
Z
zengyawen 已提交
175 176 177
| rssi | number | 只读 | 热点的信号强度(dBm)。 |
| band | number | 只读 | WLAN接入点的频段。 |
| frequency | number | 只读 | WLAN接入点的频率。 |
Z
zhangfeng 已提交
178
| channelWidth | number | 只读 | WLAN接入点的带宽。 |
Z
zhangfeng 已提交
179 180
| centerFrequency0<sup>9+</sup> | number | 只读 | 中心频点。 |
| centerFrequency1<sup>9+</sup> | number | 只读 | 中心频点。 |
181
| infoElems<sup>9+</sup> | Array&lt;[WifiInfoElem](#wifiinfoelem9)&gt; | 只读 | 信息元素。 |
Z
zengyawen 已提交
182 183 184 185 186 187 188
| timestamp | number | 只读 | 时间戳。 |


## WifiSecurityType

表示加密类型的枚举。

Z
zhangfeng 已提交
189 190
**系统能力:** SystemCapability.Communication.WiFi.Core

B
bmeangel 已提交
191

Z
zengyawen 已提交
192 193 194 195 196 197 198
| **名称** | **默认值** | **说明** |
| -------- | -------- | -------- |
| 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)加密类型。 |
Z
zhangfeng 已提交
199 200 201 202 203
| 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加密类型。 |
Z
zengyawen 已提交
204 205


Z
zhangfeng 已提交
206
## WifiInfoElem<sup>9+</sup>
Z
zengyawen 已提交
207

Z
zhangfeng 已提交
208
WLAN热点信息。
Z
zengyawen 已提交
209

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

Z
zhangfeng 已提交
212
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zengyawen 已提交
213

B
bmeangel 已提交
214

Z
zhangfeng 已提交
215 216 217 218
| **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
| eid | number | 只读 | 元素ID。 |
| content | Uint8Array | 只读 | 元素内容。 |
Z
zhangfeng 已提交
219

Z
zhangfeng 已提交
220 221 222 223 224 225 226

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

表示带宽类型的枚举。

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

B
bmeangel 已提交
227

Z
zhangfeng 已提交
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
| **名称** | **默认值** | **说明** |
| -------- | -------- | -------- |
| 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 | 无效值 |


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

getScanInfosSync(): &nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;

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

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

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

**返回值:**
B
bmeangel 已提交
249

Z
zhangfeng 已提交
250 251 252 253 254 255 256 257 258 259
  | **类型** | **说明** |
  | -------- | -------- |
  | &nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt; | 扫描结果数组。 |


## wifi.addDeviceConfig

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

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

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
262 263 264 265

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

**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
266

Z
zengyawen 已提交
267
**参数:**
B
bmeangel 已提交
268

Z
zengyawen 已提交
269 270
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
271
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
Z
zengyawen 已提交
272

Z
zengyawen 已提交
273
**返回值:**
B
bmeangel 已提交
274

Z
zengyawen 已提交
275 276
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
277
  | Promise&lt;number&gt; | Promise对象。返回添加的网络配置ID,如果值为-1表示添加失败。 |
Z
zengyawen 已提交
278

Z
zhangfeng 已提交
279
## WifiDeviceConfig
Z
zengyawen 已提交
280

Z
zhangfeng 已提交
281
WLAN配置信息。
Z
zengyawen 已提交
282

Z
zhangfeng 已提交
283 284
**系统能力:** SystemCapability.Communication.WiFi.STA

B
bmeangel 已提交
285

Z
zhangfeng 已提交
286 287 288 289 290 291
| **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
| ssid | string | 只读 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 只读 | 热点的BSSID。 |
| preSharedKey | string | 只读 | 热点的密钥。 |
| isHiddenSsid | boolean | 只读 | 是否是隐藏网络。 |
292
| securityType | [WifiSecurityType](#wifisecuritytype) | 只读 | 加密类型。 |
293 294 295 296 297 298 299 300
| creatorUid | number | 只读 | 创建用户的ID。 <br /> **系统接口:** 此接口为系统接口。 |
| disableReason | number | 只读 | 禁用原因。 <br /> **系统接口:** 此接口为系统接口。 |
| netId | number | 只读 | 分配的网络ID。 <br /> **系统接口:** 此接口为系统接口。 |
| randomMacType | number | 只读 | 随机MAC类型。 <br /> **系统接口:** 此接口为系统接口。 |
| randomMacAddr | string | 只读 | 随机MAC地址。 <br /> **系统接口:** 此接口为系统接口。 |
| ipType | [IpType](#iptype7) | 只读 | IP地址类型。 <br /> **系统接口:** 此接口为系统接口。 |
| staticIp | [IpConfig](#ipconfig7) | 只读 | 静态IP配置信息。 <br /> **系统接口:** 此接口为系统接口。 |
| eapConfig<sup>9+</sup> | [WifiEapConfig](#wifieapconfig9) | 只读 | 可扩展身份验证协议配置。 <br /> **系统接口:** 此接口为系统接口。 |
Z
zhangfeng 已提交
301 302 303 304 305 306


## IpType<sup>7+</sup>

表示IP类型的枚举。

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

Z
zhangfeng 已提交
309 310
**系统能力:** SystemCapability.Communication.WiFi.STA

B
bmeangel 已提交
311

Z
zhangfeng 已提交
312 313 314 315 316 317 318 319 320 321 322
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| STATIC | 0 | 静态IP。 |
| DHCP | 1 | 通过DHCP获取。 |
| UNKNOWN | 2 | 未指定。 |


## IpConfig<sup>7+</sup>

IP配置信息。

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

Z
zhangfeng 已提交
325 326 327 328 329 330 331 332 333 334 335 336 337 338
**系统能力:** SystemCapability.Communication.WiFi.STA

| **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
| ipAddress | number | 只读 | IP地址。 |
| gateway | number | 只读 | 网关。 |
| dnsServers | number[] | 只读 | DNS服务器。 |
| domains | Array&lt;string&gt; | 只读 | 域信息。 |


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

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

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

Z
zhangfeng 已提交
341 342 343 344
**系统能力:** SystemCapability.Communication.WiFi.STA

| **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
345 346
| eapMethod | [EapMethod](#eapmethod9) | 只读 | EAP认证方式。 |
| phase2Method | [Phase2Method](#phase2method9) | 只读 | 第二阶段认证方式。 |
Z
zhangfeng 已提交
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
| identity | string | 只读 | 身份信息。 |
| anonymousIdentity | string | 只读 | 匿名身份。 |
| password | string | 只读 | 密码。 |
| caCertAliases | string | 只读 | CA 证书别名。 |
| caPath | string | 只读 | CA 证书路径。 |
| clientCertAliases | string | 只读 | 客户端证书别名。 |
| altSubjectMatch | string | 只读 | 替代主题匹配。 |
| domainSuffixMatch | string | 只读 | 域后缀匹配。 |
| realm | string | 只读 | 通行证凭证的领域。 |
| plmn | string | 只读 | 公共陆地移动网的直通凭证提供商。 |
| eapSubId | number | 只读 | SIM卡的子ID。 |


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

表示EAP认证方式的枚举。

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

Z
zhangfeng 已提交
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
**系统能力:** SystemCapability.Communication.WiFi.STA

| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| 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>

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

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

Z
zhangfeng 已提交
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
**系统能力:** SystemCapability.Communication.WiFi.STA

| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| 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类型。 |


## wifi.addDeviceConfig

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

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

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
408 409 410 411 412 413

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

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

**参数:**
B
bmeangel 已提交
414

Z
zhangfeng 已提交
415 416
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
417
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
Z
zhangfeng 已提交
418 419 420 421 422 423 424 425 426 427 428 429 430 431
  | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当操作成功时,err为0,data为添加的网络配置ID,如果data值为-1,表示添加失败。当error为非0,表示处理出现错误。 |


## wifi.addUntrustedConfig<sup>7+</sup>

addUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;

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

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

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

**参数:**
B
bmeangel 已提交
432

Z
zhangfeng 已提交
433 434
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
435
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
Z
zhangfeng 已提交
436 437

**返回值:**
B
bmeangel 已提交
438

Z
zhangfeng 已提交
439 440 441
  | **类型** | **说明** |
  | -------- | -------- |
  | Promise&lt;boolean&gt; | Promise对象。表示操作结果,true: 成功, false: 失败。 |
Z
zengyawen 已提交
442

Z
zhangfeng 已提交
443

Z
zhangfeng 已提交
444
## wifi.addUntrustedConfig<sup>7+</sup>
Z
zhangfeng 已提交
445 446 447

addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&gt;): void

Z
zhangfeng 已提交
448
添加不可信网络配置,使用callback异步回调。
Z
zhangfeng 已提交
449

Z
zengyawen 已提交
450
**需要权限:** ohos.permission.SET_WIFI_INFO
Z
zhangfeng 已提交
451

Z
zengyawen 已提交
452
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
453

Z
zengyawen 已提交
454
**参数:**
B
bmeangel 已提交
455

Z
zhangfeng 已提交
456 457
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
458
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
Z
zhangfeng 已提交
459
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当操作成功时,err为0,data表示操作结果,true: 成功, false: 失败。如果error为非0,表示处理出现错误。 |
Z
zhangfeng 已提交
460 461


Z
zhangfeng 已提交
462
## wifi.removeUntrustedConfig<sup>7+</sup>
Z
zhangfeng 已提交
463 464 465

removeUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;

Z
zhangfeng 已提交
466
移除不可信网络配置,使用Promise异步回调。
Z
zhangfeng 已提交
467

Z
zengyawen 已提交
468
**需要权限:** ohos.permission.SET_WIFI_INFO
Z
zhangfeng 已提交
469

Z
zengyawen 已提交
470
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
471

Z
zengyawen 已提交
472
**参数:**
B
bmeangel 已提交
473

Z
zhangfeng 已提交
474 475
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
476
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
Z
zengyawen 已提交
477

Z
zengyawen 已提交
478
**返回值:**
B
bmeangel 已提交
479

Z
zengyawen 已提交
480 481
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
482
  | Promise&lt;boolean&gt; | Promise对象。表示操作结果,true: 成功, false: 失败。 |
Z
zengyawen 已提交
483

Z
zengyawen 已提交
484

Z
zhangfeng 已提交
485
## wifi.removeUntrustedConfig<sup>7+</sup>
Z
zengyawen 已提交
486

Z
zhangfeng 已提交
487
removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&gt;): void
Z
zengyawen 已提交
488

Z
zhangfeng 已提交
489 490 491 492 493 494 495
移除不可信网络配置,使用callback异步回调。

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

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

**参数:**
B
bmeangel 已提交
496

Z
zhangfeng 已提交
497 498
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
499
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
Z
zhangfeng 已提交
500 501 502 503 504 505 506 507
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当操作成功时,err为0,data表示操作结果,true: 成功, false: 失败。如果error为非0,表示处理出现错误。 |


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

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

添加候选网络配置,使用Promise异步回调。
Z
zengyawen 已提交
508

Z
zengyawen 已提交
509
**需要权限:** ohos.permission.SET_WIFI_INFO
Z
zengyawen 已提交
510

Z
zengyawen 已提交
511
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zengyawen 已提交
512

Z
zengyawen 已提交
513
**参数:**
B
bmeangel 已提交
514

Z
zhangfeng 已提交
515 516
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
517
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
Z
zhangfeng 已提交
518 519

**返回值:**
B
bmeangel 已提交
520

Z
zhangfeng 已提交
521 522 523 524 525 526 527 528 529
  | **类型** | **说明** |
  | -------- | -------- |
  | Promise&lt;number&gt; | Promise对象。表示网络配置ID。 |


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

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

Z
zhangfeng 已提交
530
添加候选网络配置,使用callback异步回调。
Z
zhangfeng 已提交
531 532 533 534 535 536

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

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

**参数:**
B
bmeangel 已提交
537

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


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

Z
zhangfeng 已提交
546
removeCandidateConfig(networkId: number): Promise&lt;void&gt;
Z
zhangfeng 已提交
547

Z
zhangfeng 已提交
548
移除候选网络配置,使用Promise异步回调。
Z
zhangfeng 已提交
549 550 551 552 553 554

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

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

**参数:**
B
bmeangel 已提交
555

Z
zhangfeng 已提交
556 557
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
558
  | networkId | number | 是 | 网络配置ID。 |
Z
zhangfeng 已提交
559 560

**返回值:**
B
bmeangel 已提交
561

Z
zhangfeng 已提交
562 563
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
564
  | Promise&lt;void&gt; | Promise对象。 |
Z
zhangfeng 已提交
565 566 567 568


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

Z
zhangfeng 已提交
569
removeCandidateConfig(networkId: number, callback: AsyncCallback&lt;void&gt;): void
Z
zhangfeng 已提交
570 571 572 573 574 575 576 577

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

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

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

**参数:**
B
bmeangel 已提交
578

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


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

587
getCandidateConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;
Z
zhangfeng 已提交
588 589 590 591 592 593 594 595

获取候选网络配置。

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

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

**返回值:**
B
bmeangel 已提交
596

Z
zhangfeng 已提交
597 598
  | **类型** | **说明** |
  | -------- | -------- |
599
  | &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt; | 候选网络配置数组。 |
Z
zhangfeng 已提交
600 601 602 603


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

604
connectToCandidateConfig(networkId: number): void
Z
zhangfeng 已提交
605 606 607 608 609 610 611 612

连接到候选网络。

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

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

**参数:**
B
bmeangel 已提交
613

Z
zhangfeng 已提交
614 615 616 617 618 619 620 621 622 623
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | networkId | number | 是 | 候选网络配置的ID。 |


## wifi.connectToNetwork

connectToNetwork(networkId: number): boolean

连接到指定网络。
624 625

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
626 627 628 629 630 631

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

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

**参数:**
B
bmeangel 已提交
632

Z
zhangfeng 已提交
633 634 635 636 637
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | networkId | number | 是 | 待连接的网络配置ID。 |

**返回值:**
B
bmeangel 已提交
638

Z
zhangfeng 已提交
639 640 641 642 643 644 645 646 647 648 649
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。 |


## wifi.connectToDevice

connectToDevice(config: WifiDeviceConfig): boolean

连接到指定网络。

650 651 652
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG 和 ohos.permissio.MANAGE_WIFI_CONNECTION,仅系统应用可用。
Z
zhangfeng 已提交
653 654 655 656 657

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

**参数:**
B
bmeangel 已提交
658

Z
zhangfeng 已提交
659 660
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
661
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
Z
zhangfeng 已提交
662 663

**返回值:**
B
bmeangel 已提交
664

Z
zhangfeng 已提交
665 666 667 668 669 670 671 672 673
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。 |


## wifi.disconnect

disconnect(): boolean

Z
z00588131 已提交
674
断开连接的网络。
Z
zhangfeng 已提交
675

676 677 678
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。
Z
zhangfeng 已提交
679 680 681 682 683

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

**返回值:**
B
bmeangel 已提交
684

Z
zhangfeng 已提交
685 686 687
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。 |
Z
zengyawen 已提交
688

Z
zhangfeng 已提交
689 690 691 692 693 694 695

## wifi.getSignalLevel

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

查询WLAN信号强度。

Z
zengyawen 已提交
696
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
697

Z
zengyawen 已提交
698
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
699

B
bmeangel 已提交
700 701
**参数:**

Z
zhangfeng 已提交
702 703 704 705
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | rssi | number | 是 | 热点的信号强度(dBm)。 |
  | band | number | 是 | WLAN接入点的频段。 |
Z
zengyawen 已提交
706

Z
zengyawen 已提交
707
**返回值:**
B
bmeangel 已提交
708

Z
zengyawen 已提交
709 710
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
711
  | number | 信号强度,取值范围为[0,&nbsp;4]。 |
Z
zengyawen 已提交
712 713


Z
zhangfeng 已提交
714
## wifi.getLinkedInfo
Z
zengyawen 已提交
715

Z
zengyawen 已提交
716
getLinkedInfo(): Promise&lt;WifiLinkedInfo&gt;
Z
zengyawen 已提交
717

Z
zhangfeng 已提交
718
获取WLAN连接信息,使用Promise异步回调。
Z
zengyawen 已提交
719

Z
zengyawen 已提交
720
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
721

Z
zengyawen 已提交
722
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
723

Z
zengyawen 已提交
724
**返回值:**
B
bmeangel 已提交
725

Z
zengyawen 已提交
726 727
  | 类型 | 说明 |
  | -------- | -------- |
728
  | Promise&lt;[WifiLinkedInfo](#wifilinkedinfo)&gt; | Promise对象。表示WLAN连接信息。 |
Z
zengyawen 已提交
729

Z
zengyawen 已提交
730

Z
zhangfeng 已提交
731
## wifi.getLinkedInfo
Z
zengyawen 已提交
732 733 734

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

Z
zhangfeng 已提交
735
获取WLAN连接信息,使用callback异步回调。
Z
zengyawen 已提交
736

Z
zengyawen 已提交
737
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
738

Z
zengyawen 已提交
739
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
740

Z
zengyawen 已提交
741
**参数:**
B
bmeangel 已提交
742

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

Z
zengyawen 已提交
747
**示例:**
Z
zhangfeng 已提交
748
  ```js
Z
zengyawen 已提交
749 750
  import wifi from '@ohos.wifi';
  
Z
zhangfeng 已提交
751 752 753 754 755 756
  wifi.getLinkedInfo((err, data) => {
      if (err) {
          console.error("get linked info error");
          return;
      }
      console.info("get wifi linked info: " + JSON.stringify(data));
Z
zengyawen 已提交
757 758 759
  });
  
  wifi.getLinkedInfo().then(data => {
Z
zhangfeng 已提交
760
      console.info("get wifi linked info: " + JSON.stringify(data));
Z
zengyawen 已提交
761
  }).catch(error => {
Z
zhangfeng 已提交
762
      console.info("get linked info error");
Z
zengyawen 已提交
763 764 765 766 767 768 769 770
  });
  ```


## WifiLinkedInfo

提供WLAN连接的相关信息。

Z
zhangfeng 已提交
771 772
**系统能力:** SystemCapability.Communication.WiFi.STA

Z
zengyawen 已提交
773 774 775 776
| 参数名 | 类型 | 读写属性 | 说明 |
| -------- | -------- | -------- | -------- |
| ssid | string | 只读 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 只读 | 热点的BSSID。 |
777
| networkId | number | 只读 | 网络配置ID。 <br /> **系统接口:** 此接口为系统接口。 |
Z
zengyawen 已提交
778 779 780 781 782 783
| rssi | number | 只读 | 热点的信号强度(dBm)。 |
| band | number | 只读 | WLAN接入点的频段。 |
| linkSpeed | number | 只读 | WLAN接入点的速度。 |
| frequency | number | 只读 | WLAN接入点的频率。 |
| isHidden | boolean | 只读 | WLAN接入点是否是隐藏网络。 |
| isRestricted | boolean | 只读 | WLAN接入点是否限制数据量。 |
784 785
| chload | number | 只读 | 连接负载,值越大表示负载约高。 <br /> **系统接口:** 此接口为系统接口。 |
| snr | number | 只读 | 信噪比。 <br /> **系统接口:** 此接口为系统接口。 |
Z
zhangfeng 已提交
786
| macType<sup>9+</sup> | number | 只读 | MAC地址类型。 |
Z
zengyawen 已提交
787 788
| macAddress | string | 只读 | 设备的MAC地址。 |
| ipAddress | number | 只读 | WLAN连接的IP地址。 |
789
| suppState | [SuppState](#suppstate) | 只读 | 请求状态。 <br /> **系统接口:** 此接口为系统接口。 |
790
| connState | [ConnState](#connstate) | 只读 | WLAN连接状态。 |
Z
zengyawen 已提交
791 792 793 794 795 796


## ConnState

表示WLAN连接状态的枚举。

Z
zhangfeng 已提交
797 798
**系统能力:** SystemCapability.Communication.WiFi.STA

Z
zengyawen 已提交
799 800 801 802 803 804 805 806 807 808 809 810
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| 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连接建立失败。 |


Z
zhangfeng 已提交
811 812 813 814
## SuppState

表示请求状态的枚举。

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

Z
zhangfeng 已提交
817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
**系统能力:** 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 | 无效值。 |


## wifi.isConnected<sup>7+</sup>

isConnected(): boolean

查询WLAN是否已连接。

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

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

**返回值:**
B
bmeangel 已提交
846

Z
zhangfeng 已提交
847 848 849 850 851 852 853 854 855 856
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:已连接,&nbsp;false:未连接。 |


## wifi.getSupportedFeatures<sup>7+</sup>

getSupportedFeatures(): number

查询设备支持的特性。
857 858

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
859 860 861 862 863 864

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

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

**返回值:**
B
bmeangel 已提交
865

Z
zhangfeng 已提交
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
  | **类型** | **说明** |
  | -------- | -------- |
  | 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 | 增强开放特性。 |


## wifi.isFeatureSupported<sup>7+</sup>

isFeatureSupported(featureId: number): boolean

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

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

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

**参数:**

B
bmeangel 已提交
898

Z
zhangfeng 已提交
899 900 901 902 903
  | **参数名** | **类型** | 必填 | **说明** |
  | -------- | -------- | -------- | -------- |
  | featureId | number | 是 | 特性ID值。 |

**返回值:**
B
bmeangel 已提交
904

Z
zhangfeng 已提交
905 906 907 908 909 910 911 912 913 914
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:支持,&nbsp;false:不支持。 |


## wifi.getDeviceMacAddress<sup>7+</sup>

getDeviceMacAddress(): string[]

获取设备的MAC地址。
915 916

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
917 918 919 920 921 922

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

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

**返回值:**
B
bmeangel 已提交
923

Z
zhangfeng 已提交
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
  | **类型** | **说明** |
  | -------- | -------- |
  | string[] | MAC地址。 |


## wifi.getIpInfo<sup>7+</sup>

getIpInfo(): IpInfo

获取IP信息。

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

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

**返回值:**
B
bmeangel 已提交
940

Z
zhangfeng 已提交
941 942
  | **类型** | **说明** |
  | -------- | -------- |
943
  | [IpInfo](#ipinfo7) | IP信息。 |
Z
zhangfeng 已提交
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973


## IpInfo<sup>7+</sup>

IP信息。

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

| **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
| ipAddress | number | 只读 | IP地址。 |
| gateway | number | 只读 | 网关。 |
| netmask | number | 只读 | 掩码。 |
| primaryDns | number | 只读 | 主DNS服务器IP地址。 |
| secondDns | number | 只读 | 备DNS服务器IP地址。 |
| serverIp | number | 只读 | DHCP服务端IP地址。 |
| leaseDuration | number | 只读 | IP地址租用时长。 |


## wifi.getCountryCode<sup>7+</sup>

getCountryCode(): string

获取国家码信息。

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

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

**返回值:**
B
bmeangel 已提交
974

Z
zhangfeng 已提交
975 976 977 978 979 980 981 982 983 984
  | **类型** | **说明** |
  | -------- | -------- |
  | string | 国家码。 |


## wifi.reassociate<sup>7+</sup>

reassociate(): boolean

重新关联网络。
985 986

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
987 988 989 990 991 992

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

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

**返回值:**
B
bmeangel 已提交
993

Z
zhangfeng 已提交
994 995 996 997 998 999 1000 1001 1002 1003
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。 |


## wifi.reconnect<sup>7+</sup>

reconnect(): boolean

重新连接网络。
1004 1005

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1006 1007 1008 1009 1010 1011

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

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

**返回值:**
B
bmeangel 已提交
1012

Z
zhangfeng 已提交
1013 1014 1015 1016 1017 1018 1019
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。 |


## wifi.getDeviceConfigs<sup>7+</sup>

1020
getDeviceConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;
Z
zhangfeng 已提交
1021 1022

获取网络配置。
1023 1024

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1025 1026 1027 1028 1029 1030

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

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

**返回值:**
B
bmeangel 已提交
1031

Z
zhangfeng 已提交
1032 1033
  | **类型** | **说明** |
  | -------- | -------- |
1034
  | &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt; | 网络配置信息的数组。 |
Z
zhangfeng 已提交
1035 1036 1037 1038


## wifi.updateNetwork<sup>7+</sup>

1039
updateNetwork(config: WifiDeviceConfig): number
Z
zhangfeng 已提交
1040 1041

更新网络配置。
1042 1043

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1044 1045 1046 1047 1048 1049

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

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

**参数:**
B
bmeangel 已提交
1050

Z
zhangfeng 已提交
1051 1052
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
1053
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
Z
zhangfeng 已提交
1054 1055

**返回值:**
B
bmeangel 已提交
1056

Z
zhangfeng 已提交
1057 1058
  | **类型** | **说明** |
  | -------- | -------- |
1059
  | number | 返回更新的网络配置ID,如果值为-1表示更新失败。 |
Z
zhangfeng 已提交
1060 1061 1062 1063 1064 1065 1066


## wifi.disableNetwork<sup>7+</sup>

disableNetwork(netId: number): boolean

去使能网络配置。
1067 1068

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1069 1070 1071 1072 1073 1074

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

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

**参数:**
B
bmeangel 已提交
1075

Z
zhangfeng 已提交
1076 1077 1078 1079 1080
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | netId | number | 是 | 网络配置ID。 |

**返回值:**
B
bmeangel 已提交
1081

Z
zhangfeng 已提交
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。 |


## wifi.removeAllNetwork<sup>7+</sup>

removeAllNetwork(): boolean

移除所有网络配置。
1092 1093

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1094 1095 1096 1097 1098 1099

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

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

**返回值:**
B
bmeangel 已提交
1100

Z
zhangfeng 已提交
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。 |


## wifi.removeDevice<sup>7+</sup>

removeDevice(id: number): boolean

移除指定的网络配置。
1111 1112

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1113 1114 1115 1116 1117 1118

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

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

**参数:**
B
bmeangel 已提交
1119

Z
zhangfeng 已提交
1120 1121 1122 1123 1124
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | id | number | 是 | 网络配置ID。 |

**返回值:**
B
bmeangel 已提交
1125

Z
zhangfeng 已提交
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。 |


## wifi.enableHotspot<sup>7+</sup>

enableHotspot(): boolean

使能热点。
1136 1137

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1138 1139 1140 1141 1142 1143

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

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

**返回值:**
B
bmeangel 已提交
1144

Z
zhangfeng 已提交
1145 1146 1147 1148
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。|

Z
zengyawen 已提交
1149

Z
zhangfeng 已提交
1150
## wifi.disableHotspot<sup>7+</sup>
Z
zengyawen 已提交
1151

Z
zhangfeng 已提交
1152
disableHotspot(): boolean
Z
zhangfeng 已提交
1153

Z
zhangfeng 已提交
1154
去使能热点。
1155 1156

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1157

Z
zhangfeng 已提交
1158 1159 1160
**需要权限:** ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

**系统能力:** SystemCapability.Communication.WiFi.AP.Core
Z
zengyawen 已提交
1161

Z
zengyawen 已提交
1162
**返回值:**
B
bmeangel 已提交
1163

Z
zengyawen 已提交
1164 1165
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
1166
  | boolean | true:操作成功,&nbsp;false:操作失败。|
Z
zengyawen 已提交
1167 1168


Z
zhangfeng 已提交
1169
## wifi.isHotspotDualBandSupported<sup>7+</sup>
Z
zengyawen 已提交
1170

Z
zhangfeng 已提交
1171
isHotspotDualBandSupported(): boolean
Z
zengyawen 已提交
1172

Z
zhangfeng 已提交
1173
热点是否支持双频。
1174 1175

**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
1176

Z
zhangfeng 已提交
1177
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。
Z
zengyawen 已提交
1178

Z
zhangfeng 已提交
1179
**系统能力:** SystemCapability.Communication.WiFi.AP.Core
Z
zhangfeng 已提交
1180

Z
zhangfeng 已提交
1181
**返回值:**
B
bmeangel 已提交
1182

Z
zhangfeng 已提交
1183 1184 1185
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:支持,&nbsp;false:不支持。|
Z
zhangfeng 已提交
1186

Z
zhangfeng 已提交
1187 1188 1189 1190 1191 1192

## wifi.isHotspotActive<sup>7+</sup>

isHotspotActive(): boolean

热点是否已使能。
1193 1194

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1195 1196 1197 1198

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

**系统能力:** SystemCapability.Communication.WiFi.AP.Core
Z
zengyawen 已提交
1199

Z
zengyawen 已提交
1200
**返回值:**
B
bmeangel 已提交
1201

Z
zengyawen 已提交
1202 1203
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
1204
  | boolean | true:已使能,&nbsp;false:未使能。|
Z
zengyawen 已提交
1205 1206


Z
zhangfeng 已提交
1207
## wifi.setHotspotConfig<sup>7+</sup>
Z
zengyawen 已提交
1208

Z
zhangfeng 已提交
1209
setHotspotConfig(config: HotspotConfig): boolean
Z
zhangfeng 已提交
1210

Z
zhangfeng 已提交
1211
设置热点配置信息。
1212 1213

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1214

Z
zhangfeng 已提交
1215
**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG
Z
zhangfeng 已提交
1216

Z
zhangfeng 已提交
1217
**系统能力:** SystemCapability.Communication.WiFi.AP.Core
Z
zhangfeng 已提交
1218

Z
zhangfeng 已提交
1219
**参数:**
B
bmeangel 已提交
1220

Z
zhangfeng 已提交
1221 1222
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
1223
  | config | [HotspotConfig](#hotspotconfig7) | 是 | 热点配置信息。 |
Z
zhangfeng 已提交
1224

Z
zengyawen 已提交
1225
**返回值:**
B
bmeangel 已提交
1226

Z
zhangfeng 已提交
1227 1228
  | **类型** | **说明** |
  | -------- | -------- |
Z
zhangfeng 已提交
1229
  | boolean | true:操作成功,&nbsp;false:操作失败。 |
Z
zhangfeng 已提交
1230 1231


Z
zhangfeng 已提交
1232
## HotspotConfig<sup>7+</sup>
Z
zhangfeng 已提交
1233

Z
zhangfeng 已提交
1234 1235
热点配置信息。

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

Z
zhangfeng 已提交
1238
**系统能力:** SystemCapability.Communication.WiFi.AP.Core
Z
zhangfeng 已提交
1239 1240 1241

| **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
1242
| ssid | string | 只读 | 热点的SSID,编码格式为UTF-8。 |
1243
| securityType | [WifiSecurityType](#wifisecuritytype) | 只读 | 加密类型。 |
Z
zhangfeng 已提交
1244 1245 1246
| band | number | 只读 | 热点的带宽。1: 2.4G, 2: 5G, 3: 双模频段 |
| preSharedKey | string | 只读 | 热点的密钥。 |
| maxConn | number | 只读 | 最大设备连接数。 |
Z
zhangfeng 已提交
1247 1248


Z
zhangfeng 已提交
1249
## wifi.getHotspotConfig<sup>7+</sup>
Z
zhangfeng 已提交
1250

Z
zhangfeng 已提交
1251
getHotspotConfig(): HotspotConfig
Z
zhangfeng 已提交
1252

Z
zhangfeng 已提交
1253
获取热点配置信息。
1254 1255

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1256

Z
zhangfeng 已提交
1257
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG
Z
zhangfeng 已提交
1258

Z
zhangfeng 已提交
1259
**系统能力:** SystemCapability.Communication.WiFi.AP.Core
Z
zhangfeng 已提交
1260

Z
zengyawen 已提交
1261
**返回值:**
B
bmeangel 已提交
1262

Z
zhangfeng 已提交
1263 1264
  | **类型** | **说明** |
  | -------- | -------- |
1265
  | [HotspotConfig](#hotspotconfig7) | 热点的配置信息。 |
Z
zhangfeng 已提交
1266 1267


Z
zhangfeng 已提交
1268
## wifi.getStations<sup>7+</sup>
Z
zhangfeng 已提交
1269

1270
getStations(): &nbsp;Array&lt;[StationInfo](#stationinfo7)&gt;
Z
zhangfeng 已提交
1271

Z
zhangfeng 已提交
1272
获取连接的设备。
1273 1274

**系统接口:** 此接口为系统接口。
Z
zhangfeng 已提交
1275

Z
zhangfeng 已提交
1276
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。
Z
zhangfeng 已提交
1277

Z
zhangfeng 已提交
1278
**系统能力:** SystemCapability.Communication.WiFi.AP.Core
Z
zhangfeng 已提交
1279

Z
zengyawen 已提交
1280
**返回值:**
B
bmeangel 已提交
1281

Z
zhangfeng 已提交
1282
  | **类型** | **说明** |
Z
zhangfeng 已提交
1283
  | -------- | -------- |
1284
  | &nbsp;Array&lt;[StationInfo](#stationinfo7)&gt; | 连接的设备数组。 |
Z
zhangfeng 已提交
1285 1286 1287 1288 1289 1290


## StationInfo<sup>7+</sup>

接入的设备信息。

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

Z
zhangfeng 已提交
1293 1294 1295 1296 1297 1298 1299
**系统能力:** SystemCapability.Communication.WiFi.AP.Core

| **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
| name | string | 只读 | 设备名称。 |
| macAddress | string | 只读 | MAC地址。 |
| ipAddress | string | 只读 | IP地址。 |
Z
zhangfeng 已提交
1300 1301 1302 1303


## wifi.getP2pLinkedInfo<sup>8+</sup>

Z
zhangfeng 已提交
1304
getP2pLinkedInfo(): Promise&lt;WifiP2pLinkedInfo&gt;
Z
zhangfeng 已提交
1305

Z
zhangfeng 已提交
1306
获取P2P连接信息,使用Promise异步回调。
Z
zhangfeng 已提交
1307

Z
zengyawen 已提交
1308
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1309

Z
zengyawen 已提交
1310
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
1311

Z
zhangfeng 已提交
1312
**返回值:**
B
bmeangel 已提交
1313

Z
zhangfeng 已提交
1314 1315
  | 类型 | 说明 |
  | -------- | -------- |
1316
  | Promise&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo8)&gt; | Promise对象。表示P2P连接信息。 |
Z
zhangfeng 已提交
1317

Z
zhangfeng 已提交
1318 1319


Z
zhangfeng 已提交
1320
## WifiP2pLinkedInfo<sup>8+</sup>
Z
zhangfeng 已提交
1321 1322 1323

提供WLAN连接的相关信息。

Z
zhangfeng 已提交
1324 1325
**系统能力:** SystemCapability.Communication.WiFi.P2P

Z
zhangfeng 已提交
1326 1327
| 参数名 | 类型 | 读写属性 | 说明 |
| -------- | -------- | -------- | -------- |
1328
| connectState | [P2pConnectState](#p2pconnectstate8) | 只读 | P2P连接状态。 |
Z
zhangfeng 已提交
1329 1330
| isGroupOwner | boolean | 只读 | 是否是群主。 |
| groupOwnerAddr | string | 只读 | 群组MAC地址。 
Z
zhangfeng 已提交
1331 1332


Z
zhangfeng 已提交
1333
## P2pConnectState<sup>8+</sup>
Z
zhangfeng 已提交
1334 1335 1336

表示P2P连接状态的枚举。

Z
zhangfeng 已提交
1337 1338
**系统能力:** SystemCapability.Communication.WiFi.P2P

Z
zhangfeng 已提交
1339 1340 1341 1342 1343 1344
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| DISCONNECTED | 0 | 断开状态。 |
| CONNECTED | 1 | 连接状态。 |


Z
zhangfeng 已提交
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
## wifi.getP2pLinkedInfo<sup>8+</sup>

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

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

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

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

**参数:**
B
bmeangel 已提交
1356

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


Z
zhangfeng 已提交
1362 1363 1364 1365
## wifi.getCurrentGroup<sup>8+</sup>

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

Z
zhangfeng 已提交
1366
获取P2P当前组信息,使用Promise异步回调。
Z
zhangfeng 已提交
1367

Z
zhangfeng 已提交
1368
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
Z
zhangfeng 已提交
1369

Z
zengyawen 已提交
1370
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
1371

Z
zengyawen 已提交
1372
**返回值:**
B
bmeangel 已提交
1373

Z
zhangfeng 已提交
1374 1375
  | 类型 | 说明 |
  | -------- | -------- |
1376
  | Promise&lt;[WifiP2pGroupInfo](#wifip2pgroupinfo8)&gt; | Promise对象。表示当前组信息。 |
Z
zhangfeng 已提交
1377 1378 1379 1380 1381 1382


## wifi.getCurrentGroup<sup>8+</sup>

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

Z
zhangfeng 已提交
1383
获取P2P当前组信息,使用callback异步回调。
Z
zhangfeng 已提交
1384

Z
zhangfeng 已提交
1385
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
Z
zhangfeng 已提交
1386

Z
zengyawen 已提交
1387
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
1388

Z
zengyawen 已提交
1389
**参数:**
B
bmeangel 已提交
1390

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

Y
y00316381 已提交
1395

Z
zhangfeng 已提交
1396 1397 1398
## wifi.getP2pPeerDevices<sup>8+</sup>

getP2pPeerDevices(): Promise&lt;WifiP2pDevice[]&gt;
Y
y00316381 已提交
1399

Z
zhangfeng 已提交
1400
获取P2P对端设备列表信息,使用Promise异步回调。
Y
y00316381 已提交
1401

Z
zhangfeng 已提交
1402
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
Y
y00316381 已提交
1403 1404 1405 1406

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

**返回值:**
B
bmeangel 已提交
1407

Y
y00316381 已提交
1408 1409
  | 类型 | 说明 |
  | -------- | -------- |
1410
  | Promise&lt;[WifiP2pDevice[]](#wifip2pdevice8)&gt; | Promise对象。表示对端设备列表信息。 |
Y
y00316381 已提交
1411 1412


Z
zhangfeng 已提交
1413 1414 1415
## wifi.getP2pPeerDevices<sup>8+</sup>

getP2pPeerDevices(callback: AsyncCallback&lt;WifiP2pDevice[]&gt;): void
Y
y00316381 已提交
1416

Z
zhangfeng 已提交
1417
获取P2P对端设备列表信息,使用callback异步回调。
Y
y00316381 已提交
1418

Z
zhangfeng 已提交
1419
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
Y
y00316381 已提交
1420 1421 1422 1423

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

**参数:**
B
bmeangel 已提交
1424

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


Z
zhangfeng 已提交
1430
## WifiP2pDevice<sup>8+</sup>
Z
zhangfeng 已提交
1431 1432 1433

表示P2P设备信息。

Z
zhangfeng 已提交
1434 1435
**系统能力:** SystemCapability.Communication.WiFi.P2P

Z
zhangfeng 已提交
1436 1437 1438 1439 1440
| 参数名 | 类型 | 读写属性 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceName | string | 只读 | 设备名称。 |
| deviceAddress | string | 只读 | 设备MAC地址。 |
| primaryDeviceType | string | 只读 | 主设备类型。 |
1441
| deviceStatus | [P2pDeviceStatus](#p2pdevicestatus8) | 只读 | 设备状态。 |
1442
| groupCapabilitys | number | 只读 | 群组能力。 |
Z
zhangfeng 已提交
1443

Z
zhangfeng 已提交
1444

Z
zhangfeng 已提交
1445
## P2pDeviceStatus<sup>8+</sup>
Z
zhangfeng 已提交
1446 1447 1448

表示设备状态的枚举。

Z
zhangfeng 已提交
1449 1450
**系统能力:** SystemCapability.Communication.WiFi.P2P

Z
zhangfeng 已提交
1451 1452 1453 1454 1455 1456 1457 1458 1459
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| CONNECTED | 0 | 连接状态。 |
| INVITED | 1 | 邀请状态。 |
| FAILED | 2 | 失败状态。 |
| AVAILABLE | 3 | 可用状态。 |
| UNAVAILABLE | 4 | 不可用状态。 |


Y
y00316381 已提交
1460 1461 1462 1463
## wifi.getP2pLocalDevice<sup>9+</sup>

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

Z
zhangfeng 已提交
1464
获取P2P本端设备信息,使用Promise异步回调。
Y
y00316381 已提交
1465

Z
zhangfeng 已提交
1466
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG
Y
y00316381 已提交
1467 1468 1469 1470

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

**返回值:**
B
bmeangel 已提交
1471

Y
y00316381 已提交
1472 1473
  | 类型 | 说明 |
  | -------- | -------- |
1474
  | Promise&lt;[WifiP2pDevice](#wifip2pdevice8)&gt; | Promise对象。表示本端设备信息。 |
Y
y00316381 已提交
1475 1476


Z
zhangfeng 已提交
1477
## wifi.getP2pLocalDevice<sup>9+</sup>
Y
y00316381 已提交
1478 1479 1480

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

Z
zhangfeng 已提交
1481
获取P2P本端设备信息,使用callback异步回调。
Y
y00316381 已提交
1482

Z
zhangfeng 已提交
1483
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG
Y
y00316381 已提交
1484 1485 1486 1487

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

**参数:**
B
bmeangel 已提交
1488

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

Z
zhangfeng 已提交
1493 1494 1495

## wifi.createGroup<sup>8+</sup>

Z
zhangfeng 已提交
1496
createGroup(config: WifiP2PConfig): boolean
Z
zhangfeng 已提交
1497 1498 1499

创建群组。

Z
zengyawen 已提交
1500
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1501

Z
zengyawen 已提交
1502 1503 1504
**系统能力:** SystemCapability.Communication.WiFi.P2P

**参数:**
Z
zhangfeng 已提交
1505 1506 1507

  | **参数名** | **类型** | 必填 | **说明** |
  | -------- | -------- | -------- | -------- |
1508
  | config | [WifiP2PConfig](#wifip2pconfig8) | 是 | 群组配置信息。 |
Z
zhangfeng 已提交
1509

Z
zengyawen 已提交
1510
**返回值:**
B
bmeangel 已提交
1511

Z
zhangfeng 已提交
1512 1513 1514 1515
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | true:创建群组操作执行成功,&nbsp;false:创建群组操作执行失败。 |

Z
zhangfeng 已提交
1516

Z
zhangfeng 已提交
1517
## WifiP2PConfig<sup>8+</sup>
Z
zhangfeng 已提交
1518 1519 1520

表示P2P配置信息。

Z
zhangfeng 已提交
1521 1522
**系统能力:** SystemCapability.Communication.WiFi.P2P

Z
zhangfeng 已提交
1523 1524
| 参数名 | 类型 | 读写属性 | 说明 |
| -------- | -------- | -------- | -------- |
1525
| deviceAddress | string | 只读 | 设备地址。 |
Z
zhangfeng 已提交
1526 1527 1528
| netId | number | 只读 | 网络ID。创建群组时-1表示创建临时组,-2表示创建永久组。 |
| passphrase | string | 只读 | 群组密钥。 |
| groupName | string | 只读 | 群组名称。 |
1529
| goBand | [GroupOwnerBand](#groupownerband8) | 只读 | 群组带宽。 |
Z
zhangfeng 已提交
1530 1531


Z
zhangfeng 已提交
1532
## GroupOwnerBand<sup>8+</sup>
Z
zhangfeng 已提交
1533 1534 1535

表示群组带宽的枚举。

Z
zhangfeng 已提交
1536 1537
**系统能力:** SystemCapability.Communication.WiFi.P2P

Z
zhangfeng 已提交
1538 1539 1540 1541 1542 1543
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| GO_BAND_AUTO | 0 | 自动模式。 |
| GO_BAND_2GHZ | 1 | 2GHZ。 |
| GO_BAND_5GHZ | 2 | 5GHZ。 |

Z
zhangfeng 已提交
1544

Z
zhangfeng 已提交
1545 1546
## wifi.removeGroup<sup>8+</sup>

Z
zhangfeng 已提交
1547
removeGroup(): boolean
Z
zhangfeng 已提交
1548 1549 1550

移除群组。

Z
zengyawen 已提交
1551
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1552

Z
zengyawen 已提交
1553
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
1554

Z
zengyawen 已提交
1555
**返回值:**
B
bmeangel 已提交
1556

Z
zhangfeng 已提交
1557 1558 1559 1560 1561 1562 1563
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | true:操作执行成功,&nbsp;false:操作执行失败。 |


## wifi.p2pConnect<sup>8+</sup>

Z
zhangfeng 已提交
1564
p2pConnect(config: WifiP2PConfig): boolean
Z
zhangfeng 已提交
1565 1566 1567

执行P2P连接。

Z
zhangfeng 已提交
1568
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
Z
zengyawen 已提交
1569 1570

**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
1571

Z
zengyawen 已提交
1572
**参数:**
Z
zhangfeng 已提交
1573

B
bmeangel 已提交
1574

Z
zhangfeng 已提交
1575 1576
  | **参数名** | **类型** | 必填 | **说明** |
  | -------- | -------- | -------- | -------- |
1577
  | config | [WifiP2PConfig](#wifip2pconfig8) | 是 | 连接配置信息。 |
Z
zhangfeng 已提交
1578

Z
zengyawen 已提交
1579
**返回值:**
B
bmeangel 已提交
1580

Z
zhangfeng 已提交
1581 1582 1583 1584 1585
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | true:操作执行成功,&nbsp;false:操作执行失败。 |


Z
zengyawen 已提交
1586
**示例:**
Z
zhangfeng 已提交
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
  ```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);
  
Z
zhangfeng 已提交
1633
  var recvP2pPersistentGroupChangeFunc = () => {
Z
zhangfeng 已提交
1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
      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());
  ```

## wifi.p2pCancelConnect<sup>8+</sup>

Z
zhangfeng 已提交
1655
p2pCancelConnect(): boolean
Z
zhangfeng 已提交
1656 1657 1658

取消P2P连接。

Z
zengyawen 已提交
1659
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1660

Z
zengyawen 已提交
1661
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
1662

Z
zengyawen 已提交
1663
**返回值:**
B
bmeangel 已提交
1664

Z
zhangfeng 已提交
1665 1666
  | 类型 | 说明 |
  | -------- | -------- |
Z
zhangfeng 已提交
1667
  | boolean | true:操作执行成功,&nbsp;false:操作执行失败。 |
Z
zhangfeng 已提交
1668 1669 1670 1671


## wifi.startDiscoverDevices<sup>8+</sup>

Z
zhangfeng 已提交
1672
startDiscoverDevices(): boolean
Z
zhangfeng 已提交
1673 1674 1675

开始发现设备。

Z
zhangfeng 已提交
1676
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
Z
zhangfeng 已提交
1677

Z
zengyawen 已提交
1678
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
1679

Z
zengyawen 已提交
1680
**返回值:**
B
bmeangel 已提交
1681

Z
zhangfeng 已提交
1682 1683 1684 1685 1686 1687 1688
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | true:操作执行成功,&nbsp;false:操作执行失败。 |


## wifi.stopDiscoverDevices<sup>8+</sup>

Z
zhangfeng 已提交
1689
stopDiscoverDevices(): boolean
Z
zhangfeng 已提交
1690 1691 1692

停止发现设备。

Z
zengyawen 已提交
1693
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1694

Z
zengyawen 已提交
1695
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
1696

Z
zengyawen 已提交
1697
**返回值:**
B
bmeangel 已提交
1698

Z
zhangfeng 已提交
1699 1700 1701 1702 1703
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | true:操作执行成功,操作执行失败。 |


Z
zhangfeng 已提交
1704 1705 1706 1707 1708 1709
## wifi.deletePersistentGroup<sup>8+</sup>

deletePersistentGroup(netId: number): boolean

删除永久组。

Z
z00588131 已提交
1710 1711
**系统接口:** 此接口为系统接口。

1712
**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION
Z
zhangfeng 已提交
1713 1714 1715 1716 1717

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

**参数:**

B
bmeangel 已提交
1718

Z
zhangfeng 已提交
1719 1720 1721 1722 1723
  | **参数名** | **类型** | 必填 | **说明** |
  | -------- | -------- | -------- | -------- |
  | netId | number | 是 | 组的ID。 |

**返回值:**
B
bmeangel 已提交
1724

Z
zhangfeng 已提交
1725 1726 1727 1728 1729 1730
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | true:操作执行成功,操作执行失败。 |


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

Z
zhangfeng 已提交
1732 1733 1734 1735
getP2pGroups(): Promise&lt;Array&lt;WifiP2pGroupInfo&gt;&gt;

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

Z
z00588131 已提交
1736 1737
**系统接口:** 此接口为系统接口。

Z
zhangfeng 已提交
1738 1739 1740 1741 1742
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

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

**返回值:**
B
bmeangel 已提交
1743

Z
zhangfeng 已提交
1744 1745
  | 类型 | 说明 |
  | -------- | -------- |
1746
  | Promise&lt;&nbsp;Array&lt;[WifiP2pGroupInfo](#wifip2pgroupinfo8)&gt;&nbsp;&gt; | Promise对象。表示所有群组信息。 |
Z
zhangfeng 已提交
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757


## WifiP2pGroupInfo<sup>8+</sup>

表示P2P群组相关信息。

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

| 参数名 | 类型 | 读写属性 | 说明 |
| -------- | -------- | -------- | -------- |
| isP2pGo | boolean | 只读 | 是否是群主。 |
1758
| ownerInfo | [WifiP2pDevice](#wifip2pdevice8) | 只读 | 群组的设备信息。 |
Z
zhangfeng 已提交
1759 1760 1761 1762 1763
| passphrase | string | 只读 | 群组密钥。 |
| interface | string | 只读 | 接口名称。 |
| groupName | string | 只读 | 群组名称。 |
| networkId | number | 只读 | 网络ID。 |
| frequency | number | 只读 | 群组的频率。 |
1764
| clientDevices | [WifiP2pDevice[]](#wifip2pdevice8) | 只读 | 接入的设备列表信息。 |
Z
zhangfeng 已提交
1765 1766 1767 1768 1769 1770 1771 1772 1773
| goIpAddress | string | 只读 | 群组IP地址。 |


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

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

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

Z
z00588131 已提交
1774 1775
**系统接口:** 此接口为系统接口。

Z
zhangfeng 已提交
1776 1777 1778 1779 1780
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION

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

**参数:**
B
bmeangel 已提交
1781

Z
zhangfeng 已提交
1782 1783
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1784
  | callback | AsyncCallback&lt;&nbsp;Array&lt;[WifiP2pGroupInfo](#wifip2pgroupinfo8)&gt;&gt; | 是 | 回调函数。当操作成功时,err为0,data表示所有群组信息。如果error为非0,表示处理出现错误。 |
Z
zhangfeng 已提交
1785 1786 1787 1788 1789 1790 1791 1792


## wifi.setDeviceName<sup>8+</sup>

setDeviceName(devName: string): boolean

设置设备名称。

1793 1794 1795
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。
Z
zhangfeng 已提交
1796 1797 1798 1799

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

**参数:**
B
bmeangel 已提交
1800

Z
zhangfeng 已提交
1801 1802 1803 1804 1805
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | devName | string | 是 | 设备名称。 |

**返回值:**
B
bmeangel 已提交
1806

Z
zhangfeng 已提交
1807 1808 1809 1810 1811
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | true:操作成功,&nbsp;false:操作失败。 |


Z
zengyawen 已提交
1812 1813 1814 1815 1816 1817
## wifi.on('wifiStateChange')<sup>7+</sup>

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

注册WLAN状态改变事件。

Z
zengyawen 已提交
1818
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1819

Z
zengyawen 已提交
1820
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
1821

Z
zengyawen 已提交
1822
**参数:**
B
bmeangel 已提交
1823

Z
zengyawen 已提交
1824 1825
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
1826
  | type | string | 是 | 固定填"wifiStateChange"字符串。 |
Z
zengyawen 已提交
1827 1828
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

Z
zengyawen 已提交
1829 1830 1831 1832 1833 1834 1835 1836
**状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 未激活。 |
| 1 | 已激活。 |
| 2 | 激活中。 |
| 3 | 去激活中。 |
Z
zengyawen 已提交
1837 1838 1839 1840 1841 1842 1843 1844


## wifi.off('wifiStateChange')<sup>7+</sup>

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

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

Z
zengyawen 已提交
1845
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1846

Z
zengyawen 已提交
1847
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
1848

Z
zengyawen 已提交
1849
**参数:**
B
bmeangel 已提交
1850

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

Z
zengyawen 已提交
1856
**示例:**
Z
zhangfeng 已提交
1857
  ```js
Z
zengyawen 已提交
1858 1859 1860 1861
  import wifi from '@ohos.wifi';
  
  var WIFI_POWER_STATE = "wifiStateChange";
  var recvPowerNotifyFunc = result => {
Z
zhangfeng 已提交
1862
      console.info("Receive power state change event: " + result);
Z
zengyawen 已提交
1863 1864 1865
  }
  
  // Register event
Z
zhangfeng 已提交
1866
  wifi.on(WIFI_POWER_STATE, recvPowerNotifyFunc);
Z
zengyawen 已提交
1867 1868
  
  // Unregister event
Z
zhangfeng 已提交
1869
  wifi.off(WIFI_POWER_STATE, recvPowerNotifyFunc);
Z
zengyawen 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878
  ```


## wifi.on('wifiConnectionChange')<sup>7+</sup>

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

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

Z
zengyawen 已提交
1879
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1880

Z
zengyawen 已提交
1881
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
1882

Z
zengyawen 已提交
1883
**参数:**
B
bmeangel 已提交
1884

Z
zengyawen 已提交
1885 1886
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
1887
  | type | string | 是 | 固定填"wifiConnectionChange"字符串。 |
Z
zengyawen 已提交
1888 1889
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

Z
zengyawen 已提交
1890 1891 1892 1893 1894 1895
**连接状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 已断开。 |
| 1 | 已连接。 |
Z
zengyawen 已提交
1896 1897 1898 1899 1900 1901 1902 1903


## wifi.off('wifiConnectionChange')<sup>7+</sup>

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

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

Z
zengyawen 已提交
1904
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1905

Z
zengyawen 已提交
1906
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
1907

Z
zengyawen 已提交
1908
**参数:**
B
bmeangel 已提交
1909

Z
zengyawen 已提交
1910 1911
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
1912
  | type | string | 是 | 固定填"wifiConnectionChange"字符串。 |
Z
zengyawen 已提交
1913 1914 1915 1916 1917 1918 1919 1920 1921
  | callback | Callback&lt;number&gt; | 否 | 连接状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |


## wifi.on('wifiScanStateChange')<sup>7+</sup>

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

注册扫描状态改变事件。

Z
zengyawen 已提交
1922
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1923

Z
zengyawen 已提交
1924
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
1925

Z
zengyawen 已提交
1926
**参数:**
B
bmeangel 已提交
1927

Z
zengyawen 已提交
1928 1929
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
1930
  | type | string | 是 | 固定填"wifiScanStateChange"字符串。 |
Z
zengyawen 已提交
1931 1932
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

Z
zengyawen 已提交
1933 1934 1935 1936 1937 1938
**扫描状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 扫描失败。 |
| 1 | 扫描成功。 |
Z
zengyawen 已提交
1939 1940 1941 1942 1943 1944 1945 1946


## wifi.off('wifiScanStateChange')<sup>7+</sup>

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

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

Z
zengyawen 已提交
1947
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1948

Z
zengyawen 已提交
1949
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
1950

Z
zengyawen 已提交
1951
**参数:**
Z
zengyawen 已提交
1952 1953 1954

| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
1955
| type | string | 是 | 固定填"wifiScanStateChange"字符串。 |
Z
zengyawen 已提交
1956 1957 1958 1959 1960 1961 1962 1963 1964
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |


## wifi.on('wifiRssiChange')<sup>7+</sup>

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

注册RSSI状态改变事件。

Z
zengyawen 已提交
1965
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1966

Z
zengyawen 已提交
1967
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
1968

Z
zengyawen 已提交
1969
**参数:**
B
bmeangel 已提交
1970

Z
zengyawen 已提交
1971 1972
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
1973
  | type | string | 是 | 固定填"wifiRssiChange"字符串。 |
Z
zengyawen 已提交
1974 1975 1976 1977 1978 1979 1980 1981 1982
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数,返回以dBm为单位的RSSI值。 |


## wifi.off('wifiRssiChange')<sup>7+</sup>

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

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

Z
zengyawen 已提交
1983
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
1984

Z
zengyawen 已提交
1985
**系统能力:** SystemCapability.Communication.WiFi.STA
Z
zhangfeng 已提交
1986

Z
zengyawen 已提交
1987
**参数:**
B
bmeangel 已提交
1988

Z
zengyawen 已提交
1989 1990
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
1991
  | type | string | 是 | 固定填"wifiRssiChange"字符串。 |
Z
zengyawen 已提交
1992 1993 1994 1995 1996 1997 1998 1999 2000
  | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |


## wifi.on('hotspotStateChange')<sup>7+</sup>

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

注册热点状态改变事件。

Z
zengyawen 已提交
2001
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2002

Z
zengyawen 已提交
2003
**系统能力:** SystemCapability.Communication.WiFi.AP.Core
Z
zhangfeng 已提交
2004

Z
zengyawen 已提交
2005
**参数:**
B
bmeangel 已提交
2006

Z
zengyawen 已提交
2007 2008
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
2009
  | type | string | 是 | 固定填"hotspotStateChange"字符串。 |
Z
zengyawen 已提交
2010 2011
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

Z
zengyawen 已提交
2012 2013 2014 2015 2016 2017 2018 2019
**热点状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 未激活。 |
| 1 | 已激活。 |
| 2 | 激活中。 |
| 3 | 去激活中。 |
Z
zengyawen 已提交
2020 2021 2022 2023 2024 2025 2026 2027


## wifi.off('hotspotStateChange')<sup>7+</sup>

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

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

Z
zengyawen 已提交
2028
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2029

Z
zengyawen 已提交
2030
**系统能力:** SystemCapability.Communication.WiFi.AP.Core
Z
zhangfeng 已提交
2031

Z
zengyawen 已提交
2032
**参数:**
B
bmeangel 已提交
2033

Z
zengyawen 已提交
2034 2035
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
Z
zhangfeng 已提交
2036
  | type | string | 是 | 固定填"hotspotStateChange"字符串。 |
Z
zengyawen 已提交
2037
  | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
Z
zhangfeng 已提交
2038 2039 2040 2041 2042 2043 2044 2045


## wifi.on('p2pStateChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2046
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2047

Z
zengyawen 已提交
2048
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2049

Z
zengyawen 已提交
2050
**参数:**
B
bmeangel 已提交
2051

Z
zhangfeng 已提交
2052 2053 2054 2055 2056
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pStateChange"字符串。 |
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

Z
zengyawen 已提交
2057 2058 2059 2060 2061 2062 2063 2064 2065
**P2P状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 1 | 空闲。 |
| 2 | 打开中。 |
| 3 | 已打开。 |
| 4 | 关闭中。 |
| 5 | 已关闭。 |
Z
zhangfeng 已提交
2066 2067 2068 2069 2070 2071 2072

## wifi.off('p2pStateChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2073
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2074

Z
zengyawen 已提交
2075
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2076

Z
zengyawen 已提交
2077
**参数:**
B
bmeangel 已提交
2078

Z
zhangfeng 已提交
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pStateChange"字符串。 |
  | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |


  ## wifi.on('p2pConnectionChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2091
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2092

Z
zengyawen 已提交
2093
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2094

Z
zengyawen 已提交
2095
**参数:**
B
bmeangel 已提交
2096

Z
zhangfeng 已提交
2097 2098 2099
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
2100
  | callback | Callback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo8)&gt; | 是 | 状态改变回调函数。 |
Z
zhangfeng 已提交
2101 2102 2103 2104 2105 2106 2107 2108


## wifi.off('p2pConnectionChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2109
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2110

Z
zengyawen 已提交
2111
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2112

Z
zengyawen 已提交
2113
**参数:**
B
bmeangel 已提交
2114

Z
zhangfeng 已提交
2115 2116 2117
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
2118
  | callback | Callback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo8)&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
Z
zhangfeng 已提交
2119 2120 2121 2122 2123 2124 2125 2126


## wifi.on('p2pDeviceChange')<sup>8+</sup>

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

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

Z
zhangfeng 已提交
2127
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
Z
zhangfeng 已提交
2128

Z
zengyawen 已提交
2129
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2130

Z
zengyawen 已提交
2131
**参数:**
B
bmeangel 已提交
2132

Z
zhangfeng 已提交
2133 2134 2135
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
2136
  | callback | Callback&lt;[WifiP2pDevice](#wifip2pdevice8)&gt; | 是 | 状态改变回调函数。 |
Z
zhangfeng 已提交
2137 2138 2139 2140 2141 2142 2143 2144


## wifi.off('p2pDeviceChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2145
**需要权限:** ohos.permission.LOCATION
Z
zhangfeng 已提交
2146

Z
zengyawen 已提交
2147
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2148

Z
zengyawen 已提交
2149
**参数:**
B
bmeangel 已提交
2150

Z
zhangfeng 已提交
2151 2152 2153
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
2154
  | callback | Callback&lt;[WifiP2pDevice](#wifip2pdevice8)&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
Z
zhangfeng 已提交
2155 2156 2157 2158 2159 2160 2161 2162


## wifi.on('p2pPeerDeviceChange')<sup>8+</sup>

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

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

Z
zhangfeng 已提交
2163
**需要权限:** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
Z
zhangfeng 已提交
2164

Z
zengyawen 已提交
2165
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2166

Z
zengyawen 已提交
2167
**参数:**
B
bmeangel 已提交
2168

Z
zhangfeng 已提交
2169 2170 2171
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
2172
  | callback | Callback&lt;[WifiP2pDevice[]](#wifip2pdevice8)&gt; | 是 | 状态改变回调函数。 |
Z
zhangfeng 已提交
2173 2174 2175 2176 2177 2178 2179 2180


## wifi.off('p2pPeerDeviceChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2181
**需要权限:** ohos.permission.LOCATION
Z
zhangfeng 已提交
2182

Z
zengyawen 已提交
2183
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2184

Z
zengyawen 已提交
2185
**参数:**
B
bmeangel 已提交
2186

Z
zhangfeng 已提交
2187 2188 2189
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
2190
  | callback | Callback&lt;[WifiP2pDevice[]](#wifip2pdevice8)&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
Z
zhangfeng 已提交
2191 2192 2193 2194 2195 2196 2197 2198


## wifi.on('p2pPersistentGroupChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2199
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2200

Z
zengyawen 已提交
2201
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2202

Z
zengyawen 已提交
2203
**参数:**
B
bmeangel 已提交
2204

Z
zhangfeng 已提交
2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 |
  | callback | Callback&lt;void&gt; | 是 | 状态改变回调函数。 |


## wifi.off('p2pPersistentGroupChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2217
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2218

Z
zengyawen 已提交
2219
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2220

Z
zengyawen 已提交
2221
**参数:**
B
bmeangel 已提交
2222

Z
zhangfeng 已提交
2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 |
  | callback | Callback&lt;void&gt; | 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |


## wifi.on('p2pDiscoveryChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2235
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2236

Z
zengyawen 已提交
2237
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2238

Z
zengyawen 已提交
2239
**参数:**
B
bmeangel 已提交
2240

Z
zhangfeng 已提交
2241 2242 2243 2244 2245
  | **参数名** | **类型** | **必填** | **说明** |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 固定填"p2pDiscoveryChange"字符串。 |
  | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |

Z
zengyawen 已提交
2246 2247 2248 2249 2250 2251
**发现设备状态改变事件的枚举:**

| **枚举值** | **说明** |
| -------- | -------- |
| 0 | 初始状态。 |
| 1 | 发现成功。 |
Z
zhangfeng 已提交
2252 2253 2254 2255 2256 2257 2258 2259


## wifi.off('p2pDiscoveryChange')<sup>8+</sup>

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

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

Z
zengyawen 已提交
2260
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
2261

Z
zengyawen 已提交
2262
**系统能力:** SystemCapability.Communication.WiFi.P2P
Z
zhangfeng 已提交
2263

Z
zengyawen 已提交
2264
**参数:**
B
bmeangel 已提交
2265

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