From 7cca9cae05c1d3d75fc5a229182a55ff13e8a59e Mon Sep 17 00:00:00 2001 From: liujiaojiao Date: Wed, 26 Jul 2023 19:38:27 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E6=8E=A5=E5=8F=A3=EF=BC=8C?= =?UTF-8?q?=E6=8E=A5=E5=8F=A3=E5=90=8D=E7=A7=B0=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: liujiaojiao --- .../reference/apis/js-apis-wifi.md | 154 +++++- .../reference/apis/js-apis-wifiManager.md | 458 +++++++++++++++--- 2 files changed, 543 insertions(+), 69 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifi.md b/zh-cn/application-dev/reference/apis/js-apis-wifi.md index 5c806e4f03..d1c1cd4080 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifi.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifi.md @@ -569,7 +569,7 @@ connectToDevice(config: WifiDeviceConfig): boolean **系统接口：** 此接口为系统接口。 **需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 - + **系统能力：** SystemCapability.Communication.WiFi.STA @@ -2254,7 +2254,58 @@ wifi.on("wifiRssiChange", recvWifiRssiChangeFunc); // Unregister event wifi.off("wifiRssiChange", recvWifiRssiChangeFunc); + +``` +## wifi.on('streamChange')7+ + +on(type: "streamChange", callback: Callback<number>): void + +注册WIFI流更改事件。 + +**需要权限：** ohos.permission.MANAGE_WIFI_CONNECTION + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 固定填"streamChange"字符串。 | + | callback | Callback<number> | 是 | 状态改变回调函数，返回0:无，1：向下，2：向上，3：双向。 | + +## wifi.off('streamChange')7+ + +off(type: "streamChange", callback: Callback<number>): void + +取消注册WIFI流更改事件。 + +**需要权限：** ohos.permission.MANAGE_WIFI_CONNECTION + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 固定填"streamChange"字符串。 | + | callback | Callback<number> | 是 | 状态改变回调函数，返回0:无，1：向下，2：向上，3：双向。 | + +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvStreamChangeFunc = result => { + console.info("Receive stream change event: " + result); +} + +// Register event +wifi.on("streamChange", recvStreamChangeFunc); + +// Unregister event +wifi.off("streamChange", recvStreamChangeFunc); + ``` + ## wifi.on('hotspotStateChange')7+ on(type: "hotspotStateChange", callback: Callback<number>): void @@ -2313,6 +2364,105 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void | type | string | 是 | 固定填"hotspotStateChange"字符串。 | | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | +## wifi.on('hotspotStaJoin')7+ + +on(type: "hotspotStaJoin", callback: Callback<StationInfo>): void + +注册wifi热点sta加入事件。 + +**需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT + +**系统能力：** SystemCapability.Communication.WiFi.AP.Core + +**参数：** + + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 固定填"hotspotStaJoin"字符串。 | + | callback | Callback<StationInfo> | 是 | 状态改变回调函数。 | + +## wifi.off('hotspotStaJoin')7+ + +off(type: "hotspotStaJoin", callback: Callback<StationInfo>): void + +取消注册wifi热点sta加入事件。 + +**需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT + +**系统能力：** SystemCapability.Communication.WiFi.AP.Core + +**参数：** + + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 固定填"hotspotStaJoin"字符串。 | + | callback | Callback<StationInfo> | 是 | 状态改变回调函数。 | + + **示例：** +```js +import wifi from '@ohos.wifi'; + +var recvHotspotStaJoinFunc = result => { + console.info("Receive hotspot sta join event: " + result); +} + +// Register event +wifi.on("hotspotStaJoin", recvHotspotStaJoinFunc); + +// Unregister event +wifi.off("hotspotStaJoin", recvHotspotStaJoinFunc); + +``` + +## wifi.on('hotspotStaLeave')7+ + +on(type: "hotspotStaLeave", callback: Callback<StationInfo>): void + +注册wifi热点sta离开事件。 + +**需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT + +**系统能力：** SystemCapability.Communication.WiFi.AP.Core + +**参数：** + + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 固定填"hotspotStaLeave"字符串。 | + | callback | Callback<StationInf]> | 是 | 状态改变回调函数。 | + +## wifi.off('hotspotStaLeave')7+ + +off(type: "hotspotStaLeave", callback: Callback<StationInfo>): void + +取消注册wifi热点sta离开事件。 + +**需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT + +**系统能力：** SystemCapability.Communication.WiFi.AP.Core + +**参数：** + + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 固定填"hotspotStaLeave"字符串。 | + | callback | Callback<StationInf]> | 是 | 状态改变回调函数。 | + + **示例：** +```js +import wifi from '@ohos.wifi'; + +var recvHotspotStaLeaveFunc = result => { + console.info("Receive hotspot sta leave event: " + result); +} + +// Register event +wifi.on("hotspotStaLeave", recvHotspotStaLeaveFunc); + +// Unregister event +wifi.off("hotspotStaLeave", recvHotspotStaLeaveFunc); + +``` ## wifi.on('p2pStateChange')8+ @@ -2373,7 +2523,7 @@ wifi.on("p2pStateChange", recvP2pStateChangeFunc); wifi.off("p2pStateChange", recvP2pStateChangeFunc); ``` - ## wifi.on('p2pConnectionChange')8+ +## wifi.on('p2pConnectionChange')8+ on(type: "p2pConnectionChange", callback: Callback<WifiP2pLinkedInfo>): void diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md b/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md index c93a8d0e7d..0bdb1e7994 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md @@ -13,7 +13,7 @@ import wifiManager from '@ohos.wifiManager'; ## wifiManager.enableWifi9+ -enableWifi(): boolean +enableWifi(): void 使能WLAN。 @@ -23,12 +23,6 @@ enableWifi(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA -**返回值：** - - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。| - **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 @@ -51,7 +45,7 @@ enableWifi(): boolean ## wifiManager.disableWifi9+ -disableWifi(): boolean +disableWifi(): void 去使能WLAN。 @@ -61,12 +55,6 @@ disableWifi(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA -**返回值：** - - | **类型** | **说明** | - | -------- | -------- | - | boolean | true:操作成功， false:操作失败。| - **错误码：** 以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 @@ -126,7 +114,7 @@ isWifiActive(): boolean ## wifiManager.scan9+ -scan(): boolean +scan(): void 启动WLAN扫描。 @@ -134,11 +122,37 @@ scan(): boolean **系统能力：** SystemCapability.Communication.WiFi.STA -**返回值：** +**错误码：** - | **类型** | **说明** | +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **错误码ID** | **错误信息** | | -------- | -------- | - | boolean | true:扫描操作执行成功， false:扫描操作执行失败。 | +| 2501000 | Operation failed.| + +**示例：** + +```js + 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 **错误码：** @@ -154,19 +168,161 @@ scan(): boolean import wifiManager from '@ohos.wifiManager'; try { - wifiManager.scan(); + wifiManager.startScan(); }catch(error){ console.error("failed:" + JSON.stringify(error)); } ``` +## wifiManager.getScanResults10+ + +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](#wifiscaninfo)> > | Promise对象。返回扫描到的热点列表。 | + +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 -## wifiManager.getScanInfoList9+ +| **错误码ID** | **错误信息** | +| -------- | -------- | +| 2501000 | Operation failed.| + +## wifiManager.getScanResults10+ + +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 + +**参数：** +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | 是 | 回调函数。当成功时，err为0，data为扫描到的热点；否则err为非0值，data为空。 | + | Array<[WifiScanInfo](#wifiscaninfo)> | 返回扫描到的热点列表。 | + +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **错误码ID** | **错误信息** | +| -------- | -------- | +| 2501000 | Operation failed.| + +**示例：** +```js + import wifiManager from '@ohos.wifiManager'; + + wifiManager.getScanResults((err, result) => { + if (err) { + console.error("get scan info error"); + return; + } + + var len = Object.keys(result).length; + console.log("wifi received scan info: " + len); + for (var i = 0; i < len; ++i) { + console.info("ssid: " + result[i].ssid); + console.info("bssid: " + result[i].bssid); + console.info("capabilities: " + result[i].capabilities); + console.info("securityType: " + result[i].securityType); + console.info("rssi: " + result[i].rssi); + console.info("band: " + result[i].band); + console.info("frequency: " + result[i].frequency); + console.info("channelWidth: " + result[i].channelWidth); + console.info("timestamp: " + result[i].timestamp); + } + }); + + wifiManager.getScanResults().then(result => { + var len = Object.keys(result).length; + console.log("wifi received scan info: " + len); + for (var i = 0; i < len; ++i) { + console.info("ssid: " + result[i].ssid); + console.info("bssid: " + result[i].bssid); + console.info("capabilities: " + result[i].capabilities); + console.info("securityType: " + result[i].securityType); + console.info("rssi: " + result[i].rssi); + console.info("band: " + result[i].band); + console.info("frequency: " + result[i].frequency); + console.info("channelWidth: " + result[i].channelWidth); + console.info("timestamp: " + result[i].timestamp); + } + }); +``` + +## wifiManager.getScanResultsSync10+ + +getScanResultsSync():  Array<[WifiScanInfo](#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](#wifiscaninfo)> | 扫描结果数组。 | + +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **错误码ID** | **错误信息** | + | -------- | -------- | +| 2501000 | Operation failed.| + +**示例：** + +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let scanInfoList = wifiManager.getScanResultsSync(); + console.info("scanInfoList:" + JSON.stringify(scanInfoList)); + let len = Object.keys(scanInfoList).length; + console.log("wifi received scan info: " + len); + if(len > 0){ + for (var 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 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 (ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION)) +**需要权限：** ohos.permission.GET_WIFI_INFO **系统能力：** SystemCapability.Communication.WiFi.STA @@ -224,6 +380,7 @@ WLAN热点信息。 | -------- | -------- | -------- | -------- | -------- | | ssid | string | 是 | 否 | 热点的SSID，编码格式为UTF-8。 | | bssid | string | 是 | 否 | 热点的BSSID。 | +| bssidType10+| DeviceAddressType | 是 | 否 | 热点的BSSID类型。 | | capabilities | string | 是 | 否 | 热点能力。 | | securityType | [WifiSecurityType](#wifisecuritytype) | 是 | 否 | WLAN加密类型。 | | rssi | number | 是 | 否 | 热点的信号强度(dBm)。 | @@ -235,6 +392,16 @@ WLAN热点信息。 | infoElems | Array<[WifiInfoElem](#wifiinfoelem9)> | 是 | 否 | 信息元素。 | | timestamp | number | 是 | 否 | 时间戳。 | +## DeviceAddressType 10+ + +wifi 设备地址（mac/bissid）类型。 + +**系统能力：** SystemCapability.Communication.WiFi.Core + +| **名称** | **值** | **说明** | +| -------- | -------- | -------- | +| RANDOM_DEVICE_ADDRESS | 0 | 随机设备地址。 | +| REAL_DEVICE_ADDRESS | 1 | 真实设备地址。 | ## WifiSecurityType9+ @@ -317,6 +484,83 @@ WLAN热点信息。 | WIDTH_80MHZ_PLUS | 4 | 80MHZ+。 | | WIDTH_INVALID | 5 | 无效值 | +## wifiManager.setScanAlwaysAllowed10+ + +setScanAlwaysAllowed(isScanAlwaysAllowed: boolean): void + +设置是否始终允许扫描。 + +**系统接口：** 此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| isScanAlwaysAllowed | boolean | 是 | 是否始终允许扫描。 | + +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **错误码ID** | **错误信息** | + | -------- | -------- | +| 2501000 | Operation failed.| + +```js + 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.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + +| **类型** | **说明** | +| -------- | -------- | +| boolean| 是否始终允许扫描。 true 表示允许触发扫描，false表示在禁用wifi时不允许触发扫描| + +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **错误码ID** | **错误信息** | + | -------- | -------- | +| 2501000 | Operation failed.| + +**示例：** + +```js + import wifiManager from '@ohos.wifiManager'; + + try { + let isScanAlwaysAllowed = wifiManager.getScanAlwaysAllowed(); + console.info("isScanAlwaysAllowed:" + ret); + }catch(error){ + console.error("failed:" + JSON.stringify(error)); + } +``` + ## wifiManager.addDeviceConfig9+ addDeviceConfig(config: WifiDeviceConfig): Promise<number> @@ -379,6 +623,7 @@ WLAN配置信息。 | -------- | -------- | -------- | -------- | -------- | | ssid | string | 是 | 否 | 热点的SSID，编码格式为UTF-8。 | | bssid | string | 是 | 否 | 热点的BSSID。 | +| bssidType10+ | DeviceAddressType | 是 | 否 | 热点的BSSID类型。 | | preSharedKey | string | 是 | 否 | 热点的密钥。 | | isHiddenSsid | boolean | 是 | 否 | 是否是隐藏网络。 | | securityType | [WifiSecurityType](#wifisecuritytype) | 是 | 否 | 加密类型。 | @@ -389,8 +634,8 @@ WLAN配置信息。 | randomMacAddr | string | 是 | 否 | 随机MAC地址。
**系统接口：** 此接口为系统接口。 | | ipType | [IpType](#iptype9) | 是 | 否 | IP地址类型。
**系统接口：** 此接口为系统接口。 | | staticIp | [IpConfig](#ipconfig9) | 是 | 否 | 静态IP配置信息。
**系统接口：** 此接口为系统接口。 | -| eapConfig9+ | [WifiEapConfig](#wifieapconfig9) | 是 | 否 | 可扩展身份验证协议配置。
**系统接口：** 此接口为系统接口。 | - +| eapConfig10+ | [WifiEapConfig](#wifieapconfig10) | 是 | 否 | 可扩展身份验证协议配置。 | +| proxyConfig10+ | WifiProxyConfig | 是 | 否 | 代理配置。
**系统接口：** 此接口为系统接口。| ## IpType9+ @@ -425,18 +670,16 @@ IP配置信息。 | domains | Array<string> | 是 | 否 | 域信息。 | -## WifiEapConfig9+ +## WifiEapConfig10+ 可扩展身份验证协议配置信息。 -**系统接口：** 此接口为系统接口。 - **系统能力：** SystemCapability.Communication.WiFi.STA | **名称** | **类型** | **可读** | **可写** | **说明** | | -------- | -------- | -------- | -------- | -------- | -| eapMethod | [EapMethod](#eapmethod9) | 是 | 否 | EAP认证方式。 | -| phase2Method | [Phase2Method](#phase2method9) | 是 | 否 | 第二阶段认证方式。 | +| eapMethod | [EapMethod](#eapmethod10) | 是 | 否 | EAP认证方式。 | +| phase2Method | [Phase2Method](#phase2method10) | 是 | 否 | 第二阶段认证方式。 | | identity | string | 是 | 否 | 身份信息。 | | anonymousIdentity | string | 是 | 否 | 匿名身份。 | | password | string | 是 | 否 | 密码。 | @@ -452,12 +695,10 @@ IP配置信息。 | eapSubId | number | 是 | 否 | SIM卡的子ID。 | -## EapMethod9+ +## EapMethod10+ 表示EAP认证方式的枚举。 -**系统接口：** 此接口为系统接口。 - **系统能力：** SystemCapability.Communication.WiFi.STA | 名称 | 值 | 说明 | @@ -473,12 +714,10 @@ IP配置信息。 | EAP_UNAUTH_TLS | 8 | UNAUTH TLS类型。 | -## Phase2Method9+ +## Phase2Method10+ 表示第二阶段认证方式的枚举。 -**系统接口：** 此接口为系统接口。 - **系统能力：** SystemCapability.Communication.WiFi.STA | 名称 | 值 | 说明 | @@ -493,6 +732,36 @@ IP配置信息。 | PHASE2_AKA_PRIME | 7 | AKA Prime类型。 | +## WifiProxyConfig 10+ + +Wifi 代理配置。 + +**系统接口：** 此接口为系统接口。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| **名称** | **类型** | **可读** | **可写** | **说明** | +| -------- | -------- | -------- | -------- | -------- | +| proxyMethod | ProxyMethod | 是 | 否 | 代理方法 | +| pacWebAddress | string | 是 | 否 | 自动配置代理的PAC web 地址。 | +| serverHostName | string | 是 | 否 | 手动配置代理的服务器主机名。 | +| serverPort | string | 是 | 否 | 手动配置代理的服务器端口。 | +| exclusionObjects | string | 是 | 否 | 手动配置代理的排除对象，对象用“,”分隔。| + +## ProxyMethod10+ + +表示WiFi代理方法的枚举。 + +**系统接口：** 此接口为系统接口。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| 名称 | 值 | 说明 | +| -------- | -------- | -------- | +| METHOD_NONE | 0 | 不使用代理。 | +| METHOD_AUTO | 1 | 使用自动配置的代理。 | +| METHOD_MANUAL | 2 | 使用手动配置的代理。 | + ## wifiManager.addDeviceConfig9+ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>): void @@ -1331,6 +1600,58 @@ IP信息。 | leaseDuration | number | 是 | 否 | IP地址租用时长。 | +## wifiManager.getIpv6Info10+ + +getIpv6Info(): Ipv6Info + +获取IP信息。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + +| **类型** | **说明** | +| -------- | -------- | +| Ipv6Info | Ipv6信息。 | + +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **错误码ID** | **错误信息** | + | -------- | -------- | +| 2501000 | Operation failed.| + +**示例：** +```js + 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 + +| **名称** | **类型** | **可读** | **可写** | **说明** | +| -------- | -------- | -------- | -------- | -------- | +| linkIpv6Address | string | 是 | 否 | 链路Ipv6地址。 | +| globalIpv6Address | string | 是 | 否 | 全局Ipv6地址。 | +| randomGlobalIpv6Address | number | 是 | 否 | 随机全局Ipv6地址。 | +| gateway | string | 是 | 否 | 网关。 | +| netmask | string | 是 | 否 | 网络掩码。 | +| primaryDNS | string | 是 | 否 | 主DNS服务器Ipv6地址。 | +| secondDNS | string | 是 | 否 | 备DNS服务器Ipv6地址。 | + + ## wifiManager.getCountryCode9+ getCountryCode(): string @@ -1469,9 +1790,9 @@ getDeviceConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> } ``` -## wifiManager.updateDeviceConfig9+ +## wifiManager.updateNetwork9+ -updateDeviceConfig(config: WifiDeviceConfig): number +updateNetwork(config: WifiDeviceConfig): number 更新网络配置。 @@ -1511,16 +1832,16 @@ updateDeviceConfig(config: WifiDeviceConfig): number preSharedKey : "****", securityType : 3 } - let ret = wifiManager.updateDeviceConfig(config); + let ret = wifiManager.updateNetwork(config); console.error("ret:" + ret); }catch(error){ console.error("failed:" + JSON.stringify(error)); } ``` -## wifiManager.disableDeviceConfig9+ +## wifiManager.disableNetwork9+ -disableDeviceConfig(networkId: number): void +disableNetwork(networkId: number): void 去使能网络配置。 @@ -1550,15 +1871,15 @@ disableDeviceConfig(networkId: number): void try { let netId = 0; - wifiManager.disableDeviceConfig(netId); + wifiManager.disableNetwork(netId); }catch(error){ console.error("failed:" + JSON.stringify(error)); } ``` -## wifiManager.removeAllDeviceConfigs9+ +## wifiManager.removeAllNetwork9+ -removeAllDeviceConfigs(): void +removeAllNetwork(): void 移除所有网络配置。 @@ -1581,15 +1902,15 @@ removeAllDeviceConfigs(): void import wifiManager from '@ohos.wifiManager'; try { - wifiManager.removeAllDeviceConfigs(); + wifiManager.removeAllNetwork(); }catch(error){ console.error("failed:" + JSON.stringify(error)); } ``` -## wifiManager.removeDeviceConfig9+ +## wifiManager.removeDevice9+ -removeDeviceConfig(networkId: number): void +removeDevice(networkId: number): void 移除指定的网络配置。 @@ -1619,7 +1940,7 @@ removeDeviceConfig(networkId: number): void try { let id = 0; - wifiManager.removeDeviceConfig(id); + wifiManager.removeDevice(id); }catch(error){ console.error("failed:" + JSON.stringify(error)); } @@ -1996,9 +2317,9 @@ getHotspotConfig(): HotspotConfig } ``` -## wifiManager.getHotspotStations9+ +## wifiManager.getStations9+ -getHotspotStations():  Array<[StationInfo](#stationinfo9)> +getStations():  Array<[StationInfo](#stationinfo9)> 获取连接的设备。 @@ -2027,7 +2348,7 @@ getHotspotStations():  Array<[StationInfo](#stationinfo9)> import wifiManager from '@ohos.wifiManager'; try { - let stations = wifiManager.getHotspotStations(); + let stations = wifiManager.getStations(); console.info("result:" + JSON.stringify(stations)); }catch(error){ console.error("failed:" + JSON.stringify(error)); @@ -2046,6 +2367,7 @@ getHotspotStations():  Array<[StationInfo](#stationinfo9)> | -------- | -------- | -------- | -------- | -------- | | name | string | 是 | 否 | 设备名称。 | | macAddress | string | 是 | 否 | MAC地址。 | +| macAddressType10+ | DeviceAddressType | 是 | 否 | MAC地址类型。 | | ipAddress | string | 是 | 否 | IP地址。 | @@ -2273,6 +2595,7 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void | -------- | -------- | -------- | -------- | -------- | | deviceName | string | 是 | 否 | 设备名称。 | | deviceAddress | string | 是 | 否 | 设备MAC地址。 | +| deviceAddressType10+ | DeviceAddressType | 是 | 否 | 设备MAC地址类型。 | | primaryDeviceType | string | 是 | 否 | 主设备类型。 | | deviceStatus | [P2pDeviceStatus](#p2pdevicestatus9) | 是 | 否 | 设备状态。 | | groupCapabilities | number | 是 | 否 | 群组能力。 | @@ -2356,9 +2679,9 @@ getP2pLocalDevice(callback: AsyncCallback<WifiP2pDevice>): void }); ``` -## wifiManager.createP2pGroup9+ +## wifiManager.createGroup9+ -createP2pGroup(config: WifiP2PConfig): void +createGroup(config: WifiP2PConfig): void 创建群组。 @@ -2392,7 +2715,7 @@ createP2pGroup(config: WifiP2PConfig): void groupName: "****", goBand: 0 } - wifiManager.createP2pGroup(config); + wifiManager.createGroup(config); }catch(error){ console.error("failed:" + JSON.stringify(error)); @@ -2408,6 +2731,7 @@ createP2pGroup(config: WifiP2PConfig): void | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | deviceAddress | string | 是 | 否 | 设备地址。 | +| deviceAddressType10+| DeviceAddressType | 是 | 否 | 设备地址类型。 | | netId | number | 是 | 否 | 网络ID。创建群组时-1表示创建临时组，-2表示创建永久组。 | | passphrase | string | 是 | 否 | 群组密钥。 | | groupName | string | 是 | 否 | 群组名称。 | @@ -2427,9 +2751,9 @@ createP2pGroup(config: WifiP2PConfig): void | GO_BAND_5GHZ | 2 | 5GHZ。 | -## wifiManager.removeP2pGroup9+ +## wifiManager.removeGroup9+ -removeP2pGroup(): void +removeGroup(): void 移除群组。 @@ -2450,7 +2774,7 @@ removeP2pGroup(): void import wifiManager from '@ohos.wifiManager'; try { - wifiManager.removeP2pGroup(); + wifiManager.removeGroup(); }catch(error){ console.error("failed:" + JSON.stringify(error)); } @@ -2576,9 +2900,9 @@ p2pCancelConnect(): void } ``` -## wifiManager.startDiscoverP2pDevices9+ +## wifiManager.startDiscoverDevices10+ -startDiscoverP2pDevices(): void +startDiscoverDevices(): void 开始发现设备。 @@ -2599,15 +2923,15 @@ startDiscoverP2pDevices(): void import wifiManager from '@ohos.wifiManager'; try { - wifiManager.startDiscoverP2pDevices(); + wifiManager.startDiscoverDevices(); }catch(error){ console.error("failed:" + JSON.stringify(error)); } ``` -## wifiManager.stopDiscoverP2pDevices9+ +## wifiManager.stopDiscoverDevices10+ -stopDiscoverP2pDevices(): void +stopDiscoverDevices(): void 停止发现设备。 @@ -2628,15 +2952,15 @@ stopDiscoverP2pDevices(): void import wifiManager from '@ohos.wifiManager'; try { - wifiManager.stopDiscoverP2pDevices(); + wifiManager.stopDiscoverDevices(); }catch(error){ console.error("failed:" + JSON.stringify(error)); } ``` -## wifiManager.deletePersistentP2pGroup9+ +## wifiManager.deletePersistentGroup9+ -deletePersistentP2pGroup(netId: number): void +deletePersistentGroup(netId: number): void 删除永久组。 @@ -2667,7 +2991,7 @@ deletePersistentP2pGroup(netId: number): void try { let netId = 0; - wifiManager.deletePersistentP2pGroup(netId); + wifiManager.deletePersistentGroup(netId); }catch(error){ console.error("failed:" + JSON.stringify(error)); } @@ -2762,9 +3086,9 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): void | -------- | -------- | | 2801000 | Operation failed.| -## wifiManager.setP2pDeviceName9+ +## wifiManager.setDeviceName9+ -setP2pDeviceName(devName: string): void +setDeviceName(devName: string): void 设置设备名称。 @@ -2794,7 +3118,7 @@ setP2pDeviceName(devName: string): void try { let name = "****"; - wifiManager.setP2pDeviceName(name); + wifiManager.setDeviceName(name); }catch(error){ console.error("failed:" + JSON.stringify(error)); } -- GitLab