From 557b3d039fa7fee3450b20f6cf733c5a22908c46 Mon Sep 17 00:00:00 2001 From: zhangfeng Date: Wed, 27 Jul 2022 06:51:47 +0000 Subject: [PATCH] update wifi docs Signed-off-by: zhangfeng --- .../reference/apis/js-apis-wifi.md | 1177 ++++++++++++++--- .../reference/apis/js-apis-wifiext.md | 77 +- 2 files changed, 1034 insertions(+), 220 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 3e164fdca9a..1e1b0112344 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifi.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifi.md @@ -1,4 +1,5 @@ # WLAN +该模块主要提供WLAN基础功能、P2P（peer-to-peer）功能和WLAN消息通知的相应服务，让应用可以通过WLAN和其他设备互联互通。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -10,11 +11,45 @@ import wifi from '@ohos.wifi'; ``` +## wifi.enableWifi + +enableWifi(): boolean + +使能WLAN。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。| + + +## wifi.disableWifi + +disableWifi(): boolean + +去使能WLAN。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。| + + ## wifi.isWifiActive isWifiActive(): boolean -查询WLAN是否已激活。 +查询WLAN是否已使能。 **需要权限：** ohos.permission.GET_WIFI_INFO @@ -23,7 +58,7 @@ isWifiActive(): boolean **返回值：** | **类型** | **说明** | | -------- | -------- | - | boolean | true:已激活， false:未激活。 | + | boolean | true:已使能， false:未使能。 | ## wifi.scan @@ -32,7 +67,7 @@ scan(): boolean 启动WLAN扫描。 -**需要权限：** ohos.permission.SET_WIFI_INFO，ohos.permission.LOCATION +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.LOCATION **系统能力：** SystemCapability.Communication.WiFi.STA @@ -46,32 +81,32 @@ scan(): boolean getScanInfos(): Promise<Array<WifiScanInfo>> -获取扫描结果，使用promise方式作为异步方法。 +获取扫描结果，使用Promise异步回调。 -**需要权限：** ohos.permission.GET_WIFI_INFO以及ohos.permission.GET_WIFI_PEERS_MAC和ohos.permission.LOCATION权限中的至少一个。 +**需要权限：** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION) **系统能力：** SystemCapability.Communication.WiFi.STA **返回值：** | **类型** | **说明** | | -------- | -------- | - | Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | 返回扫描到的热点列表。 | + | Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | Promise对象。返回扫描到的热点列表。 | ## wifi.getScanInfos getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void -获取扫描结果，使用callback方式作为异步方法。 +获取扫描结果，使用callback异步回调。 -**需要权限：** ohos.permission.GET_WIFI_INFO以及ohos.permission.GET_WIFI_PEERS_MAC和ohos.permission.LOCATION权限中的至少一个。 +**需要权限：** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION) **系统能力：** SystemCapability.Communication.WiFi.STA **参数：** | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | 是 | 扫描到的热点列表结果回调函数。 | + | callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | 是 | 回调函数。当成功时，err为0，data为扫描到的热点；否则err为非0值，data为空。 | **示例：** ```js @@ -120,6 +155,8 @@ getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void WLAN热点信息。 +**系统能力：** SystemCapability.Communication.WiFi.STA + | **参数名** | **类型** | **读写属性** | **说明** | | -------- | -------- | -------- | -------- | | ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 | @@ -130,8 +167,9 @@ WLAN热点信息。 | band | number | 只读 | WLAN接入点的频段。 | | frequency | number | 只读 | WLAN接入点的频率。 | | channelWidth | number | 只读 | WLAN接入点的带宽。 | -| centerFrequency0 | number | 只读 | 中心频点。 | -| centerFrequency1 | number | 只读 | 中心频点。 | +| centerFrequency09+ | number | 只读 | 中心频点。 | +| centerFrequency19+ | number | 只读 | 中心频点。 | +| infoElems9+ | Array<[WifiInfoElem](#WifiInfoElem)> | 只读 | 信息元素。 | | timestamp | number | 只读 | 时间戳。 | @@ -139,6 +177,8 @@ WLAN热点信息。 表示加密类型的枚举。 +**系统能力：** SystemCapability.Communication.WiFi.Core + | **名称** | **默认值** | **说明** | | -------- | -------- | -------- | | WIFI_SEC_TYPE_INVALID | 0 | 无效加密类型。 | @@ -146,19 +186,67 @@ WLAN热点信息。 | WIFI_SEC_TYPE_WEP | 2 | Wired Equivalent Privacy (WEP)加密类型。 | | WIFI_SEC_TYPE_PSK | 3 | Pre-shared key (PSK)加密类型。 | | WIFI_SEC_TYPE_SAE | 4 | Simultaneous Authentication of Equals (SAE)加密类型。 | +| WIFI_SEC_TYPE_EAP9+ | 5 | EAP加密类型。 | +| WIFI_SEC_TYPE_EAP_SUITE_B9+ | 6 | Suite-B 192位加密类型。 | +| WIFI_SEC_TYPE_OWE9+ | 7 | 机会性无线加密类型。 | +| WIFI_SEC_TYPE_WAPI_CERT9+ | 8 | WAPI-Cert加密类型。 | +| WIFI_SEC_TYPE_WAPI_PSK9+ | 9 | WAPI-PSK加密类型。 | -## wifi.addUntrustedConfig7+ +## WifiInfoElem9+ -addUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> +WLAN热点信息。 -添加不可信网络配置，使用promise方式作为异步方法。 +**系统能力：** SystemCapability.Communication.WiFi.STA -**需要权限：** - ohos.permission.SET_WIFI_INFO +| **参数名** | **类型** | **读写属性** | **说明** | +| -------- | -------- | -------- | -------- | +| eid | number | 只读 | 元素ID。 | +| content | Uint8Array | 只读 | 元素内容。 | -**系统能力：** - SystemCapability.Communication.WiFi.STA + +## WifiChannelWidth9+ + +表示带宽类型的枚举。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| **名称** | **默认值** | **说明** | +| -------- | -------- | -------- | +| WIDTH_20MHZ | 0 | 20MHZ。 | +| WIDTH_40MHZ | 1 | 40MHZ。 | +| WIDTH_80MHZ | 2 | 80MHZ。 | +| WIDTH_160MHZ | 3 | 160MHZ。 | +| WIDTH_80MHZ_PLUS | 4 | 80MHZ+。 | +| WIDTH_INVALID | 5 | 无效值 | + + +## wifi.getScanInfosSync9+ + +getScanInfosSync():  Array<[WifiScanInfo](#wifiscaninfo)> + +获取扫描结果，使用同步方式返回结果。 + +**需要权限：** ohos.permission.GET_WIFI_INFO 和 (ohos.permission.GET_WIFI_PEERS_MAC 或 ohos.permission.LOCATION) + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + |  Array<[WifiScanInfo](#wifiscaninfo)> | 扫描结果数组。 | + + +## wifi.addDeviceConfig + +addDeviceConfig(config: WifiDeviceConfig): Promise<number> + +添加网络配置，使用Promise异步回调。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG + +**系统能力：** SystemCapability.Communication.WiFi.STA **参数：** | **参数名** | **类型** | **必填** | **说明** | @@ -168,12 +256,14 @@ addUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> **返回值：** | **类型** | **说明** | | -------- | -------- | - | Promise<boolean> | 操作结果，ture: 成功， false: 失败。 | + | Promise<number> | Promise对象。返回添加的网络配置ID，如果值为-1表示添加失败。 | ## WifiDeviceConfig WLAN配置信息。 +**系统能力：** SystemCapability.Communication.WiFi.STA + | **参数名** | **类型** | **读写属性** | **说明** | | -------- | -------- | -------- | -------- | | ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 | @@ -181,13 +271,147 @@ WLAN配置信息。 | preSharedKey | string | 只读 | 热点的密钥。 | | isHiddenSsid | boolean | 只读 | 是否是隐藏网络。 | | securityType | [WifiSecurityType](#WifiSecurityType) | 只读 | 加密类型。 | +| creatorUid | number | 只读 | 创建用户的ID，仅系统应用可用。 | +| disableReason | number | 只读 | 禁用原因，仅系统应用可用。 | +| netId | number | 只读 | 分配的网络ID， 仅系统应用可用。 | +| randomMacType | number | 只读 | 随机MAC类型，仅系统应用可用。 | +| randomMacAddr | string | 只读 | 随机MAC地址，仅系统应用可用。 | +| ipType | [IpType](#IpType) | 只读 | IP地址类型，仅系统应用可用。 | +| staticIp | [IpConfig](#IpConfig) | 只读 | 静态IP配置信息，仅系统应用可用。 | +| eapConfig9+ | [WifiEapConfig](#WifiEapConfig) | 只读 | 可扩展身份验证协议配置，仅系统应用可用。 | + + +## IpType7+ + +表示IP类型的枚举。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| STATIC | 0 | 静态IP。 | +| DHCP | 1 | 通过DHCP获取。 | +| UNKNOWN | 2 | 未指定。 | + + +## IpConfig7+ + +IP配置信息。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| **参数名** | **类型** | **读写属性** | **说明** | +| -------- | -------- | -------- | -------- | +| ipAddress | number | 只读 | IP地址。 | +| gateway | number | 只读 | 网关。 | +| dnsServers | number[] | 只读 | DNS服务器。 | +| domains | Array<string> | 只读 | 域信息。 | + + +## WifiEapConfig9+ + +可扩展身份验证协议配置信息。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| **参数名** | **类型** | **读写属性** | **说明** | +| -------- | -------- | -------- | -------- | +| eapMethod | [EapMethod](#EapMethod) | 只读 | EAP认证方式。 | +| phase2Method | [Phase2Method](#Phase2Method) | 只读 | 第二阶段认证方式。 | +| identity | string | 只读 | 身份信息。 | +| anonymousIdentity | string | 只读 | 匿名身份。 | +| password | string | 只读 | 密码。 | +| caCertAliases | string | 只读 | CA 证书别名。 | +| caPath | string | 只读 | CA 证书路径。 | +| clientCertAliases | string | 只读 | 客户端证书别名。 | +| altSubjectMatch | string | 只读 | 替代主题匹配。 | +| domainSuffixMatch | string | 只读 | 域后缀匹配。 | +| realm | string | 只读 | 通行证凭证的领域。 | +| plmn | string | 只读 | 公共陆地移动网的直通凭证提供商。 | +| eapSubId | number | 只读 | SIM卡的子ID。 | + + +## EapMethod9+ + +表示EAP认证方式的枚举。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| EAP_NONE | 0 | 不指定。 | +| EAP_PEAP | 1 | PEAP类型。 | +| EAP_TLS | 2 | TLS类型。 | +| EAP_TTLS | 3 | TTLS类型。 | +| EAP_PWD | 4 | PWD类型。 | +| EAP_SIM | 5 | SIM类型。 | +| EAP_AKA | 6 | AKA类型。 | +| EAP_AKA_PRIME | 7 | AKA Prime类型。 | +| EAP_UNAUTH_TLS | 8 | UNAUTH TLS类型。 | + + +## Phase2Method9+ + +表示第二阶段认证方式的枚举。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| PHASE2_NONE | 0 | 不指定。 | +| PHASE2_PAP | 1 | PAP类型。 | +| PHASE2_MSCHAP | 2 | MSCHAP类型。 | +| PHASE2_MSCHAPV2 | 3 | MSCHAPV2类型。 | +| PHASE2_GTC | 4 | GTC类型。 | +| PHASE2_SIM | 5 | SIM类型。 | +| PHASE2_AKA | 6 | AKA类型。 | +| PHASE2_AKA_PRIME | 7 | AKA Prime类型。 | + + +## wifi.addDeviceConfig + +addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>): void + +添加网络配置，使用callback异步回调。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | + | callback | AsyncCallback<number> | 是 | 回调函数。当操作成功时，err为0，data为添加的网络配置ID，如果data值为-1，表示添加失败。当error为非0，表示处理出现错误。 | + + +## wifi.addUntrustedConfig7+ + +addUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> + +添加不可信网络配置，使用Promise异步回调。 + +**需要权限：** ohos.permission.SET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | Promise<boolean> | Promise对象。表示操作结果，true: 成功， false: 失败。 | ## wifi.addUntrustedConfig7+ addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean>): void -添加不可信网络配置，使用callback方式作为异步方法。 +添加不可信网络配置，使用callback异步回调。 **需要权限：** ohos.permission.SET_WIFI_INFO @@ -197,14 +421,14 @@ addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean& | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | - | callback | AsyncCallback<boolean> | 是 | 操作结果，ture: 成功， false: 失败。 | + | callback | AsyncCallback<boolean> | 是 | 回调函数。当操作成功时，err为0，data表示操作结果，true: 成功， false: 失败。如果error为非0，表示处理出现错误。 | ## wifi.removeUntrustedConfig7+ removeUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> -移除不可信网络配置，使用promise方式作为异步方法。 +移除不可信网络配置，使用Promise异步回调。 **需要权限：** ohos.permission.SET_WIFI_INFO @@ -218,14 +442,31 @@ removeUntrustedConfig(config: WifiDeviceConfig): Promise<boolean> **返回值：** | **类型** | **说明** | | -------- | -------- | - | Promise<boolean> | 操作结果，ture: 成功， false: 失败。 | + | Promise<boolean> | Promise对象。表示操作结果，true: 成功， false: 失败。 | ## wifi.removeUntrustedConfig7+ removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean>): void -移除不可信网络配置，使用callback方式作为异步方法。 +移除不可信网络配置，使用callback异步回调。 + +**需要权限：** ohos.permission.SET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | + | callback | AsyncCallback<boolean> | 是 | 回调函数。当操作成功时，err为0，data表示操作结果，true: 成功， false: 失败。如果error为非0，表示处理出现错误。 | + + +## wifi.addCandidateConfig9+ + +addCandidateConfig(config: WifiDeviceConfig): Promise<number> + +添加候选网络配置，使用Promise异步回调。 **需要权限：** ohos.permission.SET_WIFI_INFO @@ -235,7 +476,168 @@ removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boole | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | - | callback | AsyncCallback<boolean> | 是 | 操作结果，ture: 成功， false: 失败。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | Promise<number> | Promise对象。表示网络配置ID。 | + + +## wifi.addCandidateConfig9+ + +addCandidateConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>): void + +添加不可信网络配置，使用callback异步回调。 + +**需要权限：** ohos.permission.SET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | + | callback | AsyncCallback<number> | 是 | 回调函数。当操作成功时，err为0，data为添加的网络配置ID，如果data值为-1，表示添加失败。如果操作出现错误，err为非0值。 | + + +## wifi.removeCandidateConfig9+ + +removeCandidateConfig(config: WifiDeviceConfig): Promise<boolean> + +移除候选候选网络配置，使用Promise异步回调。 + +**需要权限：** ohos.permission.SET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | Promise<void> | Promise对象。返回操作结果，true: 成功， false | + + +## wifi.removeCandidateConfig9+ + +removeCandidateConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean>): void + +移除候选网络配置，使用callback异步回调。 + +**需要权限：** ohos.permission.SET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | + | callback | AsyncCallback<void> | 是 | 回调函数。当操作成功时，err为0，data表示操作结果，true: 成功， false: 失败。如果error为非0，表示处理出现错误。 | + + +## wifi.getCandidateConfigs9+ + +getCandidateConfigs():  Array<[WifiDeviceConfig](#WifiDeviceConfig)> + +获取候选网络配置。 + +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + |  Array<[WifiDeviceConfig](#WifiDeviceConfig)> | 候选网络配置数组。 | + + +## wifi.connectToCandidateConfig9+ + +connectToCandidateConfig(networkId: number): boolean + +连接到候选网络。 + +**需要权限：** ohos.permission.SET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | networkId | number | 是 | 候选网络配置的ID。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + +## wifi.connectToNetwork + +connectToNetwork(networkId: number): boolean + +连接到指定网络。 +此接口为系统接口。 + +**需要权限：** ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | networkId | number | 是 | 待连接的网络配置ID。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + +## wifi.connectToDevice + +connectToDevice(config: WifiDeviceConfig): boolean + +连接到指定网络。 +此接口为系统接口。 + +**需要权限：** + ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG 和 ohos.permissio.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** + SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + +## wifi.disconnect + +disconnect(): boolean + +连接到指定网络。 +此接口为系统接口。 + +**需要权限：** + ohos.permission.SET_WIFI_INFO 和 ohos.permissio.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** + SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | ## wifi.getSignalLevel @@ -264,7 +666,7 @@ getSignalLevel(rssi: number, band: number): number getLinkedInfo(): Promise<WifiLinkedInfo> -获取WLAN连接信息，使用promise方式作为异步方法。 +获取WLAN连接信息，使用Promise异步回调。 **需要权限：** ohos.permission.GET_WIFI_INFO @@ -273,14 +675,14 @@ getLinkedInfo(): Promise<WifiLinkedInfo> **返回值：** | 类型 | 说明 | | -------- | -------- | - | Promise<[WifiLinkedInfo](#WifiLinkedInfo)> | WLAN连接的相关信息。 | + | Promise<[WifiLinkedInfo](#WifiLinkedInfo)> | Promise对象。表示WLAN连接信息。 | ## wifi.getLinkedInfo getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void -获取WLAN连接信息，使用callback方式作为异步方法。 +获取WLAN连接信息，使用callback异步回调。 **需要权限：** ohos.permission.GET_WIFI_INFO @@ -289,7 +691,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiLinkedInfo](#WifiLinkedInfo)> | 是 | WLAN连接信息结果回调函数。 | + | callback | AsyncCallback<[WifiLinkedInfo](#WifiLinkedInfo)> | 是 | 回调函数。当获取成功时，err为0，data表示WLAN连接信息。如果error为非0，表示处理出现错误。 | **示例：** ```js @@ -315,18 +717,25 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void 提供WLAN连接的相关信息。 +**系统能力：** SystemCapability.Communication.WiFi.STA + | 参数名 | 类型 | 读写属性 | 说明 | | -------- | -------- | -------- | -------- | | ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 | | bssid | string | 只读 | 热点的BSSID。 | +| networkId | number | 只读 | 网络配置ID， 仅系统应用可用。 | | rssi | number | 只读 | 热点的信号强度(dBm)。 | | band | number | 只读 | WLAN接入点的频段。 | | linkSpeed | number | 只读 | WLAN接入点的速度。 | | frequency | number | 只读 | WLAN接入点的频率。 | | isHidden | boolean | 只读 | WLAN接入点是否是隐藏网络。 | | isRestricted | boolean | 只读 | WLAN接入点是否限制数据量。 | +| chload | number | 只读 | 连接负载，值越大表示负载约高，仅系统应用可用。 | +| snr | number | 只读 | 信噪比，仅系统应用可用。 | +| macType9+ | number | 只读 | MAC地址类型。 | | macAddress | string | 只读 | 设备的MAC地址。 | | ipAddress | number | 只读 | WLAN连接的IP地址。 | +| suppState | [SuppState](#SuppState) | 只读 | 请求状态，仅系统应用可用。| | connState | [ConnState](#ConnState) | 只读 | WLAN连接状态。 | @@ -334,6 +743,8 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void 表示WLAN连接状态的枚举。 +**系统能力：** SystemCapability.Communication.WiFi.STA + | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | SCANNING | 0 | 设备正在搜索可用的AP。 | @@ -346,240 +757,578 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void | UNKNOWN | 7 | WLAN连接建立失败。 | -## wifi.isConnected7+ +## SuppState + +表示请求状态的枚举。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| DISCONNECTED | 0 | 已断开。 | +| INTERFACE_DISABLED | 1 | 接口禁用。 | +| INACTIVE | 2 | 未激活。 | +| SCANNING | 3 | 扫描中。 | +| AUTHENTICATING | 4 | 认证中。 | +| ASSOCIATING | 5 | 关联中。 | +| ASSOCIATED | 6 | 已关联。 | +| FOUR_WAY_HANDSHAKE | 7 | 四次握手。 | +| GROUP_HANDSHAKE | 8 | 组握手。 | +| COMPLETED | 9 | 所有认证已完成。 | +| UNINITIALIZED | 10 | 连接建立失败。 | +| INVALID | 11 | 无效值。 | + + +## wifi.isConnected7+ + +isConnected(): boolean + +查询WLAN是否已连接。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:已连接， false:未连接。 | + + +## wifi.getSupportedFeatures7+ + +getSupportedFeatures(): number + +查询设备支持的特性。 +此接口为系统接口。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.Core + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | number | 支持的特性值。 | + +**特性ID值枚举：** + +| 枚举值 | 说明 | +| -------- | -------- | +| 0x0001 | 基础结构模式特性。 | +| 0x0002 | 5 GHz带宽特性。 | +| 0x0004 | GAS/ANQP特性。 | +| 0x0008 | Wifi-Direct特性。 | +| 0x0010 | Soft AP特性。 | +| 0x0040 | Wi-Fi AWare组网特性。 | +| 0x8000 | AP STA共存特性。 | +| 0x8000000 | WPA3-Personal SAE特性。 | +| 0x10000000 | WPA3-Enterprise Suite-B | +| 0x20000000 | 增强开放特性。 | + + +## wifi.isFeatureSupported7+ + +isFeatureSupported(featureId: number): boolean + +判断设备是否支持相关WLAN特性。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.Core + +**参数：** + + | **参数名** | **类型** | 必填 | **说明** | + | -------- | -------- | -------- | -------- | + | featureId | number | 是 | 特性ID值。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:支持， false:不支持。 | + + +## wifi.getDeviceMacAddress7+ + +getDeviceMacAddress(): string[] + +获取设备的MAC地址。 +此接口为系统接口。 + +**需要权限：** ohos.permission.GET_WIFI_LOCAL_MAC 和 ohos.permission.GET_WIFI_INFO，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | string[] | MAC地址。 | + + +## wifi.getIpInfo7+ + +getIpInfo(): IpInfo + +获取IP信息。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | [IpInfo](#IpInfo) | IP信息。 | + + +## IpInfo7+ + +IP信息。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +| **参数名** | **类型** | **读写属性** | **说明** | +| -------- | -------- | -------- | -------- | +| ipAddress | number | 只读 | IP地址。 | +| gateway | number | 只读 | 网关。 | +| netmask | number | 只读 | 掩码。 | +| primaryDns | number | 只读 | 主DNS服务器IP地址。 | +| secondDns | number | 只读 | 备DNS服务器IP地址。 | +| serverIp | number | 只读 | DHCP服务端IP地址。 | +| leaseDuration | number | 只读 | IP地址租用时长。 | + + +## wifi.getCountryCode7+ + +getCountryCode(): string + +获取国家码信息。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.Core + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | string | 国家码。 | + + +## wifi.reassociate7+ + +reassociate(): boolean + +重新关联网络。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + +## wifi.reconnect7+ + +reconnect(): boolean + +重新连接网络。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + +## wifi.getDeviceConfigs7+ + +getDeviceConfigs():  Array<[WifiDeviceConfig](#WifiDeviceConfig)> + +获取网络配置。 +此接口为系统接口。 + +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.GET_WIFI_CONFIG + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + |  Array<[WifiDeviceConfig](#WifiDeviceConfig)> | 网络配置信息的数组。 | + + +## wifi.updateNetwork7+ + +updateNetwork(config: WifiDeviceConfig): boolean + +更新网络配置。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | config | [WifiDeviceConfig](#WifiDeviceConfig) | 是 | WLAN配置信息。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + +## wifi.disableNetwork7+ + +disableNetwork(netId: number): boolean + +去使能网络配置。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | netId | number | 是 | 网络配置ID。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + +## wifi.removeAllNetwork7+ + +removeAllNetwork(): boolean + +移除所有网络配置。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + +## wifi.removeDevice7+ + +removeDevice(id: number): boolean + +移除指定的网络配置。 +此接口为系统接口。 + +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | id | number | 是 | 网络配置ID。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + +## wifi.enableHotspot7+ + +enableHotspot(): boolean + +使能热点。 +此接口为系统接口。 + +**需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.AP.Core + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。| + -isConnected(): boolean +## wifi.disableHotspot7+ -查询WLAN是否已连接。 +disableHotspot(): boolean -**需要权限：** ohos.permission.GET_WIFI_INFO +去使能热点。 +此接口为系统接口。 -**系统能力：** SystemCapability.Communication.WiFi.STA +**需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** | **类型** | **说明** | | -------- | -------- | - | boolean | true:已连接， false:未连接。 | + | boolean | true:操作成功， false:操作失败。| -## wifi.isFeatureSupported7+ +## wifi.isHotspotDualBandSupported7+ -isFeatureSupported(featureId: number): boolean +isHotspotDualBandSupported(): boolean -判断设备是否支持相关WLAN特性。 +热点是否支持双频。 +此接口为系统接口。 -**需要权限：** ohos.permission.GET_WIFI_INFO +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_HOTSPOT，仅系统应用可用。 -**系统能力：** SystemCapability.Communication.WiFi.Core +**系统能力：** SystemCapability.Communication.WiFi.AP.Core -**参数：** +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:支持， false:不支持。| - | **参数名** | **类型** | 必填 | **说明** | - | -------- | -------- | -------- | -------- | - | featureId | number | 是 | 特性ID值。 | + +## wifi.isHotspotActive7+ + +isHotspotActive(): boolean + +热点是否已使能。 +此接口为系统接口。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** | **类型** | **说明** | | -------- | -------- | - | boolean | true:支持， false:不支持。 | + | boolean | true:已使能， false:未使能。| -**特性ID值枚举：** - -| 枚举值 | 说明 | -| -------- | -------- | -| 0x0001 | 基础结构模式特性。 | -| 0x0002 | 5 GHz带宽特性。 | -| 0x0004 | GAS/ANQP特性。 | -| 0x0008 | Wifi-Direct特性。 | -| 0x0010 | Soft AP特性。 | -| 0x0040 | Wi-Fi AWare组网特性。 | -| 0x8000 | AP STA共存特性。 | -| 0x8000000 | WPA3-Personal SAE特性。 | -| 0x10000000 | WPA3-Enterprise Suite-B | -| 0x20000000 | 增强开放特性。 | +## wifi.setHotspotConfig7+ -## wifi.getIpInfo7+ +setHotspotConfig(config: HotspotConfig): boolean -getIpInfo(): IpInfo +设置热点配置信息。 +此接口为系统接口。 -获取IP信息。 +**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG -**需要权限：** ohos.permission.GET_WIFI_INFO +**系统能力：** SystemCapability.Communication.WiFi.AP.Core -**系统能力：** SystemCapability.Communication.WiFi.STA +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | config | [HotspotConfig](#HotspotConfig) | 是 | 热点配置信息。 | **返回值：** | **类型** | **说明** | | -------- | -------- | - | [IpInfo](#IpInfo) | IP信息。 | + | boolean | true:操作成功， false:操作失败。 | -## IpInfo7+ +## HotspotConfig7+ -IP信息。 +热点配置信息。 + +**系统能力：** SystemCapability.Communication.WiFi.AP.Core | **参数名** | **类型** | **读写属性** | **说明** | | -------- | -------- | -------- | -------- | -| ipAddress | number | 只读 | IP地址。 | -| gateway | number | 只读 | 网关。 | -| netmask | number | 只读 | 掩码。 | -| primaryDns | number | 只读 | 主DNS服务器IP地址。 | -| secondDns | number | 只读 | 备DNS服务器IP地址。 | -| serverIp | number | 只读 | DHCP服务端IP地址。 | -| leaseDuration | number | 只读 | IP地址租用时长。 | +| ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 | +| securityType | [WifiSecurityType](#WifiSecurityType) | 只读 | 加密类型。 | +| band | number | 只读 | 热点的带宽。1: 2.4G, 2: 5G, 3: 双模频段 | +| preSharedKey | string | 只读 | 热点的密钥。 | +| maxConn | number | 只读 | 最大设备连接数。 | -## wifi.getCountryCode7+ +## wifi.getHotspotConfig7+ -getCountryCode(): string +getHotspotConfig(): HotspotConfig -获取国家码信息。 +获取热点配置信息。 +此接口为系统接口。 -**需要权限：** ohos.permission.GET_WIFI_INFO +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG -**系统能力：** SystemCapability.Communication.WiFi.Core +**系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** | **类型** | **说明** | | -------- | -------- | - | string | 国家码。 | + | [HotspotConfig](#HotspotConfig) | 热点的配置信息。 | -## wifi.getP2pLinkedInfo8+ +## wifi.getStations7+ -getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo> +getStations():  Array<[StationInfo](#StationInfo)> -获取P2P连接信息，使用promise方式作为异步方法。 +获取连接的设备。 +此接口为系统接口。 -**需要权限：** ohos.permission.GET_WIFI_INFO +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.MANAGE_WIFI_HOTSPOT，仅系统应用可用。 -**系统能力：** SystemCapability.Communication.WiFi.P2P +**系统能力：** SystemCapability.Communication.WiFi.AP.Core **返回值：** - | 类型 | 说明 | + | **类型** | **说明** | | -------- | -------- | - | Promise<[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)> | P2P连接信息。 | + |  Array<[StationInfo](#StationInfo)> | 连接的设备数组。 | + + +## StationInfo7+ + +接入的设备信息。 + +**系统能力：** SystemCapability.Communication.WiFi.AP.Core + +| **参数名** | **类型** | **读写属性** | **说明** | +| -------- | -------- | -------- | -------- | +| name | string | 只读 | 设备名称。 | +| macAddress | string | 只读 | MAC地址。 | +| ipAddress | string | 只读 | IP地址。 | ## wifi.getP2pLinkedInfo8+ -getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void +getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo> -获取P2P连接信息，使用callback方式作为异步方法。 +获取P2P连接信息，使用Promise异步回调。 **需要权限：** ohos.permission.GET_WIFI_INFO **系统能力：** SystemCapability.Communication.WiFi.P2P -**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)> | 是 | P2P连接信息结果回调函数。 | +**返回值：** + | 类型 | 说明 | + | -------- | -------- | + | Promise<[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)> | Promise对象。表示P2P连接信息。 | + ## WifiP2pLinkedInfo8+ 提供WLAN连接的相关信息。 +**系统能力：** SystemCapability.Communication.WiFi.P2P + | 参数名 | 类型 | 读写属性 | 说明 | | -------- | -------- | -------- | -------- | | connectState | [P2pConnectState](#P2pConnectState) | 只读 | P2P连接状态。 | -| isGroupOwner | boolean | 只读 | 是否是群组。 | -| groupOwnerAddr | string | 只读 | 群组MAC地址。 | +| isGroupOwner | boolean | 只读 | 是否是群主。 | +| groupOwnerAddr | string | 只读 | 群组MAC地址。 ## P2pConnectState8+ 表示P2P连接状态的枚举。 +**系统能力：** SystemCapability.Communication.WiFi.P2P + | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | DISCONNECTED | 0 | 断开状态。 | | CONNECTED | 1 | 连接状态。 | +## wifi.getP2pLinkedInfo8+ + +getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void + +获取P2P连接信息，使用callback异步回调。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.P2P + +**参数：** + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[WifiP2pLinkedInfo](#WifiP2pLinkedInfo)> | 是 | 回调函数。当操作成功时，err为0，data表示P2P连接信息。如果error为非0，表示处理出现错误。 | + + ## wifi.getCurrentGroup8+ getCurrentGroup(): Promise<WifiP2pGroupInfo> -获取P2P当前组信息，使用promise方式作为异步方法。 +获取P2P当前组信息，使用Promise异步回调。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** | 类型 | 说明 | | -------- | -------- | - | Promise<[WifiP2pGroupInfo](#WifiP2pGroupInfo)> | 当前组信息。 | + | Promise<[WifiP2pGroupInfo](#WifiP2pGroupInfo)> | Promise对象。表示当前组信息。 | ## wifi.getCurrentGroup8+ getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void -获取P2P当前组信息，使用callback方式作为异步方法。 +获取P2P当前组信息，使用callback异步回调。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiP2pGroupInfo](#WifiP2pGroupInfo)> | 是 | 当前组信息的回调函数。 | + | callback | AsyncCallback<[WifiP2pGroupInfo](#WifiP2pGroupInfo)> | 是 | 回调函数。当操作成功时，err为0，data表示当前组信息。如果error为非0，表示处理出现错误。 | -## wifi.getP2pGroups9+ -getP2pGroups(): Promise<Array<WifiP2pGroupInfo> +## wifi.getP2pPeerDevices8+ + +getP2pPeerDevices(): Promise<WifiP2pDevice[]> -获取P2P当前创建的所有群组信息，使用promise方式作为异步方法。 +获取P2P对端设备列表信息，使用Promise异步回调。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** | 类型 | 说明 | | -------- | -------- | - | Promise< Array<[WifiP2pGroupInfo](#WifiP2pGroupInfo)> > | 当前创建的所有群组信息。 | + | Promise<[WifiP2pDevice[]](#WifiP2pDevice)> | Promise对象。表示对端设备列表信息。 | -## wifi.getP2pGroups9+ -getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>): void +## wifi.getP2pPeerDevices8+ + +getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void -获取P2P当前创建的所有群组信息，使用callback方式作为异步方法。 +获取P2P对端设备列表信息，使用callback异步回调。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback< Array<[WifiP2pGroupInfo](#WifiP2pGroupInfo)>> | 是 | 当前创建的所有群组信息的回调函数。 | - -## WifiP2pGroupInfo8+ - -表示P2P群组相关信息。 + | callback | AsyncCallback<[WifiP2pDevice[]](#WifiP2pDevice)> | 是 | 回调函数。当操作成功时，err为0，data表示对端设备列表信息。如果error为非0，表示处理出现错误。 | -| 参数名 | 类型 | 读写属性 | 说明 | -| -------- | -------- | -------- | -------- | -| isP2pGo | boolean | 只读 | 是否是群组。 | -| ownerInfo | [WifiP2pDevice](#WifiP2pDevice) | 只读 | 群组的设备信息。 | -| passphrase | string | 只读 | 群组密钥。 | -| interface | string | 只读 | 接口名称。 | -| groupName | string | 只读 | 群组名称。 | -| networkId | number | 只读 | 网络ID。 | -| frequency | number | 只读 | 群组的频率。 | -| clientDevices | [WifiP2pDevice[]](#WifiP2pDevice) | 只读 | 接入的设备列表信息。 | -| goIpAddress | string | 只读 | 群组IP地址。 | ## WifiP2pDevice8+ 表示P2P设备信息。 +**系统能力：** SystemCapability.Communication.WiFi.P2P + | 参数名 | 类型 | 读写属性 | 说明 | | -------- | -------- | -------- | -------- | | deviceName | string | 只读 | 设备名称。 | @@ -588,10 +1337,13 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>): void | deviceStatus | [P2pDeviceStatus](#P2pDeviceStatus) | 只读 | 设备状态。 | | groupCapabilitys | number | 只读 | 群组能力。 | + ## P2pDeviceStatus8+ 表示设备状态的枚举。 +**系统能力：** SystemCapability.Communication.WiFi.P2P + | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | CONNECTED | 0 | 连接状态。 | @@ -601,71 +1353,41 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>): void | UNAVAILABLE | 4 | 不可用状态。 | -## wifi.getP2pPeerDevices8+ - -getP2pPeerDevices(): Promise<WifiP2pDevice[]> - -获取P2P对端设备列表信息，使用promise方式作为异步方法。 - -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION - -**系统能力：** SystemCapability.Communication.WiFi.P2P - -**返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<[WifiP2pDevice[]](#WifiP2pDevice)> | 对端设备列表信息。 | - - -## wifi.getP2pPeerDevices8+ - -getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void - -获取P2P对端设备列表信息，使用callback方式作为异步方法。 - -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION - -**系统能力：** SystemCapability.Communication.WiFi.P2P - -**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiP2pDevice[]](#WifiP2pDevice)> | 是 | 对端设备列表信息回调函数。 | - ## wifi.getP2pLocalDevice9+ getP2pLocalDevice(): Promise<WifiP2pDevice> -获取P2P本端设备信息，使用promise方式作为异步方法。 +获取P2P本端设备信息，使用Promise异步回调。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.GET_WIFI_CONFIG +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG **系统能力：** SystemCapability.Communication.WiFi.P2P **返回值：** | 类型 | 说明 | | -------- | -------- | - | Promise<[WifiP2pDevice](#WifiP2pDevice)> | 本端设备信息。 | + | Promise<[WifiP2pDevice](#WifiP2pDevice)> | Promise对象。表示本端设备信息。 | -## wifi.getP2pLocalDevice8+ +## wifi.getP2pLocalDevice9+ getP2pLocalDevice(callback: AsyncCallback<WifiP2pDevice>): void -获取P2P本端设备信息，使用callback方式作为异步方法。 +获取P2P本端设备信息，使用callback异步回调。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.GET_WIFI_CONFIG +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG **系统能力：** SystemCapability.Communication.WiFi.P2P **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiP2pDevice](#WifiP2pDevice)> | 是 | 本端设备信息回调函数。 | + | callback | AsyncCallback<[WifiP2pDevice](#WifiP2pDevice)> | 是 | 回调函数。当操作成功时，err为0，data表示本端设备信息。如果error为非0，表示处理出现错误。 | + ## wifi.createGroup8+ -createGroup(config: WifiP2PConfig): boolean; +createGroup(config: WifiP2PConfig): boolean 创建群组。 @@ -684,10 +1406,13 @@ createGroup(config: WifiP2PConfig): boolean; | -------- | -------- | | boolean | true:创建群组操作执行成功， false:创建群组操作执行失败。 | + ## WifiP2PConfig8+ 表示P2P配置信息。 +**系统能力：** SystemCapability.Communication.WiFi.P2P + | 参数名 | 类型 | 读写属性 | 说明 | | -------- | -------- | -------- | -------- | | deviceAddress | string | 只读 | 设备地址。 | @@ -701,15 +1426,18 @@ createGroup(config: WifiP2PConfig): boolean; 表示群组带宽的枚举。 +**系统能力：** SystemCapability.Communication.WiFi.P2P + | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | GO_BAND_AUTO | 0 | 自动模式。 | | GO_BAND_2GHZ | 1 | 2GHZ。 | | GO_BAND_5GHZ | 2 | 5GHZ。 | + ## wifi.removeGroup8+ -removeGroup(): boolean; +removeGroup(): boolean 移除群组。 @@ -725,11 +1453,11 @@ removeGroup(): boolean; ## wifi.p2pConnect8+ -p2pConnect(config: WifiP2PConfig): boolean; +p2pConnect(config: WifiP2PConfig): boolean 执行P2P连接。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P @@ -792,7 +1520,7 @@ p2pConnect(config: WifiP2PConfig): boolean; } wifi.on("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc); - var recvP2pPersistentGroupChangeFunc = result => { + var recvP2pPersistentGroupChangeFunc = () => { console.info("p2p persistent group change receive event"); wifi.getCurrentGroup((err, data) => { @@ -814,7 +1542,7 @@ p2pConnect(config: WifiP2PConfig): boolean; ## wifi.p2pCancelConnect8+ -p2pCancelConnect(): boolean; +p2pCancelConnect(): boolean 取消P2P连接。 @@ -825,16 +1553,16 @@ p2pCancelConnect(): boolean; **返回值：** | 类型 | 说明 | | -------- | -------- | - | boolean | true:取消连接操作执行成功， false:取消连接操作执行失败。 | + | boolean | true:操作执行成功， false:操作执行失败。 | ## wifi.startDiscoverDevices8+ -startDiscoverDevices(): boolean; +startDiscoverDevices(): boolean 开始发现设备。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P @@ -846,7 +1574,7 @@ startDiscoverDevices(): boolean; ## wifi.stopDiscoverDevices8+ -stopDiscoverDevices(): boolean; +stopDiscoverDevices(): boolean 停止发现设备。 @@ -860,6 +1588,103 @@ stopDiscoverDevices(): boolean; | boolean | true:操作执行成功，操作执行失败。 | +## wifi.deletePersistentGroup8+ + +deletePersistentGroup(netId: number): boolean + +删除永久组。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.P2P + +**参数：** + + | **参数名** | **类型** | 必填 | **说明** | + | -------- | -------- | -------- | -------- | + | netId | number | 是 | 组的ID。 | + +**返回值：** + | 类型 | 说明 | + | -------- | -------- | + | boolean | true:操作执行成功，操作执行失败。 | + + +## wifi.getP2pGroups9+ +此接口为系统接口。 + +getP2pGroups(): Promise<Array<WifiP2pGroupInfo>> + +获取创建的所有P2P群组信息，使用Promise异步回调。 + +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION + +**系统能力：** SystemCapability.Communication.WiFi.P2P + +**返回值：** + | 类型 | 说明 | + | -------- | -------- | + | Promise< Array<[WifiP2pGroupInfo](#WifiP2pGroupInfo)> > | Promise对象。表示所有群组信息。 | + + +## WifiP2pGroupInfo8+ + +表示P2P群组相关信息。 + +**系统能力：** SystemCapability.Communication.WiFi.P2P + +| 参数名 | 类型 | 读写属性 | 说明 | +| -------- | -------- | -------- | -------- | +| isP2pGo | boolean | 只读 | 是否是群主。 | +| ownerInfo | [WifiP2pDevice](#WifiP2pDevice) | 只读 | 群组的设备信息。 | +| passphrase | string | 只读 | 群组密钥。 | +| interface | string | 只读 | 接口名称。 | +| groupName | string | 只读 | 群组名称。 | +| networkId | number | 只读 | 网络ID。 | +| frequency | number | 只读 | 群组的频率。 | +| clientDevices | [WifiP2pDevice[]](#WifiP2pDevice) | 只读 | 接入的设备列表信息。 | +| goIpAddress | string | 只读 | 群组IP地址。 | + + +## wifi.getP2pGroups9+ + +getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): void + +获取创建的所有P2P群组信息，使用callback方式作为异步方法。 + +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION + +**系统能力：** SystemCapability.Communication.WiFi.P2P + +**参数：** + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback< Array<[WifiP2pGroupInfo](#WifiP2pGroupInfo)>> | 是 | 回调函数。当操作成功时，err为0，data表示所有群组信息。如果error为非0，表示处理出现错误。 | + + +## wifi.setDeviceName8+ + +setDeviceName(devName: string): boolean + +设置设备名称。 +此接口为系统接口。 + +**需要权限：** + ohos.permission.SET_WIFI_INFO 和 ohos.permission.MANAGE_WIFI_CONNECTION，仅系统应用可用。 + +**系统能力：** SystemCapability.Communication.WiFi.P2P + +**参数：** + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | devName | string | 是 | 设备名称。 | + +**返回值：** + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:操作成功， false:操作失败。 | + + ## wifi.on('wifiStateChange')7+ on(type: "wifiStateChange", callback: Callback<number>): void @@ -1162,7 +1987,7 @@ on(type: "p2pDeviceChange", callback: Callback<WifiP2pDevice>): void 注册P2P设备状态改变事件。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P @@ -1196,7 +2021,7 @@ on(type: "p2pPeerDeviceChange", callback: Callback<WifiP2pDevice[]>): void 注册P2P对端设备状态改变事件。 -**需要权限：** ohos.permission.GET_WIFI_INFO，ohos.permission.LOCATION +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifiext.md b/zh-cn/application-dev/reference/apis/js-apis-wifiext.md index ff85bfddbd8..886be03f294 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-wifiext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifiext.md @@ -1,4 +1,5 @@ # WLAN +该模块主要提供WLAN扩展接口，供非通用类型产品使用。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -17,13 +18,11 @@ enableHotspot(): boolean; 使能WLAN热点。 -- 需要权限： - ohos.permission.MANAGE_WIFI_HOTSPOT_EXT +**需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT_EXT -- 系统能力： - SystemCapability.Communication.WiFi.AP.Extension +**系统能力：** SystemCapability.Communication.WiFi.AP.Extension -- 返回值： +**返回值：** | **类型** | **说明** | | -------- | -------- | | boolean | 操作结果， true: 成功， false: 失败。 | @@ -35,13 +34,11 @@ disableHotspot(): boolean; 去使能WLAN热点。 -- 需要权限： - ohos.permission.MANAGE_WIFI_HOTSPOT_EXT +**需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT_EXT -- 系统能力： - SystemCapability.Communication.WiFi.AP.Extension +**系统能力：** SystemCapability.Communication.WiFi.AP.Extension -- 返回值： +**返回值：** | **类型** | **说明** | | -------- | -------- | | boolean | 操作结果， true: 成功， false: 失败。 | @@ -51,24 +48,24 @@ disableHotspot(): boolean; getSupportedPowerModel(): Promise<Array<PowerModel>> -获取支持的功率模式，使用promise方式作为异步方法。 +获取支持的功率模式，使用Promise异步回调。 -- 需要权限： - ohos.permission.GET_WIFI_INFO +**需要权限：** ohos.permission.GET_WIFI_INFO -- 系统能力： - SystemCapability.Communication.WiFi.AP.Extension +**系统能力：** SystemCapability.Communication.WiFi.AP.Extension -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | - | Promise<Array<[PowerModel](#PowerModel)>> | 功率模式。 | + | Promise<Array<[PowerModel](#PowerModel)>> | Promise对象。表示功率模式。 | ## PowerModel 表示功率模式的枚举。 +**系统能力：** SystemCapability.Communication.WiFi.AP.Extension + | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | | SLEEPING | 0 | 睡眠模式。 | @@ -80,54 +77,48 @@ getSupportedPowerModel(): Promise<Array<PowerModel>> getSupportedPowerModel(callback: AsyncCallback<Array<PowerModel>>): void -获取支持的功率模式，使用callback方式作为异步方法。 +获取支持的功率模式，使用callback异步回调。 -- 需要权限： - ohos.permission.GET_WIFI_INFO +**需要权限：** ohos.permission.GET_WIFI_INFO -- 系统能力： - SystemCapability.Communication.WiFi.AP.Extension +**系统能力：** SystemCapability.Communication.WiFi.AP.Extension -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[PowerModel](#PowerModel)> | 是 | 功率模式。 | + | callback | AsyncCallback<[PowerModel](#PowerModel)> | 是 | 回调函数。当操作成功时，err为0，data表示支持的功率模式。如果error为非0，表示处理出现错误。 | ## wifiext.getPowerModel getPowerModel(): Promise<PowerModel> -获取功率模式，使用promise方式作为异步方法。 +获取功率模式，使用Promise异步回调。 -- 需要权限： - ohos.permission.GET_WIFI_INFO +**需要权限：** ohos.permission.GET_WIFI_INFO -- 系统能力： - SystemCapability.Communication.WiFi.AP.Extension +**系统能力：** SystemCapability.Communication.WiFi.AP.Extension -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | - | Promise<[PowerModel](#PowerModel)> | 功率模式。 | + | Promise<[PowerModel](#PowerModel)> | Promise对象。表示功率模式。 | ## wifiext.getPowerModel getPowerModel(callback: AsyncCallback<PowerModel>): void -获取功率模式，使用callback方式作为异步方法。 +获取功率模式，使用callback异步回调。 -- 需要权限： - ohos.permission.GET_WIFI_INFO +**需要权限：** ohos.permission.GET_WIFI_INFO -- 系统能力： - SystemCapability.Communication.WiFi.AP.Extension +**系统能力：** SystemCapability.Communication.WiFi.AP.Extension -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[PowerModel](#PowerModel)> | 是 | 功率模式。 | + | callback | AsyncCallback<[PowerModel](#PowerModel)> | 是 | 回调函数。当操作成功时，err为0，data表示功率模式。如果error为非0，表示处理出现错误。 | ## wifiext.setPowerModel @@ -136,18 +127,16 @@ setPowerModel(model: PowerModel) : boolean; 设置功率模式。 -- 需要权限： - ohos.permission.MANAGE_WIFI_HOTSPOT_EXT +**需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT_EXT -- 系统能力： - SystemCapability.Communication.WiFi.AP.Extension +**系统能力：** SystemCapability.Communication.WiFi.AP.Extension -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | model | AsyncCallback<[PowerModel](#PowerModel)> | 是 | 功率模式。 | -- 返回值： +**返回值：** | **类型** | **说明** | | -------- | -------- | | boolean | 操作结果， true: 成功， false: 失败。 | -- Gitee