com.mapbox.mapboxsdk.offline

Class OfflineManager

java.lang.Object

com.mapbox.mapboxsdk.offline.OfflineManager

public class OfflineManager
extends java.lang.Object

The offline manager is the main entry point for offline-related functionality. It'll help you list and create offline regions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OfflineManager.CreateOfflineRegionCallback This callback receives an asynchronous response containing the newly created OfflineRegion in the database, or an error message otherwise.
static interface	OfflineManager.ListOfflineRegionsCallback This callback receives an asynchronous response containing a list of all OfflineRegion in the database, or an error message otherwise.

Method Summary

Modifier and Type	Method and Description
void	createOfflineRegion(OfflineRegionDefinition definition, byte[] metadata, OfflineManager.CreateOfflineRegionCallback callback) Create an offline region in the database.
java.lang.String	getAccessToken() Deprecated. As of release 4.1.0, replaced by MapboxAccountManager.getAccessToken()
static java.lang.String	getDatabasePath(android.content.Context context)
static OfflineManager	getInstance(android.content.Context context)
static boolean	isExternalStorageReadable() Checks if external storage is available to at least read.
void	listOfflineRegions(OfflineManager.ListOfflineRegionsCallback callback) Retrieve all regions in the offline database.
void	setAccessToken(java.lang.String accessToken) Deprecated. As of release 4.1.0, replaced by MapboxAccountManager.start(Context, String) ()}
void	setOfflineMapboxTileCountLimit(long limit)

Methods inherited from class java.lang.Object

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

Method Detail

getDatabasePath

public static java.lang.String getDatabasePath(android.content.Context context)

isExternalStorageReadable

public static boolean isExternalStorageReadable()

Checks if external storage is available to at least read. In order for this to work, make sure you include <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /> (or WRITE_EXTERNAL_STORAGE) for API level < 18 in your app Manifest.

Code from https://developer.android.com/guide/topics/data/data-storage.html#filesExternal

getInstance

public static OfflineManager getInstance(android.content.Context context)

setAccessToken

@Deprecated
public void setAccessToken(java.lang.String accessToken)

Deprecated. As of release 4.1.0, replaced by MapboxAccountManager.start(Context, String) ()}

Access token getter/setter

Parameters:

accessToken -

getAccessToken

@Deprecated
public java.lang.String getAccessToken()

Deprecated. As of release 4.1.0, replaced by MapboxAccountManager.getAccessToken()

Get Access Token

Returns:

Access Token

listOfflineRegions

public void listOfflineRegions(OfflineManager.ListOfflineRegionsCallback callback)

Retrieve all regions in the offline database.

The query will be executed asynchronously and the results passed to the given callback on the main thread.

createOfflineRegion

public void createOfflineRegion(OfflineRegionDefinition definition,
                                byte[] metadata,
                                OfflineManager.CreateOfflineRegionCallback callback)

Create an offline region in the database.

When the initial database queries have completed, the provided callback will be executed on the main thread.

Note that the resulting region will be in an inactive download state; to begin downloading resources, call `OfflineRegion.setDownloadState(DownloadState.STATE_ACTIVE)`, optionally registering an `OfflineRegionObserver` beforehand.

setOfflineMapboxTileCountLimit

public void setOfflineMapboxTileCountLimit(long limit)