Package com.mapfactor.sdk

Interface MpfcEngine

public interface MpfcEngine
MapFactor SDK initialization class
Since:
1.0

  • Method Details

    • getInstance

      static MpfcEngine 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 context
      sdkRootPath - path for library data and maps
      mapDataProviderName - map data provider
      mapRendererName - map renderer name
      language - SDK language
      initListener - 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

      void activateDevice(@NonNull String masterKey, @NonNull ActivationListener activationListener)
      Activate device to enable SDK on the device. Call only once per device after installation.
      Parameters:
      masterKey - product key, contact seller to get one
      activationListener - device activation result listener
      Since:
      1.0

    • getLicenseKey

      @NonNull String getLicenseKey()
      Get license key
      Returns:
      license key
      Since:
      3.1

    • getLicenseExpirationDate

      @NonNull Calendar getLicenseExpirationDate()
      Get license expiration date
      Returns:
      license expiration date
      Since:
      2.0

    • getInfoModule

      @NonNull Info getInfoModule()
      Get Info module
      Returns:
      Info module instance
      Since:
      1.0

    • getLocalizationModule

      @NonNull Localization getLocalizationModule() throws SdkException
      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

      @NonNull Units getUnitsModule() throws SdkException
      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

      @NonNull Map getMapModule() throws SdkException
      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

      @NonNull AppDataManager getAppDataManagerModule() throws SdkException
      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

      @NonNull Routing getRoutingModule() throws SdkException
      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

    • getNavigationModule

      @NonNull Navigation getNavigationModule() throws SdkException
      Get Navigation module
      Returns:
      navigation module instance. Throws SdkNotInitializedException when SDK is not initialized or DeviceNotActivatedException when the device is not activated.
      Throws:
      SdkException
      Since:
      1.0

    • getTrafficModule

      @NonNull Traffic getTrafficModule() throws SdkException
      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

      @NonNull Search getSearchModule() throws SdkException
      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

      @NonNull FavoritesManager getFavoritesModule() throws SdkException
      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

      @NonNull ImportsManager getImportsModule() throws SdkException
      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

      @NonNull Colors 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

      @NonNull Support getSupportModule()
      Get Support module
      Returns:
      support module instance
      Since:
      1.0

    • setNightMode

      void setNightMode(boolean nightModeOn)
      Enable/disable night mode for all fragments
      Parameters:
      nightModeOn - true/false to enable/disable night mode
      Since:
      4.7

    • isNightMode

      boolean isNightMode()
      Test whether night mode is on
      Returns:
      true/false when night mode is/is not on
      Since:
      4.7