ConnectivityManager

ACTION_BACKGROUND_DATA_SETTING_CHANGED

String ACTION_BACKGROUND_DATA_SETTING_CHANGED

This constant was deprecated in API level 16.
As of ICE_CREAM_SANDWICH, availability of background data depends on several combined factors, and this broadcast is no longer sent. Instead, when background data is unavailable, getActiveNetworkInfo() will now appear disconnected. During first boot after a platform upgrade, this broadcast will be sent once if getBackgroundDataSetting() was false before the upgrade.

Broadcast Action: The setting for background data usage has changed values. Use getBackgroundDataSetting() to get the current value.

If an application uses the network in the background, it should listen for this broadcast and stop using the background data if the value is false.

Constant Value: "android.net.conn.BACKGROUND_DATA_SETTING_CHANGED"

ACTION_CAPTIVE_PORTAL_SIGN_IN

String ACTION_CAPTIVE_PORTAL_SIGN_IN

The device has connected to a network that has presented a captive portal, which is blocking Internet connectivity. The user was presented with a notification that network sign in is required, and the user invoked the notification's action indicating they desire to sign in to the network. Apps handling this activity should facilitate signing in to the network. This action includes a Network typed extra called EXTRA_NETWORK that represents the network presenting the captive portal; all communication with the captive portal must be done using this Network object.

• When the app handling this action believes the user has signed in to the network and the captive portal has been dismissed, the app should call reportCaptivePortalDismissed() so the system can reevaluate the network. If reevaluation finds the network no longer subject to a captive portal, the network may become the default active data network.
• When the app handling this action believes the user explicitly wants to ignore the captive portal and the network, the app should call ignoreNetwork().

Constant Value: "android.net.conn.CAPTIVE_PORTAL"

ACTION_RESTRICT_BACKGROUND_CHANGED

String ACTION_RESTRICT_BACKGROUND_CHANGED

A change in the background metered network activity restriction has occurred.

Applications should call getRestrictBackgroundStatus() to check if the restriction applies to them.

This is only sent to registered receivers, not manifest receivers.

Constant Value: "android.net.conn.RESTRICT_BACKGROUND_CHANGED"

CONNECTIVITY_ACTION

String CONNECTIVITY_ACTION

A change in network connectivity has occurred. A default connection has either been established or lost. The NetworkInfo for the affected network is sent as an extra; it should be consulted to see what kind of connectivity event occurred.

Constant Value: "android.net.conn.CONNECTIVITY_CHANGE"

DEFAULT_NETWORK_PREFERENCE

int DEFAULT_NETWORK_PREFERENCE

This constant was deprecated in API level 18.
Since we support so many more networks now, the single network default network preference can't really express the hierarchy. Instead, the default is defined by the networkAttributes in config.xml. You can determine the current value by calling getNetworkPreference() from an App.

If you want to set the default network preference,you can directly change the networkAttributes array in framework's config.xml.

Constant Value: 1 (0x00000001)

EXTRA_CAPTIVE_PORTAL

String EXTRA_CAPTIVE_PORTAL

The lookup key for a CaptivePortal object included with the ACTION_CAPTIVE_PORTAL_SIGN_IN intent. The CaptivePortal object can be used to either indicate to the system that the captive portal has been dismissed or that the user does not want to pursue signing in to captive portal. Retrieve it with getParcelableExtra(String).

Constant Value: "android.net.extra.CAPTIVE_PORTAL"

EXTRA_CAPTIVE_PORTAL_URL

String EXTRA_CAPTIVE_PORTAL_URL

Key for passing a URL to the captive portal login activity.

Constant Value: "android.net.extra.CAPTIVE_PORTAL_URL"

EXTRA_EXTRA_INFO

String EXTRA_EXTRA_INFO

The lookup key for a string that provides optionally supplied extra information about the network state. The information may be passed up from the lower networking layers, and its meaning may be specific to a particular network type. Retrieve it with getStringExtra(String).

