RD-967: Add MTConfig object

Author: sasaprodribaba

MapTilerSDK/build.gradle.kts

@@ -2,6 +2,7 @@ plugins {
     id("com.android.library")
     id("org.jetbrains.kotlin.android")
     id("org.jlleitschuh.gradle.ktlint")
+    id("org.jetbrains.dokka")
 }
 
 tasks.named("ktlintFormat") {

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/MTConfig.kt

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2025, MapTiler
  * All rights reserved.
  * SPDX-License-Identifier: BSD 3-Clause
@@ -14,8 +14,112 @@ import com.maptiler.maptilersdk.logging.MTLogLevel
  * Exposes properties and options such as API Key and caching preferences.
  */
 object MTConfig {
+    private var apiKey: String = ""
+    private var unit: MTUnit = MTUnit.METRIC
+
     /**
      * SDK log level.
      */
     var logLevel: MTLogLevel = MTLogLevel.None
+        private set
+
+    /**
+     * Boolean indicating whether caching is enabled.
+     *
+     * Defaults to true.
+     */
+    var isCachingEnabled: Boolean = true
+        private set
+
+    /**
+     * Boolean indicating whether session logic is enabled.
+     *
+     * This allows MapTiler to enable "session based billing".
+     * Defaults to true.
+     * For more information about sessions, see [Map Sessions](https://docs.maptiler.com/guides/maps-apis/maps-platform/what-is-map-session-in-maptiler-cloud/).
+     */
+    var isSessionLogicEnabled: Boolean = true
+        private set
+
+    /**
+     * Boolean indicating whether telemetry is enabled.
+     *
+     * The telemetry is very valuable to the team at MapTiler because it shares information about
+     * where to add the extra effort. It also helps spotting some incompatibility issues that may
+     * arise between the SDK and a specific version of a module. It consist in sending the SDK version,
+     * API Key, MapTiler session ID, if tile caching is enabled, if language specified at initialization,
+     * if terrain is activated at initialization, if globe projection is activated at initialization.
+     * Defaults to true.
+     * @see 'https://docs.maptiler.com/guides/maps-apis/maps-platform/what-is-map-session-in-maptiler-cloud/'
+     */
+    var isTelemetryEnabled: Boolean = true
+        private set
+
+    /**
+     * Sets the MapTiler API key.
+     *
+     * @param apiKey The MapTiler API Key.
+     */
+    fun setAPIKey(apiKey: String) {
+        this.apiKey = apiKey
+    }
+
+    /**
+     * Returns the MapTiler API key.
+     */
+    fun getAPIKey(): String {
+        return this.apiKey
+    }
+
+    /**
+     * Sets the caching mechanism.
+     *
+     * Enabled by default.
+     *
+     * @param isEnabled Boolean indicating whether caching is enabled.
+     */
+    fun setCaching(isEnabled: Boolean) {
+        this.isCachingEnabled = isEnabled
+    }
+
+    /**
+     * Sets the session logic.
+     *
+     * Make sure to call before map init or use MTMapOptions to supply before map init.
+     * Enabled by default.
+     *
+     * @param isEnabled Boolean indicating whether session logic is enabled.
+     */
+    fun setSessionLogic(isEnabled: Boolean) {
+        this.isSessionLogicEnabled = isEnabled
+    }
+
+    /**
+     * Sets the unit of measurement.
+     *
+     * Defaults to METRIC.
+     *
+     * @param unit The MTUnit type.
+     */
+    fun setUnit(unit: MTUnit) {
+        this.unit = unit
+    }
+
+    /**
+     * Returns the unit of measurement.
+     */
+    fun getUnit(): MTUnit {
+        return this.unit
+    }
+
+    /**
+     * Sets the telemetry.
+     *
+     * Enabled by default.
+     *
+     * @param isEnabled Boolean indicating whether telemetry is enabled.
+     */
+    fun setTelemetry(isEnabled: Boolean) {
+        this.isTelemetryEnabled = isEnabled
+    }
 }

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/MTUnit.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2025, MapTiler
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD 3-Clause
+ */
+
+package com.maptiler.maptilersdk
+
+/**
+ * Units of measurement used in MTMapView object.
+ */
+enum class MTUnit {
+    /**
+     * Imperical units.
+     */
+    IMPERIAL,
+
+    /**
+     * Metric units.
+     */
+    METRIC,
+
+    /**
+     * Nautical units.
+     */
+    NAUTICAL,
+}

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/logging/MTLog.kt

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2025, MapTiler
  * All rights reserved.
  * SPDX-License-Identifier: BSD 3-Clause

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/logging/MTLogLevel.kt

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2025, MapTiler
  * All rights reserved.
  * SPDX-License-Identifier: BSD 3-Clause

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/logging/MTLogType.kt

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2025, MapTiler
  * All rights reserved.
  * SPDX-License-Identifier: BSD 3-Clause

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/logging/MTLogger.kt

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2025, MapTiler
  * All rights reserved.
  * SPDX-License-Identifier: BSD 3-Clause

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/logging/OSLogger.kt

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2025, MapTiler
  * All rights reserved.
  * SPDX-License-Identifier: BSD 3-Clause

settings.gradle.kts

@@ -16,6 +16,7 @@ pluginManagement {
         id("com.android.application") version "8.6.1"
         id("org.jetbrains.kotlin.android") version "2.0.0"
         id("org.jlleitschuh.gradle.ktlint") version "12.3.0"
+        id("org.jetbrains.dokka") version "2.0.0"
     }
 }
 dependencyResolutionManagement {