com.dingi.dingisdk.offline

Class OfflineManager

java.lang.Object

com.dingi.dingisdk.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.
static interface	OfflineManager.MergeOfflineRegionsCallback This callback receives an asynchronous response containing a list of all OfflineRegion added to the database during the merge.

Method Summary

Modifier and Type	Method and Description
void	createOfflineRegion(OfflineRegionDefinition definition, byte[] metadata, OfflineManager.CreateOfflineRegionCallback callback) Create an offline region in the database.
protected void	finalize()
static OfflineManager	getInstance(android.content.Context context) Get the single instance of offline manager.
void	listOfflineRegions(OfflineManager.ListOfflineRegionsCallback callback) Retrieve all regions in the offline database.
void	mergeOfflineRegions(java.lang.String path, OfflineManager.MergeOfflineRegionsCallback callback) Merge offline regions from a secondary database into the main offline database.
void	putResourceWithUrl(java.lang.String url, byte[] data, long modified, long expires, java.lang.String etag, boolean mustRevalidate) Insert the provided resource into the ambient cache This method mimics the caching that would take place if the equivalent resource were requested in the process of map rendering.
void	setOfflineDingiTileCountLimit(long limit) Changing or bypassing this limit without permission from Dingi is prohibited by the Dingi Terms of Service.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

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

Get the single instance of offline manager.

Parameters:

context - the context used to host the offline manager

Returns:

the single instance of offline manager

listOfflineRegions

public void listOfflineRegions(@NonNull
                               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.

Parameters:

callback - the callback to be invoked

mergeOfflineRegions

public void mergeOfflineRegions(@NonNull
                                java.lang.String path,
                                @NonNull
                                OfflineManager.MergeOfflineRegionsCallback callback)

Merge offline regions from a secondary database into the main offline database.

When the merge is completed, or fails, the OfflineManager.MergeOfflineRegionsCallback will be invoked on the main thread.

The secondary database may need to be upgraded to the latest schema. This is done in-place and requires write-access to the provided path. If the app's process doesn't have write-access to the provided path, the file will be copied to the temporary, internal directory for the duration of the merge.

Only resources and tiles that belong to a region will be copied over. Identical regions will be flattened into a single new region in the main database.

The operation will be aborted and OfflineManager.MergeOfflineRegionsCallback.onError(String) with an appropriate message will be invoked if the merge would result in the offline tile count limit being exceeded.

Merged regions may not be in a completed status if the secondary database does not contain all the tiles or resources required by the region definition.

Parameters:

path - secondary database writable path

callback - completion/error callback

createOfflineRegion

public void createOfflineRegion(@NonNull
                                OfflineRegionDefinition definition,
                                @NonNull
                                byte[] metadata,
                                @NonNull
                                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.

Parameters:

definition - the offline region definition

metadata - the metadata in bytes

callback - the callback to be invoked

setOfflineDingiTileCountLimit

public void setOfflineDingiTileCountLimit(long limit)

Changing or bypassing this limit without permission from Dingi is prohibited by the Dingi Terms of Service.

Parameters:

limit - the new tile count limit.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

putResourceWithUrl

public void putResourceWithUrl(java.lang.String url,
                               byte[] data,
                               long modified,
                               long expires,
                               java.lang.String etag,
                               boolean mustRevalidate)

Insert the provided resource into the ambient cache This method mimics the caching that would take place if the equivalent resource were requested in the process of map rendering. Use this method to pre-warm the cache with resources you know will be requested. This call is asynchronous: the data may not be immediately available for in-progress requests, although subsequent requests should have access to the cached data.

Parameters:

url - The URL of the resource to insert

data - Response data to store for this resource. Data is expected to be uncompressed; internally, the cache will compress data as necessary.

modified - Optional "modified" response header, in seconds since 1970, or 0 if not set

expires - Optional "expires" response header, in seconds since 1970, or 0 if not set

etag - Optional "entity tag" response header

mustRevalidate - Indicates whether response can be used after it's stale