Package org.robolectric.shadows

Class ShadowConnectivityManager

java.lang.Object

org.robolectric.shadows.ShadowConnectivityManager

@Implements(android.net.ConnectivityManager.class)
public class ShadowConnectivityManager
extends Object

Constructor Summary

Constructors

Constructor	Description
ShadowConnectivityManager()

Method Summary

Modifier and Type	Method	Description
protected void	addDefaultNetworkActiveListener(ConnectivityManager.OnNetworkActiveListener l)
void	addNetwork(Network network, NetworkInfo networkInfo)	Adds new network to the list of all Networks.
protected boolean	bindProcessToNetwork(Network network)
void	clearAllNetworks()	Clears the list of all Networks.
protected Network	getActiveNetwork()
protected NetworkInfo	getActiveNetworkInfo()
protected NetworkInfo[]	getAllNetworkInfo()
protected Network[]	getAllNetworks()
protected boolean	getBackgroundDataSetting()
protected Network	getBoundNetworkForProcess()
protected String	getCaptivePortalServerUrl()	Returns the captive portal URL previously set with setCaptivePortalServerUrl(java.lang.String).
protected LinkProperties	getLinkProperties(Network network)
Set<PendingIntent>	getNetworkCallbackPendingIntents()
Set<ConnectivityManager.NetworkCallback>	getNetworkCallbacks()
protected NetworkCapabilities	getNetworkCapabilities(Network network)	Gets the network capabilities of a given Network.
protected NetworkInfo	getNetworkInfo(int networkType)
protected NetworkInfo	getNetworkInfo(Network network)
protected int	getNetworkPreference()
protected ProxyInfo	getProxyForNetwork(Network network)	Returns a proxy for a given Network.
Map<Network,Boolean>	getReportedNetworkConnectivity()
protected int	getRestrictBackgroundStatus()	Gets the RESTRICT_BACKGROUND_STATUS value.
protected boolean	isActiveNetworkMetered()	Counts ConnectivityManager.TYPE_MOBILE networks as metered.
protected boolean	isDefaultNetworkActive()
protected void	registerBestMatchingNetworkCallback(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback, Handler handler)
protected void	registerDefaultNetworkCallback(ConnectivityManager.NetworkCallback networkCallback)
protected void	registerDefaultNetworkCallback(ConnectivityManager.NetworkCallback networkCallback, Handler handler)
protected void	registerNetworkCallback(NetworkRequest request, PendingIntent pendingIntent)
protected void	registerNetworkCallback(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback)
protected void	registerNetworkCallback(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback, Handler handler)
protected void	removeDefaultNetworkActiveListener(ConnectivityManager.OnNetworkActiveListener l)
void	removeNetwork(Network network)	Removes the network from the list of all Networks.
protected void	reportNetworkConnectivity(Network network, boolean hasConnectivity)
protected void	requestNetwork(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback)
protected void	requestNetwork(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback, int timeoutMs)
protected void	requestNetwork(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback, Handler handler)
protected void	requestNetwork(NetworkRequest request, ConnectivityManager.NetworkCallback networkCallback, Handler handler, int timeoutMs)
static void	reset()
void	setActiveNetworkInfo(NetworkInfo info)
protected void	setAirplaneMode(boolean enable)	Sets the value for enabling/disabling airplane mode
void	setBackgroundDataSetting(boolean b)
void	setCaptivePortalServerUrl(String captivePortalServerUrl)	Sets the captive portal URL, which will be returned in getCaptivePortalServerUrl().
void	setDefaultNetworkActive(boolean isActive)	Sets the active state of the default network.
void	setLinkProperties(Network network, LinkProperties linkProperties)	Sets the LinkProperties for the given Network.
void	setNetworkCallbacksEnabled(boolean enabled)	Sets whether setDefaultNetworkActive(boolean) triggers registered any ConnectivityManager.NetworkCallback.
void	setNetworkCapabilities(Network network, NetworkCapabilities networkCapabilities)	Sets network capability and affects the result of ConnectivityManager.getNetworkCapabilities(Network)
void	setNetworkInfo(int networkType, NetworkInfo networkInfo)
protected void	setNetworkPreference(int preference)
void	setProxyForNetwork(Network network, ProxyInfo proxyInfo)	Sets a proxy for a given Network.
void	setRestrictBackgroundStatus(int status)	Sets the next return value for ConnectivityManager.getRestrictBackgroundStatus().
protected void	unregisterNetworkCallback(PendingIntent pendingIntent)
protected void	unregisterNetworkCallback(ConnectivityManager.NetworkCallback networkCallback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShadowConnectivityManager

public ShadowConnectivityManager()

Method Details

reset

@Resetter
public static void reset()

setNetworkCallbacksEnabled

public void setNetworkCallbacksEnabled(boolean enabled)

Sets whether setDefaultNetworkActive(boolean) triggers registered any ConnectivityManager.NetworkCallback.

getNetworkCallbacks

public Set<ConnectivityManager.NetworkCallback> getNetworkCallbacks()

getNetworkCallbackPendingIntents

public Set<PendingIntent> getNetworkCallbackPendingIntents()

getReportedNetworkConnectivity

public Map<Network,Boolean> getReportedNetworkConnectivity()

Returns:

networks and their connectivity status which was reported with reportNetworkConnectivity(android.net.Network, boolean).

registerNetworkCallback

@Implementation
protected void registerNetworkCallback(NetworkRequest request,
 ConnectivityManager.NetworkCallback networkCallback)

registerNetworkCallback

@Implementation(minSdk=26)
protected void registerNetworkCallback(NetworkRequest request,
 ConnectivityManager.NetworkCallback networkCallback,
 Handler handler)

registerNetworkCallback

@Implementation(minSdk=23)
protected void registerNetworkCallback(NetworkRequest request,
 PendingIntent pendingIntent)

requestNetwork

@Implementation
protected void requestNetwork(NetworkRequest request,
 ConnectivityManager.NetworkCallback networkCallback)

requestNetwork

@Implementation(minSdk=26)
protected void requestNetwork(NetworkRequest request,
 ConnectivityManager.NetworkCallback networkCallback,
 int timeoutMs)

requestNetwork

@Implementation(minSdk=26)
protected void requestNetwork(NetworkRequest request,
 ConnectivityManager.NetworkCallback networkCallback,
 Handler handler)

requestNetwork

@Implementation(minSdk=26)
protected void requestNetwork(NetworkRequest request,
 ConnectivityManager.NetworkCallback networkCallback,
 Handler handler,
 int timeoutMs)

registerDefaultNetworkCallback

@Implementation(minSdk=24)
protected void registerDefaultNetworkCallback(ConnectivityManager.NetworkCallback networkCallback)

registerDefaultNetworkCallback

@Implementation(minSdk=26)
protected void registerDefaultNetworkCallback(ConnectivityManager.NetworkCallback networkCallback,
 Handler handler)

registerBestMatchingNetworkCallback

@Implementation(minSdk=31)
protected void registerBestMatchingNetworkCallback(NetworkRequest request,
 ConnectivityManager.NetworkCallback networkCallback,
 Handler handler)

unregisterNetworkCallback

@Implementation
protected void unregisterNetworkCallback(ConnectivityManager.NetworkCallback networkCallback)

unregisterNetworkCallback

@Implementation(minSdk=23)
protected void unregisterNetworkCallback(PendingIntent pendingIntent)

getActiveNetworkInfo

@Implementation
protected NetworkInfo getActiveNetworkInfo()

getActiveNetwork

@Implementation(minSdk=23)
protected Network getActiveNetwork()

See Also:

• setActiveNetworkInfo(NetworkInfo)
• setNetworkInfo(int, NetworkInfo)

getAllNetworkInfo

@Implementation
protected NetworkInfo[] getAllNetworkInfo()

See Also:

• setActiveNetworkInfo(NetworkInfo)
• setNetworkInfo(int, NetworkInfo)

getNetworkInfo

@Implementation
protected NetworkInfo getNetworkInfo(int networkType)

getNetworkInfo

@Implementation
protected NetworkInfo getNetworkInfo(Network network)

getAllNetworks

@Implementation
protected Network[] getAllNetworks()

getBackgroundDataSetting

@Implementation
protected boolean getBackgroundDataSetting()

setNetworkPreference

@Implementation
protected void setNetworkPreference(int preference)

getNetworkPreference

@Implementation
protected int getNetworkPreference()

isActiveNetworkMetered

@Implementation
protected boolean isActiveNetworkMetered()

Counts ConnectivityManager.TYPE_MOBILE networks as metered. Other types will be considered unmetered.

Returns:

true if the active network is metered, otherwise false.

See Also:

• setActiveNetworkInfo(NetworkInfo)
• setDefaultNetworkActive(boolean)

bindProcessToNetwork

@Implementation(minSdk=23)
protected boolean bindProcessToNetwork(Network network)

getBoundNetworkForProcess

@Implementation(minSdk=23)
protected Network getBoundNetworkForProcess()

setNetworkInfo

public void setNetworkInfo(int networkType,
 NetworkInfo networkInfo)

getCaptivePortalServerUrl

@Implementation(minSdk=24)
protected String getCaptivePortalServerUrl()

Returns the captive portal URL previously set with setCaptivePortalServerUrl(java.lang.String).

setCaptivePortalServerUrl

public void setCaptivePortalServerUrl(String captivePortalServerUrl)

Sets the captive portal URL, which will be returned in getCaptivePortalServerUrl().

Parameters:

captivePortalServerUrl - the url of captive portal.

setBackgroundDataSetting

@HiddenApi
@Implementation
public void setBackgroundDataSetting(boolean b)

setActiveNetworkInfo

public void setActiveNetworkInfo(NetworkInfo info)

addNetwork

public void addNetwork(Network network,
 NetworkInfo networkInfo)

Adds new network to the list of all Networks.

Parameters:

network - The network.

networkInfo - The network info paired with the Network.

removeNetwork

public void removeNetwork(Network network)

Removes the network from the list of all Networks.

Parameters:

network - The network.

clearAllNetworks

public void clearAllNetworks()

Clears the list of all Networks.

setDefaultNetworkActive

public void setDefaultNetworkActive(boolean isActive)

Sets the active state of the default network.

By default this is true and affects the result of ConnectivityManager.isActiveNetworkMetered(), ConnectivityManager.isDefaultNetworkActive(), ConnectivityManager.getActiveNetwork() and ConnectivityManager.getAllNetworkInfo().

Calling this method with true after any listeners have been registered with ConnectivityManager.addDefaultNetworkActiveListener(OnNetworkActiveListener) will result in those listeners being fired.

Calling this method after any ConnectivityManager.NetworkCallback have been registered will result in those callbacks being called unless setNetworkCallbacksEnabled(boolean) has been called with a false value.

Parameters:

isActive - The active state of the default network.

isDefaultNetworkActive

@Implementation
protected boolean isDefaultNetworkActive()

Returns:

true by default, or the value specified via setDefaultNetworkActive(boolean)

See Also:

• setDefaultNetworkActive(boolean)

addDefaultNetworkActiveListener

@Implementation
protected void addDefaultNetworkActiveListener(ConnectivityManager.OnNetworkActiveListener l)

removeDefaultNetworkActiveListener

@Implementation
protected void removeDefaultNetworkActiveListener(ConnectivityManager.OnNetworkActiveListener l)

reportNetworkConnectivity

@Implementation(minSdk=23)
protected void reportNetworkConnectivity(Network network,
 boolean hasConnectivity)

getNetworkCapabilities

@Implementation
protected NetworkCapabilities getNetworkCapabilities(Network network)

Gets the network capabilities of a given Network.

Parameters:

network - The Network object identifying the network in question.

Returns:

The NetworkCapabilities for the network.

See Also:

• setNetworkCapabilities(Network, NetworkCapabilities)

setNetworkCapabilities

public void setNetworkCapabilities(Network network,
 NetworkCapabilities networkCapabilities)

Sets network capability and affects the result of ConnectivityManager.getNetworkCapabilities(Network)

Parameters:

network - The Network object identifying the network in question.

networkCapabilities - The NetworkCapabilities for the network.

setAirplaneMode

@Implementation
protected void setAirplaneMode(boolean enable)

Sets the value for enabling/disabling airplane mode

Parameters:

enable - new status for airplane mode

getLinkProperties

@Implementation
protected LinkProperties getLinkProperties(Network network)

See Also:

• setLinkProperties(Network, LinkProperties)

setLinkProperties

public void setLinkProperties(Network network,
 LinkProperties linkProperties)

Sets the LinkProperties for the given Network.

A LinkProperties can be constructed by org.robolectric.util.ReflectionHelpers.callConstructor in tests.

getRestrictBackgroundStatus

@Implementation(minSdk=24)
protected int getRestrictBackgroundStatus()

Gets the RESTRICT_BACKGROUND_STATUS value. Default value is 1 (RESTRICT_BACKGROUND_STATUS_DISABLED).

setRestrictBackgroundStatus

public void setRestrictBackgroundStatus(int status)

Sets the next return value for ConnectivityManager.getRestrictBackgroundStatus().

setProxyForNetwork

public void setProxyForNetwork(Network network,
 ProxyInfo proxyInfo)

Sets a proxy for a given Network.

Parameters:

network - The network.

proxyInfo - The proxy info.

getProxyForNetwork

@Implementation(minSdk=23)
protected ProxyInfo getProxyForNetwork(Network network)

Returns a proxy for a given Network.

In order ConnectivityManager.getDefaultProxy() to work the default network should be set using ConnectivityManager.bindProcessToNetwork(Network).