diff --git a/en/application-dev/reference/apis/js-apis-wifi.md b/en/application-dev/reference/apis/js-apis-wifi.md index 4cede020064f4a8ad43892a7940715bd49b52679..3e939dd446de55d7d4ca8d8abd12705494ab051a 100644 --- a/en/application-dev/reference/apis/js-apis-wifi.md +++ b/en/application-dev/reference/apis/js-apis-wifi.md @@ -1,1409 +1,1324 @@ -# WLAN +# WLAN ->**NOTE:** ->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. +> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> 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. -## Modules to Import -``` +## Modules to Import + +```js import wifi from '@ohos.wifi'; ``` -## wifi.isWifiActive +## wifi.isWifiActive -isWifiActive\(\): boolean +isWifiActive(): boolean Checks whether the WLAN is activated. -- Return values +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA - - - - - - - - - -

Type

-

Description

-

boolean

-

Returns true if the WLAN is activated; returns false otherwise.

-
+- Return value + | **Type**| **Description**| + | -------- | -------- | + | boolean | Returns **true** if the WLAN is activated; returns **false** otherwise.| -## wifi.scan +## wifi.scan -scan\(\): boolean +scan(): boolean Starts a scan for WLAN. -- Return values +- Required permissions: + ohos.permission.SET_WIFI_INFO and ohos.permission.LOCATION - - - - - - - - - -

Type

-

Description

-

boolean

-

Returns true if the scan is successful; returns false otherwise.

-
+- System capability: + SystemCapability.Communication.WiFi.STA +- Return value + | **Type**| **Description**| + | -------- | -------- | + | boolean | Returns **true** if the scan is successful; returns **false** otherwise.| -## wifi.getScanInfos -getScanInfos\(\): Promise\> +## wifi.getScanInfos + +getScanInfos(): Promise<Array<WifiScanInfo>> Obtains the scan result. This method uses a promise to return the result. -- Return values +- Required permissions: + ohos.permission.GET_WIFI_INFO, ohos.permission.GET_WIFI_PEERS_MAC, or ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.STA - - - - - - - - - -

Type

-

Description

-

Promise< Array<WifiScanInfo> >

-

Promise used to return the scan result, which is a list of hotspot information.

-
+- Return value + | **Type**| **Description**| + | -------- | -------- | + | Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | Promise used to return the scan result, which is a list of hotspots detected.| -## wifi.getScanInfos +## wifi.getScanInfos -getScanInfos\(callback: AsyncCallback\>\): void +getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void Obtains the scan result. This method uses an asynchronous callback to return the result. -- Parameters - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

callback

-

AsyncCallback< Array<WifiScanInfo>>

-

Yes

-

Callback invoked to return the scan result, which is a list of hotspot information.

-
- - -- Example - - ``` - import wifi from '@ohos.wifi'; - - wifi.getScanInfos(result => { - var len = Object.keys(result).length; - console.log("wifi received scan info call back: " + len); - for (var i = 0; i < len; ++i) { - console.info("ssid: " + result[i].ssid); - console.info("bssid: " + result[i].bssid); - 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("timestamp: " + result[i].timestamp); - } - }); - - wifi.getScanInfos().then(result => { - var len = Object.keys(result).length; - console.log("wifi received scan info promise: " + len); - for (var i = 0; i < len; ++i) { - console.info("ssid: " + result[i].ssid); - console.info("bssid: " + result[i].bssid); - 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("timestamp: " + result[i].timestamp); - } - }); - ``` - - -## WifiScanInfo - -Defines the WLAN hotspot information. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Readable/Writable

-

Description

-

ssid

-

string

-

Read-only

-

Hotspot service set identifier (SSID), in UTF-8 format.

-

bssid

-

string

-

Read-only

-

Basic service set identifier (BSSID) of the hotspot.

-

securityType

-

WifiSecurityType

-

Read-only

-

WLAN encryption type.

-

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).

-

frequency

-

number

-

Read-only

-

Frequency of the WLAN AP.

-

timestamp

-

number

-

Read-only

-

Timestamp.

-
- -## WifiSecurityType - -Enumerates the WLAN encryption types. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Default Value

-

Description

-

WIFI_SEC_TYPE_INVALID

-

0

-

Invalid encryption.

-

WIFI_SEC_TYPE_OPEN

-

1

-

Open encryption.

-

WIFI_SEC_TYPE_WEP

-

2

-

Wired equivalent privacy (WEP) encryption.

-

WIFI_SEC_TYPE_PSK

-

3

-

PSK encryption.

-

WIFI_SEC_TYPE_SAE

-

4

-

Simultaneous authentication of equals (SAE) encryption.

-
- -## wifi.getSignalLevel - -getSignalLevel\(rssi: number, band: number\): number +- Required permissions: + ohos.permission.GET_WIFI_INFO, ohos.permission.GET_WIFI_PEERS_MAC, or ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | Yes| Callback invoked to return the result, which is a list of hotspots detected.| + +- Example + ```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 + +Represents WLAN hotspot information. + +| **Name**| **Type**| **Readable/Writable**| **Description**| +| -------- | -------- | -------- | -------- | +| ssid | string | Read only| Hotspot service set identifier (SSID), in UTF-8 format.| +| bssid | string | Read only| Basic service set identifier (BSSID) of the hotspot.| +| capabilities | string | Read only| Hotspot capabilities.| +| securityType | [WifiSecurityType](#WifiSecurityType) | Read only| WLAN security type.| +| rssi | number | Read only| Signal strength of the hotspot, in dBm.| +| band | number | Read only| Frequency band of the WLAN access point (AP).| +| frequency | number | Read only| Frequency of the WLAN AP.| +| channelWidth | number | Read only| Bandwidth of the WLAN AP.| +| timestamp | number | Read only| Timestamp.| -Obtains the WLAN signal strength. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

