harmony 鸿蒙@ohos.wifiManager (WLAN)

2022-12-05 浏览 (1443)

@ohos.wifiManager (WLAN)

该模块主要提供WLAN基础功能、P2P(peer-to-peer)功能和WLAN消息通知的相应服务,让应用可以通过WLAN和其他设备互联互通。

说明: 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import wifiManager from '@ohos.wifiManager';

wifiManager.enableWifi9+

enableWifi(): void

使能WLAN,异步接口,是否打开成功需要注册并监听wifiStateChange的回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION 仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501003Failed to enable Wi-Fi.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.disableWifi9+

disableWifi(): void

去使能WLAN,异步接口,是否关闭成功需要注册并监听wifiStateChange的回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501004Failed to disable Wi-Fi.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.isWifiActive9+

isWifiActive(): boolean

查询WLAN是否已使能。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
booleantrue:已使能, false:未使能。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.scan9+

scan(): void

启动WLAN扫描。

需要权限:

API 9:ohos.permission.SET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.SET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.startScan10+

startScan(): void

系统接口: 此接口为系统接口。

启动WLAN扫描。

需要权限: ohos.permission.SET_WIFI_INFO 和ohos.permission.MANAGE_WIFI_CONNECTION

系统能力: SystemCapability.Communication.WiFi.STA

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getScanResults9+

getScanResults(): Promise<Array<WifiScanInfo>>

获取扫描结果,使用Promise异步回调。

需要权限: ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或(ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION))

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
Promise< Array<WifiScanInfo> >Promise对象。返回扫描到的热点列表。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

wifiManager.getScanResults9+

getScanResults(callback: AsyncCallback<Array<WifiScanInfo>>): void

获取扫描结果,使用callback异步回调。

需要权限: ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 (ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION))

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
callbackAsyncCallback< Array<WifiScanInfo>>回调函数。当成功时,err为0,data为扫描到的热点;否则err为非0值,data为空。
Array<WifiScanInfo>返回扫描到的热点列表。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  wifiManager.getScanResults((err, result) => {
      if (err) {
          console.error("get scan info error");
          return;
      }
  
      let len = result.length;
      console.log("wifi received scan info: " + len);
      for (let i = 0; i < len; ++i) {
          console.info("ssid: " + result[i].ssid);
          console.info("bssid: " + result[i].bssid);
          console.info("capabilities: " + result[i].capabilities);
          console.info("securityType: " + result[i].securityType);
          console.info("rssi: " + result[i].rssi);
          console.info("band: " + result[i].band);
          console.info("frequency: " + result[i].frequency);
          console.info("channelWidth: " + result[i].channelWidth);
          console.info("timestamp: " + result[i].timestamp);
      }
  });
  
  wifiManager.getScanResults().then(result => {
      let len = result.length;
      console.log("wifi received scan info: " + len);
      for (let i = 0; i < len; ++i) {
          console.info("ssid: " + result[i].ssid);
          console.info("bssid: " + result[i].bssid);
          console.info("capabilities: " + result[i].capabilities);
          console.info("securityType: " + result[i].securityType);
          console.info("rssi: " + result[i].rssi);
          console.info("band: " + result[i].band);
          console.info("frequency: " + result[i].frequency);
          console.info("channelWidth: " + result[i].channelWidth);
          console.info("timestamp: " + result[i].timestamp);
      }
  });

wifiManager.getScanResultsSync9+

getScanResultsSync():  Array<WifiScanInfo>

获取扫描结果,使用同步方式返回结果。

需要权限: ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 (ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION))

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
 Array<WifiScanInfo>扫描结果数组。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

	try {
		let scanInfoList = wifiManager.getScanResultsSync();
		console.info("scanInfoList:" + JSON.stringify(scanInfoList));
		let len = scanInfoList.length;
        console.log("wifi received scan info: " + len);
		if(len > 0){
			for (let i = 0; i < len; ++i) {
				console.info("ssid: " + scanInfoList[i].ssid);
				console.info("bssid: " + scanInfoList[i].bssid);
				console.info("capabilities: " + scanInfoList[i].capabilities);
				console.info("securityType: " + scanInfoList[i].securityType);
				console.info("rssi: " + scanInfoList[i].rssi);
				console.info("band: " + scanInfoList[i].band);
				console.info("frequency: " + scanInfoList[i].frequency);
				console.info("channelWidth: " + scanInfoList[i].channelWidth);
				console.info("timestamp: " + scanInfoList[i].timestamp);
			}
		}	
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}
	

wifiManager.getScanInfoList10+

getScanInfoList(): Array<WifiScanInfo>;

获取扫描结果。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
Array<WifiScanInfo>返回扫描到的热点列表。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的bssid为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

	try {
		let scanInfoList = wifiManager.getScanInfoList();
		console.info("scanInfoList:" + JSON.stringify(scanInfoList));
		let len = scanInfoList.length;
        console.log("wifi received scan info: " + len);
		if(len > 0){
			for (let i = 0; i < len; ++i) {
				console.info("ssid: " + scanInfoList[i].ssid);
				console.info("bssid: " + scanInfoList[i].bssid);
				console.info("capabilities: " + scanInfoList[i].capabilities);
				console.info("securityType: " + scanInfoList[i].securityType);
				console.info("rssi: " + scanInfoList[i].rssi);
				console.info("band: " + scanInfoList[i].band);
				console.info("frequency: " + scanInfoList[i].frequency);
				console.info("channelWidth: " + scanInfoList[i].channelWidth);
				console.info("timestamp: " + scanInfoList[i].timestamp);
			}
		}	
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}
	

WifiScanInfo9+

WLAN热点信息。

系统能力: SystemCapability.Communication.WiFi.STA

名称类型可读可写说明
ssidstring热点的SSID,编码格式为UTF-8。
bssidstring热点的BSSID。
bssidType10+DeviceAddressType热点的BSSID类型。
capabilitiesstring热点能力。
securityTypeWifiSecurityTypeWLAN加密类型。
rssinumber热点的信号强度(dBm)。
bandnumberWLAN接入点的频段。
frequencynumberWLAN接入点的频率。
channelWidthnumberWLAN接入点的带宽。
centerFrequency0number热点的中心频率。
centerFrequency1number热点的中心频率。如果热点使用两个不重叠的WLAN信道,则返回两个中心频率,分别用centerFrequency0和centerFrequency1表示。
infoElemsArray<WifiInfoElem>信息元素。
timestampnumber时间戳。

DeviceAddressType 10+

wifi 设备地址(mac/bssid)类型。