Constant Value: "extraInfo"

EXTRA_IS_FAILOVER

String EXTRA_IS_FAILOVER

The lookup key for a boolean that indicates whether a connect event is for a network to which the connectivity manager was failing over following a disconnect on another network. Retrieve it with getBooleanExtra(String, boolean).

Constant Value: "isFailover"

EXTRA_NETWORK

String EXTRA_NETWORK

The lookup key for a Network object included with the intent after successfully finding a network for the applications request. Retrieve it with getParcelableExtra(String).

Note that if you intend to invoke openConnection(java.net.URL) then you must get a ConnectivityManager instance before doing so.

Constant Value: "android.net.extra.NETWORK"

EXTRA_NETWORK_INFO

String EXTRA_NETWORK_INFO

This constant was deprecated in API level 14.
Since NetworkInfo can vary based on UID, applications should always obtain network information through getActiveNetworkInfo().

The lookup key for a NetworkInfo object. Retrieve with getParcelableExtra(String).

Constant Value: "networkInfo"

EXTRA_NETWORK_REQUEST

String EXTRA_NETWORK_REQUEST

The lookup key for a NetworkRequest object included with the intent after successfully finding a network for the applications request. Retrieve it with getParcelableExtra(String).

Constant Value: "android.net.extra.NETWORK_REQUEST"

EXTRA_NETWORK_TYPE

String EXTRA_NETWORK_TYPE

Network type which triggered a CONNECTIVITY_ACTION broadcast.

Constant Value: "networkType"

EXTRA_NO_CONNECTIVITY

String EXTRA_NO_CONNECTIVITY

The lookup key for a boolean that indicates whether there is a complete lack of connectivity, i.e., no network is available. Retrieve it with getBooleanExtra(String, boolean).

Constant Value: "noConnectivity"

EXTRA_OTHER_NETWORK_INFO

String EXTRA_OTHER_NETWORK_INFO

The lookup key for a NetworkInfo object. This is supplied when there is another network that it may be possible to connect to. Retrieve with getParcelableExtra(String).

Constant Value: "otherNetwork"

EXTRA_REASON

String EXTRA_REASON

The lookup key for a string that indicates why an attempt to connect to a network failed. The string has no particular structure. It is intended to be used in notifications presented to users. Retrieve it with getStringExtra(String).

Constant Value: "reason"

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)

TYPE_BLUETOOTH

int TYPE_BLUETOOTH

The Bluetooth data connection. When active, all data traffic will use this network type's interface by default (it has a default route).

Constant Value: 7 (0x00000007)

TYPE_DUMMY

int TYPE_DUMMY

Dummy data connection. This should not be used on shipping devices.

Constant Value: 8 (0x00000008)

TYPE_ETHERNET

int TYPE_ETHERNET

The Ethernet data connection. When active, all data traffic will use this network type's interface by default (it has a default route).

Constant Value: 9 (0x00000009)

TYPE_MOBILE

int TYPE_MOBILE

The Mobile data connection. When active, all data traffic will use this network type's interface by default (it has a default route)

Constant Value: 0 (0x00000000)

TYPE_MOBILE_DUN

int TYPE_MOBILE_DUN

A DUN-specific Mobile data connection. This network type may use the same network interface as TYPE_MOBILE or it may use a different one. This is sometimes by the system when setting up an upstream connection for tethering so that the carrier is aware of DUN traffic.

Constant Value: 4 (0x00000004)

TYPE_MOBILE_HIPRI

int TYPE_MOBILE_HIPRI

This constant was deprecated in API level 23.
Applications should instead use requestNetwork(NetworkRequest, NetworkCallback) to request a network that uses the TRANSPORT_CELLULAR transport.

A High Priority Mobile data connection. This network type uses the same network interface as TYPE_MOBILE but the routing setup is different.

Constant Value: 5 (0x00000005)

TYPE_MOBILE_MMS

int TYPE_MOBILE_MMS

