Maps SDK for Android/com.magiclane.sdk.core/SdkSettings

SdkSettings

SdkSettings object

Properties

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

allowConnection

val allowConnection: Boolean

Checks if the connection is allowed or not.

appAuthorization

var appAuthorization: String?

The application authorization API token The HTTP services are available through this API token Returns empty if no valid authorization API token is used

applicationName

var applicationName: String?

Application name

decimalSeparator

var decimalSeparator: Char

Decimal separator.

deviceModel

var deviceModel: String?

The device model.

deviceName

var deviceName: String?

The device name.

digitGroupSeparator

var digitGroupSeparator: Char

Digit group separator

isMapDataReady

val isMapDataReady: Boolean

True if worldwideRoadMapSupportStatus is EOffboardListenerStatus.UpToDate else false.

isResourcesUpdateAllowed

var isResourcesUpdateAllowed: () -> Boolean

Verifies that application resources update is allowed. Returning true will allow the SDK to download and prepare the latest resources. Will be called on SdkCall

language

var language: Language?

API language. Value should be selected from getLanguageList().

languagesList

val languagesList: ArrayList<Language>?

Gets the API language list.

mapLanguage

var mapLanguage: EMapLanguage

The current setting for the map language selection.

networkProvider

var networkProvider: NetworkProvider?

The network service provider. The network service provider interface enables the API client to customize the network access. If this is set then the Magic Earth Engine will use it for network access.

onApiTokenRejected

var onApiTokenRejected: () -> Unit

Notifies that current API token was rejected Please check the API token availability or contact the MagicLane support

onApiTokenUpdated

var onApiTokenUpdated: () -> Unit

Notifies that current API token was updated This notifications will be available only for tokens updated internally via MagicEarth services

onConnected

var onConnected: () -> Unit

Notifies that the connection status changed. param connected Boolean Tells if the connection to the online services is established.

onConnectionStatusUpdated

var onConnectionStatusUpdated: (connected: Boolean) -> Unit

Notifies that the connection status changed. param connected Boolean Tells if the connection to the online services is established.

onMapDataReady

var onMapDataReady: (isReady: Boolean) -> Unit

Notifies that the map data is ready to be used.

onOnlineCacheSizeChange

var onOnlineCacheSizeChange: (size: Int) -> Unit

Notifies that offboard caches changed size cache size is provided in KB

onResourcesReadyToDeploy

var onResourcesReadyToDeploy: () -> Unit

Notifies that the application resources are ready to be deployed

onWorldwideRoadMapSupportDisabled

var onWorldwideRoadMapSupportDisabled: (reason: EOffboardListenerReason) -> Unit

Notifies that the world map online support is disabled Tiling, routing, traffic online support is disabled param reason EOffboardListenerReason - the reason

onWorldwideRoadMapSupportEnabled

var onWorldwideRoadMapSupportEnabled: () -> Unit

Notifies that world map online support is enabled Tiling, routing, traffic online support is enabled

onWorldwideRoadMapSupportStatus

var onWorldwideRoadMapSupportStatus: (state: EOffboardListenerStatus) -> Unit

Notifies about world map data online state param state EOffboardListenerStatus - status code

onWorldwideRoadMapUnsupportedCapabilities

var onWorldwideRoadMapUnsupportedCapabilities: () -> Unit

Notifies that current SDK doesn't support all world map online capabilities SDK can use the latest online world map version but the new map capabilities are disabled

onWorldwideRoadMapVersionUpdated

var onWorldwideRoadMapVersionUpdated: () -> Unit

Notifies that world map version was updated

tilesMaxSpace

var tilesMaxSpace: Int

Set maximum space to download tiles in Kb If maxSpace is 0 there are no restriction for tiles space

unitSystem

var unitSystem: EUnitSystem

The unit system used by the Magic Earth Engine. This setting will affect the text of the route / navigation instructions and the voice instructions.

voice

var voice: Voice?

Current voice.

Functions

finalize

fun finalize()

Overrides finalize that garbage collector will call when needed.

getAllowOffboardServiceOnExtraChargedNetwork

fun getAllowOffboardServiceOnExtraChargedNetwork(type: EServiceGroupType): Boolean

Check if the given service type is allowed on the extra charged network

getApplicationVersion

external fun getApplicationVersion(): ArrayList<Int>?

Get application version 0 -> version, 1 -> subVersion, 2 -> revision

getBestLanguageMatch

external fun getBestLanguageMatch(lang: String, region: String, script: String, variant: Int = 0): Language?

Finds the best language match for the provided input(language code, region code, variant and script code).

getBestVoiceMatch

external fun getBestVoiceMatch(lang: String, region: String): ArrayList<Voice>?

Finds the best voice match for the provided input( language code, region code)

getTransferStatistics

fun getTransferStatistics(type: EServiceGroupType): TransferStatistics?

Get transfer statistics for given service type

isConnected

fun isConnected(): Boolean

Returns true if the network is connected. Note: this should be used only if null listener had been provided to setAllowConnection.

isReference

fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

not

operator fun not(): Boolean

Checks if this object is valid.

release

fun release()

Releases the native referenced value of this object if:

setAllowAutoMapUpdate

fun setAllowAutoMapUpdate(value: Boolean, allowChargeNetwork: Boolean = true, roadMapAutoUpdateListener: ProgressListener? = null)

Allow auto map updates setting.

setAllowConnection

fun setAllowConnection(value: Boolean)

Allow/deny internet connection.

setAllowOffboardServiceOnExtraChargedNetwork

fun setAllowOffboardServiceOnExtraChargedNetwork(type: EServiceGroupType, allow: Boolean)

Allow the given service type on the extra charged network type. By default all are allowed.

setApplicationVersion

external fun setApplicationVersion(version: Int, subVersion: Int, revision: Int)

Set application version

setLanguageAsString

external fun setLanguageAsString(languageName: String)

Sets the API language

setLanguageBasedOnIsoCodes

external fun setLanguageBasedOnIsoCodes(lang: String, region: String, script: String, variant: Int = 0)

Sets the API language based on language ISO

setVoiceByPath

external fun setVoiceByPath(filepath: String)

Sets the current voice by specifying the path to the voice file. The voice can be chosen from a voice list provided by SdkSettings.getBestVoiceMatch methods.

verifyAppAuthorization

external fun verifyAppAuthorization(token: String, listener: ProgressListener)

Verifies an app token