系统能力: SystemCapability.Communication.WiFi.Core

名称说明
RANDOM_DEVICE_ADDRESS0随机设备地址。
REAL_DEVICE_ADDRESS1真实设备地址。

WifiSecurityType9+

表示加密类型的枚举。

系统能力: SystemCapability.Communication.WiFi.Core

名称说明
WIFI_SEC_TYPE_INVALID0无效加密类型。
WIFI_SEC_TYPE_OPEN1开放加密类型。
WIFI_SEC_TYPE_WEP2Wired Equivalent Privacy (WEP)加密类型。
WIFI_SEC_TYPE_PSK3Pre-shared key (PSK)加密类型。
WIFI_SEC_TYPE_SAE4Simultaneous Authentication of Equals (SAE)加密类型。
WIFI_SEC_TYPE_EAP9+5EAP加密类型。
WIFI_SEC_TYPE_EAP_SUITE_B9+6Suite-B 192位加密类型。
WIFI_SEC_TYPE_OWE9+7机会性无线加密类型。
WIFI_SEC_TYPE_WAPI_CERT9+8WAPI-Cert加密类型。
WIFI_SEC_TYPE_WAPI_PSK9+9WAPI-PSK加密类型。

WifiBandType10+

表示WIFI频段类型的枚举。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
WIFI_BAND_NONE0无效频段类型。
WIFI_BAND_2G12.4G频段类型。
WIFI_BAND_5G25G频段类型。
WIFI_BAND_6G36G频段类型。
WIFI_BAND_60G460G频段类型。

WifiStandard10+

表示WIFI标准的枚举。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
WIFI_STANDARD_UNDEFINED0无效WIFI标准类型。
WIFI_STANDARD_11A1802.11a WiFi标准类型。
WIFI_STANDARD_11B2802.11b WiFi标准类型。
WIFI_STANDARD_11G3802.11g WiFi标准类型。
WIFI_STANDARD_11N4802.11n WiFi标准类型。
WIFI_STANDARD_11AC5802.11ac WiFi标准类型。
WIFI_STANDARD_11AX6802.11ax WiFi标准类型。
WIFI_STANDARD_11AD7802.11ad WiFi标准类型。

WifiInfoElem9+

WLAN热点信息。

系统能力: SystemCapability.Communication.WiFi.STA

名称类型可读可写说明
eidnumber元素ID。
contentUint8Array元素内容。

WifiChannelWidth9+

表示带宽类型的枚举。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
WIDTH_20MHZ020MHZ。
WIDTH_40MHZ140MHZ。
WIDTH_80MHZ280MHZ。
WIDTH_160MHZ3160MHZ。
WIDTH_80MHZ_PLUS480MHZ+
WIDTH_INVALID5无效值

wifiManager.setScanAlwaysAllowed10+

setScanAlwaysAllowed(isScanAlwaysAllowed: boolean): void

设置是否始终允许扫描。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
isScanAlwaysAllowedboolean是否始终允许扫描。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getScanAlwaysAllowed10+

getScanAlwaysAllowed(): boolean

获取是否始终允许扫描。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
boolean是否始终允许扫描。 true 表示允许触发扫描,false表示在禁用wifi时不允许触发扫描

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.addDeviceConfig9+

addDeviceConfig(config: WifiDeviceConfig): Promise<number>

添加网络配置,使用Promise异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
configWifiDeviceConfigWLAN配置信息。如果bssidType未指定值,则bssidType默认为随机设备地址类型。

返回值:

类型说明
Promise<number>Promise对象。返回添加的网络配置ID,如果值为-1表示添加失败。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	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(error){
		console.error("failed:" + JSON.stringify(error));
	}

WifiDeviceConfig9+

WLAN配置信息。

系统能力: SystemCapability.Communication.WiFi.STA

名称类型可读可写说明
ssidstring热点的SSID,编码格式为UTF-8。
bssidstring热点的BSSID。
bssidType10+DeviceAddressType热点的BSSID类型。
preSharedKeystring热点的密钥。
isHiddenSsidboolean是否是隐藏网络。
securityTypeWifiSecurityType加密类型。
creatorUidnumber创建用户的ID。
系统接口: 此接口为系统接口。
disableReasonnumber禁用原因。
系统接口: 此接口为系统接口。
netIdnumber分配的网络ID。
系统接口: 此接口为系统接口。
randomMacTypenumberMAC地址类型。0 - 随机MAC地址,1 - 设备MAC地址
系统接口: 此接口为系统接口。
randomMacAddrstringMAC地址。
系统接口: 此接口为系统接口。
ipTypeIpTypeIP地址类型。
系统接口: 此接口为系统接口。
staticIpIpConfig静态IP配置信息。
系统接口: 此接口为系统接口。
eapConfig10+WifiEapConfig可扩展身份验证协议配置。
proxyConfig10+WifiProxyConfig代理配置。
系统接口: 此接口为系统接口。

IpType9+

表示IP类型的枚举。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
STATIC0静态IP。
DHCP1通过DHCP获取。
UNKNOWN2未指定。

IpConfig9+

IP配置信息。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.Communication.WiFi.STA

名称类型可读可写说明
ipAddressnumberIP地址。
gatewaynumber网关。
prefixLengthnumber掩码。
dnsServersnumber[]DNS服务器。
domainsArray<string>域信息。

WifiEapConfig10+

可扩展身份验证协议配置信息。

系统能力: SystemCapability.Communication.WiFi.STA

名称类型可读可写说明
eapMethodEapMethodEAP认证方式。
phase2MethodPhase2Method第二阶段认证方式。
identitystring身份信息。
anonymousIdentitystring匿名身份。
passwordstring密码。
caCertAliasstringCA 证书别名。
caPathstringCA 证书路径。
clientCertAliasstring客户端证书别名。
certEntryUint8ArrayCA 证书内容。
certPasswordstringCA证书密码。
altSubjectMatchstring替代主题匹配。
domainSuffixMatchstring域后缀匹配。
realmstring通行证凭证的领域。
plmnstring公共陆地移动网的直通凭证提供商。
eapSubIdnumberSIM卡的子ID。

EapMethod10+

表示EAP认证方式的枚举。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
EAP_NONE0不指定。
EAP_PEAP1PEAP类型。
EAP_TLS2TLS类型。
EAP_TTLS3TTLS类型。
EAP_PWD4PWD类型。
EAP_SIM5SIM类型。
EAP_AKA6AKA类型。
EAP_AKA_PRIME7AKA Prime类型。
EAP_UNAUTH_TLS8UNAUTH TLS类型。

