MapLoader

class MapLoader : NativeMethodsReceiver

Class providing functionality to manage offline maps on the device.

ToDo: Update documentation!

Types

LoadResult

enum LoadResult : Enum<MapLoader.LoadResult>

Result of executed operation.

MapStatus

enum MapStatus : Enum<MapLoader.MapStatus>

Status of a map.

Task

class Task

Class responsible for cancelling the running operation it represents.

Functions

addMapProgressInstallListener

@JvmOverloads()

fun addMapProgressInstallListener(listener: MapInstallProgressListener, executor: Executor? = null)

Adds listener for installation progress of a map.

addMapResumedInstallDoneListener

@JvmOverloads()

fun addMapResumedInstallDoneListener(listener: MapResumedInstallDoneListener, executor: Executor? = null)

Adds listener that will be called when a map that has resumed installation has finished installing.

callMethod

open fun <T : NativeMethodsReceiver.NativeListener> callMethod(clazz: Class<T>, callback: NativeMethodsReceiver.NativeCallback<T>)

checkForUpdates

fun checkForUpdates(listener: MapListResultListener): MapLoader.Task

Checks for map updates.

clearCache

fun clearCache(listener: ResultListener)

detectCurrentCountry

fun detectCurrentCountry(mapIso: String = "", listener: MapResultListener): MapLoader.Task

Detects the country of current location.

getAvailableCountries

fun getAvailableCountries(installed: Boolean, listener: MapListResultListener): MapLoader.Task

Fetches all currently available maps.

getCountryDetails

fun getCountryDetails(mapIso: String, installed: Boolean, listener: MapCountryDetailsListener)

Fetch details about a country.

getListeners

open fun <T : NativeMethodsReceiver.NativeListener> getListeners(clazz: Class<T>): MutableMap<T, Executor>

getMapStatus

fun getMapStatus(mapIso: String, listener: MapStatusListener)

Fetches the status of requested map (country or region).

getRegionDetails

fun getRegionDetails(mapIso: String, installed: Boolean, listener: MapRegionDetailsListener)

Fetch details about a country region.

installMap

fun installMap(mapIso: String, listener: MapResultListener): MapLoader.Task

Downloads and installs the requested map.

loadMap

fun loadMap(mapIso: String, listener: MapResultListener)

Loads installed map (country or region).

loadMaps

fun loadMaps(mapIsos: List<String>, listener: MapsResultListener)

Loads installed maps (countries or regions).

open fun <T : NativeMethodsReceiver.NativeListener> register(clazz: Class<T>, listener: T): Int

open fun <T : NativeMethodsReceiver.NativeListener> register(clazz: Class<T>, listener: T, @Nullable() executor: Executor?): Int

removeMapProgressInstallListener

fun removeMapProgressInstallListener(listener: MapInstallProgressListener)

Removes listener for installation progress of a map.

removeMapResumedInstallDoneListener

fun removeMapResumedInstallDoneListener(listener: MapResumedInstallDoneListener)

Removes listener for resumed map installation.

resumePendingInstallations

fun resumePendingInstallations(listener: MapLoaderResumeInfoListener)

Resumes all pending map installations (and updates).

setLocale

fun setLocale(locale: String, listener: ResultListener)

size

open fun size(): Int

uninstallMap

fun uninstallMap(mapIso: String, listener: MapResultListener): MapLoader.Task

Uninstalls the requested map.

unloadMap

fun unloadMap(mapIso: String, listener: MapResultListener)

Unloads loaded map.

unloadMaps

fun unloadMaps(mapIsos: List<String>, listener: MapsResultListener)

Unloads loaded maps.

unregister

open fun <T : NativeMethodsReceiver.NativeListener> unregister(clazz: Class<T>, listener: T): Int

updateMap

fun updateMap(mapIso: String, listener: MapResultListener): MapLoader.Task

Updates map with given ISO code.