com.mapbox.mapboxsdk

Class Mapbox

java.lang.Object

com.mapbox.mapboxsdk.Mapbox

@UiThread
public final class Mapbox
extends java.lang.Object

The entry point to initialize the Mapbox Android SDK.

Obtain a reference by calling getInstance(Context, String). Usually this class is configured in Application#onCreate() and is responsible for the active access token, application context, and connectivity state.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAccessToken() Access token for this application.
static android.content.Context	getApplicationContext() Application context
static Mapbox	getInstance(android.content.Context context, java.lang.String accessToken) Get an instance of Mapbox.
static com.mapbox.services.android.telemetry.location.LocationEngine	getLocationEngine() Returns the location engine used by the SDK.
static LocationSource	getLocationSource() Deprecated. Replaced by getLocationEngine()
static java.lang.Boolean	isConnected() Determines whether we have an internet connection available.
static void	setConnected(java.lang.Boolean connected) Manually sets the connectivity state of the app.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

@UiThread
public static Mapbox getInstance(@NonNull
                                           android.content.Context context,
                                           @NonNull
                                           java.lang.String accessToken)

Get an instance of Mapbox.

This class manages the active access token, application context, and connectivity state.

Parameters:

context - Android context which holds or is an application context

accessToken - Mapbox access token

Returns:

the single instance of Mapbox

getAccessToken

public static java.lang.String getAccessToken()

Access token for this application.

Returns:

Mapbox access token

getApplicationContext

public static android.content.Context getApplicationContext()

Application context

Returns:

the application context

setConnected

public static void setConnected(java.lang.Boolean connected)

Manually sets the connectivity state of the app. This is useful for apps which control their own connectivity state and want to bypass any checks to the ConnectivityManager.

Parameters:

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

isConnected

public static java.lang.Boolean isConnected()

Determines whether we have an internet connection available. Please do not rely on this method in your apps. This method is used internally by the SDK.

Returns:

true if there is an internet connection, false otherwise

getLocationSource

@Deprecated
public static LocationSource getLocationSource()

Deprecated. Replaced by getLocationEngine()

Returns a location source instance with empty methods.

Returns:

an empty location source implementation

getLocationEngine

public static com.mapbox.services.android.telemetry.location.LocationEngine getLocationEngine()

Returns the location engine used by the SDK.

Returns:

the location engine configured