Package com.mapbox.mapboxsdk.net

Contains the Mapbox Maps Android Network API classes.

Types

Name Summary
ConnectivityListener
interface ConnectivityListener
Receives updates on connectivity state
ConnectivityReceiver
open class ConnectivityReceiver : BroadcastReceiver
Interface definition for a callback to be invoked when connectivity changes.
NativeConnectivityListener
open class NativeConnectivityListener : ConnectivityListener
Updates the native library’s connectivity state

ConnectivityListener

interface ConnectivityListener

Receives updates on connectivity state

Functions

Name Summary
onNetworkStateChanged
abstract fun onNetworkStateChanged(connected: Boolean)

Inheritors

Name
NativeConnectivityListener

onNetworkStateChanged

abstract fun onNetworkStateChanged(connected: Boolean)

ConnectivityReceiver

open class ConnectivityReceiver : BroadcastReceiver

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

Functions

Name Summary
abortBroadcast
fun abortBroadcast()
activate
@UiThread()
open fun activate()
Activates the connectivity receiver.
addListener
open fun addListener(listener: ConnectivityListener)
Add a listener to be notified
clearAbortBroadcast
fun clearAbortBroadcast()
deactivate
@UiThread()
open fun deactivate()
Deactivates the connectivity receiver.
getAbortBroadcast
fun getAbortBroadcast(): Boolean
getDebugUnregister
fun getDebugUnregister(): Boolean
getResultCode
fun getResultCode(): Int
getResultData
fun getResultData(): String
getResultExtras
fun getResultExtras(makeMap: Boolean): Bundle
goAsync
fun goAsync(): BroadcastReceiver.PendingResult
instance
open fun instance(context: Context): ConnectivityReceiver
Get a single instance of ConnectivityReceiver.
isConnected
open fun isConnected(): Boolean
Get current connectivity state
isInitialStickyBroadcast
fun isInitialStickyBroadcast(): Boolean
isOrderedBroadcast
fun isOrderedBroadcast(): Boolean
onReceive
abstract fun onReceive(p: Context, p1: Intent)
open fun onReceive(context: Context, intent: Intent)
peekService
open fun peekService(myContext: Context, service: Intent): IBinder
removeListener
open fun removeListener(listener: ConnectivityListener)
Remove a listener
setDebugUnregister
fun setDebugUnregister(debug: Boolean)
setOrderedHint
fun setOrderedHint(isOrdered: Boolean)
setResult
fun setResult(code: Int, data: String, extras: Bundle)
setResultCode
fun setResultCode(code: Int)
setResultData
fun setResultData(data: String)
setResultExtras
fun setResultExtras(extras: Bundle)

Properties

Name Summary
connected @Nullable()
private open var connected: Boolean

activate

@UiThread()

open fun activate()

Activates the connectivity receiver.

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

addListener

open fun addListener(listener: ConnectivityListener)

Add a listener to be notified

Parameters
Name Summary
listener
the listener to add
   
   

connected

@Nullable()

private open var connected: Boolean

deactivate

@UiThread()

open fun deactivate()

Deactivates the connectivity receiver.

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

instance

open fun instance(context: Context): ConnectivityReceiver

Get a single instance of ConnectivityReceiver.

Return

single instance of ConnectivityReceiver

Parameters
Name Summary
context
the context to extract the application context from
   
   

isConnected

open fun isConnected(): Boolean

Get current connectivity state

Return

true if connected

onReceive

open fun onReceive(context: Context, intent: Intent)

removeListener

open fun removeListener(listener: ConnectivityListener)

Remove a listener

Parameters
Name Summary
listener
the listener to remove
   
   

NativeConnectivityListener

open class NativeConnectivityListener : ConnectivityListener

Updates the native library’s connectivity state

Constructors

Name Summary
NativeConnectivityListener open fun NativeConnectivityListener(nativePtr: Long)
NativeConnectivityListener open fun NativeConnectivityListener()

Functions

Name Summary
onNetworkStateChanged
open fun onNetworkStateChanged(connected: Boolean)

onNetworkStateChanged

open fun onNetworkStateChanged(connected: Boolean)