openharmony 鸿蒙 js-apis-wifiManager-sys

2025-06-12 浏览 (1)

@ohos.wifiManager (WLAN) (System API)

The WLAN module provides basic wireless local area network (WLAN) functions, peer-to-peer (P2P) functions, and WLAN message notification services. It allows applications to communicate with devices over 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. This topic describes only the system APIs provided by the module. For details about its public APIs, see @ohos.wifiManager (WLAN).

Modules to Import

import { wifiManager } from '@kit.ConnectivityKit';

wifiManager.disableWifi9+

disableWifi(): void

Disables WLAN. This is an asynchronous API. You need to register a callback for the wifiStateChange event to check whether WLAN is successfully disabled.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.
2501004Operation failed because the service is being opened.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.disableWifi();
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.enableSemiWifi12+

enableSemiWifi(): void

Enables WLAN partially, that is, enables P2P and Huawei Magneto Link (HML) while disabling STA. You need to register a callback for the wifiStateChange event to return the operation result.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.
2501004Operation failed because the service is being opened.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.enableSemiWifi();
	} catch(error) {
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.startScan10+

startScan(): void

System API: This is a system API.

Starts a scan for WLAN.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION

System capability: SystemCapability.Communication.WiFi.STA

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.startScan();
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.setScanAlwaysAllowed10+

setScanAlwaysAllowed(isScanAlwaysAllowed: boolean): void

Sets whether scan is always allowed.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG

System capability: SystemCapability.Communication.WiFi.STA

Parameters

NameTypeMandatoryDescription
isScanAlwaysAllowedbooleanYesWhether scan is always allowed.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.
2501000Operation failed.
	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let isScanAlwaysAllowed = true;
		wifiManager.setScanAlwaysAllowed(isScanAlwaysAllowed);
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.getScanAlwaysAllowed10+

getScanAlwaysAllowed(): boolean

Obtains whether scan is always allowed.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG

System capability: SystemCapability.Communication.WiFi.STA

Return value

TypeDescription
booleanWhether scan is always allowed. The value true means scan is allowed, and the value false means the opposite.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let isScanAlwaysAllowed = wifiManager.getScanAlwaysAllowed();
		console.info("isScanAlwaysAllowed:" + isScanAlwaysAllowed);
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

WifiDeviceConfig9+

Represents the WLAN configuration.

System capability: SystemCapability.Communication.WiFi.STA

NameTypeReadableWritableDescription
creatorUidnumberYesNoID of the creator.
System API: This is a system API.
disableReasonnumberYesNoReason for disabling Wi-Fi.
-1: unknown reason
0: not disabled
1: association refused
2: authentication failed
3: DHCP failure
4: no Internet connection
5: no authentication credentials
6: no Internet connection permanently
7: disabled by Wi-Fi manager
8: disabled due to incorrect password
9: authentication without subscription
10: private EAP authentication error
11: network not found
12: consecutive failures
13: disabled by the system
14: EAP-AKA authentication failed
15: association removed
16: maximum number of forbidden network selections
System API: This is a system API.
netIdnumberYesNoNetwork ID.
System API: This is a system API.
randomMacTypenumberYesNoMAC address type.
The value 0 indicates a random MAC address, and the value 1 indicates a device MAC address.
System API: This is a system API.
randomMacAddrstringYesNoMAC address.
System API: This is a system API.
ipTypeIpTypeYesNoIP address type.
System API: This is a system API.
staticIpIpConfigYesNoStatic IP address information.
System API: This is a system API.
proxyConfig10+WifiProxyConfigYesNoProxy configuration.
System API: This is a system API.
configStatus12+numberYesNoStatus indicating whether the current network can be selected.
1: network selection allowed
2: network selection forbidden
3: network selection permanently forbidden
4: unknown
System API: This is a system API.

IpType9+

Enumerates the IP address types.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

NameValueDescription
STATIC0Static IP address.
DHCP1IP address allocated by DHCP.
UNKNOWN2Not specified.

IpConfig9+

Represents IP configuration information.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

NameTypeReadableWritableDescription
ipAddressnumberYesNoIP address.
gatewaynumberYesNoGateway.
prefixLengthnumberYesNoSubnet mask.
dnsServersnumber[]YesNoDomain name server (DNS) information.
domainsArray<string>YesNoDomain information.

WifiProxyConfig10+

Represents the Wi-Fi proxy configuration.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

NameTypeReadableWritableDescription
proxyMethodProxyMethodYesNoProxy method.
pacWebAddressstringYesNoPAC web address of the proxy automatically configured.
serverHostNamestringYesNoServer host name of the proxy manually configured.
serverPortnumberYesNoServer port of the proxy manually configured.
exclusionObjectsstringYesNoExcluded objects of the manually configured proxy. Multiple objects are separated by commas (,).

ProxyMethod10+

Enumerates the Wi-Fi proxy methods.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

NameValueDescription
METHOD_NONE0No proxy.
METHOD_AUTO1Use an automatically configured proxy.
METHOD_MANUAL2Use a manually configured proxy.

wifiManager.connectToDevice9+

connectToDevice(config: WifiDeviceConfig): void

Connects to the specified network. If the device is already connected to a hotspot, use disconnect() to disconnect it from the hotspot first.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO, ohos.permission.SET_WIFI_CONFIG, and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Parameters

NameTypeMandatoryDescription
configWifiDeviceConfigYesWLAN configuration to add. The default bssidType is random device address.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified.
2. Incorrect parameter types. 3. Parameter verification failed.
801Capability not supported.
2501000Operation failed.
2501001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let config:wifiManager.WifiDeviceConfig = {
			ssid : "****",
			preSharedKey : "****",
			securityType : 3
		}
		wifiManager.connectToDevice(config);
				
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

WifiLinkedInfo9+

Represents the WLAN connection information.

System capability: SystemCapability.Communication.WiFi.STA

NameTypeReadableWritableDescription
networkIdnumberYesNoNetwork configuration ID.
System API: This is a system API.
chloadnumberYesNoChannel load. A larger value indicates a higher load.
System API: This is a system API.
snrnumberYesNoSignal-to-noise ratio (SNR).
System API: This is a system API.
suppStateSuppStateYesNoSupplicant state.
System API: This is a system API.

SuppState9+

Enumerates the supplicant states.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

NameValueDescription
DISCONNECTED0The supplicant is disconnected from the AP.
INTERFACE_DISABLED1The network interface is disabled.
INACTIVE2The supplicant is inactive.
SCANNING3The supplicant is scanning for a WLAN connection.
AUTHENTICATING4The supplicant is being authenticated.
ASSOCIATING5The supplicant is being associated with an AP.
ASSOCIATED6The supplicant is associated with an AP.
FOUR_WAY_HANDSHAKE7A four-way handshake is being performed for the supplicant.
GROUP_HANDSHAKE8A group handshake is being performed for the supplicant.
COMPLETED9The authentication is complete.
UNINITIALIZED10The supplicant failed to set up the connection.
INVALID11Invalid value.

wifiManager.getSupportedFeatures9+

getSupportedFeatures(): number

Obtains the features supported by this device.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO

System capability: SystemCapability.Communication.WiFi.Core

Return value

TypeDescription
numberFeature value.

Feature IDs

ValueDescription
0x0001WLAN infrastructure mode
0x00025 GHz feature
0x0004Generic Advertisement Service (GAS)/Access Network Query Protocol (ANQP) feature
0x0008Wi-Fi Direct
0x0010SoftAP
0x0040Wi-Fi Aware
0x8000WLAN AP/STA concurrency
0x8000000WPA3 Personal (WPA-3 SAE)
0x10000000WPA3-Enterprise Suite B
0x20000000Enhanced open feature

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2401000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let ret = wifiManager.getSupportedFeatures();
		console.info("supportedFeatures:" + ret);
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.getDeviceMacAddress15+

getDeviceMacAddress(): string[]

Obtains the device MAC address.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_LOCAL_MAC and ohos.permission.GET_WIFI_INFO (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Return value

TypeDescription
string[]MAC address obtained.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.
2501001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let ret = wifiManager.getDeviceMacAddress();
		console.info("deviceMacAddress:" + JSON.stringify(ret));
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.getWifiDetailState12+

getWifiDetailState(): WifiDetailState

Obtains the Wi-Fi state.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Return value

TypeDescription
WifiDetailStateWi-Fi state obtained.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let ret = wifiManager.getWifiDetailState();
		console.info("wifiDetailState:" + ret);
	} catch(error) {
		console.error("failed:" + JSON.stringify(error));
	}

WifiDetailState12+

Enumerates Wi-Fi states.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

NameValueDescription
UNKNOWN-1Unidentified.
INACTIVE0Inactive.
ACTIVATED1Activated.
ACTIVATING2Activating.
DEACTIVATING3Deactivating
SEMI_ACTIVATING4Partially activating.
SEMI_ACTIVE5partially activated.

wifiManager.reassociate9+

reassociate(): void

Re-associates with the network.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.
2501001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.reassociate();
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.reconnect9+

reconnect(): void

Reconnects to the network.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.
2501001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.reconnect();
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.updateNetwork9+

updateNetwork(config: WifiDeviceConfig): number

Updates network configuration.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG

System capability: SystemCapability.Communication.WiFi.STA

Parameters

NameTypeMandatoryDescription
configWifiDeviceConfigYesNew WLAN configuration.

Return value

TypeDescription
numberID of the updated network configuration. The value -1 indicates that the operation has failed.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified.
2. Incorrect parameter types. 3. Parameter verification failed.
801Capability not supported.
2501000Operation failed.
2501001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let config:wifiManager.WifiDeviceConfig = {
			ssid : "****",
			preSharedKey : "****",
			securityType : 3
		}
		let ret = wifiManager.updateNetwork(config);
		console.info("ret:" + ret);
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.disableNetwork9+

disableNetwork(netId: number): void

Disables network configuration.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Parameters

NameTypeMandatoryDescription
netIdnumberYesID of the network configuration to disable.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified.
2. Incorrect parameter types. 3. Parameter verification failed.
801Capability not supported.
2501000Operation failed.
2501001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let netId = 0;
		wifiManager.disableNetwork(netId);		
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.removeAllNetwork9+

removeAllNetwork(): void

Removes the configuration of all networks.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.
2501001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.removeAllNetwork();		
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.get5GChannelList10+

get5GChannelList(): Array<number>

Obtains the list of 5 GHz channels supported by this device.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG

System capability: SystemCapability.Communication.WiFi.STA

Return value

TypeDescription
 Array<number>List of 5 GHz channels supported by the device.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let channelList = wifiManager.get5GChannelList();
		console.info("channelList:" + JSON.stringify(channelList));		
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.getDisconnectedReason10+

getDisconnectedReason(): DisconnectedReason

Obtains the reason of the latest disconnection.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG

System capability: SystemCapability.Communication.WiFi.STA

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
801Capability not supported.
2501000Operation failed.

Return value

TypeDescription
DisconnectedReasonReturns the reason of the latest disconnection obtained.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let disconnectedReason = wifiManager.getDisconnectedReason();	
        console.info("disconnectedReason:" + disconnectedReason);
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

DisconnectedReason 10+

Enumerates the Wi-Fi disconnection reasons.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

NameValueDescription
DISC_REASON_DEFAULT0Default reason.
DISC_REASON_WRONG_PWD1Incorrect password.
DISC_REASON_CONNECTION_FULL2The number of connections to the router has reached the limit.

wifiManager.startPortalCertification11+

startPortalCertification(): void

System API: This is a system API.

Starts portal certification.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION

System capability: SystemCapability.Communication.WiFi.STA

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.
2501001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.startPortalCertification();
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.enableHiLinkHandshake12+

enableHiLinkHandshake(isHiLinkEnable: boolean, bssid: string, config: WifiDeviceConfig): void

System API: This is a system API.

Enables or disables HiLink.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION

System capability: SystemCapability.Communication.WiFi.STA

Parameters

NameTypeMandatoryDescription
isHiLinkEnablebooleanYesWhether to enable hiLink. The value true means to enable HiLink, and the value false means the opposite.
bssidstringYesMAC address of the hotspot, for example, 00:11:22:33:44:55.
configWifiDeviceConfigYesWLAN configuration information. The value of config.bssid must be the same as that of the second parameter bssid. The default bssidType is random device address.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified.
2. Incorrect parameter types. 3. Parameter verification failed.
801Capability not supported.
2501000Operation failed.
2501001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';
	// You can obtain config data by using getScanInfoList, which can be used only when WifiScanInfo.isHiLinkNetwork is true.
	let config:wifiManager.WifiDeviceConfig = {
		ssid : "****",
		preSharedKey : "****",
		securityType : 0,
		bssid : "38:37:8b:80:bf:cc",
		bssidType : 1,
		isHiddenSsid : false
	}	
	try {
		wifiManager.enableHiLinkHandshake(true, config.bssid, config);
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.factoryReset11+

factoryReset(): void

System API: This is a system API.

Resets Wi-Fi configurations.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG

System capability: SystemCapability.Communication.WiFi.STA

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2501000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.factoryReset();
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.enableHotspot9+

enableHotspot(): void

Enables this hotspot. This API is an asynchronous interface. The hotspotStateChange callback must be registered and listened for.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications)

System capability: SystemCapability.Communication.WiFi.AP.Core

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.enableHotspot();	
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.disableHotspot9+

disableHotspot(): void

Disables this hotspot. This API is an asynchronous interface. The hotspotStateChange callback must be registered and listened for.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications)

