@ohos.wifiManagerExt (WLAN Extension)
This wifiext module provides WLAN extension interfaces for non-universal products.
NOTE
- The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
- The APIs described in this document are used only for non-universal products, such as routers.
Modules to Import
import wifiManagerExt from '@ohos.wifiManagerExt';
wifiext.enableHotspot9+
enableHotspot(): void;
Enables the WLAN hotspot.
Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
System capability: SystemCapability.Communication.WiFi.AP.Extension
Error codes
For details about the error codes, see Wi-Fi Error Codes.
ID | Error Message |
---|---|
2701000 | Operation failed. |
Example
import wifiManagerExt from '@ohos.wifiManagerExt';
try {
wifiManagerExt.enableHotspot();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
wifiext.disableHotspot9+
disableHotspot(): void;
Disables the WLAN hotspot.
Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
System capability: SystemCapability.Communication.WiFi.AP.Extension
Error codes
For details about the error codes, see Wi-Fi Error Codes.
ID | Error Message |
---|---|
2701000 | Operation failed. |
Example
import wifiManagerExt from '@ohos.wifiManagerExt';
try {
wifiManagerExt.disableHotspot();
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
wifiext.getSupportedPowerMode9+
getSupportedPowerMode(): Promise<Array<PowerMode>>
Obtains the supported power modes. This API uses a promise to return the result.
Required permissions: ohos.permission.GET_WIFI_INFO
System capability: SystemCapability.Communication.WiFi.AP.Extension
Return value
Type | Description |
---|---|
Promise<Array<PowerMode>> | Promise used to return the power modes obtained. |
Error codes
For details about the error codes, see Wi-Fi Error Codes.
ID | Error Message |
---|---|
2701000 | Operation failed. |
PowerMode9+
Enumerates the power modes.
System capability: SystemCapability.Ability.AbilityRuntime.Core
Name | Value | Description |
---|---|---|
SLEEPING | 0 | Sleeping |
GENERAL | 1 | General |
THROUGH_WALL | 2 | Through_wall |
wifiext.getSupportedPowerMode9+
getSupportedPowerMode(callback: AsyncCallback<Array<PowerMode>>): void
Obtains the supported power modes. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.GET_WIFI_INFO
System capability: SystemCapability.Communication.WiFi.AP.Extension
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<PowerMode>> | Yes | Callback invoked to return the result. If the operation is successful, err is 0 and data is the power modes obtained. If the operation fails, err is not 0. |
Error codes
For details about the error codes, see Wi-Fi Error Codes.
ID | Error Message |
---|---|
2701000 | Operation failed. |
Example
import wifiManagerExt from '@ohos.wifiManagerExt';
wifiManagerExt.getSupportedPowerMode((err, data) => {
if (err) {
console.error("get supported power mode info error");
return;
}
console.info("get supported power mode info: " + JSON.stringify(data));
});
wifiManagerExt.getSupportedPowerMode().then(data => {
console.info("get supported power mode info: " + JSON.stringify(data));
}).catch((error:number) => {
console.info("get supported power mode error");
});
wifiext.getPowerMode9+
getPowerMode(): Promise<PowerMode>
Obtains the power mode. This API uses a promise to return the result.
Required permissions: ohos.permission.GET_WIFI_INFO
System capability: SystemCapability.Communication.WiFi.AP.Extension
Return value
Type | Description |
---|---|
Promise<PowerMode> | Promise used to return the power modes obtained. |
Error codes
For details about the error codes, see Wi-Fi Error Codes.
ID | Error Message |
---|---|
2701000 | Operation failed. |
Example
import wifiManagerExt from '@ohos.wifiManagerExt';
try {
let model = wifiManagerExt.getPowerMode();
console.info("model info:" + model);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}
wifiext.getPowerMode9+
getPowerMode(callback: AsyncCallback<PowerMode>): void
Obtains the power mode. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.GET_WIFI_INFO
System capability: SystemCapability.Communication.WiFi.AP.Extension
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<PowerMode> | Yes | Callback invoked to return the result. If the operation is successful, err is 0 and data is the power mode obtained. If the operation fails, err is not 0. |
Error codes
For details about the error codes, see Wi-Fi Error Codes.
ID | Error Message |
---|---|
2701000 | Operation failed. |
Example
import wifiManagerExt from '@ohos.wifiManagerExt';
wifiManagerExt.getPowerMode((err, data) => {
if (err) {
console.error("get linked info error");
return;
}
console.info("get power mode info: " + JSON.stringify(data));
});
wifiManagerExt.getPowerMode().then(data => {
console.info("get power mode info: " + JSON.stringify(data));
}).catch((error:number) => {
console.info("get power mode error");
});
wifiext.setPowerMode9+
setPowerMode(mode: PowerMode) : void;
Sets the power mode.
Required permissions: ohos.permission.MANAGE_WIFI_HOTSPOT_EXT
System capability: SystemCapability.Communication.WiFi.AP.Extension
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
model | PowerMode | Yes | Power mode to set. |
Error codes
For details about the error codes, see Wi-Fi Error Codes.
ID | Error Message |
---|---|
2701000 | Operation failed. |
Example
import wifiManagerExt from '@ohos.wifiManagerExt';
try {
let model = 0;
wifiManagerExt.setPowerMode(model);
}catch(error){
console.error("failed:" + JSON.stringify(error));
}