rssi

-

number

-

Yes

-

RSSI of the hotspot, in dBm.

-

band

-

number

-

Yes

-

Frequency band of the WLAN AP.

-
- - -- Return values - - - - - - - - - - -

Type

-

Description

-

number

-

Signal strength obtained. The value range is 0 to 4.

-
- - -## wifi.getIpInfo7+ - -getIpInfo\(\): IpInfo +## WifiSecurityType -Obtains IP information. +Enumerates the WLAN security types. -- Return values - - - - - - - - - - -

Type

-

Description

-

IpInfo

-

IP information obtained.

-
- - -## IpInfo - -Defines IP information. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Readable/Writable

-

Description

-

ipAddress

-

number

-

Read-only

-

IP address.

-

gateway

-

number

-

Read-only

-

Gateway.

-

netmask

-

number

-

Read-only

-

Subnet mask.

-

primaryDns

-

number

-

Read-only

-

IP address of the preferred DNS server.

-

secondDns

-

number

-

Read-only

-

IP address of the alternate DNS server.

-

serverIp

-

number

-

Read-only

-

IP address of the DHCP server.

-

leaseDuration

-

number

-

Read-only

-

Lease duration of the IP address.

-
- -## wifi.isConnected7+ - -isConnected\(\): boolean +| **Name**| **Default Value**| **Description**| +| -------- | -------- | -------- | +| WIFI_SEC_TYPE_INVALID | 0 | Invalid security type| +| WIFI_SEC_TYPE_OPEN | 1 | Open security type| +| WIFI_SEC_TYPE_WEP | 2 | Wired Equivalent Privacy (WEP)| +| WIFI_SEC_TYPE_PSK | 3 | Pre-shared key (PSK)| +| WIFI_SEC_TYPE_SAE | 4 | Simultaneous Authentication of Equals (SAE)| -Checks whether the WLAN is connected. -- Return values +## wifi.addUntrustedConfig7+ + +addUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> + +Adds untrusted WLAN configuration. This method uses a promise to return the result. + +- Required permissions: + ohos.permission.SET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to add.| + +- Return value + | **Type**| **Description**| + | -------- | -------- | + | Promise<boolean> | Promise used to return the operation result. The value **true** indicates that the operation is successful; **false** indicates the opposite.| + +## WifiDeviceConfig + +Represents the WLAN configuration. + +| **Name**| **Type**| **Readable/Writable**| **Description**| +| -------- | -------- | -------- | -------- | +| ssid | string | Read only| Hotspot SSID, in UTF-8 format.| +| bssid | string | Read only| BSSID of the hotspot.| +| preSharedKey | string | Read only| Private key of the hotspot.| +| isHiddenSsid | boolean | Read only| Whether to hide the network.| +| securityType | [WifiSecurityType](#WifiSecurityType) | Read only| Security type| + + +## wifi.addUntrustedConfig7+ + +addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean>): void + +Adds untrusted WLAN configuration. This method uses an asynchronous callback to return the result. + +- Required permissions: + ohos.permission.SET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to add.| + | callback | AsyncCallback<boolean> | Yes| Promise used to return the operation result. The value **true** indicates that the operation is successful; **false** indicates the opposite.| + + +## wifi.removeUntrustedConfig7+ + +removeUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> + +Removes untrusted WLAN configuration. This method uses a promise to return the result. + +- Required permissions: + ohos.permission.SET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to remove.| + +- Return value + | **Type**| **Description**| + | -------- | -------- | + | Promise<boolean> | Promise used to return the operation result. The value **true** indicates that the operation is successful; **false** indicates the opposite.| + + +## wifi.removeUntrustedConfig7+ + +removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean>): void + +Removes untrusted WLAN configuration. This method uses an asynchronous callback to return the result. + +- Required permissions: + ohos.permission.SET_WIFI_INFO - - - - - - - - - -

Type

-

Description

-

boolean

-

Returns true if the WLAN is connected; returns false otherwise.

-
+- System capability: + SystemCapability.Communication.WiFi.STA +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | Yes| WLAN configuration to remove.| + | callback | AsyncCallback<boolean> | Yes| Promise used to return the operation result. The value **true** indicates that the operation is successful; **false** indicates the opposite.| -## wifi.getLinkedInfo7+ -getLinkedInfo\(\): Promise +## wifi.getSignalLevel + +getSignalLevel(rssi: number, band: number): number + +Obtains the WLAN signal strength. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- **Parameters** + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | rssi | number | Yes| Signal strength of the hotspot, in dBm.| + | band | number | Yes| Frequency band of the WLAN AP.| + +- Return value + | **Type**| **Description**| + | -------- | -------- | + | number | Signal strength obtained. The value range is [0, 4].| + + +## wifi.getLinkedInfo + +getLinkedInfo(): Promise<WifiLinkedInfo> Obtains WLAN connection information. This method uses a promise to return the result. -- Return values +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA - - - - - - - - - -

