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 d1c1cd4080bbeb6168055b5be52b95c1ea21dbed..faf695a3f88d29754c2c95d76d5ee0bd7ba58d5a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifi.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifi.md @@ -2256,12 +2256,14 @@ wifi.on("wifiRssiChange", recvWifiRssiChangeFunc); wifi.off("wifiRssiChange", recvWifiRssiChangeFunc); ``` -## wifi.on('streamChange')7+ +## wifi.on('streamChange')9+ on(type: "streamChange", callback: Callback<number>): void 注册WIFI流更改事件。 +**系统接口：** 此接口为系统接口。 + **需要权限：** ohos.permission.MANAGE_WIFI_CONNECTION **系统能力：** SystemCapability.Communication.WiFi.STA @@ -2273,22 +2275,24 @@ on(type: "streamChange", callback: Callback<number>): void | type | string | 是 | 固定填"streamChange"字符串。 | | callback | Callback<number> | 是 | 状态改变回调函数，返回0:无，1：向下，2：向上，3：双向。 | -## wifi.off('streamChange')7+ +## wifi.off('streamChange')9+ -off(type: "streamChange", callback: Callback<number>): void +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：双向。 | +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 固定填"streamChange"字符串。 | +| callback | Callback<number> | 否| 状态改变回调函数，返回0:无，1：向下，2：向上，3：双向。 | **示例：** ```js @@ -2364,7 +2368,7 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void | type | string | 是 | 固定填"hotspotStateChange"字符串。 | | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | -## wifi.on('hotspotStaJoin')7+ +## wifi.on('hotspotStaJoin')9+ on(type: "hotspotStaJoin", callback: Callback<StationInfo>): void @@ -2372,6 +2376,8 @@ on(type: "hotspotStaJoin", callback: Callback<StationInfo>): void **需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT +**系统接口：** 此接口为系统接口。 + **系统能力：** SystemCapability.Communication.WiFi.AP.Core **参数：** @@ -2381,14 +2387,16 @@ on(type: "hotspotStaJoin", callback: Callback<StationInfo>): void | type | string | 是 | 固定填"hotspotStaJoin"字符串。 | | callback | Callback<StationInfo> | 是 | 状态改变回调函数。 | -## wifi.off('hotspotStaJoin')7+ +## wifi.off('hotspotStaJoin')9+ -off(type: "hotspotStaJoin", callback: Callback<StationInfo>): void +off(type: "hotspotStaJoin", callback?: Callback<StationInfo>): void 取消注册wifi热点sta加入事件。 **需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT +**系统接口：** 此接口为系统接口。 + **系统能力：** SystemCapability.Communication.WiFi.AP.Core **参数：** @@ -2396,7 +2404,7 @@ off(type: "hotspotStaJoin", callback: Callback<StationInfo>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"hotspotStaJoin"字符串。 | - | callback | Callback<StationInfo> | 是 | 状态改变回调函数。 | + | callback | Callback<StationInfo> | 否 | 状态改变回调函数。 | **示例：** ```js @@ -2414,7 +2422,7 @@ wifi.off("hotspotStaJoin", recvHotspotStaJoinFunc); ``` -## wifi.on('hotspotStaLeave')7+ +## wifi.on('hotspotStaLeave')9+ on(type: "hotspotStaLeave", callback: Callback<StationInfo>): void @@ -2422,6 +2430,8 @@ on(type: "hotspotStaLeave", callback: Callback<StationInfo>): void **需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT +**系统接口：** 此接口为系统接口。 + **系统能力：** SystemCapability.Communication.WiFi.AP.Core **参数：** @@ -2431,14 +2441,16 @@ on(type: "hotspotStaLeave", callback: Callback<StationInfo>): void | type | string | 是 | 固定填"hotspotStaLeave"字符串。 | | callback | Callback<StationInf]> | 是 | 状态改变回调函数。 | -## wifi.off('hotspotStaLeave')7+ +## wifi.off('hotspotStaLeave')9+ -off(type: "hotspotStaLeave", callback: Callback<StationInfo>): void +off(type: "hotspotStaLeave", callback?: Callback<StationInfo>): void 取消注册wifi热点sta离开事件。 **需要权限：** ohos.permission.MANAGE_WIFI_HOTSPOT +**系统接口：** 此接口为系统接口。 + **系统能力：** SystemCapability.Communication.WiFi.AP.Core **参数：** @@ -2446,7 +2458,7 @@ off(type: "hotspotStaLeave", callback: Callback<StationInfo>): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | | type | string | 是 | 固定填"hotspotStaLeave"字符串。 | - | callback | Callback<StationInf]> | 是 | 状态改变回调函数。 | + | callback | Callback<StationInf]> | 否 | 状态改变回调函数。 | **示例：** ```js 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 e274ddc2599b46de66a41631f4bdc6791f729e34..ea652df5e63f4b28162e8879e859be1196a34885 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifiManager.md @@ -173,7 +173,7 @@ startScan(): void console.error("failed:" + JSON.stringify(error)); } ``` -## wifiManager.getScanResults10+ +## wifiManager.getScanResults9+ getScanResults(): Promise<Array<WifiScanInfo>> @@ -197,7 +197,7 @@ getScanResults(): Promise<Array<WifiScanInfo>> | -------- | -------- | | 2501000 | Operation failed.| -## wifiManager.getScanResults10+ +## wifiManager.getScanResults9+ getScanResults(callback: AsyncCallback<Array<WifiScanInfo>>): void @@ -263,7 +263,7 @@ getScanResults(callback: AsyncCallback<Array<WifiScanInfo>>): void }); ``` -## wifiManager.getScanResultsSync10+ +## wifiManager.getScanResultsSync9+ getScanResultsSync():  Array<[WifiScanInfo](#wifiscaninfo)> @@ -516,7 +516,6 @@ setScanAlwaysAllowed(isScanAlwaysAllowed: boolean): void try { let isScanAlwaysAllowed = true; wifiManager.setScanAlwaysAllowed(isScanAlwaysAllowed); - }); }catch(error){ console.error("failed:" + JSON.stringify(error)); } @@ -530,7 +529,7 @@ getScanAlwaysAllowed(): boolean **系统接口：** 此接口为系统接口。 -**需要权限：** ohos.permission.SET_WIFI_INFO 和 ohos.permission.SET_WIFI_CONFIG +**需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.GET_WIFI_CONFIG **系统能力：** SystemCapability.Communication.WiFi.STA @@ -555,7 +554,7 @@ getScanAlwaysAllowed(): boolean try { let isScanAlwaysAllowed = wifiManager.getScanAlwaysAllowed(); - console.info("isScanAlwaysAllowed:" + ret); + console.info("isScanAlwaysAllowed:" + isScanAlwaysAllowed); }catch(error){ console.error("failed:" + JSON.stringify(error)); } @@ -683,9 +682,9 @@ IP配置信息。 | identity | string | 是 | 否 | 身份信息。 | | anonymousIdentity | string | 是 | 否 | 匿名身份。 | | password | string | 是 | 否 | 密码。 | -| caCertAliases | string | 是 | 否 | CA 证书别名。 | +| caCertAlias | string | 是 | 否 | CA 证书别名。 | | caPath | string | 是 | 否 | CA 证书路径。 | -| clientCertAliases | string | 是 | 否 | 客户端证书别名。 | +| clientCertAlias | string | 是 | 否 | 客户端证书别名。 | | certEntry | Uint8Array | 是 | 是 | CA 证书内容。 | | certPassword | string | 是 | 是 | CA证书密码。 | | altSubjectMatch | string | 是 | 否 | 替代主题匹配。 | @@ -1841,7 +1840,7 @@ updateNetwork(config: WifiDeviceConfig): number ## wifiManager.disableNetwork9+ -disableNetwork(networkId: number): void +disableNetwork(netId: number): void 去使能网络配置。 @@ -1855,7 +1854,7 @@ disableNetwork(networkId: number): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | - | networkId | number | 是 | 网络配置ID。 | + | netId | number | 是 | 网络配置ID。 | **错误码：** @@ -1910,7 +1909,7 @@ removeAllNetwork(): void ## wifiManager.removeDevice9+ -removeDevice(networkId: number): void +removeDevice(id: number): void 移除指定的网络配置。 @@ -1924,7 +1923,7 @@ removeDevice(networkId: number): void | **参数名** | **类型** | **必填** | **说明** | | -------- | -------- | -------- | -------- | - | networkId | number | 是 | 网络配置ID。 | + | id | number | 是 | 网络配置ID。 | **错误码：** @@ -2868,7 +2867,7 @@ p2pConnect(config: WifiP2PConfig): void setTimeout(function() {wifiManager.off("p2pDeviceChange", recvP2pDeviceChangeFunc);}, 125 * 1000); setTimeout(function() {wifiManager.off("p2pPeerDeviceChange", recvP2pPeerDeviceChangeFunc);}, 125 * 1000); setTimeout(function() {wifiManager.off("p2pPersistentGroupChange", recvP2pPersistentGroupChangeFunc);}, 125 * 1000); - console.info("start discover devices -> " + wifiManager.startDiscoverP2pDevices()); + console.info("start discover devices -> " + wifiManager.startDiscoverDevices()); ``` ## wifiManager.p2pCancelConnect9+ @@ -2899,13 +2898,30 @@ p2pCancelConnect(): void console.error("failed:" + JSON.stringify(error)); } ``` - ## wifiManager.startDiscoverDevices10+ startDiscoverDevices(): void 开始发现设备。 +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.P2P + +**错误码：** + +以下错误码的详细介绍请参见[WIFI错误码](../errorcodes/errorcode-wifi.md)。 + +| **错误码ID** | **错误信息** | + | -------- | -------- | +| 2801000 | Operation failed.| + +## wifiManager.startDiscoverDevices9+ + +startDiscoverDevices(): void + +开始发现设备。 + **需要权限：** ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION **系统能力：** SystemCapability.Communication.WiFi.P2P @@ -2929,7 +2945,7 @@ startDiscoverDevices(): void } ``` -## wifiManager.stopDiscoverDevices10+ +## wifiManager.stopDiscoverDevices9+ stopDiscoverDevices(): void @@ -3381,10 +3397,10 @@ off(type: "wifiRssiChange", callback?: Callback<number>): void **参数：** - | **参数名** | **类型** | **必填** | **说明** | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 固定填"wifiRssiChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 固定填"wifiRssiChange"字符串。 | +| callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** @@ -3407,6 +3423,108 @@ off(type: "wifiRssiChange", callback?: Callback<number>): void // Unregister event wifiManager.off("wifiRssiChange", recvWifiRssiChangeFunc); +``` + ## wifiManager.on('streamChange')9+ + +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：双向。 | + +## wifiManager.off('streamChange')9+ + +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); + +``` +## wifiManager.on('deviceConfigChange')9+ + +on(type: "deviceConfigChange", callback: Callback<number>): void + +注册WIFI设备配置更改事件。 + +**需要权限：** ohos.permission.GET_WIFI_INFO + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 固定填"streamChange"字符串。 | +| callback | Callback<number> | 是 | 状态改变回调函数，返回0: 添加配置, 1: 更改配置, 2: 删除配置. | + +## wifiManager.off('deviceConfigChange')9+ + +off(type: "deviceConfigChange", callback: Callback<number>): void + +取消注册WIFI设备配置更改事件。 + +**需要权限：** ohos.permission.MANAGE_WIFI_CONNECTION + +**系统能力：** SystemCapability.Communication.WiFi.STA + +**参数：** + +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 固定填"streamChange"字符串。 | +| callback | Callback<number> | 是 | 状态改变回调函数，返回0: 添加配置, 1: 更改配置, 2: 删除配置.| + +**示例：** +```js +import wifi from '@ohos.wifi'; + +var recvDeviceConfigChangeFunc = result => { + console.info("Receive device config change event: " + result); +} + +// Register event +wifi.on("deviceConfigChange", recvDeviceConfigChangeFunc); + +// Unregister event +wifi.off("deviceConfigChange", recvDeviceConfigChangeFunc); + ``` ## wifiManager.on('hotspotStateChange')9+ @@ -3421,10 +3539,10 @@ on(type: "hotspotStateChange", callback: Callback<number>): void **参数：** - | **参数名** | **类型** | **必填** | **说明** | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 固定填"hotspotStateChange"字符串。 | - | callback | Callback<number> | 是 | 状态改变回调函数。 | +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 固定填"hotspotStateChange"字符串。 | +| callback | Callback<number> | 是 | 状态改变回调函数。 | **热点状态改变事件的枚举：** @@ -3455,10 +3573,10 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void **参数：** - | **参数名** | **类型** | **必填** | **说明** | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 固定填"hotspotStateChange"字符串。 | - | callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 固定填"hotspotStateChange"字符串。 | +| callback | Callback<number> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：** @@ -3483,6 +3601,114 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void 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 + +**参数：** + +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 固定填"hotspotStaJoin"字符串。 | +| callback | Callback<StationInfo> | 是 | 状态改变回调函数。 | + +## wifiManager.off('hotspotStaJoin')9+ + +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); + +``` + +## wifiManager.on('hotspotStaLeave')9+ + +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]> | 是 | 状态改变回调函数。 | + +## wifiManager.off('hotspotStaLeave')9+ + +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); + +``` + ## wifiManager.on('p2pStateChange')9+ on(type: "p2pStateChange", callback: Callback<number>): void @@ -3495,12 +3721,12 @@ on(type: "p2pStateChange", callback: Callback<number>): void **参数：** - | **参数名** | **类型** | **必填** | **说明** | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 固定填"p2pStateChange"字符串。 | - | callback | Callback<number> | 是 | 状态改变回调函数。 | +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 固定填"p2pStateChange"字符串。 | +| callback | Callback<number> | 是 | 状态改变回调函数。 | -**P2P状态改变事件的枚举：** +** P2P状态改变事件的枚举：** | **枚举值** | **说明** | | -------- | -------- | @@ -3790,10 +4016,10 @@ off(type: "p2pPersistentGroupChange", callback?: Callback<void>): void **参数：** - | **参数名** | **类型** | **必填** | **说明** | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 | - | callback | Callback<void> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | +| **参数名** | **类型** | **必填** | **说明** | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 固定填"p2pPersistentGroupChange"字符串。 | +| callback | Callback<void> | 否 | 状态改变回调函数。如果callback不填，将取消注册该事件关联的所有回调函数。 | **错误码：**