Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 ea5c5541 编写于 作者: Z zhangfeng
浏览文件
操作

Update wifi document 

Signed-off-by: Nzhangfeng <hw.zhangfeng@huawei.com>
上级 b7d8bbdb
隐藏空白更改
内联 并排
Showing with 1069 addition and 63 deletion
zh-cn/application-dev/reference/apis/js-apis-wifi.md
浏览文件 @ ea5c5541
...@@ -6,17 +6,22 @@ ...@@ -6,17 +6,22 @@
## 导入模块 ## 导入模块
``` ```js
import wifi from '@ohos.wifi'; import wifi from '@ohos.wifi';
``` ```
## wifi.isWifiActive ## wifi.isWifiActive
isWifiActive(): boolean isWifiActive(): boolean
查询WLAN是否已激活。 查询WLAN是否已激活。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 返回值： - 返回值：
| **类型** | **说明** | | **类型** | **说明** |
| -------- | -------- | | -------- | -------- |
...@@ -29,10 +34,16 @@ scan(): boolean ...@@ -29,10 +34,16 @@ scan(): boolean
启动WLAN扫描。 启动WLAN扫描。
- 需要权限：
ohos.permission.SET_WIFI_INFO，ohos.permission.LOCATION
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 返回值： - 返回值：
| **类型** | **说明** | | **类型** | **说明** |
| -------- | -------- | | -------- | -------- |
| boolean | true:扫描操作成功，&nbsp;false:扫描操作执行失败。 | | boolean | true:扫描操作执行成功，&nbsp;false:扫描操作执行失败。 |
## wifi.getScanInfos ## wifi.getScanInfos
...@@ -41,6 +52,12 @@ getScanInfos(): Promise&lt;Array&lt;WifiScanInfo&gt;&gt; ...@@ -41,6 +52,12 @@ getScanInfos(): Promise&lt;Array&lt;WifiScanInfo&gt;&gt;
获取扫描结果，使用promise方式作为异步方法。 获取扫描结果，使用promise方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO以及ohos.permission.GET_WIFI_PEERS_MAC和ohos.permission.LOCATION权限中的至少一个。
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 返回值： - 返回值：
| **类型** | **说明** | | **类型** | **说明** |
| -------- | -------- | | -------- | -------- |
...@@ -53,39 +70,54 @@ getScanInfos(callback: AsyncCallback&lt;Array&lt;WifiScanInfo&gt;&gt;): void ...@@ -53,39 +70,54 @@ getScanInfos(callback: AsyncCallback&lt;Array&lt;WifiScanInfo&gt;&gt;): void
获取扫描结果，使用callback方式作为异步方法。 获取扫描结果，使用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; | 是 | 扫描到的热点列表结果回调函数。 | | callback | AsyncCallback&lt;&nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;&gt; | 是 | 扫描到的热点列表结果回调函数。 |
- 示例 - 示例
``` ```js
import wifi from '@ohos.wifi'; import wifi from '@ohos.wifi';
wifi.getScanInfos(result => { wifi.getScanInfos((err, result) => {
if (err) {
console.error("get scan info error");
return;
}
var len = Object.keys(result).length; var len = Object.keys(result).length;
console.log("wifi received scan info call back: " + len); console.log("wifi received scan info: " + len);
for (var i = 0; i < len; ++i) { for (var i = 0; i < len; ++i) {
console.info("ssid: " + result[i].ssid); console.info("ssid: " + result[i].ssid);
console.info("bssid: " + result[i].bssid); console.info("bssid: " + result[i].bssid);
console.info("capabilities: " + result[i].capabilities);
console.info("securityType: " + result[i].securityType); console.info("securityType: " + result[i].securityType);
console.info("rssi: " + result[i].rssi); console.info("rssi: " + result[i].rssi);
console.info("band: " + result[i].band); console.info("band: " + result[i].band);
console.info("frequency: " + result[i].frequency); console.info("frequency: " + result[i].frequency);
console.info("channelWidth: " + result[i].channelWidth);
console.info("timestamp: " + result[i].timestamp); console.info("timestamp: " + result[i].timestamp);
} }
}); });
wifi.getScanInfos().then(result => { wifi.getScanInfos().then(result => {
var len = Object.keys(result).length; var len = Object.keys(result).length;
console.log("wifi received scan info promise: " + len); console.log("wifi received scan info: " + len);
for (var i = 0; i < len; ++i) { for (var i = 0; i < len; ++i) {
console.info("ssid: " + result[i].ssid); console.info("ssid: " + result[i].ssid);
console.info("bssid: " + result[i].bssid); console.info("bssid: " + result[i].bssid);
console.info("capabilities: " + result[i].capabilities);
console.info("securityType: " + result[i].securityType); console.info("securityType: " + result[i].securityType);
console.info("rssi: " + result[i].rssi); console.info("rssi: " + result[i].rssi);
console.info("band: " + result[i].band); console.info("band: " + result[i].band);
console.info("frequency: " + result[i].frequency); console.info("frequency: " + result[i].frequency);
console.info("channelWidth: " + result[i].channelWidth);
console.info("timestamp: " + result[i].timestamp); console.info("timestamp: " + result[i].timestamp);
} }
}); });
...@@ -100,10 +132,12 @@ WLAN热点信息。 ...@@ -100,10 +132,12 @@ WLAN热点信息。
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 | | ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 |
| bssid | string | 只读 | 热点的BSSID。 | | bssid | string | 只读 | 热点的BSSID。 |
| securityType | [WifiSecurityType](#wifisecuritytype) | 只读 | WLAN加密类型。 | | capabilities | string | 只读 | 热点能力。 |
| securityType | [WifiSecurityType](#WifiSecurityType) | 只读 | WLAN加密类型。 |
| rssi | number | 只读 | 热点的信号强度(dBm)。 | | rssi | number | 只读 | 热点的信号强度(dBm)。 |
| band | number | 只读 | WLAN接入点的频段。 | | band | number | 只读 | WLAN接入点的频段。 |
| frequency | number | 只读 | WLAN接入点的频率。 | | frequency | number | 只读 | WLAN接入点的频率。 |
| channelWidth | number | 只读 | WLAN接入点的带宽。 |
| timestamp | number | 只读 | 时间戳。 | | timestamp | number | 只读 | 时间戳。 |
...@@ -120,61 +154,124 @@ WLAN热点信息。 ...@@ -120,61 +154,124 @@ WLAN热点信息。
| WIFI_SEC_TYPE_SAE | 4 | Simultaneous&nbsp;Authentication&nbsp;of&nbsp;Equals&nbsp;(SAE)加密类型。 | | WIFI_SEC_TYPE_SAE | 4 | Simultaneous&nbsp;Authentication&nbsp;of&nbsp;Equals&nbsp;(SAE)加密类型。 |
## wifi.getSignalLevel ## wifi.addUntrustedConfig
getSignalLevel(rssi: number, band: number): number addUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
查询WLAN信号强度。 添加不可信网络配置，使用promise方式作为异步方法。
- 参数： - 需要权限：
ohos.permission.SET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rssi | number | 是 | 热点的信号强度(dBm)。 | | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 |
| band | number | 是 | WLAN接入点的频段。 |
- 返回值： - 返回值：
| **类型** | **说明** | | **类型** | **说明** |
| -------- | -------- | | -------- | -------- |
| number | 信号强度，取值范围为[0,&nbsp;4]。 | | Promise&lt;boolean&gt; | 操作结果，ture: 成功， false: 失败。 |
## WifiDeviceConfig
## wifi.getIpInfo<sup>7+</sup> WLAN配置信息。
getIpInfo(): IpInfo | **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
| ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 |
| bssid | string | 只读 | 热点的BSSID。 |
| preSharedKey | string | 只读 | 热点的密钥。 |
| isHiddenSsid | boolean | 只读 | 是否是隐藏网络。 |
| securityType | [WifiSecurityType](#WifiSecurityType) | 只读 | 加密类型。 |
获取IP信息。
## wifi.addUntrustedConfig
addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&gt;): void
添加不可信网络配置，使用callback方式作为异步方法。
- 需要权限：
ohos.permission.SET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 操作结果，ture: 成功， false: 失败。 |
## wifi.removeUntrustedConfig
removeUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
移除不可信网络配置，使用promise方式作为异步方法。
- 需要权限：
ohos.permission.SET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 |
- 返回值： - 返回值：
| **类型** | **说明** | | **类型** | **说明** |
| -------- | -------- | | -------- | -------- |
| [IpInfo](#ipinfo) | 返回IP信息。 | | Promise&lt;boolean&gt; | 操作结果，ture: 成功， false: 失败。 |
## IpInfo ## wifi.removeUntrustedConfig
IP信息。 removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&gt;): void
| **参数名** | **类型** | **读写属性** | **说明** | 添加不可信网络配置，使用callback方式作为异步方法。
| -------- | -------- | -------- | -------- |
| ipAddress | number | 只读 | IP地址。 |
| gateway | number | 只读 | 网关。 |
| netmask | number | 只读 | 掩码。 |
| primaryDns | number | 只读 | 主DNS服务器IP地址。 |
| secondDns | number | 只读 | 备DNS服务器IP地址。 |
| serverIp | number | 只读 | DHCP服务端IP地址。 |
| leaseDuration | number | 只读 | IP地址租用时长。 |
- 需要权限：
ohos.permission.SET_WIFI_INFO
## wifi.isConnected<sup>7+</sup> - 系统能力：
SystemCapability.Communication.WiFi.STA
isConnected(): boolean - 参数
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 操作结果，ture: 成功， false: 失败。 |
查询WLAN是否已连接。
## wifi.getSignalLevel
getSignalLevel(rssi: number, band: number): number
查询WLAN信号强度。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数：
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| rssi | number | 是 | 热点的信号强度(dBm)。 |
| band | number | 是 | WLAN接入点的频段。 |
- 返回值： - 返回值：
| **类型** | **说明** | | **类型** | **说明** |
| -------- | -------- | | -------- | -------- |
| boolean | true:已连接，&nbsp;false:未连接。 | | number | 信号强度，取值范围为[0,&nbsp;4]。 |
## wifi.getLinkedInfo<sup>7+</sup> ## wifi.getLinkedInfo<sup>7+</sup>
...@@ -183,10 +280,16 @@ getLinkedInfo(): Promise&lt;WifiLinkedInfo&gt; ...@@ -183,10 +280,16 @@ getLinkedInfo(): Promise&lt;WifiLinkedInfo&gt;
获取WLAN连接信息，使用promise方式作为异步方法。 获取WLAN连接信息，使用promise方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 返回值： - 返回值：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[WifiLinkedInfo](#wifilinkedinfo)&gt; | 返回WLAN连接的相关信息。 | | Promise&lt;[WifiLinkedInfo](#WifiLinkedInfo)&gt; | WLAN连接的相关信息。 |
## wifi.getLinkedInfo<sup>7+</sup> ## wifi.getLinkedInfo<sup>7+</sup>
...@@ -195,23 +298,33 @@ getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void ...@@ -195,23 +298,33 @@ getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void
获取WLAN连接信息，使用callback方式作为异步方法。 获取WLAN连接信息，使用callback方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiLinkedInfo](#wifilinkedinfo)&gt; | 是 | 获取WLAN连接信息结果回调函数。 | | callback | AsyncCallback&lt;[WifiLinkedInfo](#WifiLinkedInfo)&gt; | 是 | WLAN连接信息结果回调函数。 |
- 示例 - 示例
``` ```js
import wifi from '@ohos.wifi'; import wifi from '@ohos.wifi';
wifi.getLinkedInfo(data => { wifi.getLinkedInfo((err, data) => {
console.info("get wifi linked info [callback]: " + JSON.stringify(data)); if (err) {
console.error("get linked info error");
return;
}
console.info("get wifi linked info: " + JSON.stringify(data));
}); });
wifi.getLinkedInfo().then(data => { wifi.getLinkedInfo().then(data => {
console.info("get wifi linked info [promise]: " + JSON.stringify(data)); console.info("get wifi linked info: " + JSON.stringify(data));
}).catch(error => { }).catch(error => {
console.info("linked info promise then error"); console.info("get linked info error");
}); });
``` ```
...@@ -232,7 +345,7 @@ getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void ...@@ -232,7 +345,7 @@ getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void
| isRestricted | boolean | 只读 | WLAN接入点是否限制数据量。 | | isRestricted | boolean | 只读 | WLAN接入点是否限制数据量。 |
| macAddress | string | 只读 | 设备的MAC地址。 | | macAddress | string | 只读 | 设备的MAC地址。 |
| ipAddress | number | 只读 | WLAN连接的IP地址。 | | ipAddress | number | 只读 | WLAN连接的IP地址。 |
| connState | ConnState | 只读 | WLAN连接状态。 | | connState | [ConnState](#ConnState) | 只读 | WLAN连接状态。 |
## ConnState ## ConnState
...@@ -251,16 +364,22 @@ getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void ...@@ -251,16 +364,22 @@ getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void
| UNKNOWN | 7 | WLAN连接建立失败。 | | UNKNOWN | 7 | WLAN连接建立失败。 |
## wifi.getCountryCode<sup>7+</sup> ## wifi.isConnected<sup>7+</sup>
getCountryCode(): string isConnected(): boolean
获取国家码信息。 查询WLAN是否已连接。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 返回值： - 返回值：
| **类型** | **说明** | | **类型** | **说明** |
| -------- | -------- | | -------- | -------- |
| string | 国家码。 | | boolean | true:已连接，&nbsp;false:未连接。 |
## wifi.isFeatureSupported<sup>7+</sup> ## wifi.isFeatureSupported<sup>7+</sup>
...@@ -269,6 +388,12 @@ isFeatureSupported(featureId: number): boolean ...@@ -269,6 +388,12 @@ isFeatureSupported(featureId: number): boolean
判断设备是否支持相关WLAN特性。 判断设备是否支持相关WLAN特性。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.Core
- 参数： - 参数：
| **参数名** | **类型** | 必填 | **说明** | | **参数名** | **类型** | 必填 | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -294,16 +419,450 @@ isFeatureSupported(featureId: number): boolean ...@@ -294,16 +419,450 @@ isFeatureSupported(featureId: number): boolean
| 0x20000000 | 增强开放特性。 | | 0x20000000 | 增强开放特性。 |
## wifi.getIpInfo<sup>7+</sup>
getIpInfo(): IpInfo
获取IP信息。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 返回值：
| **类型** | **说明** |
| -------- | -------- |
| [IpInfo](#IpInfo) | IP信息。 |
## IpInfo
IP信息。
| **参数名** | **类型** | **读写属性** | **说明** |
| -------- | -------- | -------- | -------- |
| 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
- 返回值：
| **类型** | **说明** |
| -------- | -------- |
| string | 国家码。 |
## wifi.getP2pLinkedInfo<sup>8+</sup>
getP2pLinkedInfo(): Promise&lt;WifiP2pLinkedInfo&gt;
获取P2P连接信息，使用promise方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)&gt; | P2P连接信息。 |
## wifi.getP2pLinkedInfo<sup>8+</sup>
getP2pLinkedInfo(callback: AsyncCallback&lt;WifiP2pLinkedInfo&gt;): void
获取P2P连接信息，使用callback方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)&gt; | 是 | P2P连接信息结果回调函数。 |
## WifiP2pLinkedInfo
提供WLAN连接的相关信息。
| 参数名 | 类型 | 读写属性 | 说明 |
| -------- | -------- | -------- | -------- |
| connectState | [P2pConnectState](#P2pConnectState) | 只读 | P2P连接状态。 |
| isGroupOwner | boolean | 只读 | 是否是群组。 |
| groupOwnerAddr | string | 只读 | 群组MAC地址。 |
## P2pConnectState
表示P2P连接状态的枚举。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| DISCONNECTED | 0 | 断开状态。 |
| CONNECTED | 1 | 连接状态。 |
## wifi.getCurrentGroup<sup>8+</sup>
getCurrentGroup(): Promise&lt;WifiP2pGroupInfo&gt;
获取P2P当前组信息，使用promise方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[WifiP2pGroupInfo](#WifiP2pGroupInfo)&gt; | 当前组信息。 |
## wifi.getCurrentGroup<sup>8+</sup>
getCurrentGroup(callback: AsyncCallback&lt;WifiP2pGroupInfo&gt;): void
获取P2P当前组信息，使用callback方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pGroupInfo](#WifiP2pGroupInfo)&gt; | 是 | 当前组信息的回调函数。 |
## WifiP2pGroupInfo
表示P2P群组相关信息。
| 参数名 | 类型 | 读写属性 | 说明 |
| -------- | -------- | -------- | -------- |
| isP2pGo | boolean | 只读 | 是否是群组。 |
| ownerInfo | [WifiP2pDevice](#WifiP2pDevice) | 只读 | 群组的设备信息。 |
| passphrase | string | 只读 | 群组密钥。 |
| interface | string | 只读 | 接口名称。 |
| groupName | string | 只读 | 群组名称。 |
| networkId | number | 只读 | 网络ID。 |
| frequency | number | 只读 | 群组的频率。 |
| clientDevices | [WifiP2pDevice[]](#WifiP2pDevice) | 只读 | 接入的设备列表信息。 |
| goIpAddress | string | 只读 | 群组IP地址。 |
## WifiP2pDevice
表示P2P设备信息。
| 参数名 | 类型 | 读写属性 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceName | string | 只读 | 设备名称。 |
| deviceAddress | string | 只读 | 设备MAC地址。 |
| primaryDeviceType | string | 只读 | 主设备类型。 |
| deviceStatus | [P2pDeviceStatus](#P2pDeviceStatus) | 只读 | 设备状态。 |
| groupCapabilitys | number | 只读 | 群组能力。 |
## P2pDeviceStatus
表示设备状态的枚举。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| CONNECTED | 0 | 连接状态。 |
| INVITED | 1 | 邀请状态。 |
| FAILED | 2 | 失败状态。 |
| AVAILABLE | 3 | 可用状态。 |
| UNAVAILABLE | 4 | 不可用状态。 |
## wifi.getP2pPeerDevices<sup>8+</sup>
getP2pPeerDevices(): Promise&lt;WifiP2pDevice[]&gt;
获取P2P对端设备列表信息，使用promise方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | 对端设备列表信息。 |
## wifi.getP2pPeerDevices<sup>8+</sup>
getP2pPeerDevices(callback: AsyncCallback&lt;WifiP2pDevice[]&gt;): void
获取P2P对端设备列表信息，使用callback方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | 是 | 对端设备列表信息回调函数。 |
## wifi.createGroup<sup>8+</sup>
createGroup(config: WifiP2PConfig): boolean;
创建群组。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 参数：
| **参数名** | **类型** | 必填 | **说明** |
| -------- | -------- | -------- | -------- |
| config | [WifiP2PConfig](#WifiP2PConfig) | 是 | 群组配置信息。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| boolean | true:创建群组操作执行成功，&nbsp;false:创建群组操作执行失败。 |
## WifiP2PConfig
表示P2P配置信息。
| 参数名 | 类型 | 读写属性 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceAddress | string | 只读 | 设备名称。 |
| netId | number | 只读 | 网络ID。创建群组时-1表示创建临时组，-2表示创建永久组。 |
| passphrase | string | 只读 | 群组密钥。 |
| groupName | string | 只读 | 群组名称。 |
| goBand | [GroupOwnerBand](#GroupOwnerBand) | 只读 | 群组带宽。 |
## GroupOwnerBand
表示群组带宽的枚举。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| GO_BAND_AUTO | 0 | 自动模式。 |
| GO_BAND_2GHZ | 1 | 2GHZ。 |
| GO_BAND_5GHZ | 2 | 5GHZ。 |
## wifi.removeGroup<sup>8+</sup>
removeGroup(): boolean;
移除群组。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| boolean | true:操作执行成功，&nbsp;false:操作执行失败。 |
## wifi.p2pConnect<sup>8+</sup>
p2pConnect(config: WifiP2PConfig): boolean;
执行P2P连接。
- 需要权限：
ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 参数：
| **参数名** | **类型** | 必填 | **说明** |
| -------- | -------- | -------- | -------- |
| config | [WifiP2PConfig](#WifiP2PConfig) | 是 | 连接配置信息。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| boolean | true:操作执行成功，&nbsp;false:操作执行失败。 |
- 示例
```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 = result => {
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>
p2pCancelConnect(): boolean;
取消P2P连接。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| boolean | true:取消连接操作执行成功，&nbsp;false:取消连接操作执行失败。 |
## wifi.startDiscoverDevices<sup>8+</sup>
startDiscoverDevices(): boolean;
开始发现设备。
- 需要权限：
ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| boolean | true:操作执行成功，&nbsp;false:操作执行失败。 |
## wifi.stopDiscoverDevices<sup>8+</sup>
stopDiscoverDevices(): boolean;
停止发现设备。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| boolean | true:操作执行成功，操作执行失败。 |
## wifi.on('wifiStateChange')<sup>7+</sup> ## wifi.on('wifiStateChange')<sup>7+</sup>
on(type: "wifiStateChange", callback: Callback&lt;number&gt;): void on(type: "wifiStateChange", callback: Callback&lt;number&gt;): void
注册WLAN状态改变事件。 注册WLAN状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiStateChange"字符串 | | type | string | 是 | 固定填"wifiStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 | | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |
- 状态改变事件的枚举。 - 状态改变事件的枚举。
...@@ -321,29 +880,32 @@ off(type: "wifiStateChange", callback?: Callback&lt;number&gt;): void ...@@ -321,29 +880,32 @@ off(type: "wifiStateChange", callback?: Callback&lt;number&gt;): void
取消注册WLAN状态改变事件。 取消注册WLAN状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiStateChange"字符串 | | type | string | 是 | 固定填"wifiStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
- 示例 - 示例
``` ```js
import wifi from '@ohos.wifi'; import wifi from '@ohos.wifi';
import { EventListener } from '@ohos.wifi';
var WIFI_POWER_STATE = "wifiStateChange"; var WIFI_POWER_STATE = "wifiStateChange";
var listener = new EventListener();
var recvPowerNotifyFunc = result => { var recvPowerNotifyFunc = result => {
console.info("power state receive event: " + result); console.info("Receive power state change event: " + result);
} }
// Register event // Register event
listener.on(WIFI_POWER_STATE, recvPowerNotifyFunc); wifi.on(WIFI_POWER_STATE, recvPowerNotifyFunc);
// Unregister event // Unregister event
listener.off(WIFI_POWER_STATE, recvPowerNotifyFunc); wifi.off(WIFI_POWER_STATE, recvPowerNotifyFunc);
``` ```
...@@ -353,10 +915,16 @@ on(type: "wifiConnectionChange", callback: Callback&lt;number&gt;): void ...@@ -353,10 +915,16 @@ on(type: "wifiConnectionChange", callback: Callback&lt;number&gt;): void
注册WLAN连接状态改变事件。 注册WLAN连接状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiConnectionChange"字符串 | | type | string | 是 | 固定填"wifiConnectionChange"字符串。 |
| callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 | | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |
- 连接状态改变事件的枚举。 - 连接状态改变事件的枚举。
...@@ -372,10 +940,16 @@ off(type: "wifiConnectionChange", callback?: Callback&lt;number&gt;): void ...@@ -372,10 +940,16 @@ off(type: "wifiConnectionChange", callback?: Callback&lt;number&gt;): void
取消注册WLAN连接状态改变事件。 取消注册WLAN连接状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiConnectionChange"字符串 | | type | string | 是 | 固定填"wifiConnectionChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 连接状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | | callback | Callback&lt;number&gt; | 否 | 连接状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
...@@ -385,10 +959,16 @@ on(type: "wifiScanStateChange", callback: Callback&lt;number&gt;): void ...@@ -385,10 +959,16 @@ on(type: "wifiScanStateChange", callback: Callback&lt;number&gt;): void
注册扫描状态改变事件。 注册扫描状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiScanStateChange"字符串 | | type | string | 是 | 固定填"wifiScanStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 | | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |
- 扫描状态改变事件的枚举。 - 扫描状态改变事件的枚举。
...@@ -404,11 +984,17 @@ off(type: "wifiScanStateChange", callback?: Callback&lt;number&gt;): void ...@@ -404,11 +984,17 @@ off(type: "wifiScanStateChange", callback?: Callback&lt;number&gt;): void
取消注册扫描状态改变事件。 取消注册扫描状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiScanStateChange"字符串 | | type | string | 是 | 固定填"wifiScanStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
...@@ -418,10 +1004,16 @@ on(type: "wifiRssiChange", callback: Callback&lt;number&gt;): void ...@@ -418,10 +1004,16 @@ on(type: "wifiRssiChange", callback: Callback&lt;number&gt;): void
注册RSSI状态改变事件。 注册RSSI状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiRssiChange"字符串 | | type | string | 是 | 固定填"wifiRssiChange"字符串。 |
| callback | Callback&lt;number&gt; | 是 | 状态改变回调函数，返回以dBm为单位的RSSI值。 | | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数，返回以dBm为单位的RSSI值。 |
...@@ -431,10 +1023,16 @@ off(type: "wifiRssiChange", callback?: Callback&lt;number&gt;): void ...@@ -431,10 +1023,16 @@ off(type: "wifiRssiChange", callback?: Callback&lt;number&gt;): void
取消注册RSSI状态改变事件。 取消注册RSSI状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.STA
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiRssiChange"字符串 | | type | string | 是 | 固定填"wifiRssiChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
...@@ -444,10 +1042,16 @@ on(type: "hotspotStateChange", callback: Callback&lt;number&gt;): void ...@@ -444,10 +1042,16 @@ on(type: "hotspotStateChange", callback: Callback&lt;number&gt;): void
注册热点状态改变事件。 注册热点状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.AP
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"hotspotStateChange"字符串 | | type | string | 是 | 固定填"hotspotStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 | | callback | Callback&lt;number&gt; | 是 | 状态改变回调函数。 |
- 热点状态改变事件的枚举。 - 热点状态改变事件的枚举。
...@@ -465,8 +1069,257 @@ off(type: "hotspotStateChange", callback?: Callback&lt;number&gt;): void ...@@ -465,8 +1069,257 @@ off(type: "hotspotStateChange", callback?: Callback&lt;number&gt;): void
取消注册热点状态改变事件。 取消注册热点状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.AP
- 参数 - 参数
| **参数名** | **类型** | **必填** | **说明** | | **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"hotspotStateChange"字符串 | | type | string | 是 | 固定填"hotspotStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | | callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pStateChange')<sup>8+</sup>
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 | 已关闭。 |
## wifi.off('p2pStateChange')<sup>8+</sup>
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不填，将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pConnectionChange')<sup>8+</sup>
on(type: "p2pConnectionChange", callback: Callback&lt;WifiP2pLinkedInfo&gt;): void
注册P2P连接状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 参数
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
| callback | Callback&lt;[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)&gt; | 是 | 状态改变回调函数。 |
## wifi.off('p2pConnectionChange')<sup>8+</sup>
off(type: "p2pConnectionChange", callback?: Callback&lt;WifiP2pLinkedInfo&gt;): void
取消注册P2P连接状态改变事件。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 参数
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
| callback | Callback&lt;[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pDeviceChange')<sup>8+</sup>
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"字符串。 |
| callback | Callback&lt;[WifiP2pDevice](#WifiP2pDevice)&gt; | 是 | 状态改变回调函数。 |
## wifi.off('p2pDeviceChange')<sup>8+</sup>
off(type: "p2pDeviceChange", callback?: Callback&lt;WifiP2pDevice&gt;): void
取消注册P2P设备状态改变事件。
- 需要权限：
ohos.permission.LOCATION
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 参数
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
| callback | Callback&lt;[WifiP2pDevice](#WifiP2pDevice)&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pPeerDeviceChange')<sup>8+</sup>
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"字符串。 |
| callback | Callback&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | 是 | 状态改变回调函数。 |
## wifi.off('p2pPeerDeviceChange')<sup>8+</sup>
off(type: "p2pPeerDeviceChange", callback?: Callback&lt;WifiP2pDevice[]&gt;): void
取消注册P2P对端设备状态改变事件。
- 需要权限：
ohos.permission.LOCATION
- 系统能力：
SystemCapability.Communication.WiFi.P2P
- 参数
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
| callback | Callback&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pPersistentGroupChange')<sup>8+</sup>
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; | 是 | 状态改变回调函数。 |
## wifi.off('p2pPersistentGroupChange')<sup>8+</sup>
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不填，将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pDiscoveryChange')<sup>8+</sup>
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 | 发现成功。 |
## wifi.off('p2pDiscoveryChange')<sup>8+</sup>
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不填，将去注册该事件关联的所有回调函数。 |
zh-cn/application-dev/reference/apis/js-apis-wifiext.md 0 → 100755
浏览文件 @ ea5c5541
# WLAN
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
该文档中的接口只供非通用类型产品使用，如路由器等，对于常规类型产品，不应该使用这些接口。
## 导入模块
```js
import wifiext from '@ohos.wifiext';
```
## wifiext.enableHotspot
enableHotspot(): boolean;
使能WLAN热点。
- 需要权限：
ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
- 系统能力：
SystemCapability.Communication.WiFi.HotspotExt
- 返回值：
| **类型** | **说明** |
| -------- | -------- |
| boolean | 操作结果， true: 成功， false: 失败。 |
## wifiext.disableHotspot
disableHotspot(): boolean;
去使能WLAN热点。
- 需要权限：
ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
- 系统能力：
SystemCapability.Communication.WiFi.HotspotExt
- 返回值：
| **类型** | **说明** |
| -------- | -------- |
| boolean | 操作结果， true: 成功， false: 失败。 |
## wifiext.getSupportedPowerModel
getSupportedPowerModel(): Promise&lt;Array&lt;PowerModel&gt;&gt;
获取支持的功率模式，使用promise方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.HotspotExt
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;Array&lt;[PowerModel](#PowerModel)&gt;&gt; | 功率模式。 |
## PowerModel
表示功率模式的枚举。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| SLEEPING | 0 | 睡眠模式。 |
| GENERAL | 1 | 常规模式。 |
| THROUGH_WALL | 2 | 穿墙模式。 |
## wifiext.getSupportedPowerModel
getSupportedPowerModel(callback: AsyncCallback&lt;Array&lt;PowerModel&gt;&gt;): void
获取支持的功率模式，使用callback方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.HotspotExt
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[PowerModel](#PowerModel)&gt; | 是 | 功率模式。 |
## wifiext.getPowerModel
getPowerModel(): Promise&lt;PowerModel&gt;
获取功率模式，使用promise方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.HotspotExt
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[PowerModel](#PowerModel)&gt; | 功率模式。 |
## wifiext.getPowerModel
getPowerModel(callback: AsyncCallback&lt;PowerModel&gt;): void
获取功率模式，使用callback方式作为异步方法。
- 需要权限：
ohos.permission.GET_WIFI_INFO
- 系统能力：
SystemCapability.Communication.WiFi.HotspotExt
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[PowerModel](#PowerModel)&gt; | 是 | 功率模式。 |
## wifiext.setPowerModel
setPowerModel(model: PowerModel) : boolean;
设置功率模式。
- 需要权限：
ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
- 系统能力：
SystemCapability.Communication.WiFi.HotspotExt
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| model | AsyncCallback&lt;[PowerModel](#PowerModel)&gt; | 是 | 功率模式。 |
- 返回值：
| **类型** | **说明** |
| -------- | -------- |
| boolean | 操作结果， true: 成功， false: 失败。 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或