Phase2Method10+

表示第二阶段认证方式的枚举。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
PHASE2_NONE0不指定。
PHASE2_PAP1PAP类型。
PHASE2_MSCHAP2MSCHAP类型。
PHASE2_MSCHAPV23MSCHAPV2类型。
PHASE2_GTC4GTC类型。
PHASE2_SIM5SIM类型。
PHASE2_AKA6AKA类型。
PHASE2_AKA_PRIME7AKA Prime类型。

WifiProxyConfig 10+

Wifi 代理配置。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.Communication.WiFi.STA

名称类型可读可写说明
proxyMethodProxyMethod代理方法
pacWebAddressstring自动配置代理的PAC web 地址。
serverHostNamestring手动配置代理的服务器主机名。
serverPortstring手动配置代理的服务器端口。
exclusionObjectsstring手动配置代理的排除对象,对象用“,”分隔。

ProxyMethod10+

表示WiFi代理方法的枚举。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
METHOD_NONE0不使用代理。
METHOD_AUTO1使用自动配置的代理。
METHOD_MANUAL2使用手动配置的代理。

wifiManager.addDeviceConfig9+

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

添加网络配置,使用callback异步回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
configWifiDeviceConfigWLAN配置信息。如果bssidType未指定值,则bssidType默认为随机设备地址类型。
callbackAsyncCallback<number>回调函数。当操作成功时,err为0,data为添加的网络配置ID,如果data值为-1,表示添加失败。当error为非0,表示处理出现错误。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	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.addCandidateConfig9+

addCandidateConfig(config: WifiDeviceConfig): Promise<number>

添加候选网络配置,使用Promise异步回调。

需要权限: ohos.permission.SET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
configWifiDeviceConfigWLAN配置信息。如果bssidType未指定值,则bssidType默认为随机设备地址类型。

返回值:

类型说明
Promise<number>Promise对象。表示网络配置ID。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.addCandidateConfig9+

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

添加候选网络配置,使用callback异步回调。

需要权限: ohos.permission.SET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
configWifiDeviceConfigWLAN配置信息。如果bssidType未指定值,则bssidType默认为随机设备地址类型。
callbackAsyncCallback<number>回调函数。当操作成功时,err为0,data为添加的网络配置ID,如果data值为-1,表示添加失败。如果操作出现错误,err为非0值。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.removeCandidateConfig9+

removeCandidateConfig(networkId: number): Promise<void>

移除候选网络配置,使用Promise异步回调。

需要权限: ohos.permission.SET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
networkIdnumber网络配置ID。

返回值:

