NetManager

java.lang.Object
- ohos.net.NetManager

```
public final class NetManager
extends Object
```
Provides interfaces to manage and use data networks.
This class provides interfaces to activate and query data networks and bind NICs to processes, as well as callback interfaces to listen for status changes.

从以下版本开始:

1

字段概要

字段
限定符和类型	字段	说明
`static int`	`BACKGROUND_POLICY_ALLOWLISTED`	Indicates that only applications in the allowlist can use metered networks.
`static int`	`BACKGROUND_POLICY_DISABLE`	Indicates that applications can use metered networks.
`static int`	`BACKGROUND_POLICY_ENABLED`	Indicates that applications cannot use metered networks.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`addDefaultNetStatusCallback(NetStatusCallback callback)`	Receives status change notifications of the default data network.
`boolean`	`addNetStatusCallback(NetSpecifier netSpecifier, NetStatusCallback callback)`	Receives status change notifications of a specified network.
`NetHandle[]`	`getAllNets()`	Obtains the list of data networks that are activated.
`NetHandle`	`getAppNet()`	Obtains the `NetHandle` bound to a process using `setAppNet(ohos.net.NetHandle)`.
`int`	`getBackgroundPolicy()`	Queries the background policy of the current application.
`ConnectionProperties`	`getConnectionProperties(NetHandle handle)`	Queries the connection properties of a network.
`HttpProxy`	`getDefaultHttpProxy()`	Obtains the default `HttpProxy` proxy settings.
`NetHandle`	`getDefaultNet()`	Obtains the data network that is activated by default.
`static NetManager`	`getInstance(Context context)`	Get the NetManager instance.
`NetCapabilities`	`getNetCapabilities(NetHandle handle)`	Obtains `NetCapabilities` of a `NetHandle` object.
`boolean`	`hasDefaultNet()`	Checks whether the default data network is activated.
`boolean`	`isDefaultNetMetered()`	Checks whether data traffic usage on the current network is metered.
`boolean`	`removeNetStatusCallback(NetStatusCallback callback)`	Cancels listening for network status changes.
`boolean`	`sendNetConnectState(NetHandle netHandle, boolean isConnect)`	Reports the network state.
`boolean`	`setAppNet(NetHandle netHandle)`	Binds a process to `handle`.
`boolean`	`setupSpecificNet(NetSpecifier netSpecifier, NetStatusCallback callback)`	Activates a data network matching `NetSpecifier`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - BACKGROUND_POLICY_ALLOWLISTED
```
public static final int BACKGROUND_POLICY_ALLOWLISTED
```
    Indicates that only applications in the allowlist can use metered networks.
    
    从以下版本开始:
    
    2
    
    另请参阅:
    
    常量字段值
  - BACKGROUND_POLICY_DISABLE
```
public static final int BACKGROUND_POLICY_DISABLE
```
    Indicates that applications can use metered networks.
    
    从以下版本开始:
    
    2
    
    另请参阅:
    
    常量字段值
  - BACKGROUND_POLICY_ENABLED
```
public static final int BACKGROUND_POLICY_ENABLED
```
    Indicates that applications cannot use metered networks.
    
    从以下版本开始:
    
    2
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getInstance
```
public static NetManager getInstance(Context context)
```
    Get the NetManager instance.
    
    参数:
    
    context - application context.
    
    返回:
    
    NetManager instance
    
    从以下版本开始:
    
    1
  - setupSpecificNet
```
public boolean setupSpecificNet(NetSpecifier netSpecifier,
                                NetStatusCallback callback)
```
    Activates a data network matching NetSpecifier. A network is automatically deactivated when the application exits. It can also be manually deactivated by using removeNetStatusCallback(ohos.net.NetStatusCallback).
    To call this method, you must have the ohos.permission.SET_NETWORK_INFO permission.
    
    参数:
    
    netSpecifier - Indicates the network specifier. See NetSpecifier.
    
    callback - Indicates the callback to notify the application of network status changes. For details, see NetStatusCallback.
    
    返回:
    
    Returns true if the network is activated; returns false otherwise.
    
    从以下版本开始:
    
    1
  - addNetStatusCallback
```
public boolean addNetStatusCallback(NetSpecifier netSpecifier,
                                    NetStatusCallback callback)
```
    Receives status change notifications of a specified network.
    removeNetStatusCallback(ohos.net.NetStatusCallback) can be used to cancel receiving status change notifications. This method requires the ohos.permission.GET_NETWORK_INFO permission.
    
    参数:
    
    netSpecifier - Indicates the network specifier. See NetSpecifier.
    
    callback - Indicates the callback to notify the application of network status changes. For details, see NetStatusCallback.
    
    返回:
    
    Returns true if notifications are received; returns false otherwise.
    
    从以下版本开始:
    
    1
  - removeNetStatusCallback
```
public boolean removeNetStatusCallback(NetStatusCallback callback)
```
    Cancels listening for network status changes. If the callback is used by setupSpecificNet(ohos.net.NetSpecifier,ohos.net.NetStatusCallback), network connection will be interrupted.
    
    参数:
    
    callback - Indicates the callback to cancel. For details, see NetStatusCallback.
    
    返回:
    
    Returns true if listening for network status changes is canceled; returns false otherwise.
    
    从以下版本开始:
    
    1
  - addDefaultNetStatusCallback