Type

-

Description

-

Promise<WifiLinkedInfo>

-

Promise used to return the WLAN connection information

-
+- Return value + | Type| Description| + | -------- | -------- | + | Promise<[WifiLinkedInfo](#WifiLinkedInfo)> | Promise used to return the WLAN connection information obtained.| -## wifi.getLinkedInfo7+ +## wifi.getLinkedInfo -getLinkedInfo\(callback: AsyncCallback\): void +getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void Obtains WLAN connection information. This method uses a callback to return the result. -- Parameters - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

callback

-

AsyncCallback<WifiLinkedInfo>

-

Yes

-

Callback invoked to return the WLAN connection information.

-
- -- Example - - ``` - import wifi from '@ohos.wifi'; - - wifi.getLinkedInfo(data => { - console.info("get wifi linked info [callback]: " + JSON.stringify(data)); - }); - - wifi.getLinkedInfo().then(data => { - console.info("get wifi linked info [promise]: " + JSON.stringify(data)); - }).catch(error => { - console.info("linked info promise then error"); - }); - ``` - - -## WifiLinkedInfo - -Defines the WLAN connection information. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Readable/Writable

-

Description

-

ssid

-

string

-

Read-only

-

Hotspot SSID, in UTF-8 format.

-

bssid

-

string

-

Read-only

-

BSSID of the hotspot.

-

rssi

-

number

-

Read-only

-

RSSI of the hotspot, in dBm.

-

band

-

number

-

Read-only

-

Frequency band of the WLAN AP.

-

linkSpeed

-

number

-

Read-only

-

Speed of the WLAN AP.

-

frequency

-

number

-

Read-only

-

Frequency of the WLAN AP.

-

isHidden

-

boolean

-

Read-only

-

Whether the WLAN AP is hidden.

-

isRestricted

-

boolean

-

Read-only

-

Whether data volume is restricted at the WLAN AP.

-

macAddress

-

string

-

Read-only

-

MAC address of the device that sets up the WLAN connection.

-

ipAddress

-

number

-

Read-only

-

IP address of the device that sets up the WLAN connection.

-

connState

-

ConnState

-

Read-only

-

WLAN connection state.

-
- -## ConnState +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[WifiLinkedInfo](#WifiLinkedInfo)> | Yes| Callback invoked to return the WLAN connection information obtained.| + +- Example + ```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 + +Represents the WLAN connection information. + +| Name| Type| Readable/Writable| Description| +| -------- | -------- | -------- | -------- | +| ssid | string | Read only| SSID of the hotspot, in UTF-8 format.| +| bssid | string | Read only| BSSID of the hotspot.| +| rssi | number | Read only| Signal strength of the hotspot, in dBm.| +| band | number | Read only| Frequency band of the WLAN AP.| +| linkSpeed | number | Read only| Speed of the WLAN AP.| +| frequency | number | Read only| Frequency of the WLAN AP.| +| isHidden | boolean | Read only| Whether the WLAN AP is hidden.| +| isRestricted | boolean | Read only| Whether data volume is restricted at the WLAN AP.| +| macAddress | string | Read only| MAC address of the device.| +| ipAddress | number | Read only| IP address of the device that sets up the WLAN connection.| +| connState | [ConnState](#ConnState) | Read only| WLAN connection state.| + + +## ConnState Enumerates the WLAN connection states. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Default Value

-

Description

-

SCANNING

-

0

-

The device is scanning for available APs.

-

CONNECTING

-

1

-

A WLAN connection is being established.

-

AUTHENTICATING

-

2

-

An authentication is being performed for a WLAN connection.

-

OBTAINING_IPADDR

-

3

-

The IP address of the WLAN connection is being acquired.

-

CONNECTED

-

4

-

A WLAN connection is established.

-

DISCONNECTING

-

5

-

The WLAN connection is being disconnected.

-

DISCONNECTED

-

6

-

The WLAN connection is disconnected.

-

UNKNOWN

-

7

-

Failed to set up a WLAN connection.

-
- -## wifi.getCountryCode7+ - -getCountryCode\(\): string +| Name| Default Value| Description| +| -------- | -------- | -------- | +| SCANNING | 0 | The device is scanning for available APs.| +| CONNECTING | 1 | A WLAN connection is being established.| +| AUTHENTICATING | 2 | An authentication is being performed for a WLAN connection.| +| OBTAINING_IPADDR | 3 | The IP address of the WLAN connection is being acquired.| +| CONNECTED | 4 | A WLAN connection is established.| +| DISCONNECTING | 5 | The WLAN connection is being disconnected.| +| DISCONNECTED | 6 | The WLAN connection is disconnected.| +| UNKNOWN | 7 | Failed to set up a WLAN connection.| -Obtains the country code. -- Return values +## wifi.isConnected7+ - - - - - - - - - -

Type

-

Description

-

string

-

Country code obtained.

-
+isConnected(): boolean + +Checks whether the WLAN is connected. +- Required permissions: + ohos.permission.GET_WIFI_INFO -## wifi.isFeatureSupported7+ +- System capability: + SystemCapability.Communication.WiFi.STA -isFeatureSupported\(featureId: number\): boolean +- Return value + | **Type**| **Description**| + | -------- | -------- | + | boolean | Returns **true** if the WLAN is connected; returns **false** otherwise.| + + +## wifi.isFeatureSupported7+ + +isFeatureSupported(featureId: number): boolean Checks whether the device supports the specified WLAN feature. -- Parameters - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

featureId

-

number

-

Yes

-

Feature ID.

-
- - -- Return values - - - - - - - - - - -

Type

-

Description

-

boolean

-

Returns true if the feature is supported; returns false otherwise.

-
- -- Enumerates the WLAN features. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Value

-

Description

-

0x0001

-

WLAN infrastructure mode.

-

0x0002

-

5 GHz bandwidth.

-

0x0004

-

Generic Advertisement Service (GAS)/Access Network Query Protocol (ANQP) feature.

-

0x0008

-

Wi-Fi Direct.

-

0x0010

-

SoftAP.

-

0x0040

-

Wi-Fi AWare.

-

0x8000

-

WLAN AP/STA concurrency

-

0x8000000

-

WPA3 Personal (WPA-3 SAE) feature.

-

0x10000000

-

WPA3 Enterprise Suite B feature.

-

0x20000000

-

Enhanced open feature.

-
- - -## wifi.on\('wifiStateChange'\)7+ - -on\(type: "wifiStateChange", callback: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.Core + +- **Parameters** + | **Name**| **Type**| Mandatory| **Description**| + | -------- | -------- | -------- | -------- | + | featureId | number | Yes| Feature ID.| + +- Return value + | **Type**| **Description**| + | -------- | -------- | + | boolean | Returns **true** if the feature is supported; returns **false** otherwise.| + +- Enumerates the WLAN features. + | Value| Description| + | -------- | -------- | + | 0x0001 | WLAN infrastructure mode| + | 0x0002 | 5 GHz bandwidth| + | 0x0004 | Generic Advertisement Service (GAS)/Access Network Query Protocol (ANQP) feature| + | 0x0008 | Wi-Fi Direct| + | 0x0010 | SoftAP| + | 0x0040 | Wi-Fi AWare| + | 0x8000 | WLAN AP/STA concurrency| + | 0x8000000 | WPA3 Personal (WPA-3 SAE)| + | 0x10000000 | WPA3-Enterprise Suite-B | + | 0x20000000 | Enhanced open feature| + + +## wifi.getIpInfo7+ + +getIpInfo(): IpInfo + +Obtains IP information. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Return value + | **Type**| **Description**| + | -------- | -------- | + | [IpInfo](#IpInfo) | IP information obtained.| + + +## IpInfo7+ + +Represents IP information. + +| **Name**| **Type**| **Readable/Writable**| **Description**| +| -------- | -------- | -------- | -------- | +| ipAddress | number | Read only| IP address| +| gateway | number | Read only| Gateway| +| netmask | number | Read only| Subnet mask| +| primaryDns | number | Read only| IP address of the preferred DNS server| +| secondDns | number | Read only| IP address of the alternate DNS server| +| serverIp | number | Read only| IP address of the DHCP server| +| leaseDuration | number | Read only| Lease duration of the IP address| + + +## wifi.getCountryCode7+ + +getCountryCode(): string + +Obtains the country code. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.Core + +- Return value + | **Type**| **Description**| + | -------- | -------- | + | string | Country code obtained.| + + +## wifi.getP2pLinkedInfo8+ + +getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo> + +Obtains peer-to-peer (P2P) connection information. This method uses a promise to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Return value + | Type| Description| + | -------- | -------- | + | Promise<[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)> | Promise used to return the P2P connection information obtained.| + + +## wifi.getP2pLinkedInfo8+ + +getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void + +Obtains P2P connection information. This method uses a callback to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)> | Yes| Callback used to return the P2P connection information obtained.| + + +## WifiP2pLinkedInfo8+ + +Represents the WLAN connection information. + +| Name| Type| Readable/Writable| Description| +| -------- | -------- | -------- | -------- | +| connectState | [P2pConnectState](#P2pConnectState) | Read only| P2P connection state.| +| isGroupOwner | boolean | Read only| Whether it is a group.| +| groupOwnerAddr | string | Read only| MAC address of the group.| + + +## P2pConnectState8+ + +Enumerates the P2P connection states. + +| Name| Default Value| Description| +| -------- | -------- | -------- | +| DISCONNECTED | 0 | Disconnected| +| CONNECTED | 1 | Connected| + + +## wifi.getCurrentGroup8+ + +getCurrentGroup(): Promise<WifiP2pGroupInfo> + +Obtains the current P2P group information. This method uses a promise to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Return value + | Type| Description| + | -------- | -------- | + | Promise<[WifiP2pGroupInfo](#WifiP2pGroupInfo)> | Promise used to return the P2P group information obtained.| + + +## wifi.getCurrentGroup8+ + +getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void + +Obtains the P2P group information. This method uses an asynchronous callback to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[WifiP2pGroupInfo](#WifiP2pGroupInfo)> | Yes| Callback used to return the P2P group information obtained.| + + +## WifiP2pGroupInfo8+ + +Represents the P2P group information. + +| Name| Type| Readable/Writable| Description| +| -------- | -------- | -------- | -------- | +| isP2pGo | boolean | Read only| Whether it is a group.| +| ownerInfo | [WifiP2pDevice](#WifiP2pDevice) | Read only| Device information of the group.| +| passphrase | string | Read only| Private key of the group.| +| interface | string | Read only| Interface name.| +| groupName | string | Read only| Group name.| +| networkId | number | Read only| Network ID.| +| frequency | number | Read only| Frequency of the group.| +| clientDevices | [WifiP2pDevice[]](#WifiP2pDevice) | Read only| List of connected devices.| +| goIpAddress | string | Read only| IP address of the group.| + +## WifiP2pDevice8+ + +Represents the P2P device information. + +| Name| Type| Readable/Writable| Description| +| -------- | -------- | -------- | -------- | +| deviceName | string | Read only| Device name.| +| deviceAddress | string | Read only| MAC address of the device.| +| primaryDeviceType | string | Read only| Type of the primary device.| +| deviceStatus | [P2pDeviceStatus](#P2pDeviceStatus) | Read only| Device status.| +| groupCapabilitys | number | Read only| Group capabilities.| + +## P2pDeviceStatus8+ + +Enumerates the device states. + +| Name| Default Value| Description| +| -------- | -------- | -------- | +| CONNECTED | 0 | Connected| +| INVITED | 1 | Invited| +| FAILED | 2 | Failed| +| AVAILABLE | 3 | Available| +| UNAVAILABLE | 4 | Unavailable| + + +## wifi.getP2pPeerDevices8+ + +getP2pPeerDevices(): Promise<WifiP2pDevice[]> + +Obtains the list of peer devices in a P2P connection. This method uses a promise to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Return value + | Type| Description| + | -------- | -------- | + | Promise<[WifiP2pDevice[]](#WifiP2pDevice)> | Promise used to return the peer device list obtained.| + + +## wifi.getP2pPeerDevices8+ + +getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void + +Obtains the list of peer devices in a P2P connection. This method uses an asynchronous callback to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[WifiP2pDevice[]](#WifiP2pDevice)> | Yes| Callback used to return the peer device list obtained.| + + +## wifi.createGroup8+ + +createGroup(config: WifiP2PConfig): boolean; + +Creates a P2P group. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- **Parameters** + | **Name**| **Type**| Mandatory| **Description**| + | -------- | -------- | -------- | -------- | + | config | [WifiP2PConfig](#WifiP2PConfig) | Yes| Group configuration.| + +- Return value + | Type| Description| + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +## WifiP2PConfig8+ + +Represents P2P configuration. + +| Name| Type| Readable/Writable| Description| +| -------- | -------- | -------- | -------- | +| 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.| +| passphrase | string | Read only| Private key of the group.| +| groupName | string | Read only| Name of the group.| +| goBand | [GroupOwnerBand](#GroupOwnerBand) | Read only| Bandwidth of the group.| + + +## GroupOwnerBand8+ + +Enumerates the P2P group bandwidths. + +| Name| Default Value| Description| +| -------- | -------- | -------- | +| GO_BAND_AUTO | 0 | Auto| +| GO_BAND_2GHZ | 1 | 2 GHz| +| GO_BAND_5GHZ | 2 | 5 GHz| + +## wifi.removeGroup8+ + +removeGroup(): boolean; + +Removes a P2P group. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Return value + | Type| Description| + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + + +## wifi.p2pConnect8+ + +p2pConnect(config: WifiP2PConfig): boolean; + +Sets up a P2P connection. + +- Required permissions: + ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- **Parameters** + | **Name**| **Type**| Mandatory| **Description**| + | -------- | -------- | -------- | -------- | + | config | [WifiP2PConfig](#WifiP2PConfig) | Yes| Connection configuration.| + +- Return value + | Type| Description| + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + + +- Example + ```js + import wifi from '@ohos.wifi'; + + var recvP2pConnectionChangeFunc = result => { + console.info("p2p connection change receive event: " + JSON.stringify(result)); + wifi.getP2pLinkedInfo((err, data) => { + if (err) { + console.error('failed to get getP2pLinkedInfo: ' + JSON.stringify(err)); + return; + } + console.info("get getP2pLinkedInfo: " + JSON.stringify(data)); + }); + } + wifi.on("p2pConnectionChange", recvP2pConnectionChangeFunc); + + var recvP2pDeviceChangeFunc = result => { + console.info("p2p device change receive event: " + JSON.stringify(result)); + } + wifi.on("p2pDeviceChange", recvP2pDeviceChangeFunc); + + var recvP2pPeerDeviceChangeFunc = result => { + console.info("p2p peer device change receive event: " + JSON.stringify(result)); + wifi.getP2pPeerDevices((err, data) => { + if (err) { + console.error('failed to get peer devices: ' + JSON.stringify(err)); + return; + } + console.info("get peer devices: " + JSON.stringify(data)); + var len = Object.keys(data).length; + for (var i = 0; i < len; ++i) { + if (data[i].deviceName === "my_test_device") { + console.info("p2p connect to test device: " + data[i].deviceAddress); + var config = { + "deviceAddress":data[i].deviceAddress, + "netId":-2, + "passphrase":"", + "groupName":"", + "goBand":0, + } + wifi.p2pConnect(config); + } + } + }); + } + wifi.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); + + var recvP2pPersistentGroupChangeFunc = result => { + console.info("p2p persistent group change receive event"); + + wifi.getCurrentGroup((err, data) => { + if (err) { + console.error('failed to get current group: ' + JSON.stringify(err)); + return; + } + console.info("get current group: " + JSON.stringify(data)); + }); + } + wifi.on("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc); + + setTimeout(function() {wifi.off("p2pConnectionChange", recvP2pConnectionChangeFunc);}, 125 * 1000); + setTimeout(function() {wifi.off("p2pDeviceChange", recvP2pDeviceChangeFunc);}, 125 * 1000); + setTimeout(function() {wifi.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);}, 125 * 1000); + setTimeout(function() {wifi.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);}, 125 * 1000); + console.info("start discover devices -> " + wifi.startDiscoverDevices()); + ``` + +## wifi.p2pCancelConnect8+ + +p2pCancelConnect(): boolean; + +Cancels this P2P connection. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Return value + | Type| Description| + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + + +## wifi.startDiscoverDevices8+ + +startDiscoverDevices(): boolean; + +Starts to discover devices. + +- Required permissions: + ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Return value + | Type| Description| + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + + +## wifi.stopDiscoverDevices8+ + +stopDiscoverDevices(): boolean; + +Stops discovering devices. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Return value + | Type| Description| + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + + +## wifi.on('wifiStateChange')7+ + +on(type: "wifiStateChange", callback: Callback<number>): void Registers the WLAN state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is wifiStateChange.

-

callback

-

Callback<number>

-

Yes

-

Callback invoked to return the WLAN state.

-
- - -- Enumerates the WLAN states. - - - - - - - - - - - - - - - - - - - -

Value

-

Description

-

0

-

Deactivated.

-

1

-

Activated.

-

2

-

Activating.

-

3

-

Deactivating.

-
- - -## wifi.off\('wifiStateChange'\)7+ - -off\(type: "wifiStateChange", callback?: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **wifiStateChange**.| + | callback | Callback<number> | Yes| Callback invoked to return the WLAN state.| + +- Enumerates the WLAN states. + | **Value**| **Description**| + | -------- | -------- | + | 0 | Deactivated| + | 1 | Activated| + | 2 | Activating| + | 3 | Deactivating| + + +## wifi.off('wifiStateChange')7+ + +off(type: "wifiStateChange", callback?: Callback<number>): void Unregisters the WLAN state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is wifiStateChange.

-

callback

-

Callback<number>

-

No

-

Callback used to report the WLAN state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.

-
- - -- Example - - ``` - import wifi from '@ohos.wifi'; - import { EventListener } from '@ohos.wifi'; - - var WIFI_POWER_STATE = "wifiStateChange"; - var listener = new EventListener(); - - var recvPowerNotifyFunc = result => { - console.info("power state receive event: " + result); - } - - // Register event - listener.on(WIFI_POWER_STATE, recvPowerNotifyFunc); - - // Unregister event - listener.off(WIFI_POWER_STATE, recvPowerNotifyFunc); - ``` - - -## wifi.on\('wifiConnectionChange'\)7+ - -on\(type: "wifiConnectionChange", callback: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **wifiStateChange**.| + | callback | Callback<number> | 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 + ```js + import wifi from '@ohos.wifi'; + + var WIFI_POWER_STATE = "wifiStateChange"; + var recvPowerNotifyFunc = result => { + console.info("Receive power state change event: " + result); + } + + // Register event + wifi.on(WIFI_POWER_STATE, recvPowerNotifyFunc); + + // Unregister event + wifi.off(WIFI_POWER_STATE, recvPowerNotifyFunc); + ``` + + +## wifi.on('wifiConnectionChange')7+ + +on(type: "wifiConnectionChange", callback: Callback<number>): void Registers the WLAN connection state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is wifiConnectionChange.

-

callback

-

Callback<number>

-

Yes

-

Callback invoked to return the WLAN connection state.

-
- - -- Enumerates the WLAN connection states. - - - - - - - - - - - - - -

Value

-

Description

-

0

-

Disconnected.

-

1

-

Connected.

-
- - -## wifi.off\('wifiConnectionChange'\)7+ - -off\(type: "wifiConnectionChange", callback?: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **wifiConnectionChange**.| + | callback | Callback<number> | Yes| Callback invoked to return the WLAN connection state.| + +- Enumerates the WLAN connection states. + | **Value**| **Description**| + | -------- | -------- | + | 0 | Disconnected| + | 1 | Connected| + + +## wifi.off('wifiConnectionChange')7+ + +off(type: "wifiConnectionChange", callback?: Callback<number>): void Unregisters the WLAN connection state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is wifiConnectionChange.

-

callback

-

Callback<number>

-

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.

-
- - -## wifi.on\('wifiScanStateChange'\)7+ - -on\(type: "wifiScanStateChange", callback: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **wifiConnectionChange**.| + | callback | Callback<number> | 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.| + + +## wifi.on('wifiScanStateChange')7+ + +on(type: "wifiScanStateChange", callback: Callback<number>): void Registers the WLAN scan state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is wifiScanStateChange.

-

callback

-

Callback<number>

-

Yes

-

Callback invoked to return the WLAN scan state.

-
- - -- Enumerates the WLAN scan states. - - - - - - - - - - - - - -

Value

-

Description

-

0

-

The scan failed.

-

1

-

The scan is successful.

-
- - -## wifi.off\('wifiScanStateChange'\)7+ - -off\(type: "wifiScanStateChange", callback?: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **wifiScanStateChange**.| + | callback | Callback<number> | Yes| Callback invoked to return the WLAN scan state.| + +- Enumerates the WLAN scan states. + | **Value**| **Description**| + | -------- | -------- | + | 0 | Scan failed| + | 1 | Scan successful| + + +## wifi.off('wifiScanStateChange')7+ + +off(type: "wifiScanStateChange", callback?: Callback<number>): void Unregisters the WLAN scan state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is wifiScanStateChange.

-

callback

-

Callback<number>

-

No

-

Callback used to report the WLAN scan state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.

-
- -## wifi.on\('wifiRssiChange'\)7+ - -on\(type: "wifiRssiChange", callback: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **wifiScanStateChange**.| +| callback | Callback<number> | No| Callback used to return the WLAN scan state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + + +## wifi.on('wifiRssiChange')7+ + +on(type: "wifiRssiChange", callback: Callback<number>): void Registers the RSSI state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is wifiRssiChange.

-

callback

-

Callback<number>

-

Yes

-

Callback invoked to return the RSSI, in dBm.

-
- - -## wifi.off\('wifiRssiChange'\)7+ - -off\(type: "wifiRssiChange", callback?: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **wifiRssiChange**.| + | callback | Callback<number> | Yes| Callback invoked to return the RSSI, in dBm.| + + +## wifi.off('wifiRssiChange')7+ + +off(type: "wifiRssiChange", callback?: Callback<number>): void Unregisters the RSSI state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is wifiRssiChange.

-

callback

-

Callback<number>

-

No

-

Callback used to report the RSSI. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.

-
- - -## wifi.on\('hotspotStateChange'\)7+ - -on\(type: "hotspotStateChange", callback: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.STA + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **wifiRssiChange**.| + | callback | Callback<number> | 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.| + + +## wifi.on('hotspotStateChange')7+ + +on(type: "hotspotStateChange", callback: Callback<number>): void Registers the hotspot state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is hotspotStateChange.

-

callback

-

Callback<number>

-

Yes

-

Callback invoked to return the hotspot state.

-
- - -- Enumerates the hotspot states. - - - - - - - - - - - - - - - - - - - -

Value

-

Description

-

0

-

Deactivated.

-

1

-

Activated.

-

2

-

Activating.

-

3

-

Deactivating.

-
- - -## wifi.off\('hotspotStateChange'\)7+ - -off\(type: "hotspotStateChange", callback?: Callback\): void +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.AP + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **hotspotStateChange**.| + | callback | Callback<number> | Yes| Callback invoked to return the hotspot state.| + +- Enumerates the hotspot states. + | **Value**| **Description**| + | -------- | -------- | + | 0 | Deactivated| + | 1 | Activated| + | 2 | Activating| + | 3 | Deactivating| + + +## wifi.off('hotspotStateChange')7+ + +off(type: "hotspotStateChange", callback?: Callback<number>): void Unregisters the hotspot state change events. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

Event type. The value is hotspotStateChange.

-

callback

-

Callback<number>

-

No

-

Callback used to report the hotspot state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.

-
+- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.AP + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **hotspotStateChange**.| + | callback | Callback<number> | No| Callback used to return the hotspot state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + + +## wifi.on('p2pStateChange')8+ + +on(type: "p2pStateChange", callback: Callback<number>): void + +Registers the P2P status change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pStateChange**.| + | callback | Callback<number> | Yes| Callback invoked to return the P2P state.| + +- Enumerates the P2P states. + | **Value**| **Description**| + | -------- | -------- | + | 1 | Available| + | 2 | Opening| + | 3 | Opened| + | 4 | Closing| + | 5 | Closed| + +## wifi.off('p2pStateChange')8+ + +off(type: "p2pStateChange", callback?: Callback<number>): void + +Unregisters the P2P state change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pStateChange**.| + | callback | Callback<number> | No| Callback used to return the P2P state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + + + ## wifi.on('p2pConnectionChange')8+ + +on(type: "p2pConnectionChange", callback: Callback<WifiP2pLinkedInfo>): void + +Registers the P2P connection state change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pConnectionChange**.| + | callback | Callback<[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)> | Yes| Callback invoked to return the P2P connection state.| + + +## wifi.off('p2pConnectionChange')8+ + +off(type: "p2pConnectionChange", callback?: Callback<WifiP2pLinkedInfo>): void + +Unregisters the P2P connection state change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pConnectionChange**.| + | callback | Callback<[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)> | No| Callback used to return the P2P connection state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + + +## wifi.on('p2pDeviceChange')8+ + +on(type: "p2pDeviceChange", callback: Callback<WifiP2pDevice>): void + +Registers the P2P device state change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pDeviceChange**.| + | callback | Callback<[WifiP2pDevice](#WifiP2pDevice)> | Yes| Callback invoked to return the P2P device state.| + + +## wifi.off('p2pDeviceChange')8+ + +off(type: "p2pDeviceChange", callback?: Callback<WifiP2pDevice>): void + +Unregisters the P2P device state change events. + +- Required permissions: + ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pDeviceChange**.| + | callback | Callback<[WifiP2pDevice](#WifiP2pDevice)> | 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.| + + +## wifi.on('p2pPeerDeviceChange')8+ + +on(type: "p2pPeerDeviceChange", callback: Callback<WifiP2pDevice[]>): void + +Registers the P2P peer device state change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.| + | callback | Callback<[WifiP2pDevice[]](#WifiP2pDevice)> | Yes| Callback invoked to return the P2P peer device state.| + + +## wifi.off('p2pPeerDeviceChange')8+ + +off(type: "p2pPeerDeviceChange", callback?: Callback<WifiP2pDevice[]>): void + +Unregisters the P2P peer device state change events. + +- Required permissions: + ohos.permission.LOCATION + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.| + | callback | Callback<[WifiP2pDevice[]](#WifiP2pDevice)> | No| Callback used to return the peer device state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + + +## wifi.on('p2pPersistentGroupChange')8+ + +on(type: "p2pPersistentGroupChange", callback: Callback<void>): void + +Registers the P2P persistent group state change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.| + | callback | Callback<void> | Yes| Callback invoked to return the P2P persistent group state.| + + +## wifi.off('p2pPersistentGroupChange')8+ + +off(type: "p2pPersistentGroupChange", callback?: Callback<void>): void + +Unregisters the P2P persistent group state change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.| + | callback | Callback<void> | No| Callback used to return the P2P persistent group state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + + +## wifi.on('p2pDiscoveryChange')8+ + +on(type: "p2pDiscoveryChange", callback: Callback<number>): void + +Registers the P2P discovered device state change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.P2P + +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pDiscoveryChange**.| + | callback | Callback<number> | Yes| Callback invoked to return the state of the P2P discovered device.| + +- Enumerates the states of P2P discovered devices. + | **Value**| **Description**| + | -------- | -------- | + | 0 | Initial state| + | 1 | Discovered| + + +## wifi.off('p2pDiscoveryChange')8+ + +off(type: "p2pDiscoveryChange", callback?: Callback<number>): void + +Unregisters the P2P discovered device state change events. + +- Required permissions: + ohos.permission.GET_WIFI_INFO +- System capability: + SystemCapability.Communication.WiFi.P2P +- Parameters + | **Name**| **Type**| **Mandatory**| **Description**| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is **p2pDiscoveryChange**.| + | callback | Callback<number> | 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.| diff --git a/en/application-dev/reference/apis/js-apis-wifiext.md b/en/application-dev/reference/apis/js-apis-wifiext.md new file mode 100644 index 0000000000000000000000000000000000000000..23582ce56fc72b52165a1b5f15e28733314a798e --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-wifiext.md @@ -0,0 +1,153 @@ +# WLAN + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> 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. + + +## Modules to Import + +```js +import wifiext from '@ohos.wifiext'; +``` + +## wifiext.enableHotspot + +enableHotspot(): boolean; + +Enables the WLAN hotspot. + +- Required permissions: + ohos.permission.MANAGE_WIFI_HOTSPOT_EXT + +- System capability: + SystemCapability.Communication.WiFi.HotspotExt + +- Return value + | **Type**| **Description**| + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + + +## wifiext.disableHotspot + +disableHotspot(): boolean; + +Disables the WLAN hotspot. + +- Required permissions: + ohos.permission.MANAGE_WIFI_HOTSPOT_EXT + +- System capability: + SystemCapability.Communication.WiFi.HotspotExt + +- Return value + | **Type**| **Description**| + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + + +## wifiext.getSupportedPowerModel + +getSupportedPowerModel(): Promise<Array<PowerModel>> + +Obtains the supported power models. The method uses a promise to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.HotspotExt + +- Return value + | Type| Description| + | -------- | -------- | + | Promise<Array<[PowerModel](#PowerModel)>> | Promise used to return the power models obtained.| + + +## PowerModel + +Enumerates of the power models. + +| Name| Default Value| Description| +| -------- | -------- | -------- | +| SLEEPING | 0 | Sleeping| +| GENERAL | 1 | General| +| THROUGH_WALL | 2 | Through_wall| + + +## wifiext.getSupportedPowerModel + +getSupportedPowerModel(callback: AsyncCallback<Array<PowerModel>>): void + +Obtains the supported power models. The method uses an asynchronous callback to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.HotspotExt + +- Parameters + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[PowerModel](#PowerModel)> | Yes| Callback used to return the power models obtained.| + + +## wifiext.getPowerModel + +getPowerModel(): Promise<PowerModel> + +Obtains the power model. The method uses a promise to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.HotspotExt + +- Return value + | Type| Description| + | -------- | -------- | + | Promise<[PowerModel](#PowerModel)> | Promise used to return the power model obtained.| + + +## wifiext.getPowerModel + +getPowerModel(callback: AsyncCallback<PowerModel>): void + +Obtains the power model. The method uses an asynchronous callback to return the result. + +- Required permissions: + ohos.permission.GET_WIFI_INFO + +- System capability: + SystemCapability.Communication.WiFi.HotspotExt + +- Parameters + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[PowerModel](#PowerModel)> | Yes| Callback invoked to return the power mode obtained.| + + +## wifiext.setPowerModel + +setPowerModel(model: PowerModel) : boolean; + + Sets the power model. + +- Required permissions: + ohos.permission.MANAGE_WIFI_HOTSPOT_EXT + +- System capability: + SystemCapability.Communication.WiFi.HotspotExt + +- Parameters + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | model | AsyncCallback<[PowerModel](#PowerModel)> | Yes| Power model to set.| + +- Return value + | **Type**| **Description**| + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise.|