js-apis-wifiext.md 4.0 KB
Newer Older
Z
zhangfeng 已提交
1
# WLAN
Z
zhangfeng 已提交
2
该模块主要提供WLAN扩展接口,供非通用类型产品使用。
Z
zhangfeng 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该文档中的接口只供非通用类型产品使用,如路由器等,对于常规类型产品,不应该使用这些接口。


## 导入模块

```js
import wifiext from '@ohos.wifiext';
```

## wifiext.enableHotspot

enableHotspot(): boolean;

使能WLAN热点。

Z
zhangfeng 已提交
21
**需要权限:** ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
Z
zhangfeng 已提交
22

Z
zhangfeng 已提交
23
**系统能力:** SystemCapability.Communication.WiFi.AP.Extension
Z
zhangfeng 已提交
24

Z
zhangfeng 已提交
25
**返回值:**
B
bmeangel 已提交
26

Z
zhangfeng 已提交
27 28 29 30 31 32 33 34 35 36 37
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | 操作结果, true: 成功, false: 失败。 |


## wifiext.disableHotspot

disableHotspot(): boolean;

去使能WLAN热点。

Z
zhangfeng 已提交
38
**需要权限:** ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
Z
zhangfeng 已提交
39

Z
zhangfeng 已提交
40
**系统能力:** SystemCapability.Communication.WiFi.AP.Extension
Z
zhangfeng 已提交
41

Z
zhangfeng 已提交
42
**返回值:**
B
bmeangel 已提交
43

Z
zhangfeng 已提交
44 45 46 47 48 49 50 51 52
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | 操作结果, true: 成功, false: 失败。 |


## wifiext.getSupportedPowerModel

getSupportedPowerModel(): Promise<Array<PowerModel>>

Z
zhangfeng 已提交
53
获取支持的功率模式,使用Promise异步回调。
Z
zhangfeng 已提交
54

Z
zhangfeng 已提交
55
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
56

Z
zhangfeng 已提交
57
**系统能力:** SystemCapability.Communication.WiFi.AP.Extension
Z
zhangfeng 已提交
58

Z
zhangfeng 已提交
59
**返回值:**
B
bmeangel 已提交
60

Z
zhangfeng 已提交
61 62
  | 类型 | 说明 |
  | -------- | -------- |
63
  | Promise<Array<[PowerModel](#powermodel)>> | Promise对象。表示功率模式。 |
Z
zhangfeng 已提交
64 65 66 67 68 69


## PowerModel

表示功率模式的枚举。

Z
zhangfeng 已提交
70 71
**系统能力:** SystemCapability.Communication.WiFi.AP.Extension

Z
zhangfeng 已提交
72 73 74 75 76 77 78 79 80 81 82
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| SLEEPING | 0 | 睡眠模式。 |
| GENERAL | 1 | 常规模式。 |
| THROUGH_WALL | 2 | 穿墙模式。 |


## wifiext.getSupportedPowerModel

getSupportedPowerModel(callback: AsyncCallback<Array<PowerModel>>): void

Z
zhangfeng 已提交
83
获取支持的功率模式,使用callback异步回调。
Z
zhangfeng 已提交
84

Z
zhangfeng 已提交
85
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
86

Z
zhangfeng 已提交
87
**系统能力:** SystemCapability.Communication.WiFi.AP.Extension
Z
zhangfeng 已提交
88

Z
zhangfeng 已提交
89
**参数:**
B
bmeangel 已提交
90

Z
zhangfeng 已提交
91 92
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
93
  | callback | AsyncCallback<[PowerModel](#powermodel)> | 是 | 回调函数。当操作成功时,err为0,data表示支持的功率模式。如果error为非0,表示处理出现错误。 |
Z
zhangfeng 已提交
94 95 96 97 98 99


## wifiext.getPowerModel

getPowerModel(): Promise<PowerModel>

Z
zhangfeng 已提交
100
获取功率模式,使用Promise异步回调。
Z
zhangfeng 已提交
101

Z
zhangfeng 已提交
102
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
103

Z
zhangfeng 已提交
104
**系统能力:** SystemCapability.Communication.WiFi.AP.Extension
Z
zhangfeng 已提交
105

Z
zhangfeng 已提交
106
**返回值:**
B
bmeangel 已提交
107

Z
zhangfeng 已提交
108 109
  | 类型 | 说明 |
  | -------- | -------- |
110
  | Promise<[PowerModel](#powermodel)> | Promise对象。表示功率模式。 |
Z
zhangfeng 已提交
111 112 113 114 115 116


## wifiext.getPowerModel

getPowerModel(callback: AsyncCallback<PowerModel>): void

Z
zhangfeng 已提交
117
获取功率模式,使用callback异步回调。
Z
zhangfeng 已提交
118

Z
zhangfeng 已提交
119
**需要权限:** ohos.permission.GET_WIFI_INFO
Z
zhangfeng 已提交
120

Z
zhangfeng 已提交
121
**系统能力:** SystemCapability.Communication.WiFi.AP.Extension
Z
zhangfeng 已提交
122

Z
zhangfeng 已提交
123
**参数:**
B
bmeangel 已提交
124

Z
zhangfeng 已提交
125 126
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
127
  | callback | AsyncCallback<[PowerModel](#powermodel)> | 是 | 回调函数。当操作成功时,err为0,data表示功率模式。如果error为非0,表示处理出现错误。 |
Z
zhangfeng 已提交
128 129 130 131 132 133 134 135


## wifiext.setPowerModel

setPowerModel(model: PowerModel) : boolean;

 设置功率模式。

Z
zhangfeng 已提交
136
**需要权限:** ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
Z
zhangfeng 已提交
137

Z
zhangfeng 已提交
138
**系统能力:** SystemCapability.Communication.WiFi.AP.Extension
Z
zhangfeng 已提交
139

Z
zhangfeng 已提交
140
**参数:**
B
bmeangel 已提交
141

Z
zhangfeng 已提交
142 143
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
144
  | model | AsyncCallback<[PowerModel](#powermodel)> | 是 | 功率模式。 |
Z
zhangfeng 已提交
145

Z
zhangfeng 已提交
146
**返回值:**
B
bmeangel 已提交
147

Z
zhangfeng 已提交
148 149 150
  | **类型** | **说明** |
  | -------- | -------- |
  | boolean | 操作结果, true: 成功, false: 失败。 |