System capability: SystemCapability.Communication.WiFi.AP.Core

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		wifiManager.disableHotspot();	
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.isHotspotDualBandSupported9+

isHotspotDualBandSupported(): boolean

Checks whether the hotspot supports dual band.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO and ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications)

System capability: SystemCapability.Communication.WiFi.AP.Core

Return value

TypeDescription
booleanWhether the hotspot supports dual band. The value true indicates dual band is supported, and the value false indicates the opposite.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let ret = wifiManager.isHotspotDualBandSupported();
		console.info("result:" + ret);		
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.isOpenSoftApAllowed18+

isOpenSoftApAllowed(): boolean

Checks whether the hotspot supports dual band.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO and ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications)

System capability: SystemCapability.Communication.WiFi.AP.Core

Return value

TypeDescription
booleanWhether the hotspot supports dual band. The value true indicates dual band is supported, and the value false indicates the opposite.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let ret = wifiManager.isOpenSoftApAllowed();
		console.info("result:" + ret);
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.setHotspotConfig9+

setHotspotConfig(config: HotspotConfig): void

Sets hotspot configuration.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG

System capability: SystemCapability.Communication.WiFi.AP.Core

Parameters

NameTypeMandatoryDescription
configHotspotConfigYesHotspot configuration to set.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Incorrect parameter types.
2. Parameter verification failed.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let config:wifiManager.HotspotConfig = {
			ssid: "****",
			securityType: 3,
			band: 0,
			channel: 0,
			preSharedKey: "****",
			maxConn: 0
		}
		let ret = wifiManager.setHotspotConfig(config);
		console.info("result:" + ret);		
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

