Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 aea84c78 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!18416 修改md文档与d.ts不一致的问题 

Merge pull request !18416 from 刘姣姣/master
上级 3db40cb3 4331c3c0
隐藏空白更改
内联 并排
Showing with 1359 addition and 238 deletion
zh-cn/application-dev/reference/apis/js-apis-wifi.md
浏览文件 @ aea84c78
......@@ -31,6 +31,17 @@ enableWifi(): boolean
| -------- | -------- |
| boolean | true:操作成功， false:操作失败。|
**示例：**
```
import wifi from '@ohos.wifi';
try {
wifi.enableWifi();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.disableWifi
......@@ -50,6 +61,17 @@ disableWifi(): boolean
| -------- | -------- |
| boolean | true:操作成功， false:操作失败。|
**示例：**
```
import wifi from '@ohos.wifi';
try {
wifi.disableWifi();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.isWifiActive
......@@ -67,6 +89,18 @@ isWifiActive(): boolean
| -------- | -------- |
| boolean | true:已使能， false:未使能。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let isActivate = wifi.isActivate();
console.info("isActivate:" + isActivate);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.scan
......@@ -84,6 +118,17 @@ scan(): boolean
| -------- | -------- |
| boolean | true:扫描操作执行成功， false:扫描操作执行失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
wifi.scan();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getScanInfos
......@@ -237,6 +282,25 @@ addDeviceConfig(config: WifiDeviceConfig): Promise<number>
| **类型** | **说明** |
| -------- | -------- |
| Promise<number> | Promise对象。返回添加的网络配置ID，如果值为-1表示添加失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 0
}
wifi.addDeviceConfig(config).then(result => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## WifiDeviceConfig
......@@ -312,7 +376,24 @@ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>)
| config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
| callback | AsyncCallback<number> | 是 | 回调函数。当操作成功时，err为0，data为添加的网络配置ID，如果data值为-1，表示添加失败。当error为非0，表示处理出现错误。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 0
}
wifi.addDeviceConfig(config,(error,result) => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.addUntrustedConfig<sup>7+</sup>
addUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
......@@ -334,7 +415,23 @@ addUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
| **类型** | **说明** |
| -------- | -------- |
| Promise&lt;boolean&gt; | Promise对象。表示操作结果，true: 成功， false: 失败。 |
**示例：**
`````
import wifi from '@ohos.wifi';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 0
}
wifi.addUntrustedConfig(config).then(result => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
`````
## wifi.addUntrustedConfig<sup>7+</sup>
......@@ -353,6 +450,23 @@ addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&
| config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当操作成功时，err为0，data表示操作结果，true: 成功， false: 失败。如果error为非0，表示处理出现错误。 |
**示例：**
`````
import wifi from '@ohos.wifi';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 0
}
wifi.addUntrustedConfig(config,(error,result) => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
`````
## wifi.removeUntrustedConfig<sup>7+</sup>
......@@ -375,6 +489,19 @@ removeUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
| **类型** | **说明** |
| -------- | -------- |
| Promise&lt;boolean&gt; | Promise对象。表示操作结果，true: 成功， false: 失败。 |
```
import wifi from '@ohos.wifi';
try {
let networkId = 0;
wifi.removeUntrustedConfig(networkId).then(result => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.removeUntrustedConfig<sup>7+</sup>
......@@ -394,6 +521,19 @@ removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boole
| config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当操作成功时，err为0，data表示操作结果，true: 成功， false: 失败。如果error为非0，表示处理出现错误。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let networkId = 0;
wifi.removeUntrustedConfig(networkId,(error,result) => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.connectToNetwork
......@@ -419,6 +559,18 @@ connectToNetwork(networkId: number): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let networkId = 0;
wifi.connectToNetwork(networkId);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.connectToDevice
......@@ -445,6 +597,22 @@ connectToDevice(config: WifiDeviceConfig): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 3
}
wifi.connectToDevice(config);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.disconnect
......@@ -465,6 +633,16 @@ disconnect(): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
wifi.disconnect();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getSignalLevel
......@@ -489,6 +667,20 @@ getSignalLevel(rssi: number, band: number): number
| -------- | -------- |
| number | 信号强度，取值范围为[0,&nbsp;4]。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let rssi = 0;
let band = 0;
let level = wifi.getSignalLevel(rssi,band);
console.info("lelvel:" + JSON.stringify(lelvel));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getLinkedInfo
......@@ -684,6 +876,19 @@ isFeatureSupported(featureId: number): boolean
| -------- | -------- |
| boolean | true:支持，&nbsp;false:不支持。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let featureId = 0；
let ret = wifi.isFeatureSupported(featureId);
console.info("isFeatureSupported:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getDeviceMacAddress<sup>7+</sup>
......@@ -703,6 +908,18 @@ getDeviceMacAddress(): string[]
| -------- | -------- |
| string[] | MAC地址。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let ret = wifi.getDeviceMacAddress();
console.info("deviceMacAddress:" + JSON.stringify(ret));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getIpInfo<sup>7+</sup>
......@@ -720,6 +937,17 @@ getIpInfo(): IpInfo
| -------- | -------- |
| [IpInfo](#ipinfo7) | IP信息。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let info = wifi.getIpInfo();
console.info("info:" + JSON.stringify(info));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## IpInfo<sup>7+</sup>
......@@ -754,6 +982,17 @@ getCountryCode(): string
| -------- | -------- |
| string | 国家码。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let code = wifi.getCountryCode();
console.info("code:" + code);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.reassociate<sup>7+</sup>
......@@ -773,6 +1012,16 @@ reassociate(): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
wifi.reassociate();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.reconnect<sup>7+</sup>
......@@ -792,6 +1041,16 @@ reconnect(): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
wifi.reconnect();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getDeviceConfigs<sup>7+</sup>
......@@ -811,6 +1070,17 @@ getDeviceConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;
| -------- | -------- |
| &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt; | 网络配置信息的数组。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let configs = wifi.getDeviceConfigs();
console.info("configs:" + JSON.stringify(configs));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.updateNetwork<sup>7+</sup>
......@@ -836,6 +1106,22 @@ updateNetwork(config: WifiDeviceConfig): number
| -------- | -------- |
| number | 返回更新的网络配置ID，如果值为-1表示更新失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 3
}
let ret = wifi.updateNetwork(config);
console.error("ret:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.disableNetwork<sup>7+</sup>
......@@ -861,6 +1147,17 @@ disableNetwork(netId: number): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let netId = 0;
wifi.disableNetwork(netId);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.removeAllNetwork<sup>7+</sup>
......@@ -880,6 +1177,16 @@ removeAllNetwork(): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
wifi.removeAllNetwork();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.removeDevice<sup>7+</sup>
......@@ -905,6 +1212,17 @@ removeDevice(id: number): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let id = 0;
wifi.removeDevice(id);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.enableHotspot<sup>7+</sup>
......@@ -924,6 +1242,16 @@ enableHotspot(): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。|
**示例：**
```
import wifi from '@ohos.wifi';
try {
wifi.enableHotspot();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.disableHotspot<sup>7+</sup>
......@@ -943,6 +1271,16 @@ disableHotspot(): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.disableHotspot();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.isHotspotDualBandSupported<sup>7+</sup>
......@@ -962,6 +1300,17 @@ isHotspotDualBandSupported(): boolean
| -------- | -------- |
| boolean | true:支持，&nbsp;false:不支持。|
**示例：**
```
import wifi from '@ohos.wifi';
try {
let ret = wifi.isHotspotDualBandSupported();
console.info("result:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.isHotspotActive<sup>7+</sup>
......@@ -981,6 +1330,17 @@ isHotspotActive(): boolean
| -------- | -------- |
| boolean | true:已使能，&nbsp;false:未使能。|
**示例：**
```
import wifi from '@ohos.wifi';
try {
let ret = wifi.isHotspotActive();
console.info("result:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.setHotspotConfig<sup>7+</sup>
......@@ -1006,6 +1366,25 @@ setHotspotConfig(config: HotspotConfig): boolean
| -------- | -------- |
| boolean | true:操作成功，&nbsp;false:操作失败。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let config = {
ssid: "****",
securityType: 3,
band: 0,
channel: 0,
preSharedKey: "****",
maxConn: 0
}
let ret = wifi.setHotspotConfig();
console.info("result:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## HotspotConfig<sup>7+</sup>
......@@ -1042,6 +1421,17 @@ getHotspotConfig(): HotspotConfig
| -------- | -------- |
| [HotspotConfig](#hotspotconfig7) | 热点的配置信息。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let config = wifi.getHotspotConfig();
console.info("result:" + JSON.stringify(config));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getStations<sup>7+</sup>
......@@ -1061,6 +1451,17 @@ getStations(): &nbsp;Array&lt;[StationInfo](#stationinfo7)&gt;
| -------- | -------- |
| &nbsp;Array&lt;[StationInfo](#stationinfo7)&gt; | 连接的设备数组。 |
**示例：**
```
import wifi from '@ohos.wifi';
try {
let stations = wifi.getStations();
console.info("result:" + JSON.stringify(stations));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## StationInfo<sup>7+</sup>
......@@ -1136,6 +1537,22 @@ getP2pLinkedInfo(callback: AsyncCallback&lt;WifiP2pLinkedInfo&gt;): void
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo8)&gt; | 是 | 回调函数。当操作成功时，err为0，data表示P2P连接信息。如果error为非0，表示处理出现错误。 |
**示例：**
```
import wifi from '@ohos.wifi';
wifi.getP2pLinkedInfo((err, data) => {
if (err) {
console.error("get p2p linked info error");
return;
}
console.info("get wifi p2p linked info: " + JSON.stringify(data));
});
wifi.getP2pLinkedInfo().then(data => {
console.info("get wifi p2p linked info: " + JSON.stringify(data));
});
```
## wifi.getCurrentGroup<sup>8+</sup>
......@@ -1170,6 +1587,22 @@ getCurrentGroup(callback: AsyncCallback&lt;WifiP2pGroupInfo&gt;): void
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pGroupInfo](#wifip2pgroupinfo8)&gt; | 是 | 回调函数。当操作成功时，err为0，data表示当前组信息。如果error为非0，表示处理出现错误。 |
**示例：**
```
import wifi from '@ohos.wifi';
wifi.getCurrentGroup((err, data) => {
if (err) {
console.error("get current P2P group error");
return;
}
console.info("get current P2P group: " + JSON.stringify(data));
});
wifi.getCurrentGroup().then(data => {
console.info("get current P2P group: " + JSON.stringify(data));
});
```
## wifi.getP2pPeerDevices<sup>8+</sup>
......@@ -1204,6 +1637,22 @@ getP2pPeerDevices(callback: AsyncCallback&lt;WifiP2pDevice[]&gt;): void
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pDevice[]](#wifip2pdevice8)&gt; | 是 | 回调函数。当操作成功时，err为0，data表示对端设备列表信息。如果error为非0，表示处理出现错误。 |
**示例：**
```
import wifi from '@ohos.wifiManager';
wifi.getP2pPeerDevices((err, data) => {
if (err) {
console.error("get P2P peer devices error");
return;
}
console.info("get P2P peer devices: " + JSON.stringify(data));
});
wifi.getP2pPeerDevices().then(data => {
console.info("get P2P peer devices: " + JSON.stringify(data));
});
```
## WifiP2pDevice<sup>8+</sup>
......
zh-cn/application-dev/reference/apis/js-apis-wifiManager.md
浏览文件 @ aea84c78
......@@ -19,7 +19,7 @@ enableWifi(): void
**系统接口：** 此接口为系统接口。
**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。
**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION 仅系统应用可用。
**系统能力：** SystemCapability.Communication.WiFi.STA
......@@ -33,10 +33,21 @@ enableWifi(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.enableWifi();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.disableWifi<sup>9+</sup>
......@@ -60,10 +71,22 @@ disableWifi(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.disableWifi();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.isWifiActive<sup>9+</sup>
isWifiActive(): boolean
......@@ -84,17 +107,30 @@ isWifiActive(): boolean
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let isActivate = wifiManager.isActivate();
console.info("isActivate:" + isActivate);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.scan<sup>9+</sup>
scan(): void
启动WLAN扫描。
**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.STA
......@@ -108,100 +144,74 @@ scan(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
## wifi.getScanResults<sup>9+</sup>
getScanResults(): Promise&lt;Array&lt;WifiScanInfo&gt;&gt;
获取扫描结果，使用Promise异步回调。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION)
**系统能力：** SystemCapability.Communication.WiFi.STA
**返回值：**
| **类型** | **说明** |
| -------- | -------- |
| Promise&lt;&nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;&nbsp;&gt; | Promise对象。返回扫描到的热点列表。 |
**错误码：**
**示例：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
```
import wifi from '@ohos.wifiManager';
| **类型** | **说明** |
| -------- | -------- |
| 2501000 | Operation failed.|
try {
wifiManager.scan();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getScanResults<sup>9+</sup>
## wifi.getScanInfoList<sup>9+</sup>
getScanResults(callback: AsyncCallback&lt;Array&lt;WifiScanInfo&gt;&gt;): void
getScanInfoList(): Array&lt;WifiScanInfo&gt;;
获取扫描结果，使用callback异步回调。
获取扫描结果。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION)
**需要权限：** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 (ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION))
**系统能力：** SystemCapability.Communication.WiFi.STA
**参数：**
**返回值：**
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;&nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;&gt; | 是 | 回调函数。当成功时，err为0，data为扫描到的热点；否则err为非0值，data为空。 |
| **类型** | **说明** |
| -------- | -------- |
| Array&lt;[WifiScanInfo](#wifiscaninfo)&gt; | 返回扫描到的热点列表。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```js
import wifi from '@ohos.wifiManager';
wifi.getScanResults((err, result) => {
if (err) {
console.error("get scan info error");
return;
}
var len = Object.keys(result).length;
console.log("wifi received scan info: " + len);
for (var i = 0; i < len; ++i) {
console.info("ssid: " + result[i].ssid);
console.info("bssid: " + result[i].bssid);
console.info("capabilities: " + result[i].capabilities);
console.info("securityType: " + result[i].securityType);
console.info("rssi: " + result[i].rssi);
console.info("band: " + result[i].band);
console.info("frequency: " + result[i].frequency);
console.info("channelWidth: " + result[i].channelWidth);
console.info("timestamp: " + result[i].timestamp);
}
});
wifi.getScanResults().then(result => {
var len = Object.keys(result).length;
console.log("wifi received scan info: " + len);
for (var i = 0; i < len; ++i) {
console.info("ssid: " + result[i].ssid);
console.info("bssid: " + result[i].bssid);
console.info("capabilities: " + result[i].capabilities);
console.info("securityType: " + result[i].securityType);
console.info("rssi: " + result[i].rssi);
console.info("band: " + result[i].band);
console.info("frequency: " + result[i].frequency);
console.info("channelWidth: " + result[i].channelWidth);
console.info("timestamp: " + result[i].timestamp);
}
});
```
```
import wifi from '@ohos.wifiManager';
try {
let scanInfoList = wifiManager.getScanInfoList();
console.info("scanInfoList:" + JSON.stringify(scanInfoList));
let len = Object.keys(result).length;
console.log("wifi received scan info: " + len);
if(len > 0){
for (var i = 0; i < len; ++i) {
console.info("ssid: " + scanInfoList[i].ssid);
console.info("bssid: " + scanInfoList[i].bssid);
console.info("capabilities: " + scanInfoList[i].capabilities);
console.info("securityType: " + scanInfoList[i].securityType);
console.info("rssi: " + scanInfoList[i].rssi);
console.info("band: " + scanInfoList[i].band);
console.info("frequency: " + scanInfoList[i].frequency);
console.info("channelWidth: " + scanInfoList[i].channelWidth);
console.info("timestamp: " + scanInfoList[i].timestamp);
}
}
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## WifiScanInfo<sup>9+</sup>
......@@ -307,31 +317,6 @@ WLAN热点信息。
| WIDTH_80MHZ_PLUS | 4 | 80MHZ<sup>+</sup>。 |
| WIDTH_INVALID | 5 | 无效值 |
## wifi.getScanResultsSync<sup>9+</sup>
getScanResultsSync(): &nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;
获取扫描结果，使用同步方式返回结果。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION)
**系统能力：** SystemCapability.Communication.WiFi.STA
**返回值：**
| **类型** | **说明** |
| -------- | -------- |
| &nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt; | 扫描结果数组。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| -------- | -------- |
| 2501000 | Operation failed.|
## wifi.addDeviceConfig<sup>9+</sup>
addDeviceConfig(config: WifiDeviceConfig): Promise&lt;number&gt;
......@@ -360,10 +345,29 @@ addDeviceConfig(config: WifiDeviceConfig): Promise&lt;number&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 0
}
wifiManager.addDeviceConfig(config).then(result => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## WifiDeviceConfig<sup>9+</sup>
WLAN配置信息。
......@@ -512,10 +516,29 @@ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;number&gt;)
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 0
}
wifiManager.addDeviceConfig(config,(error,result) => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.addCandidateConfig<sup>9+</sup>
addCandidateConfig(config: WifiDeviceConfig): Promise&lt;number&gt;
......@@ -542,10 +565,28 @@ addCandidateConfig(config: WifiDeviceConfig): Promise&lt;number&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
`````
import wifi from '@ohos.wifiManager';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 0
}
wifiManager.addCandidateConfig(config).then(result => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
`````
## wifi.addCandidateConfig<sup>9+</sup>
addCandidateConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;number&gt;): void
......@@ -567,10 +608,28 @@ addCandidateConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;number&g
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
`````
import wifi from '@ohos.wifiManager';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 0
}
wifiManager.addCandidateConfig(config,(error,result) => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
`````
## wifi.removeCandidateConfig<sup>9+</sup>
removeCandidateConfig(networkId: number): Promise&lt;void&gt;
......@@ -597,10 +656,25 @@ removeCandidateConfig(networkId: number): Promise&lt;void&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let networkId = 0;
wifiManager.removeCandidateConfig(networkId).then(result => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.removeCandidateConfig<sup>9+</sup>
removeCandidateConfig(networkId: number, callback: AsyncCallback&lt;void&gt;): void
......@@ -622,17 +696,31 @@ removeCandidateConfig(networkId: number, callback: AsyncCallback&lt;void&gt;): v
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let networkId = 0;
wifiManager.removeCandidateConfig(networkId,(error,result) => {
console.info("result:" + JSON.stringify(result));
});
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getCandidateConfigs<sup>9+</sup>
getCandidateConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;
获取候选网络配置。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.STA
......@@ -646,9 +734,31 @@ getCandidateConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
| 2501000 | Operation failed.|
**示例：**
`````
import wifi from '@ohos.wifiManager';
try {
let configs = wifiManager.getCandidateConfigs();
console.info("configs:" + JSON.stringify(configs));
let len = Object.keys(configs).length;
console.log("result len: " + len);
if(len > 0){
for (var i = 0; i < len; ++i) {
console.info("ssid: " + configs[i].ssid);
console.info("bssid: " + configs[i].bssid);
}
}
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
`````
## wifi.connectToCandidateConfig<sup>9+</sup>
......@@ -670,11 +780,25 @@ connectToCandidateConfig(networkId: number): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
| 2501001 | Wifi is closed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let networkId = 0;
let ret = wifiManager.connectToCandidateConfig(networkId);
console.info("result:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.connectToNetwork<sup>9+</sup>
connectToNetwork(networkId: number): void
......@@ -697,11 +821,24 @@ connectToNetwork(networkId: number): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
| 2501001 | Wifi is closed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let networkId = 0;
wifiManager.connectToNetwork(networkId);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.connectToDevice<sup>9+</sup>
connectToDevice(config: WifiDeviceConfig): void
......@@ -725,11 +862,28 @@ connectToDevice(config: WifiDeviceConfig): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
| 2501001 | Wifi is closed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 3
}
wifiManager.connectToDevice(config);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.disconnect<sup>9+</sup>
disconnect(): void
......@@ -747,10 +901,21 @@ disconnect(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.disconnect();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getSignalLevel<sup>9+</sup>
getSignalLevel(rssi: number, band: number): number
......@@ -778,10 +943,25 @@ getSignalLevel(rssi: number, band: number): number
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let rssi = 0;
let band = 0;
let level = wifiManager.getSignalLevel(rssi,band);
console.info("lelvel:" + JSON.stringify(lelvel));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getLinkedInfo<sup>9+</sup>
getLinkedInfo(): Promise&lt;WifiLinkedInfo&gt;
......@@ -802,7 +982,7 @@ getLinkedInfo(): Promise&lt;WifiLinkedInfo&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
| 2501001 | Wifi is closed.|
......@@ -827,7 +1007,7 @@ getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
| 2501001 | Wifi is closed.|
......@@ -923,6 +1103,23 @@ getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void
| UNINITIALIZED | 10 | 连接建立失败。 |
| INVALID | 11 | 无效值。 |
## SuppState<sup>10+</sup>
表示Wi-Fi标准的枚举。
**系统能力：** SystemCapability.Communication.WiFi.STA
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| WIFI_STANDARD_UNDEFINED | 0 | 未定义。 |
| WIFI_STANDARD_11A | 1 | 11A。 |
| WIFI_STANDARD_11B | 2 | 11B。 |
| WIFI_STANDARD_11G | 3 | 11G。 |
| WIFI_STANDARD_11N | 4 | 11N。 |
| WIFI_STANDARD_11AC | 5 | 11AC。 |
| WIFI_STANDARD_11AX | 6 | 11AX。 |
| WIFI_STANDARD_11AD | 7 | 11AD。 |
## wifi.isConnected<sup>9+</sup>
......@@ -944,10 +1141,23 @@ isConnected(): boolean
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let ret = wifiManager.isConnected();
console.info("isConnected:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getSupportedFeatures<sup>9+</sup>
getSupportedFeatures(): number
......@@ -985,10 +1195,23 @@ getSupportedFeatures(): number
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2401000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let ret = wifiManager.getSupportedFeatures();
console.info("supportedFeatures:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.isFeatureSupported<sup>9+</sup>
isFeatureSupported(featureId: number): boolean
......@@ -1016,10 +1239,24 @@ isFeatureSupported(featureId: number): boolean
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2401000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let featureId = 0；
let ret = wifiManager.isFeatureSupported(featureId);
console.info("isFeatureSupported:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getDeviceMacAddress<sup>9+</sup>
getDeviceMacAddress(): string[]
......@@ -1042,10 +1279,23 @@ getDeviceMacAddress(): string[]
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let ret = wifiManager.getDeviceMacAddress();
console.info("deviceMacAddress:" + JSON.stringify(ret));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getIpInfo<sup>9+</sup>
getIpInfo(): IpInfo
......@@ -1066,10 +1316,22 @@ getIpInfo(): IpInfo
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let info = wifiManager.getIpInfo();
console.info("info:" + JSON.stringify(info));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## IpInfo<sup>9+</sup>
IP信息。
......@@ -1107,10 +1369,22 @@ getCountryCode(): string
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2401000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let code = wifiManager.getCountryCode();
console.info("code:" + code);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.reassociate<sup>9+</sup>
reassociate(): void
......@@ -1127,11 +1401,22 @@ reassociate(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
| 2501001 | Wifi is closed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.reassociate();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.reconnect<sup>9+</sup>
reconnect(): void
......@@ -1148,11 +1433,22 @@ reconnect(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
| 2501001 | Wifi is closed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.reconnect();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getDeviceConfigs<sup>9+</sup>
getDeviceConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;
......@@ -1161,7 +1457,7 @@ getDeviceConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;
**系统接口：** 此接口为系统接口。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.GET_WIFI_CONFIG
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION 和 ohos.permission.GET_WIFI_CONFIG
**系统能力：** SystemCapability.Communication.WiFi.STA
......@@ -1175,13 +1471,25 @@ getDeviceConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
## wifi.updateNetwork<sup>9+</sup>
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let configs = wifiManager.getDeviceConfigs();
console.info("configs:" + JSON.stringify(configs));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.updateDeviceConfig<sup>9+</sup>
updateNetwork(config: WifiDeviceConfig): number
updateDeviceConfig(config: WifiDeviceConfig): number
更新网络配置。
......@@ -1207,13 +1515,30 @@ updateNetwork(config: WifiDeviceConfig): number
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
## wifi.disableNetwork<sup>9+</sup>
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let config = {
ssid : "****",
preSharedKey : "****",
securityType : 3
}
let ret = wifiManager.updateDeviceConfig(config);
console.error("ret:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
disableNetwork(netId: number): void
## wifi.disableDeviceConfig<sup>9+</sup>
disableDeviceConfig(networkId: number): void
去使能网络配置。
......@@ -1227,19 +1552,31 @@ disableNetwork(netId: number): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| netId | number | 是 | 网络配置ID。 |
| networkId | number | 是 | 网络配置ID。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
## wifi.removeAllNetwork<sup>9+</sup>
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let netId = 0;
wifiManager.disableDeviceConfig(netId);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
removeAllNetwork(): void
## wifi.removeAllDeviceConfigs<sup>9+</sup>
removeAllDeviceConfigs(): void
移除所有网络配置。
......@@ -1253,13 +1590,24 @@ removeAllNetwork(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
## wifi.removeDevice<sup>9+</sup>
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.removeAllDeviceConfigs();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.removeDeviceConfig<sup>9+</sup>
removeDevice(id: number): void
removeDeviceConfig(networkId: number): void
移除指定的网络配置。
......@@ -1273,16 +1621,28 @@ removeDevice(id: number): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| id | number | 是 | 网络配置ID。 |
| networkId | number | 是 | 网络配置ID。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let id = 0;
wifiManager.removeDeviceConfig(id);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.isBandTypeSupported<sup>10+</sup>
isBandTypeSupported(bandType: WifiBandType): boolean
......@@ -1293,23 +1653,57 @@ isBandTypeSupported(bandType: WifiBandType): boolean
**系统能力：** SystemCapability.Communication.WiFi.STA
**参数：**
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| bandType | WifiBandType | 是 | Wifi 频段类型。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let type = 0;
boolean isBandTypeSupported = wifiManager.isBandTypeSupported(type);
console.info("isBandTypeSupported:" + isBandTypeSupported);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## WifiBandType <sup>10+</sup>
表示wifi频段类型的枚举。
**系统能力：** SystemCapability.Communication.WiFi.STA
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| WIFI_BAND_NONE | 0 | 未定义。 |
| WIFI_BAND_2G | 1 | 2G频段。 |
| WIFI_BAND_5G | 2 | 5G频段。 |
| WIFI_BAND_6G | 3 | 6G频段。 |
| WIFI_BAND_60G | 4 | 60G频段。|
## wifi.get5GChannelList<sup>10+</sup>
get5GChannelList(): Array<number>
get5GChannelList(): Array&lt;number&gt;
获取当前设备支持的5G信道列表。
**系统接口：** 此接口为系统接口。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG
**系统能力：** SystemCapability.Communication.WiFi.STA
......@@ -1317,10 +1711,22 @@ get5GChannelList(): Array<number>
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let channelList = wifiManager.get5GChannelList();
console.info("channelList:" + JSON.stringify(channelList));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.enableHotspot<sup>9+</sup>
enableHotspot(): void
......@@ -1337,10 +1743,21 @@ enableHotspot(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2601000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.enableHotspot();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.disableHotspot<sup>9+</sup>
disableHotspot(): void
......@@ -1357,10 +1774,21 @@ disableHotspot(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2601000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.disableHotspot();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.isHotspotDualBandSupported<sup>9+</sup>
isHotspotDualBandSupported(): boolean
......@@ -1383,10 +1811,22 @@ isHotspotDualBandSupported(): boolean
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2601000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let ret = wifiManager.isHotspotDualBandSupported();
console.info("result:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.isHotspotActive<sup>9+</sup>
isHotspotActive(): boolean
......@@ -1409,10 +1849,22 @@ isHotspotActive(): boolean
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2601000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let ret = wifiManager.isHotspotActive();
console.info("result:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.setHotspotConfig<sup>9+</sup>
setHotspotConfig(config: HotspotConfig): void
......@@ -1435,10 +1887,30 @@ setHotspotConfig(config: HotspotConfig): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2601000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let config = {
ssid: "****",
securityType: 3,
band: 0,
channel: 0,
preSharedKey: "****",
maxConn: 0
}
let ret = wifiManager.setHotspotConfig();
console.info("result:" + ret);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## HotspotConfig<sup>9+</sup>
热点配置信息。
......@@ -1478,19 +1950,31 @@ getHotspotConfig(): HotspotConfig
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2601000 | Operation failed.|
## wifi.getStations<sup>9+</sup>
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let config = wifiManager.getHotspotConfig();
console.info("result:" + JSON.stringify(config));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
getStations(): &nbsp;Array&lt;[StationInfo](#stationinfo9)&gt;
## wifi.getHotspotStations<sup>9+</sup>
getHotspotStations(): &nbsp;Array&lt;[StationInfo](#stationinfo9)&gt;
获取连接的设备。
**系统接口：** 此接口为系统接口。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.MANAGE_WIFI_HOTSPOT，仅系统应用可用。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION 和 ohos.permission.MANAGE_WIFI_HOTSPOT，仅系统应用可用。
**系统能力：** SystemCapability.Communication.WiFi.AP.Core
......@@ -1504,10 +1988,22 @@ getStations(): &nbsp;Array&lt;[StationInfo](#stationinfo9)&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2601000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let stations = wifiManager.getHotspotStations();
console.info("result:" + JSON.stringify(stations));
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## StationInfo<sup>9+</sup>
接入的设备信息。
......@@ -1543,10 +2039,28 @@ getP2pLinkedInfo(): Promise&lt;WifiP2pLinkedInfo&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
wifi.getP2pLinkedInfo((err, data) => {
if (err) {
console.error("get p2p linked info error");
return;
}
console.info("get wifi p2p linked info: " + JSON.stringify(data));
});
wifi.getP2pLinkedInfo().then(data => {
console.info("get wifi p2p linked info: " + JSON.stringify(data));
});
```
## WifiP2pLinkedInfo<sup>9+</sup>
提供WLAN连接的相关信息。
......@@ -1589,13 +2103,13 @@ getP2pLinkedInfo(callback: AsyncCallback&lt;WifiP2pLinkedInfo&gt;): void
| callback | AsyncCallback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo9)&gt; | 是 | 回调函数。当操作成功时，err为0，data表示P2P连接信息。如果error为非0，表示处理出现错误。 |
## wifi.getCurrentGroup<sup>9+</sup>
## wifi.getCurrentP2pGroup<sup>9+</sup>
getCurrentGroup(): Promise&lt;WifiP2pGroupInfo&gt;
getCurrentP2pGroup(): Promise&lt;WifiP2pGroupInfo&gt;
获取P2P当前组信息，使用Promise异步回调。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -1609,17 +2123,17 @@ getCurrentGroup(): Promise&lt;WifiP2pGroupInfo&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
## wifi.getCurrentGroup<sup>9+</sup>
## wifi.getCurrentP2pGroup<sup>9+</sup>
getCurrentGroup(callback: AsyncCallback&lt;WifiP2pGroupInfo&gt;): void
getCurrentP2pGroup(callback: AsyncCallback&lt;WifiP2pGroupInfo&gt;): void
获取P2P当前组信息，使用callback异步回调。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -1633,9 +2147,26 @@ getCurrentGroup(callback: AsyncCallback&lt;WifiP2pGroupInfo&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
wifi.getCurrentP2pGroup((err, data) => {
if (err) {
console.error("get current P2P group error");
return;
}
console.info("get current P2P group: " + JSON.stringify(data));
});
wifi.getCurrentP2pGroup().then(data => {
console.info("get current P2P group: " + JSON.stringify(data));
});
```
## wifi.getP2pPeerDevices<sup>9+</sup>
......@@ -1643,7 +2174,7 @@ getP2pPeerDevices(): Promise&lt;WifiP2pDevice[]&gt;
获取P2P对端设备列表信息，使用Promise异步回调。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -1657,7 +2188,7 @@ getP2pPeerDevices(): Promise&lt;WifiP2pDevice[]&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -1667,7 +2198,7 @@ getP2pPeerDevices(callback: AsyncCallback&lt;WifiP2pDevice[]&gt;): void
获取P2P对端设备列表信息，使用callback异步回调。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -1681,10 +2212,27 @@ getP2pPeerDevices(callback: AsyncCallback&lt;WifiP2pDevice[]&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
wifi.getP2pPeerDevices((err, data) => {
if (err) {
console.error("get P2P peer devices error");
return;
}
console.info("get P2P peer devices: " + JSON.stringify(data));
});
wifi.getP2pPeerDevices().then(data => {
console.info("get P2P peer devices: " + JSON.stringify(data));
});
```
## WifiP2pDevice<sup>9+</sup>
表示P2P设备信息。
......@@ -1735,7 +2283,7 @@ getP2pLocalDevice(): Promise&lt;WifiP2pDevice&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -1755,10 +2303,30 @@ getP2pLocalDevice(callback: AsyncCallback&lt;WifiP2pDevice&gt;): void
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pDevice](#wifip2pdevice9)&gt; | 是 | 回调函数。当操作成功时，err为0，data表示本端设备信息。如果error为非0，表示处理出现错误。 |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
## wifi.createGroup<sup>9+</sup>
**示例：**
```
import wifi from '@ohos.wifiManager';
wifiManager.getP2pLocalDevice((err, data) => {
if (err) {
console.error("get P2P local device error");
return;
}
console.info("get P2P local device: " + JSON.stringify(data));
});
wifi.getP2pLocalDevice().then(data => {
console.info("get P2P local device: " + JSON.stringify(data));
});
```
## wifi.createP2pGroup<sup>9+</sup>
createGroup(config: WifiP2PConfig): void
createP2pGroup(config: WifiP2PConfig): void
创建群组。
......@@ -1776,10 +2344,29 @@ createGroup(config: WifiP2PConfig): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let config = {
deviceAddress: "****",
netId: 0,
passphrase: "*****",
groupName: "****",
goBand: 0
}
wifiManager.createP2pGroup(config);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## WifiP2PConfig<sup>9+</sup>
表示P2P配置信息。
......@@ -1808,9 +2395,9 @@ createGroup(config: WifiP2PConfig): void
| GO_BAND_5GHZ | 2 | 5GHZ。 |
## wifi.removeGroup<sup>9+</sup>
## wifi.removeP2pGroup<sup>9+</sup>
removeGroup(): void
removeP2pGroup(): void
移除群组。
......@@ -1822,23 +2409,33 @@ removeGroup(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.removeP2pGroup();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.p2pConnect<sup>9+</sup>
p2pConnect(config: WifiP2PConfig): void
执行P2P连接。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
**参数：**
| **参数名** | **类型** | 必填 | **说明** |
| -------- | -------- | -------- | -------- |
| config | [WifiP2PConfig](#wifip2pconfig9) | 是 | 连接配置信息。 |
......@@ -1847,13 +2444,13 @@ p2pConnect(config: WifiP2PConfig): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
**示例：**
```js
import wifi from '@ohos.wifiManager';
import wifi from '@ohos.wifi';
var recvP2pConnectionChangeFunc = result => {
console.info("p2p connection change receive event: " + JSON.stringify(result));
......@@ -1915,7 +2512,7 @@ p2pConnect(config: WifiP2PConfig): void
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());
console.info("start discover devices -> " + wifi.startP2pDiscoverDevices());
```
## wifi.p2pCancelConnect<sup>9+</sup>
......@@ -1924,7 +2521,7 @@ p2pCancelConnect(): void
取消P2P连接。
**需要权限：** ohos.permission.GET_WIFI_INFO
**需要权限：** ohos.permission.GET_WIFI_INFO
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -1932,17 +2529,28 @@ p2pCancelConnect(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
## wifi.startDiscoverDevices<sup>9+</sup>
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.p2pCancelConnect();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.startDiscoverP2pDevices<sup>9+</sup>
startDiscoverDevices(): void
startDiscoverP2pDevices(): void
开始发现设备。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -1950,13 +2558,24 @@ startDiscoverDevices(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
## wifi.stopDiscoverDevices<sup>9+</sup>
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.startDiscoverP2pDevices();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.stopDiscoverP2pDevices<sup>9+</sup>
stopDiscoverDevices(): void
stopDiscoverP2pDevices(): void
停止发现设备。
......@@ -1968,13 +2587,24 @@ stopDiscoverDevices(): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
## wifi.deletePersistentGroup<sup>9+</sup>
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
wifiManager.stopDiscoverP2pDevices();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.deletePersistentP2pGroup<sup>9+</sup>
deletePersistentGroup(netId: number): void
deletePersistentP2pGroup(netId: number): void
删除永久组。
......@@ -1995,10 +2625,22 @@ deletePersistentGroup(netId: number): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let netId = 0;
wifiManager.deletePersistentP2pGroup(netId);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.getP2pGroups<sup>9+</sup>
getP2pGroups(): Promise&lt;Array&lt;WifiP2pGroupInfo&gt;&gt;
......@@ -2007,7 +2649,7 @@ getP2pGroups(): Promise&lt;Array&lt;WifiP2pGroupInfo&gt;&gt;
**系统接口：** 此接口为系统接口。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -2021,10 +2663,28 @@ getP2pGroups(): Promise&lt;Array&lt;WifiP2pGroupInfo&gt;&gt;
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
wifiManager.getP2pGroups((err, data) => {
if (err) {
console.error("get P2P groups error");
return;
}
console.info("get P2P groups: " + JSON.stringify(data));
});
wifi.getP2pGroups().then(data => {
console.info("get P2P groups: " + JSON.stringify(data));
});
```
## WifiP2pGroupInfo<sup>9+</sup>
表示P2P群组相关信息。
......@@ -2052,7 +2712,7 @@ getP2pGroups(callback: AsyncCallback&lt;Array&lt;WifiP2pGroupInfo&gt;&gt;): void
**系统接口：** 此接口为系统接口。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -2066,13 +2726,13 @@ getP2pGroups(callback: AsyncCallback&lt;Array&lt;WifiP2pGroupInfo&gt;&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
## wifi.setDeviceName<sup>9+</sup>
## wifi.setP2pDeviceName<sup>9+</sup>
setDeviceName(devName: string): void
setP2pDeviceName(devName: string): void
设置设备名称。
......@@ -2092,10 +2752,22 @@ setDeviceName(devName: string): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
**示例：**
```
import wifi from '@ohos.wifiManager';
try {
let name = "****";
wifiManager.setP2pDeviceName(netId);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
```
## wifi.on('wifiStateChange')<sup>9+</sup>
on(type: "wifiStateChange", callback: Callback&lt;number&gt;): void
......@@ -2117,7 +2789,7 @@ on(type: "wifiStateChange", callback: Callback&lt;number&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
......@@ -2146,19 +2818,19 @@ off(type: "wifiStateChange", callback?: Callback&lt;number&gt;): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
**示例：**
```js
import wifi from '@ohos.wifiManager';
import wifi from '@ohos.wifi';
var recvPowerNotifyFunc = result => {
console.info("Receive power state change event: " + result);
......@@ -2200,7 +2872,7 @@ on(type: "wifiConnectionChange", callback: Callback&lt;number&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
......@@ -2219,13 +2891,13 @@ off(type: "wifiConnectionChange", callback?: Callback&lt;number&gt;): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiConnectionChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 连接状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;number&gt; | 否 | 连接状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
......@@ -2257,7 +2929,7 @@ on(type: "wifiScanStateChange", callback: Callback&lt;number&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
......@@ -2276,13 +2948,13 @@ off(type: "wifiScanStateChange", callback?: Callback&lt;number&gt;): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiScanStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
......@@ -2307,7 +2979,7 @@ on(type: "wifiRssiChange", callback: Callback&lt;number&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
......@@ -2326,13 +2998,13 @@ off(type: "wifiRssiChange", callback?: Callback&lt;number&gt;): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"wifiRssiChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2501000 | Operation failed.|
......@@ -2366,7 +3038,7 @@ on(type: "hotspotStateChange", callback: Callback&lt;number&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2601000 | Operation failed.|
......@@ -2385,13 +3057,13 @@ off(type: "hotspotStateChange", callback?: Callback&lt;number&gt;): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"hotspotStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2601000 | Operation failed.|
......@@ -2426,7 +3098,7 @@ on(type: "p2pStateChange", callback: Callback&lt;number&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2445,13 +3117,13 @@ off(type: "p2pStateChange", callback?: Callback&lt;number&gt;): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pStateChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2476,7 +3148,7 @@ on(type: "p2pConnectionChange", callback: Callback&lt;WifiP2pLinkedInfo&gt;): vo
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2495,13 +3167,13 @@ off(type: "p2pConnectionChange", callback?: Callback&lt;WifiP2pLinkedInfo&gt;):
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
| callback | Callback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo9)&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo9)&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2511,7 +3183,7 @@ on(type: "p2pDeviceChange", callback: Callback&lt;WifiP2pDevice&gt;): void
注册P2P设备状态改变事件。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -2526,7 +3198,7 @@ on(type: "p2pDeviceChange", callback: Callback&lt;WifiP2pDevice&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2536,7 +3208,7 @@ off(type: "p2pDeviceChange", callback?: Callback&lt;WifiP2pDevice&gt;): void
取消注册P2P设备状态改变事件。
**需要权限：** ohos.permission.LOCATION
**需要权限：** ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -2545,13 +3217,13 @@ off(type: "p2pDeviceChange", callback?: Callback&lt;WifiP2pDevice&gt;): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
| callback | Callback&lt;[WifiP2pDevice](#wifip2pdevice9)&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;[WifiP2pDevice](#wifip2pdevice9)&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2561,7 +3233,7 @@ on(type: "p2pPeerDeviceChange", callback: Callback&lt;WifiP2pDevice[]&gt;): void
注册P2P对端设备状态改变事件。
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -2576,7 +3248,7 @@ on(type: "p2pPeerDeviceChange", callback: Callback&lt;WifiP2pDevice[]&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2586,7 +3258,7 @@ off(type: "p2pPeerDeviceChange", callback?: Callback&lt;WifiP2pDevice[]&gt;): vo
取消注册P2P对端设备状态改变事件。
**需要权限：** ohos.permission.LOCATION
**需要权限：** ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力：** SystemCapability.Communication.WiFi.P2P
......@@ -2595,13 +3267,13 @@ off(type: "p2pPeerDeviceChange", callback?: Callback&lt;WifiP2pDevice[]&gt;): vo
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
| callback | Callback&lt;[WifiP2pDevice[]](#wifip2pdevice9)&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;[WifiP2pDevice[]](#wifip2pdevice9)&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2626,7 +3298,7 @@ on(type: "p2pPersistentGroupChange", callback: Callback&lt;void&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2645,13 +3317,13 @@ off(type: "p2pPersistentGroupChange", callback?: Callback&lt;void&gt;): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 |
| callback | Callback&lt;void&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;void&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2683,7 +3355,7 @@ on(type: "p2pDiscoveryChange", callback: Callback&lt;number&gt;): void
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
......@@ -2702,12 +3374,12 @@ off(type: "p2pDiscoveryChange", callback?: Callback&lt;number&gt;): void
| **参数名** | **类型** | **必填** | **说明** |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pDiscoveryChange"字符串。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 |
| callback | Callback&lt;number&gt; | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。
| **类型** | **说明** |
| **错误码ID** | **错误信息** |
| -------- | -------- |
| 2801000 | Operation failed.|
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或