@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 '@ohos.wifiManager';

wifiManager.enableWifi⁹⁺

enableWifi(): void

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

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.

ID	Error Message
2501000	Operation failed.
2501003	Failed for wifi is closing.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.disableWifi⁹⁺

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.

ID	Error Message
2501000	Operation failed.
2501004	Failed for wifi is opening.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.startScan¹⁰⁺

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.

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.setScanAlwaysAllowed¹⁰⁺

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

Name	Type	Mandatory	Description
isScanAlwaysAllowed	boolean	Yes	Whether scan is always allowed.

Error codes

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

ID	Error Message
2501000	Operation failed.

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getScanAlwaysAllowed¹⁰⁺

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

Type	Description
boolean	Whether scan is always allowed. The value true means scan is allowed; the value false means the opposite.

Error codes

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

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.addDeviceConfig⁹⁺

addDeviceConfig(config: WifiDeviceConfig): Promise<number>

Adds network configuration. This API uses a promise to return the result.

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

Name	Type	Mandatory	Description
config	WifiDeviceConfig	Yes	WLAN configuration to add. The default bssidType is random device address.

Return value

Type	Description
Promise<number>	Promise used to return the ID of the added network configuration. If -1 is returned, the network configuration fails to be added.

Error codes

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

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

	try {
		let config:wifiManager.WifiDeviceConfig = {
			ssid : "****",
			preSharedKey : "****",
			securityType : 0
		}
		wifiManager.addDeviceConfig(config).then(result => {
			console.info("result:" + JSON.stringify(result));
		}).catch((err:number) => {
			console.error("failed:" + JSON.stringify(err));
		});
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

WifiDeviceConfig⁹⁺

Represents the WLAN configuration.

System capability: SystemCapability.Communication.WiFi.STA

Name	Type	Readable	Writable	Description
creatorUid	number	Yes	No	ID of the creator. System API: This is a system API.
disableReason	number	Yes	No	Reason for disabling WLAN. System API: This is a system API.
netId	number	Yes	No	Network ID. System API: This is a system API.
randomMacType	number	Yes	No	MAC address type. The value 0 indicates random MAC address, and 1 indicates device MAC address. System API: This is a system API.
randomMacAddr	string	Yes	No	MAC address. System API: This is a system API.
ipType	IpType	Yes	No	IP address type. System API: This is a system API.
staticIp	IpConfig	Yes	No	Static IP address information. System API: This is a system API.
proxyConfig¹⁰⁺	WifiProxyConfig	Yes	No	Proxy configuration. System API: This is a system API.

IpType⁹⁺

Enumerates the IP address types.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

Name	Value	Description
STATIC	0	Static IP address.
DHCP	1	IP address allocated by DHCP.
UNKNOWN	2	Not specified.

IpConfig⁹⁺

Represents IP configuration information.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

Name	Type	Readable	Writable	Description
ipAddress	number	Yes	No	IP address.
gateway	number	Yes	No	Gateway.
prefixLength	number	Yes	No	Subnet mask.
dnsServers	number[]	Yes	No	Domain name server (DNS) information.
domains	Array<string>	Yes	No	Domain information.

WifiProxyConfig¹⁰⁺

Represents the Wi-Fi proxy configuration.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

Name	Type	Readable	Writable	Description
proxyMethod	ProxyMethod	Yes	No	Proxy method.
pacWebAddress	string	Yes	No	PAC web address of the proxy automatically configured.
serverHostName	string	Yes	No	Server host name of the proxy manually configured.
serverPort	string	Yes	No	Server port of the proxy manually configured.
exclusionObjects	string	Yes	No	Excluded objects of the manually configured proxy. Multiple objects are separated by commas (,).

ProxyMethod¹⁰⁺

Enumerates the Wi-Fi proxy methods.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

Name	Value	Description
METHOD_NONE	0	No proxy.
METHOD_AUTO	1	Use an automatically configured proxy.
METHOD_MANUAL	2	Use a manually configured proxy.

wifiManager.addDeviceConfig⁹⁺

addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>): void

Adds network configuration. This API uses an asynchronous callback to return the result.

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

