Core/com.benomad.msdk.core/Core

Core

class Core : OnMapDownloadedObservable, OnMapUpdateAvailableObservable, OnMapDownloadErrorObservable, OnMapExtractionProgressObservable, OnMapDownloadProgressObservable, OnInitProgressObservable, OnHybridDownloadProgressObservable, OnCoreInitObservable, OnLicenseErrorObservable, OnOfflinePeriodExpiredObservable

Singleton used for initializing the mSDK. Designed to be reflection proof and thread safe.

Constructors

constructor()

Types

object Companion

Properties

var licenseInfo: LicenseInfo?

License Information Initialized when the core is ready

var mapsIO: MapsIO?

Maps loading / unloading operations Initialized when the core is ready

Functions

addOnCoreInitObserver

open override fun addOnCoreInitObserver(observer: OnCoreInitCallback)

addOnHybridDownloadProgressObserver

open override fun addOnHybridDownloadProgressObserver(observer: OnHybridMapDownloadProgressCallback)

addOnInitProgressObserver

open override fun addOnInitProgressObserver(observer: OnInitProgressCallback)

addOnLicenseErrorObserver

open override fun addOnLicenseErrorObserver(observer: OnLicenseErrorCallback)

Add observers to be notified when a licensing error occurred.

addOnMapDownloadedObserver

open override fun addOnMapDownloadedObserver(observer: OnMapDownloadedCallback)

addOnMapDownloadErrorObserver

open override fun addOnMapDownloadErrorObserver(observer: OnMapDownloadErrorCallback)

addOnMapDownloadProgressObserver

open override fun addOnMapDownloadProgressObserver(observer: OnMapDownloadProgressCallback)

addOnMapExtractionProgressObserver

open override fun addOnMapExtractionProgressObserver(observer: OnMapExtractionProgressCallback)

addOnMapUpdateAvailableObserver

open override fun addOnMapUpdateAvailableObserver(observer: OnMapUpdateAvailableCallback)

addOnOfflinePeriodExpiredObserver

open override fun addOnOfflinePeriodExpiredObserver(observer: OnOfflinePeriodExpiredCallback)

Add observers to be notified when the license offline period has expired.

cancelPendingHybridDownloads

fun cancelPendingHybridDownloads()

This method cancels any pending map download operations when working with hybrid maps

downloadAvailableUpdate

fun downloadAvailableUpdate(downloadAccepted: Boolean)

Starts the download of the maps update. Only call this method after OnMapUpdateAvailableCallback.onMapUpdateAvailable is triggered (use addOnMapUpdateAvailableObserver) To get the download progress of the update, subscribe to OnMapDownloadProgressCallback (use addOnMapDownloadProgressObserver) You can also be notified when the download has finished by subscribing to OnMapDownloadedCallback (use addOnMapDownloadedObserver)

getDefaultAssetsMapsPath

fun getDefaultAssetsMapsPath(): String

Gets the default relative path in assets to the maps folder

getDefaultAssetsResourcesPath

fun getDefaultAssetsResourcesPath(): String

Gets the default relative path in assets to the resources folder

getDefaultMapsPath

fun getDefaultMapsPath(applicationContext: Context, useSdCard: Boolean = false): String

Gets the default path to the deployed maps folder

getExternalScopedStoragePath

fun getExternalScopedStoragePath(applicationContext: Context): String

Gets the path from the scoped storage to access persistent files on the primary external storage volume

getVersioningInfoAsJson

fun getVersioningInfoAsJson(applicationContext: Context): String

Returns versioning info from created versioning file

fun init(applicationContext: Context, purchaseUUID: String?, licenseKey: String? = null, mapsDeploymentPath: String = getDefaultMapsPath(applicationContext), resourcesPathInAssets: String? = ResourcesHandler.defaultAssetsResourcesFolderName, mapsPathInAssets: String? = ResourcesHandler.defaultAssetMapsFolderName, callback: OnCoreInitCallback)

Initializes the Core This is mandatory to use modules that depends on it. It'll download/load the license and the map data and return once all is finished or an error occurred. The progress can be retrieved by adding an observer with addOnInitProgressObserver. When it's finished, all observers set with addOnCoreInitObserver will be notified.

fun isInit(): Boolean

Returns true if the Core has been successfully initialized.

isUsingHybridMaps

fun isUsingHybridMaps(): Boolean

After receiving the OnCoreReady notification, this method returns true if hybrid maps are used (vs full maps).

loadFullMapsInArea

fun loadFullMapsInArea(area: GeoRect, asyncMode: Boolean = false): Error?

After receiving the OnCoreReady notification (and if you are using hybrid maps), you can use this method to force the download of full maps within a given area (if area's maps has partial files).

loadFullMapsInCountry

fun loadFullMapsInCountry(countryCode: String, asyncMode: Boolean = false): Error?

After receiving the OnCoreReady notification (and if you are using hybrid maps), you can use this method to force the download of full maps within a given country (if country's maps has partial files).

fun mapGeoScale(): Long

Gets the current map geoscale

notifyOnMapExtractionProgressObservers

fun notifyOnMapExtractionProgressObservers(progress: Float)

removeOnCoreInitObserver

open override fun removeOnCoreInitObserver(observer: OnCoreInitCallback)

removeOnHybridDownloadProgressObserver

open override fun removeOnHybridDownloadProgressObserver(observer: OnHybridMapDownloadProgressCallback)

removeOnInitProgressObserver

open override fun removeOnInitProgressObserver(observer: OnInitProgressCallback)

removeOnLicenseErrorObserver

open override fun removeOnLicenseErrorObserver(observer: OnLicenseErrorCallback)

removeOnMapDownloadedObserver

open override fun removeOnMapDownloadedObserver(observer: OnMapDownloadedCallback)

removeOnMapDownloadErrorObserver

open override fun removeOnMapDownloadErrorObserver(observer: OnMapDownloadErrorCallback)

removeOnMapDownloadProgressObserver

open override fun removeOnMapDownloadProgressObserver(observer: OnMapDownloadProgressCallback)

removeOnMapExtractionProgressObserver

open override fun removeOnMapExtractionProgressObserver(observer: OnMapExtractionProgressCallback)

removeOnMapUpdateAvailableObserver

open override fun removeOnMapUpdateAvailableObserver(observer: OnMapUpdateAvailableCallback)

removeOnOfflinePeriodExpiredObserver

open override fun removeOnOfflinePeriodExpiredObserver(observer: OnOfflinePeriodExpiredCallback)