This constant was deprecated in API level 23.
Applications should instead use requestNetwork(NetworkRequest, NetworkCallback) to request a network that provides the NET_CAPABILITY_MMS capability.

An MMS-specific Mobile data connection. This network type may use the same network interface as TYPE_MOBILE or it may use a different one. This is used by applications needing to talk to the carrier's Multimedia Messaging Service servers.

Constant Value: 2 (0x00000002)

TYPE_MOBILE_SUPL

int TYPE_MOBILE_SUPL

This constant was deprecated in API level 23.
Applications should instead use requestNetwork(NetworkRequest, NetworkCallback) to request a network that provides the NET_CAPABILITY_SUPL capability.

A SUPL-specific Mobile data connection. This network type may use the same network interface as TYPE_MOBILE or it may use a different one. This is used by applications needing to talk to the carrier's Secure User Plane Location servers for help locating the device.

Constant Value: 3 (0x00000003)

TYPE_VPN

int TYPE_VPN

A virtual network using one or more native bearers. It may or may not be providing security services.

Constant Value: 17 (0x00000011)

TYPE_WIFI

int TYPE_WIFI

The WIFI data connection. When active, all data traffic will use this network type's interface by default (it has a default route).

Constant Value: 1 (0x00000001)

TYPE_WIMAX

int TYPE_WIMAX

The WiMAX data connection. When active, all data traffic will use this network type's interface by default (it has a default route).

Constant Value: 6 (0x00000006)

addDefaultNetworkActiveListener

void addDefaultNetworkActiveListener (ConnectivityManager.OnNetworkActiveListener l)

Start listening to reports when the system's default data network is active, meaning it is a good time to perform network traffic. Use isDefaultNetworkActive() to determine the current state of the system's default network after registering the listener.

If the process default network has been set with bindProcessToNetwork(Network) this function will not reflect the process's default, but the system default.

bindProcessToNetwork

boolean bindProcessToNetwork (Network network)

Binds the current process to network. All Sockets created in the future (and not explicitly bound via a bound SocketFactory from Network.getSocketFactory()) will be bound to network. All host name resolutions will be limited to network as well. Note that if network ever disconnects, all Sockets created in this way will cease to work and all host name resolutions will fail. This is by design so an application doesn't accidentally use Sockets it thinks are still bound to a particular Network. To clear binding pass null for network. Using individually bound Sockets created by Network.getSocketFactory().createSocket() and performing network-specific host name resolutions via Network.getAllByName is preferred to calling bindProcessToNetwork.

getActiveNetwork

Network getActiveNetwork ()

Returns a Network object corresponding to the currently active default data network. In the event that the current active default data network disconnects, the returned Network object will no longer be usable. This will return null when there is no default network.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

getActiveNetworkInfo

NetworkInfo getActiveNetworkInfo ()

Returns details about the currently active default data network. When connected, this network is the default route for outgoing connections. You should always check isConnected() before initiating network traffic. This may return null when there is no default network.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

getAllNetworkInfo

NetworkInfo[] getAllNetworkInfo ()

This method was deprecated in API level 23.
This method does not support multiple connected networks of the same type. Use getAllNetworks() and getNetworkInfo(android.net.Network) instead.

Returns connection status information about all network types supported by the device.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

getAllNetworks

Network[] getAllNetworks ()

Returns an array of all Network currently tracked by the framework.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

getBackgroundDataSetting

boolean getBackgroundDataSetting ()

This method was deprecated in API level 14.
As of ICE_CREAM_SANDWICH, availability of background data depends on several combined factors, and this method will always return true. Instead, when background data is unavailable, getActiveNetworkInfo() will now appear disconnected.

Returns the value of the setting for background data usage. If false, applications should not use the network if the application is not in the foreground. Developers should respect this setting, and check the value of this before performing any background data operations.

All applications that have background services that use the network should listen to ACTION_BACKGROUND_DATA_SETTING_CHANGED.

getBoundNetworkForProcess

