@ohos.net.connection (网络连接管理)(系统接口)

网络连接管理提供管理网络一些基础能力,包括获取默认激活的数据网络、获取所有激活数据网络列表、开启关闭飞行模式、获取网络能力信息等功能。

说明: 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 当前页面仅包含本模块的系统接口,其他公开接口参见@ohos.net.connection (网络连接管理)

导入模块

import connection from '@ohos.net.connection';

connection.getGlobalHttpProxy10+

getGlobalHttpProxy(callback: AsyncCallback<HttpProxy>): void

获取网络的全局代理配置信息,使用callback方式作为异步方法。

系统接口:此接口为系统接口。

系统能力:SystemCapability.Communication.NetManager.Core

参数:

参数名 类型 必填 说明
callback AsyncCallback<HttpProxy> 回调函数。当成功获取网络的全局代理配置信息时,error为undefined,data为网络的全局代理配置信息;否则为错误对象

错误码:

错误码ID 错误信息
401 Parameter error.
202 Non-system applications use system APIs.
2100002 Operation failed. Cannot connect to service.
2100003 System internal error.

示例:

import connection from '@ohos.net.connection';
import { BusinessError } from '@ohos.base';

connection.getGlobalHttpProxy((error: BusinessError, data: connection.HttpProxy) => {
  console.info(JSON.stringify(error));
  console.info(JSON.stringify(data));
});

connection.getGlobalHttpProxy10+

getGlobalHttpProxy(): Promise<HttpProxy>;

获取网络的全局代理配置信息,使用Promise方式作为异步方法。

系统接口:此接口为系统接口。

系统能力:SystemCapability.Communication.NetManager.Core

返回值:

类型 说明
Promise<HttpProxy> 以Promise形式返回网络的全局代理配置信息。

错误码:

错误码ID 错误信息
401 Parameter error.
202 Non-system applications use system APIs.
2100002 Operation failed. Cannot connect to service.
2100003 System internal error.

示例:

import connection from '@ohos.net.connection';
import { BusinessError } from '@ohos.base';

connection.getGlobalHttpProxy().then((data: connection.HttpProxy) => {
  console.info(JSON.stringify(data));
}).catch((error: BusinessError) => {
  console.info(JSON.stringify(error));
});

connection.setGlobalHttpProxy10+

setGlobalHttpProxy(httpProxy: HttpProxy, callback: AsyncCallback<void>): void

设置网络全局Http代理配置信息,使用callback方式作为异步方法。

系统接口:此接口为系统接口。

需要权限:ohos.permission.CONNECTIVITY_INTERNAL

系统能力:SystemCapability.Communication.NetManager.Core

参数:

参数名 类型 必填 说明
httpProxy HttpProxy 网络全局Http代理配置信息。
callback AsyncCallback<void> 回调函数。当成功设置网络全局Http代理配置信息时,error为undefined,否则为错误对象。

错误码:

错误码ID 错误信息
201 Permission denied.
401 Parameter error.
202 Non-system applications use system APIs.
2100001 Invalid parameter value.
2100002 Operation failed. Cannot connect to service.
2100003 System internal error.

示例:

import connection from '@ohos.net.connection';
import { BusinessError } from '@ohos.base';

let exclusionStr = "192.168,baidu.com";
let exclusionArray = exclusionStr.split(',');
let httpProxy: connection.HttpProxy = {
    host: "192.168.xx.xxx",
    port: 8080,
    exclusionList: exclusionArray
}
connection.setGlobalHttpProxy(httpProxy, (err: BusinessError) => {
    if (err) {
        console.error(`setGlobalHttpProxy failed, callback: err->${JSON.stringify(err)}`);
        return;
    }
    console.log(`setGlobalHttpProxy success.`);
});

connection.setGlobalHttpProxy10+

setGlobalHttpProxy(httpProxy: HttpProxy): Promise<void>;

设置网络全局Http代理配置信息,使用Promise方式作为异步方法。

系统接口:此接口为系统接口。

需要权限:ohos.permission.CONNECTIVITY_INTERNAL

系统能力:SystemCapability.Communication.NetManager.Core

参数:

参数名 类型 必填 说明
httpProxy HttpProxy 网络全局Http代理配置信息。

返回值:

类型 说明
Promise<void> 无返回值的Promise对象。

错误码:

错误码ID 错误信息
201 Permission denied.
401 Parameter error.
202 Non-system applications use system APIs.
2100001 Invalid parameter value.
2100002 Operation failed. Cannot connect to service.
2100003 System internal error.

