@ohos.wifi (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 other 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.wifi (WLAN). The APIs of this module are no longer maintained since API version 9. You are advised to use @ohos.wifiManager (WLAN).

Modules to Import

import wifi from '@ohos.wifi';

wifi.enableWifi

enableWifi(): boolean

Enables WLAN.

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

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.disableWifi

disableWifi(): boolean

Disables WLAN.

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

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

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

Return value

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

Example

import wifi from '@ohos.wifi';

try {
	let config:wifi.WifiDeviceConfig = {
		ssid : "****",
		bssid:  "****",
		preSharedKey: "****",
		isHiddenSsid: false,
		securityType: 0,
		creatorUid: 0,
		disableReason: 0,
		netId: 0,
		randomMacType: 0,
		randomMacAddr:  "****",
		ipType: 0,
		staticIp: {
			ipAddress: 0,
			gateway: 0,
			dnsServers: [],
			domains: []
		}
	}
	wifi.addDeviceConfig(config).then(result => {
		console.info("result:" + JSON.stringify(result));
	});	
}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	Random MAC type. System API: This is a system API.
randomMacAddr	string	Yes	No	Random 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 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.
dnsServers	number[]	Yes	No	Domain name server (DNS) information.
domains	Array<string>	Yes	No	Domain information.

wifi.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.
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 err is not 0, an error has occurred.

Example

import wifi from '@ohos.wifi';

try {
	let config:wifi.WifiDeviceConfig = {
		ssid : "****",
		bssid:  "****",
		preSharedKey: "****",
		isHiddenSsid: false,
		securityType: 0,
		creatorUid: 0,
		disableReason: 0,
		netId: 0,
		randomMacType: 0,
		randomMacAddr:  "****",
		ipType: 0,
		staticIp: {
			ipAddress: 0,
			gateway: 0,
			dnsServers: [],
			domains: []
		}
	}
	wifi.addDeviceConfig(config,(error,result) => {
		console.info("result:" + JSON.stringify(result));
	});	
}catch(error){
	console.error("failed:" + JSON.stringify(error));
}

wifi.connectToNetwork

connectToNetwork(networkId: number): boolean

Connects to the specified network.

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.

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.connectToDevice

connectToDevice(config: WifiDeviceConfig): boolean

Connects to the specified network.

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	WLAN configuration.

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

try {
	let config:wifi.WifiDeviceConfig = {
		ssid : "****",
		bssid:  "****",
		preSharedKey: "****",
		isHiddenSsid: false,
		securityType: 3,
		creatorUid: 0,
		disableReason: 0,
		netId: 0,
		randomMacType: 0,
		randomMacAddr:  "****",
		ipType: 0,
		staticIp: {
		ipAddress: 0,
			gateway: 0,
			dnsServers: [],
			domains: []
		}
	}
	wifi.connectToDevice(config);
			
}catch(error){
	console.error("failed:" + JSON.stringify(error));
}

wifi.disconnect

disconnect(): boolean

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

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

try {
	wifi.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.

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

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

Example

import wifi from '@ohos.wifi';

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

wifi.reassociate⁷⁺

reassociate(): boolean

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

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.reconnect⁷⁺

reconnect(): boolean

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

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.getDeviceConfigs⁷⁺

getDeviceConfigs(): Array<WifiDeviceConfig>

Obtains network configuration.

System API: This is a system API.

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

System capability: SystemCapability.Communication.WiFi.STA

Return value

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

Example

import wifi from '@ohos.wifi';

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

wifi.updateNetwork⁷⁺

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.

Example

import wifi from '@ohos.wifi';

try {
	let config:wifi.WifiDeviceConfig = {
		ssid : "****",
		bssid:  "****",
		preSharedKey: "****",
		isHiddenSsid: false,
		securityType: 3,
		creatorUid: 0,
		disableReason: 0,
		netId: 0,
		randomMacType: 0,
		randomMacAddr:  "****",
		ipType: 0,
		staticIp: {
			ipAddress: 0,
			gateway: 0,
			dnsServers: [],
			domains: []
		}
	}
	let ret = wifi.updateNetwork(config);
	console.error("ret:" + ret);		
}catch(error){
	console.error("failed:" + JSON.stringify(error));
}

wifi.disableNetwork⁷⁺

disableNetwork(netId: number): boolean

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.

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.removeAllNetwork⁷⁺

removeAllNetwork(): boolean

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

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.removeDevice⁷⁺

removeDevice(id: number): boolean

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.

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.enableHotspot⁷⁺

enableHotspot(): boolean

Enables this hotspot.

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

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.disableHotspot⁷⁺

disableHotspot(): boolean

Disables this hotspot.

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

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.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 feature is supported; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

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

Example

import wifi from '@ohos.wifi';

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

wifi.setHotspotConfig⁷⁺

setHotspotConfig(config: HotspotConfig): boolean

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.

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

try {
	let config:wifi.HotspotConfig = {
		ssid: "****",
		securityType: 3,
		band: 0,
		preSharedKey: "****",
		maxConn: 0
	}
	let ret = wifi.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	No	SSID of the hotspot, in UTF-8 format.
securityType	WifiSecurityType	Yes	No	Security type.
band	number	Yes	No	Hotspot band. The value 1 stands for 2.4 GHz, the value 2 for 5 GHz, and the value 3 for dual band.
preSharedKey	string	Yes	No	PSK of the hotspot.
maxConn	number	Yes	No	Maximum number of connections allowed.

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

Example

import wifi from '@ohos.wifi';

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

wifi.getStations⁷⁺

getStations(): Array<StationInfo>

Obtains information about the connected stations.

System API: This is a system API.

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

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

Return value

Type	Description
Array<StationInfo>	Connected stations obtained.

Example

import wifi from '@ohos.wifi';

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

StationInfo⁷⁺

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.
ipAddress	string	Yes	No	IP address.

wifi.deletePersistentGroup⁸⁺

deletePersistentGroup(netId: number): boolean

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.

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.setDeviceName⁸⁺

setDeviceName(devName: string): boolean

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.

Return value

Type	Description
boolean	Returns true if the operation is successful; returns false otherwise.

Example

import wifi from '@ohos.wifi';

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

wifi.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 Wi-Fi stream change, which can be any of the following values: - 0: No stream. - 1: Downward. - 2: Upward. - 3: Bidirectional.

wifi.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 Wi-Fi stream change can be any of the following values: - 0: No stream. - 1: Downward. - 2: Upward. - 3: Bidirectional.

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

wifi.on('hotspotStaJoin')⁷⁺

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

Subscribes to the event of an STA joining a Wi-Fi hotspot.

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT

System API: This is a system API.

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 when an STA is connected to a Wi-Fi hotspot.

wifi.off('hotspotStaJoin')⁷⁺

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

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

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT

System API: This is a system API.

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.

Example

import wifi from '@ohos.wifi';

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

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

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

wifi.on('hotspotStaLeave')⁷⁺

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

Subscribes to the event of an STA leaving a Wi-Fi hotspot.

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT

System API: This is a system API.

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 when an STA is disconnected from a Wi-Fi hotspot.

wifi.off('hotspotStaLeave')⁷⁺

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

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

Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT

System API: This is a system API.

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.

Example

import wifi from '@ohos.wifi';

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

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

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

@ohos.wifi (WLAN) (System API)

Modules to Import

wifi.enableWifi

wifi.disableWifi

wifi.addDeviceConfig

WifiDeviceConfig

IpType7+

IpConfig7+

wifi.addDeviceConfig

wifi.connectToNetwork

wifi.connectToDevice

wifi.disconnect

WifiLinkedInfo

SuppState

wifi.getSupportedFeatures7+

wifi.getDeviceMacAddress7+

wifi.reassociate7+

wifi.reconnect7+

wifi.getDeviceConfigs7+

wifi.updateNetwork7+

wifi.disableNetwork7+

wifi.removeAllNetwork7+

wifi.removeDevice7+

wifi.enableHotspot7+

wifi.disableHotspot7+

wifi.isHotspotDualBandSupported7+

wifi.isHotspotActive7+

wifi.setHotspotConfig7+

HotspotConfig7+

wifi.getHotspotConfig7+

wifi.getStations7+

StationInfo7+

wifi.deletePersistentGroup8+

wifi.setDeviceName8+

wifi.on('streamChange')7+

wifi.off('streamChange')7+

wifi.on('hotspotStaJoin')7+

wifi.off('hotspotStaJoin')7+

wifi.on('hotspotStaLeave')7+

wifi.off('hotspotStaLeave')7+

IpType⁷⁺

IpConfig⁷⁺

wifi.getSupportedFeatures⁷⁺

wifi.getDeviceMacAddress⁷⁺

wifi.reassociate⁷⁺

wifi.reconnect⁷⁺

wifi.getDeviceConfigs⁷⁺

wifi.updateNetwork⁷⁺

wifi.disableNetwork⁷⁺

wifi.removeAllNetwork⁷⁺

wifi.removeDevice⁷⁺

wifi.enableHotspot⁷⁺

wifi.disableHotspot⁷⁺

wifi.isHotspotDualBandSupported⁷⁺

wifi.isHotspotActive⁷⁺

wifi.setHotspotConfig⁷⁺

HotspotConfig⁷⁺

wifi.getHotspotConfig⁷⁺

wifi.getStations⁷⁺

StationInfo⁷⁺

wifi.deletePersistentGroup⁸⁺

wifi.setDeviceName⁸⁺

wifi.on('streamChange')⁷⁺

wifi.off('streamChange')⁷⁺

wifi.on('hotspotStaJoin')⁷⁺

wifi.off('hotspotStaJoin')⁷⁺

wifi.on('hotspotStaLeave')⁷⁺

wifi.off('hotspotStaLeave')⁷⁺