Network getBoundNetworkForProcess ()

Returns the Network currently bound to this process via bindProcessToNetwork(Network), or null if no Network is explicitly bound.

getDefaultProxy

ProxyInfo getDefaultProxy ()

Get the current default HTTP proxy settings. If a global proxy is set it will be returned, otherwise if this process is bound to a Network using bindProcessToNetwork(Network) then that Network's proxy is returned, otherwise the default network's proxy is returned.

getLinkProperties

LinkProperties getLinkProperties (Network network)

Get the LinkProperties for the given Network. This will return null if the network is unknown.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

getNetworkCapabilities

NetworkCapabilities getNetworkCapabilities (Network network)

Get the NetworkCapabilities for the given Network. This will return null if the network is unknown.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

getNetworkInfo

NetworkInfo getNetworkInfo (int networkType)

This method was deprecated in API level 23.
This method does not support multiple connected networks of the same type. Use getAllNetworks() and getNetworkInfo(android.net.Network) instead.

Returns connection status information about a particular network type.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

getNetworkInfo

NetworkInfo getNetworkInfo (Network network)

Returns connection status information about a particular Network.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

getNetworkPreference

int getNetworkPreference ()

This method was deprecated in API level 21.
Functionality has been removed as it no longer makes sense, with many more than two networks - we'd need an array to express preference. Instead we use dynamic network properties of the networks to describe their precedence.

Retrieves the current preferred network type.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

getProcessDefaultNetwork

Network getProcessDefaultNetwork ()

This method was deprecated in API level 23.
Using this function can lead to other functions throwing IllegalStateException. Use getBoundNetworkForProcess() instead. getBoundNetworkForProcess is a direct replacement.

Returns the Network currently bound to this process via bindProcessToNetwork(Network), or null if no Network is explicitly bound.

getRestrictBackgroundStatus

int getRestrictBackgroundStatus ()

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

isActiveNetworkMetered

boolean isActiveNetworkMetered ()

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 ACCESS_NETWORK_STATE.

isDefaultNetworkActive

boolean isDefaultNetworkActive ()

Return whether the data network is currently active. An active network means that it is currently in a high power state for performing data transmission. On some types of networks, it may be expensive to move and stay in such a state, so it is more power efficient to batch network traffic together when the radio is already in this state. This method tells you whether right now is currently a good time to initiate network traffic, as the network is already active.

isNetworkTypeValid

boolean isNetworkTypeValid (int networkType)

This method was deprecated in API level 23.
All APIs accepting a network type are deprecated. There should be no need to validate a network type.

Tests if a given integer represents a valid network type.

registerDefaultNetworkCallback

void registerDefaultNetworkCallback (ConnectivityManager.NetworkCallback networkCallback)

Registers to receive notifications about changes in the system default network. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(NetworkCallback) is called.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

registerNetworkCallback

void registerNetworkCallback (NetworkRequest request, 
                ConnectivityManager.NetworkCallback networkCallback)

Registers to receive notifications about all networks which satisfy the given NetworkRequest. The callbacks will continue to be called until either the application exits or link #unregisterNetworkCallback(NetworkCallback)} is called.

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

registerNetworkCallback

void registerNetworkCallback (NetworkRequest request, 
                PendingIntent operation)

Registers a PendingIntent to be sent when a network is available which satisfies the given NetworkRequest. This function behaves identically to the version that takes a NetworkCallback, but instead of ConnectivityManager.NetworkCallback a PendingIntent is used. This means the request may outlive the calling application and get called back when a suitable network is found.

The operation is an Intent broadcast that goes to a broadcast receiver that you registered with registerReceiver(BroadcastReceiver, IntentFilter) or through the <receiver> tag in an AndroidManifest.xml file

The operation Intent is delivered with two extras, a Network typed extra called EXTRA_NETWORK and a NetworkRequest typed extra called EXTRA_NETWORK_REQUEST containing the original requests parameters.

