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

Merge pull request !18416 from 刘姣姣/master

!18416 修改md文档与d.ts不一致的问题
Merge pull request !18416 from 刘姣姣/master
aea84c78 · openharmony_ci · Gitee · 3db40cb3 · 4331c3c0 · aea84c78
2 changed file
--- 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:操作成功，&nbsp;false:操作失败。|

+**示例：**
+
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		wifi.enableWifi();
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

 ## wifi.disableWifi

@@ -50,6 +61,17 @@ disableWifi(): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。|

+**示例：**
+
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		wifi.disableWifi();
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

 ## wifi.isWifiActive

@@ -67,6 +89,18 @@ isWifiActive(): boolean
  | -------- | -------- |
  | boolean | true:已使能，&nbsp;false:未使能。 |

+**示例：**
+
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let isActivate = wifi.isActivate();
+		console.info("isActivate:" + isActivate);
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

 ## wifi.scan

@@ -84,6 +118,17 @@ scan(): boolean
  | -------- | -------- |
  | boolean | true:扫描操作执行成功，&nbsp;false:扫描操作执行失败。 |

+**示例：**
+
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		wifi.scan();
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

 ## wifi.getScanInfos

@@ -238,6 +283,25 @@ addDeviceConfig(config: WifiDeviceConfig): Promise&lt;number&gt;
  | -------- | -------- |
  | Promise&lt;number&gt; | Promise对象。返回添加的网络配置ID，如果值为-1表示添加失败。 |
  
+  **示例：**
+
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let config = {
+			ssid : "****",
+			preSharedKey : "****",
+			securityType : 0
+		}
+		wifi.addDeviceConfig(config).then(result => {
+			console.info("result:" + JSON.stringify(result));
+		});	
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```
+
 ## WifiDeviceConfig

 WLAN配置信息。
@@ -312,7 +376,24 @@ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;number&gt;)
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
  | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当操作成功时，err为0，data为添加的网络配置ID，如果data值为-1，表示添加失败。当error为非0，表示处理出现错误。 |

+**示例：**

+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let config = {
+			ssid : "****",
+			preSharedKey : "****",
+			securityType : 0
+		}
+		wifi.addDeviceConfig(config,(error,result) => {
+			console.info("result:" + JSON.stringify(result));
+		});	
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```
 ## wifi.addUntrustedConfig<sup>7+</sup>

 addUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
@@ -334,7 +415,23 @@ addUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
  | **类型** | **说明** |
  | -------- | -------- |
  | Promise&lt;boolean&gt; | Promise对象。表示操作结果，true: 成功， false: 失败。 |
+**示例：**
+`````
+	import wifi from '@ohos.wifi';

+	try {
+		let config = {
+			ssid : "****",
+			preSharedKey : "****",
+			securityType : 0
+		}
+		wifi.addUntrustedConfig(config).then(result => {
+			console.info("result:" + JSON.stringify(result));
+		});	
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+`````

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

@@ -353,6 +450,23 @@ addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当操作成功时，err为0，data表示操作结果，true: 成功， false: 失败。如果error为非0，表示处理出现错误。 |

+**示例：**
+`````
+	import wifi from '@ohos.wifi';
+
+	try {
+		let config = {
+			ssid : "****",
+			preSharedKey : "****",
+			securityType : 0
+		}
+		wifi.addUntrustedConfig(config,(error,result) => {
+			console.info("result:" + JSON.stringify(result));
+		});	
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+`````

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

@@ -376,6 +490,19 @@ removeUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
  | -------- | -------- |
  | Promise&lt;boolean&gt; | Promise对象。表示操作结果，true: 成功， false: 失败。 |
  
+  ```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let networkId = 0;
+		wifi.removeUntrustedConfig(networkId).then(result => {
+			console.info("result:" + JSON.stringify(result));
+		});	
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```
+

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