HotspotConfig9+

Represents the hotspot configuration.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.AP.Core

NameTypeReadableWritableDescription
ssidstringYesYesSSID of the hotspot, in UTF-8 format.
securityTypeWifiSecurityTypeYesYesSecurity type.
bandnumberYesYesHotspot band. The value 1 stands for 2.4 GHz, the value 2 for 5 GHz, and the value 3 for dual band.
channel10+numberYesYesHotspot channel (channels 1 to 14 for 2.4 GHz, and channels 7 to 196 for 5 GHz)
preSharedKeystringYesYesPSK of the hotspot.
maxConnnumberYesYesMaximum number of connections allowed.

wifiManager.getHotspotConfig9+

getHotspotConfig(): HotspotConfig

Obtains hotspot configuration.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG

System capability: SystemCapability.Communication.WiFi.AP.Core

Return value

TypeDescription
HotspotConfigHotspot configuration obtained.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let config = wifiManager.getHotspotConfig();
		console.info("result:" + JSON.stringify(config));		
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.getStations9+

getStations():  Array<StationInfo>

Obtains information about the connected stations.

System API: This is a system API.

Required permissions:

API version 9: ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION, ohos.permission.APPROXIMATELY_LOCATION, and ohos.permission.MANAGE_WIFI_HOTSPOT (for system applications only)

