harmony 鸿蒙@ohos.net.connection (Network Connection Management)

2025-06-12
浏览 (11)

@ohos.net.connection (Network Connection Management)

The connection module provides basic network management capabilities. With the APIs provided by this module, you can obtain the default active data network or the list of all active data networks, enable or disable the airplane mode, and obtain network capability information.

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. Unless otherwise specified, the APIs of this module do not support concurrent calls.

Modules to Import

import { connection } from '@kit.NetworkKit';

connection.createNetConnection

createNetConnection(netSpecifier?: NetSpecifier, timeout?: number): NetConnection

Creates a NetConnection object, where netSpecifier specifies the network, and timeout specifies the timeout duration in ms. timeout is configurable only when netSpecifier is specified. If neither of them is present, the default network is used.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netSpecifier	NetSpecifier	No	Network specifier, which specifies the characteristics of a network. If this parameter is not set or is set to undefined, the default network is used.
timeout	number	No	Timeout duration for obtaining the network specified by netSpecifier. This parameter is valid only when netSpecifier is specified. The default value is 0 if netSpecifier is undefined.

Return value

Type	Description
NetConnection	Handle of the network specified by netSpecifier.

Example

import { connection } from '@kit.NetworkKit';

// For the default network, you do not need to pass in parameters.
let netConnection = connection.createNetConnection();

// For the cellular network, you need to pass in related network parameters. If the timeout parameter is not specified, the timeout value is 0 by default.
let netConnectionCellular = connection.createNetConnection({
  netCapabilities: {
    bearerTypes: [connection.NetBearType.BEARER_CELLULAR]
  }
});

connection.getDefaultNet

getDefaultNet(callback: AsyncCallback<NetHandle>): void

Obtains the default active data network. This API uses an asynchronous callback to return the result. You can use getNetCapabilities to obtain information such as the network type and capabilities.

Required permission: ohos.permission.GET_NETWORK_INFO

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<NetHandle>	Yes	Callback used to return the result. If the default activated data network is obtained successfully, error is undefined and data is the default activated data network. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getDefaultNet((error: BusinessError, data: connection.NetHandle) => {
  if (error) {
    console.error(`Failed to get default net. Code:${error.code}, message:${error.message}`);
    return;
  }
  console.info("Succeeded to get data " + JSON.stringify(data));
});

connection.getDefaultNet

getDefaultNet(): Promise<NetHandle>

Obtains the default active data network. This API uses a promise to return the result. You can use getNetCapabilities to obtain information such as the network type and capabilities.