@@ -394,6 +521,19 @@ removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boole
  | config | [WifiDeviceConfig](#wifideviceconfig) | 是 | WLAN配置信息。 |
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。当操作成功时，err为0，data表示操作结果，true: 成功， false: 失败。如果error为非0，表示处理出现错误。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let networkId = 0;
+		wifi.removeUntrustedConfig(networkId,(error,result) => {
+		console.info("result:" + JSON.stringify(result));
+		});	
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

 ## wifi.connectToNetwork

@@ -419,6 +559,18 @@ connectToNetwork(networkId: number): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。 |

+**示例：**
+
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let networkId = 0;
+		wifi.connectToNetwork(networkId);
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}	
+```

 ## wifi.connectToDevice

@@ -445,6 +597,22 @@ connectToDevice(config: WifiDeviceConfig): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let config = {
+			ssid : "****",
+			preSharedKey : "****",
+			securityType : 3
+		}
+		wifi.connectToDevice(config);
+				
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

 ## wifi.disconnect

@@ -465,6 +633,16 @@ disconnect(): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		wifi.disconnect();
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

 ## wifi.getSignalLevel

@@ -489,6 +667,20 @@ getSignalLevel(rssi: number, band: number): number
  | -------- | -------- |
  | number | 信号强度，取值范围为[0,&nbsp;4]。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let rssi = 0;
+		let band = 0;
+		let level = wifi.getSignalLevel(rssi,band);
+		console.info("lelvel:" + JSON.stringify(lelvel));
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+
+```

 ## wifi.getLinkedInfo

@@ -684,6 +876,19 @@ isFeatureSupported(featureId: number): boolean
  | -------- | -------- |
  | boolean | true:支持，&nbsp;false:不支持。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let featureId = 0；
+		let ret = wifi.isFeatureSupported(featureId);
+		console.info("isFeatureSupported:" + ret);
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+
+```

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

@@ -703,6 +908,18 @@ getDeviceMacAddress(): string[]
  | -------- | -------- |
  | string[] | MAC地址。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let ret = wifi.getDeviceMacAddress();
+		console.info("deviceMacAddress:" + JSON.stringify(ret));
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+
+```

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

