@system.network (Network State)

NOTE

• The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version.

• The APIs of this module are no longer maintained since API version 8. You are advised to use '@ohos.net.connection'.

Modules to Import

import network from '@system.network';

Required Permissions

ohos.permission.GET_WIFI_INFO

ohos.permission.GET_NETWORK_INFO

network.getType³⁺

getType(options?: {
  success?: (data: NetworkResponse) => void;
  fail?: (data: any, code: number) => void;
  complete?: () => void;
}): void

Obtains the network type of this device.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
success	Function	No	Called when the API call is successful. The return value is defined by NetworkResponse.
fail	Function	No	Called when an API call fails.
complete	Function	No	Called when an API call is complete.

Error codes:

Error Code	Description
602	The current permission is not declared.

Example

export default class Network {
  getType() {
    network.getType({
      success: (data) => {
        console.info('success get network type:' + data.type);
      }
    });
  }
}

network.subscribe³⁺

subscribe(options?:{
  success?: (data: NetworkResponse) => void;
  fail?: (data: any, code: number) => void;
}): void

Listens to the network connection state of this device. If this API is called multiple times, the last call takes effect.

System capability: SystemCapability.Communication.NetManager.Core

Parameters

Name	Type	Mandatory	Description
success	Function	No	Called when the network connection state changes The return value is defined by NetworkResponse.
fail	Function	No	Called when an API call fails.

Error codes:

Error Code	Description
602	The current permission is not declared.
200	Subscription failed.

Example

export default class Network {
  subscribe() {
    network.subscribe({
      success: (data) => {
        console.info('success get network type:' + data.type);
      }
    });
  }
}

network.unsubscribe³⁺

unsubscribe(): void

Cancels listening to the network connection state of this device.

System capability: SystemCapability.Communication.NetManager.Core

Example

import network from '@system.network';

network.unsubscribe();

NetworkResponse³⁺

System capability: SystemCapability.Communication.NetManager.Core

Name	Type	Read-Only	Optional	Description
metered	boolean	No	Yes	Whether to charge by traffic. The value true means to charge by traffic, and the value false means the opposite.
type	string	No	No	Network type. The value can be 2G, 3G, 4G, 5G, WiFi, or none.