ConnectivityManager

ACTION_BACKGROUND_DATA_SETTING_CHANGED

static val ACTION_BACKGROUND_DATA_SETTING_CHANGED: String

Deprecated: As of VERSION_CODES#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.

Value: "android.net.conn.BACKGROUND_DATA_SETTING_CHANGED"

ACTION_CAPTIVE_PORTAL_SIGN_IN

static val ACTION_CAPTIVE_PORTAL_SIGN_IN: String

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 CaptivePortal#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 CaptivePortal#ignoreNetwork.

Value: "android.net.conn.CAPTIVE_PORTAL"

ACTION_RESTRICT_BACKGROUND_CHANGED

static val ACTION_RESTRICT_BACKGROUND_CHANGED: String

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.

Value: "android.net.conn.RESTRICT_BACKGROUND_CHANGED"

CONNECTIVITY_ACTION

static val CONNECTIVITY_ACTION: String

Deprecated: apps should use the more versatile #requestNetwork, #registerNetworkCallback or #registerDefaultNetworkCallback functions instead for faster and more detailed updates about the network changes they care about.

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.

Value: "android.net.conn.CONNECTIVITY_CHANGE"

DEFAULT_NETWORK_PREFERENCE

static val DEFAULT_NETWORK_PREFERENCE: Int

Deprecated: 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.

Value: 1

EXTRA_CAPTIVE_PORTAL

static val EXTRA_CAPTIVE_PORTAL: String

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 android.content.Intent#getParcelableExtra(String).

Value: "android.net.extra.CAPTIVE_PORTAL"

EXTRA_CAPTIVE_PORTAL_URL

static val EXTRA_CAPTIVE_PORTAL_URL: String

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

Value: "android.net.extra.CAPTIVE_PORTAL_URL"

EXTRA_EXTRA_INFO

static val EXTRA_EXTRA_INFO: String

Deprecated: See NetworkInfo#getExtraInfo().

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 android.content.Intent#getStringExtra(String).

Value: "extraInfo"

EXTRA_IS_FAILOVER

static val EXTRA_IS_FAILOVER: String

Deprecated: See NetworkInfo.

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 android.content.Intent#getBooleanExtra(String,boolean).

Value: "isFailover"

EXTRA_NETWORK

static val EXTRA_NETWORK: String

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

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

Value: "android.net.extra.NETWORK"

EXTRA_NETWORK_INFO

static val EXTRA_NETWORK_INFO: String

Deprecated: The NetworkInfo object is deprecated, as many of its properties can't accurately represent modern network characteristics. Please obtain information about networks from the NetworkCapabilities or LinkProperties objects instead.

The lookup key for a NetworkInfo object. Retrieve with android.content.Intent#getParcelableExtra(String).

Value: "networkInfo"

EXTRA_NETWORK_REQUEST

static val EXTRA_NETWORK_REQUEST: String

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

Value: "android.net.extra.NETWORK_REQUEST"

EXTRA_NETWORK_TYPE

static val EXTRA_NETWORK_TYPE: String

Deprecated: The network type is not rich enough to represent the characteristics of modern networks. Please use NetworkCapabilities instead, in particular the transports.

Network type which triggered a CONNECTIVITY_ACTION broadcast.

Value: "networkType"

EXTRA_NO_CONNECTIVITY

static val EXTRA_NO_CONNECTIVITY: String

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 android.content.Intent#getBooleanExtra(String,boolean).

Value: "noConnectivity"

EXTRA_OTHER_NETWORK_INFO

static val EXTRA_OTHER_NETWORK_INFO: String

Deprecated: See NetworkInfo.

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 android.content.Intent#getParcelableExtra(String).

Value: "otherNetwork"

EXTRA_REASON

static val EXTRA_REASON: String

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 android.content.Intent#getStringExtra(String).

Value: "reason"

MULTIPATH_PREFERENCE_HANDOVER

static val MULTIPATH_PREFERENCE_HANDOVER: Int

It is acceptable to briefly use multipath data to provide seamless connectivity for time-sensitive user-facing operations when the system default network is temporarily unresponsive. The amount of data should be limited (less than one megabyte for every call to this method), and the operation should be infrequent to ensure that data usage is limited. An example of such an operation might be a time-sensitive foreground activity, such as a voice command, that the user is performing while walking out of range of a Wi-Fi network.