类型说明
Promise<void>Promise对象。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

	try {
		let networkId = 0;
		wifiManager.removeCandidateConfig(networkId).then(result => {
			console.info("result:" + JSON.stringify(result));
		});	
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.removeCandidateConfig9+

removeCandidateConfig(networkId: number, callback: AsyncCallback<void>): void

移除候选网络配置,使用callback异步回调。

需要权限: ohos.permission.SET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
networkIdnumber网络配置ID。
callbackAsyncCallback<void>回调函数。当操作成功时,err为0。如果error为非0,表示处理出现错误。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

	try {
		let networkId = 0;
		wifiManager.removeCandidateConfig(networkId,(error,result) => {
		console.info("result:" + JSON.stringify(result));
		});	
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.getCandidateConfigs9+

getCandidateConfigs():  Array<WifiDeviceConfig>

获取候选网络配置。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
 Array<WifiDeviceConfig>候选网络配置数组。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

	try {
		let configs = wifiManager.getCandidateConfigs();
		console.info("configs:" + JSON.stringify(configs));
		let len = configs.length;
        console.log("result len: " + len);
		if(len > 0){
			for (let i = 0; i < len; ++i) {
				console.info("ssid: " + configs[i].ssid);
				console.info("bssid: " + configs[i].bssid);
			}
		}	
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}
	

wifiManager.connectToCandidateConfig9+

connectToCandidateConfig(networkId: number): void

应用使用该接口连接到自己添加的候选网络(如果当前已经连接到热点,需要先断开连接)。

需要权限: ohos.permission.SET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
networkIdnumber候选网络配置的ID。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501001Wifi is closed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.connectToNetwork9+

connectToNetwork(networkId: number): void

连接到指定网络(如果当前已经连接到热点,请先使用disconnet()接口断开连接)。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
networkIdnumber待连接的网络配置ID。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501001Wifi is closed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.connectToDevice9+

connectToDevice(config: WifiDeviceConfig): void

连接到指定网络(如果当前已经连接到热点,请先使用disconnet()接口断开连接)。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
configWifiDeviceConfigWLAN配置信息。如果bssidType未指定值,则bssidType默认为随机设备地址类型。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501001Wifi is closed.

示例:

	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.disconnect9+

disconnect(): void

断开连接的网络。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getSignalLevel9+

getSignalLevel(rssi: number, band: number): number

查询WLAN信号强度。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
rssinumber热点的信号强度(dBm)。
bandnumberWLAN接入点的频段。

返回值:

类型说明
number信号强度,取值范围为[0, 4]。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

	try {
		let rssi = 0;
		let band = 0;
		let level = wifiManager.getSignalLevel(rssi,band);
		console.info("level:" + JSON.stringify(level));
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

wifiManager.getLinkedInfo9+

getLinkedInfo(): Promise<WifiLinkedInfo>

获取WLAN连接信息,使用Promise异步回调。

需要权限: ohos.permission.GET_WIFI_INFO 。

获取 macAddress 还需申请ohos.permission.GET_WIFI_LOCAL_MAC权限,无该权限时,macAddress 返回空字符串。

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
Promise<WifiLinkedInfo>Promise对象。表示WLAN连接信息。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501001Wifi is closed.

wifiManager.getLinkedInfo9+

getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void

获取WLAN连接信息,使用callback异步回调。

需要权限: ohos.permission.GET_WIFI_INFO 。

获取 macAddress 还需申请ohos.permission.GET_WIFI_LOCAL_MAC权限,无该权限时,macAddress 返回空字符串。

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
callbackAsyncCallback<WifiLinkedInfo>回调函数。当获取成功时,err为0,data表示WLAN连接信息。如果error为非0,表示处理出现错误。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501001Wifi is closed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  wifiManager.getLinkedInfo((err, data) => {
      if (err) {
          console.error("get linked info error");
          return;
      }
      console.info("get wifi linked info: " + JSON.stringify(data));
  });
  
  wifiManager.getLinkedInfo().then(data => {
      console.info("get wifi linked info: " + JSON.stringify(data));
  }).catch((error:number) => {
      console.info("get linked info error");
  });

WifiLinkedInfo9+

提供WLAN连接的相关信息。

系统能力: SystemCapability.Communication.WiFi.STA

名称类型可读可写说明
ssidstring热点的SSID,编码格式为UTF-8。
bssidstring热点的BSSID。
networkIdnumber网络配置ID。
系统接口: 此接口为系统接口。
rssinumber热点的信号强度(dBm)。
bandnumberWLAN接入点的频段。
linkSpeednumberWLAN接入点的上行速度。
rxLinkSpeed10+numberWLAN接入点的下行速度。
maxSupportedTxLinkSpeed10+number当前支持的最大上行速率。
maxSupportedRxLinkSpeed10+number当前支持的最大下行速率。
frequencynumberWLAN接入点的频率。
isHiddenbooleanWLAN接入点是否是隐藏网络。
isRestrictedbooleanWLAN接入点是否限制数据量。
chloadnumber连接负载,值越大表示负载约高。
系统接口: 此接口为系统接口。
snrnumber信噪比。
系统接口: 此接口为系统接口。
macTypenumberMAC地址类型。0 - 随机MAC地址,1 - 设备MAC地址。
macAddressstring设备的MAC地址。
ipAddressnumberWLAN连接的IP地址。
suppStateSuppState请求状态。
系统接口: 此接口为系统接口。
connStateConnStateWLAN连接状态。
channelWidth10+WifiChannelWidth当前连接热点的信道带宽。
wifiStandard10+WifiStandard当前连接热点的WiFi标准。

ConnState9+

表示WLAN连接状态的枚举。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
SCANNING0设备正在搜索可用的AP。
CONNECTING1正在建立WLAN连接。
AUTHENTICATING2WLAN连接正在认证中。
OBTAINING_IPADDR3正在获取WLAN连接的IP地址。
CONNECTED4WLAN连接已建立。
DISCONNECTING5WLAN连接正在断开。
DISCONNECTED6WLAN连接已断开。
UNKNOWN7WLAN连接建立失败。

SuppState9+

表示请求状态的枚举。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
DISCONNECTED0已断开。
INTERFACE_DISABLED1接口禁用。
INACTIVE2未激活。
SCANNING3扫描中。
AUTHENTICATING4认证中。
ASSOCIATING5关联中。
ASSOCIATED6已关联。
FOUR_WAY_HANDSHAKE7四次握手。
GROUP_HANDSHAKE8组握手。
COMPLETED9所有认证已完成。
UNINITIALIZED10连接建立失败。
INVALID11无效值。

wifiManager.isConnected9+

isConnected(): boolean

查询WLAN是否已连接。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
booleantrue:已连接, false:未连接。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getSupportedFeatures9+

getSupportedFeatures(): number

查询设备支持的特性。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.Core

返回值:

类型说明
number支持的特性值。

特性ID值枚举:

枚举值说明
0x0001基础结构模式特性。
0x00025 GHz带宽特性。
0x0004GAS/ANQP特性。
0x0008Wifi-Direct特性。
0x0010Soft AP特性。
0x0040Wi-Fi AWare组网特性。
0x8000AP STA共存特性。
0x8000000WPA3-Personal SAE特性。
0x10000000WPA3-Enterprise Suite-B
0x20000000增强开放特性。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2401000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.isFeatureSupported9+

isFeatureSupported(featureId: number): boolean

判断设备是否支持相关WLAN特性。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.Core

参数:

参数名类型必填说明
featureIdnumber特性ID值。

返回值:

类型说明
booleantrue:支持, false:不支持。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2401000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getDeviceMacAddress9+

getDeviceMacAddress(): string[]

获取设备的MAC地址。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_WIFI_LOCAL_MAC 和 ohos.permission.GET_WIFI_INFO,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
string[]MAC地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501001wifi is closed.

示例:

	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.getIpInfo9+

getIpInfo(): IpInfo

获取IP信息。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
IpInfoIP信息。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

IpInfo9+

IP信息。

系统能力: SystemCapability.Communication.WiFi.STA

名称类型可读可写说明
ipAddressnumberIP地址。
gatewaynumber网关。
netmasknumber掩码。
primaryDnsnumber主DNS服务器IP地址。
secondDnsnumber备DNS服务器IP地址。
serverIpnumberDHCP服务端IP地址。
leaseDurationnumberIP地址租用时长。

wifiManager.getIpv6Info10+

getIpv6Info(): Ipv6Info

获取IP信息。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
Ipv6InfoIpv6信息。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

Ipv6Info 10+

Ipv6信息。

系统能力: SystemCapability.Communication.WiFi.STA

名称类型可读可写说明
linkIpv6Addressstring链路Ipv6地址。
globalIpv6Addressstring全局Ipv6地址。
randomGlobalIpv6Addressstring随机全局Ipv6地址。
gatewaystring网关。
netmaskstring网络掩码。
primaryDNSstring主DNS服务器Ipv6地址。
secondDNSstring备DNS服务器Ipv6地址。

wifiManager.getCountryCode9+

getCountryCode(): string

获取国家码信息。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.Core

返回值:

类型说明
string国家码。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2401000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.reassociate9+

reassociate(): void

重新关联网络。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501001Wifi is closed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.reconnect9+

reconnect(): void

重新连接网络。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.
2501001Wifi is closed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getDeviceConfigs9+

getDeviceConfigs():  Array<WifiDeviceConfig>

获取网络配置。

系统接口: 此接口为系统接口。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION、ohos.permission.APPROXIMATELY_LOCATION 和 ohos.permission.GET_WIFI_CONFIG

API 10起:ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
 Array<WifiDeviceConfig>网络配置信息的数组。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	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.updateNetwork9+

updateNetwork(config: WifiDeviceConfig): number

更新网络配置。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
configWifiDeviceConfigWLAN配置信息。

返回值:

类型说明
number返回更新的网络配置ID,如果值为-1表示更新失败。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	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.disableNetwork9+

disableNetwork(netId: number): void

去使能网络配置。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
netIdnumber网络配置ID。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.removeAllNetwork9+

removeAllNetwork(): void

移除所有网络配置。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.removeDevice9+

removeDevice(id: number): void

移除指定的网络配置。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
idnumber网络配置ID。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.isBandTypeSupported10+

isBandTypeSupported(bandType: WifiBandType): boolean

判断当前频段是否支持。

需要权限: ohos.permission.GET_WIFI_INFO。

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
bandTypeWifiBandTypeWifi 频段类型。

返回值:

类型说明
booleantrue:支持, false:不支持。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.get5GChannelList10+

get5GChannelList(): Array<number>

获取当前设备支持的5G信道列表。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.STA

返回值:

类型说明
 Array<number>设备支持的5G信道列表。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

	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.getDisconnectedReason10+

getDisconnectedReason(): DisconnectedReason

获取最近一次断连原因。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.STA

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

返回值:

类型说明
DisconnectedReason最近断开的原因

示例:

	import wifiManager from '@ohos.wifiManager';

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

DisconnectedReason 10+

表示wifi断开原因的枚举。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.Communication.WiFi.STA

名称说明
DISC_REASON_DEFAULT0默认原因。
DISC_REASON_WRONG_PWD1密码错误。
DISC_REASON_CONNECTION_FULL2路由器的连接数已达到最大数量限制。

wifiManager.enableHotspot9+

enableHotspot(): void

使能热点,异步接口,是否打开成功需要注册并监听hotspotStateChange的回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.AP.Core

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.disableHotspot9+

disableHotspot(): void

去使能热点 ,异步接口,是否关闭成功需要注册并监听hotspotStateChange的回调。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.AP.Core

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.isHotspotDualBandSupported9+

isHotspotDualBandSupported(): boolean

热点是否支持双频。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.AP.Core

返回值:

类型说明
booleantrue:支持, false:不支持.

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.isHotspotActive9+

isHotspotActive(): boolean

热点是否已使能。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.AP.Core

返回值:

类型说明
booleantrue:已使能, false:未使能.

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.setHotspotConfig9+

setHotspotConfig(config: HotspotConfig): void

设置热点配置信息。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.AP.Core

参数:

参数名类型必填说明
configHotspotConfig热点配置信息。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

示例:

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

HotspotConfig9+

热点配置信息。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.Communication.WiFi.AP.Core

名称类型可读可写说明
ssidstring热点的SSID,编码格式为UTF-8。
securityTypeWifiSecurityType加密类型。
bandnumber热点的带宽。1: 2.4G, 2: 5G, 3: 双模频段
channel10+number热点的信道(2.4G:1~14,5G:7~196,双模频段:暂不支持)。
preSharedKeystring热点的密钥。
maxConnnumber最大设备连接数。

wifiManager.getHotspotConfig9+

getHotspotConfig(): HotspotConfig

获取热点配置信息。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.AP.Core

返回值:

类型说明
HotspotConfig热点的配置信息。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

示例:

	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.getStations9+

getStations():  Array<StationInfo>

获取连接的设备。

系统接口: 此接口为系统接口。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION、ohos.permission.APPROXIMATELY_LOCATION 和 ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

API 10起:ohos.permission.GET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_HOTSPOT,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.AP.Core

返回值:

类型说明
 Array<StationInfo>连接的设备数组。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的macAddress为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

StationInfo9+

接入的设备信息。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.Communication.WiFi.AP.Core

名称类型可读可写说明
namestring设备名称。
macAddressstringMAC地址。
macAddressType10+DeviceAddressTypeMAC地址类型。
ipAddressstringIP地址。

wifiManager.getP2pLinkedInfo9+

getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo>

获取P2P连接信息,使用Promise异步回调。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

返回值:

类型说明
Promise<WifiP2pLinkedInfo>Promise对象。表示P2P连接信息。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

	wifiManager.getP2pLinkedInfo((err, data) => {
    if (err) {
        console.error("get p2p linked info error");
        return;
    }
		console.info("get wifi p2p linked info: " + JSON.stringify(data));
	});

	wifiManager.getP2pLinkedInfo().then(data => {
		console.info("get wifi p2p linked info: " + JSON.stringify(data));
	});

WifiP2pLinkedInfo9+

提供WLAN连接的相关信息。

系统能力: SystemCapability.Communication.WiFi.P2P

名称类型可读可写说明
connectStateP2pConnectStateP2P连接状态。
isGroupOwnerboolean是否是群主。
groupOwnerAddrstring群组MAC地址。

P2pConnectState9+

表示P2P连接状态的枚举。

系统能力: SystemCapability.Communication.WiFi.P2P

名称说明
DISCONNECTED0断开状态。
CONNECTED1连接状态。

wifiManager.getP2pLinkedInfo9+

getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void

获取P2P连接信息,使用callback异步回调。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
callbackAsyncCallback<WifiP2pLinkedInfo>回调函数。当操作成功时,err为0,data表示P2P连接信息。如果error为非0,表示处理出现错误。

wifiManager.getCurrentGroup9+

getCurrentGroup(): Promise<WifiP2pGroupInfo>

获取P2P当前组信息,使用Promise异步回调。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

返回值:

类型说明
Promise<WifiP2pGroupInfo>Promise对象。表示当前组信息。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的deviceAddress为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.getCurrentGroup9+

getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void

获取P2P当前组信息,使用callback异步回调。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
callbackAsyncCallback<WifiP2pGroupInfo>回调函数。当操作成功时,err为0,data表示当前组信息。如果error为非0,表示处理出现错误。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的deviceAddress为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

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

wifiManager.getP2pPeerDevices9+

getP2pPeerDevices(): Promise<WifiP2pDevice[]>

获取P2P对端设备列表信息,使用Promise异步回调。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

返回值:

类型说明
Promise<WifiP2pDevice[]>Promise对象。表示对端设备列表信息。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的deviceAddress为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.getP2pPeerDevices9+

getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void

获取P2P对端设备列表信息,使用callback异步回调。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
callbackAsyncCallback<WifiP2pDevice[]>回调函数。当操作成功时,err为0,data表示对端设备列表信息。如果error为非0,表示处理出现错误。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的deviceAddress为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

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

WifiP2pDevice9+

表示P2P设备信息。

系统能力: SystemCapability.Communication.WiFi.P2P

名称类型可读可写说明
deviceNamestring设备名称。
deviceAddressstring设备MAC地址。
deviceAddressType10+DeviceAddressType设备MAC地址类型。
primaryDeviceTypestring主设备类型。
deviceStatusP2pDeviceStatus设备状态。
groupCapabilitiesnumber群组能力。

P2pDeviceStatus9+

表示设备状态的枚举。

系统能力: SystemCapability.Communication.WiFi.P2P

名称说明
CONNECTED0连接状态。
INVITED1邀请状态。
FAILED2失败状态。
AVAILABLE3可用状态。
UNAVAILABLE4不可用状态。

wifiManager.getP2pLocalDevice9+

getP2pLocalDevice(): Promise<WifiP2pDevice>

获取P2P本端设备信息,使用Promise异步回调。

需要权限: ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.P2P

返回值:

类型说明
Promise<WifiP2pDevice>Promise对象。表示本端设备信息。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.getP2pLocalDevice9+

getP2pLocalDevice(callback: AsyncCallback<WifiP2pDevice>): void

获取P2P本端设备信息,使用callback异步回调。

需要权限: ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
callbackAsyncCallback<WifiP2pDevice>回调函数。当操作成功时,err为0,data表示本端设备信息。如果error为非0,表示处理出现错误。

错误码:

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

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

wifiManager.createGroup9+

createGroup(config: WifiP2PConfig): void

创建群组。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
configWifiP2PConfig群组配置信息。如果DeviceAddressType未指定值,则DeviceAddressType默认为随机设备地址类型。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

	try {
		let config:wifiManager.WifiP2PConfig = {
			deviceAddress: "****",
			netId: 0,
			passphrase: "*****",
			groupName: "****",
			goBand: 0
		}
		wifiManager.createGroup(config);	
		
	}catch(error){
		console.error("failed:" + JSON.stringify(error));
	}

WifiP2PConfig9+

表示P2P配置信息。

系统能力: SystemCapability.Communication.WiFi.P2P

名称类型可读可写说明
deviceAddressstring设备地址。
deviceAddressType10+DeviceAddressType设备地址类型。
netIdnumber网络ID。创建群组时-1表示创建临时组,-2表示创建永久组。
passphrasestring群组密钥。
groupNamestring群组名称。
goBandGroupOwnerBand群组带宽。

GroupOwnerBand9+

表示群组带宽的枚举。

系统能力: SystemCapability.Communication.WiFi.P2P

名称说明
GO_BAND_AUTO0自动模式。
GO_BAND_2GHZ12GHZ。
GO_BAND_5GHZ25GHZ。

wifiManager.removeGroup9+

removeGroup(): void

移除群组。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.p2pConnect9+

p2pConnect(config: WifiP2PConfig): void

执行P2P连接。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
configWifiP2PConfig连接配置信息。如果DeviceAddressType未指定值,则DeviceAddressType默认为随机设备地址类型。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvP2pConnectionChangeFunc = (result:wifiManager.WifiP2pLinkedInfo) => {
      console.info("p2p connection change receive event: " + JSON.stringify(result));
      wifiManager.getP2pLinkedInfo((err, data) => {
          if (err) {
              console.error('failed to get getP2pLinkedInfo: ' + JSON.stringify(err));
              return;
          }
          console.info("get getP2pLinkedInfo: " + JSON.stringify(data));
      });
  }
  wifiManager.on("p2pConnectionChange", recvP2pConnectionChangeFunc);
  
  let recvP2pDeviceChangeFunc = (result:wifiManager.WifiP2pDevice) => {
      console.info("p2p device change receive event: " + JSON.stringify(result));
  }
  wifiManager.on("p2pDeviceChange", recvP2pDeviceChangeFunc);
  
  let recvP2pPeerDeviceChangeFunc = (result:wifiManager.WifiP2pDevice[]) => {
      console.info("p2p peer device change receive event: " + JSON.stringify(result));
      wifiManager.getP2pPeerDevices((err, data) => {
          if (err) {
              console.error('failed to get peer devices: ' + JSON.stringify(err));
              return;
          }
          console.info("get peer devices: " + JSON.stringify(data));
          let len = data.length;
          for (let i = 0; i < len; ++i) {
              if (data[i].deviceName === "my_test_device") {
                  console.info("p2p connect to test device: " + data[i].deviceAddress);
                  let config:wifiManager.WifiP2PConfig = {
                      deviceAddress:data[i].deviceAddress,
                      netId:-2,
                      passphrase:"",
                      groupName:"",
                      goBand:0,
                  }
                  wifiManager.p2pConnect(config);
              }
          }
      });
  }
  wifiManager.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);
  
  let recvP2pPersistentGroupChangeFunc = () => {
      console.info("p2p persistent group change receive event");
  
      wifiManager.getCurrentGroup((err, data) => {
          if (err) {
              console.error('failed to get current group: ' + JSON.stringify(err));
              return;
          }
          console.info("get current group: " + JSON.stringify(data));
      });
  }
  wifiManager.on("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);
  
  setTimeout(() => {wifiManager.off("p2pConnectionChange", recvP2pConnectionChangeFunc);}, 125 * 1000);
  setTimeout(() =>  {wifiManager.off("p2pDeviceChange", recvP2pDeviceChangeFunc);}, 125 * 1000);
  setTimeout(() =>  {wifiManager.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);}, 125 * 1000);
  setTimeout(() =>  {wifiManager.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);}, 125 * 1000);
  console.info("start discover devices -> " + wifiManager.startDiscoverDevices());

wifiManager.p2pCancelConnect9+

p2pCancelConnect(): void

取消P2P连接。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.startDiscoverDevices9+

startDiscoverDevices(): void

开始发现设备。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.stopDiscoverDevices9+

stopDiscoverDevices(): void

停止发现设备。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.deletePersistentGroup9+

deletePersistentGroup(netId: number): void

删除永久组。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
netIdnumber组的ID。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.getP2pGroups9+

getP2pGroups(): Promise<Array<WifiP2pGroupInfo>>

获取创建的所有P2P群组信息,使用Promise异步回调。

系统接口: 此接口为系统接口。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

返回值:

类型说明
Promise< Array<WifiP2pGroupInfo> >Promise对象。表示所有群组信息。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的deviceAddress为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

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

WifiP2pGroupInfo9+

表示P2P群组相关信息。

系统能力: SystemCapability.Communication.WiFi.P2P

名称类型可读可写说明
isP2pGoboolean是否是群主。
ownerInfoWifiP2pDevice群组的设备信息。
passphrasestring群组密钥。
interfacestring接口名称。
groupNamestring群组名称。
networkIdnumber网络ID。
frequencynumber群组的频率。
clientDevicesWifiP2pDevice[]接入的设备列表信息。
goIpAddressstring群组IP地址。

wifiManager.getP2pGroups9+

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

获取创建的所有P2P群组信息,使用callback方式作为异步方法。

系统接口: 此接口为系统接口。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
callbackAsyncCallback< Array<WifiP2pGroupInfo>>回调函数。当操作成功时,err为0,data表示所有群组信息。如果error为非0,表示处理出现错误。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的deviceAddress为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.setDeviceName9+

setDeviceName(devName: string): void

设置设备名称。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION,仅系统应用可用。

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
devNamestring设备名称。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

	import wifiManager from '@ohos.wifiManager';

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

wifiManager.on('wifiStateChange')9+

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

注册WLAN状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"wifiStateChange"字符串。
callbackCallback<number>状态改变回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

状态改变事件的枚举:

枚举值说明
0未激活。
1已激活。
2激活中。
3去激活中。

wifiManager.off('wifiStateChange')9+

off(type: "wifiStateChange", callback?: Callback<number>): void

取消注册WLAN状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"wifiStateChange"字符串。
callbackCallback<number>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvPowerNotifyFunc = (result:number) => {
      console.info("Receive power state change event: " + result);
  }
  
  // Register event
  wifiManager.on("wifiStateChange", recvPowerNotifyFunc);
  
  // Unregister event
  wifiManager.off("wifiStateChange", recvPowerNotifyFunc);

wifiManager.on('wifiConnectionChange')9+

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

注册WLAN连接状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"wifiConnectionChange"字符串。
callbackCallback<number>状态改变回调函数。

连接状态改变事件的枚举:

枚举值说明
0已断开。
1已连接。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

wifiManager.off('wifiConnectionChange')9+

off(type: "wifiConnectionChange", callback?: Callback<number>): void

取消注册WLAN连接状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"wifiConnectionChange"字符串。
callbackCallback<number>连接状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvWifiConnectionChangeFunc = (result:number) => {
      console.info("Receive wifi connection change event: " + result);
  }
  
  // Register event
  wifiManager.on("wifiConnectionChange", recvWifiConnectionChangeFunc);
  
  // Unregister event
  wifiManager.off("wifiConnectionChange", recvWifiConnectionChangeFunc);

wifiManager.on('wifiScanStateChange')9+

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

注册扫描状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"wifiScanStateChange"字符串。
callbackCallback<number>状态改变回调函数。

扫描状态改变事件的枚举:

枚举值说明
0扫描失败。
1扫描成功。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

wifiManager.off('wifiScanStateChange')9+

off(type: "wifiScanStateChange", callback?: Callback<number>): void

取消注册扫描状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"wifiScanStateChange"字符串。
callbackCallback<number>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvWifiScanStateChangeFunc = (result:number) => {
      console.info("Receive Wifi scan state change event: " + result);
  }
  
  // Register event
  wifiManager.on("wifiScanStateChange", recvWifiScanStateChangeFunc);
  
  // Unregister event
  wifiManager.off("wifiScanStateChange", recvWifiScanStateChangeFunc);

wifiManager.on('wifiRssiChange')9+

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

注册RSSI状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"wifiRssiChange"字符串。
callbackCallback<number>状态改变回调函数,返回以dBm为单位的RSSI值。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

wifiManager.off('wifiRssiChange')9+

off(type: "wifiRssiChange", callback?: Callback<number>): void

取消注册RSSI状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"wifiRssiChange"字符串。
callbackCallback<number>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvWifiRssiChangeFunc = (result:number) => {
      console.info("Receive wifi rssi change event: " + result);
  }
  
  // Register event
  wifiManager.on("wifiRssiChange", recvWifiRssiChangeFunc);
  
  // Unregister event
  wifiManager.off("wifiRssiChange", recvWifiRssiChangeFunc);

wifiManager.on('streamChange')9+

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

注册WIFI流变更事件,当前版本不支持,抛出通用错误码801。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.MANAGE_WIFI_CONNECTION

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"streamChange"字符串。
callbackCallback<number>状态改变回调函数,返回0:无,1:向下,2:向上,3:双向。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

wifiManager.off('streamChange')9+

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

取消注册WIFI流变更事件,当前版本不支持,抛出通用错误码801。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.MANAGE_WIFI_CONNECTION

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"streamChange"字符串。
callbackCallback<number>状态改变回调函数,返回0:无,1:向下,2:向上,3:双向。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

import wifi from '@ohos.wifi';

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

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

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

wifiManager.on('deviceConfigChange')9+

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

注册WIFI设备配置更改事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"streamChange"字符串。
callbackCallback<number>状态改变回调函数,返回0: 添加配置, 1: 更改配置, 2: 删除配置.

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

wifiManager.off('deviceConfigChange')9+

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

取消注册WIFI设备配置更改事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.STA

参数:

参数名类型必填说明
typestring固定填"streamChange"字符串。
callbackCallback<number>状态改变回调函数,返回0: 添加配置, 1: 更改配置, 2: 删除配置.

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

import wifi from '@ohos.wifiManager';

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

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

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

wifiManager.on('hotspotStateChange')9+

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

注册热点状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.AP.Core

参数:

参数名类型必填说明
typestring固定填"hotspotStateChange"字符串。
callbackCallback<number>状态改变回调函数。

热点状态改变事件的枚举:

枚举值说明
0未激活。
1已激活。
2激活中。
3去激活中。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

wifiManager.off('hotspotStateChange')9+

off(type: "hotspotStateChange", callback?: Callback<number>): void

取消注册热点状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.AP.Core

参数:

参数名类型必填说明
typestring固定填"hotspotStateChange"字符串。
callbackCallback<number>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvHotspotStateChangeFunc = (result:number) => {
      console.info("Receive hotspot state change event: " + result);
  }
  
  // Register event
  wifiManager.on("hotspotStateChange", recvHotspotStateChangeFunc);
  
  // Unregister event
  wifiManager.off("hotspotStateChange", recvHotspotStateChangeFunc);

wifiManager.on('hotspotStaJoin')9+

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

注册wifi热点sta加入事件。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.MANAGE_WIFI_HOTSPOT

系统能力: SystemCapability.Communication.WiFi.AP.Core

参数:

参数名类型必填说明
typestring固定填"hotspotStaJoin"字符串。
callbackCallback<StationInfo>状态改变回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

wifiManager.off('hotspotStaJoin')9+

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

取消注册wifi热点sta加入事件。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.MANAGE_WIFI_HOTSPOT

系统能力: SystemCapability.Communication.WiFi.AP.Core

参数:

参数名类型必填说明
typestring固定填"hotspotStaJoin"字符串。
callbackCallback<StationInfo>状态改变回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

示例:

import wifiManager from '@ohos.wifiManager';

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

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

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

wifiManager.on('hotspotStaLeave')9+

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

注册wifi热点sta离开事件。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.MANAGE_WIFI_HOTSPOT

系统能力: SystemCapability.Communication.WiFi.AP.Core

参数:

参数名类型必填说明
typestring固定填"hotspotStaLeave"字符串。
callbackCallback<StationInf]>状态改变回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2601000Operation failed.