Name	Type	Mandatory	Description
config	WifiDeviceConfig	Yes	WLAN configuration to add. The default bssidType is random device address.
callback	AsyncCallback<number>	Yes	Callback invoked to return the result. If the operation is successful, err is 0 and data is the network configuration ID. If data is -1, the operation has failed. If the operation fails, error is not 0.

Error codes

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

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.connectToNetwork⁹⁺

connectToNetwork(networkId: number): 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.MANAGE_WIFI_CONNECTION (available only to system applications)

System capability: SystemCapability.Communication.WiFi.STA

Parameters

Name	Type	Mandatory	Description
networkId	number	Yes	Network configuration ID.

Error codes

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

ID	Error Message
2501000	Operation failed.
2501001	Wifi is closed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.connectToDevice⁹⁺

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

Name	Type	Mandatory	Description
config	WifiDeviceConfig	Yes	Configuration of the WLAN to connect. The default bssidType is random device address.

Error codes

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

ID	Error Message
2501000	Operation failed.
2501001	Wifi is closed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.disconnect⁹⁺

disconnect(): void

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

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

WifiLinkedInfo⁹⁺

Represents the WLAN connection information.

System capability: SystemCapability.Communication.WiFi.STA

Name	Type	Readable	Writable	Description
networkId	number	Yes	No	Network configuration ID. System API: This is a system API.
chload	number	Yes	No	Channel load. A larger value indicates a higher load. System API: This is a system API.
snr	number	Yes	No	Signal-to-noise ratio (SNR). System API: This is a system API.
suppState	SuppState	Yes	No	Supplicant state. System API: This is a system API.

SuppState⁹⁺

Enumerates the supplicant states.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

Name	Value	Description
DISCONNECTED	0	The supplicant is disconnected from the AP.
INTERFACE_DISABLED	1	The network interface is disabled.
INACTIVE	2	The supplicant is inactive.
SCANNING	3	The supplicant is scanning for a WLAN connection.
AUTHENTICATING	4	The supplicant is being authenticated.
ASSOCIATING	5	The supplicant is being associated with an AP.
ASSOCIATED	6	The supplicant is associated with an AP.
FOUR_WAY_HANDSHAKE	7	A four-way handshake is being performed for the supplicant.
GROUP_HANDSHAKE	8	A group handshake is being performed for the supplicant.
COMPLETED	9	The authentication is complete.
UNINITIALIZED	10	The supplicant failed to set up the connection.
INVALID	11	Invalid value.

wifiManager.getSupportedFeatures⁹⁺

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

Type	Description
number	Feature value.

Feature IDs

Value	Description
0x0001	WLAN infrastructure mode
0x0002	5 GHz feature
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

Error codes

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

ID	Error Message
2401000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getDeviceMacAddress⁹⁺

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

Type	Description
string[]	MAC address obtained.

Error codes

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

ID	Error Message
2501000	Operation failed.
2501001	wifi is closed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.reassociate⁹⁺

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.

ID	Error Message
2501000	Operation failed.
2501001	Wifi is closed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.reconnect⁹⁺

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.

ID	Error Message
2501000	Operation failed.
2501001	Wifi is closed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getDeviceConfigs⁹⁺

getDeviceConfigs(): Array<WifiDeviceConfig>

Obtains network configuration.

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

API version 10 and later: ohos.permission.GET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG

System capability: SystemCapability.Communication.WiFi.STA

Return value

Type	Description
Array<WifiDeviceConfig>	Array of network configuration obtained.

Error codes

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

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.updateNetwork⁹⁺

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

Name	Type	Mandatory	Description
config	WifiDeviceConfig	Yes	New WLAN configuration.

Return value

Type	Description
number	ID 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.

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

	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.disableNetwork⁹⁺

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

Name	Type	Mandatory	Description
netId	number	Yes	ID of the network configuration to disable.

Error codes

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

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.removeAllNetwork⁹⁺

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.

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.removeDevice⁹⁺

removeDevice(id: number): void

Removes the specified 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

Name	Type	Mandatory	Description
id	number	Yes	ID of the network configuration to remove.