API version 10 and later: ohos.permission.GET_WIFI_INFO and ohos.permission.MANAGE_WIFI_HOTSPOT (for system applications only)

System capability: SystemCapability.Communication.WiFi.AP.Core

Return value

TypeDescription
 Array<StationInfo>Connected stations obtained. If the application has the ohos.permission.GET_WIFI_PEERS_MAC permission, macAddress in the return value is a real MAC address; otherwise, macAddress is a random MAC address.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let stations = wifiManager.getStations();
		console.info("result:" + JSON.stringify(stations));		
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

StationInfo9+

Represents the station information.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.AP.Core

NameTypeReadableWritableDescription
namestringYesNoDevice name.
macAddressstringYesNoMAC address.
macAddressType10+DeviceAddressTypeYesNoMAC address type.
ipAddressstringYesNoIP address.

wifiManager.addHotspotBlockList11+

addHotspotBlockList(stationInfo: StationInfo)

Adds a device to the list of blocked devices of the hotspot. Devices in the list cannot access the hotspot.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications)

System capability: SystemCapability.Communication.WiFi.AP.Core

Parameters

NameTypeMandatoryDescription
stationInfoStationInfoYesDevice to add.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Incorrect parameter types.
2. Parameter verification failed.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let config:wifiManager.StationInfo = {
			name : "testSsid",
			macAddress : "11:22:33:44:55:66",
			ipAddress : "192.168.1.111"
		}
		// The device can be added to the block list only after the hotspot is enabled.
		wifiManager.addHotspotBlockList(config);
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.delHotspotBlockList11+

