Class SdkSettings

Constructors

constructor

new SdkSettings(): SdkSettings
Returns SdkSettings

Accessors

`Static`actualAppTheme

get actualAppTheme(): AppTheme
Get the actual images & texts render theme This will return the actual used theme (dark/light) when SDK theme was set to automatic

Returns AppTheme
The app theme

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:620

`Static`allowConnection

get allowConnection(): boolean
Returns boolean
- Defined in core/sdk_settings.ts:362

`Static`appAuthorization

get appAuthorization(): string
Returns string
- Defined in core/sdk_settings.ts:576
set appAuthorization(token: string): void
Parameters
- token: string
Returns void
- Defined in core/sdk_settings.ts:568

`Static`applicationName

get applicationName(): string
Returns string
- Defined in core/sdk_settings.ts:497
set applicationName(name: string): void
Parameters
- name: string
Returns void
- Defined in core/sdk_settings.ts:493

`Static`appTheme

get appTheme(): AppTheme
Returns AppTheme
- Defined in core/sdk_settings.ts:604
set appTheme(theme: AppTheme): void
Parameters
- theme: AppTheme
Returns void
- Defined in core/sdk_settings.ts:609

`Static`capabilities

get capabilities(): Set<SdkCapability>
Get the set of SdkCapability for the current build.

Returns Set<SdkCapability>
The features available for the current release

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:856

`Static`decimalSeparator

get decimalSeparator(): string
Returns string
- Defined in core/sdk_settings.ts:343
set decimalSeparator(separator: string): void
Parameters
- separator: string
Returns void
- Defined in core/sdk_settings.ts:348

`Static`deviceModel

get deviceModel(): string
Get device model.

Returns string
The device model

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:563
set deviceModel(model: string): void
Set device model.
Parameters
- model: string
  The device model.
Returns void
Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:553

`Static`deviceName

get deviceName(): string
Returns string
- Defined in core/sdk_settings.ts:542
set deviceName(name: string): void
Parameters
- name: string
Returns void
- Defined in core/sdk_settings.ts:538

`Static`digitGroupSeparator

get digitGroupSeparator(): string
Returns string
- Defined in core/sdk_settings.ts:353
set digitGroupSeparator(separator: string): void
Parameters
- separator: string
Returns void
- Defined in core/sdk_settings.ts:358

`Static`isCurrentThreadMainThread

get isCurrentThreadMainThread(): boolean
Check if the current thread is the main thread.

Returns boolean
true if the current thread is the main thread, false otherwise

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:845

`Static`isSDkInitialized

get isSDkInitialized(): boolean
Returns boolean
- Defined in core/sdk_settings.ts:625

`Static`language

get language(): Language
Get the API language.

Returns Language
Language object

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:426
set language(language: Language): void
Set the API language.
Parameters
- language: Language
  The selected language from the SDK list
Returns void
Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:437

`Static`languageList

get languageList(): Language[]
Get the API language list.

Returns Language[]
The languages list

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:477

`Static`mapLanguage

get mapLanguage(): MapLanguage
Returns MapLanguage
- Defined in core/sdk_settings.ts:484
set mapLanguage(mapLanguage: MapLanguage): void
Parameters
- mapLanguage: MapLanguage
Returns void
- Defined in core/sdk_settings.ts:489

`Static`offBoardListener

get offBoardListener(): OffBoardListener
Get the offboard listener

Returns OffBoardListener
The offboard listener
- Defined in core/sdk_settings.ts:372

`Static`sdkVersion

get sdkVersion(): string
Get SDK version '0.1.2' 0 -> version, 1 -> subVersion, 2 -> revision The revision is unsigned hexadecimal

Returns string
The sdk version as String

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:526

`Static`tilesMaxSpace

get tilesMaxSpace(): number
Get maximum storage space/cache size to use for downloaded tiles in kilobytes (Kb).

Returns number
Size in Kb

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:776
set tilesMaxSpace(maxSpace: number): void
Set maximum cache size/storage space to use for downloaded tiles in kilobytes (Kb).
Parameters
- maxSpace: number
  Size in Kb. If maxSpace is 0 there are no restrictions for tiles space.