示例:

import connection from '@ohos.net.connection';
import { BusinessError } from '@ohos.base';

let exclusionStr = "192.168,baidu.com";
let exclusionArray = exclusionStr.split(',');
connection.setGlobalHttpProxy({
  host: "192.168.xx.xxx",
  port: 8080,
  exclusionList: exclusionArray
} as connection.HttpProxy).then(() => {
  console.info("success");
}).catch((error: BusinessError) => {
  console.info(JSON.stringify(error));
});

connection.enableAirplaneMode

enableAirplaneMode(callback: AsyncCallback<void>): void

开启飞行模式,使用callback方式作为异步方法。

系统接口:此接口为系统接口。

需要权限:ohos.permission.CONNECTIVITY_INTERNAL

系统能力:SystemCapability.Communication.NetManager.Core

参数:

参数名 类型 必填 说明
callback AsyncCallback<void> 回调函数。

错误码:

错误码ID 错误信息
201 Permission denied.
202 Non-system applications use system APIs.
401 Parameter error.
2100002 Operation failed. Cannot connect to service.
2100003 System internal error.

示例:

import connection from '@ohos.net.connection';
import { BusinessError } from '@ohos.base';

connection.enableAirplaneMode((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

connection.enableAirplaneMode

enableAirplaneMode(): Promise<void>

开启飞行模式,使用Promise方式作为异步方法。

系统接口:此接口为系统接口。

需要权限:ohos.permission.CONNECTIVITY_INTERNAL

系统能力:SystemCapability.Communication.NetManager.Core

返回值:

类型 说明
Promise<void> 无返回值的Promise对象。

错误码:

错误码ID 错误信息
201 Permission denied.
202 Non-system applications use system APIs.
401 Parameter error.
2100002 Operation failed. Cannot connect to service.
2100003 System internal error.

示例:

import connection from '@ohos.net.connection';

connection.enableAirplaneMode().then((error: void) => {
  console.log(JSON.stringify(error));
});

connection.disableAirplaneMode

disableAirplaneMode(callback: AsyncCallback<void>): void

关闭飞行模式,使用callback方式作为异步方法。

系统接口:此接口为系统接口。

需要权限:ohos.permission.CONNECTIVITY_INTERNAL

系统能力:SystemCapability.Communication.NetManager.Core

参数:

参数名 类型 必填 说明
callback AsyncCallback<void> 回调函数。当关闭飞行模式成功,error为undefined,否则为错误对象。

错误码:

错误码ID 错误信息
201 Permission denied.
202 Non-system applications use system APIs.
401 Parameter error.
2100002 Operation failed. Cannot connect to service.
2100003 System internal error.

示例:

import connection from '@ohos.net.connection';
import { BusinessError } from '@ohos.base';

connection.disableAirplaneMode((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

connection.disableAirplaneMode

disableAirplaneMode(): Promise<void>

关闭飞行模式,使用Promise方式作为异步方法。

系统接口:此接口为系统接口。

需要权限:ohos.permission.CONNECTIVITY_INTERNAL

系统能力:SystemCapability.Communication.NetManager.Core

返回值:

类型 说明
Promise<void> 无返回值的Promise对象。

错误码:

错误码ID 错误信息
201 Permission denied.
202 Non-system applications use system APIs.
401 Parameter error.
2100002 Operation failed. Cannot connect to service.
2100003 System internal error.

示例:

import connection from '@ohos.net.connection';

connection.disableAirplaneMode().then((error: void) => {
  console.log(JSON.stringify(error));
});

connection.factoryReset11+

factoryReset(): Promise<void>

出厂重置网络设置,使用Promise方式作为异步方法。

系统接口:此接口为系统接口。

需要权限:ohos.permission.CONNECTIVITY_INTERNAL

系统能力:SystemCapability.Communication.NetManager.Core

返回值:

类型 说明
Promise<void> 无返回值的Promise对象。

错误码:

错误码ID 错误信息
201 Permission denied.
202 Non-system applications use system APIs.
401 Parameter error.
2100002 Operation failed. Cannot connect to service.
2100003 System internal error.

示例:

import connection from '@ohos.net.connection';
import { BusinessError } from '@ohos.base';
connection.factoryReset().then(() => {
    console.log("success");
}).catch((error: BusinessError) => {
    console.log(JSON.stringify(error));
})