@@ -720,6 +937,17 @@ getIpInfo(): IpInfo
  | -------- | -------- |
  | [IpInfo](#ipinfo7) | IP信息。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let info = wifi.getIpInfo();
+		console.info("info:" + JSON.stringify(info));
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -754,6 +982,17 @@ getCountryCode(): string
  | -------- | -------- |
  | string | 国家码。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let code = wifi.getCountryCode();
+		console.info("code:" + code);
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -773,6 +1012,16 @@ reassociate(): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		wifi.reassociate();
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -792,6 +1041,16 @@ reconnect(): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		wifi.reconnect();
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -811,6 +1070,17 @@ getDeviceConfigs(): &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt;
  | -------- | -------- |
  | &nbsp;Array&lt;[WifiDeviceConfig](#wifideviceconfig)&gt; | 网络配置信息的数组。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let configs = wifi.getDeviceConfigs();
+		console.info("configs:" + JSON.stringify(configs));
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -836,6 +1106,22 @@ updateNetwork(config: WifiDeviceConfig): number
  | -------- | -------- |
  | number | 返回更新的网络配置ID，如果值为-1表示更新失败。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let config = {
+			ssid : "****",
+			preSharedKey : "****",
+			securityType : 3
+		}
+		let ret = wifi.updateNetwork(config);
+		console.error("ret:" + ret);		
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -861,6 +1147,17 @@ disableNetwork(netId: number): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let netId = 0;
+		wifi.disableNetwork(netId);		
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -880,6 +1177,16 @@ removeAllNetwork(): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		wifi.removeAllNetwork();		
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -905,6 +1212,17 @@ removeDevice(id: number): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let id = 0;
+		wifi.removeDevice(id);		
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -924,6 +1242,16 @@ enableHotspot(): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。|

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		wifi.enableHotspot();	
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -943,6 +1271,16 @@ disableHotspot(): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。|

+**示例：**
+```
+	import wifi from '@ohos.wifiManager';
+
+	try {
+		wifiManager.disableHotspot();	
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -962,6 +1300,17 @@ isHotspotDualBandSupported(): boolean
  | -------- | -------- |
  | boolean | true:支持，&nbsp;false:不支持。|

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let ret = wifi.isHotspotDualBandSupported();
+		console.info("result:" + ret);		
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -981,6 +1330,17 @@ isHotspotActive(): boolean
  | -------- | -------- |
  | boolean | true:已使能，&nbsp;false:未使能。|

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let ret = wifi.isHotspotActive();
+		console.info("result:" + ret);		
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -1006,6 +1366,25 @@ setHotspotConfig(config: HotspotConfig): boolean
  | -------- | -------- |
  | boolean | true:操作成功，&nbsp;false:操作失败。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let config = {
+			ssid: "****",
+			securityType: 3,
+			band: 0,
+			channel: 0,
+			preSharedKey: "****",
+			maxConn: 0
+		}
+		let ret = wifi.setHotspotConfig();
+		console.info("result:" + ret);		
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

 ## HotspotConfig<sup>7+</sup>

@@ -1042,6 +1421,17 @@ getHotspotConfig(): HotspotConfig
  | -------- | -------- |
  | [HotspotConfig](#hotspotconfig7) | 热点的配置信息。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let config = wifi.getHotspotConfig();
+		console.info("result:" + JSON.stringify(config));		
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -1061,6 +1451,17 @@ getStations(): &nbsp;Array&lt;[StationInfo](#stationinfo7)&gt;
  | -------- | -------- |
  | &nbsp;Array&lt;[StationInfo](#stationinfo7)&gt; | 连接的设备数组。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	try {
+		let stations = wifi.getStations();
+		console.info("result:" + JSON.stringify(stations));		
+	}catch(error){
+		console.error("failed:" + JSON.stringify(error));
+	}
+```

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

@@ -1136,6 +1537,22 @@ getP2pLinkedInfo(callback: AsyncCallback&lt;WifiP2pLinkedInfo&gt;): void
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;[WifiP2pLinkedInfo](#wifip2plinkedinfo8)&gt; | 是 | 回调函数。当操作成功时，err为0，data表示P2P连接信息。如果error为非0，表示处理出现错误。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	wifi.getP2pLinkedInfo((err, data) => {
+    if (err) {
+        console.error("get p2p linked info error");
+        return;
+    }
+		console.info("get wifi p2p linked info: " + JSON.stringify(data));
+	});
+
+	wifi.getP2pLinkedInfo().then(data => {
+		console.info("get wifi p2p linked info: " + JSON.stringify(data));
+	});
+```

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

@@ -1170,6 +1587,22 @@ getCurrentGroup(callback: AsyncCallback&lt;WifiP2pGroupInfo&gt;): void
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;[WifiP2pGroupInfo](#wifip2pgroupinfo8)&gt; | 是 | 回调函数。当操作成功时，err为0，data表示当前组信息。如果error为非0，表示处理出现错误。 |

+**示例：**
+```
+	import wifi from '@ohos.wifi';
+
+	wifi.getCurrentGroup((err, data) => {
+    if (err) {
+        console.error("get current P2P group error");
+        return;
+    }
+		console.info("get current P2P group: " + JSON.stringify(data));
+	});
+
+	wifi.getCurrentGroup().then(data => {
+		console.info("get current P2P group: " + JSON.stringify(data));
+	});
+```

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

@@ -1204,6 +1637,22 @@ getP2pPeerDevices(callback: AsyncCallback&lt;WifiP2pDevice[]&gt;): void
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;[WifiP2pDevice[]](#wifip2pdevice8)&gt; | 是 | 回调函数。当操作成功时，err为0，data表示对端设备列表信息。如果error为非0，表示处理出现错误。 |

+**示例：**
+```
+	import wifi from '@ohos.wifiManager';
+
+	wifi.getP2pPeerDevices((err, data) => {
+    if (err) {
+        console.error("get P2P peer devices error");
+        return;
+    }
+		console.info("get P2P peer devices: " + JSON.stringify(data));
+	});
+
+	wifi.getP2pPeerDevices().then(data => {
+		console.info("get P2P peer devices: " + JSON.stringify(data));
+	});
+```

 ## WifiP2pDevice<sup>8+</sup>


--- a/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md