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() Get the current active 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 ModuleProvider	getModuleProvider() Get the module provider
static java.lang.String	getSkuToken() Returns a SKU token, refreshed if necessary.
static TelemetryDefinition	getTelemetry() Get an instance of Telemetry if initialised
static boolean	hasInstance() Internal use.
static java.lang.Boolean	isConnected() Determines whether we have an internet connection available.
static void	setAccessToken(java.lang.String accessToken) Set the current active accessToken.
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
 @NonNull
public static Mapbox getInstance(@NonNull
                                                     android.content.Context context,
                                                     @Nullable
                                                     java.lang.String accessToken)

Get an instance of Mapbox.

This class manages the Mapbox 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

@Nullable
public static java.lang.String getAccessToken()

Get the current active access token for this application.

Returns:

Mapbox access token

setAccessToken

public static void setAccessToken(java.lang.String accessToken)

Set the current active accessToken.

getSkuToken

public static java.lang.String getSkuToken()

Returns a SKU token, refreshed if necessary. This method is meant for internal SDK usage only.

Returns:

the SKU token

getApplicationContext

@NonNull
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

getTelemetry

@Nullable
public static TelemetryDefinition getTelemetry()

Get an instance of Telemetry if initialised

Returns:

instance of telemetry

getModuleProvider

@NonNull
public static ModuleProvider getModuleProvider()

Get the module provider

Returns:

moduleProvider

hasInstance

public static boolean hasInstance()

Internal use. Check if the INSTANCE is present.