@ohos.net.vpnExtension (VPN 增强管理)(系统接口)
三方VPN管理模块,支持三方VPN的启动和停止功能。
说明: 本模块首批接口从 API version 11 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 当前页面仅包含本模块的系统接口,其他公开接口参见@ohos.net.vpnExtension (VPN 增强管理)
导入模块
import vpnExt from "@ohos.net.vpnExtension";
vpnExt.setAlwaysOnVpnEnabled
setAlwaysOnVpnEnabled(enable: boolean, bundleName: string): Promise<void>
设置设备的启用/禁用always on VPN模式。
系统接口:此接口为系统接口。
需要权限:ohos.permission.MANAGE_VPN
系统能力:SystemCapability.Communication.NetManager.Vpn
模型约束:此接口仅可在Stage模型下使用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
enable | boolean | 是 | always on启用或禁用。 |
bundleName | string | 是 | 设置了always on vpn的包名,通常指三方应用的bundleName。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | 无返回值的Promise对象。 |
错误码:
错误码 ID | 错误信息 |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
示例: Stage 模型示例:
import vpnExt from '@ohos.net.vpnExtension';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let want: Want = {
deviceId: "",
bundleName: 'com.example.myvpndemo',
abilityName: 'MyVpnExtAbility',
};
vpnExt.setAlwaysOnVpnEnabled(true, want.bundleName).then(() => {
console.info('setAlwaysOnVpnEnabled success.');
}).catch((err : BusinessError) => {
console.error('setAlwaysOnVpnEnabled fail, err-> ${JSON.stringify(err)}');
});
vpnExt.isAlwaysOnVpnEnabled
isAlwaysOnVpnEnabled(bundleName: string): Promise<boolean>
获取always on VPN开关状态。
系统接口:此接口为系统接口。
需要权限:ohos.permission.MANAGE_VPN
系统能力:SystemCapability.Communication.NetManager.Vpn
模型约束:此接口仅可在Stage模型下使用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundleName | string | 是 | 设置了always on vpn的包名,通常指三方应用的bundleName。 |
返回值:
类型 | 说明 |
---|---|
Promise<boolean> | 返回应用alway on vpn开关状态。 |
错误码:
错误码 ID | 错误信息 |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
示例: Stage 模型示例:
import vpnExt from '@ohos.net.vpnExtension';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let want: Want = {
deviceId: "",
bundleName: 'com.example.myvpndemo',
abilityName: 'MyVpnExtAbility',
};
vpnExt.isAlwaysOnVpnEnabled(want.bundleName).then((data : boolean) => {
console.info('isAlwaysOnVpnEnabled success.');
}).catch((err : BusinessError) => {
console.error('setAlwaysOnVpnEnabled fail, err-> ${JSON.stringify(err)}');
});
vpnExt.updateVpnAuthorizedState
updateVpnAuthorizedState(bundleName: string): boolean
更新VPN对话框授权信息。
系统接口:此接口为系统接口。
需要权限:ohos.permission.MANAGE_VPN
系统能力:SystemCapability.Communication.NetManager.Vpn
模型约束:此接口仅可在Stage模型下使用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
bundleName | string | 是 | 应用弹框授权的包名,通常指三方应用的bundleName。 |
返回值:
类型 | 说明 |
---|---|
boolean | 返回值用来判断是否成功更新vpn弹框授权状态。 |
错误码:
错误码 ID | 错误信息 |
---|---|
201 | Permission denied. |
202 | Non-system applications use system APIs. |
401 | Parameter error. |
示例: Stage 模型示例:
import vpnExt from '@ohos.net.vpnExtension';
import Want from '@ohos.app.ability.Want';
let want: Want = {
deviceId: "",
bundleName: 'com.example.myvpndemo',
abilityName: 'MyVpnExtAbility',
};
let result: boolean = vpnExt.updateVpnAuthorizedState(want.bundleName);
console.log("Result: "+ result);