```
public boolean addDefaultNetStatusCallback(NetStatusCallback callback)
```
    Receives status change notifications of the default data network.
    removeNetStatusCallback(ohos.net.NetStatusCallback) can be used to cancel receiving status change notifications. This method requires the ohos.permission.GET_NETWORK_INFO permission.
    
    参数:
    
    callback - Indicates the callback to notify the application of network status changes. For details, see NetStatusCallback.
    
    返回:
    
    Returns true if notifications are received; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getDefaultNet
```
public NetHandle getDefaultNet()
```
    Obtains the data network that is activated by default.
    To call this method, you must have the ohos.permission.GET_NETWORK_INFO permission.
    
    返回:
    
    Returns the NetHandle object; returns null if the default network is not activated.
    
    从以下版本开始:
    
    1
  - getAllNets
```
public NetHandle[] getAllNets()
```
    Obtains the list of data networks that are activated.
    To invoke this method, you must have the ohos.permission.GET_NETWORK_INFO permission.
    
    返回:
    
    Returns the NetHandle object; returns null if no network is activated.
    
    从以下版本开始:
    
    1
  - hasDefaultNet
```
public boolean hasDefaultNet()
```
    Checks whether the default data network is activated.
    
    返回:
    
    Returns true if the default data network is activated; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getNetCapabilities
```
public NetCapabilities getNetCapabilities(NetHandle handle)
```
    Obtains NetCapabilities of a NetHandle object.
    To invoke this method, you must have the ohos.permission.GET_NETWORK_INFO permission.
    
    参数:
    
    handle - Indicates the handle. See NetHandle.
    
    返回:
    
    Returns NetCapabilities; returns null if handle is invalid.
    
    从以下版本开始:
    
    1
  - getDefaultHttpProxy
```
public HttpProxy getDefaultHttpProxy()
```
    Obtains the default HttpProxy proxy settings.
    If a global proxy is set, the global proxy parameters are returned. If the process is bound to a NetHandle using setAppNet(ohos.net.NetHandle), the NetHandle proxy settings are returned. In other cases, the default proxy settings of NetHandle are returned.
    
    返回:
    
    Returns the proxy settings. For details, see HttpProxy.
    
    从以下版本开始:
    
    1
  - setAppNet
```
public boolean setAppNet(NetHandle netHandle)
```
    Binds a process to handle.
    All the sockets created from the process will be bound to the handle, and the resolution of all host names will be managed by the handle. You can unbind the process from handle by setting nethanlde to null.
    
    参数:
    
    netHandle - Indicates the handle. For details, see NetHandle.
    
    返回:
    
    Returns true for success, false for failed.
    
    从以下版本开始:
    
    1
  - getAppNet
```
public NetHandle getAppNet()
```
    Obtains the NetHandle bound to a process using setAppNet(ohos.net.NetHandle).
    
    返回:
    
    Returns the NetHandle bound to the process; returns null if no NetHandle is bound to the process. For details, see NetHandle.
    
    从以下版本开始:
    
    1
  - isDefaultNetMetered
```
public boolean isDefaultNetMetered()
```
    Checks whether data traffic usage on the current network is metered.
    To call this method, you must have the ohos.permission.GET_NETWORK_INFO permission.
    
    返回:
    
    Returns true if data traffic usage on the current network is metered; returns false otherwise.
    
    从以下版本开始:
    
    2
  - getConnectionProperties
```
public ConnectionProperties getConnectionProperties(NetHandle handle)
```
    Queries the connection properties of a network.
    This method requires the ohos.permission.GET_NETWORK_INFO permission.
    
    参数:
    
    handle - Indicates the network to be queried.
    
    返回:
    
    Returns the ConnectionProperties object.
    
    从以下版本开始:
    
    2
  - getBackgroundPolicy
```
public int getBackgroundPolicy()
```
    Queries the background policy of the current application.
    
    返回:
    
    Returns the background policy of the current application. For details, see BACKGROUND_POLICY_DISABLE.
    
    从以下版本开始:
    
    2
  - sendNetConnectState
```
public boolean sendNetConnectState(NetHandle netHandle,
                                   boolean isConnect)
```
    Reports the network state.
    Permissions required: SystemPermission.GET_NETWORK_INFO and SystemPermission.INTERNET
    
    参数:
    
    netHandle - Indicates the network whose state is to be reported. The value nullindicates the current network.
    
    isConnect - Specifies whether the network is available. The value true indicates that the network is available, and false indicates the opposite.
    
    返回:
    
    Returns true if the operation is successful; returns false otherwise.
    
    从以下版本开始:
    
    5

类 NetManager

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

BACKGROUND_POLICY_ALLOWLISTED

BACKGROUND_POLICY_DISABLE

BACKGROUND_POLICY_ENABLED

方法详细资料

getInstance

setupSpecificNet

addNetStatusCallback

removeNetStatusCallback

addDefaultNetStatusCallback

getDefaultNet

getAllNets

hasDefaultNet

getNetCapabilities

getDefaultHttpProxy

setAppNet

getAppNet

isDefaultNetMetered

getConnectionProperties

getBackgroundPolicy

sendNetConnectState