Required permission: ohos.permission.GET_NETWORK_INFO

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
Promise<NetHandle>	Promise used to return the result.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getDefaultNet().then((data: connection.NetHandle) => {
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

connection.getDefaultNetSync⁹⁺

getDefaultNetSync(): NetHandle

Obtains the default active data network in synchronous mode. You can use getNetCapabilities to obtain information such as the network type and capabilities.

Required permission: ohos.permission.GET_NETWORK_INFO

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
NetHandle	Handle of the default active data network.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

let netHandle = connection.getDefaultNetSync();

connection.setAppHttpProxy¹¹⁺

setAppHttpProxy(httpProxy: HttpProxy): void

Sets the application-level HTTP proxy configuration of the network.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
httpProxy	HttpProxy	Yes	Application-level HTTP proxy configuration.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
401	Parameter error.
2100001	Invalid http proxy.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let exclusionStr = "192.168,baidu.com";
let exclusionArray = exclusionStr.split(',');
connection.setAppHttpProxy({
  host: "192.168.xx.xxx",
  port: 8080,
  exclusionList: exclusionArray
} as connection.HttpProxy);

Preset certificate PIN:

A certificate PIN is the hash value calculated using the SHA256 algorithm for a certificate file. For the server.pem certificate, you can use the following openssl command to calculate its PIN:

cat server.pem \
|sed -n '/-----BEGIN/,/-----END/p' \
|openssl x509 -noout -pubkey \
|openssl pkey -pubin -outform der \
|openssl dgst -sha256 -binary \
|openssl enc -base64

Preset application-level certificate:

The original certificate file is preset in the application. Currently, certificate files in the .crt and .pem formats are supported.

NOTE

Currently, certificate pinning has been enabled for the ohos.net.http and Image components, and the hash values of all certificates in the certificate chain are matched. If any certificate is updated on the server, the verification fails. Therefore, if any certificate on the server has been updated, upgrade the application to the latest version as soon as possible. Otherwise, network connection may fail.

Preset JSON configuration file:

The mapping between preset certificates and network servers is configured in a JSON configuration file. The configuration file is stored in the src/main/resources/base/profile/network_config.json directory of the application.

JSON configuration file:

The following is an example configuration of the certificate pin:

{
  "network-security-config": {
    "domain-config": [
      {
        "domains": [
          {
            "include-subdomains": true,
            "name": "server.com"
          }
        ],
        "pin-set": {
          "expiration": "2024-11-08",
          "pin": [
            {
              "digest-algorithm": "sha256",
              "digest": "FEDCBA987654321"
            }
          ]
        }
      }
    ]
  },
  "trust-global-user-ca": false,
  "trust-current-user-ca": false,
}

The following is an example configuration of the application-level certificate:

{
  "network-security-config": {
    "base-config": {
      "trust-anchors": [
        {
          "certificates": "/etc/security/certificates"
        }
      ]
    },
    "domain-config": [
      {
        "domains": [
          {
            "include-subdomains": true,
            "name": "example.com"
          }
        ],
        "trust-anchors": [
          {
            "certificates": "/data/storage/el1/bundle/entry/resources/resfile"
          }
        ]
      }
    ]
  }
}

The following is an example configuration for overall and host name–based HTTP access:

{
  "network-security-config": {
    "base-config": {
      "cleartextTrafficPermitted": true
    },
    "domain-config": [
      {
        "domains": [
          {
            "include-subdomains": true,
            "name": "example.com"
          }
        ],
        "cleartextTrafficPermitted": false
      }
    ]
  }
}

Description of fields

network-security-config (object: network security configuration)

base-config: one or none

domain-config: one (mandatory)

trust-global-user-ca: This field specifies whether to trust the CA certificate manually installed by the enterprise MDM system or device administrator. The default value is true.

trust-current-user-ca: This field specifies whether to trust the certificate installed by the current user. The default value is true.

base-config (object: application-wide security configuration)

trust-anchors: one (mandatory)

cleartextTrafficPermitted (boolean: overall plaintext HTTP access permitted or not): one or none

domain-config (array: security configuration of each domain)

item: any number

domain in an item: one (mandatory)

trust-anchors in an item: one or none

pin-set in an item: one or none

cleartextTrafficPermitted (boolean: host name–based plaintext HTTP access permitted or not) in an item: one or none

trust-anchors (array: trusted CA)

item: any number

certificates (string: CA certificate path) in an item: one (mandatory)

domain (array: domain)

item: any number

name (string: domain name) in an item: one (mandatory)

include-subdomains in an item: one or none (boolean: whether a rule is applicable to subdomains)

pin-set (object: certificate PIN setting)

pin: one (mandatory)

expiration (string: expiration time of the certificate PIN): one or none

pin (array: certificate PIN)

item: any number

digest-algorithm (string: digest algorithm used to generate the PIN) in an item: one (mandatory)

digest (string: public key PIN) in an item: one (mandatory)

cleartextTrafficPermitted (boolean: plaintext HTTP access permitted or not)
This field specifies whether plaintext HTTP access is allowed. The default value is true.

connection.getDefaultHttpProxy¹⁰⁺

getDefaultHttpProxy(callback: AsyncCallback<HttpProxy>): void

Obtains the default HTTP proxy configuration of the network. If the global proxy is set, the global HTTP proxy configuration is returned. If setAppNet is used to bind the application to the network specified by NetHandle, the HTTP proxy configuration of this network is returned. In other cases, the HTTP proxy configuration of the default network is returned. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<HttpProxy>	Yes	Callback used to return the result. If the global HTTP proxy configuration of the network is obtained successfully, error is undefined and data is the global HTTP proxy configuration. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getDefaultHttpProxy((error: BusinessError, data: connection.HttpProxy) => {
  if (error) {
    console.error(`Failed to get default http proxy. Code:${error.code}, message:${error.message}`);
    return;
  }
  console.log("Succeeded to get data" + JSON.stringify(data));
});

connection.getDefaultHttpProxy¹⁰⁺

getDefaultHttpProxy(): Promise<HttpProxy>

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
Promise<HttpProxy>	Promise used to return the result.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

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

connection.getAppNet⁹⁺

getAppNet(callback: AsyncCallback<NetHandle>): void

Obtains information about the network bound to an application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<NetHandle>	Yes	Callback used to return the result. If information about the network bound to the application is successfully obtained, error is undefined and data is the obtained network information. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
401	Parameter error.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getAppNet((error: BusinessError, data: connection.NetHandle) => {
  if (error) {
    console.error(`Failed to get app net. Code:${error.code}, message:${error.message}`);
    return;
  }
  console.info("Succeeded to get data: " + JSON.stringify(data));
})

connection.getAppNet⁹⁺

getAppNet(): Promise<NetHandle>

Obtains information about the network bound to an application. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
Promise<NetHandle>	Promise used to return the result.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

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

connection.getAppNetSync¹⁰⁺

getAppNetSync(): NetHandle

Obtains information about the network bound to an application. This API returns the result synchronously.

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
NetHandle	Handle of the data network bound to the application.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

let netHandle = connection.getAppNetSync();

connection.setAppNet⁹⁺

setAppNet(netHandle: NetHandle, callback: AsyncCallback<void>): void

Binds an application to the specified network, so that the application can access the external network only through this network. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the application is successfully bound to the specified network, error is undefined. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getDefaultNet((error: BusinessError, netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  connection.setAppNet(netHandle, (error: BusinessError, data: void) => {
    if (error) {
      console.error(`Failed to get default net. Code:${error.code}, message:${error.message}`);
      return;
    }
    console.info("Succeeded to get data: " + JSON.stringify(data));
  });
});

connection.setAppNet⁹⁺

setAppNet(netHandle: NetHandle): Promise<void>

Binds an application to the specified network, so that the application can access the external network only through this network. This API uses a promise to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }

  connection.setAppNet(netHandle).then(() => {
    console.log("success");
  }).catch((error: BusinessError) => {
    console.log(JSON.stringify(error));
  })
});

connection.getAllNets

getAllNets(callback: AsyncCallback<Array<NetHandle>>): void

Obtains the list of all connected networks. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<NetHandle>>	Yes	Callback used to return the result. If the list of all connected networks is obtained successfully, error is undefined and data is the list of activated data networks. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getAllNets((error: BusinessError, data: connection.NetHandle[]) => {
  if (error) {
    console.error(`Failed to get all nets. Code:${error.code}, message:${error.message}`);
    return;
  }
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

connection.getAllNets

getAllNets(): Promise<Array<NetHandle>>

Obtains the list of all connected networks. This API uses a promise to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
Promise<Array<NetHandle>>	Promise used to return the result.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getAllNets().then((data: connection.NetHandle[]) => {
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

connection.getAllNetsSync¹⁰⁺

getAllNetsSync(): Array<NetHandle>

Obtains the list of all connected networks. This API returns the result synchronously.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
Array<NetHandle>	List of all activated data networks.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

let netHandle = connection.getAllNetsSync();

connection.getConnectionProperties

getConnectionProperties(netHandle: NetHandle, callback: AsyncCallback<ConnectionProperties>): void

Obtains connection properties of the network corresponding to the netHandle. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network.
callback	AsyncCallback<ConnectionProperties>	Yes	Callback used to return the result. If the connection properties of the network corresponding to the netHandle is obtained successfully, error is undefined and data is the obtained network connection information. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  connection.getConnectionProperties(netHandle, (error: BusinessError, data: connection.ConnectionProperties) => {
    if (error) {
      console.error(`Failed to get connection properties. Code:${error.code}, message:${error.message}`);
      return;
    }
    console.info("Succeeded to get data: " + JSON.stringify(data));
  })
});

connection.getConnectionProperties

getConnectionProperties(netHandle: NetHandle): Promise<ConnectionProperties>

Obtains connection properties of the network corresponding to the netHandle. This API uses a promise to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network.

Return value

Type	Description
Promise<ConnectionProperties>	Promise used to return the result.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }

  connection.getConnectionProperties(netHandle).then((data: connection.ConnectionProperties) => {
    console.info("Succeeded to get data: " + JSON.stringify(data));
  })
});