Returns void
Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:766

`Static`transferStatistics

get transferStatistics(): TransferStatistics
Get the transfer statistics

Returns TransferStatistics
The transfer statistics

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:755

`Static`unitSystem

get unitSystem(): UnitSystem
Returns UnitSystem
- Defined in core/sdk_settings.ts:334
set unitSystem(unitSystem: UnitSystem): void
Parameters
- unitSystem: UnitSystem
Returns void
- Defined in core/sdk_settings.ts:339

Methods

`Static`autoUpdate

autoUpdate(): GemError
Forces auto update in respect to the configured AutoUpdateSettings. Might also trigger the OffBoardListener callbacks

Returns GemError
GemError.success if the operation could be started

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:406

`Static`getAllowOffboardServiceOnExtraChargedNetwork

getAllowOffboardServiceOnExtraChargedNetwork(
serviceType: ServiceGroupType,
): boolean
Check if the given service type is allowed on the extra charged network.
Parameters
- serviceType: ServiceGroupType
  The service type
Returns boolean
True if the service is allowed on the extra charged network, false otherwise

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:674

`Static`getBestLanguageMatch

getBestLanguageMatch(
    languageCode: string,
    regionCode?: string,
    scriptCode?: string,
    variant?: ScriptVariant,
): Language | null
Find the best language match for the provided input.
Parameters
- languageCode: string
  ISO 639-3 three-letter language code.
- regionCode: string = ''
  ISO 3166-1_3 three-letter region code, can be empty.
- scriptCode: string = ''
  ISO 15924 four-letter script code, can be empty.
- variant: ScriptVariant = ScriptVariant.Native
  script variant
Returns Language | null
Language object if a match is found, otherwise null.

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:451

`Static`getDefaultWidthHeightImageFormat

getDefaultWidthHeightImageFormat(): SizeAndFormat
Returns SizeAndFormat
- Defined in core/sdk_settings.ts:654

`Static`getImageById

getImageById(
options: { format?: ImageFileFormat; id: number; size?: Size },
): Uint8Array<ArrayBufferLike> | null
Parameters
- options: { format?: ImageFileFormat; id: number; size?: Size }
Returns Uint8Array<ArrayBufferLike> | null
- Defined in core/sdk_settings.ts:631

`Static`getImgById

getImgById(id: number): any
Get the image by its ID
Parameters
- id: number
  The image id
Returns any
The image with the given ID. Returns null if no image with the given ID exists

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:828

`Static`getOnlineServiceRestriction

getOnlineServiceRestriction(
serviceType: ServiceGroupType,
): Set<OnlineRestrictions>
Get online service restrictions.
Parameters
- serviceType: ServiceGroupType
  The service group id
Returns Set<OnlineRestrictions>
The OnlineRestrictions set

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:704

`Static`getTopicNotificationsServiceRestriction

getTopicNotificationsServiceRestriction(
serviceType: ServiceGroupType,
): Set<OnlineRestrictions>
Get topic notifications service restrictions.
Parameters
- serviceType: ServiceGroupType
  The service group id
Returns Set<OnlineRestrictions>
The OnlineRestrictions set

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:730

`Static`getVoice

getVoice(): Voice
Get the current voice.

Returns Voice
The voice

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:816

`Static`reset

reset(): void
Internal
The API user should not call this method

Returns void
- Defined in core/sdk_settings.ts:416

`Static`setAllowInternetConnection

setAllowInternetConnection(allowInternetConnection: boolean): void
Allow/deny internet connection.
Parameters
- allowInternetConnection: boolean
  Set if the SDK can connect to the internet
Returns void
Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:385

`Static`setAllowOffboardServiceOnExtraChargedNetwork

setAllowOffboardServiceOnExtraChargedNetwork(
serviceType: ServiceGroupType,
allow: boolean,
): void
Allow the given service type on the extra charged network type. By default all are allowed.
Parameters
- serviceType: ServiceGroupType
  ServiceGroupType object containing the service type
- allow: boolean
  Allow/deny value
Returns void
Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:690

`Static`setDefaultWidthHeightImageFormat

