diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifi.md b/zh-cn/application-dev/reference/apis/js-apis-wifi.md index 4f6c7999eddc049acfedd560174f0d0f0445a5aa..c3b1746f3d5bb9a05e5e76b481f832c30bd6c6be 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifi.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifi.md @@ -31,6 +31,17 @@ enableWifi(): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。| +**示例：** + +```js +import wifi from '@ohos.wifi'; + +try { + wifi.enableWifi(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.disableWifi @@ -50,6 +61,18 @@ disableWifi(): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。| +**示例：** + +```js +import wifi from '@ohos.wifi'; + +try { + wifi.disableWifi(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} + +``` ## wifi.isWifiActive @@ -67,6 +90,18 @@ isWifiActive(): boolean | -------- | -------- | | boolean | true:已使能， false:未使能。 | +**示例：** + +```js +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 +119,17 @@ scan(): boolean | -------- | -------- | | boolean | true:扫描操作执行成功， false:扫描操作执行失败。 | +**示例：** + +```js +import wifi from '@ohos.wifi'; + +try { + wifi.scan(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.getScanInfos @@ -119,46 +165,47 @@ getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void | callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | 是 | 回调函数。当成功时，err为0，data为扫描到的热点；否则err为非0值，data为空。 | **示例：** - ```js - import wifi from '@ohos.wifi'; - - wifi.getScanInfos((err, result) => { - if (err) { - console.error("get scan info error"); - return; - } - - var len = Object.keys(result).length; - console.log("wifi received scan info: " + len); - for (var i = 0; i < len; ++i) { - console.info("ssid: " + result[i].ssid); - console.info("bssid: " + result[i].bssid); - console.info("capabilities: " + result[i].capabilities); - console.info("securityType: " + result[i].securityType); - console.info("rssi: " + result[i].rssi); - console.info("band: " + result[i].band); - console.info("frequency: " + result[i].frequency); - console.info("channelWidth: " + result[i].channelWidth); - console.info("timestamp: " + result[i].timestamp); - } - }); - - wifi.getScanInfos().then(result => { - var len = Object.keys(result).length; - console.log("wifi received scan info: " + len); - for (var i = 0; i < len; ++i) { - console.info("ssid: " + result[i].ssid); - console.info("bssid: " + result[i].bssid); - console.info("capabilities: " + result[i].capabilities); - console.info("securityType: " + result[i].securityType); - console.info("rssi: " + result[i].rssi); - console.info("band: " + result[i].band); - console.info("frequency: " + result[i].frequency); - console.info("channelWidth: " + result[i].channelWidth); - console.info("timestamp: " + result[i].timestamp); - } - }); - ``` + +```js +import wifi from '@ohos.wifi'; + +wifi.getScanInfos((err, result) => { + if (err) { + console.error("get scan info error"); + return; + } + + var len = Object.keys(result).length; + console.log("wifi received scan info: " + len); + for (var i = 0; i < len; ++i) { + console.info("ssid: " + result[i].ssid); + console.info("bssid: " + result[i].bssid); + console.info("capabilities: " + result[i].capabilities); + console.info("securityType: " + result[i].securityType); + console.info("rssi: " + result[i].rssi); + console.info("band: " + result[i].band); + console.info("frequency: " + result[i].frequency); + console.info("channelWidth: " + result[i].channelWidth); + console.info("timestamp: " + result[i].timestamp); + } +}); + +wifi.getScanInfos().then(result => { + var len = Object.keys(result).length; + console.log("wifi received scan info: " + len); + for (var i = 0; i < len; ++i) { + console.info("ssid: " + result[i].ssid); + console.info("bssid: " + result[i].bssid); + console.info("capabilities: " + result[i].capabilities); + console.info("securityType: " + result[i].securityType); + console.info("rssi: " + result[i].rssi); + console.info("band: " + result[i].band); + console.info("frequency: " + result[i].frequency); + console.info("channelWidth: " + result[i].channelWidth); + console.info("timestamp: " + result[i].timestamp); + } +}); +``` ## WifiScanInfo @@ -238,6 +285,25 @@ addDeviceConfig(config: WifiDeviceConfig): Promise<number> | -------- | -------- | | Promise<number> | Promise对象。返回添加的网络配置ID，如果值为-1表示添加失败。 | + **示例：** + +```js +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 WLAN配置信息。 @@ -312,7 +378,24 @@ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>) | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | | callback | AsyncCallback<number> | 是 | 回调函数。当操作成功时，err为0，data为添加的网络配置ID，如果data值为-1，表示添加失败。当error为非0，表示处理出现错误。 | +**示例：** +```js +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.addUntrustedConfig7+ addUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> @@ -335,6 +418,23 @@ addUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> | -------- | -------- | | Promise<boolean> | Promise对象。表示操作结果，true: 成功， false: 失败。 | +**示例：** +```js +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.addUntrustedConfig7+ @@ -353,6 +453,23 @@ addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean& | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。当操作成功时，err为0，data表示操作结果，true: 成功， false: 失败。如果error为非0，表示处理出现错误。 | +**示例：** +```js +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.removeUntrustedConfig7+ @@ -376,6 +493,21 @@ removeUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> | -------- | -------- | | Promise<boolean> | Promise对象。表示操作结果，true: 成功， false: 失败。 | +**示例：** + +```js +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.removeUntrustedConfig7+ @@ -394,6 +526,19 @@ removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boole | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。当操作成功时，err为0，data表示操作结果，true: 成功， false: 失败。如果error为非0，表示处理出现错误。 | +**示例：** +```js +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 +564,18 @@ connectToNetwork(networkId: number): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** + +```js +import wifi from '@ohos.wifi'; + +try { + let networkId = 0; + wifi.connectToNetwork(networkId); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.connectToDevice @@ -445,6 +602,22 @@ connectToDevice(config: WifiDeviceConfig): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** +```js +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 +638,16 @@ disconnect(): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.disconnect(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.getSignalLevel @@ -489,6 +672,20 @@ getSignalLevel(rssi: number, band: number): number | -------- | -------- | | number | 信号强度，取值范围为[0, 4]。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let rssi = 0; + let band = 0; + let level = wifi.getSignalLevel(rssi,band); + console.info("level:" + JSON.stringify(level)); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} + +``` ## wifi.getLinkedInfo @@ -524,23 +721,23 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void | callback | AsyncCallback<[WifiLinkedInfo](#wifilinkedinfo)> | 是 | 回调函数。当获取成功时，err为0，data表示WLAN连接信息。如果error为非0，表示处理出现错误。 | **示例：** - ```js - import wifi from '@ohos.wifi'; - - wifi.getLinkedInfo((err, data) => { - if (err) { - console.error("get linked info error"); - return; - } - console.info("get wifi linked info: " + JSON.stringify(data)); - }); - - wifi.getLinkedInfo().then(data => { - console.info("get wifi linked info: " + JSON.stringify(data)); - }).catch(error => { - console.info("get linked info error"); - }); - ``` +```js +import wifi from '@ohos.wifi'; + +wifi.getLinkedInfo((err, data) => { + if (err) { + console.error("get linked info error"); + return; + } + console.info("get wifi linked info: " + JSON.stringify(data)); +}); + +wifi.getLinkedInfo().then(data => { + console.info("get wifi linked info: " + JSON.stringify(data)); +}).catch(error => { + console.info("get linked info error"); +}); +``` ## WifiLinkedInfo @@ -684,6 +881,19 @@ isFeatureSupported(featureId: number): boolean | -------- | -------- | | boolean | true:支持， false:不支持。 | +**示例：** +```js +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.getDeviceMacAddress7+ @@ -703,6 +913,18 @@ getDeviceMacAddress(): string[] | -------- | -------- | | string[] | MAC地址。 | +**示例：** +```js +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.getIpInfo7+ @@ -720,6 +942,17 @@ getIpInfo(): IpInfo | -------- | -------- | | [IpInfo](#ipinfo7) | IP信息。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let info = wifi.getIpInfo(); + console.info("info:" + JSON.stringify(info)); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## IpInfo7+ @@ -754,6 +987,17 @@ getCountryCode(): string | -------- | -------- | | string | 国家码。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let code = wifi.getCountryCode(); + console.info("code:" + code); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.reassociate7+ @@ -773,6 +1017,16 @@ reassociate(): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.reassociate(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.reconnect7+ @@ -792,6 +1046,16 @@ reconnect(): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.reconnect(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.getDeviceConfigs7+ @@ -811,6 +1075,17 @@ getDeviceConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> | -------- | -------- | |  Array<[WifiDeviceConfig](#wifideviceconfig)> | 网络配置信息的数组。 | +**示例：** +```js +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.updateNetwork7+ @@ -836,6 +1111,22 @@ updateNetwork(config: WifiDeviceConfig): number | -------- | -------- | | number | 返回更新的网络配置ID，如果值为-1表示更新失败。 | +**示例：** +```js +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.disableNetwork7+ @@ -861,6 +1152,17 @@ disableNetwork(netId: number): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let netId = 0; + wifi.disableNetwork(netId); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.removeAllNetwork7+ @@ -880,6 +1182,16 @@ removeAllNetwork(): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.removeAllNetwork(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.removeDevice7+ @@ -905,6 +1217,17 @@ removeDevice(id: number): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let id = 0; + wifi.removeDevice(id); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.enableHotspot7+ @@ -924,6 +1247,16 @@ enableHotspot(): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。| +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.enableHotspot(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.disableHotspot7+ @@ -943,6 +1276,16 @@ disableHotspot(): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。| +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.disableHotspot(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.isHotspotDualBandSupported7+ @@ -962,6 +1305,17 @@ isHotspotDualBandSupported(): boolean | -------- | -------- | | boolean | true:支持， false:不支持。| +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let ret = wifi.isHotspotDualBandSupported(); + console.info("result:" + ret); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.isHotspotActive7+ @@ -981,6 +1335,17 @@ isHotspotActive(): boolean | -------- | -------- | | boolean | true:已使能， false:未使能。| +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let ret = wifi.isHotspotActive(); + console.info("result:" + ret); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.setHotspotConfig7+ @@ -1006,6 +1371,25 @@ setHotspotConfig(config: HotspotConfig): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** +```js +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)); +} +``` ## HotspotConfig7+ @@ -1042,6 +1426,17 @@ getHotspotConfig(): HotspotConfig | -------- | -------- | | [HotspotConfig](#hotspotconfig7) | 热点的配置信息。 | +**示例：** +```js +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.getStations7+ @@ -1061,6 +1456,17 @@ getStations():  Array<[StationInfo](#stationinfo7)> | -------- | -------- | |  Array<[StationInfo](#stationinfo7)> | 连接的设备数组。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let stations = wifi.getStations(); + console.info("result:" + JSON.stringify(stations)); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## StationInfo7+ @@ -1136,6 +1542,22 @@ getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | 是 | 回调函数。当操作成功时，err为0，data表示P2P连接信息。如果error为非0，表示处理出现错误。 | +**示例：** +```js +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.getCurrentGroup8+ @@ -1170,6 +1592,22 @@ getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> | 是 | 回调函数。当操作成功时，err为0，data表示当前组信息。如果error为非0，表示处理出现错误。 | +**示例：** +```js +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.getP2pPeerDevices8+ @@ -1204,6 +1642,22 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pDevice[]](#wifip2pdevice8)> | 是 | 回调函数。当操作成功时，err为0，data表示对端设备列表信息。如果error为非0，表示处理出现错误。 | +**示例：** +```js +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)); +}); +``` ## WifiP2pDevice8+ @@ -1257,6 +1711,24 @@ createGroup(config: WifiP2PConfig): boolean | -------- | -------- | | boolean | true:创建群组操作执行成功， false:创建群组操作执行失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let config = { + deviceAddress: "****", + netId: 0, + passphrase: "*****", + groupName: "****", + goBand: 0 + } + wifi.createGroup(config); + +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## WifiP2PConfig8+ @@ -1302,6 +1774,16 @@ removeGroup(): boolean | -------- | -------- | | boolean | true:操作执行成功， false:操作执行失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.removeGroup(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.p2pConnect8+ @@ -1328,71 +1810,71 @@ p2pConnect(config: WifiP2PConfig): boolean **示例：** - ```js - import wifi from '@ohos.wifi'; - - var recvP2pConnectionChangeFunc = result => { - console.info("p2p connection change receive event: " + JSON.stringify(result)); - wifi.getP2pLinkedInfo((err, data) => { - if (err) { - console.error('failed to get getP2pLinkedInfo: ' + JSON.stringify(err)); - return; - } - console.info("get getP2pLinkedInfo: " + JSON.stringify(data)); - }); - } - wifi.on("p2pConnectionChange", recvP2pConnectionChangeFunc); - - var recvP2pDeviceChangeFunc = result => { - console.info("p2p device change receive event: " + JSON.stringify(result)); - } - wifi.on("p2pDeviceChange", recvP2pDeviceChangeFunc); - - var recvP2pPeerDeviceChangeFunc = result => { - console.info("p2p peer device change receive event: " + JSON.stringify(result)); - wifi.getP2pPeerDevices((err, data) => { - if (err) { - console.error('failed to get peer devices: ' + JSON.stringify(err)); - return; - } - console.info("get peer devices: " + JSON.stringify(data)); - var len = Object.keys(data).length; - for (var i = 0; i < len; ++i) { - if (data[i].deviceName === "my_test_device") { - console.info("p2p connect to test device: " + data[i].deviceAddress); - var config = { - "deviceAddress":data[i].deviceAddress, - "netId":-2, - "passphrase":"", - "groupName":"", - "goBand":0, - } - wifi.p2pConnect(config); - } - } - }); - } - wifi.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); - - var recvP2pPersistentGroupChangeFunc = () => { - console.info("p2p persistent group change receive event"); - - wifi.getCurrentGroup((err, data) => { - if (err) { - console.error('failed to get current group: ' + JSON.stringify(err)); - return; - } - console.info("get current group: " + JSON.stringify(data)); - }); - } - wifi.on("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc); - - setTimeout(function() {wifi.off("p2pConnectionChange", recvP2pConnectionChangeFunc);}, 125 * 1000); - setTimeout(function() {wifi.off("p2pDeviceChange", recvP2pDeviceChangeFunc);}, 125 * 1000); - setTimeout(function() {wifi.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);}, 125 * 1000); - setTimeout(function() {wifi.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);}, 125 * 1000); - console.info("start discover devices -> " + wifi.startDiscoverDevices()); - ``` +```js +import wifi from '@ohos.wifi'; + +var recvP2pConnectionChangeFunc = result => { + console.info("p2p connection change receive event: " + JSON.stringify(result)); + wifi.getP2pLinkedInfo((err, data) => { + if (err) { + console.error('failed to get getP2pLinkedInfo: ' + JSON.stringify(err)); + return; + } + console.info("get getP2pLinkedInfo: " + JSON.stringify(data)); + }); +} +wifi.on("p2pConnectionChange", recvP2pConnectionChangeFunc); + +var recvP2pDeviceChangeFunc = result => { + console.info("p2p device change receive event: " + JSON.stringify(result)); +} +wifi.on("p2pDeviceChange", recvP2pDeviceChangeFunc); + +var recvP2pPeerDeviceChangeFunc = result => { + console.info("p2p peer device change receive event: " + JSON.stringify(result)); + wifi.getP2pPeerDevices((err, data) => { + if (err) { + console.error('failed to get peer devices: ' + JSON.stringify(err)); + return; + } + console.info("get peer devices: " + JSON.stringify(data)); + var len = Object.keys(data).length; + for (var i = 0; i < len; ++i) { + if (data[i].deviceName === "my_test_device") { + console.info("p2p connect to test device: " + data[i].deviceAddress); + var config = { + "deviceAddress":data[i].deviceAddress, + "netId":-2, + "passphrase":"", + "groupName":"", + "goBand":0, + } + wifi.p2pConnect(config); + } + } + }); +} +wifi.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); + +var recvP2pPersistentGroupChangeFunc = () => { + console.info("p2p persistent group change receive event"); + + wifi.getCurrentGroup((err, data) => { + if (err) { + console.error('failed to get current group: ' + JSON.stringify(err)); + return; + } + console.info("get current group: " + JSON.stringify(data)); + }); +} +wifi.on("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc); + +setTimeout(function() {wifi.off("p2pConnectionChange", recvP2pConnectionChangeFunc);}, 125 * 1000); +setTimeout(function() {wifi.off("p2pDeviceChange", recvP2pDeviceChangeFunc);}, 125 * 1000); +setTimeout(function() {wifi.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);}, 125 * 1000); +setTimeout(function() {wifi.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);}, 125 * 1000); +console.info("start discover devices -> " + wifi.startDiscoverDevices()); +``` ## wifi.p2pCancelConnect8+ @@ -1410,6 +1892,16 @@ p2pCancelConnect(): boolean | -------- | -------- | | boolean | true:操作执行成功， false:操作执行失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.p2pCancelConnect(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.startDiscoverDevices8+ @@ -1427,6 +1919,16 @@ startDiscoverDevices(): boolean | -------- | -------- | | boolean | true:操作执行成功， false:操作执行失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.startDiscoverDevices(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.stopDiscoverDevices8+ @@ -1444,6 +1946,16 @@ stopDiscoverDevices(): boolean | -------- | -------- | | boolean | true:操作执行成功，操作执行失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + wifi.stopDiscoverDevices(); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.deletePersistentGroup8+ @@ -1470,6 +1982,17 @@ deletePersistentGroup(netId: number): boolean | -------- | -------- | | boolean | true:操作执行成功，操作执行失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let netId = 0; + wifi.deletePersistentGroup(netId); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## WifiP2pGroupInfo8+ @@ -1514,6 +2037,17 @@ setDeviceName(devName: string): boolean | -------- | -------- | | boolean | true:操作成功， false:操作失败。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +try { + let name = "****"; + wifi.setDeviceName(name); +}catch(error){ + console.error("failed:" + JSON.stringify(error)); +} +``` ## wifi.on('wifiStateChange')7+ @@ -1557,22 +2091,22 @@ off(type: "wifiStateChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiStateChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **示例：** - ```js - import wifi from '@ohos.wifi'; - - var recvPowerNotifyFunc = result => { - console.info("Receive power state change event: " + result); - } - - // Register event - wifi.on("wifiStateChange", recvPowerNotifyFunc); - - // Unregister event - wifi.off("wifiStateChange", recvPowerNotifyFunc); - ``` +```js +import wifi from '@ohos.wifi'; + +var recvPowerNotifyFunc = result => { + console.info("Receive power state change event: " + result); +} + +// Register event +wifi.on("wifiStateChange", recvPowerNotifyFunc); + +// Unregister event +wifi.off("wifiStateChange", recvPowerNotifyFunc); +``` ## wifi.on('wifiConnectionChange')7+ @@ -1615,8 +2149,22 @@ off(type: "wifiConnectionChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiConnectionChange"字符串。 | - | callback | Callback<number> | 否 | 连接状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 连接状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | + +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvWifiConnectionChangeFunc = result => { + console.info("Receive wifi connection change event: " + result); +} +// Register event +wifi.on("wifiConnectionChange", recvWifiConnectionChangeFunc); + +// Unregister event +wifi.off("wifiConnectionChange", recvWifiConnectionChangeFunc); +``` ## wifi.on('wifiScanStateChange')7+ @@ -1658,8 +2206,22 @@ off(type: "wifiScanStateChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiScanStateChange"字符串。 | -| callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +| callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | + +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvWifiScanStateChangeFunc = result => { + console.info("Receive Wifi scan state change event: " + result); +} +// Register event +wifi.on("wifiScanStateChange", recvWifiScanStateChangeFunc); + +// Unregister event +wifi.off("wifiScanStateChange", recvWifiScanStateChangeFunc); +``` ## wifi.on('wifiRssiChange')7+ @@ -1694,9 +2256,22 @@ off(type: "wifiRssiChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiRssiChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | + +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvWifiRssiChangeFunc = result => { + console.info("Receive wifi rssi change event: " + result); +} +// Register event +wifi.on("wifiRssiChange", recvWifiRssiChangeFunc); +// Unregister event +wifi.off("wifiRssiChange", recvWifiRssiChangeFunc); +``` ## wifi.on('hotspotStateChange')7+ on(type: "hotspotStateChange", callback: Callback<number>): void @@ -1723,6 +2298,20 @@ on(type: "hotspotStateChange", callback: Callback<number>): void | 2 | 激活中。 | | 3 | 去激活中。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvHotspotStateChangeFunc = result => { + console.info("Receive hotspot state change event: " + result); +} + +// Register event +wifi.on("hotspotStateChange", recvHotspotStateChangeFunc); + +// Unregister event +wifi.off("hotspotStateChange", recvHotspotStateChangeFunc); +``` ## wifi.off('hotspotStateChange')7+ @@ -1739,7 +2328,7 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"hotspotStateChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | ## wifi.on('p2pStateChange')8+ @@ -1784,8 +2373,22 @@ off(type: "p2pStateChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pStateChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | + +**示例：** +```js +import wifi from '@ohos.wifi'; +var recvP2pStateChangeFunc = result => { + console.info("Receive p2p state change event: " + result); +} + +// Register event +wifi.on("p2pStateChange", recvP2pStateChangeFunc); + +// Unregister event +wifi.off("p2pStateChange", recvP2pStateChangeFunc); +``` ## wifi.on('p2pConnectionChange')8+ @@ -1820,8 +2423,22 @@ off(type: "p2pConnectionChange", callback?: Callback<WifiP2pLinkedInfo>): | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pConnectionChange"字符串。 | - | callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | + +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvP2pConnectionChangeFunc = result => { + console.info("Receive p2p connection change event: " + result); +} +// Register event +wifi.on("p2pConnectionChange", recvP2pConnectionChangeFunc); + +// Unregister event +wifi.off("p2pConnectionChange", recvP2pConnectionChangeFunc); +``` ## wifi.on('p2pDeviceChange')8+ @@ -1856,8 +2473,22 @@ off(type: "p2pDeviceChange", callback?: Callback<WifiP2pDevice>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pDeviceChange"字符串。 | - | callback | Callback<[WifiP2pDevice](#wifip2pdevice8)> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<[WifiP2pDevice](#wifip2pdevice8)> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvP2pDeviceChangeFunc = result => { + console.info("Receive recv p2p device change event: " + result); +} + +// Register event +wifi.on("p2pDeviceChange", recvP2pDeviceChangeFunc); + +// Unregister event +wifi.off("p2pDeviceChange", recvP2pDeviceChangeFunc); +``` ## wifi.on('p2pPeerDeviceChange')8+ @@ -1892,8 +2523,22 @@ off(type: "p2pPeerDeviceChange", callback?: Callback<WifiP2pDevice[]>): vo | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 | - | callback | Callback<[WifiP2pDevice[]](#wifip2pdevice8)> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<[WifiP2pDevice[]](#wifip2pdevice8)> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | + +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvP2pPeerDeviceChangeFunc = result => { + console.info("Receive recv p2p peer device change event: " + result); +} +// Register event +wifi.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); + +// Unregister event +wifi.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); +``` ## wifi.on('p2pPersistentGroupChange')8+ @@ -1928,8 +2573,23 @@ off(type: "p2pPersistentGroupChange", callback?: Callback<void>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 | - | callback | Callback<void> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<void> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | + +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvP2pPersistentGroupChangeFunc = result => { + console.info("Receive recv p2p persistent group change event: " + result); +} +// Register event +wifi.on("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc); + +// Unregister event +wifi.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc); + +``` ## wifi.on('p2pDiscoveryChange')8+ @@ -1971,5 +2631,19 @@ off(type: "p2pDiscoveryChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pDiscoveryChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | + +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvP2pDiscoveryChangeFunc = result => { + console.info("Receive recv p2p discovery change event: " + result); +} + +// Register event +wifi.on("p2pDiscoveryChange", recvP2pDiscoveryChangeFunc); +// Unregister event +wifi.off("p2pDiscoveryChange", recvP2pDiscoveryChangeFunc); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md b/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md index 5abef285bc074a3bc2a5c04f95b781651c6d55e0..d8c928a35a6d8a87427e6360fd2d61fadda35978 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md @@ -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.| +**示例：** + +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.enableWifi(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` ## wifi.disableWifi9+ @@ -60,10 +71,22 @@ disableWifi(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** + +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.disableWifi(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.isWifiActive9+ isWifiActive(): boolean @@ -84,17 +107,30 @@ isWifiActive(): boolean 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** + +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let isActivate = wifiManager.isActivate(); + console.info("isActivate:" + isActivate); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.scan9+ 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.getScanResults9+ - -getScanResults(): Promise<Array<WifiScanInfo>> - -获取扫描结果，使用Promise异步回调。 - -**需要权限：** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION) - -**系统能力：** SystemCapability.Communication.WiFi.STA - -**返回值：** - - | **类型** | **说明** | - | -------- | -------- | - | Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | Promise对象。返回扫描到的热点列表。 | - -**错误码：** +**示例：** -以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 +```js + import wifiManager from '@ohos.wifiManager'; -| **类型** | **说明** | - | -------- | -------- | -| 2501000 | Operation failed.| + try { + wifiManager.scan(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` -## wifi.getScanResults9+ +## wifi.getScanInfoList9+ -getScanResults(callback: AsyncCallback<Array<WifiScanInfo>>): void +getScanInfoList(): Array<WifiScanInfo>; -获取扫描结果，使用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< Array<[WifiScanInfo](#wifiscaninfo)>> | 是 | 回调函数。当成功时，err为0，data为扫描到的热点；否则err为非0值，data为空。 | + | **类型** | **说明** | + | -------- | -------- | + | Array<[WifiScanInfo](#wifiscaninfo)> | 返回扫描到的热点列表。 | **错误码：** 以下错误码的详细介绍请参见[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); - } - }); - ``` +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let scanInfoList = wifiManager.getScanInfoList(); + console.info("scanInfoList:" + JSON.stringify(scanInfoList)); + let len = Object.keys(scanInfoList).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)); + } + +``` ## WifiScanInfo9+ @@ -307,31 +317,6 @@ WLAN热点信息。 | WIDTH_80MHZ_PLUS | 4 | 80MHZ+。 | | WIDTH_INVALID | 5 | 无效值 | - -## wifi.getScanResultsSync9+ - -getScanResultsSync():  Array<[WifiScanInfo](#wifiscaninfo)> - -获取扫描结果，使用同步方式返回结果。 - -**需要权限：** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION) - -**系统能力：** SystemCapability.Communication.WiFi.STA - -**返回值：** - - | **类型** | **说明** | - | -------- | -------- | - |  Array<[WifiScanInfo](#wifiscaninfo)> | 扫描结果数组。 | - -**错误码：** - -以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 - -| **类型** | **说明** | - | -------- | -------- | -| 2501000 | Operation failed.| - ## wifi.addDeviceConfig9+ addDeviceConfig(config: WifiDeviceConfig): Promise<number> @@ -360,10 +345,29 @@ addDeviceConfig(config: WifiDeviceConfig): Promise<number> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** + +```js + import wifiManager 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)); + } +``` + ## WifiDeviceConfig9+ WLAN配置信息。 @@ -512,10 +516,29 @@ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>) 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** + +```js + import wifiManager 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.addCandidateConfig9+ addCandidateConfig(config: WifiDeviceConfig): Promise<number> @@ -542,10 +565,28 @@ addCandidateConfig(config: WifiDeviceConfig): Promise<number> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +`````js + import wifiManager 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.addCandidateConfig9+ addCandidateConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>): void @@ -567,10 +608,28 @@ addCandidateConfig(config: WifiDeviceConfig, callback: AsyncCallback<number&g 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +`````js + import wifiManager 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.removeCandidateConfig9+ removeCandidateConfig(networkId: number): Promise<void> @@ -597,10 +656,25 @@ removeCandidateConfig(networkId: number): Promise<void> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** + +```js + import wifiManager 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.removeCandidateConfig9+ removeCandidateConfig(networkId: number, callback: AsyncCallback<void>): void @@ -622,17 +696,31 @@ removeCandidateConfig(networkId: number, callback: AsyncCallback<void>): v 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager 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.getCandidateConfigs9+ getCandidateConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> 获取候选网络配置。 -**需要权限：** 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():  Array<[WifiDeviceConfig](#wifideviceconfig)> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | -| 2501000 | Operation failed.| +| 2501000 | Operation failed.| + +**示例：** + +`````js + import wifiManager 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.connectToCandidateConfig9+ @@ -670,11 +780,25 @@ connectToCandidateConfig(networkId: number): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| | 2501001 | Wifi is closed.| +**示例：** +```js + import wifiManager 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.connectToNetwork9+ 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.| +**示例：** + +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let networkId = 0; + wifiManager.connectToNetwork(networkId); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.connectToDevice9+ 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.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let config = { + ssid : "****", + preSharedKey : "****", + securityType : 3 + } + wifiManager.connectToDevice(config); + + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.disconnect9+ disconnect(): void @@ -747,10 +901,21 @@ disconnect(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.disconnect(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.getSignalLevel9+ 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.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let rssi = 0; + let band = 0; + let level = wifiManager.getSignalLevel(rssi,band); + console.info("level:" + JSON.stringify(level)); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } + +``` + ## wifi.getLinkedInfo9+ getLinkedInfo(): Promise<WifiLinkedInfo> @@ -802,7 +982,7 @@ getLinkedInfo(): Promise<WifiLinkedInfo> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| | 2501001 | Wifi is closed.| @@ -827,16 +1007,16 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| | 2501001 | Wifi is closed.| **示例：** - ```js - import wifi from '@ohos.wifiManager'; +```js + import wifiManager from '@ohos.wifiManager'; - wifi.getLinkedInfo((err, data) => { + wifiManager.getLinkedInfo((err, data) => { if (err) { console.error("get linked info error"); return; @@ -844,12 +1024,12 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void console.info("get wifi linked info: " + JSON.stringify(data)); }); - wifi.getLinkedInfo().then(data => { + wifiManager.getLinkedInfo().then(data => { console.info("get wifi linked info: " + JSON.stringify(data)); }).catch(error => { console.info("get linked info error"); }); - ``` +``` ## WifiLinkedInfo9+ @@ -923,7 +1103,6 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void | UNINITIALIZED | 10 | 连接建立失败。 | | INVALID | 11 | 无效值。 | - ## wifi.isConnected9+ isConnected(): boolean @@ -944,10 +1123,23 @@ isConnected(): boolean 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let ret = wifiManager.isConnected(); + console.info("isConnected:" + ret); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } + +``` + ## wifi.getSupportedFeatures9+ getSupportedFeatures(): number @@ -985,10 +1177,23 @@ getSupportedFeatures(): number 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2401000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let ret = wifiManager.getSupportedFeatures(); + console.info("supportedFeatures:" + ret); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } + +``` + ## wifi.isFeatureSupported9+ isFeatureSupported(featureId: number): boolean @@ -1016,10 +1221,24 @@ isFeatureSupported(featureId: number): boolean 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2401000 | Operation failed.| +**示例：** +```js + import wifiManager 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.getDeviceMacAddress9+ getDeviceMacAddress(): string[] @@ -1042,10 +1261,23 @@ getDeviceMacAddress(): string[] 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let ret = wifiManager.getDeviceMacAddress(); + console.info("deviceMacAddress:" + JSON.stringify(ret)); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } + +``` + ## wifi.getIpInfo9+ getIpInfo(): IpInfo @@ -1066,10 +1298,22 @@ getIpInfo(): IpInfo 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let info = wifiManager.getIpInfo(); + console.info("info:" + JSON.stringify(info)); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## IpInfo9+ IP信息。 @@ -1107,10 +1351,22 @@ getCountryCode(): string 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2401000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let code = wifiManager.getCountryCode(); + console.info("code:" + code); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.reassociate9+ reassociate(): void @@ -1127,11 +1383,22 @@ reassociate(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| | 2501001 | Wifi is closed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.reassociate(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.reconnect9+ reconnect(): void @@ -1148,11 +1415,22 @@ reconnect(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| | 2501001 | Wifi is closed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.reconnect(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.getDeviceConfigs9+ getDeviceConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> @@ -1161,7 +1439,7 @@ getDeviceConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> **系统接口：** 此接口为系统接口。 -**需要权限：** 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 +1453,25 @@ getDeviceConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| -## wifi.updateNetwork9+ +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let configs = wifiManager.getDeviceConfigs(); + console.info("configs:" + JSON.stringify(configs)); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + +## wifi.updateDeviceConfig9+ -updateNetwork(config: WifiDeviceConfig): number +updateDeviceConfig(config: WifiDeviceConfig): number 更新网络配置。 @@ -1207,13 +1497,30 @@ updateNetwork(config: WifiDeviceConfig): number 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| -## wifi.disableNetwork9+ +**示例：** +```js + import wifiManager 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.disableDeviceConfig9+ + +disableDeviceConfig(networkId: number): void 去使能网络配置。 @@ -1227,19 +1534,31 @@ disableNetwork(netId: number): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | - | netId | number | 是 | 网络配置ID。 | + | networkId | number | 是 | 网络配置ID。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| -## wifi.removeAllNetwork9+ +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let netId = 0; + wifiManager.disableDeviceConfig(netId); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + +## wifi.removeAllDeviceConfigs9+ -removeAllNetwork(): void +removeAllDeviceConfigs(): void 移除所有网络配置。 @@ -1253,13 +1572,24 @@ removeAllNetwork(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| -## wifi.removeDevice9+ +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.removeAllDeviceConfigs(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` -removeDevice(id: number): void +## wifi.removeDeviceConfig9+ + +removeDeviceConfig(networkId: number): void 移除指定的网络配置。 @@ -1273,16 +1603,28 @@ removeDevice(id: number): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | - | id | number | 是 | 网络配置ID。 | + | networkId | number | 是 | 网络配置ID。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let id = 0; + wifiManager.removeDeviceConfig(id); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.isBandTypeSupported10+ isBandTypeSupported(bandType: WifiBandType): boolean @@ -1293,23 +1635,57 @@ isBandTypeSupported(bandType: WifiBandType): boolean **系统能力：** SystemCapability.Communication.WiFi.STA +**参数：** + + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | bandType | WifiBandType | 是 | Wifi 频段类型。 | + **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let type = 0; + let isBandTypeSupported = wifiManager.isBandTypeSupported(type); + console.info("isBandTypeSupported:" + isBandTypeSupported); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + +## WifiBandType 10+ + +表示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.get5GChannelList10+ -get5GChannelList(): Array +get5GChannelList(): Array<number> 获取当前设备支持的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 +1693,22 @@ get5GChannelList(): Array 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let channelList = wifiManager.get5GChannelList(); + console.info("channelList:" + JSON.stringify(channelList)); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.enableHotspot9+ enableHotspot(): void @@ -1337,10 +1725,21 @@ enableHotspot(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2601000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.enableHotspot(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.disableHotspot9+ disableHotspot(): void @@ -1357,10 +1756,21 @@ disableHotspot(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2601000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.disableHotspot(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.isHotspotDualBandSupported9+ isHotspotDualBandSupported(): boolean @@ -1383,10 +1793,22 @@ isHotspotDualBandSupported(): boolean 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2601000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let ret = wifiManager.isHotspotDualBandSupported(); + console.info("result:" + ret); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.isHotspotActive9+ isHotspotActive(): boolean @@ -1409,10 +1831,22 @@ isHotspotActive(): boolean 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2601000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let ret = wifiManager.isHotspotActive(); + console.info("result:" + ret); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.setHotspotConfig9+ setHotspotConfig(config: HotspotConfig): void @@ -1435,10 +1869,30 @@ setHotspotConfig(config: HotspotConfig): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2601000 | Operation failed.| +**示例：** +```js + import wifiManager 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)); + } +``` + ## HotspotConfig9+ 热点配置信息。 @@ -1478,19 +1932,31 @@ getHotspotConfig(): HotspotConfig 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2601000 | Operation failed.| -## wifi.getStations9+ +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let config = wifiManager.getHotspotConfig(); + console.info("result:" + JSON.stringify(config)); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + +## wifi.getHotspotStations9+ -getStations():  Array<[StationInfo](#stationinfo9)> +getHotspotStations():  Array<[StationInfo](#stationinfo9)> 获取连接的设备。 **系统接口：** 此接口为系统接口。 -**需要权限：** 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 +1970,22 @@ getStations():  Array<[StationInfo](#stationinfo9)> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2601000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let stations = wifiManager.getHotspotStations(); + console.info("result:" + JSON.stringify(stations)); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## StationInfo9+ 接入的设备信息。 @@ -1543,10 +2021,28 @@ getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + wifiManager.getP2pLinkedInfo((err, data) => { + if (err) { + console.error("get p2p linked info error"); + return; + } + console.info("get wifi p2p linked info: " + JSON.stringify(data)); + }); + + wifiManager.getP2pLinkedInfo().then(data => { + console.info("get wifi p2p linked info: " + JSON.stringify(data)); + }); +``` + + ## WifiP2pLinkedInfo9+ 提供WLAN连接的相关信息。 @@ -1589,13 +2085,13 @@ getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void | callback | AsyncCallback<[WifiP2pLinkedInfo](#wifip2plinkedinfo9)> | 是 | 回调函数。当操作成功时，err为0，data表示P2P连接信息。如果error为非0，表示处理出现错误。 | -## wifi.getCurrentGroup9+ +## wifi.getCurrentP2pGroup9+ -getCurrentGroup(): Promise<WifiP2pGroupInfo> +getCurrentP2pGroup(): Promise<WifiP2pGroupInfo> 获取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 +2105,17 @@ getCurrentGroup(): Promise<WifiP2pGroupInfo> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| -## wifi.getCurrentGroup9+ +## wifi.getCurrentP2pGroup9+ -getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void +getCurrentP2pGroup(callback: AsyncCallback<WifiP2pGroupInfo>): 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,17 +2129,34 @@ getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + wifiManager.getCurrentP2pGroup((err, data) => { + if (err) { + console.error("get current P2P group error"); + return; + } + console.info("get current P2P group: " + JSON.stringify(data)); + }); + + wifiManager.getCurrentP2pGroup().then(data => { + console.info("get current P2P group: " + JSON.stringify(data)); + }); +``` + ## wifi.getP2pPeerDevices9+ getP2pPeerDevices(): Promise<WifiP2pDevice[]> 获取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 +2170,7 @@ getP2pPeerDevices(): Promise<WifiP2pDevice[]> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| @@ -1667,7 +2180,7 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): 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 +2194,27 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + wifiManager.getP2pPeerDevices((err, data) => { + if (err) { + console.error("get P2P peer devices error"); + return; + } + console.info("get P2P peer devices: " + JSON.stringify(data)); + }); + + wifiManager.getP2pPeerDevices().then(data => { + console.info("get P2P peer devices: " + JSON.stringify(data)); + }); +``` + ## WifiP2pDevice9+ 表示P2P设备信息。 @@ -1735,7 +2265,7 @@ getP2pLocalDevice(): Promise<WifiP2pDevice> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| @@ -1755,10 +2285,30 @@ getP2pLocalDevice(callback: AsyncCallback<WifiP2pDevice>): void | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[WifiP2pDevice](#wifip2pdevice9)> | 是 | 回调函数。当操作成功时，err为0，data表示本端设备信息。如果error为非0，表示处理出现错误。 | +| **错误码ID** | **错误信息** | + | -------- | -------- | +| 2801000 | Operation failed.| -## wifi.createGroup9+ +**示例：** +```js + import wifiManager 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)); + }); + + wifiManager.getP2pLocalDevice().then(data => { + console.info("get P2P local device: " + JSON.stringify(data)); + }); +``` -createGroup(config: WifiP2PConfig): void +## wifi.createP2pGroup9+ + +createP2pGroup(config: WifiP2PConfig): void 创建群组。 @@ -1776,10 +2326,29 @@ createGroup(config: WifiP2PConfig): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let config = { + deviceAddress: "****", + netId: 0, + passphrase: "*****", + groupName: "****", + goBand: 0 + } + wifiManager.createP2pGroup(config); + + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## WifiP2PConfig9+ 表示P2P配置信息。 @@ -1808,9 +2377,9 @@ createGroup(config: WifiP2PConfig): void | GO_BAND_5GHZ | 2 | 5GHZ。 | -## wifi.removeGroup9+ +## wifi.removeP2pGroup9+ -removeGroup(): void +removeP2pGroup(): void 移除群组。 @@ -1822,23 +2391,33 @@ removeGroup(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.removeP2pGroup(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.p2pConnect9+ 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,17 +2426,17 @@ p2pConnect(config: WifiP2PConfig): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| **示例：** - ```js - import wifi from '@ohos.wifiManager'; +```js + import wifiManager from '@ohos.wifiManager'; var recvP2pConnectionChangeFunc = result => { console.info("p2p connection change receive event: " + JSON.stringify(result)); - wifi.getP2pLinkedInfo((err, data) => { + wifiManager.getP2pLinkedInfo((err, data) => { if (err) { console.error('failed to get getP2pLinkedInfo: ' + JSON.stringify(err)); return; @@ -1865,16 +2444,16 @@ p2pConnect(config: WifiP2PConfig): void console.info("get getP2pLinkedInfo: " + JSON.stringify(data)); }); } - wifi.on("p2pConnectionChange", recvP2pConnectionChangeFunc); + wifiManager.on("p2pConnectionChange", recvP2pConnectionChangeFunc); var recvP2pDeviceChangeFunc = result => { console.info("p2p device change receive event: " + JSON.stringify(result)); } - wifi.on("p2pDeviceChange", recvP2pDeviceChangeFunc); + wifiManager.on("p2pDeviceChange", recvP2pDeviceChangeFunc); var recvP2pPeerDeviceChangeFunc = result => { console.info("p2p peer device change receive event: " + JSON.stringify(result)); - wifi.getP2pPeerDevices((err, data) => { + wifiManager.getP2pPeerDevices((err, data) => { if (err) { console.error('failed to get peer devices: ' + JSON.stringify(err)); return; @@ -1891,17 +2470,17 @@ p2pConnect(config: WifiP2PConfig): void "groupName":"", "goBand":0, } - wifi.p2pConnect(config); + wifiManager.p2pConnect(config); } } }); } - wifi.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); + wifiManager.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); var recvP2pPersistentGroupChangeFunc = () => { console.info("p2p persistent group change receive event"); - wifi.getCurrentGroup((err, data) => { + wifiManager.getCurrentGroup((err, data) => { if (err) { console.error('failed to get current group: ' + JSON.stringify(err)); return; @@ -1909,14 +2488,14 @@ p2pConnect(config: WifiP2PConfig): void console.info("get current group: " + JSON.stringify(data)); }); } - wifi.on("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc); + wifiManager.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()); - ``` + setTimeout(function() {wifiManager.off("p2pConnectionChange", recvP2pConnectionChangeFunc);}, 125 * 1000); + setTimeout(function() {wifiManager.off("p2pDeviceChange", recvP2pDeviceChangeFunc);}, 125 * 1000); + setTimeout(function() {wifiManager.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);}, 125 * 1000); + setTimeout(function() {wifiManager.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);}, 125 * 1000); + console.info("start discover devices -> " + wifiManager.startDiscoverP2pDevices()); +``` ## wifi.p2pCancelConnect9+ @@ -1924,7 +2503,7 @@ p2pCancelConnect(): void 取消P2P连接。 -**需要权限：** ohos.permission.GET_WIFI_INFO +**需要权限：** ohos.permission.GET_WIFI_INFO **系统能力：** SystemCapability.Communication.WiFi.P2P @@ -1932,17 +2511,28 @@ p2pCancelConnect(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| -## wifi.startDiscoverDevices9+ +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.p2pCancelConnect(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + +## wifi.startDiscoverP2pDevices9+ -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 +2540,24 @@ startDiscoverDevices(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| -## wifi.stopDiscoverDevices9+ +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + wifiManager.startDiscoverP2pDevices(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` -stopDiscoverDevices(): void +## wifi.stopDiscoverP2pDevices9+ + +stopDiscoverP2pDevices(): void 停止发现设备。 @@ -1968,13 +2569,24 @@ stopDiscoverDevices(): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| -## wifi.deletePersistentGroup9+ +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; -deletePersistentGroup(netId: number): void + try { + wifiManager.stopDiscoverP2pDevices(); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + +## wifi.deletePersistentP2pGroup9+ + +deletePersistentP2pGroup(netId: number): void 删除永久组。 @@ -1995,10 +2607,22 @@ deletePersistentGroup(netId: number): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let netId = 0; + wifiManager.deletePersistentP2pGroup(netId); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.getP2pGroups9+ getP2pGroups(): Promise<Array<WifiP2pGroupInfo>> @@ -2007,7 +2631,7 @@ getP2pGroups(): Promise<Array<WifiP2pGroupInfo>> **系统接口：** 此接口为系统接口。 -**需要权限：** 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 +2645,28 @@ getP2pGroups(): Promise<Array<WifiP2pGroupInfo>> 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + wifiManager.getP2pGroups((err, data) => { + if (err) { + console.error("get P2P groups error"); + return; + } + console.info("get P2P groups: " + JSON.stringify(data)); + }); + + wifiManager.getP2pGroups().then(data => { + console.info("get P2P groups: " + JSON.stringify(data)); + }); + +``` + ## WifiP2pGroupInfo9+ 表示P2P群组相关信息。 @@ -2052,7 +2694,7 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): 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 +2708,13 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| -## wifi.setDeviceName9+ +## wifi.setP2pDeviceName9+ -setDeviceName(devName: string): void +setP2pDeviceName(devName: string): void 设置设备名称。 @@ -2092,10 +2734,22 @@ setDeviceName(devName: string): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let name = "****"; + wifiManager.setP2pDeviceName(name); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifi.on('wifiStateChange')9+ on(type: "wifiStateChange", callback: Callback<number>): void @@ -2117,7 +2771,7 @@ on(type: "wifiStateChange", callback: Callback<number>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| @@ -2146,30 +2800,30 @@ off(type: "wifiStateChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiStateChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| **示例：** - ```js - import wifi from '@ohos.wifiManager'; +```js + import wifiManager from '@ohos.wifiManager'; var recvPowerNotifyFunc = result => { console.info("Receive power state change event: " + result); } // Register event - wifi.on("wifiStateChange", recvPowerNotifyFunc); + wifiManager.on("wifiStateChange", recvPowerNotifyFunc); // Unregister event - wifi.off("wifiStateChange", recvPowerNotifyFunc); - ``` + wifiManager.off("wifiStateChange", recvPowerNotifyFunc); +``` ## wifi.on('wifiConnectionChange')9+ @@ -2200,7 +2854,7 @@ on(type: "wifiConnectionChange", callback: Callback<number>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| @@ -2219,16 +2873,31 @@ off(type: "wifiConnectionChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiConnectionChange"字符串。 | - | callback | Callback<number> | 否 | 连接状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 连接状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvWifiConnectionChangeFunc = result => { + console.info("Receive wifi connection change event: " + result); + } + + // Register event + wifiManager.on("wifiConnectionChange", recvWifiConnectionChangeFunc); + + // Unregister event + wifiManager.off("wifiConnectionChange", recvWifiConnectionChangeFunc); +``` + ## wifi.on('wifiScanStateChange')9+ on(type: "wifiScanStateChange", callback: Callback<number>): void @@ -2257,7 +2926,7 @@ on(type: "wifiScanStateChange", callback: Callback<number>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| @@ -2276,16 +2945,31 @@ off(type: "wifiScanStateChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiScanStateChange"字符串。 | -| callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | +| callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvWifiScanStateChangeFunc = result => { + console.info("Receive Wifi scan state change event: " + result); + } + + // Register event + wifiManager.on("wifiScanStateChange", recvWifiScanStateChangeFunc); + + // Unregister event + wifiManager.off("wifiScanStateChange", recvWifiScanStateChangeFunc); +``` + ## wifi.on('wifiRssiChange')9+ on(type: "wifiRssiChange", callback: Callback<number>): void @@ -2307,7 +2991,7 @@ on(type: "wifiRssiChange", callback: Callback<number>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| @@ -2326,16 +3010,31 @@ off(type: "wifiRssiChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"wifiRssiChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2501000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvWifiRssiChangeFunc = result => { + console.info("Receive wifi rssi change event: " + result); + } + + // Register event + wifiManager.on("wifiRssiChange", recvWifiRssiChangeFunc); + + // Unregister event + wifiManager.off("wifiRssiChange", recvWifiRssiChangeFunc); +``` + ## wifi.on('hotspotStateChange')9+ on(type: "hotspotStateChange", callback: Callback<number>): void @@ -2366,7 +3065,7 @@ on(type: "hotspotStateChange", callback: Callback<number>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2601000 | Operation failed.| @@ -2385,16 +3084,31 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"hotspotStateChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2601000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvHotspotStateChangeFunc = result => { + console.info("Receive hotspot state change event: " + result); + } + + // Register event + wifiManager.on("hotspotStateChange", recvHotspotStateChangeFunc); + + // Unregister event + wifiManager.off("hotspotStateChange", recvHotspotStateChangeFunc); +``` + ## wifi.on('p2pStateChange')9+ on(type: "p2pStateChange", callback: Callback<number>): void @@ -2426,7 +3140,7 @@ on(type: "p2pStateChange", callback: Callback<number>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| @@ -2445,17 +3159,32 @@ off(type: "p2pStateChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pStateChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| - ## wifi.on('p2pConnectionChange')9+ +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvP2pStateChangeFunc = result => { + console.info("Receive p2p state change event: " + result); + } + + // Register event + wifiManager.on("p2pStateChange", recvP2pStateChangeFunc); + + // Unregister event + wifiManager.off("p2pStateChange", recvP2pStateChangeFunc); +``` + +## wifi.on('p2pConnectionChange')9+ on(type: "p2pConnectionChange", callback: Callback<WifiP2pLinkedInfo>): void @@ -2476,7 +3205,7 @@ on(type: "p2pConnectionChange", callback: Callback<WifiP2pLinkedInfo>): vo 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| @@ -2495,23 +3224,38 @@ off(type: "p2pConnectionChange", callback?: Callback<WifiP2pLinkedInfo>): | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pConnectionChange"字符串。 | - | callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo9)> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo9)> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvP2pConnectionChangeFunc = result => { + console.info("Receive p2p connection change event: " + result); + } + + // Register event + wifiManager.on("p2pConnectionChange", recvP2pConnectionChangeFunc); + + // Unregister event + wifiManager.off("p2pConnectionChange", recvP2pConnectionChangeFunc); +``` + ## wifi.on('p2pDeviceChange')9+ on(type: "p2pDeviceChange", callback: Callback<WifiP2pDevice>): 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 +3270,7 @@ on(type: "p2pDeviceChange", callback: Callback<WifiP2pDevice>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| @@ -2536,7 +3280,7 @@ off(type: "p2pDeviceChange", callback?: Callback<WifiP2pDevice>): void 取消注册P2P设备状态改变事件。 -**需要权限：** ohos.permission.LOCATION +**需要权限：** ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P @@ -2545,23 +3289,38 @@ off(type: "p2pDeviceChange", callback?: Callback<WifiP2pDevice>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pDeviceChange"字符串。 | - | callback | Callback<[WifiP2pDevice](#wifip2pdevice9)> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<[WifiP2pDevice](#wifip2pdevice9)> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvP2pDeviceChangeFunc = result => { + console.info("Receive recv p2p device change event: " + result); + } + + // Register event + wifiManager.on("p2pDeviceChange", recvP2pDeviceChangeFunc); + + // Unregister event + wifiManager.off("p2pDeviceChange", recvP2pDeviceChangeFunc); +``` + ## wifi.on('p2pPeerDeviceChange')9+ on(type: "p2pPeerDeviceChange", callback: Callback<WifiP2pDevice[]>): 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 +3335,7 @@ on(type: "p2pPeerDeviceChange", callback: Callback<WifiP2pDevice[]>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| @@ -2586,7 +3345,7 @@ off(type: "p2pPeerDeviceChange", callback?: Callback<WifiP2pDevice[]>): vo 取消注册P2P对端设备状态改变事件。 -**需要权限：** ohos.permission.LOCATION +**需要权限：** ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P @@ -2595,16 +3354,31 @@ off(type: "p2pPeerDeviceChange", callback?: Callback<WifiP2pDevice[]>): vo | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 | - | callback | Callback<[WifiP2pDevice[]](#wifip2pdevice9)> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<[WifiP2pDevice[]](#wifip2pdevice9)> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvP2pPeerDeviceChangeFunc = result => { + console.info("Receive recv p2p peer device change event: " + result); + } + + // Register event + wifiManager.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); + + // Unregister event + wifiManager.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); +``` + ## wifi.on('p2pPersistentGroupChange')9+ on(type: "p2pPersistentGroupChange", callback: Callback<void>): void @@ -2626,7 +3400,7 @@ on(type: "p2pPersistentGroupChange", callback: Callback<void>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| @@ -2645,16 +3419,31 @@ off(type: "p2pPersistentGroupChange", callback?: Callback<void>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 | - | callback | Callback<void> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<void> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvP2pPersistentGroupChangeFunc = result => { + console.info("Receive recv p2p persistent group change event: " + result); + } + + // Register event + wifiManager.on("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc); + + // Unregister event + wifiManager.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc); +``` + ## wifi.on('p2pDiscoveryChange')9+ on(type: "p2pDiscoveryChange", callback: Callback<number>): void @@ -2683,7 +3472,7 @@ on(type: "p2pDiscoveryChange", callback: Callback<number>): void 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| @@ -2702,12 +3491,27 @@ off(type: "p2pDiscoveryChange", callback?: Callback<number>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"p2pDiscoveryChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将去注册该事件关联的所有回调函数。 | + | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -| **类型** | **说明** | +| **错误码ID** | **错误信息** | | -------- | -------- | | 2801000 | Operation failed.| + +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + var recvP2pDiscoveryChangeFunc = result => { + console.info("Receive recv p2p discovery change event: " + result); + } + + // Register event + wifiManager.on("p2pDiscoveryChange", recvP2pDiscoveryChangeFunc); + + // Unregister event + wifiManager.off("p2pDiscoveryChange", recvP2pDiscoveryChangeFunc); +``` \ No newline at end of file