delHotspotBlockList(stationInfo: StationInfo)

Deletes a device from the list of blocked devices of the hotspot.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications)

System capability: SystemCapability.Communication.WiFi.AP.Core

Parameters

NameTypeMandatoryDescription
stationInfoStationInfoYesDevice to delete.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Incorrect parameter types.
2. Parameter verification failed.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let config:wifiManager.StationInfo = {
			name : "testSsid",
			macAddress : "11:22:33:44:55:66",
			ipAddress : "192.168.1.111"
		}
		wifiManager.delHotspotBlockList(config);
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.getHotspotBlockList11+

getHotspotBlockList(): Array<StationInfo>

Obtains the list of blocked devices of the hotspot.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO and ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications)

System capability: SystemCapability.Communication.WiFi.AP.Core

Return value

TypeDescription
 Array<StationInfo>List of blocked devices obtained.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified.
801Capability not supported.
2601000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let data = wifiManager.getHotspotBlockList();
		console.info("result:" + JSON.stringify(data));
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.deletePersistentGroup9+

deletePersistentGroup(netId: number): void

Deletes a persistent group.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION

System capability: SystemCapability.Communication.WiFi.P2P

Parameters

NameTypeMandatoryDescription
netIdnumberYesID of the group to delete.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1.Incorrect parameter types.
801Capability not supported.
2801000Operation failed.
2801001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let netId = 0;
		wifiManager.deletePersistentGroup(netId);	
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.getP2pGroups9+

getP2pGroups(): Promise<Array<WifiP2pGroupInfo>>

Obtains information about all P2P groups. This API uses a promise to return the result.

System API: This is a system API.

Required permissions:

API version 9: ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION, and ohos.permission.APPROXIMATELY_LOCATION

API version 10 and later : ohos.permission.GET_WIFI_INFO

System capability: SystemCapability.Communication.WiFi.P2P

Return value

TypeDescription
Promise< Array<WifiP2pGroupInfo> >Promise used to return the group information obtained. If the application has the ohos.permission.GET_WIFI_PEERS_MAC permission, deviceAddress in the return value is a real device address; otherwise, deviceAddress is a random device address.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2801000Operation failed.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	wifiManager.getP2pGroups((err, data:wifiManager.WifiP2pGroupInfo) => {
    if (err) {
        console.error("get P2P groups error");
        return;
    }
		console.info("get P2P groups: " + JSON.stringify(data));
	});

	wifiManager.getP2pGroups().then(data => {
		console.info("get P2P groups: " + JSON.stringify(data));
	});
	

wifiManager.getP2pGroups9+

getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): void

Obtains information about all P2P groups. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions:

