SdkSettings class abstract Core

SDK-level configuration and utility methods.

This class exposes global SDK settings such as unit system, language, theme, caching limits and other runtime flags. Settings are global to the running SDK instance and affect behavior for routing, navigation, content updates and rendering.

Constructors

SdkSettings()

Properties

hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

actualAppTheme → AppTheme: Returns the actual theme currently in effect.
no setter
allowConnection → bool: Returns whether offboard (internet) connections are allowed.
no setter
appAuthorization ↔ String: Returns the configured application authorization API token.
getter/setter pair
applicationName ↔ String: Returns the configured application name.
getter/setter pair
applicationVersion → String: Returns the application version as a human-readable string.
no setter
appTheme ↔ AppTheme: Returns the configured app theme used for image and text rendering.
getter/setter pair
capabilitties → Set<SdkCapability>: Returns the set of capabilities enabled in the current SDK build.
no setter
decimalSeparator ↔ String: Returns the decimal separator used when formatting numbers.
getter/setter pair
deviceModel ↔ String: Returns the device model configured for the SDK.
getter/setter pair
deviceName ↔ String: Returns the configured device name.
getter/setter pair
digitGroupSeparator ↔ String: Returns the digit group (thousands) separator used for number formatting.
getter/setter pair
isCurrentThreadMainThread → bool: Returns whether the current Dart thread is the main/UI thread.
no setter
isSDkInitialized → bool: Returns true when the SDK has been initialized.
no setter
language ↔ Language: Returns the currently selected API language.
getter/setter pair
languageList → List<Language>: Returns the list of languages supported by the SDK API.
no setter
mapLanguage ↔ MapLanguage: Returns the current map language selection method.
getter/setter pair
offBoardListener → OffBoardListener: Returns the SDK-wide offboard listener instance.
no setter
sdkVersion → String: Returns the SDK version as a human-readable string.
no setter
tilesMaxSpace ↔ int: Returns the maximum tile cache/storage size in kilobytes.
getter/setter pair
transferStatistics → TransferStatistics: Returns transfer statistics for SDK network usage.
no setter
unitSystem ↔ UnitSystem: Returns the SDK-wide unit system.
getter/setter pair

Static Methods

autoUpdate() → GemError: Triggers automatic content updates according to the configured auto-update settings.
getAllowOffboardServiceOnExtraChargedNetwork(ServiceGroupType serviceType) → bool: Returns whether a service group type is allowed on metered (extra-charged) networks.
getBestLanguageMatch(String languageCode, {String regionCode = '', String scriptCode = '', ScriptVariant variant = ScriptVariant.native}) → Language?: Finds the best language match for the provided codes and variant.
getDefaultWidthHeightImageFormat() → SizeAndFormat: Returns the SDK default image size and format used for automatically returned images.
getImageById({required int id, Size? size, ImageFileFormat? format}) → Uint8List?: Returns the raw image bytes for the given image id.
getImgById(int id) → Img?: Get the image as a Img.
getOnlineServiceRestriction(ServiceGroupType serviceType) → Set<OnlineRestrictions>: Returns the online service restrictions for a service group.
getTopicNotificationsServiceRestriction(ServiceGroupType serviceType) → Set<OnlineRestrictions>: Returns topic notification service restrictions for a service group.
getVoice() → Voice: Returns the currently selected Voice object.
setAllowInternetConnection(bool allowInternetConnection) → void: Enables or disables SDK access to the internet.
setAllowOffboardServiceOnExtraChargedNetwork(ServiceGroupType serviceType, bool allow) → void: Enables or disables a service group on metered (extra-charged) networks.
setApplicationVersion(int version, int subVersion, int revision) → void: Sets the application version information exposed to the SDK.
setDefaultWidthHeightImageFormat(Size size, {ImageFileFormat format = ImageFileFormat.png}) → void: Sets the SDK default image width, height and format used when the platform returns images automatically.
setSdkVersion(int version, int subVersion, int revision) → void: Sets the application version information exposed to the SDK.
setTTSVoiceByLanguage(Language language) → GemError: Selects the default TTS (computer) voice by language.
setVoiceByPath(String path, {Language? language}) → GemError: Sets the TTS/computer voice by absolute file path.
verifyAppAuthorization(String token, void callback(GemError err)) → void: Validates an application authorization token and reports the result via a callback.