SdkSettings - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > SdkSettings

SdkSettings class

Signature:

export declare class SdkSettings

Properties

Property	Modifiers	Type	Description
actualAppTheme	`static` `readonly`	AppTheme	Get the actual images & texts render theme This will return the actual used theme (dark/light) when SDK theme was set to automatic
allowConnection	`static` `readonly`	boolean
appAuthorization	`static`	string
applicationName	`static`	string
appTheme	`static`	AppTheme
capabilities	`static` `readonly`	Set<SdkCapability>	Get the set of SdkCapability for the current build.
decimalSeparator	`static`	string
deviceModel	`static`	string	Get device model.
deviceName	`static`	string
digitGroupSeparator	`static`	string
isCurrentThreadMainThread	`static` `readonly`	boolean	Check if the current thread is the main thread.
isSDkInitialized	`static` `readonly`	boolean
language	`static`	Language	Get the API language.
languageList	`static` `readonly`	Language[]	Get the API language list.
mapLanguage	`static`	MapLanguage
offBoardListener	`static` `readonly`	OffBoardListener	Get the offboard listener
sdkVersion	`static` `readonly`	string	Get SDK version '0.1.2' 0 -> version, 1 -> subVersion, 2 -> revision The revision is unsigned hexadecimal
tilesMaxSpace	`static`	number	Get maximum storage space/cache size to use for downloaded tiles in kilobytes (Kb).
transferStatistics	`static` `readonly`	TransferStatistics	Get the transfer statistics
unitSystem	`static`	UnitSystem

Methods

Method	Modifiers	Description
autoUpdate()	`static`	Forces auto update in respect to the configured AutoUpdateSettings. Might also trigger the OffBoardListener callbacks
getAllowOffboardServiceOnExtraChargedNetwork(serviceType)	`static`	Check if the given service type is allowed on the extra charged network.
getBestLanguageMatch(languageCode, regionCode, scriptCode, variant)	`static`	Find the best language match for the provided input.
getDefaultWidthHeightImageFormat()	`static`
getImageById(options)	`static`
getImgById(id)	`static`	Get the image by its ID
getOnlineServiceRestriction(serviceType)	`static`	Get online service restrictions.
getTopicNotificationsServiceRestriction(serviceType)	`static`	Get topic notifications service restrictions.
getVoice()	`static`	Get the current voice.
setAllowInternetConnection(allowInternetConnection)	`static`	Allow/deny internet connection.
setAllowOffboardServiceOnExtraChargedNetwork(serviceType, allow)	`static`	Allow the given service type on the extra charged network type. By default all are allowed.
setDefaultWidthHeightImageFormat(size, format)	`static`
setSdkVersion(version, subVersion, revision)	`static`	Set the SDK version
setTTSVoiceByLanguage(language)	`static`	Set the current TTS (computer) voice used for text-to-speech instructions. The best voice is selected based on the provided language.
setVoiceByPath(path, language)	`static`	Set the current voice by specifying the absolute path to the voice file.
verifyAppAuthorization(token, callback)	`static`	Verifies an app token. Validates the provided token and reports progress through the specified callback.