Error codes

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

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.get5GChannelList¹⁰⁺

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

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

Error codes

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

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getDisconnectedReason¹⁰⁺

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.

ID	Error Message
2501000	Operation failed.

Return value

Type	Description
DisconnectedReason	Returns the reason of the latest disconnection obtained.

Example

	import wifiManager from '@ohos.wifiManager';

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

DisconnectedReason ¹⁰⁺

Enumerates the Wi-Fi disconnection reasons.

System API: This is a system API.

System capability: SystemCapability.Communication.WiFi.STA

Name	Value	Description
DISC_REASON_DEFAULT	0	Default reason.
DISC_REASON_WRONG_PWD	1	Incorrect password.
DISC_REASON_CONNECTION_FULL	2	The number of connections to the router has reached the limit.

wifiManager.startPortalCertification¹¹⁺

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.

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.factoryReset¹¹⁺

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.

ID	Error Message
2501000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.enableHotspot⁹⁺

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.

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.disableHotspot⁹⁺

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.

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.isHotspotDualBandSupported⁹⁺

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

Type	Description
boolean	Returns true if the hotspot supports dual band; returns false otherwise.

Error codes

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

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.isHotspotActive⁹⁺

isHotspotActive(): boolean

Checks whether this hotspot is active.

System API: This is a system API.

Required permissions: ohos.permission.GET_WIFI_INFO

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

Return value

Type	Description
boolean	Returns true if the hotspot is active; returns false otherwise.

Error codes

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

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.setHotspotConfig⁹⁺

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

Name	Type	Mandatory	Description
config	HotspotConfig	Yes	Hotspot configuration to set.

Error codes

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

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

	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));
	}

HotspotConfig⁹⁺

Represents the hotspot configuration.

System API: This is a system API.

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

Name	Type	Readable	Writable	Description
ssid	string	Yes	Yes	SSID of the hotspot, in UTF-8 format.
securityType	WifiSecurityType	Yes	Yes	Security type.
band	number	Yes	Yes	Hotspot band. The value 1 stands for 2.4 GHz, the value 2 for 5 GHz, and the value 3 for dual band.
channel¹⁰⁺	number	Yes	Yes	Hotspot channel (2.4 GHz: 1 to 14; 5 GHz: 7 to 196; Dual-band: not supported currently)
preSharedKey	string	Yes	Yes	PSK of the hotspot.
maxConn	number	Yes	Yes	Maximum number of connections allowed.

wifiManager.getHotspotConfig⁹⁺

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

Type	Description
HotspotConfig	Hotspot configuration obtained.

Error codes

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

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getStations⁹⁺

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

Type	Description
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.

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

StationInfo⁹⁺

Represents the station information.

System API: This is a system API.

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

Name	Type	Readable	Writable	Description
name	string	Yes	No	Device name.
macAddress	string	Yes	No	MAC address.
macAddressType¹⁰⁺	DeviceAddressType	Yes	No	MAC address type.
ipAddress	string	Yes	No	IP address.

wifiManager.addHotspotBlockList¹¹⁺

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

Name	Type	Mandatory	Description
stationInfo	StationInfo	Yes	Device to add.

Error codes

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

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

	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.delHotspotBlockList¹¹⁺

delHotspotBlockList(stationInfo: StationInfo)

Delets 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

Name	Type	Mandatory	Description
stationInfo	StationInfo	Yes	Device to delete.

Error codes

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

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

	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.getHotspotBlockList¹¹⁺

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

Type	Description
Array<StationInfo>	List of blocked devices obtained.

Error codes

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

ID	Error Message
2601000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.deletePersistentGroup⁹⁺

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

Name	Type	Mandatory	Description
netId	number	Yes	ID of the group to delete.

Error codes

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

ID	Error Message
2801000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getP2pGroups⁹⁺

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

Type	Description
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.

ID	Error Message
2801000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

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

wifiManager.getP2pGroups⁹⁺

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

Name	Type	Mandatory	Description
callback	AsyncCallback< Array<WifiP2pGroupInfo>>	Yes	Callback invoked 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.

