Package com.mapfactor.sdk
Interface MpfcEngine
public interface MpfcEngine
MapFactor SDK initialization class
- Since:
- 1.0
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
Device activation resultstatic enum
MapFactor SDK initialization resultstatic enum
MapFactor SDK initialization progress status -
Method Summary
Modifier and TypeMethodDescriptionvoid
activateDevice
(String masterKey, ActivationListener activationListener) Activate device to enable SDK on the device.Get App data manager moduleGet Colors moduleGet FavoritesManager moduleGet Imports moduleGet Info modulestatic MpfcEngine
Get MpfcEngine instanceGet license expiration dateGet license keyGet Localization moduleGet Map moduleGet Navigation moduleGet Routing moduleGet Search moduleGet Support moduleGet Traffic moduleGet Units modulevoid
init
(android.content.Context context, String sdkRootPath, MapDataProvider.ProviderName mapDataProviderName, MapRenderer.RendererName mapRendererName, Localization.Language language, InitListener initListener) MapFactor SDK initializationboolean
MapFactor SDK is initialized testvoid
Call this when onLocationPermissionNotGranted() was called during SDK initialization and after location permission was granted for the App using MapFactor SDKvoid
shutdown()
MapFactor SDK un-initialization.
-
Method Details
-
getInstance
Get MpfcEngine instance- Returns:
- MpfcEngine instance
- Since:
- 1.0
-
init
void init(@NonNull android.content.Context context, @NonNull String sdkRootPath, @NonNull MapDataProvider.ProviderName mapDataProviderName, @NonNull MapRenderer.RendererName mapRendererName, @NonNull Localization.Language language, @NonNull InitListener initListener) MapFactor SDK initialization- Parameters:
context
- application contextsdkRootPath
- path for library data and mapsmapDataProviderName
- map data providermapRendererName
- map renderer namelanguage
- SDK languageinitListener
- SDK initialization listener- Since:
- 1.0
-
isInitialized
boolean isInitialized()MapFactor SDK is initialized test- Returns:
- true/false whether SDK is/isn't initialized
- Since:
- 1.0
-
shutdown
void shutdown()MapFactor SDK un-initialization.- Since:
- 1.0
-
locationPermissionWasGranted
void locationPermissionWasGranted()Call this when onLocationPermissionNotGranted() was called during SDK initialization and after location permission was granted for the App using MapFactor SDK- Since:
- 1.0
-
activateDevice
Activate device to enable SDK on the device. Call only once per device after installation.- Parameters:
masterKey
- product key, contact seller to get oneactivationListener
- device activation result listener- Since:
- 1.0
-
getLicenseKey
Get license key- Returns:
- license key
- Since:
- 3.1
-
getLicenseExpirationDate
Get license expiration date- Returns:
- license expiration date
- Since:
- 2.0
-
getInfoModule
Get Info module- Returns:
- Info module instance
- Since:
- 1.0
-
getLocalizationModule
Get Localization module- Returns:
- Localization module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Throws:
SdkException
- Since:
- 1.0
-
getUnitsModule
Get Units module- Returns:
- Units module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Throws:
SdkException
- Since:
- 1.0
-
getMapModule
Get Map module- Returns:
- Map module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Throws:
SdkException
- Since:
- 1.0
-
getAppDataManagerModule
Get App data manager module- Returns:
- App data manager module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Throws:
SdkException
- Since:
- 1.0
-
getRoutingModule
Get Routing module- Returns:
- routing module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Throws:
SdkException
- Since:
- 1.0
-
getTrafficModule
Get Traffic module- Returns:
- traffic module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Throws:
SdkException
- Since:
- 1.0
-
getSearchModule
Get Search module- Returns:
- search module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Throws:
SdkException
- Since:
- 1.0
-
getFavoritesModule
Get FavoritesManager module- Returns:
- favorites module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Throws:
SdkException
- Since:
- 1.0
-
getImportsModule
Get Imports module- Returns:
- imports module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Throws:
SdkException
- Since:
- 1.5
-
getColorsModule
Get Colors module- Returns:
- Colors module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
- Since:
- 3.14
-
getSupportModule
Get Support module- Returns:
- support module instance
- Since:
- 1.0
-