Value: 1

MULTIPATH_PREFERENCE_PERFORMANCE

static val MULTIPATH_PREFERENCE_PERFORMANCE: Int

It is acceptable to use metered data to improve network latency and performance.

Value: 4

MULTIPATH_PREFERENCE_RELIABILITY

static val MULTIPATH_PREFERENCE_RELIABILITY: Int

It is acceptable to use small amounts of multipath data on an ongoing basis to provide a backup channel for traffic that is primarily going over another network. An example might be maintaining backup connections to peers or servers for the purpose of fast fallback if the default network is temporarily unresponsive or disconnects. The traffic on backup paths should be negligible compared to the traffic on the main path.

Value: 2

RESTRICT_BACKGROUND_STATUS_DISABLED

static val RESTRICT_BACKGROUND_STATUS_DISABLED: Int

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

Value: 1

RESTRICT_BACKGROUND_STATUS_ENABLED

static val RESTRICT_BACKGROUND_STATUS_ENABLED: Int

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.

Value: 3

RESTRICT_BACKGROUND_STATUS_WHITELISTED

static val RESTRICT_BACKGROUND_STATUS_WHITELISTED: Int

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.

Value: 2

TYPE_BLUETOOTH

static val TYPE_BLUETOOTH: Int

Deprecated: Applications should instead use NetworkCapabilities#hasTransport or requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

A Bluetooth data connection.

Value: 7

TYPE_DUMMY

static val TYPE_DUMMY: Int

Deprecated: This is not used any more.

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

Value: 8

TYPE_ETHERNET

static val TYPE_ETHERNET: Int

Deprecated: Applications should instead use NetworkCapabilities#hasTransport or requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

An Ethernet data connection.

Value: 9

TYPE_MOBILE

static val TYPE_MOBILE: Int

Deprecated: Applications should instead use NetworkCapabilities#hasTransport or requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

A Mobile data connection. Devices may support more than one.

Value: 0

TYPE_MOBILE_DUN

static val TYPE_MOBILE_DUN: Int

Deprecated: Applications should instead use NetworkCapabilities#hasCapability or requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to request a network that provides the NetworkCapabilities#NET_CAPABILITY_DUN capability.

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.

Value: 4

TYPE_MOBILE_HIPRI

static val TYPE_MOBILE_HIPRI: Int

Deprecated: Applications should instead use NetworkCapabilities#hasTransport or requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

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

Value: 5

TYPE_MOBILE_MMS

static val TYPE_MOBILE_MMS: Int

Deprecated: Applications should instead use NetworkCapabilities#hasCapability or requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to request a network that provides the NetworkCapabilities#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.

Value: 2

TYPE_MOBILE_SUPL

static val TYPE_MOBILE_SUPL: Int

Deprecated: Applications should instead use NetworkCapabilities#hasCapability or requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to request a network that provides the NetworkCapabilities#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.

Value: 3

TYPE_VPN

static val TYPE_VPN: Int

Deprecated: Applications should use NetworkCapabilities#TRANSPORT_VPN instead.

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

Value: 17

TYPE_WIFI

static val TYPE_WIFI: Int

Deprecated: Applications should instead use NetworkCapabilities#hasTransport or requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

A WIFI data connection. Devices may support more than one.

Value: 1

TYPE_WIMAX

static val TYPE_WIMAX: Int

Deprecated: Applications should instead use NetworkCapabilities#hasTransport or requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to request an appropriate network. See NetworkCapabilities for supported transports.

A WiMAX data connection.

Value: 6

addDefaultNetworkActiveListener

open fun addDefaultNetworkActiveListener(l: ConnectivityManager.OnNetworkActiveListener!): Unit

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 ConnectivityManager#bindProcessToNetwork this function will not reflect the process's default, but the system default.

bindProcessToNetwork

open fun bindProcessToNetwork(network: Network?): Boolean

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.

createSocketKeepalive

open fun createSocketKeepalive(
    network: Network, 
    socket: IpSecManager.UdpEncapsulationSocket, 
    source: InetAddress, 
    destination: InetAddress, 
    executor: Executor, 
    callback: SocketKeepalive.Callback
): SocketKeepalive

Request that keepalives be started on a IPsec NAT-T socket.

getActiveNetwork