wifiManager.off('hotspotStaLeave')7+

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

取消注册wifi热点sta离开事件。

系统接口: 此接口为系统接口。

需要权限: ohos.permission.MANAGE_WIFI_HOTSPOT

系统能力: SystemCapability.Communication.WiFi.AP.Core

参数:

参数名类型必填说明
typestring固定填"hotspotStaLeave"字符串。
callbackCallback<StationInf]>状态改变回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2501000Operation failed.

示例:

import wifiManager from '@ohos.wifiManager';

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

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

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

wifiManager.on('p2pStateChange')9+

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

注册P2P开关状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pStateChange"字符串。
callbackCallback<number>状态改变回调函数。

** P2P状态改变事件的枚举:**

枚举值说明
1空闲。
2打开中。
3已打开。
4关闭中。
5已关闭。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.off('p2pStateChange')9+

off(type: "p2pStateChange", callback?: Callback<number>): void

取消注册P2P开关状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pStateChange"字符串。
callbackCallback<number>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvP2pStateChangeFunc = (result:number) => {
      console.info("Receive p2p state change event: " + result);
  }
  
  // Register event
  wifiManager.on("p2pStateChange", recvP2pStateChangeFunc);
  
  // Unregister event
  wifiManager.off("p2pStateChange", recvP2pStateChangeFunc);