ID	Error Message
2801000	Operation failed.

wifiManager.setDeviceName⁹⁺

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

Name	Type	Mandatory	Description
devName	string	Yes	Device name to set.

Error codes

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

ID	Error Message
2801000	Operation failed.

Example

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.on('streamChange')⁹⁺

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

Subscribes to 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

Name	Type	Mandatory	Description
type	string	Yes	Event type, which has a fixed value of streamChange.
callback	Callback<number>	Yes	Callback invoked to return the 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.

ID	Error Message
2501000	Operation failed.

wifiManager.off('streamChange')⁹⁺

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

Name	Type	Mandatory	Description
type	string	Yes	Event type, which has a fixed value of streamChange.
callback	Callback<number>	No	Callback 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.

ID	Error Message
2501000	Operation failed.

Example

import wifi from '@ohos.wifi';

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')⁹⁺

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

Subscribes to 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

Name	Type	Mandatory	Description
type	string	Yes	Event type, which has a fixed value of deviceConfigChange.
callback	Callback<number>	Yes	Callback invoked to return the device configuration change, which can be any of the following values: - 0: device configuration added. - 1: device configuration changed. - 2: device configuration deleted.

Error codes

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

ID	Error Message
2501000	Operation failed.

wifiManager.off('deviceConfigChange')⁹⁺

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

Name	Type	Mandatory	Description
type	string	Yes	Event type, which has a fixed value of deviceConfigChange.
callback	Callback<number>	No	Callback to unregister. The device configuration change can be any of the following values: - 0: device configuration added. - 1: device configuration changed. - 2: device configuration deleted.

Error codes

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

ID	Error Message
2501000	Operation failed.

Example

import wifi from '@ohos.wifiManager';

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')⁹⁺

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

Subscribes to 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

Name	Type	Mandatory	Description
type	string	Yes	Event type, which has a fixed value of hotspotStaJoin.
callback	Callback<StationInfo>	Yes	Callback invoked immediately after an STA is connected to a Wi-Fi hotspot.

Error codes

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

ID	Error Message
2601000	Operation failed.

wifiManager.off('hotspotStaJoin')⁹⁺

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

Name	Type	Mandatory	Description
type	string	Yes	Event type, which has a fixed value of hotspotStaJoin.
callback	Callback<StationInfo>	No	Callback to unregister.

Error codes

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

ID	Error Message
2601000	Operation failed.

Example

import wifiManager from '@ohos.wifiManager';

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')⁹⁺

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

Subscribes to 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

Name	Type	Mandatory	Description
type	string	Yes	Event type, which has a fixed value of hotspotStaLeave.
callback	Callback<StationInf]>	Yes	Callback invoked immediately after an STA is disconnected from a Wi-Fi hotspot.

Error codes

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

ID	Error Message
2601000	Operation failed.

wifiManager.off('hotspotStaLeave')⁹⁺

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

Name	Type	Mandatory	Description
type	string	Yes	Event type, which has a fixed value of hotspotStaLeave.
callback	Callback<StationInf]>	No	Callback to unregister.

Error codes

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

ID	Error Message
2601000	Operation failed.

Example

import wifiManager from '@ohos.wifiManager';

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

@ohos.wifiManager (WLAN) (System API)

Modules to Import

wifiManager.enableWifi9+

wifiManager.disableWifi9+

wifiManager.startScan10+

wifiManager.setScanAlwaysAllowed10+

wifiManager.getScanAlwaysAllowed10+

wifiManager.addDeviceConfig9+

WifiDeviceConfig9+

IpType9+

IpConfig9+

WifiProxyConfig10+

ProxyMethod10+

wifiManager.addDeviceConfig9+

wifiManager.connectToNetwork9+

wifiManager.connectToDevice9+

wifiManager.disconnect9+

WifiLinkedInfo9+

SuppState9+

wifiManager.getSupportedFeatures9+

wifiManager.getDeviceMacAddress9+

wifiManager.reassociate9+

wifiManager.reconnect9+

wifiManager.getDeviceConfigs9+

wifiManager.updateNetwork9+