If there is already a request for this Intent registered (with the equality of two Intents defined by filterEquals(Intent)), then it will be removed and replaced by this one, effectively releasing the previous NetworkRequest.

The request may be released normally by calling unregisterNetworkCallback(android.app.PendingIntent).

This method requires the caller to hold the permission ACCESS_NETWORK_STATE.

releaseNetworkRequest

void releaseNetworkRequest (PendingIntent operation)

Removes a request made via requestNetwork(NetworkRequest, android.app.PendingIntent)

This method has the same behavior as unregisterNetworkCallback(android.app.PendingIntent) with respect to releasing network resources and disconnecting.

removeDefaultNetworkActiveListener

void removeDefaultNetworkActiveListener (ConnectivityManager.OnNetworkActiveListener l)

Remove network active listener previously registered with addDefaultNetworkActiveListener(ConnectivityManager.OnNetworkActiveListener).

reportBadNetwork

void reportBadNetwork (Network network)

This method was deprecated in API level 23.
Use reportNetworkConnectivity(Network, boolean) which allows reporting both working and non-working connectivity.

Report a problem network to the framework. This provides a hint to the system that there might be connectivity problems on this network and may cause the framework to re-evaluate network connectivity and/or switch to another network.

reportNetworkConnectivity

void reportNetworkConnectivity (Network network, 
                boolean hasConnectivity)

Report to the framework whether a network has working connectivity. This provides a hint to the system that a particular network is providing working connectivity or not. In response the framework may re-evaluate the network's connectivity and might take further action thereafter.

requestBandwidthUpdate

boolean requestBandwidthUpdate (Network network)

Requests bandwidth update for a given Network and returns whether the update request is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying network connection for updated bandwidth information. The caller will be notified via ConnectivityManager.NetworkCallback if there is an update. Notice that this method assumes that the caller has previously called registerNetworkCallback(NetworkRequest, NetworkCallback) to listen for network changes.

requestNetwork

void requestNetwork (NetworkRequest request, 
                ConnectivityManager.NetworkCallback networkCallback)

Request a network to satisfy a set of NetworkCapabilities. This NetworkRequest will live until released via unregisterNetworkCallback(NetworkCallback) or the calling application exits. Status of the request can be followed by listening to the various callbacks described in ConnectivityManager.NetworkCallback. The Network can be used to direct traffic to the network.

It is presently unsupported to request a network with mutable NetworkCapabilities such as NET_CAPABILITY_VALIDATED or NET_CAPABILITY_CAPTIVE_PORTAL as these NetworkCapabilities represent states that a particular network may never attain, and whether a network will attain these states is unknown prior to bringing up the network so the framework does not know how to go about satisfing a request with these capabilities.

This method requires the caller to hold either the CHANGE_NETWORK_STATE permission or the ability to modify system settings as determined by canWrite(Context).

requestNetwork

void requestNetwork (NetworkRequest request, 
                PendingIntent operation)

Request a network to satisfy a set of NetworkCapabilities. This function behaves identically to the version that takes a NetworkCallback, but instead of ConnectivityManager.NetworkCallback a PendingIntent is used. This means the request may outlive the calling application and get called back when a suitable network is found.

The operation is an Intent broadcast that goes to a broadcast receiver that you registered with registerReceiver(BroadcastReceiver, IntentFilter) or through the <receiver> tag in an AndroidManifest.xml file

The operation Intent is delivered with two extras, a Network typed extra called EXTRA_NETWORK and a NetworkRequest typed extra called EXTRA_NETWORK_REQUEST containing the original requests parameters. It is important to create a new, ConnectivityManager.NetworkCallback based request before completing the processing of the Intent to reserve the network or it will be released shortly after the Intent is processed.

If there is already a request for this Intent registered (with the equality of two Intents defined by filterEquals(Intent)), then it will be removed and replaced by this one, effectively releasing the previous NetworkRequest.

The request may be released normally by calling releaseNetworkRequest(android.app.PendingIntent).