wifiManager.on('p2pConnectionChange')9+

on(type: "p2pConnectionChange", callback: Callback<WifiP2pLinkedInfo>): void

注册P2P连接状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pConnectionChange"字符串。
callbackCallback<WifiP2pLinkedInfo>状态改变回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.off('p2pConnectionChange')9+

off(type: "p2pConnectionChange", callback?: Callback<WifiP2pLinkedInfo>): void

取消注册P2P连接状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pConnectionChange"字符串。
callbackCallback<WifiP2pLinkedInfo>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvP2pConnectionChangeFunc = (result:wifiManager.WifiP2pLinkedInfo) => {
      console.info("Receive p2p connection change event: " + result);
  }
  
  // Register event
  wifiManager.on("p2pConnectionChange", recvP2pConnectionChangeFunc);
  
  // Unregister event
  wifiManager.off("p2pConnectionChange", recvP2pConnectionChangeFunc);

wifiManager.on('p2pDeviceChange')9+

on(type: "p2pDeviceChange", callback: Callback<WifiP2pDevice>): void

注册P2P设备状态改变事件。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pDeviceChange"字符串。
callbackCallback<WifiP2pDevice>状态改变回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.off('p2pDeviceChange')9+

off(type: "p2pDeviceChange", callback?: Callback<WifiP2pDevice>): void