open fun getActiveNetwork(): Network?

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, or when the default network is blocked.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getActiveNetworkInfo

open fun getActiveNetworkInfo(): NetworkInfo?

Deprecated: See NetworkInfo.

Returns details about the currently active default data network. When connected, this network is the default route for outgoing connections. You should always check NetworkInfo#isConnected() before initiating network traffic. This may return null when there is no default network. Note that if the default network is a VPN, this method will return the NetworkInfo for one of its underlying networks instead, or null if the VPN agent did not specify any. Apps interested in learning about VPNs should use getNetworkInfo(android.net.Network) instead.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getAllNetworkInfo

open fun getAllNetworkInfo(): Array<NetworkInfo!>

Deprecated: 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.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getAllNetworks

open fun getAllNetworks(): Array<Network!>

Deprecated: This method does not provide any notification of network state changes, forcing apps to call it repeatedly. This is inefficient and prone to race conditions. Apps should use methods such as registerNetworkCallback(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) instead. Apps that desire to obtain information about networks that do not apply to them can use NetworkRequest.Builder#setIncludeOtherUidNetworks.

Returns an array of all Network currently tracked by the framework.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getBackgroundDataSetting

open fun getBackgroundDataSetting(): Boolean

Deprecated: As of VERSION_CODES#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

open fun getBoundNetworkForProcess(): Network?

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

getConnectionOwnerUid

open fun getConnectionOwnerUid(
    protocol: Int, 
    local: InetSocketAddress, 
    remote: InetSocketAddress
): Int

Returns the uid of the owner of a network connection.

getDefaultProxy

open fun getDefaultProxy(): ProxyInfo?

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 then that Network's proxy is returned, otherwise the default network's proxy is returned.

getLinkProperties

open fun getLinkProperties(network: Network?): LinkProperties?

Get the LinkProperties for the given Network. This will return null if the network is unknown.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getMultipathPreference

open fun getMultipathPreference(network: Network?): Int