setDefaultWidthHeightImageFormat(size: Size, format?: ImageFileFormat): void
Parameters
- size: Size
- format: ImageFileFormat = ImageFileFormat.png
Returns void
- Defined in core/sdk_settings.ts:646

`Static`setSdkVersion

setSdkVersion(version: number, subVersion: number, revision: number): void
Set the SDK version
Parameters
- version: number
  The application version
- subVersion: number
  The application sub version
- revision: number
  The application revision
Returns void
Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:510

`Static`setTTSVoiceByLanguage

setTTSVoiceByLanguage(language: Language): GemError
Set the current TTS (computer) voice used for text-to-speech instructions. The best voice is selected based on the provided language.
Parameters
- language: Language
  The voice language.
Returns GemError
GemError.success on success, otherwise see GemError for other values.

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:789

`Static`setVoiceByPath

setVoiceByPath(path: string, language?: Language): GemError
Set the current voice by specifying the absolute path to the voice file.
Parameters
- path: string
  The absolute path to the voice file.
- Optionallanguage: Language
  The desired voice language. Used only in the case of TTS computer voice for accurate match in the underlying OS support
Returns GemError
GemError.success on success, otherwise see GemError for other values.

Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:802

`Static`verifyAppAuthorization

verifyAppAuthorization(token: string, callback: (err: GemError) => void): void
Verifies an app token. Validates the provided token and reports progress through the specified callback.
Parameters
- token: string
  The token to be verified. Must be a valid JWT token.
- callback: (err: GemError) => void
  An operation progress callback that handles the validation process.
Returns void
Throws
An exception if it fails.
- Defined in core/sdk_settings.ts:589

Class SdkSettings

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns SdkSettings

Accessors

StaticactualAppTheme

Returns AppTheme

Throws

StaticallowConnection

Returns boolean

StaticappAuthorization

Returns string

Parameters

Returns void

StaticapplicationName

Returns string

Parameters

Returns void

StaticappTheme

Returns AppTheme

Parameters

Returns void

Staticcapabilities

Returns Set<SdkCapability>

Throws

StaticdecimalSeparator

Returns string

Parameters

Returns void

StaticdeviceModel

Returns string

Throws

Parameters

Returns void

Throws

StaticdeviceName

Returns string

Parameters

Returns void

StaticdigitGroupSeparator

Returns string

Parameters

Returns void

StaticisCurrentThreadMainThread

Returns boolean

Throws

StaticisSDkInitialized

Returns boolean

Staticlanguage

Returns Language

Throws

Parameters

Returns void

Throws

StaticlanguageList

Returns Language[]

Throws

StaticmapLanguage

Returns MapLanguage

Parameters

Returns void

StaticoffBoardListener

Returns OffBoardListener

StaticsdkVersion

Returns string

Throws

StatictilesMaxSpace

Returns number

Throws

Parameters

Returns void

Throws

StatictransferStatistics

Returns TransferStatistics

Throws

StaticunitSystem

`Static`actualAppTheme

`Static`allowConnection

`Static`appAuthorization

`Static`applicationName

`Static`appTheme

`Static`capabilities

`Static`decimalSeparator

`Static`deviceModel

`Static`deviceName

`Static`digitGroupSeparator

`Static`isCurrentThreadMainThread

`Static`isSDkInitialized

`Static`language

`Static`languageList

`Static`mapLanguage

`Static`offBoardListener

`Static`sdkVersion

`Static`tilesMaxSpace

`Static`transferStatistics

`Static`unitSystem

`Static`autoUpdate

`Static`getAllowOffboardServiceOnExtraChargedNetwork

`Static`getBestLanguageMatch

`Static`getDefaultWidthHeightImageFormat

`Static`getImageById

`Static`getImgById

`Static`getOnlineServiceRestriction

`Static`getTopicNotificationsServiceRestriction

`Static`getVoice

`Static`reset

`Static`setAllowInternetConnection

`Static`setAllowOffboardServiceOnExtraChargedNetwork

`Static`setDefaultWidthHeightImageFormat

`Static`setSdkVersion

`Static`setTTSVoiceByLanguage

`Static`setVoiceByPath

`Static`verifyAppAuthorization