wifiManager.disableNetwork9+

wifiManager.removeAllNetwork9+

wifiManager.removeDevice9+

wifiManager.get5GChannelList10+

wifiManager.getDisconnectedReason10+

DisconnectedReason 10+

wifiManager.startPortalCertification11+

wifiManager.factoryReset11+

wifiManager.enableHotspot9+

wifiManager.disableHotspot9+

wifiManager.isHotspotDualBandSupported9+

wifiManager.isHotspotActive9+

wifiManager.setHotspotConfig9+

HotspotConfig9+

wifiManager.getHotspotConfig9+

wifiManager.getStations9+

StationInfo9+

wifiManager.addHotspotBlockList11+

wifiManager.delHotspotBlockList11+

wifiManager.getHotspotBlockList11+

wifiManager.deletePersistentGroup9+

wifiManager.getP2pGroups9+

wifiManager.getP2pGroups9+

wifiManager.setDeviceName9+

wifiManager.on('streamChange')9+

wifiManager.off('streamChange')9+

wifiManager.on('deviceConfigChange')9+

wifiManager.off('deviceConfigChange')9+

wifiManager.on('hotspotStaJoin')9+

wifiManager.off('hotspotStaJoin')9+

wifiManager.on('hotspotStaLeave')9+

wifiManager.off('hotspotStaLeave')9+

wifiManager.enableWifi⁹⁺

wifiManager.disableWifi⁹⁺

wifiManager.startScan¹⁰⁺

wifiManager.setScanAlwaysAllowed¹⁰⁺

wifiManager.getScanAlwaysAllowed¹⁰⁺

wifiManager.addDeviceConfig⁹⁺

WifiDeviceConfig⁹⁺

IpType⁹⁺

IpConfig⁹⁺

WifiProxyConfig¹⁰⁺

ProxyMethod¹⁰⁺

wifiManager.addDeviceConfig⁹⁺

wifiManager.connectToNetwork⁹⁺

wifiManager.connectToDevice⁹⁺

wifiManager.disconnect⁹⁺

WifiLinkedInfo⁹⁺

SuppState⁹⁺

wifiManager.getSupportedFeatures⁹⁺

wifiManager.getDeviceMacAddress⁹⁺

wifiManager.reassociate⁹⁺

wifiManager.reconnect⁹⁺

wifiManager.getDeviceConfigs⁹⁺

wifiManager.updateNetwork⁹⁺

wifiManager.disableNetwork⁹⁺

wifiManager.removeAllNetwork⁹⁺

wifiManager.removeDevice⁹⁺

wifiManager.get5GChannelList¹⁰⁺

wifiManager.getDisconnectedReason¹⁰⁺

DisconnectedReason ¹⁰⁺

wifiManager.startPortalCertification¹¹⁺

wifiManager.factoryReset¹¹⁺

wifiManager.enableHotspot⁹⁺

wifiManager.disableHotspot⁹⁺

wifiManager.isHotspotDualBandSupported⁹⁺

wifiManager.isHotspotActive⁹⁺

wifiManager.setHotspotConfig⁹⁺

HotspotConfig⁹⁺

wifiManager.getHotspotConfig⁹⁺

wifiManager.getStations⁹⁺

StationInfo⁹⁺

wifiManager.addHotspotBlockList¹¹⁺

wifiManager.delHotspotBlockList¹¹⁺

wifiManager.getHotspotBlockList¹¹⁺

wifiManager.deletePersistentGroup⁹⁺

wifiManager.getP2pGroups⁹⁺

wifiManager.getP2pGroups⁹⁺

wifiManager.setDeviceName⁹⁺

wifiManager.on('streamChange')⁹⁺

wifiManager.off('streamChange')⁹⁺

wifiManager.on('deviceConfigChange')⁹⁺

wifiManager.off('deviceConfigChange')⁹⁺

wifiManager.on('hotspotStaJoin')⁹⁺

wifiManager.off('hotspotStaJoin')⁹⁺

wifiManager.on('hotspotStaLeave')⁹⁺

wifiManager.off('hotspotStaLeave')⁹⁺