Package com.trimblemaps.mapsdk.net
Class ConnectivityReceiver
java.lang.Object
android.content.BroadcastReceiver
com.trimblemaps.mapsdk.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 TypeMethodDescriptionvoidactivate()Activates the connectivity receiver.voidaddListener(ConnectivityListener listener) Add a listener to be notifiedvoidvoidDeactivates the connectivity receiver.Get wifi ssid blacklistGet wifi ssid whiteliststatic ConnectivityReceiverinstance(android.content.Context context) Get a single instance of ConnectivityReceiver.booleanbooleanGet current connectivity statebooleanGet wifi only settingvoidonReceive(android.content.Context context, android.content.Intent intent) voidremoveListener(ConnectivityListener listener) Remove a listenervoidvoidsetConnected(Boolean connected) Overwrites system connectivity state.voidsetShouldPromptForOnline(boolean shouldPromptForOnline) Sets whether or not to trigger the OnlineDataRequestedWhileOfflineCallback when setConnected() is set to false but the map would need more data to render the onscreen mapvoidsetWifiBlackList(List<String> blackList) Sets WiFi SSID black listvoidsetWifiOnly(boolean wifiOnly) Sets whether or not map data should only we downloaded on wifivoidsetWifiWhiteList(List<String> whiteList) Sets WiFi SSID white listbooleanMethods inherited from class android.content.BroadcastReceiver
abortBroadcast, clearAbortBroadcast, getAbortBroadcast, getDebugUnregister, getResultCode, getResultData, getResultExtras, getSentFromPackage, getSentFromUid, goAsync, isInitialStickyBroadcast, isOrderedBroadcast, peekService, setDebugUnregister, setOrderedHint, setResult, setResultCode, setResultData, setResultExtras
-
Method Details
-
instance
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:
onReceivein classandroid.content.BroadcastReceiver
-
setConnected
Overwrites system connectivity state. To set, useTrimbleMaps.setConnected(Boolean).- Parameters:
connected- flag to determine the connectivity state, true for connected, false for disconnected, and null for ConnectivityManager to determine.
-
setWifiOnly
public void setWifiOnly(boolean wifiOnly) Sets whether or not map data should only we downloaded on wifi- Parameters:
wifiOnly- whether or not map data should only we downloaded on wifi
-
setShouldPromptForOnline
public void setShouldPromptForOnline(boolean shouldPromptForOnline) Sets whether or not to trigger the OnlineDataRequestedWhileOfflineCallback when setConnected() is set to false but the map would need more data to render the onscreen map- Parameters:
shouldPromptForOnline- whether or not to prompt if offline and missing tiles
-
setWifiWhiteList
Sets WiFi SSID white list- Parameters:
whiteList- A list of SSIDs that will be allowed when on WiFi
-
setWifiBlackList
Sets WiFi SSID black list- Parameters:
blackList- A list of SSIDs that will not be allowed when on WiFi
-
addListener
Add a listener to be notified- Parameters:
listener- the listener to add
-
addOnlineDataRequestedWhenOfflineListener
public void addOnlineDataRequestedWhenOfflineListener(@NonNull OnlineDataRequestedWhenOfflineListener listener) -
removeListener
Remove a listener- Parameters:
listener- the listener to remove
-
removeOnlineDataRequestedWhenOfflineListener
public void removeOnlineDataRequestedWhenOfflineListener(@NonNull OnlineDataRequestedWhenOfflineListener listener) -
isConnected
public boolean isConnected()Get current connectivity state- Returns:
- true if connected
-
isWifiOnly
public boolean isWifiOnly()Get wifi only setting- Returns:
- true if connected
-
shouldPromptForOnline
public boolean shouldPromptForOnline() -
getConnectivityOverride
-
getWifiWhiteList
Get wifi ssid whitelist- Returns:
- wifi whitelist
-
getWifiBlackList
Get wifi ssid blacklist- Returns:
- wifi blacklist
-
isCapabilitiesMonitoringAvailable
public boolean isCapabilitiesMonitoringAvailable()
-