It is presently unsupported to request a network with either NET_CAPABILITY_VALIDATED or NET_CAPABILITY_CAPTIVE_PORTAL as these NetworkCapabilities represent states that a particular network may never attain, and whether a network will attain these states is unknown prior to bringing up the network so the framework does not know how to go about satisfing a request with these capabilities.

This method requires the caller to hold either the CHANGE_NETWORK_STATE permission or the ability to modify system settings as determined by canWrite(Context).

requestRouteToHost

boolean requestRouteToHost (int networkType, 
                int hostAddress)

This method was deprecated in API level 21.
Deprecated in favor of the requestNetwork(NetworkRequest, NetworkCallback), bindProcessToNetwork(Network) and getSocketFactory() API. In M, and above, this method is unsupported and will throw UnsupportedOperationException if called.

Ensure that a network route exists to deliver traffic to the specified host via the specified network interface. An attempt to add a route that already exists is ignored, but treated as successful.

This method requires the caller to hold either the CHANGE_NETWORK_STATE permission or the ability to modify system settings as determined by canWrite(Context).

setNetworkPreference

void setNetworkPreference (int preference)

This method was deprecated in API level 21.
Functionality has been removed as it no longer makes sense, with many more than two networks - we'd need an array to express preference. Instead we use dynamic network properties of the networks to describe their precedence.

Specifies the preferred network type. When the device has more than one type available the preferred network type will be used.

setProcessDefaultNetwork

boolean setProcessDefaultNetwork (Network network)

This method was deprecated in API level 23.
This function can throw IllegalStateException. Use bindProcessToNetwork(Network) instead. bindProcessToNetwork is a direct replacement.

Binds the current process to network. All Sockets created in the future (and not explicitly bound via a bound SocketFactory from Network.getSocketFactory()) will be bound to network. All host name resolutions will be limited to network as well. Note that if network ever disconnects, all Sockets created in this way will cease to work and all host name resolutions will fail. This is by design so an application doesn't accidentally use Sockets it thinks are still bound to a particular Network. To clear binding pass null for network. Using individually bound Sockets created by Network.getSocketFactory().createSocket() and performing network-specific host name resolutions via Network.getAllByName is preferred to calling setProcessDefaultNetwork.

startUsingNetworkFeature

int startUsingNetworkFeature (int networkType, 
                String feature)

This method was deprecated in API level 21.
Deprecated in favor of the cleaner requestNetwork(NetworkRequest, NetworkCallback) API. In M, and above, this method is unsupported and will throw UnsupportedOperationException if called.

Tells the underlying networking system that the caller wants to begin using the named feature. The interpretation of feature is completely up to each networking implementation.

This method requires the caller to hold either the CHANGE_NETWORK_STATE permission or the ability to modify system settings as determined by canWrite(Context).

stopUsingNetworkFeature

int stopUsingNetworkFeature (int networkType, 
                String feature)

This method was deprecated in API level 21.
Deprecated in favor of the cleaner unregisterNetworkCallback(NetworkCallback) API. In M, and above, this method is unsupported and will throw UnsupportedOperationException if called.

Tells the underlying networking system that the caller is finished using the named feature. The interpretation of feature is completely up to each networking implementation.

This method requires the caller to hold either the CHANGE_NETWORK_STATE permission or the ability to modify system settings as determined by canWrite(Context).

unregisterNetworkCallback

void unregisterNetworkCallback (ConnectivityManager.NetworkCallback networkCallback)

Unregisters callbacks about and possibly releases networks originating from requestNetwork(NetworkRequest, NetworkCallback) and registerNetworkCallback(NetworkRequest, NetworkCallback) calls. If the given NetworkCallback had previously been used with #requestNetwork, any networks that had been connected to only to satisfy that request will be disconnected.

unregisterNetworkCallback

void unregisterNetworkCallback (PendingIntent operation)

Unregisters a callback previously registered via registerNetworkCallback(NetworkRequest, android.app.PendingIntent).