API version 9: ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION, and ohos.permission.APPROXIMATELY_LOCATION

API version 10 and later : ohos.permission.GET_WIFI_INFO

System capability: SystemCapability.Communication.WiFi.P2P

Parameters

NameTypeMandatoryDescription
callbackAsyncCallback< Array<WifiP2pGroupInfo>>YesCallback used to return the result. If the operation is successful, error is 0 and data is the group information obtained. If the operation fails, error is not 0. If the application has the ohos.permission.GET_WIFI_PEERS_MAC permission, deviceAddress in the return value is a real device address; otherwise, deviceAddress is a random device address.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
801Capability not supported.
2801000Operation failed.
2801001Wi-Fi STA disabled.

wifiManager.setDeviceName9+

setDeviceName(devName: string): void

Sets the device name.

System API: This is a system API.

Required permissions: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.P2P

Parameters

NameTypeMandatoryDescription
devNamestringYesDevice name to set.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified.
2. Incorrect parameter types. 3. Parameter verification failed.
801Capability not supported.
2801000Operation failed.
2801001Wi-Fi STA disabled.

Example

	import { wifiManager } from '@kit.ConnectivityKit';

	try {
		let name = "****";
		wifiManager.setDeviceName(name);	
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.on('streamChange')9+

on(type: 'streamChange', callback: Callback<number>): void

Subscribes to Wi-Fi stream changes. When the service exits, call off(type: 'streamChange', callback?: Callback<number>) to unregister the callback registered.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_WIFI_CONNECTION

System capability: SystemCapability.Communication.WiFi.STA

Parameters

NameTypeMandatoryDescription
typestringYesEvent type, which has a fixed value of streamChange.
callbackCallback<number>YesCallback used to return the Wi-Fi stream change, which can be any of the following values:
- 0: No stream.
- 1: Downward.
- 2: Upward.
- 3: Bidirectional.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.
2501000Operation failed.

wifiManager.off('streamChange')9+

off(type: 'streamChange', callback?: Callback<number>): void

Unsubscribes from Wi-Fi stream changes.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_WIFI_CONNECTION

System capability: SystemCapability.Communication.WiFi.STA

Parameters

NameTypeMandatoryDescription
typestringYesEvent type, which has a fixed value of streamChange.
callbackCallback<number>NoCallback to unregister. The stream change can be any of the following values:
- 0: No stream.
- 1: Downward.
- 2: Upward.
- 3: Bidirectional.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.
2501000Operation failed.

Example

import { wifi } from '@kit.ConnectivityKit';

let recvStreamChangeFunc = (result:number) => {
    console.info("Receive stream change event: " + result);
}

// Register an event.
wifi.on("streamChange", recvStreamChangeFunc);

// Unregister an event.
wifi.off("streamChange", recvStreamChangeFunc);

wifiManager.on('deviceConfigChange')9+

on(type: 'deviceConfigChange', callback: Callback<number>): void

Subscribes to Wi-Fi device configuration changes. When the service exits, call off(type: 'deviceConfigChange', callback?: Callback<number>) to unregister the callback registered.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO

System capability: SystemCapability.Communication.WiFi.STA

Parameters

NameTypeMandatoryDescription
typestringYesEvent type, which has a fixed value of deviceConfigChange.
callbackCallback<number>YesCallback for device configuration changes.
0: Configuration is added. 1: Configuration is modified. 2: Configuration is deleted.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.
2501000Operation failed.

wifiManager.off('deviceConfigChange')9+

off(type: 'deviceConfigChange', callback?: Callback<number>): void

Unsubscribes from Wi-Fi device configuration changes.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO

System capability: SystemCapability.Communication.WiFi.STA

Parameters

NameTypeMandatoryDescription
typestringYesEvent type, which has a fixed value of deviceConfigChange.
callbackCallback<number>NoCallback for device configuration changes.
0: Configuration is added. 1: Configuration is modified. 2: Configuration is deleted.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.
2501000Operation failed.

Example

import { wifiManager } from '@kit.ConnectivityKit';

let recvDeviceConfigChangeFunc = (result:number) => {
    console.info("Receive device config change event: " + result);
}

// Register an event.
wifi.on("deviceConfigChange", recvDeviceConfigChangeFunc);

// Unregister an event.
wifi.off("deviceConfigChange", recvDeviceConfigChangeFunc);

wifiManager.on('hotspotStaJoin')9+

on(type: 'hotspotStaJoin', callback: Callback<StationInfo>): void

Subscribes to the event of an STA joining a Wi-Fi hotspot. When the service exits, call off(type: 'hotspotStaJoin', callback?: Callback<StationInfo>) to unregister the callback registered.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT

System capability: SystemCapability.Communication.WiFi.AP.Core

Parameters

NameTypeMandatoryDescription
typestringYesEvent type, which has a fixed value of hotspotStaJoin.
callbackCallback<StationInfo>YesCallback used to return the event.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.
2601000Operation failed.

wifiManager.off('hotspotStaJoin')9+

off(type: 'hotspotStaJoin', callback?: Callback<StationInfo>): void

Unsubscribes from the event of an STA joining a Wi-Fi hotspot.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT

System capability: SystemCapability.Communication.WiFi.AP.Core

Parameters

NameTypeMandatoryDescription
typestringYesEvent type, which has a fixed value of hotspotStaJoin.
callbackCallback<StationInfo>NoCallback to unregister.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.
2601000Operation failed.

Example

import { wifiManager } from '@kit.ConnectivityKit';

let recvHotspotStaJoinFunc = (result:wifiManager.StationInfo) => {
    console.info("Receive hotspot sta join event: " + result);
}

// Register an event.
wifiManager.on("hotspotStaJoin", recvHotspotStaJoinFunc);

// Unregister an event.
wifiManager.off("hotspotStaJoin", recvHotspotStaJoinFunc);

wifiManager.on('hotspotStaLeave')9+

on(type: 'hotspotStaLeave', callback: Callback<StationInfo>): void

Subscribes to the event of an STA leaving a Wi-Fi hotspot. When the service exits, call off(type: 'hotspotStaLeave', callback?: Callback<StationInfo>) to unregister the callback registered.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT

System capability: SystemCapability.Communication.WiFi.AP.Core

Parameters

NameTypeMandatoryDescription
typestringYesEvent type, which has a fixed value of hotspotStaLeave.
callbackCallback<StationInf]>YesCallback used to return the event.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.
2601000Operation failed.