connection.getConnectionPropertiesSync¹⁰⁺

getConnectionPropertiesSync(netHandle: NetHandle): ConnectionProperties

Obtains network connection information based on the specified netHandle.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network.

Return value

Type	Description
ConnectionProperties	Network connection information.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let netHandle: connection.NetHandle;
let connectionproperties: connection.ConnectionProperties;

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  netHandle = connection.getDefaultNetSync();
  connectionproperties = connection.getConnectionPropertiesSync(netHandle);
  console.info("Succeeded to get connectionproperties: " + JSON.stringify(connectionproperties));
});

connection.getNetCapabilities

getNetCapabilities(netHandle: NetHandle, callback: AsyncCallback<NetCapabilities>): void

Obtains capability information of the network corresponding to the netHandle. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network.
callback	AsyncCallback<NetCapabilities>	Yes	Callback used to return the result. If the capability information of the network corresponding to the netHandle is obtained successfully, error is undefined and data is the obtained network capability information. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  connection.getNetCapabilities(netHandle, (error: BusinessError, data: connection.NetCapabilities) => {
    if (error) {
      console.error(`Failed to get net capabilities. Code:${error.code}, message:${error.message}`);
      return;
    }
    console.info("Succeeded to get data: " + JSON.stringify(data));
  })
}).catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
});

connection.getNetCapabilities

getNetCapabilities(netHandle: NetHandle): Promise<NetCapabilities>

Obtains capability information of the network corresponding to the netHandle. This API uses a promise to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network.

Return value

Type	Description
Promise<NetCapabilities>	Promise used to return the result.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  connection.getNetCapabilities(netHandle).then((data: connection.NetCapabilities) => {
      console.info("Succeeded to get data: " + JSON.stringify(data));
  })
}).catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
});

connection.getNetCapabilitiesSync¹⁰⁺

getNetCapabilitiesSync(netHandle: NetHandle): NetCapabilities

Obtains capability information of the network corresponding to the netHandle. This API returns the result synchronously.

Required permission: ohos.permission.GET_NETWORK_INFO

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network.

Return value

Type	Description
NetCapabilities	Network capability information.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let netHandle: connection.NetHandle;
let getNetCapabilitiesSync: connection.NetCapabilities;

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }

  getNetCapabilitiesSync = connection.getNetCapabilitiesSync(netHandle);
  console.info("Succeeded to get net capabilities sync: " + JSON.stringify(getNetCapabilitiesSync));
});

connection.isDefaultNetMetered⁹⁺

isDefaultNetMetered(callback: AsyncCallback<boolean>): void

Checks whether the data traffic usage on the current network is metered. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true indicates the data traffic usage is metered.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.isDefaultNetMetered((error: BusinessError, data: boolean) => {
  console.log(JSON.stringify(error));
  console.log('data: ' + data);
});

connection.isDefaultNetMetered⁹⁺

isDefaultNetMetered(): Promise<boolean>

Checks whether the data traffic usage on the current network is metered. This API uses a promise to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true indicates the data traffic usage is metered.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.isDefaultNetMetered().then((data: boolean) => {
  console.log('data: ' + data);
});

connection.isDefaultNetMeteredSync¹⁰⁺

isDefaultNetMeteredSync(): boolean

Checks whether the data traffic usage on the current network is metered. This API returns the result synchronously.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
boolean	The value true indicates the data traffic usage is metered.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

let isMetered = connection.isDefaultNetMeteredSync();

connection.hasDefaultNet

hasDefaultNet(callback: AsyncCallback<boolean>): void

Checks whether the default data network is activated. This API uses an asynchronous callback to return the result. You can use getDefaultNet to obtain the default data network, if any.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true indicates that the default data network is activated.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.hasDefaultNet((error: BusinessError, data: boolean) => {
  console.log(JSON.stringify(error));
  console.log('data: ' + data);
});

connection.hasDefaultNet

hasDefaultNet(): Promise<boolean>

Checks whether the default data network is activated. This API uses a promise to return the result. You can use getDefaultNet to obtain the default data network, if any.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the default data network is activated.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.hasDefaultNet().then((data: boolean) => {
  console.log('data: ' + data);
});

connection.hasDefaultNetSync¹⁰⁺

hasDefaultNetSync(): boolean

Checks whether the default data network is activated. This API returns the result synchronously.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
boolean	The value true indicates that the default data network is activated.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

let isDefaultNet = connection.hasDefaultNetSync();

connection.reportNetConnected

reportNetConnected(netHandle: NetHandle, callback: AsyncCallback<void>): void

Reports connection of the data network to the network management module. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network. For details, see NetHandle.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the network status is reported successfully, error is undefined. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  connection.reportNetConnected(netHandle, (error: BusinessError) => {
    console.log(JSON.stringify(error));
  });
});

connection.reportNetConnected

reportNetConnected(netHandle: NetHandle): Promise<void>

Reports connection of the data network to the network management module. This API uses a promise to return the result.

Permission required: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network. For details, see NetHandle.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  connection.reportNetConnected(netHandle).then(() => {
    console.log(`report success`);
  });
});

connection.reportNetDisconnected

reportNetDisconnected(netHandle: NetHandle, callback: AsyncCallback<void>): void

Reports disconnection of the data network to the network management module. This API uses an asynchronous callback to return the result.

Permission required: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network. For details, see NetHandle.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the network status is reported successfully, error is undefined. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  connection.reportNetDisconnected(netHandle).then( () => {
    console.log(`report success`);
  });
});

connection.reportNetDisconnected

reportNetDisconnected(netHandle: NetHandle): Promise<void>

Reports disconnection of the data network to the network management module. This API uses a promise to return the result.

Permission required: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network. For details, see NetHandle.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  connection.reportNetDisconnected(netHandle).then( () => {
    console.log(`report success`);
  });
});

connection.getAddressesByName

getAddressesByName(host: string, callback: AsyncCallback<Array<NetAddress>>): void

