com.mapbox.mapboxsdk.net

Class ConnectivityReceiver

java.lang.Object

android.content.BroadcastReceiver

com.mapbox.mapboxsdk.net.ConnectivityReceiver

public class ConnectivityReceiver
extends android.content.BroadcastReceiver

Interface definition for a callback to be invoked when connectivity changes. Not public api.

Nested Class Summary

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

android.content.BroadcastReceiver.PendingResult

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the connectivity receiver.
void	addListener(ConnectivityListener listener) Add a listener to be notified
void	deactivate() Deactivates the connectivity receiver.
static ConnectivityReceiver	instance(android.content.Context context) Get a single instance of ConnectivityReceiver.
boolean	isConnected() Get current connectivity state
void	onReceive(android.content.Context context, android.content.Intent intent)
void	removeListener(ConnectivityListener listener) Remove a listener
void	setConnected(java.lang.Boolean connected) Overwrites system connectivity state.

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

Method Detail

instance

public static ConnectivityReceiver instance(@NonNull
                                            android.content.Context context)

Get a single instance of ConnectivityReceiver.

Parameters:

context - the context to extract the application context from

Returns:

single instance of ConnectivityReceiver

activate

@UiThread
public void activate()

Activates the connectivity receiver.

if the underlying connectivity receiver isn't active, register the connectivity receiver.

deactivate

@UiThread
public void deactivate()

Deactivates the connectivity receiver.

if no other components are listening, unregister the underlying connectivity receiver.

onReceive

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

Specified by:

onReceive in class android.content.BroadcastReceiver

setConnected

public void setConnected(java.lang.Boolean connected)

Overwrites system connectivity state. To set, use Mapbox.setConnected(Boolean).

Parameters:

connected - flag to determine the connectivity state, true for connected, false for disconnected, and null for ConnectivityManager to determine.

addListener

public void addListener(@NonNull
                        ConnectivityListener listener)

Add a listener to be notified

Parameters:

listener - the listener to add

removeListener

public void removeListener(@NonNull
                           ConnectivityListener listener)

Remove a listener

Parameters:

listener - the listener to remove

isConnected

public boolean isConnected()

Get current connectivity state

Returns:

true if connected