Settings topic
Use this module to configure global SDK behaviour, persistence of lightweight application settings, network policy, debug diagnostics, and platform capabilities. The Settings area exposes programmatic access to runtime SDK flags, persisted key/value storage, offboard update listeners, and diagnostic helpers useful for building resilient map, navigation, and content-enabled apps.
SdkSettings: Central SDK configuration surface for global runtime flags and preferences. Use this to read and set unit systems, language, app identity, network allowances, and to query build-time capabilities exposed by the SDK.SettingsService: Local key/value persistence for application settings. Use it to store typed values, retrieve defaults, and persist small pieces of state that need to survive app restarts.NetworkProvider: Abstraction for querying and managing network availability and status. Use it to determine whether offboard services can be reached and to trigger refreshes when connectivity changes.OffBoardListener: Central event listener for offboard content and network events. Use it to register callbacks for content update status, connection changes, and worldwide roadmap capability notifications.Debug: Diagnostic utilities and fine-grained logging controls. Use it to toggle logging levels and to retrieve low-level app I/O and service diagnostics during development or troubleshooting.
Settings APIs combine to provide a predictable configuration surface and small persistent store for application needs. Together they let apps enforce consistent presentation (units, language), manage network and update policies safely, gather diagnostic information for troubleshooting, and persist small user preferences without pulling in a heavyweight storage dependency.
Prefer SdkSettings for global SDK-level flags that affect core features such as unit formatting, language selection, and allowable network behavior. Use SettingsService for app-level key/value persistence of small items (user preferences, counters, last-sync timestamps). Register an OffBoardListener to receive content update and connection events and coordinate background refreshes via NetworkProvider. Enable Debug logging selectively in development.
Classes
- Debug Settings
- Provides debugging utilities for memory monitoring, logging, and SDK configuration.
- ExpiredContent Settings
- Expired Content
- MountInfo Settings
- Information about a storage mount point used by the application.
- NetworkProvider Settings
- Network access customization and notification hooks.
- OffBoardListener Settings
- Listener receiving offboard/content-related events from the SDK.
- ProxyDetails Settings
- Proxy information used for HTTPS/HTTP proxy callbacks and configuration.
- SdkSettings Settings
- SDK-level configuration and utility methods.
- SettingsService Settings
- Service for storing persistent key/value application settings.
Enums
- AppTheme Settings
- Application theme selection used for images and text rendering.
- ContentStoreStatus Settings
- The status for ContentStore data.
- GemDumpSdkLevel Settings
- Defines verbosity levels for crash report logs sent to Magic Lane servers.
- GemLoggingLevel Settings
- Defines logging levels for SDK debug output to console.
- MapLanguage Settings
- Map language selection options.
- Modifies navigation behavior for debugging and testing purposes.
- OnlineRestrictions Settings
- Represents online restrictions using bitwise flags.
- ProxyType Settings
- Proxy type enumeration.
- Reason Settings
- Error reason type
- RoutingAlgoModifiers Settings
- Modifies routing algorithm behavior for debugging and testing purposes.
- SdkCapability Settings
- Enumerates the possible capabilities included in this SDK build.
- ServiceGroupType Settings
- Service group enum, including map tiles, traffic, terrain.
- UnitSystem Settings
- Unit system used for textual and spoken measurements.