Provides a hint to the calling application on whether it is desirable to use the multinetwork APIs (e.g., android.net.Network#openConnection, android.net.Network#bindSocket, etc.) for multipath data transfer on this network when it is not the system default network. Applications desiring to use multipath network protocols should call this method before each such operation.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getNetworkCapabilities

open fun getNetworkCapabilities(network: Network?): NetworkCapabilities?

Get the NetworkCapabilities for the given Network, or null. This will remove any location sensitive data in the returned NetworkCapabilities. Some TransportInfo instances like android.net.wifi.WifiInfo contain location sensitive information. To retrieve this location sensitive information (subject to the caller's location permissions), use a NetworkCallback with the NetworkCallback#FLAG_INCLUDE_LOCATION_INFO flag instead. This method returns null if the network is unknown or if the |network| argument is null.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getNetworkInfo

open fun getNetworkInfo(networkType: Int): NetworkInfo?

Deprecated: 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.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getNetworkInfo

open fun getNetworkInfo(network: Network?): NetworkInfo?

Deprecated: See NetworkInfo.

Returns connection status information about a particular Network.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getNetworkPreference

open fun getNetworkPreference(): Int

Deprecated: 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.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

getNetworkWatchlistConfigHash

open fun getNetworkWatchlistConfigHash(): ByteArray?

The network watchlist is a list of domains and IP addresses that are associated with potentially harmful apps. This method returns the SHA-256 of the watchlist config file currently used by the system for validation purposes.

getProcessDefaultNetwork

open static fun getProcessDefaultNetwork(): Network?

Deprecated: 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, or null if no Network is explicitly bound.

getRestrictBackgroundStatus

open fun getRestrictBackgroundStatus(): Int

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

isActiveNetworkMetered

open fun isActiveNetworkMetered(): Boolean

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.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

isDefaultNetworkActive

open fun isDefaultNetworkActive(): Boolean

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

open static fun isNetworkTypeValid(networkType: Int): Boolean

Deprecated: 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.

registerBestMatchingNetworkCallback

open fun registerBestMatchingNetworkCallback(
    request: NetworkRequest, 
    networkCallback: ConnectivityManager.NetworkCallback, 
    handler: Handler
): Unit

Registers to receive notifications about the best matching network which satisfy the given NetworkRequest. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with #registerNetworkCallback and its variants and #requestNetwork as well as ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).

registerDefaultNetworkCallback

open fun registerDefaultNetworkCallback(networkCallback: ConnectivityManager.NetworkCallback): Unit

Registers to receive notifications about changes in the application's default network. This may be a physical network or a virtual network, such as a VPN that applies to the application. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of #requestNetwork as well as ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

registerDefaultNetworkCallback

open fun registerDefaultNetworkCallback(
    networkCallback: ConnectivityManager.NetworkCallback, 
    handler: Handler
): Unit

Registers to receive notifications about changes in the application's default network. This may be a physical network or a virtual network, such as a VPN that applies to the application. The callbacks will continue to be called until either the application exits or unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of #requestNetwork as well as ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

registerNetworkCallback

open fun registerNetworkCallback(
    request: NetworkRequest, 
    networkCallback: ConnectivityManager.NetworkCallback
): Unit

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 unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of #requestNetwork as well as ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

registerNetworkCallback

open fun registerNetworkCallback(
    request: NetworkRequest, 
    networkCallback: ConnectivityManager.NetworkCallback, 
    handler: Handler
): Unit

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 unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) is called.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of #requestNetwork as well as ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

registerNetworkCallback

open fun registerNetworkCallback(
    request: NetworkRequest, 
    operation: PendingIntent
): Unit

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 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 android.content.Context#registerReceiver 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 Intent#filterEquals), 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).

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of #requestNetwork as well as ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.app.PendingIntent) or releaseNetworkRequest(android.app.PendingIntent).
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

releaseNetworkRequest

open fun releaseNetworkRequest(operation: PendingIntent): Unit

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

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

removeDefaultNetworkActiveListener

open fun removeDefaultNetworkActiveListener(l: ConnectivityManager.OnNetworkActiveListener): Unit

Remove network active listener previously registered with addDefaultNetworkActiveListener.

reportBadNetwork

open fun reportBadNetwork(network: Network?): Unit

Deprecated: Use reportNetworkConnectivity 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

open fun reportNetworkConnectivity(
    network: Network?, 
    hasConnectivity: Boolean
): Unit

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

open fun requestBandwidthUpdate(network: Network): Boolean

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(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) to listen for network changes.

requestNetwork

open fun requestNetwork(
    request: NetworkRequest, 
    networkCallback: ConnectivityManager.NetworkCallback
): Unit

Request a network to satisfy a set of NetworkCapabilities.

This method will attempt to find the best network that matches the passed NetworkRequest, and to bring up one that does if none currently satisfies the criteria. The platform will evaluate which network is the best at its own discretion. Throughput, latency, cost per byte, policy, user preference and other considerations may be factored in the decision of what is considered the best network.

As long as this request is outstanding, the platform will try to maintain the best network matching this request, while always attempting to match the request to a better network if possible. If a better match is found, the platform will switch this request to the now-best network and inform the app of the newly best network by invoking NetworkCallback#onAvailable(Network) on the provided callback. Note that the platform will not try to maintain any other network than the best one currently matching the request: a network not matching any network request may be disconnected at any time.

For example, an application could use this method to obtain a connected cellular network even if the device currently has a data connection over Ethernet. This may cause the cellular radio to consume additional power. Or, an application could inform the system that it wants a network supporting sending MMSes and have the system let it know about the currently best MMS-supporting network through the provided NetworkCallback.

The status of the request can be followed by listening to the various callbacks described in NetworkCallback. The Network object passed to the callback methods can be used to direct traffic to the network (although accessing some networks may be subject to holding specific permissions). Callers will learn about the specific characteristics of the network through NetworkCallback#onCapabilitiesChanged(Network, NetworkCapabilities) and NetworkCallback#onLinkPropertiesChanged(Network, LinkProperties). The methods of the provided NetworkCallback will only be invoked due to changes in the best network matching the request at any given time; therefore when a better network matching the request becomes available, the NetworkCallback#onAvailable(Network) method is called with the new network after which no further updates are given about the previously-best network, unless it becomes the best again at some later time. All callbacks are invoked in order on the same thread, which by default is a thread created by the framework running in the app. See requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback,android.os.Handler) to change where the callbacks are invoked.

ThisNetworkRequest will live until released via unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) or the calling application exits, at which point the system may let go of the network at any time.

A version of this method which takes a timeout is requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback,int), that an app can use to only wait for a limited amount of time for the network to become unavailable.