取消注册P2P设备状态改变事件。

需要权限:

API 9:ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:无

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pDeviceChange"字符串。
callbackCallback<WifiP2pDevice>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvP2pDeviceChangeFunc = (result:wifiManager.WifiP2pDevice) => {
      console.info("Receive p2p device change event: " + result);
  }
  
  // Register event
  wifiManager.on("p2pDeviceChange", recvP2pDeviceChangeFunc);
  
  // Unregister event
  wifiManager.off("p2pDeviceChange", recvP2pDeviceChangeFunc);

wifiManager.on('p2pPeerDeviceChange')9+

on(type: "p2pPeerDeviceChange", callback: Callback<WifiP2pDevice[]>): void

注册P2P对端设备状态改变事件。

需要权限:

API 9:ohos.permission.GET_WIFI_INFO、ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pPeerDeviceChange"字符串。
callbackCallback<WifiP2pDevice[]>状态改变回调函数。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的deviceAddress为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.off('p2pPeerDeviceChange')9+

off(type: "p2pPeerDeviceChange", callback?: Callback<WifiP2pDevice[]>): void

取消注册P2P对端设备状态改变事件。

需要权限:

API 9:ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION

API 10起:无

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pPeerDeviceChange"字符串。
callbackCallback<WifiP2pDevice[]>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。如果应用申请了ohos.permission.GET_WIFI_PEERS_MAC权限,则返回结果中的deviceAddress为真实设备地址,否则为随机设备地址。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvP2pPeerDeviceChangeFunc = (result:wifiManager.WifiP2pDevice[]) => {
      console.info("Receive p2p peer device change event: " + result);
  }
  
  // Register event
  wifiManager.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);
  
  // Unregister event
  wifiManager.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);

