Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
10bec5b4
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
10bec5b4
编写于
12月 06, 2022
作者:
O
openharmony_ci
提交者:
Gitee
12月 06, 2022
浏览文件
操作
浏览文件
下载
差异文件
!12140 【仅修改md格式】WifiManager对应接口规范整改
Merge pull request !12140 from xiaosi/master
上级
123c8a9e
bb6818a2
变更
2
显示空白变更内容
内联
并排
Showing
2 changed file
with
193 addition
and
295 deletion
+193
-295
zh-cn/application-dev/reference/apis/js-apis-wifi.md
zh-cn/application-dev/reference/apis/js-apis-wifi.md
+11
-30
zh-cn/application-dev/reference/apis/js-apis-wifiManager.md
zh-cn/application-dev/reference/apis/js-apis-wifiManager.md
+182
-265
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-wifi.md
浏览文件 @
10bec5b4
...
@@ -166,7 +166,7 @@ WLAN热点信息。
...
@@ -166,7 +166,7 @@ WLAN热点信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
...
@@ -243,7 +243,7 @@ WLAN配置信息。
...
@@ -243,7 +243,7 @@ WLAN配置信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
...
@@ -283,7 +283,7 @@ IP配置信息。
...
@@ -283,7 +283,7 @@ IP配置信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ipAddress | number | 是 | 否 | IP地址。 |
| ipAddress | number | 是 | 否 | IP地址。 |
| gateway | number | 是 | 否 | 网关。 |
| gateway | number | 是 | 否 | 网关。 |
...
@@ -547,7 +547,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
...
@@ -547,7 +547,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
...
@@ -725,7 +725,7 @@ IP信息。
...
@@ -725,7 +725,7 @@ IP信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ipAddress | number | 是 | 否 | IP地址。 |
| ipAddress | number | 是 | 否 | IP地址。 |
| gateway | number | 是 | 否 | 网关。 |
| gateway | number | 是 | 否 | 网关。 |
...
@@ -1013,7 +1013,7 @@ setHotspotConfig(config: HotspotConfig): boolean
...
@@ -1013,7 +1013,7 @@ setHotspotConfig(config: HotspotConfig): boolean
**系统能力:**
SystemCapability.Communication.WiFi.AP.Core
**系统能力:**
SystemCapability.Communication.WiFi.AP.Core
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| securityType |
[
WifiSecurityType
](
#wifisecuritytype
)
| 是 | 否 | 加密类型。 |
| securityType |
[
WifiSecurityType
](
#wifisecuritytype
)
| 是 | 否 | 加密类型。 |
...
@@ -1068,7 +1068,7 @@ getStations(): Array<[StationInfo](#stationinfo7)>
...
@@ -1068,7 +1068,7 @@ getStations(): Array<[StationInfo](#stationinfo7)>
**系统能力:**
SystemCapability.Communication.WiFi.AP.Core
**系统能力:**
SystemCapability.Communication.WiFi.AP.Core
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| name | string | 是 | 否 | 设备名称。 |
| name | string | 是 | 否 | 设备名称。 |
| macAddress | string | 是 | 否 | MAC地址。 |
| macAddress | string | 是 | 否 | MAC地址。 |
...
@@ -1099,7 +1099,7 @@ getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo>
...
@@ -1099,7 +1099,7 @@ getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo>
**系统能力:**
SystemCapability.Communication.WiFi.P2P
**系统能力:**
SystemCapability.Communication.WiFi.P2P
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| connectState |
[
P2pConnectState
](
#p2pconnectstate8
)
| 是 | 否 | P2P连接状态。 |
| connectState |
[
P2pConnectState
](
#p2pconnectstate8
)
| 是 | 否 | P2P连接状态。 |
| isGroupOwner | boolean | 是 | 否 | 是否是群主。 |
| isGroupOwner | boolean | 是 | 否 | 是否是群主。 |
...
@@ -1209,7 +1209,7 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void
...
@@ -1209,7 +1209,7 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void
**系统能力:**
SystemCapability.Communication.WiFi.P2P
**系统能力:**
SystemCapability.Communication.WiFi.P2P
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| deviceName | string | 是 | 否 | 设备名称。 |
| deviceName | string | 是 | 否 | 设备名称。 |
| deviceAddress | string | 是 | 否 | 设备MAC地址。 |
| deviceAddress | string | 是 | 否 | 设备MAC地址。 |
...
@@ -1262,7 +1262,7 @@ createGroup(config: WifiP2PConfig): boolean
...
@@ -1262,7 +1262,7 @@ createGroup(config: WifiP2PConfig): boolean
**系统能力:**
SystemCapability.Communication.WiFi.P2P
**系统能力:**
SystemCapability.Communication.WiFi.P2P
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| deviceAddress | string | 是 | 否 | 设备地址。 |
| deviceAddress | string | 是 | 否 | 设备地址。 |
| netId | number | 是 | 否 | 网络ID。创建群组时-1表示创建临时组,-2表示创建永久组。 |
| netId | number | 是 | 否 | 网络ID。创建群组时-1表示创建临时组,-2表示创建永久组。 |
...
@@ -1475,7 +1475,7 @@ deletePersistentGroup(netId: number): boolean
...
@@ -1475,7 +1475,7 @@ deletePersistentGroup(netId: number): boolean
**系统能力:**
SystemCapability.Communication.WiFi.P2P
**系统能力:**
SystemCapability.Communication.WiFi.P2P
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| isP2pGo | boolean | 是 | 否 | 是否是群主。 |
| isP2pGo | boolean | 是 | 否 | 是否是群主。 |
| ownerInfo |
[
WifiP2pDevice
](
#wifip2pdevice8
)
| 是 | 否 | 群组的设备信息。 |
| ownerInfo |
[
WifiP2pDevice
](
#wifip2pdevice8
)
| 是 | 否 | 群组的设备信息。 |
...
@@ -1488,25 +1488,6 @@ deletePersistentGroup(netId: number): boolean
...
@@ -1488,25 +1488,6 @@ deletePersistentGroup(netId: number): boolean
| goIpAddress | string | 是 | 否 | 群组IP地址。 |
| goIpAddress | string | 是 | 否 | 群组IP地址。 |
## wifi.getP2pGroups<sup>9+</sup>
getP2pGroups(callback: AsyncCallback
<
Array
<
WifiP2pGroupInfo
>>
): void
获取创建的所有P2P群组信息,使用callback方式作为异步方法。
**系统接口:**
此接口为系统接口。
**需要权限:**
ohos.permission.GET_WIFI_INFO 和 ohos.permission.LOCATION
**系统能力:**
SystemCapability.Communication.WiFi.P2P
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
Array
<
[WifiP2pGroupInfo](#wifip2pgroupinfo8)
>>
| 是 | 回调函数。当操作成功时,err为0,data表示所有群组信息。如果error为非0,表示处理出现错误。 |
## wifi.setDeviceName<sup>8+</sup>
## wifi.setDeviceName<sup>8+</sup>
setDeviceName(devName: string): boolean
setDeviceName(devName: string): boolean
...
...
zh-cn/application-dev/reference/apis/js-apis-wifiManager.md
浏览文件 @
10bec5b4
...
@@ -11,9 +11,9 @@
...
@@ -11,9 +11,9 @@
import
wifiManager
from
'
@ohos.wifiManager
'
;
import
wifiManager
from
'
@ohos.wifiManager
'
;
```
```
## wifi.enableWifi
## wifi.enableWifi
<sup>9+</sup>
enableWifi():
boolean
enableWifi():
void
使能WLAN。
使能WLAN。
...
@@ -30,9 +30,9 @@ enableWifi(): boolean
...
@@ -30,9 +30,9 @@ enableWifi(): boolean
| boolean | true:操作成功,
false:操作失败。|
| boolean | true:操作成功,
false:操作失败。|
## wifi.disableWifi
## wifi.disableWifi
<sup>9+</sup>
disableWifi():
boolean
disableWifi():
void
去使能WLAN。
去使能WLAN。
...
@@ -49,7 +49,7 @@ disableWifi(): boolean
...
@@ -49,7 +49,7 @@ disableWifi(): boolean
| boolean | true:操作成功,
false:操作失败。|
| boolean | true:操作成功,
false:操作失败。|
## wifi.isWifiActive
## wifi.isWifiActive
<sup>9+</sup>
isWifiActive(): boolean
isWifiActive(): boolean
...
@@ -66,9 +66,9 @@ isWifiActive(): boolean
...
@@ -66,9 +66,9 @@ isWifiActive(): boolean
| boolean | true:已使能,
false:未使能。 |
| boolean | true:已使能,
false:未使能。 |
## wifi.scan
## wifi.scan
<sup>9+</sup>
scan():
boolean
scan():
void
启动WLAN扫描。
启动WLAN扫描。
...
@@ -83,9 +83,9 @@ scan(): boolean
...
@@ -83,9 +83,9 @@ scan(): boolean
| boolean | true:扫描操作执行成功,
false:扫描操作执行失败。 |
| boolean | true:扫描操作执行成功,
false:扫描操作执行失败。 |
## wifi.getScan
Infos
## wifi.getScan
Results<sup>9+</sup>
getScan
Info
s(): Promise
<
Array
<
WifiScanInfo
>>
getScan
Result
s(): Promise
<
Array
<
WifiScanInfo
>>
获取扫描结果,使用Promise异步回调。
获取扫描结果,使用Promise异步回调。
...
@@ -100,9 +100,9 @@ getScanInfos(): Promise<Array<WifiScanInfo>>
...
@@ -100,9 +100,9 @@ getScanInfos(): Promise<Array<WifiScanInfo>>
| Promise
<
Array
<
[WifiScanInfo](#wifiscaninfo)
> >
| Promise对象。返回扫描到的热点列表。 |
| Promise
<
Array
<
[WifiScanInfo](#wifiscaninfo)
> >
| Promise对象。返回扫描到的热点列表。 |
## wifi.getScan
Infos
## wifi.getScan
Results<sup>9+</sup>
getScan
Info
s(callback: AsyncCallback
<
Array
<
WifiScanInfo
>>
): void
getScan
Result
s(callback: AsyncCallback
<
Array
<
WifiScanInfo
>>
): void
获取扫描结果,使用callback异步回调。
获取扫描结果,使用callback异步回调。
...
@@ -159,14 +159,14 @@ getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void
...
@@ -159,14 +159,14 @@ getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void
```
```
## WifiScanInfo
## WifiScanInfo
<sup>9+</sup>
WLAN热点信息。
WLAN热点信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
...
@@ -176,13 +176,13 @@ WLAN热点信息。
...
@@ -176,13 +176,13 @@ WLAN热点信息。
| band | number | 是 | 否 | WLAN接入点的频段。 |
| band | number | 是 | 否 | WLAN接入点的频段。 |
| frequency | number | 是 | 否 | WLAN接入点的频率。 |
| frequency | number | 是 | 否 | WLAN接入点的频率。 |
| channelWidth | number | 是 | 否 | WLAN接入点的带宽。 |
| channelWidth | number | 是 | 否 | WLAN接入点的带宽。 |
| centerFrequency0
<sup>
9+
</sup>
| number | 是 | 否 | 热点的中心频率。 |
| centerFrequency0 | number | 是 | 否 | 热点的中心频率。 |
| centerFrequency1
<sup>
9+
</sup>
| number | 是 | 否 | 热点的中心频率。如果热点使用两个不重叠的WLAN信道,则返回两个中心频率,分别用centerFrequency0和centerFrequency1表示。 |
| centerFrequency1 | number | 是 | 否 | 热点的中心频率。如果热点使用两个不重叠的WLAN信道,则返回两个中心频率,分别用centerFrequency0和centerFrequency1表示。 |
| infoElems
<sup>
9+
</sup>
| Array
<
[WifiInfoElem](#wifiinfoelem9)
>
| 是 | 否 | 信息元素。 |
| infoElems | Array
<
[WifiInfoElem](#wifiinfoelem9)
>
| 是 | 否 | 信息元素。 |
| timestamp | number | 是 | 否 | 时间戳。 |
| timestamp | number | 是 | 否 | 时间戳。 |
## WifiSecurityType
## WifiSecurityType
<sup>9+</sup>
表示加密类型的枚举。
表示加密类型的枚举。
...
@@ -207,15 +207,13 @@ WLAN热点信息。
...
@@ -207,15 +207,13 @@ WLAN热点信息。
WLAN热点信息。
WLAN热点信息。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名**
|
**类型**
|
**读写属性
**
|
**说明**
|
|
**
名称**
|
**类型**
|
**可读**
|
**可写
**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
-------- |
| eid | number |
只读
| 元素ID。 |
| eid | number |
是 | 否
| 元素ID。 |
| content | Uint8Array |
只读
| 元素内容。 |
| content | Uint8Array |
是 | 否
| 元素内容。 |
## WifiChannelWidth<sup>9+</sup>
## WifiChannelWidth<sup>9+</sup>
...
@@ -225,7 +223,7 @@ WLAN热点信息。
...
@@ -225,7 +223,7 @@ WLAN热点信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**名称**
|
**
默认
值**
|
**说明**
|
|
**名称**
|
**值**
|
**说明**
|
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| WIDTH_20MHZ | 0 | 20MHZ。 |
| WIDTH_20MHZ | 0 | 20MHZ。 |
| WIDTH_40MHZ | 1 | 40MHZ。 |
| WIDTH_40MHZ | 1 | 40MHZ。 |
...
@@ -235,9 +233,9 @@ WLAN热点信息。
...
@@ -235,9 +233,9 @@ WLAN热点信息。
| WIDTH_INVALID | 5 | 无效值 |
| WIDTH_INVALID | 5 | 无效值 |
## wifi.getScan
Info
sSync<sup>9+</sup>
## wifi.getScan
Result
sSync<sup>9+</sup>
getScan
Info
sSync():
Array
<
[WifiScanInfo](#wifiscaninfo)
>
getScan
Result
sSync():
Array
<
[WifiScanInfo](#wifiscaninfo)
>
获取扫描结果,使用同步方式返回结果。
获取扫描结果,使用同步方式返回结果。
...
@@ -252,7 +250,7 @@ getScanInfosSync(): Array<[WifiScanInfo](#wifiscaninfo)>
...
@@ -252,7 +250,7 @@ getScanInfosSync(): Array<[WifiScanInfo](#wifiscaninfo)>
|
Array
<
[WifiScanInfo](#wifiscaninfo)
>
| 扫描结果数组。 |
|
Array
<
[WifiScanInfo](#wifiscaninfo)
>
| 扫描结果数组。 |
## wifi.addDeviceConfig
## wifi.addDeviceConfig
<sup>9+</sup>
addDeviceConfig(config: WifiDeviceConfig): Promise
<
number
>
addDeviceConfig(config: WifiDeviceConfig): Promise
<
number
>
...
@@ -276,14 +274,14 @@ addDeviceConfig(config: WifiDeviceConfig): Promise<number>
...
@@ -276,14 +274,14 @@ addDeviceConfig(config: WifiDeviceConfig): Promise<number>
| -------- | -------- |
| -------- | -------- |
| Promise
<
number
>
| Promise对象。返回添加的网络配置ID,如果值为-1表示添加失败。 |
| Promise
<
number
>
| Promise对象。返回添加的网络配置ID,如果值为-1表示添加失败。 |
## WifiDeviceConfig
## WifiDeviceConfig
<sup>9+</sup>
WLAN配置信息。
WLAN配置信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
...
@@ -295,12 +293,12 @@ WLAN配置信息。
...
@@ -295,12 +293,12 @@ WLAN配置信息。
| netId | number | 是 | 否 | 分配的网络ID。
<br
/>
**系统接口:**
此接口为系统接口。 |
| netId | number | 是 | 否 | 分配的网络ID。
<br
/>
**系统接口:**
此接口为系统接口。 |
| randomMacType | number | 是 | 否 | 随机MAC类型。
<br
/>
**系统接口:**
此接口为系统接口。 |
| randomMacType | number | 是 | 否 | 随机MAC类型。
<br
/>
**系统接口:**
此接口为系统接口。 |
| randomMacAddr | string | 是 | 否 | 随机MAC地址。
<br
/>
**系统接口:**
此接口为系统接口。 |
| randomMacAddr | string | 是 | 否 | 随机MAC地址。
<br
/>
**系统接口:**
此接口为系统接口。 |
| ipType |
[
IpType
](
#iptype
7
)
| 是 | 否 | IP地址类型。
<br
/>
**系统接口:**
此接口为系统接口。 |
| ipType |
[
IpType
](
#iptype
9
)
| 是 | 否 | IP地址类型。
<br
/>
**系统接口:**
此接口为系统接口。 |
| staticIp |
[
IpConfig
](
#ipconfig
7
)
| 是 | 否 | 静态IP配置信息。
<br
/>
**系统接口:**
此接口为系统接口。 |
| staticIp |
[
IpConfig
](
#ipconfig
9
)
| 是 | 否 | 静态IP配置信息。
<br
/>
**系统接口:**
此接口为系统接口。 |
| eapConfig
<sup>
9+
</sup>
|
[
WifiEapConfig
](
#wifieapconfig9
)
| 是 | 否 | 可扩展身份验证协议配置。
<br
/>
**系统接口:**
此接口为系统接口。 |
| eapConfig
<sup>
9+
</sup>
|
[
WifiEapConfig
](
#wifieapconfig9
)
| 是 | 否 | 可扩展身份验证协议配置。
<br
/>
**系统接口:**
此接口为系统接口。 |
## IpType<sup>
7
+</sup>
## IpType<sup>
9
+</sup>
表示IP类型的枚举。
表示IP类型的枚举。
...
@@ -316,7 +314,7 @@ WLAN配置信息。
...
@@ -316,7 +314,7 @@ WLAN配置信息。
| UNKNOWN | 2 | 未指定。 |
| UNKNOWN | 2 | 未指定。 |
## IpConfig<sup>
7
+</sup>
## IpConfig<sup>
9
+</sup>
IP配置信息。
IP配置信息。
...
@@ -324,10 +322,11 @@ IP配置信息。
...
@@ -324,10 +322,11 @@ IP配置信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ipAddress | number | 是 | 否 | IP地址。 |
| ipAddress | number | 是 | 否 | IP地址。 |
| gateway | number | 是 | 否 | 网关。 |
| gateway | number | 是 | 否 | 网关。 |
| prefixLength | number | 是 | 否 | 掩码。 |
| dnsServers | number[] | 是 | 否 | DNS服务器。 |
| dnsServers | number[] | 是 | 否 | DNS服务器。 |
| domains | Array
<
string
>
| 是 | 否 | 域信息。 |
| domains | Array
<
string
>
| 是 | 否 | 域信息。 |
...
@@ -340,21 +339,21 @@ IP配置信息。
...
@@ -340,21 +339,21 @@ IP配置信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名**
|
**类型**
|
**读写属性
**
|
**说明**
|
|
**
名称**
|
**类型**
|
**可读**
|
**可写
**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
-------- |
| eapMethod |
[
EapMethod
](
#eapmethod9
)
|
只读
| EAP认证方式。 |
| eapMethod |
[
EapMethod
](
#eapmethod9
)
|
是 | 否
| EAP认证方式。 |
| phase2Method |
[
Phase2Method
](
#phase2method9
)
|
只读
| 第二阶段认证方式。 |
| phase2Method |
[
Phase2Method
](
#phase2method9
)
|
是 | 否
| 第二阶段认证方式。 |
| identity | string |
只读
| 身份信息。 |
| identity | string |
是 | 否
| 身份信息。 |
| anonymousIdentity | string |
只读
| 匿名身份。 |
| anonymousIdentity | string |
是 | 否
| 匿名身份。 |
| password | string |
只读
| 密码。 |
| password | string |
是 | 否
| 密码。 |
| caCertAliases | string |
只读
| CA 证书别名。 |
| caCertAliases | string |
是 | 否
| CA 证书别名。 |
| caPath | string |
只读
| CA 证书路径。 |
| caPath | string |
是 | 否
| CA 证书路径。 |
| clientCertAliases | string |
只读
| 客户端证书别名。 |
| clientCertAliases | string |
是 | 否
| 客户端证书别名。 |
| altSubjectMatch | string |
只读
| 替代主题匹配。 |
| altSubjectMatch | string |
是 | 否
| 替代主题匹配。 |
| domainSuffixMatch | string |
只读
| 域后缀匹配。 |
| domainSuffixMatch | string |
是 | 否
| 域后缀匹配。 |
| realm | string |
只读
| 通行证凭证的领域。 |
| realm | string |
是 | 否
| 通行证凭证的领域。 |
| plmn | string |
只读
| 公共陆地移动网的直通凭证提供商。 |
| plmn | string |
是 | 否
| 公共陆地移动网的直通凭证提供商。 |
| eapSubId | number |
只读
| SIM卡的子ID。 |
| eapSubId | number |
是 | 否
| SIM卡的子ID。 |
## EapMethod<sup>9+</sup>
## EapMethod<sup>9+</sup>
...
@@ -365,7 +364,7 @@ IP配置信息。
...
@@ -365,7 +364,7 @@ IP配置信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
| 名称 |
默认
值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| EAP_NONE | 0 | 不指定。 |
| EAP_NONE | 0 | 不指定。 |
| EAP_PEAP | 1 | PEAP类型。 |
| EAP_PEAP | 1 | PEAP类型。 |
...
@@ -386,7 +385,7 @@ IP配置信息。
...
@@ -386,7 +385,7 @@ IP配置信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
| 名称 |
默认
值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| PHASE2_NONE | 0 | 不指定。 |
| PHASE2_NONE | 0 | 不指定。 |
| PHASE2_PAP | 1 | PAP类型。 |
| PHASE2_PAP | 1 | PAP类型。 |
...
@@ -398,7 +397,7 @@ IP配置信息。
...
@@ -398,7 +397,7 @@ IP配置信息。
| PHASE2_AKA_PRIME | 7 | AKA Prime类型。 |
| PHASE2_AKA_PRIME | 7 | AKA Prime类型。 |
## wifi.addDeviceConfig
## wifi.addDeviceConfig
<sup>9+</sup>
addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback
<
number
>
): void
addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback
<
number
>
): void
...
@@ -418,88 +417,6 @@ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>)
...
@@ -418,88 +417,6 @@ addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>)
| callback | AsyncCallback
<
number
>
| 是 | 回调函数。当操作成功时,err为0,data为添加的网络配置ID,如果data值为-1,表示添加失败。当error为非0,表示处理出现错误。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数。当操作成功时,err为0,data为添加的网络配置ID,如果data值为-1,表示添加失败。当error为非0,表示处理出现错误。 |
## wifi.addUntrustedConfig<sup>7+</sup>
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.addUntrustedConfig<sup>7+</sup>
addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback
<
boolean
>
): void
添加不可信网络配置,使用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.removeUntrustedConfig<sup>7+</sup>
removeUntrustedConfig(config: WifiDeviceConfig): Promise
<
boolean
>
移除不可信网络配置,使用Promise异步回调。
**需要权限:**
ohos.permission.SET_WIFI_INFO
**系统能力:**
SystemCapability.Communication.WiFi.STA
**参数:**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| config |
[
WifiDeviceConfig
](
#wifideviceconfig
)
| 是 | WLAN配置信息。 |
**返回值:**
|
**类型**
|
**说明**
|
| -------- | -------- |
| Promise
<
boolean
>
| Promise对象。表示操作结果,true: 成功, false: 失败。 |
## wifi.removeUntrustedConfig<sup>7+</sup>
removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback
<
boolean
>
): void
移除不可信网络配置,使用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.addCandidateConfig<sup>9+</sup>
## wifi.addCandidateConfig<sup>9+</sup>
addCandidateConfig(config: WifiDeviceConfig): Promise
<
number
>
addCandidateConfig(config: WifiDeviceConfig): Promise
<
number
>
...
@@ -616,9 +533,9 @@ connectToCandidateConfig(networkId: number): void
...
@@ -616,9 +533,9 @@ connectToCandidateConfig(networkId: number): void
| networkId | number | 是 | 候选网络配置的ID。 |
| networkId | number | 是 | 候选网络配置的ID。 |
## wifi.connectToNetwork
## wifi.connectToNetwork
<sup>9+</sup>
connectToNetwork(networkId: number):
boolean
connectToNetwork(networkId: number):
void
连接到指定网络。
连接到指定网络。
...
@@ -641,9 +558,9 @@ connectToNetwork(networkId: number): boolean
...
@@ -641,9 +558,9 @@ connectToNetwork(networkId: number): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## wifi.connectToDevice
## wifi.connectToDevice
<sup>9+</sup>
connectToDevice(config: WifiDeviceConfig):
boolean
connectToDevice(config: WifiDeviceConfig):
void
连接到指定网络。
连接到指定网络。
...
@@ -667,9 +584,9 @@ connectToDevice(config: WifiDeviceConfig): boolean
...
@@ -667,9 +584,9 @@ connectToDevice(config: WifiDeviceConfig): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## wifi.disconnect
## wifi.disconnect
<sup>9+</sup>
disconnect():
boolean
disconnect():
void
断开连接的网络。
断开连接的网络。
...
@@ -687,7 +604,7 @@ disconnect(): boolean
...
@@ -687,7 +604,7 @@ disconnect(): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## wifi.getSignalLevel
## wifi.getSignalLevel
<sup>9+</sup>
getSignalLevel(rssi: number, band: number): number
getSignalLevel(rssi: number, band: number): number
...
@@ -711,7 +628,7 @@ getSignalLevel(rssi: number, band: number): number
...
@@ -711,7 +628,7 @@ getSignalLevel(rssi: number, band: number): number
| number | 信号强度,取值范围为[0,
4]。 |
| number | 信号强度,取值范围为[0,
4]。 |
## wifi.getLinkedInfo
## wifi.getLinkedInfo
<sup>9+</sup>
getLinkedInfo(): Promise
<
WifiLinkedInfo
>
getLinkedInfo(): Promise
<
WifiLinkedInfo
>
...
@@ -728,7 +645,7 @@ getLinkedInfo(): Promise<WifiLinkedInfo>
...
@@ -728,7 +645,7 @@ getLinkedInfo(): Promise<WifiLinkedInfo>
| Promise
<
[WifiLinkedInfo](#wifilinkedinfo)
>
| Promise对象。表示WLAN连接信息。 |
| Promise
<
[WifiLinkedInfo](#wifilinkedinfo)
>
| Promise对象。表示WLAN连接信息。 |
## wifi.getLinkedInfo
## wifi.getLinkedInfo
<sup>9+</sup>
getLinkedInfo(callback: AsyncCallback
<
WifiLinkedInfo
>
): void
getLinkedInfo(callback: AsyncCallback
<
WifiLinkedInfo
>
): void
...
@@ -764,13 +681,13 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
...
@@ -764,13 +681,13 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
```
```
## WifiLinkedInfo
## WifiLinkedInfo
<sup>9+</sup>
提供WLAN连接的相关信息。
提供WLAN连接的相关信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
| bssid | string | 是 | 否 | 热点的BSSID。 |
...
@@ -790,7 +707,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
...
@@ -790,7 +707,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
| connState |
[
ConnState
](
#connstate
)
| 是 | 否 | WLAN连接状态。 |
| connState |
[
ConnState
](
#connstate
)
| 是 | 否 | WLAN连接状态。 |
## ConnState
## ConnState
<sup>9+</sup>
表示WLAN连接状态的枚举。
表示WLAN连接状态的枚举。
...
@@ -808,7 +725,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
...
@@ -808,7 +725,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
| UNKNOWN | 7 | WLAN连接建立失败。 |
| UNKNOWN | 7 | WLAN连接建立失败。 |
## SuppState
## SuppState
<sup>9+</sup>
表示请求状态的枚举。
表示请求状态的枚举。
...
@@ -832,7 +749,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
...
@@ -832,7 +749,7 @@ getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void
| INVALID | 11 | 无效值。 |
| INVALID | 11 | 无效值。 |
## wifi.isConnected<sup>
7
+</sup>
## wifi.isConnected<sup>
9
+</sup>
isConnected(): boolean
isConnected(): boolean
...
@@ -849,7 +766,7 @@ isConnected(): boolean
...
@@ -849,7 +766,7 @@ isConnected(): boolean
| boolean | true:已连接,
false:未连接。 |
| boolean | true:已连接,
false:未连接。 |
## wifi.getSupportedFeatures<sup>
7
+</sup>
## wifi.getSupportedFeatures<sup>
9
+</sup>
getSupportedFeatures(): number
getSupportedFeatures(): number
...
@@ -883,7 +800,7 @@ getSupportedFeatures(): number
...
@@ -883,7 +800,7 @@ getSupportedFeatures(): number
| 0x20000000 | 增强开放特性。 |
| 0x20000000 | 增强开放特性。 |
## wifi.isFeatureSupported<sup>
7
+</sup>
## wifi.isFeatureSupported<sup>
9
+</sup>
isFeatureSupported(featureId: number): boolean
isFeatureSupported(featureId: number): boolean
...
@@ -907,7 +824,7 @@ isFeatureSupported(featureId: number): boolean
...
@@ -907,7 +824,7 @@ isFeatureSupported(featureId: number): boolean
| boolean | true:支持,
false:不支持。 |
| boolean | true:支持,
false:不支持。 |
## wifi.getDeviceMacAddress<sup>
7
+</sup>
## wifi.getDeviceMacAddress<sup>
9
+</sup>
getDeviceMacAddress(): string[]
getDeviceMacAddress(): string[]
...
@@ -926,7 +843,7 @@ getDeviceMacAddress(): string[]
...
@@ -926,7 +843,7 @@ getDeviceMacAddress(): string[]
| string[] | MAC地址。 |
| string[] | MAC地址。 |
## wifi.getIpInfo<sup>
7
+</sup>
## wifi.getIpInfo<sup>
9
+</sup>
getIpInfo(): IpInfo
getIpInfo(): IpInfo
...
@@ -940,16 +857,16 @@ getIpInfo(): IpInfo
...
@@ -940,16 +857,16 @@ getIpInfo(): IpInfo
|
**类型**
|
**说明**
|
|
**类型**
|
**说明**
|
| -------- | -------- |
| -------- | -------- |
|
[
IpInfo
](
#ipinfo
7
)
| IP信息。 |
|
[
IpInfo
](
#ipinfo
9
)
| IP信息。 |
## IpInfo<sup>
7
+</sup>
## IpInfo<sup>
9
+</sup>
IP信息。
IP信息。
**系统能力:**
SystemCapability.Communication.WiFi.STA
**系统能力:**
SystemCapability.Communication.WiFi.STA
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ipAddress | number | 是 | 否 | IP地址。 |
| ipAddress | number | 是 | 否 | IP地址。 |
| gateway | number | 是 | 否 | 网关。 |
| gateway | number | 是 | 否 | 网关。 |
...
@@ -960,7 +877,7 @@ IP信息。
...
@@ -960,7 +877,7 @@ IP信息。
| leaseDuration | number | 是 | 否 | IP地址租用时长。 |
| leaseDuration | number | 是 | 否 | IP地址租用时长。 |
## wifi.getCountryCode<sup>
7
+</sup>
## wifi.getCountryCode<sup>
9
+</sup>
getCountryCode(): string
getCountryCode(): string
...
@@ -977,9 +894,9 @@ getCountryCode(): string
...
@@ -977,9 +894,9 @@ getCountryCode(): string
| string | 国家码。 |
| string | 国家码。 |
## wifi.reassociate<sup>
7
+</sup>
## wifi.reassociate<sup>
9
+</sup>
reassociate():
boolean
reassociate():
void
重新关联网络。
重新关联网络。
...
@@ -996,9 +913,9 @@ reassociate(): boolean
...
@@ -996,9 +913,9 @@ reassociate(): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## wifi.reconnect<sup>
7
+</sup>
## wifi.reconnect<sup>
9
+</sup>
reconnect():
boolean
reconnect():
void
重新连接网络。
重新连接网络。
...
@@ -1015,7 +932,7 @@ reconnect(): boolean
...
@@ -1015,7 +932,7 @@ reconnect(): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## wifi.getDeviceConfigs<sup>
7
+</sup>
## wifi.getDeviceConfigs<sup>
9
+</sup>
getDeviceConfigs():
Array
<
[WifiDeviceConfig](#wifideviceconfig)
>
getDeviceConfigs():
Array
<
[WifiDeviceConfig](#wifideviceconfig)
>
...
@@ -1034,7 +951,7 @@ getDeviceConfigs(): Array<[WifiDeviceConfig](#wifideviceconfig)>
...
@@ -1034,7 +951,7 @@ getDeviceConfigs(): Array<[WifiDeviceConfig](#wifideviceconfig)>
|
Array
<
[WifiDeviceConfig](#wifideviceconfig)
>
| 网络配置信息的数组。 |
|
Array
<
[WifiDeviceConfig](#wifideviceconfig)
>
| 网络配置信息的数组。 |
## wifi.updateNetwork<sup>
7
+</sup>
## wifi.updateNetwork<sup>
9
+</sup>
updateNetwork(config: WifiDeviceConfig): number
updateNetwork(config: WifiDeviceConfig): number
...
@@ -1059,9 +976,9 @@ updateNetwork(config: WifiDeviceConfig): number
...
@@ -1059,9 +976,9 @@ updateNetwork(config: WifiDeviceConfig): number
| number | 返回更新的网络配置ID,如果值为-1表示更新失败。 |
| number | 返回更新的网络配置ID,如果值为-1表示更新失败。 |
## wifi.disableNetwork<sup>
7
+</sup>
## wifi.disableNetwork<sup>
9
+</sup>
disableNetwork(netId: number):
boolean
disableNetwork(netId: number):
void
去使能网络配置。
去使能网络配置。
...
@@ -1084,9 +1001,9 @@ disableNetwork(netId: number): boolean
...
@@ -1084,9 +1001,9 @@ disableNetwork(netId: number): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## wifi.removeAllNetwork<sup>
7
+</sup>
## wifi.removeAllNetwork<sup>
9
+</sup>
removeAllNetwork():
boolean
removeAllNetwork():
void
移除所有网络配置。
移除所有网络配置。
...
@@ -1103,9 +1020,9 @@ removeAllNetwork(): boolean
...
@@ -1103,9 +1020,9 @@ removeAllNetwork(): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## wifi.removeDevice<sup>
7
+</sup>
## wifi.removeDevice<sup>
9
+</sup>
removeDevice(id: number):
boolean
removeDevice(id: number):
void
移除指定的网络配置。
移除指定的网络配置。
...
@@ -1128,9 +1045,9 @@ removeDevice(id: number): boolean
...
@@ -1128,9 +1045,9 @@ removeDevice(id: number): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## wifi.enableHotspot<sup>
7
+</sup>
## wifi.enableHotspot<sup>
9
+</sup>
enableHotspot():
boolean
enableHotspot():
void
使能热点。
使能热点。
...
@@ -1147,9 +1064,9 @@ enableHotspot(): boolean
...
@@ -1147,9 +1064,9 @@ enableHotspot(): boolean
| boolean | true:操作成功,
false:操作失败。|
| boolean | true:操作成功,
false:操作失败。|
## wifi.disableHotspot<sup>
7
+</sup>
## wifi.disableHotspot<sup>
9
+</sup>
disableHotspot():
boolean
disableHotspot():
void
去使能热点。
去使能热点。
...
@@ -1166,7 +1083,7 @@ disableHotspot(): boolean
...
@@ -1166,7 +1083,7 @@ disableHotspot(): boolean
| boolean | true:操作成功,
false:操作失败。|
| boolean | true:操作成功,
false:操作失败。|
## wifi.isHotspotDualBandSupported<sup>
7
+</sup>
## wifi.isHotspotDualBandSupported<sup>
9
+</sup>
isHotspotDualBandSupported(): boolean
isHotspotDualBandSupported(): boolean
...
@@ -1185,7 +1102,7 @@ isHotspotDualBandSupported(): boolean
...
@@ -1185,7 +1102,7 @@ isHotspotDualBandSupported(): boolean
| boolean | true:支持,
false:不支持。|
| boolean | true:支持,
false:不支持。|
## wifi.isHotspotActive<sup>
7
+</sup>
## wifi.isHotspotActive<sup>
9
+</sup>
isHotspotActive(): boolean
isHotspotActive(): boolean
...
@@ -1204,9 +1121,9 @@ isHotspotActive(): boolean
...
@@ -1204,9 +1121,9 @@ isHotspotActive(): boolean
| boolean | true:已使能,
false:未使能。|
| boolean | true:已使能,
false:未使能。|
## wifi.setHotspotConfig<sup>
7
+</sup>
## wifi.setHotspotConfig<sup>
9
+</sup>
setHotspotConfig(config: HotspotConfig):
boolean
setHotspotConfig(config: HotspotConfig):
void
设置热点配置信息。
设置热点配置信息。
...
@@ -1220,7 +1137,7 @@ setHotspotConfig(config: HotspotConfig): boolean
...
@@ -1220,7 +1137,7 @@ setHotspotConfig(config: HotspotConfig): boolean
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| config |
[
HotspotConfig
](
#hotspotconfig
7
)
| 是 | 热点配置信息。 |
| config |
[
HotspotConfig
](
#hotspotconfig
9
)
| 是 | 热点配置信息。 |
**返回值:**
**返回值:**
...
@@ -1229,7 +1146,7 @@ setHotspotConfig(config: HotspotConfig): boolean
...
@@ -1229,7 +1146,7 @@ setHotspotConfig(config: HotspotConfig): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## HotspotConfig<sup>
7
+</sup>
## HotspotConfig<sup>
9
+</sup>
热点配置信息。
热点配置信息。
...
@@ -1237,7 +1154,7 @@ setHotspotConfig(config: HotspotConfig): boolean
...
@@ -1237,7 +1154,7 @@ setHotspotConfig(config: HotspotConfig): boolean
**系统能力:**
SystemCapability.Communication.WiFi.AP.Core
**系统能力:**
SystemCapability.Communication.WiFi.AP.Core
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| ssid | string | 是 | 否 | 热点的SSID,编码格式为UTF-8。 |
| securityType |
[
WifiSecurityType
](
#wifisecuritytype
)
| 是 | 否 | 加密类型。 |
| securityType |
[
WifiSecurityType
](
#wifisecuritytype
)
| 是 | 否 | 加密类型。 |
...
@@ -1246,7 +1163,7 @@ setHotspotConfig(config: HotspotConfig): boolean
...
@@ -1246,7 +1163,7 @@ setHotspotConfig(config: HotspotConfig): boolean
| maxConn | number | 是 | 否 | 最大设备连接数。 |
| maxConn | number | 是 | 否 | 最大设备连接数。 |
## wifi.getHotspotConfig<sup>
7
+</sup>
## wifi.getHotspotConfig<sup>
9
+</sup>
getHotspotConfig(): HotspotConfig
getHotspotConfig(): HotspotConfig
...
@@ -1262,12 +1179,12 @@ getHotspotConfig(): HotspotConfig
...
@@ -1262,12 +1179,12 @@ getHotspotConfig(): HotspotConfig
|
**类型**
|
**说明**
|
|
**类型**
|
**说明**
|
| -------- | -------- |
| -------- | -------- |
|
[
HotspotConfig
](
#hotspotconfig
7
)
| 热点的配置信息。 |
|
[
HotspotConfig
](
#hotspotconfig
9
)
| 热点的配置信息。 |
## wifi.getStations<sup>
7
+</sup>
## wifi.getStations<sup>
9
+</sup>
getStations():
Array
<
[StationInfo](#stationinfo
7
)
>
getStations():
Array
<
[StationInfo](#stationinfo
9
)
>
获取连接的设备。
获取连接的设备。
...
@@ -1281,10 +1198,10 @@ getStations(): Array<[StationInfo](#stationinfo7)>
...
@@ -1281,10 +1198,10 @@ getStations(): Array<[StationInfo](#stationinfo7)>
|
**类型**
|
**说明**
|
|
**类型**
|
**说明**
|
| -------- | -------- |
| -------- | -------- |
|
Array
<
[StationInfo](#stationinfo
7
)
>
| 连接的设备数组。 |
|
Array
<
[StationInfo](#stationinfo
9
)
>
| 连接的设备数组。 |
## StationInfo<sup>
7
+</sup>
## StationInfo<sup>
9
+</sup>
接入的设备信息。
接入的设备信息。
...
@@ -1292,14 +1209,14 @@ getStations(): Array<[StationInfo](#stationinfo7)>
...
@@ -1292,14 +1209,14 @@ getStations(): Array<[StationInfo](#stationinfo7)>
**系统能力:**
SystemCapability.Communication.WiFi.AP.Core
**系统能力:**
SystemCapability.Communication.WiFi.AP.Core
|
**
参数名
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
|
**
名称
**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| name | string | 是 | 否 | 设备名称。 |
| name | string | 是 | 否 | 设备名称。 |
| macAddress | string | 是 | 否 | MAC地址。 |
| macAddress | string | 是 | 否 | MAC地址。 |
| ipAddress | string | 是 | 否 | IP地址。 |
| ipAddress | string | 是 | 否 | IP地址。 |
## wifi.getP2pLinkedInfo<sup>
8
+</sup>
## wifi.getP2pLinkedInfo<sup>
9
+</sup>
getP2pLinkedInfo(): Promise
<
WifiP2pLinkedInfo
>
getP2pLinkedInfo(): Promise
<
WifiP2pLinkedInfo
>
...
@@ -1313,24 +1230,24 @@ getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo>
...
@@ -1313,24 +1230,24 @@ getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo>
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
[WifiP2pLinkedInfo](#wifip2plinkedinfo
8
)
>
| Promise对象。表示P2P连接信息。 |
| Promise
<
[WifiP2pLinkedInfo](#wifip2plinkedinfo
9
)
>
| Promise对象。表示P2P连接信息。 |
## WifiP2pLinkedInfo<sup>
8
+</sup>
## WifiP2pLinkedInfo<sup>
9
+</sup>
提供WLAN连接的相关信息。
提供WLAN连接的相关信息。
**系统能力:**
SystemCapability.Communication.WiFi.P2P
**系统能力:**
SystemCapability.Communication.WiFi.P2P
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| connectState |
[
P2pConnectState
](
#p2pconnectstate
8
)
| 是 | 否 | P2P连接状态。 |
| connectState |
[
P2pConnectState
](
#p2pconnectstate
9
)
| 是 | 否 | P2P连接状态。 |
| isGroupOwner | boolean | 是 | 否 | 是否是群主。 |
| isGroupOwner | boolean | 是 | 否 | 是否是群主。 |
| groupOwnerAddr | string | 是 | 否 | 群组MAC地址。
| groupOwnerAddr | string | 是 | 否 | 群组MAC地址。
## P2pConnectState<sup>
8
+</sup>
## P2pConnectState<sup>
9
+</sup>
表示P2P连接状态的枚举。
表示P2P连接状态的枚举。
...
@@ -1342,7 +1259,7 @@ getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo>
...
@@ -1342,7 +1259,7 @@ getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo>
| CONNECTED | 1 | 连接状态。 |
| CONNECTED | 1 | 连接状态。 |
## wifi.getP2pLinkedInfo<sup>
8
+</sup>
## wifi.getP2pLinkedInfo<sup>
9
+</sup>
getP2pLinkedInfo(callback: AsyncCallback
<
WifiP2pLinkedInfo
>
): void
getP2pLinkedInfo(callback: AsyncCallback
<
WifiP2pLinkedInfo
>
): void
...
@@ -1356,10 +1273,10 @@ getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void
...
@@ -1356,10 +1273,10 @@ getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[WifiP2pLinkedInfo](#wifip2plinkedinfo
8
)
>
| 是 | 回调函数。当操作成功时,err为0,data表示P2P连接信息。如果error为非0,表示处理出现错误。 |
| callback | AsyncCallback
<
[WifiP2pLinkedInfo](#wifip2plinkedinfo
9
)
>
| 是 | 回调函数。当操作成功时,err为0,data表示P2P连接信息。如果error为非0,表示处理出现错误。 |
## wifi.getCurrentGroup<sup>
8
+</sup>
## wifi.getCurrentGroup<sup>
9
+</sup>
getCurrentGroup(): Promise
<
WifiP2pGroupInfo
>
getCurrentGroup(): Promise
<
WifiP2pGroupInfo
>
...
@@ -1373,10 +1290,10 @@ getCurrentGroup(): Promise<WifiP2pGroupInfo>
...
@@ -1373,10 +1290,10 @@ getCurrentGroup(): Promise<WifiP2pGroupInfo>
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
[WifiP2pGroupInfo](#wifip2pgroupinfo
8
)
>
| Promise对象。表示当前组信息。 |
| Promise
<
[WifiP2pGroupInfo](#wifip2pgroupinfo
9
)
>
| Promise对象。表示当前组信息。 |
## wifi.getCurrentGroup<sup>
8
+</sup>
## wifi.getCurrentGroup<sup>
9
+</sup>
getCurrentGroup(callback: AsyncCallback
<
WifiP2pGroupInfo
>
): void
getCurrentGroup(callback: AsyncCallback
<
WifiP2pGroupInfo
>
): void
...
@@ -1390,10 +1307,10 @@ getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void
...
@@ -1390,10 +1307,10 @@ getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[WifiP2pGroupInfo](#wifip2pgroupinfo
8
)
>
| 是 | 回调函数。当操作成功时,err为0,data表示当前组信息。如果error为非0,表示处理出现错误。 |
| callback | AsyncCallback
<
[WifiP2pGroupInfo](#wifip2pgroupinfo
9
)
>
| 是 | 回调函数。当操作成功时,err为0,data表示当前组信息。如果error为非0,表示处理出现错误。 |
## wifi.getP2pPeerDevices<sup>
8
+</sup>
## wifi.getP2pPeerDevices<sup>
9
+</sup>
getP2pPeerDevices(): Promise
<
WifiP2pDevice[]
>
getP2pPeerDevices(): Promise
<
WifiP2pDevice[]
>
...
@@ -1407,10 +1324,10 @@ getP2pPeerDevices(): Promise<WifiP2pDevice[]>
...
@@ -1407,10 +1324,10 @@ getP2pPeerDevices(): Promise<WifiP2pDevice[]>
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
[WifiP2pDevice[]](#wifip2pdevice
8
)
>
| Promise对象。表示对端设备列表信息。 |
| Promise
<
[WifiP2pDevice[]](#wifip2pdevice
9
)
>
| Promise对象。表示对端设备列表信息。 |
## wifi.getP2pPeerDevices<sup>
8
+</sup>
## wifi.getP2pPeerDevices<sup>
9
+</sup>
getP2pPeerDevices(callback: AsyncCallback
<
WifiP2pDevice[]
>
): void
getP2pPeerDevices(callback: AsyncCallback
<
WifiP2pDevice[]
>
): void
...
@@ -1424,25 +1341,25 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void
...
@@ -1424,25 +1341,25 @@ getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[WifiP2pDevice[]](#wifip2pdevice
8
)
>
| 是 | 回调函数。当操作成功时,err为0,data表示对端设备列表信息。如果error为非0,表示处理出现错误。 |
| callback | AsyncCallback
<
[WifiP2pDevice[]](#wifip2pdevice
9
)
>
| 是 | 回调函数。当操作成功时,err为0,data表示对端设备列表信息。如果error为非0,表示处理出现错误。 |
## WifiP2pDevice<sup>
8
+</sup>
## WifiP2pDevice<sup>
9
+</sup>
表示P2P设备信息。
表示P2P设备信息。
**系统能力:**
SystemCapability.Communication.WiFi.P2P
**系统能力:**
SystemCapability.Communication.WiFi.P2P
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| deviceName | string | 是 | 否 | 设备名称。 |
| deviceName | string | 是 | 否 | 设备名称。 |
| deviceAddress | string | 是 | 否 | 设备MAC地址。 |
| deviceAddress | string | 是 | 否 | 设备MAC地址。 |
| primaryDeviceType | string | 是 | 否 | 主设备类型。 |
| primaryDeviceType | string | 是 | 否 | 主设备类型。 |
| deviceStatus |
[
P2pDeviceStatus
](
#p2pdevicestatus
8
)
| 是 | 否 | 设备状态。 |
| deviceStatus |
[
P2pDeviceStatus
](
#p2pdevicestatus
9
)
| 是 | 否 | 设备状态。 |
| groupCapabilit
y
s | number | 是 | 否 | 群组能力。 |
| groupCapabilit
ie
s | number | 是 | 否 | 群组能力。 |
## P2pDeviceStatus<sup>
8
+</sup>
## P2pDeviceStatus<sup>
9
+</sup>
表示设备状态的枚举。
表示设备状态的枚举。
...
@@ -1471,7 +1388,7 @@ getP2pLocalDevice(): Promise<WifiP2pDevice>
...
@@ -1471,7 +1388,7 @@ getP2pLocalDevice(): Promise<WifiP2pDevice>
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
[WifiP2pDevice](#wifip2pdevice
8
)
>
| Promise对象。表示本端设备信息。 |
| Promise
<
[WifiP2pDevice](#wifip2pdevice
9
)
>
| Promise对象。表示本端设备信息。 |
## wifi.getP2pLocalDevice<sup>9+</sup>
## wifi.getP2pLocalDevice<sup>9+</sup>
...
@@ -1488,12 +1405,12 @@ getP2pLocalDevice(callback: AsyncCallback<WifiP2pDevice>): void
...
@@ -1488,12 +1405,12 @@ getP2pLocalDevice(callback: AsyncCallback<WifiP2pDevice>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[WifiP2pDevice](#wifip2pdevice
8
)
>
| 是 | 回调函数。当操作成功时,err为0,data表示本端设备信息。如果error为非0,表示处理出现错误。 |
| callback | AsyncCallback
<
[WifiP2pDevice](#wifip2pdevice
9
)
>
| 是 | 回调函数。当操作成功时,err为0,data表示本端设备信息。如果error为非0,表示处理出现错误。 |
## wifi.createGroup<sup>
8
+</sup>
## wifi.createGroup<sup>
9
+</sup>
createGroup(config: WifiP2PConfig):
boolean
createGroup(config: WifiP2PConfig):
void
创建群组。
创建群组。
...
@@ -1505,7 +1422,7 @@ createGroup(config: WifiP2PConfig): boolean
...
@@ -1505,7 +1422,7 @@ createGroup(config: WifiP2PConfig): boolean
|
**参数名**
|
**类型**
| 必填 |
**说明**
|
|
**参数名**
|
**类型**
| 必填 |
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| config |
[
WifiP2PConfig
](
#wifip2pconfig
8
)
| 是 | 群组配置信息。 |
| config |
[
WifiP2PConfig
](
#wifip2pconfig
9
)
| 是 | 群组配置信息。 |
**返回值:**
**返回值:**
...
@@ -1514,22 +1431,22 @@ createGroup(config: WifiP2PConfig): boolean
...
@@ -1514,22 +1431,22 @@ createGroup(config: WifiP2PConfig): boolean
| boolean | true:创建群组操作执行成功,
false:创建群组操作执行失败。 |
| boolean | true:创建群组操作执行成功,
false:创建群组操作执行失败。 |
## WifiP2PConfig<sup>
8
+</sup>
## WifiP2PConfig<sup>
9
+</sup>
表示P2P配置信息。
表示P2P配置信息。
**系统能力:**
SystemCapability.Communication.WiFi.P2P
**系统能力:**
SystemCapability.Communication.WiFi.P2P
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| deviceAddress | string | 是 | 否 | 设备地址。 |
| deviceAddress | string | 是 | 否 | 设备地址。 |
| netId | number | 是 | 否 | 网络ID。创建群组时-1表示创建临时组,-2表示创建永久组。 |
| netId | number | 是 | 否 | 网络ID。创建群组时-1表示创建临时组,-2表示创建永久组。 |
| passphrase | string | 是 | 否 | 群组密钥。 |
| passphrase | string | 是 | 否 | 群组密钥。 |
| groupName | string | 是 | 否 | 群组名称。 |
| groupName | string | 是 | 否 | 群组名称。 |
| goBand |
[
GroupOwnerBand
](
#groupownerband
8
)
| 是 | 否 | 群组带宽。 |
| goBand |
[
GroupOwnerBand
](
#groupownerband
9
)
| 是 | 否 | 群组带宽。 |
## GroupOwnerBand<sup>
8
+</sup>
## GroupOwnerBand<sup>
9
+</sup>
表示群组带宽的枚举。
表示群组带宽的枚举。
...
@@ -1542,9 +1459,9 @@ createGroup(config: WifiP2PConfig): boolean
...
@@ -1542,9 +1459,9 @@ createGroup(config: WifiP2PConfig): boolean
| GO_BAND_5GHZ | 2 | 5GHZ。 |
| GO_BAND_5GHZ | 2 | 5GHZ。 |
## wifi.removeGroup<sup>
8
+</sup>
## wifi.removeGroup<sup>
9
+</sup>
removeGroup():
boolean
removeGroup():
void
移除群组。
移除群组。
...
@@ -1559,9 +1476,9 @@ removeGroup(): boolean
...
@@ -1559,9 +1476,9 @@ removeGroup(): boolean
| boolean | true:操作执行成功,
false:操作执行失败。 |
| boolean | true:操作执行成功,
false:操作执行失败。 |
## wifi.p2pConnect<sup>
8
+</sup>
## wifi.p2pConnect<sup>
9
+</sup>
p2pConnect(config: WifiP2PConfig):
boolean
p2pConnect(config: WifiP2PConfig):
void
执行P2P连接。
执行P2P连接。
...
@@ -1574,7 +1491,7 @@ p2pConnect(config: WifiP2PConfig): boolean
...
@@ -1574,7 +1491,7 @@ p2pConnect(config: WifiP2PConfig): boolean
|
**参数名**
|
**类型**
| 必填 |
**说明**
|
|
**参数名**
|
**类型**
| 必填 |
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| config |
[
WifiP2PConfig
](
#wifip2pconfig
8
)
| 是 | 连接配置信息。 |
| config |
[
WifiP2PConfig
](
#wifip2pconfig
9
)
| 是 | 连接配置信息。 |
**返回值:**
**返回值:**
...
@@ -1650,9 +1567,9 @@ p2pConnect(config: WifiP2PConfig): boolean
...
@@ -1650,9 +1567,9 @@ p2pConnect(config: WifiP2PConfig): boolean
console
.
info
(
"
start discover devices ->
"
+
wifi
.
startDiscoverDevices
());
console
.
info
(
"
start discover devices ->
"
+
wifi
.
startDiscoverDevices
());
```
```
## wifi.p2pCancelConnect<sup>
8
+</sup>
## wifi.p2pCancelConnect<sup>
9
+</sup>
p2pCancelConnect():
boolean
p2pCancelConnect():
void
取消P2P连接。
取消P2P连接。
...
@@ -1667,9 +1584,9 @@ p2pCancelConnect(): boolean
...
@@ -1667,9 +1584,9 @@ p2pCancelConnect(): boolean
| boolean | true:操作执行成功,
false:操作执行失败。 |
| boolean | true:操作执行成功,
false:操作执行失败。 |
## wifi.startDiscoverDevices<sup>
8
+</sup>
## wifi.startDiscoverDevices<sup>
9
+</sup>
startDiscoverDevices():
boolean
startDiscoverDevices():
void
开始发现设备。
开始发现设备。
...
@@ -1684,9 +1601,9 @@ startDiscoverDevices(): boolean
...
@@ -1684,9 +1601,9 @@ startDiscoverDevices(): boolean
| boolean | true:操作执行成功,
false:操作执行失败。 |
| boolean | true:操作执行成功,
false:操作执行失败。 |
## wifi.stopDiscoverDevices<sup>
8
+</sup>
## wifi.stopDiscoverDevices<sup>
9
+</sup>
stopDiscoverDevices():
boolean
stopDiscoverDevices():
void
停止发现设备。
停止发现设备。
...
@@ -1701,9 +1618,9 @@ stopDiscoverDevices(): boolean
...
@@ -1701,9 +1618,9 @@ stopDiscoverDevices(): boolean
| boolean | true:操作执行成功,操作执行失败。 |
| boolean | true:操作执行成功,操作执行失败。 |
## wifi.deletePersistentGroup<sup>
8
+</sup>
## wifi.deletePersistentGroup<sup>
9
+</sup>
deletePersistentGroup(netId: number):
boolean
deletePersistentGroup(netId: number):
void
删除永久组。
删除永久组。
...
@@ -1743,25 +1660,25 @@ getP2pGroups(): Promise<Array<WifiP2pGroupInfo>>
...
@@ -1743,25 +1660,25 @@ getP2pGroups(): Promise<Array<WifiP2pGroupInfo>>
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
Array
<
[WifiP2pGroupInfo](#wifip2pgroupinfo
8
)
> >
| Promise对象。表示所有群组信息。 |
| Promise
<
Array
<
[WifiP2pGroupInfo](#wifip2pgroupinfo
9
)
> >
| Promise对象。表示所有群组信息。 |
## WifiP2pGroupInfo<sup>
8
+</sup>
## WifiP2pGroupInfo<sup>
9
+</sup>
表示P2P群组相关信息。
表示P2P群组相关信息。
**系统能力:**
SystemCapability.Communication.WiFi.P2P
**系统能力:**
SystemCapability.Communication.WiFi.P2P
|
参数名
| 类型 | 可读 | 可写 | 说明 |
|
名称
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| isP2pGo | boolean | 是 | 否 | 是否是群主。 |
| isP2pGo | boolean | 是 | 否 | 是否是群主。 |
| ownerInfo |
[
WifiP2pDevice
](
#wifip2pdevice
8
)
| 是 | 否 | 群组的设备信息。 |
| ownerInfo |
[
WifiP2pDevice
](
#wifip2pdevice
9
)
| 是 | 否 | 群组的设备信息。 |
| passphrase | string | 是 | 否 | 群组密钥。 |
| passphrase | string | 是 | 否 | 群组密钥。 |
| interface | string | 是 | 否 | 接口名称。 |
| interface | string | 是 | 否 | 接口名称。 |
| groupName | string | 是 | 否 | 群组名称。 |
| groupName | string | 是 | 否 | 群组名称。 |
| networkId | number | 是 | 否 | 网络ID。 |
| networkId | number | 是 | 否 | 网络ID。 |
| frequency | number | 是 | 否 | 群组的频率。 |
| frequency | number | 是 | 否 | 群组的频率。 |
| clientDevices |
[
WifiP2pDevice[]
](
#wifip2pdevice
8
)
| 是 | 否 | 接入的设备列表信息。 |
| clientDevices |
[
WifiP2pDevice[]
](
#wifip2pdevice
9
)
| 是 | 否 | 接入的设备列表信息。 |
| goIpAddress | string | 是 | 否 | 群组IP地址。 |
| goIpAddress | string | 是 | 否 | 群组IP地址。 |
...
@@ -1781,12 +1698,12 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): void
...
@@ -1781,12 +1698,12 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
Array
<
[WifiP2pGroupInfo](#wifip2pgroupinfo
8
)
>>
| 是 | 回调函数。当操作成功时,err为0,data表示所有群组信息。如果error为非0,表示处理出现错误。 |
| callback | AsyncCallback
<
Array
<
[WifiP2pGroupInfo](#wifip2pgroupinfo
9
)
>>
| 是 | 回调函数。当操作成功时,err为0,data表示所有群组信息。如果error为非0,表示处理出现错误。 |
## wifi.setDeviceName<sup>
8
+</sup>
## wifi.setDeviceName<sup>
9
+</sup>
setDeviceName(devName: string):
boolean
setDeviceName(devName: string):
void
设置设备名称。
设置设备名称。
...
@@ -1809,7 +1726,7 @@ setDeviceName(devName: string): boolean
...
@@ -1809,7 +1726,7 @@ setDeviceName(devName: string): boolean
| boolean | true:操作成功,
false:操作失败。 |
| boolean | true:操作成功,
false:操作失败。 |
## wifi.on('wifiStateChange')<sup>
7
+</sup>
## wifi.on('wifiStateChange')<sup>
9
+</sup>
on(type: "wifiStateChange", callback: Callback
<
number
>
): void
on(type: "wifiStateChange", callback: Callback
<
number
>
): void
...
@@ -1836,7 +1753,7 @@ on(type: "wifiStateChange", callback: Callback<number>): void
...
@@ -1836,7 +1753,7 @@ on(type: "wifiStateChange", callback: Callback<number>): void
| 3 | 去激活中。 |
| 3 | 去激活中。 |
## wifi.off('wifiStateChange')<sup>
7
+</sup>
## wifi.off('wifiStateChange')<sup>
9
+</sup>
off(type: "wifiStateChange", callback?: Callback
<
number
>
): void
off(type: "wifiStateChange", callback?: Callback
<
number
>
): void
...
@@ -1869,7 +1786,7 @@ off(type: "wifiStateChange", callback?: Callback<number>): void
...
@@ -1869,7 +1786,7 @@ off(type: "wifiStateChange", callback?: Callback<number>): void
```
```
## wifi.on('wifiConnectionChange')<sup>
7
+</sup>
## wifi.on('wifiConnectionChange')<sup>
9
+</sup>
on(type: "wifiConnectionChange", callback: Callback
<
number
>
): void
on(type: "wifiConnectionChange", callback: Callback
<
number
>
): void
...
@@ -1894,7 +1811,7 @@ on(type: "wifiConnectionChange", callback: Callback<number>): void
...
@@ -1894,7 +1811,7 @@ on(type: "wifiConnectionChange", callback: Callback<number>): void
| 1 | 已连接。 |
| 1 | 已连接。 |
## wifi.off('wifiConnectionChange')<sup>
7
+</sup>
## wifi.off('wifiConnectionChange')<sup>
9
+</sup>
off(type: "wifiConnectionChange", callback?: Callback
<
number
>
): void
off(type: "wifiConnectionChange", callback?: Callback
<
number
>
): void
...
@@ -1912,7 +1829,7 @@ off(type: "wifiConnectionChange", callback?: Callback<number>): void
...
@@ -1912,7 +1829,7 @@ off(type: "wifiConnectionChange", callback?: Callback<number>): void
| callback | Callback
<
number
>
| 否 | 连接状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
| callback | Callback
<
number
>
| 否 | 连接状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
## wifi.on('wifiScanStateChange')<sup>
7
+</sup>
## wifi.on('wifiScanStateChange')<sup>
9
+</sup>
on(type: "wifiScanStateChange", callback: Callback
<
number
>
): void
on(type: "wifiScanStateChange", callback: Callback
<
number
>
): void
...
@@ -1937,7 +1854,7 @@ on(type: "wifiScanStateChange", callback: Callback<number>): void
...
@@ -1937,7 +1854,7 @@ on(type: "wifiScanStateChange", callback: Callback<number>): void
| 1 | 扫描成功。 |
| 1 | 扫描成功。 |
## wifi.off('wifiScanStateChange')<sup>
7
+</sup>
## wifi.off('wifiScanStateChange')<sup>
9
+</sup>
off(type: "wifiScanStateChange", callback?: Callback
<
number
>
): void
off(type: "wifiScanStateChange", callback?: Callback
<
number
>
): void
...
@@ -1955,7 +1872,7 @@ off(type: "wifiScanStateChange", callback?: Callback<number>): void
...
@@ -1955,7 +1872,7 @@ off(type: "wifiScanStateChange", callback?: Callback<number>): void
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
## wifi.on('wifiRssiChange')<sup>
7
+</sup>
## wifi.on('wifiRssiChange')<sup>
9
+</sup>
on(type: "wifiRssiChange", callback: Callback
<
number
>
): void
on(type: "wifiRssiChange", callback: Callback
<
number
>
): void
...
@@ -1973,7 +1890,7 @@ on(type: "wifiRssiChange", callback: Callback<number>): void
...
@@ -1973,7 +1890,7 @@ on(type: "wifiRssiChange", callback: Callback<number>): void
| callback | Callback
<
number
>
| 是 | 状态改变回调函数,返回以dBm为单位的RSSI值。 |
| callback | Callback
<
number
>
| 是 | 状态改变回调函数,返回以dBm为单位的RSSI值。 |
## wifi.off('wifiRssiChange')<sup>
7
+</sup>
## wifi.off('wifiRssiChange')<sup>
9
+</sup>
off(type: "wifiRssiChange", callback?: Callback
<
number
>
): void
off(type: "wifiRssiChange", callback?: Callback
<
number
>
): void
...
@@ -1991,7 +1908,7 @@ off(type: "wifiRssiChange", callback?: Callback<number>): void
...
@@ -1991,7 +1908,7 @@ off(type: "wifiRssiChange", callback?: Callback<number>): void
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
## wifi.on('hotspotStateChange')<sup>
7
+</sup>
## wifi.on('hotspotStateChange')<sup>
9
+</sup>
on(type: "hotspotStateChange", callback: Callback
<
number
>
): void
on(type: "hotspotStateChange", callback: Callback
<
number
>
): void
...
@@ -2018,7 +1935,7 @@ on(type: "hotspotStateChange", callback: Callback<number>): void
...
@@ -2018,7 +1935,7 @@ on(type: "hotspotStateChange", callback: Callback<number>): void
| 3 | 去激活中。 |
| 3 | 去激活中。 |
## wifi.off('hotspotStateChange')<sup>
7
+</sup>
## wifi.off('hotspotStateChange')<sup>
9
+</sup>
off(type: "hotspotStateChange", callback?: Callback
<
number
>
): void
off(type: "hotspotStateChange", callback?: Callback
<
number
>
): void
...
@@ -2036,7 +1953,7 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void
...
@@ -2036,7 +1953,7 @@ off(type: "hotspotStateChange", callback?: Callback<number>): void
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pStateChange')<sup>
8
+</sup>
## wifi.on('p2pStateChange')<sup>
9
+</sup>
on(type: "p2pStateChange", callback: Callback
<
number
>
): void
on(type: "p2pStateChange", callback: Callback
<
number
>
): void
...
@@ -2063,7 +1980,7 @@ on(type: "p2pStateChange", callback: Callback<number>): void
...
@@ -2063,7 +1980,7 @@ on(type: "p2pStateChange", callback: Callback<number>): void
| 4 | 关闭中。 |
| 4 | 关闭中。 |
| 5 | 已关闭。 |
| 5 | 已关闭。 |
## wifi.off('p2pStateChange')<sup>
8
+</sup>
## wifi.off('p2pStateChange')<sup>
9
+</sup>
off(type: "p2pStateChange", callback?: Callback
<
number
>
): void
off(type: "p2pStateChange", callback?: Callback
<
number
>
): void
...
@@ -2081,7 +1998,7 @@ off(type: "p2pStateChange", callback?: Callback<number>): void
...
@@ -2081,7 +1998,7 @@ off(type: "p2pStateChange", callback?: Callback<number>): void
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pConnectionChange')
<sup>
8
+
</sup>
## wifi.on('p2pConnectionChange')
<sup>
9
+
</sup>
on(type: "p2pConnectionChange", callback: Callback
<
WifiP2pLinkedInfo
>
): void
on(type: "p2pConnectionChange", callback: Callback
<
WifiP2pLinkedInfo
>
): void
...
@@ -2096,10 +2013,10 @@ on(type: "p2pConnectionChange", callback: Callback<WifiP2pLinkedInfo>): vo
...
@@ -2096,10 +2013,10 @@ on(type: "p2pConnectionChange", callback: Callback<WifiP2pLinkedInfo>): vo
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
| type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
| callback | Callback
<
[WifiP2pLinkedInfo](#wifip2plinkedinfo
8
)
>
| 是 | 状态改变回调函数。 |
| callback | Callback
<
[WifiP2pLinkedInfo](#wifip2plinkedinfo
9
)
>
| 是 | 状态改变回调函数。 |
## wifi.off('p2pConnectionChange')<sup>
8
+</sup>
## wifi.off('p2pConnectionChange')<sup>
9
+</sup>
off(type: "p2pConnectionChange", callback?: Callback
<
WifiP2pLinkedInfo
>
): void
off(type: "p2pConnectionChange", callback?: Callback
<
WifiP2pLinkedInfo
>
): void
...
@@ -2114,10 +2031,10 @@ off(type: "p2pConnectionChange", callback?: Callback<WifiP2pLinkedInfo>):
...
@@ -2114,10 +2031,10 @@ off(type: "p2pConnectionChange", callback?: Callback<WifiP2pLinkedInfo>):
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
| type | string | 是 | 固定填"p2pConnectionChange"字符串。 |
| callback | Callback
<
[WifiP2pLinkedInfo](#wifip2plinkedinfo
8
)
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
| callback | Callback
<
[WifiP2pLinkedInfo](#wifip2plinkedinfo
9
)
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pDeviceChange')<sup>
8
+</sup>
## wifi.on('p2pDeviceChange')<sup>
9
+</sup>
on(type: "p2pDeviceChange", callback: Callback
<
WifiP2pDevice
>
): void
on(type: "p2pDeviceChange", callback: Callback
<
WifiP2pDevice
>
): void
...
@@ -2132,10 +2049,10 @@ on(type: "p2pDeviceChange", callback: Callback<WifiP2pDevice>): void
...
@@ -2132,10 +2049,10 @@ on(type: "p2pDeviceChange", callback: Callback<WifiP2pDevice>): void
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
| type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
| callback | Callback
<
[WifiP2pDevice](#wifip2pdevice
8
)
>
| 是 | 状态改变回调函数。 |
| callback | Callback
<
[WifiP2pDevice](#wifip2pdevice
9
)
>
| 是 | 状态改变回调函数。 |
## wifi.off('p2pDeviceChange')<sup>
8
+</sup>
## wifi.off('p2pDeviceChange')<sup>
9
+</sup>
off(type: "p2pDeviceChange", callback?: Callback
<
WifiP2pDevice
>
): void
off(type: "p2pDeviceChange", callback?: Callback
<
WifiP2pDevice
>
): void
...
@@ -2150,10 +2067,10 @@ off(type: "p2pDeviceChange", callback?: Callback<WifiP2pDevice>): void
...
@@ -2150,10 +2067,10 @@ off(type: "p2pDeviceChange", callback?: Callback<WifiP2pDevice>): void
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
| type | string | 是 | 固定填"p2pDeviceChange"字符串。 |
| callback | Callback
<
[WifiP2pDevice](#wifip2pdevice
8
)
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
| callback | Callback
<
[WifiP2pDevice](#wifip2pdevice
9
)
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pPeerDeviceChange')<sup>
8
+</sup>
## wifi.on('p2pPeerDeviceChange')<sup>
9
+</sup>
on(type: "p2pPeerDeviceChange", callback: Callback
<
WifiP2pDevice[]
>
): void
on(type: "p2pPeerDeviceChange", callback: Callback
<
WifiP2pDevice[]
>
): void
...
@@ -2168,10 +2085,10 @@ on(type: "p2pPeerDeviceChange", callback: Callback<WifiP2pDevice[]>): void
...
@@ -2168,10 +2085,10 @@ on(type: "p2pPeerDeviceChange", callback: Callback<WifiP2pDevice[]>): void
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
| type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
| callback | Callback
<
[WifiP2pDevice[]](#wifip2pdevice
8
)
>
| 是 | 状态改变回调函数。 |
| callback | Callback
<
[WifiP2pDevice[]](#wifip2pdevice
9
)
>
| 是 | 状态改变回调函数。 |
## wifi.off('p2pPeerDeviceChange')<sup>
8
+</sup>
## wifi.off('p2pPeerDeviceChange')<sup>
9
+</sup>
off(type: "p2pPeerDeviceChange", callback?: Callback
<
WifiP2pDevice[]
>
): void
off(type: "p2pPeerDeviceChange", callback?: Callback
<
WifiP2pDevice[]
>
): void
...
@@ -2186,10 +2103,10 @@ off(type: "p2pPeerDeviceChange", callback?: Callback<WifiP2pDevice[]>): vo
...
@@ -2186,10 +2103,10 @@ off(type: "p2pPeerDeviceChange", callback?: Callback<WifiP2pDevice[]>): vo
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
| type | string | 是 | 固定填"p2pPeerDeviceChange"字符串。 |
| callback | Callback
<
[WifiP2pDevice[]](#wifip2pdevice
8
)
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
| callback | Callback
<
[WifiP2pDevice[]](#wifip2pdevice
9
)
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pPersistentGroupChange')<sup>
8
+</sup>
## wifi.on('p2pPersistentGroupChange')<sup>
9
+</sup>
on(type: "p2pPersistentGroupChange", callback: Callback
<
void
>
): void
on(type: "p2pPersistentGroupChange", callback: Callback
<
void
>
): void
...
@@ -2207,7 +2124,7 @@ on(type: "p2pPersistentGroupChange", callback: Callback<void>): void
...
@@ -2207,7 +2124,7 @@ on(type: "p2pPersistentGroupChange", callback: Callback<void>): void
| callback | Callback
<
void
>
| 是 | 状态改变回调函数。 |
| callback | Callback
<
void
>
| 是 | 状态改变回调函数。 |
## wifi.off('p2pPersistentGroupChange')<sup>
8
+</sup>
## wifi.off('p2pPersistentGroupChange')<sup>
9
+</sup>
off(type: "p2pPersistentGroupChange", callback?: Callback
<
void
>
): void
off(type: "p2pPersistentGroupChange", callback?: Callback
<
void
>
): void
...
@@ -2225,7 +2142,7 @@ off(type: "p2pPersistentGroupChange", callback?: Callback<void>): void
...
@@ -2225,7 +2142,7 @@ off(type: "p2pPersistentGroupChange", callback?: Callback<void>): void
| callback | Callback
<
void
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
| callback | Callback
<
void
>
| 否 | 状态改变回调函数。如果callback不填,将去注册该事件关联的所有回调函数。 |
## wifi.on('p2pDiscoveryChange')<sup>
8
+</sup>
## wifi.on('p2pDiscoveryChange')<sup>
9
+</sup>
on(type: "p2pDiscoveryChange", callback: Callback
<
number
>
): void
on(type: "p2pDiscoveryChange", callback: Callback
<
number
>
): void
...
@@ -2250,7 +2167,7 @@ on(type: "p2pDiscoveryChange", callback: Callback<number>): void
...
@@ -2250,7 +2167,7 @@ on(type: "p2pDiscoveryChange", callback: Callback<number>): void
| 1 | 发现成功。 |
| 1 | 发现成功。 |
## wifi.off('p2pDiscoveryChange')<sup>
8
+</sup>
## wifi.off('p2pDiscoveryChange')<sup>
9
+</sup>
off(type: "p2pDiscoveryChange", callback?: Callback
<
number
>
): void
off(type: "p2pDiscoveryChange", callback?: Callback
<
number
>
): void
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录