com.mapbox.android.core.connectivity

Class ConnectivityReceiver

java.lang.Object

android.content.BroadcastReceiver

com.mapbox.android.core.connectivity.ConnectivityReceiver

public class ConnectivityReceiver
extends android.content.BroadcastReceiver

ConnectivityReceiver is a BroadcastReceiver that helps you keep track of the connectivity status. When used statically (getSystemConnectivity) the ConnectivityReceiver will always return the connectivity status as reported by the Android system.

When instantiating ConnectivityReceiver, you have the option to set a connectedFlag. You can override the connectivity value reported by the system by setting this flag to true or false. If left in its default value (null), ConnectivityReceiver will report the system value.

ConnectivityReceiver also lets you subscribe to connecitivity changes using a ConnectivityListener.

Nested Class Summary

Nested classes/interfaces inherited from class android.content.BroadcastReceiver

android.content.BroadcastReceiver.PendingResult

Constructor Summary

Constructors

Constructor and Description
ConnectivityReceiver(android.content.Context context) ConnectivityReceiver constructor

Method Summary

Modifier and Type	Method and Description
void	addConnectivityListener(com.mapbox.android.core.connectivity.ConnectivityListener listener)
java.lang.Boolean	getConnectedFlag() Get the connectedFlag value
boolean	isConnected() Get the connectivity state.
static boolean	isConnected(android.content.Context context) Get the connectivity state as reported by the Android system
void	onReceive(android.content.Context context, android.content.Intent intent)
boolean	removeConnectivityListener(com.mapbox.android.core.connectivity.ConnectivityListener listener)
void	removeConnectivityUpdates()
void	requestConnectivityUpdates()
void	setConnectedFlag(java.lang.Boolean connectedFlag) Set the connectedFlag value

Methods inherited from class android.content.BroadcastReceiver

abortBroadcast, clearAbortBroadcast, getAbortBroadcast, getDebugUnregister, getResultCode, getResultData, getResultExtras, goAsync, isInitialStickyBroadcast, isOrderedBroadcast, peekService, setDebugUnregister, setOrderedHint, setResult, setResultCode, setResultData, setResultExtras

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectivityReceiver

public ConnectivityReceiver(android.content.Context context)

ConnectivityReceiver constructor

Parameters:

context - Android context. To avoid memory leaks, you might want to pass the application context and make sure you call removeConnectivityUpdates() when you don't need further updates (https://github.com/mapbox/mapbox-gl-native/issues/7176)

Method Detail

isConnected

public static boolean isConnected(android.content.Context context)

Get the connectivity state as reported by the Android system

Parameters:

context - Android context

Returns:

the connectivity state as reported by the Android system

isConnected

public boolean isConnected()

Get the connectivity state. This can be overriden using the connectedFlag.

Returns:

the connectivity state

getConnectedFlag

public java.lang.Boolean getConnectedFlag()

Get the connectedFlag value

Returns:

the connectedFlag value, true/false if the connectivity state has ben overriden, null otherwise.

setConnectedFlag

public void setConnectedFlag(java.lang.Boolean connectedFlag)

Set the connectedFlag value

Parameters:

connectedFlag - Set it to true/false to override the connectivity state

addConnectivityListener

public void addConnectivityListener(com.mapbox.android.core.connectivity.ConnectivityListener listener)

removeConnectivityListener

public boolean removeConnectivityListener(com.mapbox.android.core.connectivity.ConnectivityListener listener)

requestConnectivityUpdates

@UiThread
public void requestConnectivityUpdates()

removeConnectivityUpdates

@UiThread
public void removeConnectivityUpdates()

onReceive

public void onReceive(android.content.Context context,
                      android.content.Intent intent)

Specified by:

onReceive in class android.content.BroadcastReceiver