belongs to Maven artifact androidx.core:core:1.0.0-alpha1

ConnectivityManagerCompat

public final class ConnectivityManagerCompat
extends Object

java.lang.Object
   ↳ androidx.core.net.ConnectivityManagerCompat


Helper for accessing features in ConnectivityManager.

Summary

Constants

int RESTRICT_BACKGROUND_STATUS_DISABLED

Device is not restricting metered network activity while application is running on background.

int RESTRICT_BACKGROUND_STATUS_ENABLED

Device is restricting metered network activity while application is running on background.

int RESTRICT_BACKGROUND_STATUS_WHITELISTED

Device is restricting metered network activity while application is running on background, but application is allowed to bypass it.

Public methods

static NetworkInfo getNetworkInfoFromBroadcast(ConnectivityManager cm, Intent intent)

Return the NetworkInfo that caused the given ConnectivityManager.CONNECTIVITY_ACTION broadcast.

static int getRestrictBackgroundStatus(ConnectivityManager cm)

Determines if the calling application is subject to metered network restrictions while running on background.

static boolean isActiveNetworkMetered(ConnectivityManager cm)

Returns if the currently active data network is metered.

Inherited methods

Constants

RESTRICT_BACKGROUND_STATUS_DISABLED

int RESTRICT_BACKGROUND_STATUS_DISABLED

Device is not restricting metered network activity while application is running on background.

Constant Value: 1 (0x00000001)

RESTRICT_BACKGROUND_STATUS_ENABLED

int RESTRICT_BACKGROUND_STATUS_ENABLED

Device is restricting metered network activity while application is running on background.

In this state, application should not try to use the network while running on background, because it would be denied.

Constant Value: 3 (0x00000003)

RESTRICT_BACKGROUND_STATUS_WHITELISTED

int RESTRICT_BACKGROUND_STATUS_WHITELISTED

Device is restricting metered network activity while application is running on background, but application is allowed to bypass it.

In this state, application should take action to mitigate metered network access. For example, a music streaming application should switch to a low-bandwidth bitrate.

Constant Value: 2 (0x00000002)

Public methods

getNetworkInfoFromBroadcast

NetworkInfo getNetworkInfoFromBroadcast (ConnectivityManager cm, 
                Intent intent)

Return the NetworkInfo that caused the given ConnectivityManager.CONNECTIVITY_ACTION broadcast. This obtains the current state from ConnectivityManager instead of using the potentially-stale value from ConnectivityManager.EXTRA_NETWORK_INFO. May be null.

Requires the ACCESS_NETWORK_STATE permission.

Parameters
cm ConnectivityManager

intent Intent

Returns
NetworkInfo

getRestrictBackgroundStatus

int getRestrictBackgroundStatus (ConnectivityManager cm)

Determines if the calling application is subject to metered network restrictions while running on background.

Parameters
cm ConnectivityManager

Returns
int RESTRICT_BACKGROUND_STATUS_DISABLED, RESTRICT_BACKGROUND_STATUS_ENABLED, or RESTRICT_BACKGROUND_STATUS_WHITELISTED

isActiveNetworkMetered

boolean isActiveNetworkMetered (ConnectivityManager cm)

Returns if the currently active data network is metered. A network is classified as metered when the user is sensitive to heavy data usage on that connection due to monetary costs, data limitations or battery/performance issues. You should check this before doing large data transfers, and warn the user or delay the operation until another network is available.

This method requires the caller to hold the permission Manifest.permission.ACCESS_NETWORK_STATE.

Requires the ACCESS_NETWORK_STATE permission.

Parameters
cm ConnectivityManager

Returns
boolean true if large transfers should be avoided, otherwise false.