wifiManager.on('p2pPersistentGroupChange')9+

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

注册P2P永久组状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pPersistentGroupChange"字符串。
callbackCallback<void>状态改变回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.off('p2pPersistentGroupChange')9+

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

取消注册P2P永久组状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pPersistentGroupChange"字符串。
callbackCallback<void>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvP2pPersistentGroupChangeFunc = (result:void) => {
      console.info("Receive p2p persistent group change event: " + result);
  }
  
  // Register event
  wifiManager.on("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);
  
  // Unregister event
  wifiManager.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);

wifiManager.on('p2pDiscoveryChange')9+

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

注册发现设备状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pDiscoveryChange"字符串。
callbackCallback<number>状态改变回调函数。

发现设备状态改变事件的枚举:

枚举值说明
0初始状态。
1发现成功。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

wifiManager.off('p2pDiscoveryChange')9+

off(type: "p2pDiscoveryChange", callback?: Callback<number>): void

取消注册发现设备状态改变事件。

需要权限: ohos.permission.GET_WIFI_INFO

系统能力: SystemCapability.Communication.WiFi.P2P

参数:

参数名类型必填说明
typestring固定填"p2pDiscoveryChange"字符串。
callbackCallback<number>状态改变回调函数。如果callback不填,将取消注册该事件关联的所有回调函数。

错误码:

以下错误码的详细介绍请参见WIFI错误码

错误码ID错误信息
2801000Operation failed.

示例:

  import wifiManager from '@ohos.wifiManager';
  
  let recvP2pDiscoveryChangeFunc = (result:number) => {
      console.info("Receive p2p discovery change event: " + result);
  }
  
  // Register event
  wifiManager.on("p2pDiscoveryChange", recvP2pDiscoveryChangeFunc);
  
  // Unregister event
  wifiManager.off("p2pDiscoveryChange", recvP2pDiscoveryChangeFunc);

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述(仅对系统应用开放)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

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