It is presently unsupported to request a network with mutable NetworkCapabilities such as NetworkCapabilities#NET_CAPABILITY_VALIDATED or NetworkCapabilities#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 satisfying a request with these capabilities.

This method requires the caller to hold either the android.Manifest.permission#CHANGE_NETWORK_STATE permission or the ability to modify system settings as determined by android.provider.Settings.System#canWrite.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of #registerNetworkCallback as well as ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback).

requestNetwork

open fun requestNetwork(
    request: NetworkRequest, 
    networkCallback: ConnectivityManager.NetworkCallback, 
    handler: Handler
): Unit

Request a network to satisfy a set of NetworkCapabilities. This method behaves identically to requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) but runs all the callbacks on the passed Handler.

This method has the same permission requirements as requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback), is subject to the same limitations, and throws the same exceptions in the same conditions.

requestNetwork

open fun requestNetwork(
    request: NetworkRequest, 
    networkCallback: ConnectivityManager.NetworkCallback, 
    timeoutMs: Int
): Unit

Request a network to satisfy a set of NetworkCapabilities, limited by a timeout. This function behaves identically to the non-timed-out version requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback), but if a suitable network is not found within the given time (in milliseconds) the NetworkCallback#onUnavailable() callback is called. The request can still be released normally by calling unregisterNetworkCallback(android.net.ConnectivityManager.NetworkCallback) but does not have to be released if timed-out (it is automatically released). Unregistering a request that timed out is not an error.

Do not use this method to poll for the existence of specific networks (e.g. with a small timeout) - registerNetworkCallback(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) is provided for that purpose. Calling this method will attempt to bring up the requested network.

This method has the same permission requirements as requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback), is subject to the same limitations, and throws the same exceptions in the same conditions.

requestNetwork

open fun requestNetwork(
    request: NetworkRequest, 
    networkCallback: ConnectivityManager.NetworkCallback, 
    handler: Handler, 
    timeoutMs: Int
): Unit

Request a network to satisfy a set of NetworkCapabilities, limited by a timeout. This method behaves identically to requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback,int) but runs all the callbacks on the passed Handler.

This method has the same permission requirements as requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback), is subject to the same limitations, and throws the same exceptions in the same conditions.

requestNetwork

open fun requestNetwork(
    request: NetworkRequest, 
    operation: PendingIntent
): Unit

Request a network to satisfy a set of NetworkCapabilities. This function behaves identically to the version that takes a NetworkCallback, but instead of 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 android.content.Context#registerReceiver 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, 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 Intent#filterEquals), 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 NetworkCapabilities#NET_CAPABILITY_VALIDATED or NetworkCapabilities#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 satisfying a request with these capabilities.

To avoid performance issues due to apps leaking callbacks, the system will limit the number of outstanding requests to 100 per app (identified by their UID), shared with all variants of this method, of #registerNetworkCallback as well as ConnectivityDiagnosticsManager#registerConnectivityDiagnosticsCallback. Requesting a network with this method will count toward this limit. If this limit is exceeded, an exception will be thrown. To avoid hitting this issue and to conserve resources, make sure to unregister the callbacks with unregisterNetworkCallback(android.app.PendingIntent) or releaseNetworkRequest(android.app.PendingIntent).

This method requires the caller to hold either the android.Manifest.permission#CHANGE_NETWORK_STATE permission or the ability to modify system settings as determined by android.provider.Settings.System#canWrite.

setNetworkPreference

open fun setNetworkPreference(preference: Int): Unit

Deprecated: 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

open static fun setProcessDefaultNetwork(network: Network?): Boolean

Deprecated: This function can throw IllegalStateException. Use bindProcessToNetwork 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.

unregisterNetworkCallback

open fun unregisterNetworkCallback(networkCallback: ConnectivityManager.NetworkCallback): Unit

Unregisters a NetworkCallback and possibly releases networks originating from requestNetwork(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) and registerNetworkCallback(android.net.NetworkRequest,android.net.ConnectivityManager.NetworkCallback) calls. If the given NetworkCallback had previously been used with requestNetwork, any networks that the device brought up only to satisfy that request will be disconnected. Notifications that would have triggered that NetworkCallback will immediately stop triggering it as soon as this call returns.

unregisterNetworkCallback

open fun unregisterNetworkCallback(operation: PendingIntent): Unit

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