Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
“3d490d030e7c51c760f7da3030a0e8b938050044”上不存在“doc/howto/git@gitcode.net:s920243400/PaddleDetection.git”
提交 6201dc59 编写于 作者: A Annie_wang
浏览文件
操作

update docs 

Signed-off-by: NAnnie_wang <annie.wangli@huawei.com>
上级 fb498bc2
隐藏空白更改
内联 并排
Showing with 258 addition and 254 deletion
en/application-dev/reference/apis/js-apis-wifi.md
浏览文件 @ 6201dc59
# WLAN # WLAN
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**<br/> > **NOTE**<br>
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
...@@ -16,13 +16,13 @@ isWifiActive(): boolean ...@@ -16,13 +16,13 @@ isWifiActive(): boolean
Checks whether the WLAN is activated. Checks whether the WLAN is activated.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the WLAN is activated; returns **false** otherwise.| | boolean | Returns **true** if the WLAN is activated; returns **false** otherwise.|
...@@ -34,31 +34,31 @@ scan(): boolean ...@@ -34,31 +34,31 @@ scan(): boolean
Starts a scan for WLAN. Starts a scan for WLAN.
- Required permissions: - **Required permissions**:
ohos.permission.SET_WIFI_INFO and ohos.permission.LOCATION ohos.permission.SET_WIFI_INFO and ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the scan is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
## wifi.getScanInfos ## wifi.getScanInfos
getScanInfos(): Promise&lt;Array&lt;WifiScanInfo&gt;&gt; getScanInfos(): Promise&lt;Array&lt;WifiScanInfo&gt;&gt;
Obtains the scan result. This method uses a promise to return the result. Obtains the scan result. This API uses a promise to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO, ohos.permission.GET_WIFI_PEERS_MAC, or ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO, ohos.permission.GET_WIFI_PEERS_MAC, or ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| Promise&lt;&nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;&nbsp;&gt; | Promise used to return the scan result, which is a list of hotspots detected.| | Promise&lt;&nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;&nbsp;&gt; | Promise used to return the scan result, which is a list of hotspots detected.|
...@@ -68,20 +68,20 @@ Obtains the scan result. This method uses a promise to return the result. ...@@ -68,20 +68,20 @@ Obtains the scan result. This method uses a promise to return the result.
getScanInfos(callback: AsyncCallback&lt;Array&lt;WifiScanInfo&gt;&gt;): void getScanInfos(callback: AsyncCallback&lt;Array&lt;WifiScanInfo&gt;&gt;): void
Obtains the scan result. This method uses an asynchronous callback to return the result. Obtains the scan result. This API uses an asynchronous callback to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO, ohos.permission.GET_WIFI_PEERS_MAC, or ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO, ohos.permission.GET_WIFI_PEERS_MAC, or ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;&nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;&gt; | Yes| Callback invoked to return the result, which is a list of hotspots detected.| | callback | AsyncCallback&lt;&nbsp;Array&lt;[WifiScanInfo](#wifiscaninfo)&gt;&gt; | Yes| Callback invoked to return the result, which is a list of hotspots detected.|
- Example - **Example**
```js ```js
import wifi from '@ohos.wifi'; import wifi from '@ohos.wifi';
...@@ -130,14 +130,14 @@ Represents WLAN hotspot information. ...@@ -130,14 +130,14 @@ Represents WLAN hotspot information.
| **Name**| **Type**| **Readable/Writable**| **Description**| | **Name**| **Type**| **Readable/Writable**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ssid | string | Read only| Hotspot service set identifier (SSID), in UTF-8 format.| | ssid | string | Read only| Service set identifier (SSID) of the hotspot, in UTF-8 format.|
| bssid | string | Read only| Basic service set identifier (BSSID) of the hotspot.| | bssid | string | Read only| Basic service set identifier (BSSID) of the hotspot.|
| capabilities | string | Read only| Hotspot capabilities.| | capabilities | string | Read only| Hotspot capabilities.|
| securityType | [WifiSecurityType](#WifiSecurityType) | Read only| WLAN security type.| | securityType | [WifiSecurityType](#WifiSecurityType) | Read only| WLAN security type.|
| rssi | number | Read only| Signal strength of the hotspot, in dBm.| | rssi | number | Read only| Received signal strength indicator (RSSI) of the hotspot, in dBm.|
| band | number | Read only| Frequency band of the WLAN access point (AP).| | band | number | Read only| Frequency band of the WLAN access point (AP).|
| frequency | number | Read only| Frequency of the WLAN AP.| | frequency | number | Read only| Frequency of the WLAN AP.|
| channelWidth | number | Read only| Bandwidth of the WLAN AP.| | channelWidth | number | Read only| Channel width of the WLAN AP.|
| timestamp | number | Read only| Timestamp.| | timestamp | number | Read only| Timestamp.|
...@@ -158,23 +158,24 @@ Enumerates the WLAN security types. ...@@ -158,23 +158,24 @@ Enumerates the WLAN security types.
addUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt; addUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
Adds untrusted WLAN configuration. This method uses a promise to return the result. Adds untrusted WLAN configuration. This API uses a promise to return the result.
- **NOTE**<br>This API is not supported by OpenHarmony 3.1 Release.
- Required permissions: - **Required permissions**:
ohos.permission.SET_WIFI_INFO ohos.permission.SET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to add.| | config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to add.|
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | Promise used to return the operation result. The value **true** indicates that the operation is successful; **false** indicates the opposite.| | Promise&lt;boolean&gt; | Promise used to return the operation result. If the operation is successful, **true** is returned; otherwise, **false** is returned.|
## WifiDeviceConfig ## WifiDeviceConfig
...@@ -182,111 +183,113 @@ Represents the WLAN configuration. ...@@ -182,111 +183,113 @@ Represents the WLAN configuration.
| **Name**| **Type**| **Readable/Writable**| **Description**| | **Name**| **Type**| **Readable/Writable**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ssid | string | Read only| Hotspot service set identifier (SSID), in UTF-8 format.| | ssid | string | Read only| SSID of the hotspot, in UTF-8 format.|
| bssid | string | Read only| BSSID of the hotspot.| | bssid | string | Read only| BSSID of the hotspot.|
| preSharedKey | string | Read only| Private key of the hotspot.| | preSharedKey | string | Read only| PSK of the hotspot.|
| isHiddenSsid | boolean | Read only| Whether to hide the network.| | isHiddenSsid | boolean | Read only| Whether the network is hidden.|
| securityType | [WifiSecurityType](#WifiSecurityType) | Read only| Security type| | securityType | [WifiSecurityType](#WifiSecurityType) | Read only| Security type.|
## wifi.addUntrustedConfig<sup>7+</sup> ## wifi.addUntrustedConfig<sup>7+</sup>
addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&gt;): void addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&gt;): void
Adds untrusted WLAN configuration. This method uses an asynchronous callback to return the result. Adds untrusted WLAN configuration. This API uses an asynchronous callback to return the result.
- Required permissions: - **NOTE**<br>This API is not supported by OpenHarmony 3.1 Release.
- **Required permissions**:
ohos.permission.SET_WIFI_INFO ohos.permission.SET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to add.| | config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to add.|
| callback | AsyncCallback&lt;boolean&gt; | Yes| Promise used to return the operation result. The value **true** indicates that the operation is successful; **false** indicates the opposite.| | callback | AsyncCallback&lt;boolean&gt; | Yes| Callback invoked to return the result. If the operation is successful, **true** is returned; otherwise, **false** is returned.|
## wifi.removeUntrustedConfig<sup>7+</sup> ## wifi.removeUntrustedConfig<sup>7+</sup>
removeUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt; removeUntrustedConfig(config: WifiDeviceConfig): Promise&lt;boolean&gt;
Removes untrusted WLAN configuration. This method uses a promise to return the result. Removes untrusted WLAN configuration. This API uses a promise to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.SET_WIFI_INFO ohos.permission.SET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to remove.| | config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to remove.|
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| Promise&lt;boolean&gt; | Promise used to return the operation result. The value **true** indicates that the operation is successful; **false** indicates the opposite.| | Promise&lt;boolean&gt; | Promise used to return the result. If the operation is successful, **true** is returned; otherwise, **false** is returned.|
## wifi.removeUntrustedConfig<sup>7+</sup> ## wifi.removeUntrustedConfig<sup>7+</sup>
removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&gt;): void removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback&lt;boolean&gt;): void
Removes untrusted WLAN configuration. This method uses an asynchronous callback to return the result. Removes untrusted WLAN configuration. This API uses an asynchronous callback to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.SET_WIFI_INFO ohos.permission.SET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to remove.| | config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to remove.|
| callback | AsyncCallback&lt;boolean&gt; | Yes| Promise used to return the operation result. The value **true** indicates that the operation is successful; **false** indicates the opposite.| | callback | AsyncCallback&lt;boolean&gt; | Yes| Callback invoked used to return the result. If the operation is successful, **true** is returned; otherwise, **false** is returned.|
## wifi.getSignalLevel ## wifi.getSignalLevel
getSignalLevel(rssi: number, band: number): number getSignalLevel(rssi: number, band: number): number
Obtains the WLAN signal strength. Obtains the WLAN signal level.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- **Parameters** - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rssi | number | Yes| Signal strength of the hotspot, in dBm.| | rssi | number | Yes| RSSI of the hotspot, in dBm.|
| band | number | Yes| Frequency band of the WLAN AP.| | band | number | Yes| Frequency band of the WLAN AP.|
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| number | Signal strength obtained. The value range is [0,&nbsp;4].| | number | Signal level obtained. The value range is [0, 4].|
## wifi.getLinkedInfo ## wifi.getLinkedInfo
getLinkedInfo(): Promise&lt;WifiLinkedInfo&gt; getLinkedInfo(): Promise&lt;WifiLinkedInfo&gt;
Obtains WLAN connection information. This method uses a promise to return the result. Obtains WLAN connection information. This API uses a promise to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;[WifiLinkedInfo](#WifiLinkedInfo)&gt; | Promise used to return the WLAN connection information obtained.| | Promise&lt;[WifiLinkedInfo](#WifiLinkedInfo)&gt; | Promise used to return the WLAN connection information obtained.|
...@@ -296,20 +299,20 @@ Obtains WLAN connection information. This method uses a promise to return the re ...@@ -296,20 +299,20 @@ Obtains WLAN connection information. This method uses a promise to return the re
getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void getLinkedInfo(callback: AsyncCallback&lt;WifiLinkedInfo&gt;): void
Obtains WLAN connection information. This method uses a callback to return the result. Obtains WLAN connection information. This API uses a callback to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiLinkedInfo](#WifiLinkedInfo)&gt; | Yes| Callback invoked to return the WLAN connection information obtained.| | callback | AsyncCallback&lt;[WifiLinkedInfo](#WifiLinkedInfo)&gt; | Yes| Callback invoked to return the WLAN connection information obtained.|
- Example - **Example**
```js ```js
import wifi from '@ohos.wifi'; import wifi from '@ohos.wifi';
...@@ -335,9 +338,9 @@ Represents the WLAN connection information. ...@@ -335,9 +338,9 @@ Represents the WLAN connection information.
| Name| Type| Readable/Writable| Description| | Name| Type| Readable/Writable| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ssid | string | Read only| Hotspot SSID, in UTF-8 format.| | ssid | string | Read only| SSID of the hotspot, in UTF-8 format.|
| bssid | string | Read only| BSSID of the hotspot.| | bssid | string | Read only| BSSID of the hotspot.|
| rssi | number | Read only| Signal strength of the hotspot, in dBm.| | rssi | number | Read only| RSSI of the hotspot, in dBm.|
| band | number | Read only| Frequency band of the WLAN AP.| | band | number | Read only| Frequency band of the WLAN AP.|
| linkSpeed | number | Read only| Speed of the WLAN AP.| | linkSpeed | number | Read only| Speed of the WLAN AP.|
| frequency | number | Read only| Frequency of the WLAN AP.| | frequency | number | Read only| Frequency of the WLAN AP.|
...@@ -361,7 +364,7 @@ Enumerates the WLAN connection states. ...@@ -361,7 +364,7 @@ Enumerates the WLAN connection states.
| CONNECTED | 4 | A WLAN connection is established.| | CONNECTED | 4 | A WLAN connection is established.|
| DISCONNECTING | 5 | The WLAN connection is being disconnected.| | DISCONNECTING | 5 | The WLAN connection is being disconnected.|
| DISCONNECTED | 6 | The WLAN connection is disconnected.| | DISCONNECTED | 6 | The WLAN connection is disconnected.|
| UNKNOWN | 7 | Failed to set up a WLAN connection.| | UNKNOWN | 7 | Failed to set up the WLAN connection.|
## wifi.isConnected<sup>7+</sup> ## wifi.isConnected<sup>7+</sup>
...@@ -370,13 +373,13 @@ isConnected(): boolean ...@@ -370,13 +373,13 @@ isConnected(): boolean
Checks whether the WLAN is connected. Checks whether the WLAN is connected.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the WLAN is connected; returns **false** otherwise.| | boolean | Returns **true** if the WLAN is connected; returns **false** otherwise.|
...@@ -388,10 +391,10 @@ isFeatureSupported(featureId: number): boolean ...@@ -388,10 +391,10 @@ isFeatureSupported(featureId: number): boolean
Checks whether the device supports the specified WLAN feature. Checks whether the device supports the specified WLAN feature.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.Core SystemCapability.Communication.WiFi.Core
- **Parameters** - **Parameters**
...@@ -399,7 +402,7 @@ Checks whether the device supports the specified WLAN feature. ...@@ -399,7 +402,7 @@ Checks whether the device supports the specified WLAN feature.
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| featureId | number | Yes| Feature ID.| | featureId | number | Yes| Feature ID.|
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the feature is supported; returns **false** otherwise.| | boolean | Returns **true** if the feature is supported; returns **false** otherwise.|
...@@ -408,14 +411,14 @@ Checks whether the device supports the specified WLAN feature. ...@@ -408,14 +411,14 @@ Checks whether the device supports the specified WLAN feature.
| Value| Description| | Value| Description|
| -------- | -------- | | -------- | -------- |
| 0x0001 | WLAN infrastructure mode| | 0x0001 | WLAN infrastructure mode|
| 0x0002 | 5 GHz bandwidth| | 0x0002 | 5 GHz feature|
| 0x0004 | Generic Advertisement Service (GAS)/Access Network Query Protocol (ANQP) feature| | 0x0004 | Generic Advertisement Service (GAS)/Access Network Query Protocol (ANQP) feature|
| 0x0008 | Wi-Fi Direct| | 0x0008 | Wi-Fi Direct|
| 0x0010 | SoftAP| | 0x0010 | SoftAP|
| 0x0040 | Wi-Fi AWare| | 0x0040 | Wi-Fi AWare|
| 0x8000 | WLAN AP/STA concurrency| | 0x8000 | WLAN AP/STA concurrency|
| 0x8000000 | WPA3 Personal (WPA-3 SAE)| | 0x8000000 | WPA3 Personal (WPA-3 SAE)|
| 0x10000000 | WPA3-Enterprise&nbsp;Suite-B | | 0x10000000 | WPA3-Enterprise Suite B |
| 0x20000000 | Enhanced open feature| | 0x20000000 | Enhanced open feature|
...@@ -425,13 +428,13 @@ getIpInfo(): IpInfo ...@@ -425,13 +428,13 @@ getIpInfo(): IpInfo
Obtains IP information. Obtains IP information.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| [IpInfo](#IpInfo) | IP information obtained.| | [IpInfo](#IpInfo) | IP information obtained.|
...@@ -443,13 +446,13 @@ Represents IP information. ...@@ -443,13 +446,13 @@ Represents IP information.
| **Name**| **Type**| **Readable/Writable**| **Description**| | **Name**| **Type**| **Readable/Writable**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ipAddress | number | Read only| IP address| | ipAddress | number | Read only| IP address.|
| gateway | number | Read only| Gateway| | gateway | number | Read only| Gateway.|
| netmask | number | Read only| Subnet mask| | netmask | number | Read only| Subnet mask.|
| primaryDns | number | Read only| IP address of the preferred DNS server| | primaryDns | number | Read only| IP address of the preferred DNS server.|
| secondDns | number | Read only| IP address of the alternate DNS server| | secondDns | number | Read only| IP address of the alternate DNS server.|
| serverIp | number | Read only| IP address of the DHCP server| | serverIp | number | Read only| IP address of the DHCP server.|
| leaseDuration | number | Read only| Lease duration of the IP address| | leaseDuration | number | Read only| Lease duration of the IP address.|
## wifi.getCountryCode<sup>7+</sup> ## wifi.getCountryCode<sup>7+</sup>
...@@ -458,13 +461,13 @@ getCountryCode(): string ...@@ -458,13 +461,13 @@ getCountryCode(): string
Obtains the country code. Obtains the country code.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.Core SystemCapability.Communication.WiFi.Core
- Return value - **Return value**
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| string | Country code obtained.| | string | Country code obtained.|
...@@ -474,15 +477,15 @@ Obtains the country code. ...@@ -474,15 +477,15 @@ Obtains the country code.
getP2pLinkedInfo(): Promise&lt;WifiP2pLinkedInfo&gt; getP2pLinkedInfo(): Promise&lt;WifiP2pLinkedInfo&gt;
Obtains peer-to-peer (P2P) connection information. This method uses a promise to return the result. Obtains peer-to-peer (P2P) connection information. This API uses a promise to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)&gt; | Promise used to return the P2P connection information obtained.| | Promise&lt;[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)&gt; | Promise used to return the P2P connection information obtained.|
...@@ -492,18 +495,18 @@ Obtains peer-to-peer (P2P) connection information. This method uses a promise to ...@@ -492,18 +495,18 @@ Obtains peer-to-peer (P2P) connection information. This method uses a promise to
getP2pLinkedInfo(callback: AsyncCallback&lt;WifiP2pLinkedInfo&gt;): void getP2pLinkedInfo(callback: AsyncCallback&lt;WifiP2pLinkedInfo&gt;): void
Obtains P2P connection information. This method uses a callback to return the result. Obtains P2P connection information. This API uses an asynchronous callback to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)&gt; | Yes| Callback used to return the P2P connection information obtained.| | callback | AsyncCallback&lt;[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)&gt; | Yes| Callback invoked to return the P2P connection information obtained.|
## WifiP2pLinkedInfo<sup>8+</sup> ## WifiP2pLinkedInfo<sup>8+</sup>
...@@ -531,15 +534,15 @@ Enumerates the P2P connection states. ...@@ -531,15 +534,15 @@ Enumerates the P2P connection states.
getCurrentGroup(): Promise&lt;WifiP2pGroupInfo&gt; getCurrentGroup(): Promise&lt;WifiP2pGroupInfo&gt;
Obtains the current P2P group information. This method uses a promise to return the result. Obtains the current P2P group information. This API uses a promise to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;[WifiP2pGroupInfo](#WifiP2pGroupInfo)&gt; | Promise used to return the P2P group information obtained.| | Promise&lt;[WifiP2pGroupInfo](#WifiP2pGroupInfo)&gt; | Promise used to return the P2P group information obtained.|
...@@ -549,18 +552,18 @@ Obtains the current P2P group information. This method uses a promise to return ...@@ -549,18 +552,18 @@ Obtains the current P2P group information. This method uses a promise to return
getCurrentGroup(callback: AsyncCallback&lt;WifiP2pGroupInfo&gt;): void getCurrentGroup(callback: AsyncCallback&lt;WifiP2pGroupInfo&gt;): void
Obtains the P2P group information. This method uses an asynchronous callback to return the result. Obtains the P2P group information. This API uses an asynchronous callback to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pGroupInfo](#WifiP2pGroupInfo)&gt; | Yes| Callback used to return the P2P group information obtained.| | callback | AsyncCallback&lt;[WifiP2pGroupInfo](#WifiP2pGroupInfo)&gt; | Yes| Callback invoked to return the P2P group information obtained.|
## WifiP2pGroupInfo<sup>8+</sup> ## WifiP2pGroupInfo<sup>8+</sup>
...@@ -571,7 +574,7 @@ Represents the P2P group information. ...@@ -571,7 +574,7 @@ Represents the P2P group information.
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| isP2pGo | boolean | Read only| Whether it is a group.| | isP2pGo | boolean | Read only| Whether it is a group.|
| ownerInfo | [WifiP2pDevice](#WifiP2pDevice) | Read only| Device information of the group.| | ownerInfo | [WifiP2pDevice](#WifiP2pDevice) | Read only| Device information of the group.|
| passphrase | string | Read only| Private key of the group.| | passphrase | string | Read only| Passphrase of the group.|
| interface | string | Read only| Interface name.| | interface | string | Read only| Interface name.|
| groupName | string | Read only| Group name.| | groupName | string | Read only| Group name.|
| networkId | number | Read only| Network ID.| | networkId | number | Read only| Network ID.|
...@@ -593,7 +596,7 @@ Represents the P2P device information. ...@@ -593,7 +596,7 @@ Represents the P2P device information.
## P2pDeviceStatus<sup>8+</sup> ## P2pDeviceStatus<sup>8+</sup>
Enumerates the device states. Enumerates the P2P device states.
| Name| Default Value| Description| | Name| Default Value| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
...@@ -608,15 +611,15 @@ Enumerates the device states. ...@@ -608,15 +611,15 @@ Enumerates the device states.
getP2pPeerDevices(): Promise&lt;WifiP2pDevice[]&gt; getP2pPeerDevices(): Promise&lt;WifiP2pDevice[]&gt;
Obtains the list of peer devices in a P2P connection. This method uses a promise to return the result. Obtains the list of peer devices in the P2P connection. This API uses a promise to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | Promise used to return the peer device list obtained.| | Promise&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | Promise used to return the peer device list obtained.|
...@@ -626,18 +629,18 @@ Obtains the list of peer devices in a P2P connection. This method uses a promise ...@@ -626,18 +629,18 @@ Obtains the list of peer devices in a P2P connection. This method uses a promise
getP2pPeerDevices(callback: AsyncCallback&lt;WifiP2pDevice[]&gt;): void getP2pPeerDevices(callback: AsyncCallback&lt;WifiP2pDevice[]&gt;): void
Obtains the list of peer devices in a P2P connection. This method uses an asynchronous callback to return the result. Obtains the list of peer devices in the P2P connection. This API uses an asynchronous callback to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | Yes| Callback used to return the peer device list obtained.| | callback | AsyncCallback&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | Yes| Callback involed to return the peer device list obtained.|
## wifi.createGroup<sup>8+</sup> ## wifi.createGroup<sup>8+</sup>
...@@ -646,10 +649,10 @@ createGroup(config: WifiP2PConfig): boolean; ...@@ -646,10 +649,10 @@ createGroup(config: WifiP2PConfig): boolean;
Creates a P2P group. Creates a P2P group.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- **Parameters** - **Parameters**
...@@ -657,27 +660,27 @@ Creates a P2P group. ...@@ -657,27 +660,27 @@ Creates a P2P group.
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [WifiP2PConfig](#WifiP2PConfig) | Yes| Group configuration.| | config | [WifiP2PConfig](#WifiP2PConfig) | Yes| Group configuration.|
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
## WifiP2PConfig<sup>8+</sup> ## WifiP2PConfig<sup>8+</sup>
Represents P2P configuration. Represents P2P group configuration.
| Name| Type| Readable/Writable| Description| | Name| Type| Readable/Writable| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceAddress | string | Read only| Device address.| | deviceAddress | string | Read only| Device address.|
| netId | number | Read only| Network ID. The value **-1** indicates that a temporary group, and **-2** indicates that a persistent group.| | netId | number | Read only| Network ID. The value **-1** indicates a temporary group, and **-2** indicates a persistent group.|
| passphrase | string | Read only| Private key of the group.| | passphrase | string | Read only| Passphrase of the group.|
| groupName | string | Read only| Name of the group.| | groupName | string | Read only| Name of the group.|
| goBand | [GroupOwnerBand](#GroupOwnerBand) | Read only| Bandwidth of the group.| | goBand | [GroupOwnerBand](#GroupOwnerBand) | Read only| Frequency band of the group.|
## GroupOwnerBand<sup>8+</sup> ## GroupOwnerBand<sup>8+</sup>
Enumerates the P2P group bandwidths. Enumerates the P2P group frequency bands.
| Name| Default Value| Description| | Name| Default Value| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
...@@ -689,15 +692,15 @@ Enumerates the P2P group bandwidths. ...@@ -689,15 +692,15 @@ Enumerates the P2P group bandwidths.
removeGroup(): boolean; removeGroup(): boolean;
Removes a P2P group. Removes this P2P group.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
...@@ -709,24 +712,24 @@ p2pConnect(config: WifiP2PConfig): boolean; ...@@ -709,24 +712,24 @@ p2pConnect(config: WifiP2PConfig): boolean;
Sets up a P2P connection. Sets up a P2P connection.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- **Parameters** - **Parameters**
| **Name**| **Type**| Mandatory| **Description**| | **Name**| **Type**| Mandatory| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [WifiP2PConfig](#WifiP2PConfig) | Yes| Connection configuration.| | config | [WifiP2PConfig](#WifiP2PConfig) | Yes| P2P group configuration.|
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
- Example - **Example**
```js ```js
import wifi from '@ohos.wifi'; import wifi from '@ohos.wifi';
...@@ -799,13 +802,13 @@ p2pCancelConnect(): boolean; ...@@ -799,13 +802,13 @@ p2pCancelConnect(): boolean;
Cancels this P2P connection. Cancels this P2P connection.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
...@@ -817,13 +820,13 @@ startDiscoverDevices(): boolean; ...@@ -817,13 +820,13 @@ startDiscoverDevices(): boolean;
Starts to discover devices. Starts to discover devices.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
...@@ -835,13 +838,13 @@ stopDiscoverDevices(): boolean; ...@@ -835,13 +838,13 @@ stopDiscoverDevices(): boolean;
Stops discovering devices. Stops discovering devices.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Return value - **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
...@@ -853,13 +856,13 @@ on(type: "wifiStateChange", callback: Callback&lt;number&gt;): void ...@@ -853,13 +856,13 @@ on(type: "wifiStateChange", callback: Callback&lt;number&gt;): void
Registers the WLAN state change events. Registers the WLAN state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **wifiStateChange**.| | type | string | Yes| Event type. The value is **wifiStateChange**.|
...@@ -880,19 +883,19 @@ off(type: "wifiStateChange", callback?: Callback&lt;number&gt;): void ...@@ -880,19 +883,19 @@ off(type: "wifiStateChange", callback?: Callback&lt;number&gt;): void
Unregisters the WLAN state change events. Unregisters the WLAN state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **wifiStateChange**.| | type | string | Yes| Event type. The value is **wifiStateChange**.|
| callback | Callback&lt;number&gt; | No| Callback used to return the WLAN state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| | callback | Callback&lt;number&gt; | No| Callback used to return the WLAN state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.|
- Example - **Example**
```js ```js
import wifi from '@ohos.wifi'; import wifi from '@ohos.wifi';
...@@ -901,10 +904,10 @@ Unregisters the WLAN state change events. ...@@ -901,10 +904,10 @@ Unregisters the WLAN state change events.
console.info("Receive power state change event: " + result); console.info("Receive power state change event: " + result);
} }
// Register event // Register an event.
wifi.on(WIFI_POWER_STATE, recvPowerNotifyFunc); wifi.on(WIFI_POWER_STATE, recvPowerNotifyFunc);
// Unregister event // Unregister an event.
wifi.off(WIFI_POWER_STATE, recvPowerNotifyFunc); wifi.off(WIFI_POWER_STATE, recvPowerNotifyFunc);
``` ```
...@@ -915,13 +918,13 @@ on(type: "wifiConnectionChange", callback: Callback&lt;number&gt;): void ...@@ -915,13 +918,13 @@ on(type: "wifiConnectionChange", callback: Callback&lt;number&gt;): void
Registers the WLAN connection state change events. Registers the WLAN connection state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **wifiConnectionChange**.| | type | string | Yes| Event type. The value is **wifiConnectionChange**.|
...@@ -930,8 +933,8 @@ Registers the WLAN connection state change events. ...@@ -930,8 +933,8 @@ Registers the WLAN connection state change events.
- Enumerates the WLAN connection states. - Enumerates the WLAN connection states.
| **Value**| **Description**| | **Value**| **Description**|
| -------- | -------- | | -------- | -------- |
| 0 | Disconnected| | 0 | Disconnected.|
| 1 | Connected| | 1 | Connected.|
## wifi.off('wifiConnectionChange')<sup>7+</sup> ## wifi.off('wifiConnectionChange')<sup>7+</sup>
...@@ -940,17 +943,17 @@ off(type: "wifiConnectionChange", callback?: Callback&lt;number&gt;): void ...@@ -940,17 +943,17 @@ off(type: "wifiConnectionChange", callback?: Callback&lt;number&gt;): void
Unregisters the WLAN connection state change events. Unregisters the WLAN connection state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **wifiConnectionChange**.| | type | string | Yes| Event type. The value is **wifiConnectionChange**.|
| callback | Callback&lt;number&gt; | No| Callback used to report the WLAN connection state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| | callback | Callback&lt;number&gt; | No| Callback used to return the WLAN connection state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.|
## wifi.on('wifiScanStateChange')<sup>7+</sup> ## wifi.on('wifiScanStateChange')<sup>7+</sup>
...@@ -959,13 +962,13 @@ on(type: "wifiScanStateChange", callback: Callback&lt;number&gt;): void ...@@ -959,13 +962,13 @@ on(type: "wifiScanStateChange", callback: Callback&lt;number&gt;): void
Registers the WLAN scan state change events. Registers the WLAN scan state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **wifiScanStateChange**.| | type | string | Yes| Event type. The value is **wifiScanStateChange**.|
...@@ -974,8 +977,8 @@ Registers the WLAN scan state change events. ...@@ -974,8 +977,8 @@ Registers the WLAN scan state change events.
- Enumerates the WLAN scan states. - Enumerates the WLAN scan states.
| **Value**| **Description**| | **Value**| **Description**|
| -------- | -------- | | -------- | -------- |
| 0 | Scan failed| | 0 | Scan failed.|
| 1 | Scan successful| | 1 | Scan successful.|
## wifi.off('wifiScanStateChange')<sup>7+</sup> ## wifi.off('wifiScanStateChange')<sup>7+</sup>
...@@ -984,13 +987,13 @@ off(type: "wifiScanStateChange", callback?: Callback&lt;number&gt;): void ...@@ -984,13 +987,13 @@ off(type: "wifiScanStateChange", callback?: Callback&lt;number&gt;): void
Unregisters the WLAN scan state change events. Unregisters the WLAN scan state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -1002,15 +1005,15 @@ Unregisters the WLAN scan state change events. ...@@ -1002,15 +1005,15 @@ Unregisters the WLAN scan state change events.
on(type: "wifiRssiChange", callback: Callback&lt;number&gt;): void on(type: "wifiRssiChange", callback: Callback&lt;number&gt;): void
Registers the RSSI state change events. Registers the RSSI change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **wifiRssiChange**.| | type | string | Yes| Event type. The value is **wifiRssiChange**.|
...@@ -1021,19 +1024,19 @@ Registers the RSSI state change events. ...@@ -1021,19 +1024,19 @@ Registers the RSSI state change events.
off(type: "wifiRssiChange", callback?: Callback&lt;number&gt;): void off(type: "wifiRssiChange", callback?: Callback&lt;number&gt;): void
Unregisters the RSSI state change events. Unregisters the RSSI change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.STA SystemCapability.Communication.WiFi.STA
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **wifiRssiChange**.| | type | string | Yes| Event type. The value is **wifiRssiChange**.|
| callback | Callback&lt;number&gt; | No| Callback used to return the RSSI, in dBm. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| | callback | Callback&lt;number&gt; | No| Callback used to return the RSSI. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.|
## wifi.on('hotspotStateChange')<sup>7+</sup> ## wifi.on('hotspotStateChange')<sup>7+</sup>
...@@ -1042,13 +1045,13 @@ on(type: "hotspotStateChange", callback: Callback&lt;number&gt;): void ...@@ -1042,13 +1045,13 @@ on(type: "hotspotStateChange", callback: Callback&lt;number&gt;): void
Registers the hotspot state change events. Registers the hotspot state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.AP.Core SystemCapability.Communication.WiFi.AP.Core
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **hotspotStateChange**.| | type | string | Yes| Event type. The value is **hotspotStateChange**.|
...@@ -1069,13 +1072,13 @@ off(type: "hotspotStateChange", callback?: Callback&lt;number&gt;): void ...@@ -1069,13 +1072,13 @@ off(type: "hotspotStateChange", callback?: Callback&lt;number&gt;): void
Unregisters the hotspot state change events. Unregisters the hotspot state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.AP.Core SystemCapability.Communication.WiFi.AP.Core
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **hotspotStateChange**.| | type | string | Yes| Event type. The value is **hotspotStateChange**.|
...@@ -1086,15 +1089,15 @@ Unregisters the hotspot state change events. ...@@ -1086,15 +1089,15 @@ Unregisters the hotspot state change events.
on(type: "p2pStateChange", callback: Callback&lt;number&gt;): void on(type: "p2pStateChange", callback: Callback&lt;number&gt;): void
Registers the P2P status change events. Registers the P2P state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pStateChange**.| | type | string | Yes| Event type. The value is **p2pStateChange**.|
...@@ -1115,13 +1118,13 @@ off(type: "p2pStateChange", callback?: Callback&lt;number&gt;): void ...@@ -1115,13 +1118,13 @@ off(type: "p2pStateChange", callback?: Callback&lt;number&gt;): void
Unregisters the P2P state change events. Unregisters the P2P state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pStateChange**.| | type | string | Yes| Event type. The value is **p2pStateChange**.|
...@@ -1134,13 +1137,13 @@ on(type: "p2pConnectionChange", callback: Callback&lt;WifiP2pLinkedInfo&gt;): vo ...@@ -1134,13 +1137,13 @@ on(type: "p2pConnectionChange", callback: Callback&lt;WifiP2pLinkedInfo&gt;): vo
Registers the P2P connection state change events. Registers the P2P connection state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pConnectionChange**.| | type | string | Yes| Event type. The value is **p2pConnectionChange**.|
...@@ -1153,13 +1156,13 @@ off(type: "p2pConnectionChange", callback?: Callback&lt;WifiP2pLinkedInfo&gt;): ...@@ -1153,13 +1156,13 @@ off(type: "p2pConnectionChange", callback?: Callback&lt;WifiP2pLinkedInfo&gt;):
Unregisters the P2P connection state change events. Unregisters the P2P connection state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pConnectionChange**.| | type | string | Yes| Event type. The value is **p2pConnectionChange**.|
...@@ -1172,13 +1175,13 @@ on(type: "p2pDeviceChange", callback: Callback&lt;WifiP2pDevice&gt;): void ...@@ -1172,13 +1175,13 @@ on(type: "p2pDeviceChange", callback: Callback&lt;WifiP2pDevice&gt;): void
Registers the P2P device state change events. Registers the P2P device state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pDeviceChange**.| | type | string | Yes| Event type. The value is **p2pDeviceChange**.|
...@@ -1191,17 +1194,17 @@ off(type: "p2pDeviceChange", callback?: Callback&lt;WifiP2pDevice&gt;): void ...@@ -1191,17 +1194,17 @@ off(type: "p2pDeviceChange", callback?: Callback&lt;WifiP2pDevice&gt;): void
Unregisters the P2P device state change events. Unregisters the P2P device state change events.
- Required permissions: - **Required permissions**:
ohos.permission.LOCATION ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pDeviceChange**.| | type | string | Yes| Event type. The value is **p2pDeviceChange**.|
| callback | Callback&lt;[WifiP2pDevice](#WifiP2pDevice)&gt; | No| Callback used to return the P2P device state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| | callback | Callback&lt;[WifiP2pDevice](#WifiP2pDevice)&gt; | No| Callback used to return the P2P peer device state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.|
## wifi.on('p2pPeerDeviceChange')<sup>8+</sup> ## wifi.on('p2pPeerDeviceChange')<sup>8+</sup>
...@@ -1210,17 +1213,17 @@ on(type: "p2pPeerDeviceChange", callback: Callback&lt;WifiP2pDevice[]&gt;): void ...@@ -1210,17 +1213,17 @@ on(type: "p2pPeerDeviceChange", callback: Callback&lt;WifiP2pDevice[]&gt;): void
Registers the P2P peer device state change events. Registers the P2P peer device state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.| | type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.|
| callback | Callback&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | Yes| Callback invoked to return the P2P peer device state.| | callback | Callback&lt;[WifiP2pDevice[]](#WifiP2pDevice)&gt; | Yes| Callback invoked to return the peer device state.|
## wifi.off('p2pPeerDeviceChange')<sup>8+</sup> ## wifi.off('p2pPeerDeviceChange')<sup>8+</sup>
...@@ -1229,13 +1232,13 @@ off(type: "p2pPeerDeviceChange", callback?: Callback&lt;WifiP2pDevice[]&gt;): vo ...@@ -1229,13 +1232,13 @@ off(type: "p2pPeerDeviceChange", callback?: Callback&lt;WifiP2pDevice[]&gt;): vo
Unregisters the P2P peer device state change events. Unregisters the P2P peer device state change events.
- Required permissions: - **Required permissions**:
ohos.permission.LOCATION ohos.permission.LOCATION
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.| | type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.|
...@@ -1248,13 +1251,13 @@ on(type: "p2pPersistentGroupChange", callback: Callback&lt;void&gt;): void ...@@ -1248,13 +1251,13 @@ on(type: "p2pPersistentGroupChange", callback: Callback&lt;void&gt;): void
Registers the P2P persistent group state change events. Registers the P2P persistent group state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.| | type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.|
...@@ -1267,13 +1270,13 @@ off(type: "p2pPersistentGroupChange", callback?: Callback&lt;void&gt;): void ...@@ -1267,13 +1270,13 @@ off(type: "p2pPersistentGroupChange", callback?: Callback&lt;void&gt;): void
Unregisters the P2P persistent group state change events. Unregisters the P2P persistent group state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.| | type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.|
...@@ -1284,21 +1287,21 @@ Unregisters the P2P persistent group state change events. ...@@ -1284,21 +1287,21 @@ Unregisters the P2P persistent group state change events.
on(type: "p2pDiscoveryChange", callback: Callback&lt;number&gt;): void on(type: "p2pDiscoveryChange", callback: Callback&lt;number&gt;): void
Registers the P2P discovered device state change events. Registers the P2P device discovery state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pDiscoveryChange**.| | type | string | Yes| Event type. The value is **p2pDiscoveryChange**.|
| callback | Callback&lt;number&gt; | Yes| Callback invoked to return the state of the P2P discovered device.| | callback | Callback&lt;number&gt; | Yes| Callback invoked to return the P2P device discovery state.|
- Enumerates the states of P2P discovered devices. - Enumerates the P2P device discovery states.
| **Value**| **Description**| | **Value**| **Description**|
| -------- | -------- | | -------- | -------- |
| 0 | Initial state| | 0 | Initial state|
...@@ -1309,16 +1312,16 @@ Registers the P2P discovered device state change events. ...@@ -1309,16 +1312,16 @@ Registers the P2P discovered device state change events.
off(type: "p2pDiscoveryChange", callback?: Callback&lt;number&gt;): void off(type: "p2pDiscoveryChange", callback?: Callback&lt;number&gt;): void
Unregisters the P2P discovered device state change events. Unregisters the P2P device discovery state change events.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.P2P SystemCapability.Communication.WiFi.P2P
- Parameters - **Parameters**
| **Name**| **Type**| **Mandatory**| **Description**| | **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value is **p2pDiscoveryChange**.| | type | string | Yes| Event type. The value is **p2pDiscoveryChange**.|
| callback | Callback&lt;number&gt; | No| Callback used to return the state of the P2P discovered device. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| | callback | Callback&lt;number&gt; | No| Callback used to return the P2P device discovery state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.|
en/application-dev/reference/apis/js-apis-wifiext.md
浏览文件 @ 6201dc59
# WLAN # WLAN
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**<br/> > **NOTE**<br>
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
The APIs described in this document are used only for non-universal products, such as routers. The APIs described in this document are used only for non-universal products, such as routers.
The APIs of this module are not supported by OpenHarmony 3.1 Release.
## Modules to Import ## Modules to Import
...@@ -17,13 +18,13 @@ enableHotspot(): boolean; ...@@ -17,13 +18,13 @@ enableHotspot(): boolean;
Enables the WLAN hotspot. Enables the WLAN hotspot.
- Required permissions: - **Required permissions**:
ohos.permission.MANAGE_WIFI_HOTSPOT_EXT ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.AP.Extension SystemCapability.Communication.WiFi.AP.Extension
- Return value - **Return value**:
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
...@@ -35,13 +36,13 @@ disableHotspot(): boolean; ...@@ -35,13 +36,13 @@ disableHotspot(): boolean;
Disables the WLAN hotspot. Disables the WLAN hotspot.
- Required permissions: - **Required permissions**:
ohos.permission.MANAGE_WIFI_HOTSPOT_EXT ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.AP.Extension SystemCapability.Communication.WiFi.AP.Extension
- Return value - **Return value**:
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
...@@ -51,15 +52,15 @@ Disables the WLAN hotspot. ...@@ -51,15 +52,15 @@ Disables the WLAN hotspot.
getSupportedPowerModel(): Promise&lt;Array&lt;PowerModel&gt;&gt; getSupportedPowerModel(): Promise&lt;Array&lt;PowerModel&gt;&gt;
Obtains the supported power models. The method uses a promise to return the result. Obtains the supported power models. The API uses a promise to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.AP.Extension SystemCapability.Communication.WiFi.AP.Extension
- Return value - **Return value**:
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;Array&lt;[PowerModel](#PowerModel)&gt;&gt; | Promise used to return the power models obtained.| | Promise&lt;Array&lt;[PowerModel](#PowerModel)&gt;&gt; | Promise used to return the power models obtained.|
...@@ -67,7 +68,7 @@ Obtains the supported power models. The method uses a promise to return the resu ...@@ -67,7 +68,7 @@ Obtains the supported power models. The method uses a promise to return the resu
## PowerModel ## PowerModel
Enumerates of the power models. Enumerates the power models.
| Name| Default Value| Description| | Name| Default Value| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
...@@ -80,33 +81,33 @@ Enumerates of the power models. ...@@ -80,33 +81,33 @@ Enumerates of the power models.
getSupportedPowerModel(callback: AsyncCallback&lt;Array&lt;PowerModel&gt;&gt;): void getSupportedPowerModel(callback: AsyncCallback&lt;Array&lt;PowerModel&gt;&gt;): void
Obtains the supported power models. The method uses an asynchronous callback to return the result. Obtains the supported power models. The API uses an asynchronous callback to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.AP.Extension SystemCapability.Communication.WiFi.AP.Extension
- Parameters - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[PowerModel](#PowerModel)&gt; | Yes| Callback used to return the power models obtained.| | callback | AsyncCallback&lt;[PowerModel](#PowerModel)&gt; | Yes| Callback invoked to return the power models obtained.|
## wifiext.getPowerModel ## wifiext.getPowerModel
getPowerModel(): Promise&lt;PowerModel&gt; getPowerModel(): Promise&lt;PowerModel&gt;
Obtains the power model. The method uses a promise to return the result. Obtains the power model. The API uses a promise to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.AP.Extension SystemCapability.Communication.WiFi.AP.Extension
- Return value - **Return value**:
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;[PowerModel](#PowerModel)&gt; | Promise used to return the power model obtained.| | Promise&lt;[PowerModel](#PowerModel)&gt; | Promise used to return the power model obtained.|
...@@ -116,15 +117,15 @@ Obtains the power model. The method uses a promise to return the result. ...@@ -116,15 +117,15 @@ Obtains the power model. The method uses a promise to return the result.
getPowerModel(callback: AsyncCallback&lt;PowerModel&gt;): void getPowerModel(callback: AsyncCallback&lt;PowerModel&gt;): void
Obtains the power model. The method uses an asynchronous callback to return the result. Obtains the power model. The API uses an asynchronous callback to return the result.
- Required permissions: - **Required permissions**:
ohos.permission.GET_WIFI_INFO ohos.permission.GET_WIFI_INFO
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.AP.Extension SystemCapability.Communication.WiFi.AP.Extension
- Parameters - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[PowerModel](#PowerModel)&gt; | Yes| Callback invoked to return the power mode obtained.| | callback | AsyncCallback&lt;[PowerModel](#PowerModel)&gt; | Yes| Callback invoked to return the power mode obtained.|
...@@ -136,18 +137,18 @@ setPowerModel(model: PowerModel) : boolean; ...@@ -136,18 +137,18 @@ setPowerModel(model: PowerModel) : boolean;
Sets the power model. Sets the power model.
- Required permissions: - **Required permissions**:
ohos.permission.MANAGE_WIFI_HOTSPOT_EXT ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
- System capability: - **System capability**:
SystemCapability.Communication.WiFi.AP.Extension SystemCapability.Communication.WiFi.AP.Extension
- Parameters - **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| model | AsyncCallback&lt;[PowerModel](#PowerModel)&gt; | Yes| Power model to set.| | model | AsyncCallback&lt;[PowerModel](#PowerModel)&gt; | Yes| Power model to set.|
- Return value - **Return value**:
| **Type**| **Description**| | **Type**| **Description**|
| -------- | -------- | | -------- | -------- |
| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或