Resolves the host name by using the corresponding network to obtain all IP addresses. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Host name to resolve.
callback	AsyncCallback<Array<NetAddress>>	Yes	Callback used to return the result. If all IP addresses are successfully obtained, error is undefined, and data is the list of all obtained IP addresses. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getAddressesByName("xxxx", (error: BusinessError, data: connection.NetAddress[]) => {
  if (error) {
    console.error(`Failed to get addresses. Code:${error.code}, message:${error.message}`);
    return;
  }
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

connection.getAddressesByName

getAddressesByName(host: string): Promise<Array<NetAddress>>

Resolves the host name by using the corresponding network to obtain all IP addresses. This API uses a promise to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Host name to resolve.

Return value

Type	Description
Promise<Array<NetAddress>>	Promise used to return the result.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getAddressesByName("xxxx").then((data: connection.NetAddress[]) => {
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

connection.addCustomDnsRule¹¹⁺

addCustomDnsRule(host: string, ip: Array<string>, callback: AsyncCallback<void>): void

Adds custom DNS rules for the specified host of the current application. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Name of the custom host.
ip	Array<string>	Yes	List of IP addresses mapped to the host name.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the mapping is added successfully, error is undefined. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.addCustomDnsRule("xxxx", ["xx.xx.xx.xx","xx.xx.xx.xx"], (error: BusinessError, data: void) => {
  if (error) {
    console.error(`Failed to get add custom dns rule. Code:${error.code}, message:${error.message}`);
    return;
  }
  console.info("Succeeded to get data: " + JSON.stringify(data));
})

connection.addCustomDnsRule¹¹⁺

addCustomDnsRule(host: string, ip: Array<string>): Promise<void>

Adds custom DNS rules for the specified host of the current application. This API uses a promise to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Name of the custom host.
ip	Array<string>	Yes	List of IP addresses mapped to the host name.

Return value

Type	Description
Promise<Array<void>>	Promise that returns no value.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.addCustomDnsRule("xxxx", ["xx.xx.xx.xx","xx.xx.xx.xx"]).then(() => {
    console.info("success");
}).catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
})

connection.removeCustomDnsRule¹¹⁺

removeCustomDnsRule(host: string, callback: AsyncCallback<void>): void

Removes the custom DNS rules of the specified host from the current application. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Name of the host for which DNS rules are to be deleted.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the DNS rules are removed successfully, error is undefined. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.removeCustomDnsRule("xxxx", (error: BusinessError, data: void) => {
  if (error) {
    console.error(`Failed to remove custom dns rule. Code:${error.code}, message:${error.message}`);
    return;
  }
  console.info("Succeeded to get data: " + JSON.stringify(data));
})

connection.removeCustomDnsRule¹¹⁺

removeCustomDnsRule(host: string): Promise<void>

Removes the custom DNS rules of the specified host from the current application. This API uses a promise to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Name of the host for which DNS rules are to be deleted.

Return value

Type	Description
Promise<Array<void>>	Promise that returns no value.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.removeCustomDnsRule("xxxx").then(() => {
    console.log("success");
}).catch((error: BusinessError) => {
    console.log(JSON.stringify(error));
})

connection.clearCustomDnsRules¹¹⁺

clearCustomDnsRules(callback: AsyncCallback<void>): void

Removes all custom DNS rules from the current application. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If all the DNS rules are removed successfully, error is undefined. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.clearCustomDnsRules((error: BusinessError, data: void) => {
  if (error) {
    console.error(`Failed to clear custom dns rules. Code:${error.code}, message:${error.message}`);
    return;
  }
  console.info("Succeeded to get data: " + JSON.stringify(data));
})

connection.clearCustomDnsRules¹¹⁺

clearCustomDnsRules(): Promise<void>

Removes all custom DNS rules from the current application. This API uses a promise to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.clearCustomDnsRules().then(() => {
    console.log("success");
}).catch((error: BusinessError) => {
    console.log(JSON.stringify(error));
})

connection.setPacUrl¹⁵⁺

setPacUrl(pacUrl: string): void

Sets the URL of the system-level proxy auto-config (PAC) script.

Required permissions: ohos.permission.SET_PAC_URL

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
pacUrl	string	Yes	URL of the PAC script. Note that this URL will not be verified by the API.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

let pacUrl = "xxx";
connection.setPacUrl(pacUrl);

connection.getPacUrl¹⁵⁺

getPacUrl(): string

Obtains the URL of the system-level PAC script.

System capability: SystemCapability.Communication.NetManager.Core

Return value

Type	Description
string	URL of the PAC script. If the URL does not exist, the error code 2100003 is returned.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

let pacUrl = connection.getPacUrl();

NetConnection

Represents the network connection handle.

NOTE When a device changes to the network connected state, the netAvailable, netCapabilitiesChange, and netConnectionPropertiesChange events will be triggered. When a device changes to the network disconnected state, the netLost event will be triggered. When a device switches from a Wi-Fi network to a cellular network, the netLost event will be first triggered to indicate that the Wi-Fi network is lost and then the netAvailable event will be triggered to indicate that the cellular network is available.

register

Registers a listener for network status changes.

Required permission: ohos.permission.GET_NETWORK_INFO

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If a listener for network status changes is registered successfully, error is undefined. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100002	Failed to connect to the service.
2100003	System internal error.
2101008	The callback already exists.
2101022	The number of requests exceeded the maximum allowed.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let netCon: connection.NetConnection = connection.createNetConnection();
netCon.register((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

unregister

unregister(callback: AsyncCallback<void>): void

Unregisters the listener for network status changes.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If a listener for network status changes is unregistered successfully, error is undefined. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
401	Parameter error.
2100002	Failed to connect to the service.
2100003	System internal error.
2101007	The callback does not exist.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let netCon: connection.NetConnection = connection.createNetConnection();
netCon.unregister((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

on(‘netAvailable’)

on(type: ‘netAvailable’, callback: Callback<NetHandle>): void

Registers a listener for netAvailable events. Before you call this API, make sure that you have called register to add a listener and called unregister API to unsubscribe from status changes of the default network.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. This field has a fixed value of netAvailable. netAvailable: event indicating that the data network is available.
callback	Callback<NetHandle>	Yes	Callback used to return the network handle.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// Create a NetConnection object.
let netCon: connection.NetConnection = connection.createNetConnection();

// Call register to register a listener.
netCon.register((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

// Subscribe to netAvailable events. Event notifications can be received only after register is called.
netCon.on('netAvailable', (data: connection.NetHandle) => {
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

// Call unregister to unregister the listener.
netCon.unregister((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

on(‘netBlockStatusChange’)

on(type: ‘netBlockStatusChange’, callback: Callback<NetBlockStatusInfo>): void

Registers a listener for netBlockStatusChange events. Before you call this API, make sure that you have called register to add a listener and called unregister API to unsubscribe from status changes of the default network.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. This field has a fixed value of netBlockStatusChange. netBlockStatusChange: event indicating a change in the network blocking status.
callback	Callback<NetBlockStatusInfo>	Yes	Callback used to return the result.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// Create a NetConnection object.
let netCon: connection.NetConnection = connection.createNetConnection();

// Call register to register a listener.
netCon.register((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

// Subscribe to netBlockStatusChange events. Event notifications can be received only after register is called.
netCon.on('netBlockStatusChange', (data: connection.NetBlockStatusInfo) => {
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

// Call unregister to unregister the listener.
netCon.unregister((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

on(‘netCapabilitiesChange’)

on(type: ‘netCapabilitiesChange’, callback: Callback<NetCapabilityInfo>): void

Registers a listener for netCapabilitiesChange events. Before you call this API, make sure that you have called register to add a listener and called unregister API to unsubscribe from status changes of the default network.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. This field has a fixed value of netCapabilitiesChange. netCapabilitiesChange: event indicating that the network capabilities have changed.
callback	Callback<NetCapabilityInfo>	Yes	Callback used to return the network handle (netHandle) and capability information (netCap).

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// Create a NetConnection object.
let netCon: connection.NetConnection = connection.createNetConnection();

// Call register to register a listener.
netCon.register((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

// Subscribe to netCapabilitiesChange events. Event notifications can be received only after register is called.
netCon.on('netCapabilitiesChange', (data: connection.NetCapabilityInfo) => {
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

// Call unregister to unregister the listener.
netCon.unregister((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

on(‘netConnectionPropertiesChange’)

on(type: ‘netConnectionPropertiesChange’, callback: Callback<NetConnectionPropertyInfo>): void

Registers a listener for netConnectionPropertiesChange events. Before you call this API, make sure that you have called register to add a listener and called unregister API to unsubscribe from status changes of the default network.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. This field has a fixed value of netConnectionPropertiesChange. netConnectionPropertiesChange: event indicating that network connection properties have changed.
callback	Callback<NetConnectionPropertyInfo>	Yes	Callback used to return the result.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// Create a NetConnection object.
let netCon: connection.NetConnection = connection.createNetConnection();

// Call register to register a listener.
netCon.register((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

// Subscribe to netConnectionPropertiesChange events. Event notifications can be received only after register is called.
netCon.on('netConnectionPropertiesChange', (data: connection.NetConnectionPropertyInfo) => {
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

// Call unregister to unregister the listener.
netCon.unregister((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

on(‘netLost’)

on(type: ‘netLost’, callback: Callback<NetHandle>): void

Registers a listener for netLost events. Before you call this API, make sure that you have called register to add a listener and called unregister API to unsubscribe from status changes of the default network.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. This field has a fixed value of netLost. netLost: event indicating that the network is interrupted or normally disconnected.
callback	Callback<NetHandle>	Yes	Callback used to return netHandle.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// Create a NetConnection object.
let netCon: connection.NetConnection = connection.createNetConnection();

// Call register to register a listener.
netCon.register((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

// Subscribe to netLost events. Event notifications can be received only after register is called.
netCon.on('netLost', (data: connection.NetHandle) => {
  console.info("Succeeded to get data: " + JSON.stringify(data));
});

// Call unregister to unregister the listener.
netCon.unregister((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

on(‘netUnavailable’)

on(type: ‘netUnavailable’, callback: Callback<void>): void

Registers a listener for netUnavailable events. Before you call this API, make sure that you have called register to add a listener and called unregister API to unsubscribe from status changes of the default network.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. This field has a fixed value of netUnavailable. netUnavailable: event indicating that the network is unavailable.
callback	Callback<void>	Yes	Callback used to return the result, which is empty.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// Create a NetConnection object.
let netCon: connection.NetConnection = connection.createNetConnection();

// Call register to register a listener.
netCon.register((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

// Subscribe to netUnavailable events. Event notifications can be received only after register is called.
netCon.on('netUnavailable', () => {
  console.info("Succeeded to get unavailable net event");
});

// Call unregister to unregister the listener.
netCon.unregister((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

NetHandle

Defines the handle of the data network.

Before invoking NetHandle APIs, call getNetHandle to obtain a NetHandle object.

System capability: SystemCapability.Communication.NetManager.Core

Attributes

Name	Type	Mandatory	Description
netId	number	Yes	Network ID. The value 0 indicates no default network. Any other value must be greater than or equal to 100. Atomic service API: This API can be used in atomic services since API version 11.

bindSocket⁹⁺

bindSocket(socketParam: TCPSocket |UDPSocket, callback: AsyncCallback<void>): void

Binds a TCPSocket or UDPSocket object to the data network. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
socketParam	TCPSocket \|UDPSocket	Yes	TCPSocket or UDPSocket object.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the TCPSocket or UDPSocket object is successfully bound to the current network, error is undefined. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection, socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

interface Data {
  message: ArrayBuffer,
  remoteInfo: socket.SocketRemoteInfo
}

  connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
  }
  let tcp : socket.TCPSocket = socket.constructTCPSocketInstance();
  let udp : socket.UDPSocket = socket.constructUDPSocketInstance();
  let socketType = "TCPSocket";
  if (socketType == "TCPSocket") {
    tcp.bind({address:"192.168.xxx.xxx",
              port:8080,
              family:1} as socket.NetAddress, (error: Error) => {
      if (error) {
        console.log('bind fail');
        return;
      }
      netHandle.bindSocket(tcp, (error: BusinessError, data: void) => {
        if (error) {
          console.error(`Failed to bind socket. Code:${error.code}, message:${error.message}`);
          return;
        } else {
          console.info(JSON.stringify(data));
        }
      });
    });
  } else {
    let callback: (value: Data) => void = (value: Data) => {
      console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
    };
    udp.bind({address:"192.168.xxx.xxx",
              port:8080,
              family:1} as socket.NetAddress, (error: BusinessError) => {
      if (error) {
        console.error(`Failed to bind. Code:${error.code}, message:${error.message}`);
        return;
      }
      udp.on('message', (data: Data) => {
        console.info("Succeeded to get data: " + JSON.stringify(data));
      });
      netHandle.bindSocket(udp, (error: BusinessError, data: void) => {
        if (error) {
          console.error(`Failed to bind socket. Code:${error.code}, message:${error.message}`);
          return;
        } else {
          console.info(JSON.stringify(data));
        }
      });
    });
  }
})

bindSocket⁹⁺

bindSocket(socketParam: TCPSocket |UDPSocket): Promise<void>

Binds a TCPSocket or UDPSocket object to the data network. This API uses a promise to return the result.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
socketParam	TCPSocket \|UDPSocket	Yes	TCPSocket or UDPSocket object.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection, socket } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

interface Data {
  message: ArrayBuffer,
  remoteInfo: socket.SocketRemoteInfo
}

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  let tcp : socket.TCPSocket = socket.constructTCPSocketInstance();
  let udp : socket.UDPSocket = socket.constructUDPSocketInstance();
  let socketType = "TCPSocket";
  if (socketType == "TCPSocket") {
    tcp.bind({address:"192.168.xxx.xxx",
              port:8080,
              family:1} as socket.NetAddress, (error: Error) => {
      if (error) {
        console.log('bind fail');
        return;
      }
      netHandle.bindSocket(tcp).then(() => {
        console.info("bind socket success");
      }).catch((error: BusinessError) => {
        console.error(`Failed to bind socket. Code:${error.code}, message:${error.message}`);
      });
    });
  } else {
    let callback: (value: Data) => void = (value: Data) => {
      console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
    }
    udp.bind({address:"192.168.xxx.xxx",
              port:8080,
              family:1} as socket.NetAddress, (error: BusinessError) => {
      if (error) {
        console.error(`Failed to bind. Code:${error.code}, message:${error.message}`);
        return;
      }
      udp.on('message', (data: Data) => {
        console.info("Succeeded to get data: " + JSON.stringify(data));
      });
      netHandle.bindSocket(udp).then(() => {
        console.info("bind socket success");
      }).catch((error: BusinessError) => {
        console.error(`Failed to bind socket. Code:${error.code}, message:${error.message}`);
      });
    });
  }
});

getAddressesByName

getAddressesByName(host: string, callback: AsyncCallback<Array<NetAddress>>): void

Resolves the host name by using the corresponding network to obtain all IP addresses. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Host name to resolve.
callback	AsyncCallback<Array<NetAddress>>	Yes	Callback used to return the result. If all IP addresses are successfully obtained, error is undefined, and data is the list of all obtained IP addresses. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  let host = "xxxx";
  netHandle.getAddressesByName(host, (error: BusinessError, data: connection.NetAddress[]) => {
    if (error) {
      console.error(`Failed to get addresses. Code:${error.code}, message:${error.message}`);
      return;
    }
    console.info("Succeeded to get data: " + JSON.stringify(data));
  });
});

getAddressesByName

getAddressesByName(host: string): Promise<Array<NetAddress>>

Resolves the host name by using the corresponding network to obtain all IP addresses. This API uses a promise to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Host name to resolve.

Return value

Type	Description
Promise<Array<NetAddress>>	Promise used to return the result.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  let host = "xxxx";
  netHandle.getAddressesByName(host).then((data: connection.NetAddress[]) => {
    console.info("Succeeded to get data: " + JSON.stringify(data));
  });
});

getAddressByName

getAddressByName(host: string, callback: AsyncCallback<NetAddress>): void

Resolves the host name by using the corresponding network to obtain the first IP address. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Host name to resolve.
callback	AsyncCallback<NetAddress>	Yes	Callback used to return the result. If the first IP address is obtained successfully, error is undefined, and data is the first obtained IP address. Otherwise, error is an error object.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  let host = "xxxx";
  netHandle.getAddressByName(host, (error: BusinessError, data: connection.NetAddress) => {
    if (error) {
      console.error(`Failed to get address. Code:${error.code}, message:${error.message}`);
      return;
    }
    console.info("Succeeded to get data: " + JSON.stringify(data));
  });
});

getAddressByName

getAddressByName(host: string): Promise<NetAddress>

Resolves the host name by using the corresponding network to obtain the first IP address. This API uses a promise to return the result.

Required permissions: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
host	string	Yes	Host name to resolve.

Return value

Type	Description
Promise<NetAddress>	Promise used to return the result.

Error codes

For details about the error codes, see Network Connection Management Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error.
2100001	Invalid parameter value.
2100002	Failed to connect to the service.
2100003	System internal error.

Example

import { connection } from '@kit.NetworkKit';

connection.getDefaultNet().then((netHandle: connection.NetHandle) => {
  if (netHandle.netId == 0) {
    // If no network is connected, the obtained netid of netHandler is 0, which is abnormal. You can add specific processing based on the service requirements.
    return;
  }
  let host = "xxxx";
  netHandle.getAddressByName(host).then((data: connection.NetAddress) => {
    console.info("Succeeded to get data: " + JSON.stringify(data));
  });
});

NetCap

Defines the network capability.

System capability: SystemCapability.Communication.NetManager.Core

Name	Value	Description
NET_CAPABILITY_MMS	0	The network can connect to the carrier’s Multimedia Messaging Service Center (MMSC) to send and receive multimedia messages. Atomic service API: This API can be used in atomic services since API version 11.
NET_CAPABILITY_NOT_METERED	11	The network traffic is not metered. Atomic service API: This API can be used in atomic services since API version 11.
NET_CAPABILITY_INTERNET	12	The network is capable of Internet access but the network connectivity is not successfully verified by the network management module. This capability is configured by the network provider. Atomic service API: This API can be used in atomic services since API version 11.
NET_CAPABILITY_NOT_VPN	15	The network does not use a virtual private network (VPN). Atomic service API: This API can be used in atomic services since API version 11.
NET_CAPABILITY_VALIDATED	16	The network management module successfully connects to the Huawei Cloud address through the network. This capability is configured by the network management module. If the network management module fails to connect to the Huawei Cloud address, this flag is not available in the network capability, but this does not mean a complete loss in Internet access. Note that for a newly connected network, this value may not reflect the actual verification result as network connectivity verification is in progress. You can use NET_CAPABILITY_CHECKING_CONNECTIVITY¹²⁺ to check whether network connectivity verification is in progress. Atomic service API: This API can be used in atomic services since API version 11.
NET_CAPABILITY_PORTAL¹²⁺	17	The network is found to have a captive portal and user login authentication is required. This capability is set by the connection management module. Atomic service API: This API can be used in atomic services since API version 12.
NET_CAPABILITY_CHECKING_CONNECTIVITY¹²⁺	31	The network management module is verifying the network connectivity. This value remains valid until the connectivity check is complete. If it is present, the value of NET_CAPABILITY_VALIDATED may be incorrect. Atomic service API: This API can be used in atomic services since API version 12.

NetBearType

Enumerates network types.

System capability: SystemCapability.Communication.NetManager.Core

Name	Value	Description
BEARER_CELLULAR	0	Cellular network. Atomic service API: This API can be used in atomic services since API version 11.
BEARER_WIFI	1	Wi-Fi network. Atomic service API: This API can be used in atomic services since API version 11.
BEARER_BLUETOOTH¹²⁺	2	Bluetooth network. Atomic service API: This API can be used in atomic services since API version 12.
BEARER_ETHERNET	3	Ethernet network. Atomic service API: This API can be used in atomic services since API version 11.
BEARER_VPN¹²⁺	4	VPN.

HttpProxy¹⁰⁺

Represents the HTTP proxy configuration.

System capability: SystemCapability.Communication.NetManager.Core

Name	Type	Mandatory	Description
host	string	Yes	Host name of the proxy server. Atomic service API: This API can be used in atomic services since API version 11.
port	number	Yes	Host port. Atomic service API: This API can be used in atomic services since API version 11.
exclusionList	Array<string>	Yes	List of the names of hosts that do not use a proxy. Host names can be domain names, IP addresses, or wildcards. The detailed matching rules are as follows: - Domain name matching: - Exact match: The host name of the proxy server exactly matches any host name in the list. - Partial match: The host name of the proxy server contains any host name in the list. For example, if ample.com is set in the host name list, ample.com, www.ample.com, and ample.com:80 are matched, and www.example.com and ample.com.org are not matched. - IP address matching: The host name of the proxy server exactly matches any IP address in the list. - Both the domain name and IP address are added to the list for matching. - A single asterisk () is the only valid wildcard. If the list contains only wildcards, the wildcards match all host names; that is, the HTTP proxy is disabled. A wildcard can only be added independently. It cannot be added to the list together with other domain names or IP addresses. Otherwise, the wildcard does not take effect. - Host names are case insensitive. - Protocol prefixes such as http* and https are ignored during matching. Atomic service API: This API can be used in atomic services since API version 11.
username¹²⁺	string	No	Name of the user who uses the proxy.
password¹²⁺	string	No	Password of the user who uses the proxy.

NetSpecifier

Provides an instance that bears data network capabilities.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Name	Type	Mandatory	Description
netCapabilities	NetCapabilities	Yes	Network transmission capabilities and bearer types of the data network.
bearerPrivateIdentifier	string	No	Network identifier. The identifier of the cellular network is slot0 for SIM card 1 and slot1 for SIM card 2. Since API version 12, you can pass the registered WLAN hotspot to the API to specify the WLAN network to be activated.

Example

import { connection } from '@kit.NetworkKit';
import { wifiManager } from '@kit.ConnectivityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let config: wifiManager.WifiDeviceConfig = {
  ssid: "TEST",
  preSharedKey: "**********",
  securityType: wifiManager.WifiSecurityType.WIFI_SEC_TYPE_PSK
};
// Obtain the network ID of the registered WLAN through wifiManager.addCandidateConfig.
let networkId: number = await wifiManager.addCandidateConfig(config);
let netConnectionWlan = connection.createNetConnection({
  netCapabilities: {
    bearerTypes: [connection.NetBearType.BEARER_WIFI]
  },
  bearerPrivateIdentifier: `${networkId}`
});
netConnectionWlan.register((error: BusinessError) => {
  console.log(JSON.stringify(error));
});

NetCapabilityInfo¹⁰⁺

Provides an instance that bears data network capabilities.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetManager.Core

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Handle of the data network.
netCap	NetCapabilities	Yes	Network transmission capabilities and bearer types of the data network.

NetCapabilities

Defines the network capability set.

System capability: SystemCapability.Communication.NetManager.Core

Name	Type	Mandatory	Description
linkUpBandwidthKbps	number	No	Uplink (device-to-network) bandwidth, in kbit/s. The value 0 indicates that the network bandwidth cannot be evaluated.
linkDownBandwidthKbps	number	No	Downlink (network-to-device) bandwidth, in kbit/s. The value 0 indicates that the network bandwidth cannot be evaluated.
networkCap	Array<NetCap>	No	Network capability. Atomic service API: This API can be used in atomic services since API version 11.
bearerTypes	Array<NetBearType>	Yes	Network type. The array contains only one specific network type. Atomic service API: This API can be used in atomic services since API version 11.

NetConnectionPropertyInfo¹¹⁺

Defines the network connection properties.

System capability: SystemCapability.Communication.NetManager.Core

Attributes

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Data network handle.
connectionProperties	ConnectionProperties	Yes	Network connection properties.

NetBlockStatusInfo¹¹⁺

Obtains the network block status information.

System capability: SystemCapability.Communication.NetManager.Core

Attributes

Name	Type	Mandatory	Description
netHandle	NetHandle	Yes	Data network handle.
blocked	boolean	Yes	Whether the current network is blocked.

ConnectionProperties

Defines the network connection properties.

System capability: SystemCapability.Communication.NetManager.Core

Name	Type	Mandatory	Description
interfaceName	string	Yes	Network interface card (NIC) name.
domains	string	Yes	Domain name.
linkAddresses	Array<LinkAddress>	Yes	Link information.
routes	Array<RouteInfo>	Yes	Route information.
dnses	Array<NetAddress>	Yes	Network address. For details, see NetAddress.
mtu	number	Yes	Maximum transmission unit (MTU).

RouteInfo

Defines network route information.

System capability: SystemCapability.Communication.NetManager.Core

Name	Type	Mandatory	Description
interface	string	Yes	NIC name.
destination	LinkAddress	Yes	Destination address.
gateway	NetAddress	Yes	Gateway address.
hasGateway	boolean	Yes	Whether a gateway is present.
isDefaultRoute	boolean	Yes	Whether the route is the default route.

LinkAddress

Defines network link information.

System capability: SystemCapability.Communication.NetManager.Core

Name	Type	Mandatory	Description
address	NetAddress	Yes	Link address.
prefixLength	number	Yes	Length of the link address prefix.

NetAddress

Defines a network address.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Communication.NetManager.Core

HttpRequest

type HttpRequest = http.HttpRequest

Defines an HTTP request.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Communication.NetStack

Type	Description
http.HttpRequest	HTTP request task. You need to obtain an HTTP request task before calling HttpRequest APIs .

TCPSocket

type TCPSocket = socket.TCPSocket

Defines a TCPSocket object.

Atomic service API: This API can be used in atomic services since API version 10.

System capability: SystemCapability.Communication.NetStack

Type	Description
socket.TCPSocket	TCPSocket object.

UDPSocket

type UDPSocket = socket.UDPSocket

Defines a UDPSocket object.

Atomic service API: This API can be used in atomic services since API version 10.

System capability: SystemCapability.Communication.NetStack

Type	Description
socket.UDPSocket	UDPSocket object.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Network Kit

harmony 鸿蒙NetConn_ConnectionProperties

harmony 鸿蒙NetConn_HttpProxy

harmony 鸿蒙NetConn_NetAddr

harmony 鸿蒙NetConn_NetCapabilities

harmony 鸿蒙NetConn_NetConnCallback

harmony 鸿蒙NetConn_NetHandle

harmony 鸿蒙NetConn_NetHandleList

harmony 鸿蒙NetConn_NetSpecifier

harmony 鸿蒙NetConn_Route

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/duUM99

harmony 鸿蒙@ohos.net.connection (Network Connection Management)

@ohos.net.connection (Network Connection Management)

Modules to Import

connection.createNetConnection

connection.getDefaultNet

connection.getDefaultNet

connection.getDefaultNetSync9+

connection.setAppHttpProxy11+

connection.getDefaultHttpProxy10+

connection.getDefaultHttpProxy10+

connection.getAppNet9+

connection.getAppNet9+

connection.getAppNetSync10+

connection.setAppNet9+

connection.setAppNet9+

connection.getAllNets

connection.getAllNets

connection.getAllNetsSync10+

connection.getConnectionProperties

connection.getConnectionProperties

connection.getConnectionPropertiesSync10+

connection.getNetCapabilities

connection.getNetCapabilities

connection.getNetCapabilitiesSync10+

connection.isDefaultNetMetered9+

connection.isDefaultNetMetered9+

connection.isDefaultNetMeteredSync10+

connection.hasDefaultNet

connection.hasDefaultNet

connection.hasDefaultNetSync10+

connection.reportNetConnected

connection.reportNetConnected

connection.reportNetDisconnected

connection.reportNetDisconnected

connection.getAddressesByName

connection.getAddressesByName

connection.addCustomDnsRule11+

connection.addCustomDnsRule11+

connection.removeCustomDnsRule11+

connection.removeCustomDnsRule11+

connection.clearCustomDnsRules11+

connection.clearCustomDnsRules11+

connection.setPacUrl15+

connection.getPacUrl15+

NetConnection

register

unregister

on(‘netAvailable’)

on(‘netBlockStatusChange’)

on(‘netCapabilitiesChange’)

on(‘netConnectionPropertiesChange’)

on(‘netLost’)

on(‘netUnavailable’)

NetHandle

Attributes

bindSocket9+

bindSocket9+

getAddressesByName

getAddressesByName

getAddressByName

getAddressByName

NetCap

NetBearType

HttpProxy10+

NetSpecifier

NetCapabilityInfo10+

NetCapabilities

NetConnectionPropertyInfo11+

Attributes

NetBlockStatusInfo11+

Attributes

ConnectionProperties

RouteInfo

LinkAddress

NetAddress

HttpRequest

TCPSocket

UDPSocket

你可能感兴趣的鸿蒙文章

热门推荐

connection.getDefaultNetSync⁹⁺

connection.setAppHttpProxy¹¹⁺

connection.getDefaultHttpProxy¹⁰⁺

connection.getDefaultHttpProxy¹⁰⁺

connection.getAppNet⁹⁺

connection.getAppNet⁹⁺

connection.getAppNetSync¹⁰⁺

connection.setAppNet⁹⁺

connection.setAppNet⁹⁺

connection.getAllNetsSync¹⁰⁺

connection.getConnectionPropertiesSync¹⁰⁺

connection.getNetCapabilitiesSync¹⁰⁺

connection.isDefaultNetMetered⁹⁺

connection.isDefaultNetMetered⁹⁺

connection.isDefaultNetMeteredSync¹⁰⁺

connection.hasDefaultNetSync¹⁰⁺

connection.addCustomDnsRule¹¹⁺

connection.addCustomDnsRule¹¹⁺

connection.removeCustomDnsRule¹¹⁺

connection.removeCustomDnsRule¹¹⁺

connection.clearCustomDnsRules¹¹⁺

connection.clearCustomDnsRules¹¹⁺

connection.setPacUrl¹⁵⁺

connection.getPacUrl¹⁵⁺

bindSocket⁹⁺

bindSocket⁹⁺

HttpProxy¹⁰⁺

NetCapabilityInfo¹⁰⁺

NetConnectionPropertyInfo¹¹⁺

NetBlockStatusInfo¹¹⁺