wifiManager.off('hotspotStaLeave')9+

off(type: 'hotspotStaLeave', callback?: Callback<StationInfo>): void

Unsubscribes from the event of an STA leaving a Wi-Fi hotspot.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT

System capability: SystemCapability.Communication.WiFi.AP.Core

Parameters

NameTypeMandatoryDescription
typestringYesEvent type, which has a fixed value of hotspotStaLeave.
callbackCallback<StationInf]>NoCallback to unregister.

Error codes

For details about the error codes, see Wi-Fi Error Codes.

IDError Message
201Permission denied.
202System API is not allowed called by Non-system application.
401Invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.
2601000Operation failed.

Example

import { wifiManager } from '@kit.ConnectivityKit';

let recvHotspotStaLeaveFunc = (result:wifiManager.StationInfo) => {
    console.info("Receive hotspot sta leave event: " + result);
}

// Register an event.
wifiManager.on("hotspotStaLeave", recvHotspotStaLeaveFunc);

// Unregister an event.
wifiManager.off("hotspotStaLeave", recvHotspotStaLeaveFunc);

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Connectivity Kit (Short-Range Communication Service)

harmony 鸿蒙Bluetooth

harmony 鸿蒙Wifi

harmony 鸿蒙Bluetooth Error Codes

harmony 鸿蒙NFC Error Codes

harmony 鸿蒙SecureElement Error Codes

harmony 鸿蒙Wi-Fi Error Codes

harmony 鸿蒙@ohos.bluetooth.a2dp (Bluetooth A2DP Module) (System API)

harmony 鸿蒙@ohos.bluetooth.a2dp (Bluetooth A2DP Module)

harmony 鸿蒙@ohos.bluetooth.access (Bluetooth Access Module) (System API)

  • 所属分类: 后端技术
  • 本文标签: 鸿蒙 软件
  • 版权声明: 本文链接 https://seaxiang.com/blog/hwi888